diff options
Diffstat (limited to 'docs')
35 files changed, 142 insertions, 22 deletions
diff --git a/docs/podman-attach.1.md b/docs/podman-attach.1.md index 4322ca2be..ceb945a0e 100644 --- a/docs/podman-attach.1.md +++ b/docs/podman-attach.1.md @@ -24,6 +24,8 @@ ctrl-[value] where [value] is one of: a-z, @, ^, [, , or _. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--no-stdin** Do not attach STDIN. The default is false. diff --git a/docs/podman-build.1.md b/docs/podman-build.1.md index 76e16b42c..fdae48b93 100644 --- a/docs/podman-build.1.md +++ b/docs/podman-build.1.md @@ -362,6 +362,12 @@ Specifies the name which will be assigned to the resulting image if the build process completes successfully. If _imageName_ does not include a registry name, the registry name *localhost* will be prepended to the image name. +**--target** *stageName* + +Set the target build stage to build. When building a Dockerfile with multiple build stages, --target +can be used to specify an intermediate build stage by name as the final stage for the resulting image. +Commands after the target stage will be skipped. + **--tls-verify** *bool-value* Require HTTPS and verify certificates when talking to container registries (defaults to true). diff --git a/docs/podman-container-checkpoint.1.md b/docs/podman-container-checkpoint.1.md index 94e52dc78..666dbbb80 100644 --- a/docs/podman-container-checkpoint.1.md +++ b/docs/podman-container-checkpoint.1.md @@ -25,6 +25,8 @@ Checkpoint all running containers. Instead of providing the container name or ID, checkpoint the last created container. +The latest option is not supported on the remote client. + **--leave-running, -R** Leave the container running after checkpointing instead of stopping it. diff --git a/docs/podman-container-cleanup.1.md b/docs/podman-container-cleanup.1.md index 2819d1138..2ad39d214 100644 --- a/docs/podman-container-cleanup.1.md +++ b/docs/podman-container-cleanup.1.md @@ -19,6 +19,9 @@ Cleanup all containers. **--latest, -l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. + +The latest option is not supported on the remote client. + ## EXAMPLE `podman container cleanup mywebserver` @@ -27,7 +30,7 @@ to run containers such as CRI-O, the last started container could be from either `podman container cleanup 860a4b23` -`podman container-cleanup -a` +`podman container cleanup -a` `podman container cleanup --latest` diff --git a/docs/podman-container-restore.1.md b/docs/podman-container-restore.1.md index 44219f3ef..e47d585cc 100644 --- a/docs/podman-container-restore.1.md +++ b/docs/podman-container-restore.1.md @@ -32,6 +32,8 @@ Restore all checkpointed containers. Instead of providing the container name or ID, restore the last created container. +The latest option is not supported on the remote client. + **--tcp-established** Restore a container with established TCP connections. If the checkpoint image diff --git a/docs/podman-diff.1.md b/docs/podman-diff.1.md index dd5f0edcf..8837b744f 100644 --- a/docs/podman-diff.1.md +++ b/docs/podman-diff.1.md @@ -15,6 +15,12 @@ Displays changes on a container or image's filesystem. The container or image w Alter the output into a different format. The only valid format for diff is `json`. +**--latest, -l** + +Instead of providing the container name or ID, use the last created container. If you use methods other than Podman +to run containers such as CRI-O, the last started container could be from either of those methods. + +The latest option is not supported on the remote client. ## EXAMPLE diff --git a/docs/podman-exec.1.md b/docs/podman-exec.1.md index 6f464a8f2..14088b468 100644 --- a/docs/podman-exec.1.md +++ b/docs/podman-exec.1.md @@ -24,6 +24,8 @@ Not supported. All exec commands are interactive by default. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--privileged** Give the process extended Linux capabilities when running the command in container. diff --git a/docs/podman-inspect.1.md b/docs/podman-inspect.1.md index b01bc0f4e..5748f29f4 100644 --- a/docs/podman-inspect.1.md +++ b/docs/podman-inspect.1.md @@ -27,6 +27,8 @@ The keys of the returned JSON can be used as the values for the --format flag (s Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--size, -s** Display the total file size if the type is a container diff --git a/docs/podman-kill.1.md b/docs/podman-kill.1.md index 85f68a73d..1c14b71d5 100644 --- a/docs/podman-kill.1.md +++ b/docs/podman-kill.1.md @@ -19,6 +19,8 @@ Signal all running containers. This does not include paused containers. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--signal, s** Signal to send to the container. For more information on Linux signals, refer to *man signal(7)*. diff --git a/docs/podman-load.1.md b/docs/podman-load.1.md index eca7ecb2e..8b6501a5c 100644 --- a/docs/podman-load.1.md +++ b/docs/podman-load.1.md @@ -22,7 +22,9 @@ Note: `:` is a restricted character and cannot be part of the file name. **--input, -i** -Read from archive file, default is STDIN +Read from archive file, default is STDIN. + +The remote client requires the use of this option. **--quiet, -q** diff --git a/docs/podman-logs.1.md b/docs/podman-logs.1.md index 71a798bc0..bc02df954 100644 --- a/docs/podman-logs.1.md +++ b/docs/podman-logs.1.md @@ -17,6 +17,13 @@ any logs at the time you execute podman logs Follow log output. Default is false +**--latest, -l** + +Instead of providing the container name or ID, use the last created container. If you use methods other than Podman +to run containers such as CRI-O, the last started container could be from either of those methods. + +The latest option is not supported on the remote client. + **--since=TIMESTAMP** Show logs since TIMESTAMP. The --since option can be Unix timestamps, date formatted timestamps, or Go duration @@ -61,7 +68,7 @@ podman logs --tail 2 b3f2436bdb97 To view a containers logs since a certain time: ``` -podman logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver +podman logs --since 2017-08-07T10:10:09.055837383-04:00 myserver 1:M 07 Aug 14:10:09.055 # Server can't set maximum open files to 10032 because of OS error: Operation not permitted. 1:M 07 Aug 14:10:09.055 # Current maximum open files is 4096. maxclients has been reduced to 4064 to compensate for low ulimit. If you need higher maxclients increase 'ulimit -n'. @@ -72,7 +79,7 @@ podman logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver To view a container's logs generated in the last 10 minutes: ``` -podman logs 224c375f27cd --since 10m myserver +podman logs --since 10m myserver 1:M 07 Aug 14:10:09.055 # Server can't set maximum open files to 10032 because of OS error: Operation not permitted. 1:M 07 Aug 14:10:09.055 # Current maximum open files is 4096. maxclients has been reduced to 4064 to compensate for low ulimit. If you need higher maxclients increase 'ulimit -n'. diff --git a/docs/podman-mount.1.md b/docs/podman-mount.1.md index 2cccf5ee0..e244e5daf 100644 --- a/docs/podman-mount.1.md +++ b/docs/podman-mount.1.md @@ -33,6 +33,8 @@ Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--notruncate** Do not truncate IDs in output. diff --git a/docs/podman-pod-inspect.1.md b/docs/podman-pod-inspect.1.md index b8fb143ba..a4e6a5559 100644 --- a/docs/podman-pod-inspect.1.md +++ b/docs/podman-pod-inspect.1.md @@ -16,6 +16,7 @@ that belong to the pod. Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman to run pods such as CRI-O, the last started pod could be from either of those methods. +The latest option is not supported on the remote client. ## EXAMPLE ``` diff --git a/docs/podman-pod-kill.1.md b/docs/podman-pod-kill.1.md index 4376c2d29..2a863d3d9 100644 --- a/docs/podman-pod-kill.1.md +++ b/docs/podman-pod-kill.1.md @@ -19,6 +19,8 @@ Sends signal to all containers associated with a pod. Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman to run pods such as CRI-O, the last started pod could be from either of those methods. +The latest option is not supported on the remote client. + **--signal, s** Signal to send to the containers in the pod. For more information on Linux signals, refer to *man signal(7)*. diff --git a/docs/podman-pod-pause.1.md b/docs/podman-pod-pause.1.md index 32c5b927e..418a9ee2a 100644 --- a/docs/podman-pod-pause.1.md +++ b/docs/podman-pod-pause.1.md @@ -19,6 +19,8 @@ Pause all pods. Instead of providing the pod name or ID, pause the last created pod. +The latest option is not supported on the remote client. + ## EXAMPLE podman pod pause mywebserverpod diff --git a/docs/podman-pod-ps.1.md b/docs/podman-pod-ps.1.md index 24b343438..ee215154a 100644 --- a/docs/podman-pod-ps.1.md +++ b/docs/podman-pod-ps.1.md @@ -42,6 +42,8 @@ Includes the container statuses in the container info field Show the latest pod created (all states) +The latest option is not supported on the remote client. + **--no-trunc** Display the extended information diff --git a/docs/podman-pod-restart.1.md b/docs/podman-pod-restart.1.md index 17fb4ed4c..cd6e5c8ce 100644 --- a/docs/podman-pod-restart.1.md +++ b/docs/podman-pod-restart.1.md @@ -22,8 +22,11 @@ Restarts all pods Instead of providing the pod name or ID, restart the last created pod. +The latest option is not supported on the remote client. + ## EXAMPLE +``` podman pod restart mywebserverpod cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907 @@ -31,8 +34,6 @@ podman pod restart 490eb 3557fb 490eb241aaf704d4dd2629904410fe4aa31965d9310a735f8755267f4ded1de5 3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab -3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab - podman pod restart --latest 3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab @@ -42,6 +43,7 @@ podman pod restart --all 490eb241aaf704d4dd2629904410fe4aa31965d9310a735f8755267f4ded1de5 70c358daecf71ef9be8f62404f926080ca0133277ef7ce4f6aa2d5af6bb2d3e9 cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907 +``` ## SEE ALSO podman-pod(1), podman-pod-start(1), podman-restart(1) diff --git a/docs/podman-pod-rm.1.md b/docs/podman-pod-rm.1.md index 7a300c152..aa26a1bbb 100644 --- a/docs/podman-pod-rm.1.md +++ b/docs/podman-pod-rm.1.md @@ -19,6 +19,8 @@ Remove all pods. Can be used in conjunction with \-f as well. Instead of providing the pod name or ID, remove the last created pod. +The latest option is not supported on the remote client. + **--force, f** Stop running containers and delete all stopped containers before removal of pod. diff --git a/docs/podman-pod-start.1.md b/docs/podman-pod-start.1.md index 253bb5f53..27e40740f 100644 --- a/docs/podman-pod-start.1.md +++ b/docs/podman-pod-start.1.md @@ -20,6 +20,8 @@ Starts all pods Instead of providing the pod name or ID, start the last created pod. +The latest option is not supported on the remote client. + ## EXAMPLE podman pod start mywebserverpod diff --git a/docs/podman-pod-stop.1.md b/docs/podman-pod-stop.1.md index 7544f8bf7..338e04d67 100644 --- a/docs/podman-pod-stop.1.md +++ b/docs/podman-pod-stop.1.md @@ -19,6 +19,8 @@ Stops all pods Instead of providing the pod name or ID, stop the last created pod. +The latest option is not supported on the remote client. + **--timeout, --time, t** Timeout to wait before forcibly stopping the containers in the pod. diff --git a/docs/podman-pod-top.1.md b/docs/podman-pod-top.1.md index 0b330eb03..a77ca2b37 100644 --- a/docs/podman-pod-top.1.md +++ b/docs/podman-pod-top.1.md @@ -19,6 +19,8 @@ Display the running process of containers in a pod. The *format-descriptors* are Instead of providing the pod name or ID, use the last created pod. +The latest option is not supported on the remote client. + ## FORMAT DESCRIPTORS The following descriptors are supported in addition to the AIX format descriptors mentioned in ps (1): diff --git a/docs/podman-pod-unpause.1.md b/docs/podman-pod-unpause.1.md index 643544ef1..1004e09f9 100644 --- a/docs/podman-pod-unpause.1.md +++ b/docs/podman-pod-unpause.1.md @@ -19,6 +19,8 @@ Unpause all pods. Instead of providing the pod name or ID, unpause the last created pod. +The latest option is not supported on the remote client. + ## EXAMPLE podman pod unpause mywebserverpod diff --git a/docs/podman-port.1.md b/docs/podman-port.1.md index 874ea5036..020a25d32 100644 --- a/docs/podman-port.1.md +++ b/docs/podman-port.1.md @@ -21,11 +21,13 @@ or private ports/protocols as filters. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + ## EXAMPLE List all port mappings ``` -#podman port -a +# podman port -a b4d2f05432e482e017b1a4b2eae15fa7b4f6fb7e9f65c1bde46294fdef285906 80/udp -> 0.0.0.0:44327 80/tcp -> 0.0.0.0:44327 @@ -34,21 +36,21 @@ b4d2f05432e482e017b1a4b2eae15fa7b4f6fb7e9f65c1bde46294fdef285906 List port mappings for a specific container ``` -#podman port b4d2f054 +# podman port b4d2f054 80/udp -> 0.0.0.0:44327 80/tcp -> 0.0.0.0:44327 # ``` List the port mappings for the latest container and port 80 ``` -#podman port b4d2f054 80 +# podman port b4d2f054 80 0.0.0.0:44327 # ``` List the port mappings for a specific container for port 80 and the tcp protocol. ``` -#podman port b4d2f054 80/tcp +# podman port b4d2f054 80/tcp 0.0.0.0:44327 # ``` diff --git a/docs/podman-ps.1.md b/docs/podman-ps.1.md index 8b86703d8..b8b1c3d62 100644 --- a/docs/podman-ps.1.md +++ b/docs/podman-ps.1.md @@ -75,6 +75,8 @@ Print the n last created containers (all states) Show the latest container created (all states) +The latest option is not supported on the remote client. + **--namespace, --ns** Display namespace information diff --git a/docs/podman-restart.1.md b/docs/podman-restart.1.md index 875afa385..dd28e34c7 100644 --- a/docs/podman-restart.1.md +++ b/docs/podman-restart.1.md @@ -19,6 +19,8 @@ Restart all containers regardless of their current state. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--running** Restart all containers that are already in the *running* state. diff --git a/docs/podman-rm.1.md b/docs/podman-rm.1.md index f4513c2be..dc1729188 100644 --- a/docs/podman-rm.1.md +++ b/docs/podman-rm.1.md @@ -1,9 +1,11 @@ -% podman-rm(1) +% podman-container-rm(1) ## NAME -podman\-rm - Remove one or more containers +podman\-container\-rm (podman\-rm) - Remove one or more containers ## SYNOPSIS +**podman container rm** [*options*] *container* + **podman rm** [*options*] *container* ## DESCRIPTION @@ -26,6 +28,8 @@ Containers could have been created by a different container engine. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--volumes, -v** Remove the volumes associated with the container. (Not yet implemented) @@ -55,8 +59,13 @@ Forcibly remove the latest container created. podman rm -f --latest ``` +## Exit Status +**_0_** if all specified containers removed +**_1_** if one of the specified containers did not exist, and no other failures +**_125_** if command fails for a reason other then an container did not exist + ## SEE ALSO -podman(1), podman-rmi(1) +podman(1), podman-image-rm(1) ## HISTORY August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/podman-rmi.1.md b/docs/podman-rmi.1.md index 9c080c9f1..8c22bba2c 100644 --- a/docs/podman-rmi.1.md +++ b/docs/podman-rmi.1.md @@ -1,9 +1,11 @@ -% podman-rmi(1) +% podman-image-rm(1) ## NAME -podman\-rmi - Removes one or more images +podman\-image\-rm (podman\-rmi) - Removes one or more images ## SYNOPSIS +**podman image rm** *image* ... + **podman rmi** *image* ... ## DESCRIPTION @@ -38,6 +40,10 @@ Remove all images and containers. ``` podman rmi -a -f ``` +## Exit Status +**_0_** if all specified images removed +**_1_** if one of the specified images did not exist, and no other failures +**_125_** if command fails for a reason other then an image did not exist ## SEE ALSO podman(1) diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md index b928f61f5..bbf10a2ce 100644 --- a/docs/podman-run.1.md +++ b/docs/podman-run.1.md @@ -28,6 +28,8 @@ servers in the created `resolv.conf`). Additionally, an empty file is created in each container to indicate to programs they are running in a container. This file is located at `/run/.containerenv`. +When running from a user defined network namespace, the /etc/netns/NSNAME/resolv.conf will be used if it exists, otherwise /etc/resolv.conf will be used. + ## OPTIONS **--add-host**=[] @@ -694,21 +696,21 @@ Current supported mount TYPES are bind, and tmpfs. Common Options: - · src, source: mount source spec for bind and volume. Mandatory for bind. + · src, source: mount source spec for bind and volume. Mandatory for bind. - · dst, destination, target: mount destination spec. + · dst, destination, target: mount destination spec. - · ro, read-only: true or false (default). + · ro, read-only: true or false (default). Options specific to bind: - · bind-propagation: Z, z, shared, slave, private, rshared, rslave, or rprivate(default). See also mount(2). + · bind-propagation: Z, z, shared, slave, private, rshared, rslave, or rprivate(default). See also mount(2). Options specific to tmpfs: - · tmpfs-size: Size of the tmpfs mount in bytes. Unlimited by default in Linux. + · tmpfs-size: Size of the tmpfs mount in bytes. Unlimited by default in Linux. - · tmpfs-mode: File mode of the tmpfs in octal. (e.g. 700 or 0700.) Defaults to 1777 in Linux. + · tmpfs-mode: File mode of the tmpfs in octal. (e.g. 700 or 0700.) Defaults to 1777 in Linux. **--userns**="" diff --git a/docs/podman-start.1.md b/docs/podman-start.1.md index 786936721..b0167003e 100644 --- a/docs/podman-start.1.md +++ b/docs/podman-start.1.md @@ -33,6 +33,7 @@ Attach container's STDIN. The default is false. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. **--sig-proxy**=*true*|*false* diff --git a/docs/podman-stats.1.md b/docs/podman-stats.1.md index d0b56b2e6..97a9be961 100644 --- a/docs/podman-stats.1.md +++ b/docs/podman-stats.1.md @@ -20,6 +20,8 @@ Show all containers. Only running containers are shown by default Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--no-reset** Do not clear the terminal/screen in between reporting intervals diff --git a/docs/podman-stop.1.md b/docs/podman-stop.1.md index e36265d5e..2016a7301 100644 --- a/docs/podman-stop.1.md +++ b/docs/podman-stop.1.md @@ -24,6 +24,8 @@ Stop all running containers. This does not include paused containers. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + **--timeout, --time, t** Timeout to wait before forcibly stopping the container diff --git a/docs/podman-system-renumber.1.md b/docs/podman-system-renumber.1.md new file mode 100644 index 000000000..a88640d63 --- /dev/null +++ b/docs/podman-system-renumber.1.md @@ -0,0 +1,29 @@ +% podman-system-renumber(1) podman + +## NAME +podman\-system\-renumber - Renumber container locks + +## SYNOPSIS +** podman system renumber** + +## DESCRIPTION +** podman system renumber** renumbers locks used by containers and pods. + +Each Podman container and pod is allocated a lock at creation time, up to a maximum number controlled by the **num_locks** parameter in **libpod.conf**. + +When all available locks are exhausted, no further containers and pods can be created until some existing containers and pods are removed. This can be avoided by increasing the number of locks available via modifying **libpod.conf** and subsequently running **podman system renumber** to prepare the new locks (and reallocate lock numbers to fit the new struct). + +**podman system renumber** must be called after any changes to **num_locks** - failure to do so will result in errors starting Podman as the number of locks available conflicts with the configured number of locks. + +**podman system renumber** can also be used to migrate 1.0 and earlier versions of Podman, which used a different locking scheme, to the new locking model. It is not strictly required to do this, but it is highly recommended to do so as deadlocks can occur otherwise. + +If possible, avoid calling **podman system renumber** while there are other Podman processes running. + +## SYNOPSIS +**podman system renumber** + +## SEE ALSO +`podman(1)`, `libpod.conf(5)` + +# HISTORY +February 2019, Originally compiled by Matt Heon (mheon at redhat dot com) diff --git a/docs/podman-top.1.md b/docs/podman-top.1.md index 7782a3f29..52d1238ef 100644 --- a/docs/podman-top.1.md +++ b/docs/podman-top.1.md @@ -20,6 +20,8 @@ Display the running process of the container. The *format-descriptors* are ps (1 Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + ## FORMAT DESCRIPTORS The following descriptors are supported in addition to the AIX format descriptors mentioned in ps (1): diff --git a/docs/podman-umount.1.md b/docs/podman-umount.1.md index cceb63019..795f0402d 100644 --- a/docs/podman-umount.1.md +++ b/docs/podman-umount.1.md @@ -35,6 +35,8 @@ Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + ## EXAMPLE podman umount containerID diff --git a/docs/podman-wait.1.md b/docs/podman-wait.1.md index dd5dc7907..672316eef 100644 --- a/docs/podman-wait.1.md +++ b/docs/podman-wait.1.md @@ -22,9 +22,11 @@ After the container stops, the container's return code is printed. **--latest, -l** - Instead of providing the container name or ID, use the last created container. If you use methods other than Podman +Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +The latest option is not supported on the remote client. + ## EXAMPLES ``` |