diff --git a/docs/source/markdown/podman-attach.1.md.in b/docs/source/markdown/podman-attach.1.md.in index d3efcc3bd5..63d122516c 100644 --- a/docs/source/markdown/podman-attach.1.md.in +++ b/docs/source/markdown/podman-attach.1.md.in @@ -31,7 +31,7 @@ Attach to a container called "foobar". $ podman attach foobar ``` -Attach to the latest created container. +Attach to the latest created container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` $ podman attach --latest ``` diff --git a/docs/source/markdown/podman-container-inspect.1.md.in b/docs/source/markdown/podman-container-inspect.1.md.in index b95a736d1a..27ba28018d 100644 --- a/docs/source/markdown/podman-container-inspect.1.md.in +++ b/docs/source/markdown/podman-container-inspect.1.md.in @@ -74,6 +74,7 @@ In addition to normal output, display the total file size if the type is a conta ## EXAMPLE +Inspect the specified container and print its information in json format. ``` $ podman container inspect foobar [ @@ -305,16 +306,19 @@ $ podman container inspect foobar ] ``` +Inspect the specified container for the Image Name it is based on. ``` $ podman container inspect nervous_fermi --format "{{.ImageName}}" registry.access.redhat.com/ubi8:latest ``` +Inspect the specified container for the GraphDriver Name it is running with. ``` $ podman container inspect foobar --format "{{.GraphDriver.Name}}" overlay ``` +Inspect the latest container created for its EffectiveCaps field. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` $ podman container inspect --latest --format {{.EffectiveCaps}} [CAP_CHOWN CAP_DAC_OVERRIDE CAP_FOWNER CAP_FSETID CAP_KILL CAP_NET_BIND_SERVICE CAP_SETFCAP CAP_SETGID CAP_SETPCAP CAP_SETUID] diff --git a/docs/source/markdown/podman-init.1.md.in b/docs/source/markdown/podman-init.1.md.in index e883d53a5d..ec05283e47 100644 --- a/docs/source/markdown/podman-init.1.md.in +++ b/docs/source/markdown/podman-init.1.md.in @@ -26,17 +26,17 @@ Initialize all containers. Containers that have already initialized (including c ## EXAMPLE -Initialize container with a given ID +Initialize specified container with a given ID. ``` podman init 35480fc9d568 ``` -Initialize container with a given name +Initialize specified container with a given name. ``` podman init test1 ``` -Initialize the latest container created by Podman +Initialize the latest container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` podman init --latest ``` diff --git a/docs/source/markdown/podman-inspect.1.md.in b/docs/source/markdown/podman-inspect.1.md.in index 9a5dcf2aae..2a6333d5e0 100644 --- a/docs/source/markdown/podman-inspect.1.md.in +++ b/docs/source/markdown/podman-inspect.1.md.in @@ -35,11 +35,12 @@ In addition to normal output, display the total file size if the type is a conta #### **--type**, **-t**=*type* -Return JSON for the specified type. Type can be 'container', 'image', 'volume', 'network', 'pod', or 'all' (default: all) +Return JSON for the specified type. Type can be 'container', 'image', 'volume', 'network', 'pod', or 'all' (default: all) (Only meaningful when invoked as *podman inspect*) ## EXAMPLE +Inspect the fedora image ``` # podman inspect fedora [ @@ -121,35 +122,43 @@ Return JSON for the specified type. Type can be 'container', 'image', 'volume', ] ``` +Inspect the specified image for Image Name. ``` # podman inspect a04 --format "{{.ImageName}}" fedora ``` +Inspect the specified image for GraphDriver Name. ``` # podman inspect a04 --format "{{.GraphDriver.Name}}" overlay ``` +Inspect the specified image for its Size field. ``` # podman image inspect --format "size: {{.Size}}" alpine size: 4405240 ``` +Inspect the latest container created for its EffectiveCaps field. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` podman container inspect --latest --format {{.EffectiveCaps}} [CAP_CHOWN CAP_DAC_OVERRIDE CAP_FSETID CAP_FOWNER CAP_SETGID CAP_SETUID CAP_SETFCAP CAP_SETPCAP CAP_NET_BIND_SERVICE CAP_KILL] ``` +Inspect the specified pod for the Name field. ``` # podman inspect myPod --type pod --format "{{.Name}}" myPod ``` + +Inspect the specified volume for the Name field. ``` # podman inspect myVolume --type volume --format "{{.Name}}" myVolume ``` +Inspect the specified network for the Name field. ``` # podman inspect nyNetwork --type network --format "{{.name}}" myNetwork diff --git a/docs/source/markdown/podman-kill.1.md.in b/docs/source/markdown/podman-kill.1.md.in index 722d37bbb8..2275e06ded 100644 --- a/docs/source/markdown/podman-kill.1.md.in +++ b/docs/source/markdown/podman-kill.1.md.in @@ -39,7 +39,8 @@ Terminate container by sending `TERM` signal podman kill --signal TERM 860a4b23 ``` -Kill the latest container created by Podman +Kill the latest container. (This option is not available with the remote Podman client, including Mac and Windows +(excluding WSL2) machines) ``` podman kill --latest ``` diff --git a/docs/source/markdown/podman-kube-generate.1.md b/docs/source/markdown/podman-kube-generate.1.md index 2cc6a1ab65..78f2bb1f70 100644 --- a/docs/source/markdown/podman-kube-generate.1.md +++ b/docs/source/markdown/podman-kube-generate.1.md @@ -63,7 +63,7 @@ The Kubernetes kind to generate in the YAML file. Currently, the only supported ## EXAMPLES -Create Kubernetes Pod YAML for a container called `some-mariadb`. +Create Kubernetes Pod YAML for the specified container. ``` $ podman kube generate some-mariadb # Save the output of this file and use kubectl create -f to import @@ -103,7 +103,7 @@ spec: claimName: mariadb_data ``` -Create Kubernetes Deployment YAML with 3 replicas for a container called `dep-ctr` +Create Kubernetes Deployment YAML with 3 replicas for the specified container. ``` $ podman kube generate --type deployment --replicas 3 dep-ct r @@ -140,7 +140,7 @@ spec: ``` -Create Kubernetes Pod YAML for a container with the directory `/home/user/my-data` on the host bind-mounted in the container to `/volume`. +Create Kubernetes Pod YAML for the specified container with the host directory `/home/user/my-data` bind-mounted onto the container path `/volume`. ``` $ podman kube generate my-container-with-bind-mounted-data # Save the output of this file and use kubectl create -f to import @@ -171,7 +171,7 @@ spec: name: home-user-my-data-host ``` -Create Kubernetes Pod YAML for a container with the named volume `priceless-data` mounted in the container at `/volume`. +Create Kubernetes Pod YAML for the specified container with named volume `priceless-data` mounted onto the container path `/volume`. ``` $ podman kube generate my-container-using-priceless-data # Save the output of this file and use kubectl create -f to import @@ -201,7 +201,7 @@ spec: claimName: priceless-data ``` -Create Kubernetes Pod YAML for a pod called `demoweb` and include a service. +Create Kubernetes Pod YAML for the specified pod and include a service. ``` $ sudo podman kube generate -s demoweb # Save the output of this file and use kubectl create -f to import diff --git a/docs/source/markdown/podman-kube-play.1.md.in b/docs/source/markdown/podman-kube-play.1.md.in index a2c07a459c..20e3a114ef 100644 --- a/docs/source/markdown/podman-kube-play.1.md.in +++ b/docs/source/markdown/podman-kube-play.1.md.in @@ -14,7 +14,7 @@ Using the `--down` command line option, it is also capable of tearing down the p Using the `--replace` command line option, it tears down the pods(if any) created by a previous run of `podman kube play` and recreate the pods with the Kubernetes YAML file. -Ideally the input file is created by Podman (see podman-kube-generate(1)). This guarantees a smooth import and expected results. +Ideally the input file is created by the Podman command (see podman-kube-generate(1)). This guarantees a smooth import and expected results. Currently, the supported Kubernetes kinds are: @@ -270,19 +270,19 @@ upon exit. ## EXAMPLES -Recreate the pod and containers as described in a file called `demo.yml` +Recreate the pod and containers described in the specified host YAML file. ``` $ podman kube play demo.yml 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 ``` -Recreate the pod and containers as described in a file `demo.yml` sent to stdin +Recreate the pod and containers specified in a YAML file sent to stdin. ``` $ cat demo.yml | podman kube play - 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 - ``` -Teardown the pod and containers as described in a file `demo.yml` + +Teardown the pod and containers as described in the specified YAML file. ``` $ podman kube play --down demo.yml Pods stopped: @@ -291,7 +291,7 @@ Pods removed: 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 ``` -Provide `configmap-foo.yml` and `configmap-bar.yml` as sources for environment variables within the containers. +Provide multiple configmaps files as sources for environment variables within the specified pods and containers. ``` $ podman kube play demo.yml --configmap configmap-foo.yml,configmap-bar.yml 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 @@ -300,14 +300,14 @@ $ podman kube play demo.yml --configmap configmap-foo.yml --configmap configmap- 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 ``` -Create a pod connected to two networks (called net1 and net2) with a static ip +Create a pod connected to two networks with a static ip. ``` $ podman kube play demo.yml --network net1:ip=10.89.1.5 --network net2:ip=10.89.10.10 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 ``` Please take into account that networks must be created first using podman-network-create(1). -Create and teardown from a URL pointing to a YAML file +Create and teardown from a URL pointing to a YAML file. ``` $ podman kube play https://podman.io/demo.yml 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 diff --git a/docs/source/markdown/podman-load.1.md b/docs/source/markdown/podman-load.1.md index 91054ecb60..7bd54f0e06 100644 --- a/docs/source/markdown/podman-load.1.md +++ b/docs/source/markdown/podman-load.1.md @@ -44,14 +44,17 @@ Suppress the progress output ## EXAMPLES +Create an image from a compressed tar file, without showing progress. ``` $ podman load --quiet -i fedora.tar.gz ``` +Create an image from the archive.tar file pulled from a URL, without showing progress. ``` $ podman load -q -i https://server.com/archive.tar ``` +Create an image from stdin using bash redirection from a tar file. ``` $ podman load < fedora.tar Getting image source signatures @@ -64,6 +67,7 @@ Storing signatures Loaded image: registry.fedoraproject.org/fedora:latest ``` +Create an image from stdin using a piped. ``` $ cat fedora.tar | podman load Getting image source signatures diff --git a/docs/source/markdown/podman-login.1.md.in b/docs/source/markdown/podman-login.1.md.in index 0f1713cc97..7789f38ba0 100644 --- a/docs/source/markdown/podman-login.1.md.in +++ b/docs/source/markdown/podman-login.1.md.in @@ -69,6 +69,7 @@ print detailed information about credential store ## EXAMPLES +Add login credentials for specified registry to the default authorization file. ``` $ podman login docker.io Username: umohnani @@ -76,18 +77,21 @@ Password: Login Succeeded! ``` +Add login credentials using specified username and password for local registry to the default authorization file. ``` $ podman login -u testuser -p testpassword localhost:5000 Login Succeeded! ``` +Add login credentials for alternate authfile path for the specified registry. ``` -$ podman login --authfile authdir/myauths.json docker.io +$ podman login --authfile authdir/myauths.json quay.io Username: umohnani Password: Login Succeeded! ``` +Add login credentials as a Podman Secret for the specified registry to the default authorization file. ``` $ echo -n MySecret! | podman secret create secretname - a0ad54df3c97cf89d5ca6193c @@ -95,26 +99,31 @@ $ podman login --secret secretname -u testuser quay.io Login Succeeded! ``` +Add login credentials for user test with password test to localhost:5000 registry disabling tls verification requirement. ``` $ podman login --tls-verify=false -u test -p test localhost:5000 Login Succeeded! ``` +Add login credentials for user foo with password bar to localhost:5000 registry using the certificate directory /etc/containers/certs.d. ``` $ podman login --cert-dir /etc/containers/certs.d/ -u foo -p bar localhost:5000 Login Succeeded! ``` +Add login credentials for docker.io into the default authorization file for user testuser with password information provided via stdin from a file on disk. ``` $ podman login -u testuser --password-stdin < testpassword.txt docker.io Login Succeeded! ``` +Add login credentials for docker.io into the default authorization file for user testuser with password information provided via stdin from a pipe. ``` $ echo $testpassword | podman login -u testuser --password-stdin docker.io Login Succeeded! ``` +Add login credentials for the quay.io registry in verbose mode default authorization file. ``` $ podman login quay.io --verbose Username: myusername diff --git a/docs/source/markdown/podman-logout.1.md.in b/docs/source/markdown/podman-logout.1.md.in index 496c039732..616cf2cc91 100644 --- a/docs/source/markdown/podman-logout.1.md.in +++ b/docs/source/markdown/podman-logout.1.md.in @@ -37,19 +37,19 @@ Print usage statement ## EXAMPLES +Remove login credentials for the docker.io registry from the authorization file ``` $ podman logout docker.io -Remove login credentials for https://registry-1.docker.io/v2/ ``` +Remove login credentials for the docker.io registry from the authdir/myauths.json file. ``` $ podman logout --authfile authdir/myauths.json docker.io -Remove login credentials for https://registry-1.docker.io/v2/ ``` +Remove login credentials for all registries. ``` $ podman logout --all -Remove login credentials for all registries ``` ## SEE ALSO diff --git a/docs/source/markdown/podman-machine-info.1.md b/docs/source/markdown/podman-machine-info.1.md index 933444d4fc..2cc85e100f 100644 --- a/docs/source/markdown/podman-machine-info.1.md +++ b/docs/source/markdown/podman-machine-info.1.md @@ -28,6 +28,7 @@ Print usage statement. ## EXAMPLES +Display default Podman machine info. ``` $ podman machine info Host: @@ -52,6 +53,7 @@ Version: Version: 4.4.0 ``` +Display default Podman machine info formatted as json. ``` $ podman machine info --format json { @@ -80,6 +82,7 @@ $ podman machine info --format json } ``` +Display default Podman machine Host.Arch field. ``` $ podman machine info --format "{{ .Host.Arch }}" amd64 diff --git a/docs/source/markdown/podman-machine-init.1.md.in b/docs/source/markdown/podman-machine-init.1.md.in index 3a3d023004..17fde730d7 100644 --- a/docs/source/markdown/podman-machine-init.1.md.in +++ b/docs/source/markdown/podman-machine-init.1.md.in @@ -167,14 +167,43 @@ Driver to use for mounting volumes from the host, such as `virtfs`. ## EXAMPLES +Initialize the default Podman machine, pulling the content from the internet. ``` $ podman machine init +``` + +Initialize a Podman machine for the specified name pulling the content from the internet. +``` $ podman machine init myvm +``` + +Initialize the default Podman machine pulling the content from the internet defaulting to rootful mode. The default is rootless. +``` $ podman machine init --rootful +``` + +Initialize the default Podman machine overriding its disk size override, pulling the content from the internet. +``` $ podman machine init --disk-size 50 +``` + +Initialize the specified Podman machine overriding its memory size, pulling the content from the internet. +``` $ podman machine init --memory=1024 myvm +``` + +Initialize the default Podman machine with the host directory `/Users` mounted into the VM at `/mnt/Users`. +``` $ podman machine init -v /Users:/mnt/Users +``` + +Initialize the default Podman machine with a usb device passthrough specified with options. Only supported for QEMU Machines. +``` $ podman machine init --usb vendor=13d3,product=5406 +``` + +Initialize the default Podman machine with a usb device passthrough with specified with options. Only supported for QEMU Machines. +``` $ podman machine init --usb bus=1,devnum=3 ``` diff --git a/docs/source/markdown/podman-machine-inspect.1.md b/docs/source/markdown/podman-machine-inspect.1.md index d290ef9529..fdf682c26a 100644 --- a/docs/source/markdown/podman-machine-inspect.1.md +++ b/docs/source/markdown/podman-machine-inspect.1.md @@ -43,6 +43,7 @@ Print usage statement. ## EXAMPLES +Inspect the specified Podman machine. ``` $ podman machine inspect podman-machine-default ``` diff --git a/docs/source/markdown/podman-machine-list.1.md.in b/docs/source/markdown/podman-machine-list.1.md.in index 56db789e26..6e5568c077 100644 --- a/docs/source/markdown/podman-machine-list.1.md.in +++ b/docs/source/markdown/podman-machine-list.1.md.in @@ -62,15 +62,22 @@ is printed. ## EXAMPLES +List all Podman machines. ``` $ podman machine list NAME VM TYPE CREATED LAST UP CPUS MEMORY DISK SIZE podman-machine-default qemu 2 weeks ago 2 weeks ago 1 2.147GB 10.74GB +``` +List all Podman machines using the specified table format. +``` $ podman machine ls --format "table {{.Name}}\t{{.VMType}}\t{{.Created}}\t{{.LastUp}}" NAME VM TYPE CREATED LAST UP podman-machine-default qemu 2 weeks ago 2 weeks ago +``` +List all Podman machines in json format. +``` $ podman machine ls --format json [ { diff --git a/docs/source/markdown/podman-machine-os-apply.1.md b/docs/source/markdown/podman-machine-os-apply.1.md index c1699d3945..928deaaa70 100644 --- a/docs/source/markdown/podman-machine-os-apply.1.md +++ b/docs/source/markdown/podman-machine-os-apply.1.md @@ -32,8 +32,13 @@ Restart VM after applying changes. ## EXAMPLES +Update the default Podman machine to the specified bootable OCI image. ``` $ podman machine os apply quay.io/podman_next +``` + +Update the specified Podman machine to the specified bootable OCI image. +``` $ podman machine os apply quay.io/podman_next podman-machine-default ``` diff --git a/docs/source/markdown/podman-machine-rm.1.md b/docs/source/markdown/podman-machine-rm.1.md index 9aa90c35ad..49a5c8420f 100644 --- a/docs/source/markdown/podman-machine-rm.1.md +++ b/docs/source/markdown/podman-machine-rm.1.md @@ -41,8 +41,7 @@ Do not delete the VM image. ## EXAMPLES -Remove a VM named "test1": - +Remove the specified Podman machine. ``` $ podman machine rm test1 @@ -55,6 +54,7 @@ The following files will be deleted: Are you sure you want to continue? [y/N] y ``` +Remove the specified Podman machine even if it is running. ``` $ podman machine rm -f test1 $ diff --git a/docs/source/markdown/podman-machine-set.1.md.in b/docs/source/markdown/podman-machine-set.1.md.in index 1f0e416479..ee5ee92a3c 100644 --- a/docs/source/markdown/podman-machine-set.1.md.in +++ b/docs/source/markdown/podman-machine-set.1.md.in @@ -70,24 +70,24 @@ devices with the same vendor product value, the first available device is assign ## EXAMPLES -To switch the default VM `podman-machine-default` from rootless to rootful: +To switch the default Podman machine from rootless to rootful: ``` $ podman machine set --rootful ``` -or more explicitly: +or more explicitly set with value true. ``` $ podman machine set --rootful=true ``` -To switch the default VM `podman-machine-default` from rootful to rootless: +Switch the default Podman machine from rootful to rootless. ``` $ podman machine set --rootful=false ``` -To switch the VM `myvm` from rootless to rootful: +Switch the specified Podman machine from rootless to rootful. ``` $ podman machine set --rootful myvm ``` diff --git a/docs/source/markdown/podman-machine-ssh.1.md b/docs/source/markdown/podman-machine-ssh.1.md index eda566d0db..72a14dc4f2 100644 --- a/docs/source/markdown/podman-machine-ssh.1.md +++ b/docs/source/markdown/podman-machine-ssh.1.md @@ -62,25 +62,21 @@ the exit codes follow the `chroot` standard, see below: ## EXAMPLES -To get an interactive session with the default virtual machine: +To get an interactive session with the default Podman machine: +SSH into the default Podman machine. ``` $ podman machine ssh ``` -To get an interactive session with a VM called `myvm`: +Run command inside the default Podman machine via ssh. ``` $ podman machine ssh myvm ``` -To run a command on the default virtual machine: +Run command inside the specified Podman machine via ssh. ``` -$ podman machine ssh rpm -q podman -``` - -To run a command on a VM called `myvm`: -``` -$ podman machine ssh myvm rpm -q podman +$ podman machine ssh myvm rpm -q podman ``` ## SEE ALSO diff --git a/docs/source/markdown/podman-machine-start.1.md b/docs/source/markdown/podman-machine-start.1.md index c3ba5bbfba..853d62e1b1 100644 --- a/docs/source/markdown/podman-machine-start.1.md +++ b/docs/source/markdown/podman-machine-start.1.md @@ -41,6 +41,7 @@ Suppress machine starting status output. ## EXAMPLES +Start the specified podman machine. ``` $ podman machine start myvm ``` diff --git a/docs/source/markdown/podman-machine-stop.1.md b/docs/source/markdown/podman-machine-stop.1.md index cb136aaf14..985a3a5257 100644 --- a/docs/source/markdown/podman-machine-stop.1.md +++ b/docs/source/markdown/podman-machine-stop.1.md @@ -30,6 +30,7 @@ Print usage statement. ## EXAMPLES +Stop a podman machine named myvm. ``` $ podman machine stop myvm ``` diff --git a/docs/source/markdown/podman-manifest-create.1.md.in b/docs/source/markdown/podman-manifest-create.1.md.in index 1405940813..3d9e620970 100644 --- a/docs/source/markdown/podman-manifest-create.1.md.in +++ b/docs/source/markdown/podman-manifest-create.1.md.in @@ -32,18 +32,25 @@ preexisting list instead of exiting with an error. The contents of ## EXAMPLES +Create the specified manifest. ``` podman manifest create mylist:v1.11 9cfd24048d5fc80903f088f1531a21bff01172abe66effa8941a4c2308dc745f +``` + +Create the specified manifest manifest or modify it if it previously exist. +``` podman manifest create --amend mylist:v1.11 9cfd24048d5fc80903f088f1531a21bff01172abe66effa8941a4c2308dc745f ``` +Create the named manifest including the specified image matching the current platform. ``` podman manifest create mylist:v1.11 docker://fedora 5c2bc76bfb4ba6665a7973f7e1c05ee0536b4580637f27adc9fa5a4b2bc03cf1 ``` +Create the named manifest including all images referred to with the specified image reference. ``` podman manifest create --all mylist:v1.11 docker://fedora 30330571e79c65288a4fca421d9aed29b0210d57294d9c2056743fdcf6e3967b diff --git a/docs/source/markdown/podman-manifest-inspect.1.md.in b/docs/source/markdown/podman-manifest-inspect.1.md.in index 27ce5f4326..fe0f2e3e97 100644 --- a/docs/source/markdown/podman-manifest-inspect.1.md.in +++ b/docs/source/markdown/podman-manifest-inspect.1.md.in @@ -21,6 +21,7 @@ A formatted JSON representation of the manifest list or image index. ## EXAMPLES +Inspect the manifest of mylist:v1.11. ``` podman manifest inspect mylist:v1.11 ``` diff --git a/docs/source/markdown/podman-pause.1.md.in b/docs/source/markdown/podman-pause.1.md.in index a85827a6a6..4c5030b6ab 100644 --- a/docs/source/markdown/podman-pause.1.md.in +++ b/docs/source/markdown/podman-pause.1.md.in @@ -69,7 +69,7 @@ podman pause --cidfile /home/user/cidfile-1 podman pause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 ``` -Pause the latest container created by Podman. +Pause the latest container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` podman pause --latest ``` diff --git a/docs/source/markdown/podman-pod-clone.1.md.in b/docs/source/markdown/podman-pod-clone.1.md.in index 1ab91908ca..5a15ecd186 100644 --- a/docs/source/markdown/podman-pod-clone.1.md.in +++ b/docs/source/markdown/podman-pod-clone.1.md.in @@ -99,22 +99,27 @@ clone process has completed. All containers within the pod are started. @@option volumes-from ## EXAMPLES + +Clone the specified pod to a new pod. ``` # podman pod clone pod-name 6b2c73ff8a1982828c9ae2092954bcd59836a131960f7e05221af9df5939c584 ``` +Clone the specified pod to a new pod with a new name. ``` -# podman pod clone --name=cloned-pod +# podman pod clone pod-name --name=cloned-pod d0cf1f782e2ed67e8c0050ff92df865a039186237a4df24d7acba5b1fa8cc6e7 6b2c73ff8a1982828c9ae2092954bcd59836a131960f7e05221af9df5939c584 ``` +Clone and remove the specified pod to a new pod modifying its cpus. ``` -# podman pod clone --destroy --cpus=5 d0cf1f782e2ed67e8c0050ff92df865a039186237a4df24d7acba5b1fa8cc6e7 +# podman pod clone --destroy --cpus=5 d0cf1 6b2c73ff8a1982828c9ae2092954bcd59836a131960f7e05221af9df5939c584 ``` +Clone the specified pod to a new named pod. ``` # podman pod clone 2d4d4fca7219b4437e0d74fcdc272c4f031426a6eacd207372691207079551de new_name 5a9b7851013d326aa4ac4565726765901b3ecc01fcbc0f237bc7fd95588a24f9 diff --git a/docs/source/markdown/podman-pod-create.1.md.in b/docs/source/markdown/podman-pod-create.1.md.in index 46f52d3966..70bfbd7663 100644 --- a/docs/source/markdown/podman-pod-create.1.md.in +++ b/docs/source/markdown/podman-pod-create.1.md.in @@ -181,23 +181,43 @@ Note: This option conflicts with the **--share=cgroup** option since that option ## EXAMPLES +Create a named pod. ``` $ podman pod create --name test +``` +Create a named pod. +``` $ podman pod create mypod +``` +Create a pod without an infra container. +``` $ podman pod create --infra=false +``` +Create a named pod with infra container command to run. +``` $ podman pod create --infra-command /top toppod +``` +Create a pod with published ports on the host. +``` $ podman pod create --publish 8443:443 +``` +Create a pod with the specified network configuration. +``` $ podman pod create --network slirp4netns:outbound_addr=127.0.0.1,allow_host_loopback=true +``` -$ podman pod create --network slirp4netns:cidr=192.168.0.0/24 - +Create a pod with the specified network. +``` $ podman pod create --network pasta +``` +Create a pod on two networks. +``` $ podman pod create --network net1:ip=10.89.1.5 --network net2:ip=10.89.10.10 ``` diff --git a/docs/source/markdown/podman-pod-kill.1.md.in b/docs/source/markdown/podman-pod-kill.1.md.in index 69a34210ce..2c65ff5b47 100644 --- a/docs/source/markdown/podman-pod-kill.1.md.in +++ b/docs/source/markdown/podman-pod-kill.1.md.in @@ -35,7 +35,7 @@ Terminate pod by sending `TERM` signal podman pod kill --signal TERM 860a4b23 ``` -Kill the latest pod created by Podman +Kill the latest pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` podman pod kill --latest ``` diff --git a/docs/source/markdown/podman-pod-prune.1.md b/docs/source/markdown/podman-pod-prune.1.md index 5dfb145170..4361467c40 100644 --- a/docs/source/markdown/podman-pod-prune.1.md +++ b/docs/source/markdown/podman-pod-prune.1.md @@ -15,7 +15,8 @@ podman-pod-prune - Remove all stopped pods and their containers Force removal of all running pods and their containers. The default is false. ## EXAMPLES -Remove all stopped pods and their containers from local storage + +Remove all stopped pods and their containers from local storage. ``` $ sudo podman pod prune 22b8813332948064b6566370088c5e0230eeaf15a58b1c5646859fd9fc364fe7 diff --git a/docs/source/markdown/podman-pod-ps.1.md.in b/docs/source/markdown/podman-pod-ps.1.md.in index a41d59541c..1431ee2375 100644 --- a/docs/source/markdown/podman-pod-ps.1.md.in +++ b/docs/source/markdown/podman-pod-ps.1.md.in @@ -124,6 +124,7 @@ Default: created ## EXAMPLES +List all running pods. ``` $ podman pod ps POD ID NAME STATUS CREATED INFRA ID # OF CONTAINERS @@ -131,6 +132,7 @@ POD ID NAME STATUS CREATED INFRA ID # OF f4df8692e116 nifty_torvalds Created 10 minutes ago 331693bff40a 2 ``` +List all running pods along with container names within the pods. ``` $ podman pod ps --ctr-names POD ID NAME STATUS CREATED INFRA ID NAMES @@ -138,6 +140,7 @@ POD ID NAME STATUS CREATED INFRA ID NAMES f4df8692e116 nifty_torvalds Created 10 minutes ago 331693bff40a thirsty_hawking,wizardly_golick ``` +List all running pods along with status, names and ids. ``` $ podman pod ps --ctr-status --ctr-names --ctr-ids POD ID NAME STATUS CREATED INFRA ID IDS NAMES STATUS @@ -145,18 +148,21 @@ POD ID NAME STATUS CREATED INFRA ID IDS f4df8692e116 nifty_torvalds Created 10 minutes ago 331693bff40a 331693bff40a,8e428daeb89e thirsty_hawking,wizardly_golick configured,configured ``` +List all running pods and print ID, Container Names, and cgroups. ``` $ podman pod ps --format "{{.ID}} {{.ContainerNames}} {{.Cgroup}}" 00dfd6fa02c0 loving_archimedes /libpod_parent f4df8692e116 thirsty_hawking,wizardly_golick /libpod_parent ``` +List all running pods with two containers sorted by pod ID. ``` $ podman pod ps --sort id --filter ctr-number=2 POD ID NAME STATUS CREATED INFRA ID # OF CONTAINERS f4df8692e116 nifty_torvalds Created 10 minutes ago 331693bff40a 2 ``` +List all running pods with their container ids. ``` $ podman pod ps --ctr-ids POD ID NAME STATUS CREATED INFRA ID IDS @@ -164,6 +170,7 @@ POD ID NAME STATUS CREATED INFRA ID IDS f4df8692e116 nifty_torvalds Created 10 minutes ago 331693bff40a 331693bff40a,8e428daeb89e ``` +List all running pods with container ids without truncating IDs. ``` $ podman pod ps --no-trunc --ctr-ids POD ID NAME STATUS CREATED INFRA ID IDS @@ -171,6 +178,7 @@ POD ID NAME f4df8692e116a3e6d1d62572644ed36ca475d933808cc3c93435c45aa139314b nifty_torvalds Created 10 minutes ago 331693bff40a926b6d52b184e116afd15497610c378d5d4c42945dd6e33b75b0 331693bff40a926b6d52b184e116afd15497610c378d5d4c42945dd6e33b75b0,8e428daeb89e69b71e7916a13accfb87d122889442b5c05c2d99cf94a3230e9d ``` +List all running pods with container names. ``` $ podman pod ps --ctr-names POD ID NAME STATUS CREATED INFRA ID NAMES diff --git a/docs/source/markdown/podman-pod-start.1.md.in b/docs/source/markdown/podman-pod-start.1.md.in index 5a681ba378..fd59736472 100644 --- a/docs/source/markdown/podman-pod-start.1.md.in +++ b/docs/source/markdown/podman-pod-start.1.md.in @@ -32,7 +32,7 @@ Start pods with given IDs podman pod start 860a4b23 5421ab4 ``` -Start the latest pod created by Podman +Start the latest pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` podman pod start --latest ``` diff --git a/docs/source/markdown/podman-pod-stop.1.md.in b/docs/source/markdown/podman-pod-stop.1.md.in index 75650eafa8..2763bcea47 100644 --- a/docs/source/markdown/podman-pod-stop.1.md.in +++ b/docs/source/markdown/podman-pod-stop.1.md.in @@ -25,7 +25,7 @@ Stops all pods ## EXAMPLE -Stop pod with a given name +Stop pod with a given name. ``` $ podman pod stop mywebserverpod cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907 @@ -38,13 +38,13 @@ $ podman pod stop 490eb 3557fb 3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab ``` -Stop the last created pod +Stop the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` $ podman pod stop --latest 3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab ``` -Stop all pods +Stop all pods. ``` $ podman pod stop --all 19456b4cd557eaf9629825113a552681a6013f8c8cad258e36ab825ef536e818 @@ -54,14 +54,14 @@ $ podman pod stop --all cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907 ``` -Stop two pods via --pod-id-file +Stop two pods via --pod-id-file. ``` $ podman pod stop --pod-id-file file1 --pod-id-file file2 19456b4cd557eaf9629825113a552681a6013f8c8cad258e36ab825ef536e818 cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907 ``` -Stop all pods with a timeout of 1 second +Stop all pods with a timeout of 1 second. ``` $ podman pod stop -a -t 1 3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab diff --git a/docs/source/markdown/podman-pod-top.1.md.in b/docs/source/markdown/podman-pod-top.1.md.in index 537cb9d0fc..2bdd55590a 100644 --- a/docs/source/markdown/podman-pod-top.1.md.in +++ b/docs/source/markdown/podman-pod-top.1.md.in @@ -25,8 +25,8 @@ For a full list of available descriptors, see podman-top(1) ## EXAMPLES +Print top data for the specified pod. By default, `podman-pod-top` prints data similar to `ps -ef`: - ``` $ podman pod top b031293491cc USER PID PPID %CPU ELAPSED TTY TIME COMMAND @@ -34,8 +34,9 @@ root 1 0 0.000 2h5m38.737137571s ? 0s top root 8 0 0.000 2h5m15.737228361s ? 0s top ``` -The output can be controlled by specifying format descriptors as arguments after the pod: +The output can be controlled by specifying format descriptors as arguments after the pod. +Print the pod top data fields pid,seccomp, args and %C on the latest pod created. (This -l option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` $ podman pod top -l pid seccomp args %C PID SECCOMP COMMAND %CPU diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md index 55230f9927..7345e89bec 100644 --- a/docs/source/markdown/podman-ps.1.md +++ b/docs/source/markdown/podman-ps.1.md @@ -28,7 +28,7 @@ all the containers information. By default it lists: #### **--all**, **-a** -Show all the containers created by Podman, default is only running containers. +Show all the containers, default is only running containers. Note: Podman shares containers storage with other tools such as Buildah and CRI-O. In some cases these `external` containers might also exist in the same storage. Use the `--external` option to see these external containers. External containers show the 'storage' status. @@ -154,6 +154,15 @@ Refresh the output with current containers on an interval in seconds. ## EXAMPLES +List running containers. +``` +$ podman ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +4089df24d4f3 docker.io/library/centos:latest /bin/bash 2 minutes ago Up 2 minutes 0.0.0.0:80->8080/tcp, 0.0.0.0:2000-2006->2000-2006/tcp manyports +92f58933c28c docker.io/library/centos:latest /bin/bash 3 minutes ago Up 3 minutes 192.168.99.100:1000-1006->1000-1006/tcp zen_sanderson +``` + +List all containers. ``` $ podman ps -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES @@ -161,6 +170,7 @@ CONTAINER ID IMAGE COMMAND CREATED STATUS 69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 ``` +List all containers including their size. Note: this can take longer since Podman needs to calculate the size from the file system. ``` $ podman ps -a -s CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES SIZE @@ -168,12 +178,14 @@ CONTAINER ID IMAGE COMMAND CREATED STATUS 69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 27.49 MB ``` +List all containers, running or not, using a custom Go format. ``` $ podman ps -a --format "{{.ID}} {{.Image}} {{.Labels}} {{.Mounts}}" 02f65160e14ca redis:alpine tier=backend proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/ 69ed779d8ef9f redis:alpine batch=no,type=small proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/ ``` +List all containers and display their namespaces. ``` $ podman ps --ns -a CONTAINER ID NAMES PID CGROUP IPC MNT NET PIDNS USER UTS @@ -182,6 +194,7 @@ CONTAINER ID NAMES a31ebbee9cee7 k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 29717 4026531835 4026532585 4026532587 4026532508 4026532589 4026531837 4026532588 ``` +List all containers including size sorted by names. ``` $ podman ps -a --size --sort names CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES @@ -189,14 +202,7 @@ CONTAINER ID IMAGE COMMAND CREATED STATUS 02f65160e14ca redis:alpine "redis-server" 19 hours ago Exited (-1) 19 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 ``` -``` -$ podman ps -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -4089df24d4f3 docker.io/library/centos:latest /bin/bash 2 minutes ago Up 2 minutes 0.0.0.0:80->8080/tcp, 0.0.0.0:2000-2006->2000-2006/tcp manyports -92f58933c28c docker.io/library/centos:latest /bin/bash 3 minutes ago Up 3 minutes 192.168.99.100:1000-1006->1000-1006/tcp zen_sanderson - -``` - +List all external containers created by tools other than Podman. ``` $ podman ps --external -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES diff --git a/docs/source/markdown/podman-rename.1.md b/docs/source/markdown/podman-rename.1.md index 1c25ef0d8f..0818c83f16 100644 --- a/docs/source/markdown/podman-rename.1.md +++ b/docs/source/markdown/podman-rename.1.md @@ -19,17 +19,17 @@ At present, only containers are supported; pods and volumes cannot be renamed. ## EXAMPLES -Rename container with a given name +Rename container with a given name. ``` $ podman rename oldContainer aNewName ``` -Rename container with a given ID +Rename container with a given ID. ``` $ podman rename 717716c00a6b testcontainer ``` -Create an alias for container with a given ID +Create an alias for container with a given ID. ``` $ podman container rename 6e7514b47180 databaseCtr ``` diff --git a/docs/source/markdown/podman-restart.1.md.in b/docs/source/markdown/podman-restart.1.md.in index d05efc5643..c1909734bd 100644 --- a/docs/source/markdown/podman-restart.1.md.in +++ b/docs/source/markdown/podman-restart.1.md.in @@ -57,31 +57,31 @@ Restart all containers that are already in the *running* state. ## EXAMPLES -Restart the latest container +Restart the latest container. ``` $ podman restart -l ec588fc80b05e19d3006bf2e8aa325f0a2e2ff1f609b7afb39176ca8e3e13467 ``` -Restart a specific container by partial container ID +Restart a specific container by partial container ID. ``` $ podman restart ff6cf1 ff6cf1e5e77e6dba1efc7f3fcdb20e8b89ad8947bc0518be1fcb2c78681f226f ``` -Restart two containers by name with a timeout of 4 seconds +Restart two containers by name with a timeout of 4 seconds. ``` $ podman restart --time 4 test1 test2 c3bb026838c30e5097f079fa365c9a4769d52e1017588278fa00d5c68ebc1502 17e13a63081a995136f907024bcfe50ff532917988a152da229db9d894c5a9ec ``` -Restart all running containers +Restart all running containers. ``` $ podman restart --running ``` -Restart all containers +Restart all containers. ``` $ podman restart --all ``` diff --git a/docs/source/markdown/podman-rm.1.md.in b/docs/source/markdown/podman-rm.1.md.in index 3595018358..caead560aa 100644 --- a/docs/source/markdown/podman-rm.1.md.in +++ b/docs/source/markdown/podman-rm.1.md.in @@ -105,7 +105,7 @@ Remove all containers regardless of the run state $ podman rm -f -a ``` -Forcibly remove the last created container +Forcibly remove the last created container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` $ podman rm -f --latest ``` diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index 54ad0dbf6a..3f7fc5e917 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -464,12 +464,15 @@ to volumes if they need to write to file systems at all. Applications can be made more secure by running them in read-only mode using the **--read-only** switch. This protects the container's image from modification. By default read-only containers can write to temporary data. Podman mounts a tmpfs on _/run_ and -_/tmp_ within the container. If the container does not write to any file -system within the container, including tmpfs, set --read-only-tmpfs=false. +_/tmp_ within the container. ``` $ podman run --read-only -i -t fedora /bin/bash +``` +If the container does not write to any file +system within the container, including tmpfs, set --read-only-tmpfs=false. +``` $ podman run --read-only --read-only-tmpfs=false --tmpfs /run -i -t fedora /bin/bash ``` diff --git a/docs/source/markdown/podman-save.1.md.in b/docs/source/markdown/podman-save.1.md.in index 72a8932a7b..342c39718f 100644 --- a/docs/source/markdown/podman-save.1.md.in +++ b/docs/source/markdown/podman-save.1.md.in @@ -62,18 +62,22 @@ Accept uncompressed layers when using one of the OCI formats. ## EXAMPLES +Save image to a local file without displaying progress. ``` $ podman save --quiet -o alpine.tar alpine:2.6 ``` +Save image to stdout and redirect content via shell. ``` -$ podman save > alpine-all.tar alpine +$ podman save alpine > alpine-all.tar ``` +Save image in oci-archive format to the local file. ``` $ podman save -o oci-alpine.tar --format oci-archive alpine ``` +Save image compressed in docker-dir format. ``` $ podman save --compress --format docker-dir -o alp-dir alpine Getting image source signatures @@ -85,25 +89,6 @@ Writing manifest to image destination Storing signatures ``` -``` -$ podman save --format docker-dir -o ubuntu-dir ubuntu -Getting image source signatures -Copying blob sha256:660c48dd555dcbfdfe19c80a30f557ac57a15f595250e67bfad1e5663c1725bb - 45.55 MB / 45.55 MB [======================================================] 8s -Copying blob sha256:4c7380416e7816a5ab1f840482c9c3ca8de58c6f3ee7f95e55ad299abbfe599f - 846 B / 846 B [============================================================] 0s -Copying blob sha256:421e436b5f80d876128b74139531693be9b4e59e4f1081c9a3c379c95094e375 - 620 B / 620 B [============================================================] 0s -Copying blob sha256:e4ce6c3651b3a090bb43688f512f687ea6e3e533132bcbc4a83fb97e7046cea3 - 849 B / 849 B [============================================================] 0s -Copying blob sha256:be588e74bd348ce48bb7161350f4b9d783c331f37a853a80b0b4abc0a33c569e - 169 B / 169 B [============================================================] 0s -Copying config sha256:20c44cd7596ff4807aef84273c99588d22749e2a7e15a7545ac96347baa65eda - 3.53 KB / 3.53 KB [========================================================] 0s -Writing manifest to image destination -Storing signatures -``` - ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-load(1)](podman-load.1.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[containers-transports(5)](https://github.com/containers/image/blob/main/docs/containers-transports.5.md)** diff --git a/docs/source/markdown/podman-search.1.md.in b/docs/source/markdown/podman-search.1.md.in index 9bd0be6e8b..1991254b5f 100644 --- a/docs/source/markdown/podman-search.1.md.in +++ b/docs/source/markdown/podman-search.1.md.in @@ -95,18 +95,20 @@ Do not truncate the output (default *false*). ## EXAMPLES +Search for images containing the specified name, returning the first three images from each defined registry. ``` $ podman search --limit 3 fedora NAME DESCRIPTION -registry.centos.org/centos -registry.centos.org/cdrage/mosh-centos7 -registry.centos.org/centos/bind -docker.io/library/centos The official build of CentOS. -docker.io/jdeathe/centos-ssh OpenSSH / Supervisor / EPEL/IUS/SCL Repos - ... -docker.io/ansible/centos7-ansible Ansible on Centos7 -quay.io/centos/centos The official CentOS base containers. -quay.io/ukhomeofficedigital/centos-base -quay.io/quarkus/centos-quarkus-maven Quarkus.io builder image for building Quarku... +NAME DESCRIPTION +registry.fedoraproject.org/f29/fedora-toolbox +registry.fedoraproject.org/f30/fedora-toolbox +registry.fedoraproject.org/f31/fedora-toolbox +docker.io/library/fedora Official Docker builds of Fedora +docker.io/kasmweb/fedora-37-desktop Fedora 37 desktop for Kasm Workspaces +docker.io/kasmweb/fedora-38-desktop Fedora 38 desktop for Kasm Workspaces +quay.io/fedora/fedora +quay.io/containerdisks/fedora # Fedora Containerdisk Images ``` -To start the systemd socket for the rootful service, run: - +Start the systemd socket for the rootful service. ``` sudo systemctl start podman.socket ``` -To configure the socket to be automatically started after reboots, run: - +Configure the socket to be automatically started after reboots. ``` sudo systemctl enable podman.socket ``` @@ -132,8 +126,7 @@ sudo systemctl enable podman.socket It is possible to run the API without using systemd socket activation. In this case the API will not be available on demand because the command will stay terminated after the inactivity timeout has passed. -Run an API with an inactivity timeout of 5 seconds without using socket activation: - +Run an API with an inactivity timeout of 5 seconds without using socket activation. ``` podman system service --time 5 ``` diff --git a/docs/source/markdown/podman-tag.1.md b/docs/source/markdown/podman-tag.1.md index 444f3891c3..f6e444976f 100644 --- a/docs/source/markdown/podman-tag.1.md +++ b/docs/source/markdown/podman-tag.1.md @@ -22,11 +22,18 @@ Print usage statement ## EXAMPLES +Tag specified image with an image name defaulting to :latest. ``` $ podman tag 0e3bbc2 fedora:latest +``` +Tag specified image with fully specified image name. +``` $ podman tag httpd myregistryhost:5000/fedora/httpd:v2 +``` +Tag specified image with multiple tags. +``` $ podman tag mymariadb mycontainerregistry.io/namespace/mariadb:10 mycontainerregistry.io/namespace/mariadb:10.11 mycontainerregistry.io/namespace/mariadb:10.11.12 ``` diff --git a/docs/source/markdown/podman-top.1.md.in b/docs/source/markdown/podman-top.1.md.in index c080081a5e..bbccbe87b0 100644 --- a/docs/source/markdown/podman-top.1.md.in +++ b/docs/source/markdown/podman-top.1.md.in @@ -78,8 +78,7 @@ The following descriptors are supported in addition to the AIX format descriptor ## EXAMPLES -By default, `podman-top` prints data similar to `ps -ef`: - +By default, `podman-top` prints data similar to `ps -ef`. ``` $ podman top f5a62a71b07 USER PID PPID %CPU ELAPSED TTY TIME COMMAND @@ -88,8 +87,7 @@ root 7 1 0.000 16.386882887s pts/0 0s sleep root 8 1 0.000 11.386886562s pts/0 0s vi ``` -The output can be controlled by specifying format descriptors as arguments after the container: - +The output can be controlled by specifying format descriptors as arguments after the container. ``` $ podman top -l pid seccomp args %C PID SECCOMP COMMAND %CPU @@ -98,7 +96,6 @@ PID SECCOMP COMMAND %CPU ``` Podman falls back to executing ps(1) from the host in the container namespace if an unknown descriptor is specified. - ``` $ podman top -l -- aux USER PID PPID %CPU ELAPSED TTY TIME COMMAND diff --git a/docs/source/markdown/podman-unpause.1.md.in b/docs/source/markdown/podman-unpause.1.md.in index b6acb9b457..adee477ec3 100644 --- a/docs/source/markdown/podman-unpause.1.md.in +++ b/docs/source/markdown/podman-unpause.1.md.in @@ -69,7 +69,7 @@ podman unpause --cidfile /home/user/cidfile-1 podman unpause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 ``` -Unpause the latest container created by Podman. +Unpause the latest container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) ``` podman unpause --latest ``` diff --git a/docs/source/markdown/podman-untag.1.md b/docs/source/markdown/podman-untag.1.md index 62513ce937..f6a99f3c7e 100644 --- a/docs/source/markdown/podman-untag.1.md +++ b/docs/source/markdown/podman-untag.1.md @@ -19,14 +19,20 @@ Print usage statement ## EXAMPLES +Remove all tags from the specified image. ``` $ podman untag 0e3bbc2 - -$ podman untag imageName:latest otherImageName:latest - -$ podman untag httpd myregistryhost:5000/fedora/httpd:v2 ``` +Remove tag from specified image. +``` +$ podman untag imageName:latest otherImageName:latest +``` + +Remove multiple tags from the specified image. +``` +$ podman untag httpd myhttpd myregistryhost:5000/fedora/httpd:v2 +``` ## SEE ALSO **[podman(1)](podman.1.md)** diff --git a/docs/source/markdown/podman-update.1.md.in b/docs/source/markdown/podman-update.1.md.in index a3540edd9a..913f6a7180 100644 --- a/docs/source/markdown/podman-update.1.md.in +++ b/docs/source/markdown/podman-update.1.md.in @@ -58,17 +58,17 @@ This command takes one argument, a container name or ID, alongside the resource ## EXAMPLEs -update a container with a new cpu quota and period +Update a container with a new cpu quota and period. ``` podman update --cpus=5 myCtr ``` -update a container with all available options for cgroups v2 +Update a container with all available options for cgroups v2. ``` podman update --cpus 5 --cpuset-cpus 0 --cpu-shares 123 --cpuset-mems 0 --memory 1G --memory-swap 2G --memory-reservation 2G --blkio-weight-device /dev/zero:123 --blkio-weight 123 --device-read-bps /dev/zero:10mb --device-write-bps /dev/zero:10mb --device-read-iops /dev/zero:1000 --device-write-iops /dev/zero:1000 --pids-limit 123 ctrID ``` -update a container with all available options for cgroups v1 +Update a container with all available options for cgroups v1. ``` podman update --cpus 5 --cpuset-cpus 0 --cpu-shares 123 --cpuset-mems 0 --memory 1G --memory-swap 2G --memory-reservation 2G --memory-swappiness 50 --pids-limit 123 ctrID ``` diff --git a/docs/source/markdown/podman-volume-create.1.md b/docs/source/markdown/podman-volume-create.1.md index f2222b6105..ca6e400909 100644 --- a/docs/source/markdown/podman-volume-create.1.md +++ b/docs/source/markdown/podman-volume-create.1.md @@ -71,17 +71,33 @@ When not using the **local** and **image** drivers, the given options are passed ## EXAMPLES +Create empty volume. +``` +$ podman volume create +``` + +Create empty named volume. ``` $ podman volume create myvol +``` -$ podman volume create - +Create empty named volume with specified label. +``` $ podman volume create --label foo=bar myvol +``` +Create tmpfs named volume with specified size and mount options. +``` # podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=size=2M,nodev,noexec myvol +``` +Create tmpfs named volume testvol with specified options. +``` # podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=uid=1000,gid=1000 testvol +``` +Create image named volume using the specified local image in containers/storage. +``` # podman volume create --driver image --opt image=fedora:latest fedoraVol ``` diff --git a/docs/source/markdown/podman-volume-export.1.md b/docs/source/markdown/podman-volume-export.1.md index ca98b35933..1257c7d2a6 100644 --- a/docs/source/markdown/podman-volume-export.1.md +++ b/docs/source/markdown/podman-volume-export.1.md @@ -28,6 +28,7 @@ Write to a file, default is STDOUT ## EXAMPLES +Export named volume content into the specified file. ``` $ podman volume export myvol --output myvol.tar diff --git a/docs/source/markdown/podman-volume-import.1.md b/docs/source/markdown/podman-volume-import.1.md index 84c402d5c5..ba59d9dd23 100644 --- a/docs/source/markdown/podman-volume-import.1.md +++ b/docs/source/markdown/podman-volume-import.1.md @@ -22,14 +22,19 @@ Print usage statement ## EXAMPLES -``` -$ gunzip -c hello.tar.gz | podman volume import myvol - -``` +Import named volume content from the specified file. ``` $ podman volume import myvol test.tar ``` + +Import named volume content from stdin. ``` -$ podman volume export myvol | podman volume import oldmyvol - +$ gunzip -c hello.tar.gz | podman volume import myvol - +``` + +Export the content from named volume and pipe it into the named volume via stdin. +``` +$ podman volume export oldmyvol | podman volume import myvol - ``` ## SEE ALSO diff --git a/docs/source/markdown/podman-volume-inspect.1.md b/docs/source/markdown/podman-volume-inspect.1.md index f5755308aa..7e7e831feb 100644 --- a/docs/source/markdown/podman-volume-inspect.1.md +++ b/docs/source/markdown/podman-volume-inspect.1.md @@ -53,6 +53,7 @@ Print usage statement ## EXAMPLES +Inspect named volume. ``` $ podman volume inspect myvol [ @@ -71,6 +72,7 @@ $ podman volume inspect myvol ] ``` +Inspect all volumes. ``` $ podman volume inspect --all [ @@ -89,6 +91,7 @@ $ podman volume inspect --all ] ``` +Inspect named volume and display its Driver and Scope field. ``` $ podman volume inspect --format "{{.Driver}} {{.Scope}}" myvol local local diff --git a/docs/source/markdown/podman-volume-ls.1.md.in b/docs/source/markdown/podman-volume-ls.1.md.in index eb0cb7447c..64e84b518e 100644 --- a/docs/source/markdown/podman-volume-ls.1.md.in +++ b/docs/source/markdown/podman-volume-ls.1.md.in @@ -74,15 +74,28 @@ Print volume output in quiet mode. Only print the volume names. ## EXAMPLES +List all volumes. ``` $ podman volume ls +``` +List all volumes and display content as json format. +``` $ podman volume ls --format json +``` +List all volumes and display their Driver and Scope fields +``` $ podman volume ls --format "{{.Driver}} {{.Scope}}" +``` +List volumes with the name foo and label blue. +``` $ podman volume ls --filter name=foo,label=blue +``` +List volumes with the label key=value. +``` $ podman volume ls --filter label=key=value ``` diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md index 41120cff1e..3dd585f3d2 100644 --- a/docs/source/markdown/podman-volume-prune.1.md +++ b/docs/source/markdown/podman-volume-prune.1.md @@ -49,11 +49,19 @@ Print usage statement ## EXAMPLES + +Prune all unused volumes. ``` $ podman volume prune +``` +Prune all volumes. Note: this command will also remove all containers that are using a volume. +``` $ podman volume prune --force +``` +Prune all volumes that contain the specified label. +``` $ podman volume prune --filter label=mylabel=mylabelvalue ``` diff --git a/docs/source/markdown/podman-volume-reload.1.md b/docs/source/markdown/podman-volume-reload.1.md index 4e2d97b918..6ede2f2172 100644 --- a/docs/source/markdown/podman-volume-reload.1.md +++ b/docs/source/markdown/podman-volume-reload.1.md @@ -17,6 +17,7 @@ Note: This command is not supported with podman-remote. ## EXAMPLES +Reload the volume plugins. ``` $ podman volume reload Added: diff --git a/docs/source/markdown/podman-volume-rm.1.md b/docs/source/markdown/podman-volume-rm.1.md index 7faf30c3b1..5e9cceaf1a 100644 --- a/docs/source/markdown/podman-volume-rm.1.md +++ b/docs/source/markdown/podman-volume-rm.1.md @@ -34,11 +34,18 @@ Seconds to wait before forcibly stopping running containers that are using the s ## EXAMPLES +Remove multiple specified volumes. ``` $ podman volume rm myvol1 myvol2 +``` +Remove all volumes. +``` $ podman volume rm --all +``` +Remove the specified volume even if it is in use. Note, this removes all containers using the volume. +``` $ podman volume rm --force myvol ``` diff --git a/docs/source/markdown/podman-wait.1.md.in b/docs/source/markdown/podman-wait.1.md.in index 3ffacb5e49..e0a1a0fd79 100644 --- a/docs/source/markdown/podman-wait.1.md.in +++ b/docs/source/markdown/podman-wait.1.md.in @@ -41,23 +41,39 @@ Ignore errors when a specified container is missing and mark its return code as ## EXAMPLES +Wait for the specified container to exit. ``` $ podman wait mywebserver 0 +``` +Wait for the latest container to exit. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +``` $ podman wait --latest 0 +``` -$ podman wait --interval 2s +Wait up to 2 seconds the specified container to exit. +``` +$ podman wait --interval 2s mywebserver 0 +``` +Wait for the specified container to exit with a failure. +``` $ podman wait 860a4b23 1 +``` +Wait for both specified containers to exit. +``` $ podman wait mywebserver myftpserver 0 125 +``` +Wait for does-not-exist container to exit, but do not fail if container does not exist. +``` $ podman wait --ignore does-not-exist -1 ```