mirror of
https://github.com/containers/podman.git
synced 2025-10-31 18:08:51 +08:00
1141962e2a
Belated followup to #21981. (Looks like I started to add this functionality back in 2020 but left it unfinished. Tsk tsk.) docs/source/Commands.rst is unnecessary duplication. It _should_ be autogenerated, but I can't figure out how to cleanly add that to our Make process. This PR is an interim cross-check until we get that resolved: - everything in podman --help must have a matching entry in Commands.rst (top-level commands only) - check for dups and out-of-sequence in Commands.rst - also for anything in Commands.rst that is not in --help Fix existing mismatches in Commands.rst. Also, #21784 removed a format specifier that I was using in regression tests. Switch to using something else, to get test passing again. Given the fact the correct solution is autogenerating Commands.rst, I choose not to add new tests for the rst xref. Also, executive decision, remove volume.rst. It is not referenced from anywhere, it looks like a lonely orphan remnant from days of yore. Signed-off-by: Ed Santiago <santiago@redhat.com>
125 lines
4.6 KiB
ReStructuredText
125 lines
4.6 KiB
ReStructuredText
.. include:: includes.rst
|
|
|
|
Commands
|
|
========
|
|
|
|
:doc:`Podman <markdown/podman.1>` (Pod Manager) Global Options, Environment Variables, Exit Codes, Configuration Files, and more
|
|
|
|
:doc:`attach <markdown/podman-attach.1>` Attach to a running container
|
|
|
|
:doc:`auto-update <markdown/podman-auto-update.1>` Auto update containers according to their auto-update policy
|
|
|
|
:doc:`build <markdown/podman-build.1>` Build an image using instructions from Containerfiles
|
|
|
|
:doc:`commit <markdown/podman-commit.1>` Create new image based on the changed container
|
|
|
|
:doc:`container <markdown/podman-container.1>` Manage containers
|
|
|
|
:doc:`cp <markdown/podman-cp.1>` Copy files/folders between a container and the local filesystem
|
|
|
|
:doc:`create <markdown/podman-create.1>` Create but do not start a container
|
|
|
|
:doc:`diff <markdown/podman-diff.1>` Display the changes to the object's file system
|
|
|
|
:doc:`events <markdown/podman-events.1>` Show podman system events
|
|
|
|
:doc:`exec <markdown/podman-exec.1>` Run a process in a running container
|
|
|
|
:doc:`export <markdown/podman-export.1>` Export container's filesystem contents as a tar archive
|
|
|
|
:doc:`farm <markdown/podman-farm.1>` Farm out builds to remote machines
|
|
|
|
:doc:`generate <markdown/podman-generate.1>` Generate structured data based on containers, pods or volumes
|
|
|
|
:doc:`healthcheck <markdown/podman-healthcheck.1>` Manage health checks on containers
|
|
|
|
:doc:`history <markdown/podman-history.1>` Show history of a specified image
|
|
|
|
:doc:`image <markdown/podman-image.1>` Manage images
|
|
|
|
:doc:`images <markdown/podman-images.1>` List images in local storage
|
|
|
|
:doc:`import <markdown/podman-import.1>` Import a tarball to create a filesystem image
|
|
|
|
:doc:`info <markdown/podman-info.1>` Display podman system information
|
|
|
|
:doc:`init <markdown/podman-init.1>` Initialize one or more containers
|
|
|
|
:doc:`inspect <markdown/podman-inspect.1>` Display the configuration of object denoted by ID
|
|
|
|
:doc:`kill <markdown/podman-kill.1>` Kill one or more running containers with a specific signal
|
|
|
|
:doc:`kube <markdown/podman-kube.1>` Play containers, pods or volumes from a structured file
|
|
|
|
:doc:`load <markdown/podman-load.1>` Load image(s) from a tar archive
|
|
|
|
:doc:`login <markdown/podman-login.1>` Log in to a container registry
|
|
|
|
:doc:`logout <markdown/podman-logout.1>` Log out of a container registry
|
|
|
|
:doc:`logs <markdown/podman-logs.1>` Fetch the logs of one or more containers
|
|
|
|
:doc:`machine <markdown/podman-machine.1>` Manage a virtual machine
|
|
|
|
:doc:`manifest <markdown/podman-manifest.1>` Manipulate manifest lists and image indexes
|
|
|
|
:doc:`mount <markdown/podman-mount.1>` Mount a working container's root filesystem
|
|
|
|
:doc:`network <markdown/podman-network.1>` Manage networks
|
|
|
|
:doc:`pause <markdown/podman-pause.1>` Pause all the processes in one or more containers
|
|
|
|
:doc:`pod <markdown/podman-pod.1>` Manage pods
|
|
|
|
:doc:`port <markdown/podman-port.1>` List port mappings or a specific mapping for the container
|
|
|
|
:doc:`ps <markdown/podman-ps.1>` List containers
|
|
|
|
:doc:`pull <markdown/podman-pull.1>` Pull an image from a registry
|
|
|
|
:doc:`push <markdown/podman-push.1>` Push an image to a specified destination
|
|
|
|
:doc:`rename <markdown/podman-rename.1>` Rename an existing container
|
|
|
|
:doc:`restart <markdown/podman-restart.1>` Restart one or more containers
|
|
|
|
:doc:`rm <markdown/podman-rm.1>` Remove one or more containers
|
|
|
|
:doc:`rmi <markdown/podman-rmi.1>` Remove one or more images from local storage
|
|
|
|
:doc:`run <markdown/podman-run.1>` Run a command in a new container
|
|
|
|
:doc:`save <markdown/podman-save.1>` Save image(s) to an archive
|
|
|
|
:doc:`search <markdown/podman-search.1>` Search registry for image
|
|
|
|
:doc:`secret <markdown/podman-secret.1>` Manage secrets
|
|
|
|
:doc:`start <markdown/podman-start.1>` Start one or more containers
|
|
|
|
:doc:`stats <markdown/podman-stats.1>` Display a live stream of container resource usage statistics
|
|
|
|
:doc:`stop <markdown/podman-stop.1>` Stop one or more containers
|
|
|
|
:doc:`system <markdown/podman-system.1>` Manage podman
|
|
|
|
:doc:`tag <markdown/podman-tag.1>` Add an additional name to a local image
|
|
|
|
:doc:`top <markdown/podman-top.1>` Display the running processes of a container
|
|
|
|
:doc:`unmount <markdown/podman-unmount.1>` Unmount working container's root filesystem
|
|
|
|
:doc:`unpause <markdown/podman-unpause.1>` Unpause the processes in one or more containers
|
|
|
|
:doc:`unshare <markdown/podman-unshare.1>` Run a command in a modified user namespace
|
|
|
|
:doc:`untag <markdown/podman-untag.1>` Remove a name from a local image
|
|
|
|
:doc:`update <markdown/podman-update.1>` Update an existing container
|
|
|
|
:doc:`version <markdown/podman-version.1>` Display the Podman version information
|
|
|
|
:doc:`volume <markdown/podman-volume.1>` Manage volumes
|
|
|
|
:doc:`wait <markdown/podman-wait.1>` Block on one or more containers
|