diff options
Diffstat (limited to 'docs')
31 files changed, 75 insertions, 0 deletions
diff --git a/docs/podman-attach.1.md b/docs/podman-attach.1.md index 4caa87792..cef01f0f6 100644 --- a/docs/podman-attach.1.md +++ b/docs/podman-attach.1.md @@ -6,6 +6,8 @@ podman\-attach - Attach to a running container ## SYNOPSIS **podman attach** [*options*] *container* +**podman container attach** [*options*] *container* + ## DESCRIPTION The attach command allows you to attach to a running container using the container's ID or name, either to view its ongoing output or to control it interactively. diff --git a/docs/podman-build.1.md b/docs/podman-build.1.md index 8deb8811e..74c07ab73 100644 --- a/docs/podman-build.1.md +++ b/docs/podman-build.1.md @@ -6,6 +6,8 @@ podman\-build - Build a container image using a Dockerfile ## SYNOPSIS **podman build** [*options*] *context* +**podman image build** [*options*] *context* + ## DESCRIPTION **podman build** Builds an image using instructions from one or more Dockerfiles and a specified build context directory. diff --git a/docs/podman-commit.1.md b/docs/podman-commit.1.md index a269d0fae..5b0ba48aa 100644 --- a/docs/podman-commit.1.md +++ b/docs/podman-commit.1.md @@ -6,6 +6,8 @@ podman\-commit - Create new image based on the changed container ## SYNOPSIS **podman commit** [*options*] *container* *image* +**podman container commit** [*options*] *container* *image* + ## DESCRIPTION **podman commit** creates an image based on a changed container. The author of the image can be set using the `--author` flag. Various image instructions can be diff --git a/docs/podman-cp.1.md b/docs/podman-cp.1.md index 178a05018..e3d992b55 100644 --- a/docs/podman-cp.1.md +++ b/docs/podman-cp.1.md @@ -6,6 +6,8 @@ podman\-cp - Copy files/folders between a container and the local filesystem ## SYNOPSIS **podman cp** [*options*] [*container*:]*src_path* [*container*:]*dest_path* +**podman container cp** [*options*] [*container*:]*src_path* [*container*:]*dest_path* + ## DESCRIPTION Copies the contents of **src_path** to the **dest_path**. You can copy from the container's filesystem to the local machine or the reverse, from the local filesystem to the container. If - is specified for either the SRC_PATH or DEST_PATH, you can also stream a tar archive from STDIN or to STDOUT. diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md index 7634408f5..cee9a1640 100644 --- a/docs/podman-create.1.md +++ b/docs/podman-create.1.md @@ -6,6 +6,8 @@ podman\-create - Create a new container ## SYNOPSIS **podman create** [*options*] *image* [*command* [*arg* ...]] +**podman container create** [*options*] *image* [*command* [*arg* ...]] + ## DESCRIPTION Creates a writable container layer over the specified image and prepares it for diff --git a/docs/podman-diff.1.md b/docs/podman-diff.1.md index 8d67ed82c..5b0434a07 100644 --- a/docs/podman-diff.1.md +++ b/docs/podman-diff.1.md @@ -6,6 +6,8 @@ podman\-diff - Inspect changes on a container or image's filesystem ## SYNOPSIS **podman diff** [*options*] *name* +**podman container diff** [*options*] *name* + ## DESCRIPTION Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer diff --git a/docs/podman-exec.1.md b/docs/podman-exec.1.md index ab8d75626..f71b21126 100644 --- a/docs/podman-exec.1.md +++ b/docs/podman-exec.1.md @@ -6,6 +6,8 @@ podman\-exec - Execute a command in a running container ## SYNOPSIS **podman exec** [*options*] *container* [*command* [*arg* ...]] +**podman container exec** [*options*] *container* [*command* [*arg* ...]] + ## DESCRIPTION **podman exec** executes a command in a running container. diff --git a/docs/podman-export.1.md b/docs/podman-export.1.md index 3ccd783d8..4286d0e2f 100644 --- a/docs/podman-export.1.md +++ b/docs/podman-export.1.md @@ -6,6 +6,8 @@ podman\-export - Export a container's filesystem contents as a tar archive ## SYNOPSIS **podman export** [*options*] *container* +**podman container export** [*options*] *container* + ## DESCRIPTION **podman export** exports the filesystem of a container and saves it as a tarball on the local machine. **podman export** writes to STDOUT by default and can be diff --git a/docs/podman-history.1.md b/docs/podman-history.1.md index 5ee87c185..a67cb0286 100644 --- a/docs/podman-history.1.md +++ b/docs/podman-history.1.md @@ -6,6 +6,8 @@ podman\-history - Show the history of an image ## SYNOPSIS **podman history** [*options*] *image*[:*tag*|@*digest*] +**podman image history** [*options*] *image*[:*tag*|@*digest*] + ## DESCRIPTION **podman history** displays the history of an image by printing out information about each layer used in the image. The information printed out for each layer diff --git a/docs/podman-images.1.md b/docs/podman-images.1.md index 6360bf580..3ac07fc43 100644 --- a/docs/podman-images.1.md +++ b/docs/podman-images.1.md @@ -6,6 +6,10 @@ podman\-images - List images in local storage ## SYNOPSIS **podman images** [*options*] +**podman image list** [*options*] + +**podman image ls** [*options*] + ## DESCRIPTION Displays locally stored images, their names, and their IDs. diff --git a/docs/podman-import.1.md b/docs/podman-import.1.md index 6c625bc8d..5e57c1bcb 100644 --- a/docs/podman-import.1.md +++ b/docs/podman-import.1.md @@ -6,6 +6,8 @@ podman\-import - Import a tarball and save it as a filesystem image ## SYNOPSIS **podman import** [*options*] *path* [*reference*] +**podman image import** [*options*] *path* [*reference*] + ## DESCRIPTION **podman import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) and saves it as a filesystem image. Remote tarballs can be specified using a URL. diff --git a/docs/podman-init.1.md b/docs/podman-init.1.md index a6bb391ec..3b49cfb99 100644 --- a/docs/podman-init.1.md +++ b/docs/podman-init.1.md @@ -6,6 +6,8 @@ podman\-init - Initialize one or more containers ## SYNOPSIS **podman init** [*options*] *container* [*container*...] +**podman container init** [*options*] *container* [*container*...] + ## DESCRIPTION Initialize one or more containers. You may use container IDs or names as input. diff --git a/docs/podman-kill.1.md b/docs/podman-kill.1.md index 5144511fb..617d25b85 100644 --- a/docs/podman-kill.1.md +++ b/docs/podman-kill.1.md @@ -6,6 +6,8 @@ podman\-kill - Kill the main process in one or more containers ## SYNOPSIS **podman kill** [*options*] [*container* ...] +**podman container kill** [*options*] [*container* ...] + ## DESCRIPTION The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. diff --git a/docs/podman-load.1.md b/docs/podman-load.1.md index 6643538ce..deb4fb5ec 100644 --- a/docs/podman-load.1.md +++ b/docs/podman-load.1.md @@ -6,6 +6,8 @@ podman\-load - Load an image from a container image archive into container stora ## SYNOPSIS **podman load** [*options*] [*name*[:*tag*]] +**podman image load** [*options*] [*name*[:*tag*]] + ## DESCRIPTION **podman load** loads an image from either an **oci-archive** or **docker-archive** stored on the local machine into container storage. **podman load** reads from stdin by default or a file if the **input** option is set. You can also specify a name for the image if the archive does not contain a named reference, of if you want an additional name for the local image. diff --git a/docs/podman-mount.1.md b/docs/podman-mount.1.md index 5748fc804..8f4deeca6 100644 --- a/docs/podman-mount.1.md +++ b/docs/podman-mount.1.md @@ -6,6 +6,8 @@ podman\-mount - Mount a working container's root filesystem ## SYNOPSIS **podman mount** [*container* ...] +**podman container mount** [*container* ...] + ## DESCRIPTION Mounts the specified containers' root file system in a location which can be accessed from the host, and returns its location. diff --git a/docs/podman-pause.1.md b/docs/podman-pause.1.md index 18080ec04..dfd4da416 100644 --- a/docs/podman-pause.1.md +++ b/docs/podman-pause.1.md @@ -6,6 +6,8 @@ podman\-pause - Pause one or more containers ## SYNOPSIS **podman pause** [*options*] [*container*...] +**podman container pause** [*options*] [*container*...] + ## DESCRIPTION Pauses all the processes in one or more containers. You may use container IDs or names as input. diff --git a/docs/podman-port.1.md b/docs/podman-port.1.md index bee15c881..c9833f447 100644 --- a/docs/podman-port.1.md +++ b/docs/podman-port.1.md @@ -6,6 +6,8 @@ podman\-port - List port mappings for a container ## SYNOPSIS **podman port** [*options*] *container* [*private-port*[/*proto*]] +**podman container port** [*options*] *container* [*private-port*[/*proto*]] + ## DESCRIPTION List port mappings for the *container* or lookup the public-facing port that is NAT-ed to the *private-port*. diff --git a/docs/podman-ps.1.md b/docs/podman-ps.1.md index e3aaf93e2..298de0b2b 100644 --- a/docs/podman-ps.1.md +++ b/docs/podman-ps.1.md @@ -6,6 +6,16 @@ podman\-ps - Prints out information about containers ## SYNOPSIS **podman ps** [*options*] +**podman container list** [*options*] + +**podman container ls** [*options*] + +**podman container ps** [*options*] + +**podman list** [*options*] + +**podman ls** [*options*] + ## DESCRIPTION **podman ps** lists the running containers on the system. Use the **--all** flag to view all the containers information. By default it lists: diff --git a/docs/podman-pull.1.md b/docs/podman-pull.1.md index 8774075e1..9976bc586 100644 --- a/docs/podman-pull.1.md +++ b/docs/podman-pull.1.md @@ -6,6 +6,8 @@ podman\-pull - Pull an image from a registry ## SYNOPSIS **podman pull** [*options*] *name*[:*tag*|@*digest*] +**podman image pull** [*options*] *name*[:*tag*|@*digest*] + ## DESCRIPTION Copies an image from a registry onto the local machine. **podman pull** pulls an image from Docker Hub if a registry is not specified in the command line argument. diff --git a/docs/podman-push.1.md b/docs/podman-push.1.md index 29e4044a3..1cf8fd1a6 100644 --- a/docs/podman-push.1.md +++ b/docs/podman-push.1.md @@ -6,6 +6,8 @@ podman\-push - Push an image from local storage to elsewhere ## SYNOPSIS **podman push** [*options*] *image* [*destination*] +**podman image push** [*options*] *image* [*destination*] + ## DESCRIPTION Pushes an image from local storage to a specified destination. Push is mainly used to push images to registries, however **podman push** diff --git a/docs/podman-restart.1.md b/docs/podman-restart.1.md index 643eb1b03..08fa29244 100644 --- a/docs/podman-restart.1.md +++ b/docs/podman-restart.1.md @@ -6,6 +6,8 @@ podman\-restart - Restart one or more containers ## SYNOPSIS **podman restart** [*options*] *container* ... +**podman container restart** [*options*] *container* ... + ## DESCRIPTION The restart command allows containers to be restarted using their ID or name. Containers will be stopped if they are running and then restarted. Stopped diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md index 447d4f282..8fb7453fe 100644 --- a/docs/podman-run.1.md +++ b/docs/podman-run.1.md @@ -6,6 +6,8 @@ podman\-run - Run a command in a new container ## SYNOPSIS **podman run** [*options*] *image* [*command* [*arg* ...]] +**podman container run** [*options*] *image* [*command* [*arg* ...]] + ## DESCRIPTION Run a process in a new container. **podman run** starts a process with its own diff --git a/docs/podman-save.1.md b/docs/podman-save.1.md index 034d2696f..b2b0995d3 100644 --- a/docs/podman-save.1.md +++ b/docs/podman-save.1.md @@ -6,6 +6,8 @@ podman\-save - Save an image to a container archive ## SYNOPSIS **podman save** [*options*] *name*[:*tag*] +**podman image save** [*options*] *name*[:*tag*] + ## DESCRIPTION **podman save** saves an image to either **docker-archive**, **oci-archive**, **oci-dir** (directory with oci manifest type), or **docker-dir** (directory with v2s2 manifest type) on the local machine, default is **docker-archive**. **podman save** writes to STDOUT by default and can be redirected to a diff --git a/docs/podman-start.1.md b/docs/podman-start.1.md index 5ec6e2ea2..4c81d17bd 100644 --- a/docs/podman-start.1.md +++ b/docs/podman-start.1.md @@ -6,6 +6,8 @@ podman\-start - Start one or more containers ## SYNOPSIS **podman start** [*options*] *container* ... +**podman container start** [*options*] *container* ... + ## DESCRIPTION Start one or more containers. You may use container IDs or names as input. The *attach* and *interactive* options cannot be used to override the *--tty* and *--interactive* options from when the container diff --git a/docs/podman-stats.1.md b/docs/podman-stats.1.md index 49a3c5ac1..e0cff0dc2 100644 --- a/docs/podman-stats.1.md +++ b/docs/podman-stats.1.md @@ -6,6 +6,8 @@ podman\-stats - Display a live stream of one or more container's resource usage ## SYNOPSIS **podman stats** [*options*] [*container*] +**podman container stats** [*options*] [*container*] + ## DESCRIPTION Display a live stream of one or more containers' resource usage statistics diff --git a/docs/podman-stop.1.md b/docs/podman-stop.1.md index d7ad41e30..b5ea670b0 100644 --- a/docs/podman-stop.1.md +++ b/docs/podman-stop.1.md @@ -6,6 +6,8 @@ podman\-stop - Stop one or more running containers ## SYNOPSIS **podman stop** [*options*] *container* ... +**podman container stop** [*options*] *container* ... + ## DESCRIPTION Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command diff --git a/docs/podman-tag.1.md b/docs/podman-tag.1.md index f3851d8b6..291d95228 100644 --- a/docs/podman-tag.1.md +++ b/docs/podman-tag.1.md @@ -6,6 +6,7 @@ podman\-tag - Add an additional name to a local image ## SYNOPSIS **podman tag** *image*[:*tag*] *target-name*[:*tag*] [*options*] +**podman image tag** *image*[:*tag*] *target-name*[:*tag*] [*options*] ## DESCRIPTION Assigns a new alias to an image. An alias refers to the entire image name, including the optional diff --git a/docs/podman-top.1.md b/docs/podman-top.1.md index 564c2f067..1410aa651 100644 --- a/docs/podman-top.1.md +++ b/docs/podman-top.1.md @@ -6,6 +6,8 @@ podman\-top - Display the running processes of a container ## SYNOPSIS **podman top** [*options*] *container* [*format-descriptors*] +**podman container top** [*options*] *container* [*format-descriptors*] + ## DESCRIPTION Display the running processes of the container. The *format-descriptors* are ps (1) compatible AIX format descriptors but extended to print additional information, such as the seccomp mode or the effective capabilities of a given process. The descriptors can either be passed as separated arguments or as a single comma-separated argument. Note that you can also specify options and or flags of ps(1); in this case, Podman will fallback to executing ps with the specified arguments and flags in the container. diff --git a/docs/podman-umount.1.md b/docs/podman-umount.1.md index 95300a8e8..100c47b32 100644 --- a/docs/podman-umount.1.md +++ b/docs/podman-umount.1.md @@ -6,6 +6,12 @@ podman\-umount - Unmount a working container's root filesystem ## SYNOPSIS **podman umount** *container* [...] +**podman container umount** *container* [...] + +**podman container unmount** *container* [...] + +**podman unmount** *container* [...] + ## DESCRIPTION Unmounts the specified containers' root file system, if no other processes are using it. diff --git a/docs/podman-unpause.1.md b/docs/podman-unpause.1.md index ef8a4cdb6..f5538d6d5 100644 --- a/docs/podman-unpause.1.md +++ b/docs/podman-unpause.1.md @@ -6,6 +6,8 @@ podman\-unpause - Unpause one or more containers ## SYNOPSIS **podman unpause** [*options*]|[*container* ...] +**podman container unpause** [*options*]|[*container* ...] + ## DESCRIPTION Unpauses the processes in one or more containers. You may use container IDs or names as input. diff --git a/docs/podman-wait.1.md b/docs/podman-wait.1.md index e1a810ff1..ce1c70a5f 100644 --- a/docs/podman-wait.1.md +++ b/docs/podman-wait.1.md @@ -6,6 +6,8 @@ podman\-wait - Wait on one or more containers to stop and print their exit codes ## SYNOPSIS **podman wait** [*options*] *container* +**podman container wait** [*options*] *container* + ## DESCRIPTION Waits on one or more containers to stop. The container can be referred to by its name or ID. In the case of multiple containers, podman will wait on each consecutively. |