diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index 398b541dc6..820bfd5559 100644 --- a/docs/source/markdown/.gitignore +++ b/docs/source/markdown/.gitignore @@ -2,10 +2,16 @@ podman-attach.1.md podman-auto-update.1.md podman-build.1.md podman-container-clone.1.md +podman-container-diff.1.md podman-container-runlabel.1.md +podman-container-inspect.1.md podman-create.1.md +podman-diff.1.md podman-exec.1.md podman-image-sign.1.md +podman-init.1.md +podman-init.1.md +podman-inspect.1.md podman-kill.1.md podman-kube-play.1.md podman-login.1.md @@ -14,17 +20,23 @@ podman-logs.1.md podman-manifest-add.1.md podman-manifest-annotate.1.md podman-manifest-create.1.md -podman-manifest-push.1.md podman-manifest-inspect.1.md +podman-manifest-push.1.md +podman-mount.1.md +podman-network-reload.1.md podman-pause.1.md podman-pod-clone.1.md podman-pod-create.1.md +podman-pod-inspect.1.md +podman-pod-inspect.1.md podman-pod-kill.1.md podman-pod-logs.1.md podman-pod-rm.1.md podman-pod-start.1.md podman-pod-stats.1.md podman-pod-stop.1.md +podman-pod-top.1.md +podman-port.1.md podman-pull.1.md podman-push.1.md podman-restart.1.md @@ -34,5 +46,8 @@ podman-search.1.md podman-start.1.md podman-stats.1.md podman-stop.1.md +podman-top.1.md +podman-unmount.1.md podman-unpause.1.md podman-update.1.md +podman-wait.1.md diff --git a/docs/source/markdown/options/add-host.md b/docs/source/markdown/options/add-host.md index dc1ea7bab7..968665d812 100644 --- a/docs/source/markdown/options/add-host.md +++ b/docs/source/markdown/options/add-host.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, create, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--add-host**=*host:ip* diff --git a/docs/source/markdown/options/annotation.container.md b/docs/source/markdown/options/annotation.container.md index 6049d9826f..aadaef264f 100644 --- a/docs/source/markdown/options/annotation.container.md +++ b/docs/source/markdown/options/annotation.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, kube play, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--annotation**=*key=value* diff --git a/docs/source/markdown/options/annotation.manifest.md b/docs/source/markdown/options/annotation.manifest.md index e884e761e2..36914df424 100644 --- a/docs/source/markdown/options/annotation.manifest.md +++ b/docs/source/markdown/options/annotation.manifest.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman manifest add, manifest annotate -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--annotation**=*annotation=value* diff --git a/docs/source/markdown/options/arch.md b/docs/source/markdown/options/arch.md index 4d357ac7d7..535bc87e11 100644 --- a/docs/source/markdown/options/arch.md +++ b/docs/source/markdown/options/arch.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pull, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. diff --git a/docs/source/markdown/options/attach.md b/docs/source/markdown/options/attach.md index bd7259df64..92a290cd26 100644 --- a/docs/source/markdown/options/attach.md +++ b/docs/source/markdown/options/attach.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--attach**, **-a**=*stdin* | *stdout* | *stderr* diff --git a/docs/source/markdown/options/authfile.md b/docs/source/markdown/options/authfile.md index 9832acd6a6..a2fa03bb28 100644 --- a/docs/source/markdown/options/authfile.md +++ b/docs/source/markdown/options/authfile.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman auto update, build, container runlabel, create, image sign, kube play, login, logout, manifest add, manifest push, pull, push, run, search -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--authfile**=*path* diff --git a/docs/source/markdown/options/blkio-weight-device.md b/docs/source/markdown/options/blkio-weight-device.md index 12eb3762e2..a0b55b7336 100644 --- a/docs/source/markdown/options/blkio-weight-device.md +++ b/docs/source/markdown/options/blkio-weight-device.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--blkio-weight-device**=*device:weight* diff --git a/docs/source/markdown/options/blkio-weight.md b/docs/source/markdown/options/blkio-weight.md index 226ce734c8..59ceb30e44 100644 --- a/docs/source/markdown/options/blkio-weight.md +++ b/docs/source/markdown/options/blkio-weight.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--blkio-weight**=*weight* diff --git a/docs/source/markdown/options/cap-add.md b/docs/source/markdown/options/cap-add.md index 1945e44d84..d5199579cb 100644 --- a/docs/source/markdown/options/cap-add.md +++ b/docs/source/markdown/options/cap-add.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cap-add**=*capability* diff --git a/docs/source/markdown/options/cap-drop.md b/docs/source/markdown/options/cap-drop.md index bb8eb962b2..1baacc96d6 100644 --- a/docs/source/markdown/options/cap-drop.md +++ b/docs/source/markdown/options/cap-drop.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cap-drop**=*capability* diff --git a/docs/source/markdown/options/cert-dir.md b/docs/source/markdown/options/cert-dir.md index 7abf09c26c..ef780cc0b8 100644 --- a/docs/source/markdown/options/cert-dir.md +++ b/docs/source/markdown/options/cert-dir.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container runlabel, image sign, kube play, login, manifest add, manifest push, pull, push -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cert-dir**=*path* diff --git a/docs/source/markdown/options/cgroup-conf.md b/docs/source/markdown/options/cgroup-conf.md index 62fbdfa158..749b5d861f 100644 --- a/docs/source/markdown/options/cgroup-conf.md +++ b/docs/source/markdown/options/cgroup-conf.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cgroup-conf**=*KEY=VALUE* diff --git a/docs/source/markdown/options/cgroup-parent.md b/docs/source/markdown/options/cgroup-parent.md index fac5e79739..b9eecaa98f 100644 --- a/docs/source/markdown/options/cgroup-parent.md +++ b/docs/source/markdown/options/cgroup-parent.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cgroup-parent**=*path* diff --git a/docs/source/markdown/options/cgroupns.md b/docs/source/markdown/options/cgroupns.md index 4b13af4e15..71fa248688 100644 --- a/docs/source/markdown/options/cgroupns.md +++ b/docs/source/markdown/options/cgroupns.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cgroupns**=*mode* diff --git a/docs/source/markdown/options/cgroups.md b/docs/source/markdown/options/cgroups.md index 1138c579a0..37f1c1a8c7 100644 --- a/docs/source/markdown/options/cgroups.md +++ b/docs/source/markdown/options/cgroups.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cgroups**=*how* diff --git a/docs/source/markdown/options/chrootdirs.md b/docs/source/markdown/options/chrootdirs.md index f79f066b3f..ef0fbe3033 100644 --- a/docs/source/markdown/options/chrootdirs.md +++ b/docs/source/markdown/options/chrootdirs.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--chrootdirs**=*path* diff --git a/docs/source/markdown/options/cidfile.read.md b/docs/source/markdown/options/cidfile.read.md index 85439b4108..0a11852743 100644 --- a/docs/source/markdown/options/cidfile.read.md +++ b/docs/source/markdown/options/cidfile.read.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman kill, pause, rm, stop, unpause -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cidfile**=*file* diff --git a/docs/source/markdown/options/cidfile.write.md b/docs/source/markdown/options/cidfile.write.md index 1ced2862b8..a767d01c73 100644 --- a/docs/source/markdown/options/cidfile.write.md +++ b/docs/source/markdown/options/cidfile.write.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cidfile**=*file* diff --git a/docs/source/markdown/options/color.md b/docs/source/markdown/options/color.md index a211a60b60..0d932fb0be 100644 --- a/docs/source/markdown/options/color.md +++ b/docs/source/markdown/options/color.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman logs, pod logs -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--color** diff --git a/docs/source/markdown/options/compression-format.md b/docs/source/markdown/options/compression-format.md index 72818953e4..0fe49d9581 100644 --- a/docs/source/markdown/options/compression-format.md +++ b/docs/source/markdown/options/compression-format.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman manifest push, push -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--compression-format**=**gzip** | *zstd* | *zstd:chunked* diff --git a/docs/source/markdown/options/conmon-pidfile.md b/docs/source/markdown/options/conmon-pidfile.md index 5732209598..4ee5e514aa 100644 --- a/docs/source/markdown/options/conmon-pidfile.md +++ b/docs/source/markdown/options/conmon-pidfile.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--conmon-pidfile**=*file* diff --git a/docs/source/markdown/options/cpu-period.md b/docs/source/markdown/options/cpu-period.md index dc35fb747c..e90577a566 100644 --- a/docs/source/markdown/options/cpu-period.md +++ b/docs/source/markdown/options/cpu-period.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container clone, create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cpu-period**=*limit* diff --git a/docs/source/markdown/options/cpu-quota.md b/docs/source/markdown/options/cpu-quota.md index d756f6b5f7..8551d30695 100644 --- a/docs/source/markdown/options/cpu-quota.md +++ b/docs/source/markdown/options/cpu-quota.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container clone, create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cpu-quota**=*limit* diff --git a/docs/source/markdown/options/cpu-rt-period.md b/docs/source/markdown/options/cpu-rt-period.md index 8a180d8975..962b6c676e 100644 --- a/docs/source/markdown/options/cpu-rt-period.md +++ b/docs/source/markdown/options/cpu-rt-period.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cpu-rt-period**=*microseconds* diff --git a/docs/source/markdown/options/cpu-rt-runtime.md b/docs/source/markdown/options/cpu-rt-runtime.md index 4cb35d5307..b40ac351f6 100644 --- a/docs/source/markdown/options/cpu-rt-runtime.md +++ b/docs/source/markdown/options/cpu-rt-runtime.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cpu-rt-runtime**=*microseconds* diff --git a/docs/source/markdown/options/cpu-shares.md b/docs/source/markdown/options/cpu-shares.md index 6e3acc5b2e..bdf0dfc64b 100644 --- a/docs/source/markdown/options/cpu-shares.md +++ b/docs/source/markdown/options/cpu-shares.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cpu-shares**, **-c**=*shares* diff --git a/docs/source/markdown/options/cpus.container.md b/docs/source/markdown/options/cpus.container.md index 7d112394b0..9db3ec8778 100644 --- a/docs/source/markdown/options/cpus.container.md +++ b/docs/source/markdown/options/cpus.container.md @@ -1,12 +1,12 @@ ####> This option file is used in: ####> podman create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cpus**=*number* Number of CPUs. The default is *0.0* which means no limit. This is shorthand -for **--cpu-period** and **--cpu-quota**, so you may only set either -**--cpus** or **--cpu-period** and **--cpu-quota**. +for **--cpu-period** and **--cpu-quota**, therfore the option cannot be specified with +**--cpu-period** or **--cpu-quota**. On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see diff --git a/docs/source/markdown/options/cpuset-cpus.md b/docs/source/markdown/options/cpuset-cpus.md index b34d466bae..f8e167e4c7 100644 --- a/docs/source/markdown/options/cpuset-cpus.md +++ b/docs/source/markdown/options/cpuset-cpus.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cpuset-cpus**=*number* diff --git a/docs/source/markdown/options/cpuset-mems.md b/docs/source/markdown/options/cpuset-mems.md index 15e7fee01e..7796341662 100644 --- a/docs/source/markdown/options/cpuset-mems.md +++ b/docs/source/markdown/options/cpuset-mems.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--cpuset-mems**=*nodes* diff --git a/docs/source/markdown/options/creds.md b/docs/source/markdown/options/creds.md index 58ce1de641..05f111c5ca 100644 --- a/docs/source/markdown/options/creds.md +++ b/docs/source/markdown/options/creds.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container runlabel, kube play, manifest add, manifest push, pull, push -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--creds**=*[username[:password]]* diff --git a/docs/source/markdown/options/decryption-key.md b/docs/source/markdown/options/decryption-key.md index 0a9c1b93ab..b804ba7f7b 100644 --- a/docs/source/markdown/options/decryption-key.md +++ b/docs/source/markdown/options/decryption-key.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pull, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--decryption-key**=*key[:passphrase]* diff --git a/docs/source/markdown/options/destroy.md b/docs/source/markdown/options/destroy.md index 0889baba53..e278994837 100644 --- a/docs/source/markdown/options/destroy.md +++ b/docs/source/markdown/options/destroy.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, pod clone -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--destroy** diff --git a/docs/source/markdown/options/detach-keys.md b/docs/source/markdown/options/detach-keys.md index dfa726d076..3f2b0fcc5f 100644 --- a/docs/source/markdown/options/detach-keys.md +++ b/docs/source/markdown/options/detach-keys.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman attach, exec, run, start -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--detach-keys**=*sequence* diff --git a/docs/source/markdown/options/device-cgroup-rule.md b/docs/source/markdown/options/device-cgroup-rule.md index 2dfd414ed2..528c5e1f00 100644 --- a/docs/source/markdown/options/device-cgroup-rule.md +++ b/docs/source/markdown/options/device-cgroup-rule.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--device-cgroup-rule**=*"type major:minor mode"* diff --git a/docs/source/markdown/options/device-read-bps.md b/docs/source/markdown/options/device-read-bps.md index 65a85d13bd..abee191097 100644 --- a/docs/source/markdown/options/device-read-bps.md +++ b/docs/source/markdown/options/device-read-bps.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--device-read-bps**=*path:rate* diff --git a/docs/source/markdown/options/device-read-iops.md b/docs/source/markdown/options/device-read-iops.md index 6b819014e7..a74452ce9c 100644 --- a/docs/source/markdown/options/device-read-iops.md +++ b/docs/source/markdown/options/device-read-iops.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--device-read-iops**=*path:rate* diff --git a/docs/source/markdown/options/device-write-bps.md b/docs/source/markdown/options/device-write-bps.md index bbc948034b..e7edc8629f 100644 --- a/docs/source/markdown/options/device-write-bps.md +++ b/docs/source/markdown/options/device-write-bps.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--device-write-bps**=*path:rate* diff --git a/docs/source/markdown/options/device-write-iops.md b/docs/source/markdown/options/device-write-iops.md index 16cd23a0c6..8e2831231c 100644 --- a/docs/source/markdown/options/device-write-iops.md +++ b/docs/source/markdown/options/device-write-iops.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--device-write-iops**=*path:rate* diff --git a/docs/source/markdown/options/device.md b/docs/source/markdown/options/device.md index 5403194591..4f17997793 100644 --- a/docs/source/markdown/options/device.md +++ b/docs/source/markdown/options/device.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--device**=*host-device[:container-device][:permissions]* diff --git a/docs/source/markdown/options/digestfile.md b/docs/source/markdown/options/digestfile.md index 22c42b23b6..ce569acac8 100644 --- a/docs/source/markdown/options/digestfile.md +++ b/docs/source/markdown/options/digestfile.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman manifest push, push -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--digestfile**=*Digestfile* diff --git a/docs/source/markdown/options/disable-content-trust.md b/docs/source/markdown/options/disable-content-trust.md index a69b870d1a..14ac336633 100644 --- a/docs/source/markdown/options/disable-content-trust.md +++ b/docs/source/markdown/options/disable-content-trust.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, create, pull, push, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--disable-content-trust** diff --git a/docs/source/markdown/options/dns-option.container.md b/docs/source/markdown/options/dns-option.container.md index 1c8bc03aa3..f1b57de1a1 100644 --- a/docs/source/markdown/options/dns-option.container.md +++ b/docs/source/markdown/options/dns-option.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--dns-option**=*option* diff --git a/docs/source/markdown/options/dns-search.container.md b/docs/source/markdown/options/dns-search.container.md index e27e60eba8..589e3fa6d6 100644 --- a/docs/source/markdown/options/dns-search.container.md +++ b/docs/source/markdown/options/dns-search.container.md @@ -1,8 +1,8 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--dns-search**=*domain* Set custom DNS search domains. Invalid if using **--dns-search** with **--network** that is set to **none** or **container:**_id_. -Use **--dns-search=.** if you don't wish to set the search domain. +Use **--dns-search=.** to remove the search domain. diff --git a/docs/source/markdown/options/dns.md b/docs/source/markdown/options/dns.md index 585c8c085a..1da106a115 100644 --- a/docs/source/markdown/options/dns.md +++ b/docs/source/markdown/options/dns.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--dns**=*ipaddr* diff --git a/docs/source/markdown/options/entrypoint.md b/docs/source/markdown/options/entrypoint.md index d3cc6cbb41..8ee5d11a1e 100644 --- a/docs/source/markdown/options/entrypoint.md +++ b/docs/source/markdown/options/entrypoint.md @@ -1,21 +1,18 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--entrypoint**=*"command"* | *'["command", "arg1", ...]'* -Overwrite the default ENTRYPOINT of the image. - -This option allows you to overwrite the default entrypoint of the image. +Override the default ENTRYPOINT from the image. The ENTRYPOINT of an image is similar to a COMMAND because it specifies what executable to run when the container starts, but it is (purposely) more difficult to override. The ENTRYPOINT gives a container its -default nature or behavior, so that when you set an ENTRYPOINT you can run the -container as if it were that binary, complete with default options, and you can -pass in more options via the COMMAND. But, sometimes an operator may want to run -something else inside the container, so you can override the default ENTRYPOINT -at runtime by using a **--entrypoint** and a string to specify the new -ENTRYPOINT. +default nature or behavior. When the ENTRYPOINT is set, the +container runs as if it were that binary, complete with default options. More options can be +passed in via the COMMAND. But, if a user wants to run +something else inside the container, the **--entrypoint** option allows a new +ENTRYPOINT to be specified. -You need to specify multi option commands in the form of a json string. +Specify multi option commands in the form of a json string. diff --git a/docs/source/markdown/options/env-file.md b/docs/source/markdown/options/env-file.md index d2165419c8..428cb78582 100644 --- a/docs/source/markdown/options/env-file.md +++ b/docs/source/markdown/options/env-file.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, exec, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--env-file**=*file* diff --git a/docs/source/markdown/options/env-host.md b/docs/source/markdown/options/env-host.md index 1ca125c319..53b121cbc2 100644 --- a/docs/source/markdown/options/env-host.md +++ b/docs/source/markdown/options/env-host.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--env-host** diff --git a/docs/source/markdown/options/env-merge.md b/docs/source/markdown/options/env-merge.md index 8b18f09fa8..2b80233a1a 100644 --- a/docs/source/markdown/options/env-merge.md +++ b/docs/source/markdown/options/env-merge.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--env-merge**=*env* diff --git a/docs/source/markdown/options/env.md b/docs/source/markdown/options/env.md index 41e648525a..cd95c658e8 100644 --- a/docs/source/markdown/options/env.md +++ b/docs/source/markdown/options/env.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, exec, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--env**, **-e**=*env* diff --git a/docs/source/markdown/options/expose.md b/docs/source/markdown/options/expose.md index 22c653cf06..6615a350ad 100644 --- a/docs/source/markdown/options/expose.md +++ b/docs/source/markdown/options/expose.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--expose**=*port* diff --git a/docs/source/markdown/options/features.md b/docs/source/markdown/options/features.md index 47f2f74797..05540558f4 100644 --- a/docs/source/markdown/options/features.md +++ b/docs/source/markdown/options/features.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman manifest add, manifest annotate -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--features** diff --git a/docs/source/markdown/options/follow.md b/docs/source/markdown/options/follow.md index 2886531110..159840d2e5 100644 --- a/docs/source/markdown/options/follow.md +++ b/docs/source/markdown/options/follow.md @@ -1,11 +1,11 @@ ####> This option file is used in: ####> podman logs, pod logs -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--follow**, **-f** Follow log output. Default is false. -Note: If you are following a <> which is removed by `podman <> rm` -or removed on exit (`podman run --rm ...`), then there is a chance that the log +Note: When following a <> which is removed by `podman <> rm` +or removed on exit (`podman run --rm ...`), there is a chance that the log file will be removed before `podman<< pod|>> logs` reads the final content. diff --git a/docs/source/markdown/options/gidmap.container.md b/docs/source/markdown/options/gidmap.container.md index 226f10e7a2..ac6bfdecac 100644 --- a/docs/source/markdown/options/gidmap.container.md +++ b/docs/source/markdown/options/gidmap.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--gidmap**=*container_gid:host_gid:amount* diff --git a/docs/source/markdown/options/gidmap.pod.md b/docs/source/markdown/options/gidmap.pod.md index 8d5e8bbe8e..9244833c29 100644 --- a/docs/source/markdown/options/gidmap.pod.md +++ b/docs/source/markdown/options/gidmap.pod.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--gidmap**=*pod_gid:host_gid:amount* diff --git a/docs/source/markdown/options/group-add.md b/docs/source/markdown/options/group-add.md index a33c87920c..4640e88ea3 100644 --- a/docs/source/markdown/options/group-add.md +++ b/docs/source/markdown/options/group-add.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--group-add**=*group* | *keep-groups* @@ -11,5 +11,5 @@ Assign additional groups to the primary user running within the container proces Allows container to use the user's supplementary group access. If file systems or devices are only accessible by the rootless user's group, this flag tells the OCI runtime to pass the group access into the container. Currently only available -with the `crun` OCI runtime. Note: `keep-groups` is exclusive, you cannot add any other groups +with the `crun` OCI runtime. Note: `keep-groups` is exclusive, other groups cannot be specified with this flag. (Not available for remote commands, including Mac and Windows (excluding WSL2) machines) diff --git a/docs/source/markdown/options/health-cmd.md b/docs/source/markdown/options/health-cmd.md index d3d9f0b925..01c4ef92b1 100644 --- a/docs/source/markdown/options/health-cmd.md +++ b/docs/source/markdown/options/health-cmd.md @@ -1,11 +1,11 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-cmd**=*"command"* | *'["command", "arg1", ...]'* -Set or alter a healthcheck command for a container. The command is a command to be executed inside your -container that determines your container health. The command is required for other healthcheck options +Set or alter a healthcheck command for a container. The command is a command to be executed inside the +container that determines the container health. The command is required for other healthcheck options to be applied. A value of **none** disables existing healthchecks. Multiple options can be passed in the form of a JSON array; otherwise, the command will be interpreted diff --git a/docs/source/markdown/options/health-interval.md b/docs/source/markdown/options/health-interval.md index 690be2cc02..9aa86dcd76 100644 --- a/docs/source/markdown/options/health-interval.md +++ b/docs/source/markdown/options/health-interval.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-interval**=*interval* diff --git a/docs/source/markdown/options/health-on-failure.md b/docs/source/markdown/options/health-on-failure.md index d5c93e50f5..4075556a2d 100644 --- a/docs/source/markdown/options/health-on-failure.md +++ b/docs/source/markdown/options/health-on-failure.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-on-failure**=*action* diff --git a/docs/source/markdown/options/health-retries.md b/docs/source/markdown/options/health-retries.md index 6cecaae49b..224bd0d552 100644 --- a/docs/source/markdown/options/health-retries.md +++ b/docs/source/markdown/options/health-retries.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-retries**=*retries* diff --git a/docs/source/markdown/options/health-start-period.md b/docs/source/markdown/options/health-start-period.md index 9568166a42..7559f94613 100644 --- a/docs/source/markdown/options/health-start-period.md +++ b/docs/source/markdown/options/health-start-period.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-start-period**=*period* diff --git a/docs/source/markdown/options/health-startup-cmd.md b/docs/source/markdown/options/health-startup-cmd.md index cd54590a95..84cbb22215 100644 --- a/docs/source/markdown/options/health-startup-cmd.md +++ b/docs/source/markdown/options/health-startup-cmd.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-startup-cmd**=*"command"* | *'["command", "arg1", ...]'* diff --git a/docs/source/markdown/options/health-startup-interval.md b/docs/source/markdown/options/health-startup-interval.md index 4681a7590b..dbba969a55 100644 --- a/docs/source/markdown/options/health-startup-interval.md +++ b/docs/source/markdown/options/health-startup-interval.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-startup-interval**=*interval* diff --git a/docs/source/markdown/options/health-startup-retries.md b/docs/source/markdown/options/health-startup-retries.md index 55b37eab60..dd1b900a36 100644 --- a/docs/source/markdown/options/health-startup-retries.md +++ b/docs/source/markdown/options/health-startup-retries.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-startup-retries**=*retries* diff --git a/docs/source/markdown/options/health-startup-success.md b/docs/source/markdown/options/health-startup-success.md index ddb48061f7..2c1f761e71 100644 --- a/docs/source/markdown/options/health-startup-success.md +++ b/docs/source/markdown/options/health-startup-success.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-startup-success**=*retries* diff --git a/docs/source/markdown/options/health-startup-timeout.md b/docs/source/markdown/options/health-startup-timeout.md index 11ba5f6676..f6b8c75e07 100644 --- a/docs/source/markdown/options/health-startup-timeout.md +++ b/docs/source/markdown/options/health-startup-timeout.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-startup-timeout**=*timeout* diff --git a/docs/source/markdown/options/health-timeout.md b/docs/source/markdown/options/health-timeout.md index 02459f9156..1324628008 100644 --- a/docs/source/markdown/options/health-timeout.md +++ b/docs/source/markdown/options/health-timeout.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--health-timeout**=*timeout* diff --git a/docs/source/markdown/options/hostname.container.md b/docs/source/markdown/options/hostname.container.md index df7860665d..6b89f1b6a1 100644 --- a/docs/source/markdown/options/hostname.container.md +++ b/docs/source/markdown/options/hostname.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--hostname**, **-h**=*name* diff --git a/docs/source/markdown/options/hostname.pod.md b/docs/source/markdown/options/hostname.pod.md index 9a35bfbe80..81efeaf2ba 100644 --- a/docs/source/markdown/options/hostname.pod.md +++ b/docs/source/markdown/options/hostname.pod.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--hostname**=*name* diff --git a/docs/source/markdown/options/hostuser.md b/docs/source/markdown/options/hostuser.md index 647003b7a6..e429cb6438 100644 --- a/docs/source/markdown/options/hostuser.md +++ b/docs/source/markdown/options/hostuser.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--hostuser**=*name* diff --git a/docs/source/markdown/options/http-proxy.md b/docs/source/markdown/options/http-proxy.md index 51c12a414b..9203b96d27 100644 --- a/docs/source/markdown/options/http-proxy.md +++ b/docs/source/markdown/options/http-proxy.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--http-proxy** diff --git a/docs/source/markdown/options/ignore.md b/docs/source/markdown/options/ignore.md index 979584d4c2..c5fa3dfcca 100644 --- a/docs/source/markdown/options/ignore.md +++ b/docs/source/markdown/options/ignore.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod rm, pod stop, rm, stop -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--ignore**, **-i** diff --git a/docs/source/markdown/options/image-volume.md b/docs/source/markdown/options/image-volume.md index 174f74f886..d842199482 100644 --- a/docs/source/markdown/options/image-volume.md +++ b/docs/source/markdown/options/image-volume.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--image-volume**=**bind** | *tmpfs* | *ignore* diff --git a/docs/source/markdown/options/infra-command.md b/docs/source/markdown/options/infra-command.md index aca30a9bec..dc9a9546de 100644 --- a/docs/source/markdown/options/infra-command.md +++ b/docs/source/markdown/options/infra-command.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--infra-command**=*command* diff --git a/docs/source/markdown/options/infra-conmon-pidfile.md b/docs/source/markdown/options/infra-conmon-pidfile.md index 2e75cdd9e3..615bb1c3bb 100644 --- a/docs/source/markdown/options/infra-conmon-pidfile.md +++ b/docs/source/markdown/options/infra-conmon-pidfile.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--infra-conmon-pidfile**=*file* diff --git a/docs/source/markdown/options/infra-name.md b/docs/source/markdown/options/infra-name.md index 3fb98e0ee4..ec389b007c 100644 --- a/docs/source/markdown/options/infra-name.md +++ b/docs/source/markdown/options/infra-name.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--infra-name**=*name* diff --git a/docs/source/markdown/options/init-path.md b/docs/source/markdown/options/init-path.md index d9e1f1e61f..484c72c785 100644 --- a/docs/source/markdown/options/init-path.md +++ b/docs/source/markdown/options/init-path.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--init-path**=*path* diff --git a/docs/source/markdown/options/init.md b/docs/source/markdown/options/init.md index b9755c8960..bc47ca0f9f 100644 --- a/docs/source/markdown/options/init.md +++ b/docs/source/markdown/options/init.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--init** diff --git a/docs/source/markdown/options/interactive.md b/docs/source/markdown/options/interactive.md index 8e44123194..37f8309eff 100644 --- a/docs/source/markdown/options/interactive.md +++ b/docs/source/markdown/options/interactive.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, exec, run, start -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--interactive**, **-i** diff --git a/docs/source/markdown/options/ip.md b/docs/source/markdown/options/ip.md index 8566cafe1e..d3c865a88d 100644 --- a/docs/source/markdown/options/ip.md +++ b/docs/source/markdown/options/ip.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--ip**=*ipv4* diff --git a/docs/source/markdown/options/ip6.md b/docs/source/markdown/options/ip6.md index 84c6f0145d..a2dd619f72 100644 --- a/docs/source/markdown/options/ip6.md +++ b/docs/source/markdown/options/ip6.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--ip6**=*ipv6* diff --git a/docs/source/markdown/options/ipc.md b/docs/source/markdown/options/ipc.md index 47df3affdb..ca19d0f71f 100644 --- a/docs/source/markdown/options/ipc.md +++ b/docs/source/markdown/options/ipc.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--ipc**=*ipc* diff --git a/docs/source/markdown/options/label-file.md b/docs/source/markdown/options/label-file.md index 27b24fbf42..576dbd1f00 100644 --- a/docs/source/markdown/options/label-file.md +++ b/docs/source/markdown/options/label-file.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--label-file**=*file* diff --git a/docs/source/markdown/options/label.md b/docs/source/markdown/options/label.md index 0022c31fbc..af88b3f95f 100644 --- a/docs/source/markdown/options/label.md +++ b/docs/source/markdown/options/label.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--label**, **-l**=*key=value* diff --git a/docs/source/markdown/options/latest.md b/docs/source/markdown/options/latest.md new file mode 100644 index 0000000000..3be6e2f4e0 --- /dev/null +++ b/docs/source/markdown/options/latest.md @@ -0,0 +1,10 @@ +####> This option file is used in: +####> podman attach, container diff, container inspect, diff, exec, init, inspect, kill, logs, mount, network reload, pause, pod inspect, pod kill, pod logs, pod rm, pod start, pod stats, pod stop, pod top, port, restart, rm, start, stats, stop, top, unmount, unpause, wait +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--latest**, **-l** + +Instead of providing the <> name or ID, use the last created <>. +Note: the last started <> could be from other users of Podman on the host machine. +(This option is not available with the remote Podman client, including Mac and Windows +(excluding WSL2) machines) diff --git a/docs/source/markdown/options/link-local-ip.md b/docs/source/markdown/options/link-local-ip.md index 5ac1a54ad3..4452f9b401 100644 --- a/docs/source/markdown/options/link-local-ip.md +++ b/docs/source/markdown/options/link-local-ip.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--link-local-ip**=*ip* diff --git a/docs/source/markdown/options/log-driver.md b/docs/source/markdown/options/log-driver.md index 730249bd42..da697fe0d5 100644 --- a/docs/source/markdown/options/log-driver.md +++ b/docs/source/markdown/options/log-driver.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--log-driver**=*driver* diff --git a/docs/source/markdown/options/log-opt.md b/docs/source/markdown/options/log-opt.md index d1701c54f1..9cb1402ae3 100644 --- a/docs/source/markdown/options/log-opt.md +++ b/docs/source/markdown/options/log-opt.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, kube play, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--log-opt**=*name=value* diff --git a/docs/source/markdown/options/mac-address.md b/docs/source/markdown/options/mac-address.md index 2575889eb2..eb636d2af7 100644 --- a/docs/source/markdown/options/mac-address.md +++ b/docs/source/markdown/options/mac-address.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--mac-address**=*address* diff --git a/docs/source/markdown/options/memory-reservation.md b/docs/source/markdown/options/memory-reservation.md index bdbc330548..b7022807c7 100644 --- a/docs/source/markdown/options/memory-reservation.md +++ b/docs/source/markdown/options/memory-reservation.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--memory-reservation**=*number[unit]* @@ -8,7 +8,7 @@ Memory soft limit. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebi After setting memory reservation, when the system detects memory contention or low memory, containers are forced to restrict their consumption to their -reservation. So you should always set the value below **--memory**, otherwise the +reservation. So always set the value below **--memory**, otherwise the hard limit will take precedence. By default, memory reservation will be the same as memory limit. diff --git a/docs/source/markdown/options/memory-swap.md b/docs/source/markdown/options/memory-swap.md index 89c4d30d5b..bbaf3b5515 100644 --- a/docs/source/markdown/options/memory-swap.md +++ b/docs/source/markdown/options/memory-swap.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--memory-swap**=*number[unit]* diff --git a/docs/source/markdown/options/memory-swappiness.md b/docs/source/markdown/options/memory-swappiness.md index a34fbc1084..2112857b53 100644 --- a/docs/source/markdown/options/memory-swappiness.md +++ b/docs/source/markdown/options/memory-swappiness.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman container clone, create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--memory-swappiness**=*number* diff --git a/docs/source/markdown/options/memory.md b/docs/source/markdown/options/memory.md index 8cf93dca46..06f2da1bc1 100644 --- a/docs/source/markdown/options/memory.md +++ b/docs/source/markdown/options/memory.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container clone, create, pod clone, pod create, run, update -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--memory**, **-m**=*number[unit]* diff --git a/docs/source/markdown/options/mount.md b/docs/source/markdown/options/mount.md index 99490b91d7..5f3969abbc 100644 --- a/docs/source/markdown/options/mount.md +++ b/docs/source/markdown/options/mount.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]* diff --git a/docs/source/markdown/options/name.container.md b/docs/source/markdown/options/name.container.md index 6835907ef1..1caa8aaf9c 100644 --- a/docs/source/markdown/options/name.container.md +++ b/docs/source/markdown/options/name.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--name**=*name* @@ -14,5 +14,5 @@ The operator can identify a container in three ways: Podman generates a UUID for each container, and if a name is not assigned to the container with **--name** then it will generate a random -string name. The name is useful any place you need to identify a container. +string name. The name can be useful as a more human-friendly way to identify containers. This works for both background and foreground containers. diff --git a/docs/source/markdown/options/names.md b/docs/source/markdown/options/names.md index b056ba11d9..422f7b03bd 100644 --- a/docs/source/markdown/options/names.md +++ b/docs/source/markdown/options/names.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman logs, pod logs -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--names**, **-n** diff --git a/docs/source/markdown/options/network-alias.md b/docs/source/markdown/options/network-alias.md index fa775483d1..066c6dc927 100644 --- a/docs/source/markdown/options/network-alias.md +++ b/docs/source/markdown/options/network-alias.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--network-alias**=*alias* diff --git a/docs/source/markdown/options/network.md b/docs/source/markdown/options/network.md index faad284a4e..bc22b41f61 100644 --- a/docs/source/markdown/options/network.md +++ b/docs/source/markdown/options/network.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, kube play, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--network**=*mode*, **--net** @@ -17,7 +17,7 @@ Valid _mode_ values are: For example to set a static ipv4 address and a static mac address, use `--network bridge:ip=10.88.0.10,mac=44:33:22:11:00:99`. -- \[:OPTIONS,...]: Connect to a user-defined network; this is the network name or ID from a network created by **[podman network create](podman-network-create.1.md)**. Using the network name implies the bridge network mode. It is possible to specify the same options described under the bridge mode above. You can use the **--network** option multiple times to specify additional networks. +- \[:OPTIONS,...]: Connect to a user-defined network; this is the network name or ID from a network created by **[podman network create](podman-network-create.1.md)**. Using the network name implies the bridge network mode. It is possible to specify the same options described under the bridge mode above. Use the **--network** option multiple times to specify additional networks. - **none**: Create a network namespace for the container but do not configure network interfaces for it, thus the container has no network connectivity. - **container:**_id_: Reuse another container's network stack. - **host**: Do not create a network namespace, the container will use the host's network. Note: The host mode gives the container full access to local system services such as D-bus and is therefore considered insecure. @@ -33,7 +33,7 @@ Valid _mode_ values are: - **outbound_addr6=INTERFACE**: Specify the outbound interface slirp should bind to (ipv6 traffic only). - **outbound_addr6=IPv6**: Specify the outbound ipv6 address slirp should bind to. - **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default. - Note: Rootlesskit changes the source IP address of incoming packets to an IP address in the container network namespace, usually `10.0.2.100`. If your application requires the real source IP address, e.g. web server logs, use the slirp4netns port handler. The rootlesskit port handler is also used for rootless containers when connected to user-defined networks. + Note: Rootlesskit changes the source IP address of incoming packets to an IP address in the container network namespace, usually `10.0.2.100`. If the application requires the real source IP address, e.g. web server logs, use the slirp4netns port handler. The rootlesskit port handler is also used for rootless containers when connected to user-defined networks. - **port_handler=slirp4netns**: Use the slirp4netns port forwarding, it is slower than rootlesskit but preserves the correct source IP address. This port handler cannot be used for user-defined networks. - **pasta[:OPTIONS,...]**: use **pasta**(1) to create a user-mode networking @@ -75,5 +75,4 @@ Valid _mode_ values are: host, using the loopback interface instead of the tap interface for improved performance - NOTE: For backward compatibility reasons, if you have a network named `pasta`, - Podman will use this instead of the pasta mode. + NOTE: For backward compatibility reasons, if there is an existing network named `pasta`, Podman will use it instead of the pasta mode."? diff --git a/docs/source/markdown/options/no-healthcheck.md b/docs/source/markdown/options/no-healthcheck.md index 2dae29915f..14704db8aa 100644 --- a/docs/source/markdown/options/no-healthcheck.md +++ b/docs/source/markdown/options/no-healthcheck.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--no-healthcheck** diff --git a/docs/source/markdown/options/no-hosts.md b/docs/source/markdown/options/no-hosts.md index 47b21f8b60..0c2ee34399 100644 --- a/docs/source/markdown/options/no-hosts.md +++ b/docs/source/markdown/options/no-hosts.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, create, kube play, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--no-hosts** diff --git a/docs/source/markdown/options/no-reset.md b/docs/source/markdown/options/no-reset.md index 165e2eb5d5..c45c26774c 100644 --- a/docs/source/markdown/options/no-reset.md +++ b/docs/source/markdown/options/no-reset.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod stats, stats -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--no-reset** diff --git a/docs/source/markdown/options/no-stream.md b/docs/source/markdown/options/no-stream.md index 531dce1b00..cac84d70cc 100644 --- a/docs/source/markdown/options/no-stream.md +++ b/docs/source/markdown/options/no-stream.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod stats, stats -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--no-stream** diff --git a/docs/source/markdown/options/oom-kill-disable.md b/docs/source/markdown/options/oom-kill-disable.md index b8bb26eafb..344f0ad34e 100644 --- a/docs/source/markdown/options/oom-kill-disable.md +++ b/docs/source/markdown/options/oom-kill-disable.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--oom-kill-disable** diff --git a/docs/source/markdown/options/oom-score-adj.md b/docs/source/markdown/options/oom-score-adj.md index 14612c59c5..462abf5194 100644 --- a/docs/source/markdown/options/oom-score-adj.md +++ b/docs/source/markdown/options/oom-score-adj.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--oom-score-adj**=*num* diff --git a/docs/source/markdown/options/os-version.md b/docs/source/markdown/options/os-version.md index 8394e23fc8..b6d83544d0 100644 --- a/docs/source/markdown/options/os-version.md +++ b/docs/source/markdown/options/os-version.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman manifest add, manifest annotate -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--os-version** diff --git a/docs/source/markdown/options/os.pull.md b/docs/source/markdown/options/os.pull.md index b2be86753d..a81763424e 100644 --- a/docs/source/markdown/options/os.pull.md +++ b/docs/source/markdown/options/os.pull.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pull, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--os**=*OS* diff --git a/docs/source/markdown/options/passwd-entry.md b/docs/source/markdown/options/passwd-entry.md index 00d316be89..f9b3d6763c 100644 --- a/docs/source/markdown/options/passwd-entry.md +++ b/docs/source/markdown/options/passwd-entry.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--passwd-entry**=*ENTRY* diff --git a/docs/source/markdown/options/personality.md b/docs/source/markdown/options/personality.md index 728d580e51..d59b833e3a 100644 --- a/docs/source/markdown/options/personality.md +++ b/docs/source/markdown/options/personality.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--personality**=*persona* diff --git a/docs/source/markdown/options/pid.container.md b/docs/source/markdown/options/pid.container.md index 58e805d1ca..ba9165fcbd 100644 --- a/docs/source/markdown/options/pid.container.md +++ b/docs/source/markdown/options/pid.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--pid**=*mode* diff --git a/docs/source/markdown/options/pid.pod.md b/docs/source/markdown/options/pid.pod.md index 620cbfa4b0..7208983e2b 100644 --- a/docs/source/markdown/options/pid.pod.md +++ b/docs/source/markdown/options/pid.pod.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--pid**=*pid* diff --git a/docs/source/markdown/options/pidfile.md b/docs/source/markdown/options/pidfile.md index 44f8e953e9..e9962d03a5 100644 --- a/docs/source/markdown/options/pidfile.md +++ b/docs/source/markdown/options/pidfile.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--pidfile**=*path* diff --git a/docs/source/markdown/options/pids-limit.md b/docs/source/markdown/options/pids-limit.md index fa71deee66..39c53e081a 100644 --- a/docs/source/markdown/options/pids-limit.md +++ b/docs/source/markdown/options/pids-limit.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--pids-limit**=*limit* diff --git a/docs/source/markdown/options/platform.md b/docs/source/markdown/options/platform.md index 85552a1e4c..b96f2735af 100644 --- a/docs/source/markdown/options/platform.md +++ b/docs/source/markdown/options/platform.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pull, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--platform**=*OS/ARCH* diff --git a/docs/source/markdown/options/pod-id-file.container.md b/docs/source/markdown/options/pod-id-file.container.md index 4f2aa2ddda..402886285a 100644 --- a/docs/source/markdown/options/pod-id-file.container.md +++ b/docs/source/markdown/options/pod-id-file.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--pod-id-file**=*file* diff --git a/docs/source/markdown/options/pod-id-file.pod.md b/docs/source/markdown/options/pod-id-file.pod.md index 8514d9bbd8..dbd212f5d7 100644 --- a/docs/source/markdown/options/pod-id-file.pod.md +++ b/docs/source/markdown/options/pod-id-file.pod.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod rm, pod start, pod stop -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--pod-id-file**=*file* diff --git a/docs/source/markdown/options/pod.run.md b/docs/source/markdown/options/pod.run.md index 5f1f949455..b3a0214f5a 100644 --- a/docs/source/markdown/options/pod.run.md +++ b/docs/source/markdown/options/pod.run.md @@ -1,9 +1,9 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--pod**=*name* -Run container in an existing pod. If you want Podman to make the pod for you, prefix the pod name with **new:**. +Run container in an existing pod. Podman will make the pod automatically if the pod name is prefixed with **new:**. To make a pod with more granular options, use the **podman pod create** command before creating a container. If a container is run with a pod, and the pod has an infra-container, the infra-container will be started before the container is. diff --git a/docs/source/markdown/options/preserve-fds.md b/docs/source/markdown/options/preserve-fds.md index 046833711b..970d71672a 100644 --- a/docs/source/markdown/options/preserve-fds.md +++ b/docs/source/markdown/options/preserve-fds.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman exec, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--preserve-fds**=*N* diff --git a/docs/source/markdown/options/privileged.md b/docs/source/markdown/options/privileged.md index 6d50684190..608b0ded8f 100644 --- a/docs/source/markdown/options/privileged.md +++ b/docs/source/markdown/options/privileged.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, exec, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--privileged** diff --git a/docs/source/markdown/options/publish-all.md b/docs/source/markdown/options/publish-all.md index 195bc8473b..ce5195b057 100644 --- a/docs/source/markdown/options/publish-all.md +++ b/docs/source/markdown/options/publish-all.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--publish-all**, **-P** diff --git a/docs/source/markdown/options/publish.md b/docs/source/markdown/options/publish.md index 45acb4fea1..b0ecdddc69 100644 --- a/docs/source/markdown/options/publish.md +++ b/docs/source/markdown/options/publish.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--publish**, **-p**=*[[ip:][hostPort]:]containerPort[/protocol]* diff --git a/docs/source/markdown/options/pull.md b/docs/source/markdown/options/pull.md index a67dac65e1..c8c45fbf93 100644 --- a/docs/source/markdown/options/pull.md +++ b/docs/source/markdown/options/pull.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--pull**=*policy* diff --git a/docs/source/markdown/options/read-only-tmpfs.md b/docs/source/markdown/options/read-only-tmpfs.md index cae57e888b..f1419a22a3 100644 --- a/docs/source/markdown/options/read-only-tmpfs.md +++ b/docs/source/markdown/options/read-only-tmpfs.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--read-only-tmpfs** diff --git a/docs/source/markdown/options/read-only.md b/docs/source/markdown/options/read-only.md index 9de13a8a14..1155f9e9c8 100644 --- a/docs/source/markdown/options/read-only.md +++ b/docs/source/markdown/options/read-only.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--read-only** diff --git a/docs/source/markdown/options/replace.md b/docs/source/markdown/options/replace.md index 353685bf29..3b56100cbc 100644 --- a/docs/source/markdown/options/replace.md +++ b/docs/source/markdown/options/replace.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--replace** diff --git a/docs/source/markdown/options/requires.md b/docs/source/markdown/options/requires.md index 4c784d7dd3..8c2901239f 100644 --- a/docs/source/markdown/options/requires.md +++ b/docs/source/markdown/options/requires.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--requires**=*container* diff --git a/docs/source/markdown/options/restart.md b/docs/source/markdown/options/restart.md index 60c536f57b..3a5e665c12 100644 --- a/docs/source/markdown/options/restart.md +++ b/docs/source/markdown/options/restart.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--restart**=*policy* @@ -14,6 +14,6 @@ Valid _policy_ values are: - `always` : Restart containers when they exit, regardless of status, retrying indefinitely - `unless-stopped` : Identical to **always** -Please note that restart will not restart containers after a system reboot. -If this functionality is required in your environment, you can invoke Podman from a **systemd.unit**(5) file, or create an init script for whichever init system is in use. -To generate systemd unit files, please see **podman generate systemd**. +Podman provides a systemd unit file, podman-restart.service, which restarts containers after a system reboot. + +If container will run as a system service, generate a systemd unit file to manage it. See **podman generate systemd**. diff --git a/docs/source/markdown/options/rootfs.md b/docs/source/markdown/options/rootfs.md index 07cbd485ff..1a773de8b1 100644 --- a/docs/source/markdown/options/rootfs.md +++ b/docs/source/markdown/options/rootfs.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--rootfs** diff --git a/docs/source/markdown/options/sdnotify.md b/docs/source/markdown/options/sdnotify.md index c5c6de4e06..4faa9d9ae1 100644 --- a/docs/source/markdown/options/sdnotify.md +++ b/docs/source/markdown/options/sdnotify.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--sdnotify**=**container** | *conmon* | *ignore* diff --git a/docs/source/markdown/options/seccomp-policy.md b/docs/source/markdown/options/seccomp-policy.md index 08c6af67a2..b22f5b2b5c 100644 --- a/docs/source/markdown/options/seccomp-policy.md +++ b/docs/source/markdown/options/seccomp-policy.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--seccomp-policy**=*policy* diff --git a/docs/source/markdown/options/secret.md b/docs/source/markdown/options/secret.md index 68e1825f2d..2c625bc7f2 100644 --- a/docs/source/markdown/options/secret.md +++ b/docs/source/markdown/options/secret.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--secret**=*secret[,opt=opt ...]* diff --git a/docs/source/markdown/options/security-opt.md b/docs/source/markdown/options/security-opt.md index bdd9233dbb..252bede2ff 100644 --- a/docs/source/markdown/options/security-opt.md +++ b/docs/source/markdown/options/security-opt.md @@ -1,13 +1,13 @@ ####> This option file is used in: ####> podman create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--security-opt**=*option* Security Options - **apparmor=unconfined** : Turn off apparmor confinement for the <> -- **apparmor**=_your-profile_ : Set the apparmor confinement profile for the <> +- **apparmor**=_alternate-profile_ : Set the apparmor confinement profile for the <> - **label=user:**_USER_: Set the label user for the <> processes - **label=role:**_ROLE_: Set the label role for the <> processes diff --git a/docs/source/markdown/options/shm-size.md b/docs/source/markdown/options/shm-size.md index 79d1506fe3..381a123819 100644 --- a/docs/source/markdown/options/shm-size.md +++ b/docs/source/markdown/options/shm-size.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--shm-size**=*number[unit]* diff --git a/docs/source/markdown/options/sig-proxy.md b/docs/source/markdown/options/sig-proxy.md index 66c5b85fca..6b2ccb3409 100644 --- a/docs/source/markdown/options/sig-proxy.md +++ b/docs/source/markdown/options/sig-proxy.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman attach, run, start -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--sig-proxy** diff --git a/docs/source/markdown/options/sign-passphrase-file.md b/docs/source/markdown/options/sign-passphrase-file.md index c8aa2d965c..c3b272d444 100644 --- a/docs/source/markdown/options/sign-passphrase-file.md +++ b/docs/source/markdown/options/sign-passphrase-file.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman manifest push, push -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--sign-passphrase-file**=*path* diff --git a/docs/source/markdown/options/signal.md b/docs/source/markdown/options/signal.md index 5b713e62cb..925615f79c 100644 --- a/docs/source/markdown/options/signal.md +++ b/docs/source/markdown/options/signal.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman kill, pod kill -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--signal**, **-s**=**signal** diff --git a/docs/source/markdown/options/since.md b/docs/source/markdown/options/since.md index 71eb14f2af..461b972969 100644 --- a/docs/source/markdown/options/since.md +++ b/docs/source/markdown/options/since.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman logs, pod logs -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--since**=*TIMESTAMP* diff --git a/docs/source/markdown/options/stop-signal.md b/docs/source/markdown/options/stop-signal.md index 33442a5ba1..efbca84cf7 100644 --- a/docs/source/markdown/options/stop-signal.md +++ b/docs/source/markdown/options/stop-signal.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--stop-signal**=*signal* diff --git a/docs/source/markdown/options/stop-timeout.md b/docs/source/markdown/options/stop-timeout.md index 4a6fb0b065..0277f91189 100644 --- a/docs/source/markdown/options/stop-timeout.md +++ b/docs/source/markdown/options/stop-timeout.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--stop-timeout**=*seconds* diff --git a/docs/source/markdown/options/subgidname.md b/docs/source/markdown/options/subgidname.md index 9c0b814846..d31cb7ea79 100644 --- a/docs/source/markdown/options/subgidname.md +++ b/docs/source/markdown/options/subgidname.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--subgidname**=*name* diff --git a/docs/source/markdown/options/subuidname.md b/docs/source/markdown/options/subuidname.md index c92810be73..ac3e1f372a 100644 --- a/docs/source/markdown/options/subuidname.md +++ b/docs/source/markdown/options/subuidname.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--subuidname**=*name* diff --git a/docs/source/markdown/options/sysctl.md b/docs/source/markdown/options/sysctl.md index 3b6ad104ce..1027d5640f 100644 --- a/docs/source/markdown/options/sysctl.md +++ b/docs/source/markdown/options/sysctl.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--sysctl**=*name=value* @@ -18,8 +18,8 @@ For the IPC namespace, the following sysctls are allowed: - kernel.shm_rmid_forced - Sysctls beginning with fs.mqueue.\* -Note: <>, the above sysctls are not allowed. +Note: <>, the above sysctls are not allowed. For the network namespace, only sysctls beginning with net.\* are allowed. -Note: <>, the above sysctls are not allowed. +Note: <>, the above sysctls are not allowed. diff --git a/docs/source/markdown/options/systemd.md b/docs/source/markdown/options/systemd.md index 07ceb4fcdb..973c063536 100644 --- a/docs/source/markdown/options/systemd.md +++ b/docs/source/markdown/options/systemd.md @@ -1,15 +1,17 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--systemd**=*true* | *false* | *always* Run container in systemd mode. The default is **true**. -The value *always* enforces the systemd mode is enforced without -looking at the executable name. Otherwise, if set to true and the -command you are running inside the container is **systemd**, **/usr/sbin/init**, -**/sbin/init** or **/usr/local/sbin/init**. +- **true** enables systemd mode only when the command executed inside the container is *systemd*, */usr/sbin/init*, +*/sbin/init* or */usr/local/sbin/init*, systemd mode is enabled. + +- **false** disables systemd mode. + +- **always** enforces the systemd mode to be enabled. Running the container in systemd mode causes the following changes: diff --git a/docs/source/markdown/options/tail.md b/docs/source/markdown/options/tail.md index 5607dbbab0..10012d5ad1 100644 --- a/docs/source/markdown/options/tail.md +++ b/docs/source/markdown/options/tail.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman logs, pod logs -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--tail**=*LINES* diff --git a/docs/source/markdown/options/time.md b/docs/source/markdown/options/time.md index e4da5236bb..ba1cdc1d8c 100644 --- a/docs/source/markdown/options/time.md +++ b/docs/source/markdown/options/time.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod rm, pod stop, restart, rm, stop -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--time**, **-t**=*seconds* diff --git a/docs/source/markdown/options/timeout.md b/docs/source/markdown/options/timeout.md index 6b1ca1b98e..be959d73ac 100644 --- a/docs/source/markdown/options/timeout.md +++ b/docs/source/markdown/options/timeout.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--timeout**=*seconds* diff --git a/docs/source/markdown/options/timestamps.md b/docs/source/markdown/options/timestamps.md index a228bdb6e4..1ff2a125a6 100644 --- a/docs/source/markdown/options/timestamps.md +++ b/docs/source/markdown/options/timestamps.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman logs, pod logs -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--timestamps**, **-t** diff --git a/docs/source/markdown/options/tls-verify.md b/docs/source/markdown/options/tls-verify.md index b2905f661e..bf2b7d4d84 100644 --- a/docs/source/markdown/options/tls-verify.md +++ b/docs/source/markdown/options/tls-verify.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman build, container runlabel, create, kube play, login, manifest add, manifest create, manifest inspect, manifest push, pull, push, run, search -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--tls-verify** diff --git a/docs/source/markdown/options/tmpfs.md b/docs/source/markdown/options/tmpfs.md index 5e9fa6bc7c..11c62756ae 100644 --- a/docs/source/markdown/options/tmpfs.md +++ b/docs/source/markdown/options/tmpfs.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--tmpfs**=*fs* @@ -13,6 +13,6 @@ $ podman <> -d --tmpfs /tmp:rw,size=787448k,mode=1777 my_image ``` This command mounts a **tmpfs** at _/tmp_ within the container. The supported mount -options are the same as the Linux default mount flags. If you do not specify -any options, the system uses the following options: +options are the same as the Linux default mount flags. If no options are specified, +the system uses the following options: **rw,noexec,nosuid,nodev**. diff --git a/docs/source/markdown/options/tty.md b/docs/source/markdown/options/tty.md index e5579b4342..4ca1827a2e 100644 --- a/docs/source/markdown/options/tty.md +++ b/docs/source/markdown/options/tty.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, exec, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--tty**, **-t** diff --git a/docs/source/markdown/options/tz.md b/docs/source/markdown/options/tz.md index 258da5414a..bfe18f0e6a 100644 --- a/docs/source/markdown/options/tz.md +++ b/docs/source/markdown/options/tz.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--tz**=*timezone* diff --git a/docs/source/markdown/options/uidmap.container.md b/docs/source/markdown/options/uidmap.container.md index 19409bb351..63370f3b57 100644 --- a/docs/source/markdown/options/uidmap.container.md +++ b/docs/source/markdown/options/uidmap.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--uidmap**=*container_uid:from_uid:amount* diff --git a/docs/source/markdown/options/uidmap.pod.md b/docs/source/markdown/options/uidmap.pod.md index 5fc3dc150d..04f7c229c7 100644 --- a/docs/source/markdown/options/uidmap.pod.md +++ b/docs/source/markdown/options/uidmap.pod.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--uidmap**=*container_uid:from_uid:amount* diff --git a/docs/source/markdown/options/ulimit.md b/docs/source/markdown/options/ulimit.md index fb8264b630..4f035d53c2 100644 --- a/docs/source/markdown/options/ulimit.md +++ b/docs/source/markdown/options/ulimit.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--ulimit**=*option* diff --git a/docs/source/markdown/options/umask.md b/docs/source/markdown/options/umask.md index b20833f314..389eba9f49 100644 --- a/docs/source/markdown/options/umask.md +++ b/docs/source/markdown/options/umask.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--umask**=*umask* diff --git a/docs/source/markdown/options/unsetenv-all.md b/docs/source/markdown/options/unsetenv-all.md index 98328f9fde..a9370e169a 100644 --- a/docs/source/markdown/options/unsetenv-all.md +++ b/docs/source/markdown/options/unsetenv-all.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--unsetenv-all** diff --git a/docs/source/markdown/options/unsetenv.md b/docs/source/markdown/options/unsetenv.md index 38ec4e5f3c..bd98d4999b 100644 --- a/docs/source/markdown/options/unsetenv.md +++ b/docs/source/markdown/options/unsetenv.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--unsetenv**=*env* diff --git a/docs/source/markdown/options/until.md b/docs/source/markdown/options/until.md index b3b11d844a..314fe63e7b 100644 --- a/docs/source/markdown/options/until.md +++ b/docs/source/markdown/options/until.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman logs, pod logs -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--until**=*TIMESTAMP* diff --git a/docs/source/markdown/options/user.md b/docs/source/markdown/options/user.md index 68f60e1845..f81718bc5d 100644 --- a/docs/source/markdown/options/user.md +++ b/docs/source/markdown/options/user.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, exec, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--user**, **-u**=*user[:group]* diff --git a/docs/source/markdown/options/userns.container.md b/docs/source/markdown/options/userns.container.md index 61816383d2..4c2f398f2a 100644 --- a/docs/source/markdown/options/userns.container.md +++ b/docs/source/markdown/options/userns.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, kube play, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--userns**=*mode* diff --git a/docs/source/markdown/options/userns.pod.md b/docs/source/markdown/options/userns.pod.md index c566fddb4d..bf31f7dfb9 100644 --- a/docs/source/markdown/options/userns.pod.md +++ b/docs/source/markdown/options/userns.pod.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--userns**=*mode* diff --git a/docs/source/markdown/options/uts.container.md b/docs/source/markdown/options/uts.container.md index 7d5ebdb49f..056de8f3ea 100644 --- a/docs/source/markdown/options/uts.container.md +++ b/docs/source/markdown/options/uts.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--uts**=*mode* diff --git a/docs/source/markdown/options/uts.pod.md b/docs/source/markdown/options/uts.pod.md index bc4c2415df..6bbbe2dbf2 100644 --- a/docs/source/markdown/options/uts.pod.md +++ b/docs/source/markdown/options/uts.pod.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman pod clone, pod create -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--uts**=*mode* diff --git a/docs/source/markdown/options/variant.container.md b/docs/source/markdown/options/variant.container.md index a039825852..522e74bf1a 100644 --- a/docs/source/markdown/options/variant.container.md +++ b/docs/source/markdown/options/variant.container.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pull, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--variant**=*VARIANT* diff --git a/docs/source/markdown/options/variant.manifest.md b/docs/source/markdown/options/variant.manifest.md index 8f63ac681c..304c9bfbcd 100644 --- a/docs/source/markdown/options/variant.manifest.md +++ b/docs/source/markdown/options/variant.manifest.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman manifest add, manifest annotate -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--variant** diff --git a/docs/source/markdown/options/volume.md b/docs/source/markdown/options/volume.md index 3f463c5402..5b6d358249 100644 --- a/docs/source/markdown/options/volume.md +++ b/docs/source/markdown/options/volume.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--volume**, **-v**=*[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]* @@ -80,7 +80,7 @@ The **Z** option tells Podman to label the content with a private unshared label Only the current <> can use a private volume. Note: Do not relabel system files and directories. Relabeling system content -might cause other confined services on your machine to fail. For these types +might cause other confined services on the machine to fail. For these types of containers we recommend disabling SELinux separation. The option **--security-opt label=disable** disables SELinux separation for the <>. For example if a user wanted to volume mount their entire home directory into a diff --git a/docs/source/markdown/options/volumes-from.md b/docs/source/markdown/options/volumes-from.md index 977ba41f1d..0463017e11 100644 --- a/docs/source/markdown/options/volumes-from.md +++ b/docs/source/markdown/options/volumes-from.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, pod clone, pod create, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--volumes-from**=*CONTAINER[:OPTIONS]* diff --git a/docs/source/markdown/options/workdir.md b/docs/source/markdown/options/workdir.md index 4e1226cfa9..70a63eba74 100644 --- a/docs/source/markdown/options/workdir.md +++ b/docs/source/markdown/options/workdir.md @@ -1,6 +1,6 @@ ####> This option file is used in: ####> podman create, exec, run -####> If you edit this file, make sure your changes +####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--workdir**, **-w**=*dir* diff --git a/docs/source/markdown/podman-attach.1.md.in b/docs/source/markdown/podman-attach.1.md.in index 80f35e3bc0..b3fd31a580 100644 --- a/docs/source/markdown/podman-attach.1.md.in +++ b/docs/source/markdown/podman-attach.1.md.in @@ -15,11 +15,7 @@ The *container* can be detached from (and leave it running) using a configurable ## OPTIONS @@option detach-keys -#### **--latest**, **-l** - -Instead of providing the *container ID* or *name*, use the last created *container*. If other methods than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either of those methods.\ -The default is **false**.\ -*IMPORTANT: This OPTION is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines. This OPTION does not need a container name or ID as input argument.* +@@option latest #### **--no-stdin** diff --git a/docs/source/markdown/podman-build.1.md.in b/docs/source/markdown/podman-build.1.md.in index 6343188fb3..011a78d059 100644 --- a/docs/source/markdown/podman-build.1.md.in +++ b/docs/source/markdown/podman-build.1.md.in @@ -90,7 +90,7 @@ Valid values could be: * HTTP URL to a tarball – e.g. --build-context src=https://example.org/releases/src.tar * Container image – specified with a container-image:// prefix, e.g. --build-context alpine=container-image://alpine:3.15, (also accepts docker://, docker-image://) -On the Containerfile side, you can reference the build context on all +On the Containerfile side, reference the build context on all commands that accept the “from” parameter. Here’s how that might look: ```dockerfile @@ -261,7 +261,7 @@ If a build context is not specified, and at least one Containerfile is a local file, the directory in which it resides will be used as the build context. -If you specify `-f -`, the Containerfile contents will be read from stdin. +Specifying the option `-f -` causes the Containerfile contents to be read from stdin. #### **--force-rm** @@ -284,9 +284,8 @@ FROM instructions in a Containerfile, only the first is changed. With the remote podman client, not all container transports will work as expected. For example, oci-archive:/x.tar will reference /x.tar on the remote -machine instead of on the client. If you need to support remote podman clients, -it is best to restrict yourself to containers-storage: and docker:// -transports. +machine instead of on the client. When using podman remote clients it is +best to restrict use to *containers-storage*, and *docker:// transports*. #### **--help**, **-h** @@ -483,7 +482,7 @@ process. #### **--platform**=*os/arch[/variant][,...]* -Set the *os/arch* of the built image (and its base image, if your build uses one) +Set the *os/arch* of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host (for example `linux/arm`). Unless overridden, subsequent lookups of the same image in the local storage will match this @@ -565,7 +564,7 @@ To later use the secret, use the --mount option in a `RUN` instruction within a Security Options - `apparmor=unconfined` : Turn off apparmor confinement for the container -- `apparmor=your-profile` : Set the apparmor confinement profile for the +- `apparmor=alternate-profile` : Set the apparmor confinement profile for the container - `label=user:USER` : Set the label user for the container processes @@ -766,8 +765,8 @@ using the architecture variant of the build host. #### **--volume**, **-v**=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]* -Create a bind mount. If you specify `-v /HOST-DIR:/CONTAINER-DIR`, Podman -bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the Podman +Create a bind mount. Specifying the `-v /HOST-DIR:/CONTAINER-DIR` option, Podman +bind mounts `/HOST-DIR` from the host to `/CONTAINER-DIR` in the Podman container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) @@ -780,7 +779,7 @@ The `OPTIONS` are a comma-separated list and can be: [[1]](#Footnote1)** syntax. +Note: When joining multiple networks use the **--network name:ip=\** syntax. #### **--log-driver**=*driver* @@ -160,7 +160,7 @@ Set logging driver for all created containers. #### **--mac-address**=*MAC address* Assign a static mac address to the pod. This option can be specified several times when kube play creates more than one pod. -Note: When joining multiple networks you should use the **--network name:mac=\** syntax. +Note: When joining multiple networks use the **--network name:mac=\** syntax. @@option network diff --git a/docs/source/markdown/podman-logs.1.md.in b/docs/source/markdown/podman-logs.1.md.in index 63144bec3e..d8b6a5a9dd 100644 --- a/docs/source/markdown/podman-logs.1.md.in +++ b/docs/source/markdown/podman-logs.1.md.in @@ -10,8 +10,8 @@ podman\-logs - Display the logs of one or more containers ## DESCRIPTION The podman logs command batch-retrieves whatever logs are present for one or more containers at the time of execution. -This does not guarantee execution order when combined with podman run (i.e. your run may not have generated -any logs at the time you execute podman logs). +This does not guarantee execution order when combined with podman run (i.e. the run may not have generated +any logs at the time podman logs was executed). ## OPTIONS @@ -19,10 +19,7 @@ any logs at the time you execute podman logs). @@option follow -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option names @@ -87,7 +84,7 @@ To view a container's logs generated in the last 10 minutes: podman logs --since 10m myserver # Server can't set maximum open files to 10032 because of OS error: Operation not permitted. -# 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'. +# Current maximum open files is 4096. maxclients has been reduced to 4064 to compensate for low ulimit, Increase 'ulimit -n' when higher maxclients are required. ``` To view a container's logs until 30 minutes ago: diff --git a/docs/source/markdown/podman-mount.1.md b/docs/source/markdown/podman-mount.1.md.in similarity index 73% rename from docs/source/markdown/podman-mount.1.md rename to docs/source/markdown/podman-mount.1.md.in index 8229b13909..73a13eaa60 100644 --- a/docs/source/markdown/podman-mount.1.md +++ b/docs/source/markdown/podman-mount.1.md.in @@ -12,12 +12,11 @@ podman\-mount - Mount a working container's root filesystem Mounts the specified containers' root file system in a location which can be accessed from the host, and returns its location. -If you execute the command without any arguments, Podman will list all of the -currently mounted containers, including external containers. External containers are -containers in container/storage by tools other than Podman. For example Buildah and -CRI-O. +Podman lists all of the currently mounted containers, including external containers, when the command is executed +without any arguments. External containers are containers in container/storage by tools other than Podman. +For example Buildah and CRI-O. -Rootless mode only supports mounting VFS driver, unless you enter the user namespace +Rootless mode only supports mounting VFS driver, unless Podman is run within the user namespace via the `podman unshare` command. All other storage drivers will fail to mount. ## RETURN VALUE @@ -34,11 +33,7 @@ Mount all podman containers. (External containers will not be mounted) Print the mounted containers in specified format (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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest #### **--no-trunc** diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md index 72cec874a8..0582f7b36a 100644 --- a/docs/source/markdown/podman-network-create.1.md +++ b/docs/source/markdown/podman-network-create.1.md @@ -11,7 +11,7 @@ Create a network configuration for use with Podman. By default, Podman creates a A *Macvlan* connection can be created with the *-d macvlan* option. A parent device for macvlan can be designated with the *-o parent=``* option. -If no options are provided, Podman will assign a free subnet and name for your network. +If no options are provided, Podman will assign a free subnet and name for the network. Upon completion of creating the network, Podman will display the name of the newly added network. @@ -35,8 +35,8 @@ Special considerations for the *netavark* backend: #### **--gateway** -Define a gateway for the subnet. If you want to provide a gateway address, you must also provide a -*subnet* option. Can be specified multiple times. +Define a gateway for the subnet. To provide a gateway address, a +*subnet* option is required. Can be specified multiple times. The argument order of the **--subnet**, **--gateway** and **--ip-range** options must match. #### **--internal** @@ -55,10 +55,10 @@ The argument order of the **--subnet**, **--gateway** and **--ip-range** options Set the ipam driver (IP Address Management Driver) for the network. When unset podman will choose an ipam driver automatically based on the network driver. Valid values are: - `host-local`: IP addresses are assigned locally. - - `dhcp`: IP addresses are assigned from a dhcp server on your network. This driver is not yet supported with netavark. For CNI the *dhcp* plugin needs to be activated before. + - `dhcp`: IP addresses are assigned from a dhcp server on the network. This driver is not yet supported with netavark. For CNI the *dhcp* plugin needs to be activated before. - `none`: No ip addresses are assigned to the interfaces. -You can see the driver in the **podman network inspect** output under the `ipam_options` field. +View the driver in the **podman network inspect** output under the `ipam_options` field. #### **--ipv6** diff --git a/docs/source/markdown/podman-network-reload.1.md b/docs/source/markdown/podman-network-reload.1.md.in similarity index 79% rename from docs/source/markdown/podman-network-reload.1.md rename to docs/source/markdown/podman-network-reload.1.md.in index 4ecce17f84..004cafce1a 100644 --- a/docs/source/markdown/podman-network-reload.1.md +++ b/docs/source/markdown/podman-network-reload.1.md.in @@ -18,10 +18,7 @@ the network connectivity. Reload network configuration of 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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest ## EXAMPLE diff --git a/docs/source/markdown/podman-pause.1.md.in b/docs/source/markdown/podman-pause.1.md.in index a228f7107e..7194e8143a 100644 --- a/docs/source/markdown/podman-pause.1.md.in +++ b/docs/source/markdown/podman-pause.1.md.in @@ -43,10 +43,7 @@ Valid filters are listed below: | pod | [Pod] name or full or partial ID of pod | | network | [Network] name or full ID of network | -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest ## EXAMPLE diff --git a/docs/source/markdown/podman-pod-create.1.md.in b/docs/source/markdown/podman-pod-create.1.md.in index d26ae62765..ad68a54186 100644 --- a/docs/source/markdown/podman-pod-create.1.md.in +++ b/docs/source/markdown/podman-pod-create.1.md.in @@ -21,10 +21,11 @@ Name (“jonah”) podman generates a UUID for each pod, and if a name is not assigned to the container with **--name** then a random string name will be generated -for it. The name is useful any place you need to identify a pod. +for it. This name is useful to identify a pod. -Note: resource limit related flags work by setting the limits explicitly in the pod's cgroup -which by default, is the cgroup parent for all containers joining the pod. Containers are still delegated the ability to set their own resource limits when joining a pod meaning that if you run **podman pod create --cpus=5** you can also run **podman container create --pod=`` --cpus=4** and the container will only see the smaller limit. containers do NOT get the pod level cgroup resources if they specify their own cgroup when joining a pod such as **--cgroupns=host** +Note: resource limit related flags work by setting the limits explicitly in the pod's cgroup parent +for all containers joining the pod. A container can override the resource limits when joining a pod. +For example, if a pod was created via **podman pod create --cpus=5**, specifying **podman container create --pod=`` --cpus=4** causes the container to use the smaller limit. Also, containers which specify their own cgroup, such as **--cgroupns=host**, do NOT get the assigned pod level cgroup resources. ## OPTIONS @@ -150,7 +151,7 @@ A comma-separated list of kernel namespaces to share. If none or "" is specified #### **--share-parent** -This boolean determines whether or not all containers entering the pod will use the pod as their cgroup parent. The default value of this flag is true. If you are looking to share the cgroup namespace rather than a cgroup parent in a pod, use **--share** +This boolean determines whether or not all containers entering the pod will use the pod as their cgroup parent. The default value of this flag is true. Use the **--share** option to share the cgroup namespace rather than a cgroup parent in a pod. Note: This options conflict with **--share=cgroup** since that would set the pod as the cgroup parent but enter the container into the same cgroupNS as the infra container. diff --git a/docs/source/markdown/podman-pod-inspect.1.md b/docs/source/markdown/podman-pod-inspect.1.md.in similarity index 92% rename from docs/source/markdown/podman-pod-inspect.1.md rename to docs/source/markdown/podman-pod-inspect.1.md.in index 609cc47da9..b43f6977ce 100644 --- a/docs/source/markdown/podman-pod-inspect.1.md +++ b/docs/source/markdown/podman-pod-inspect.1.md.in @@ -55,10 +55,7 @@ Valid placeholders for the Go template are listed below: | .State | Pod state | | .VolumesFrom | Volumes from | -#### **--latest**, **-l** - -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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest ## EXAMPLE ``` diff --git a/docs/source/markdown/podman-pod-kill.1.md.in b/docs/source/markdown/podman-pod-kill.1.md.in index 64425bb4df..b7eb003652 100644 --- a/docs/source/markdown/podman-pod-kill.1.md.in +++ b/docs/source/markdown/podman-pod-kill.1.md.in @@ -14,10 +14,7 @@ The main process of each container inside the pods specified will be sent SIGKIL Sends signal to all containers associated with a pod. -#### **--latest**, **-l** - -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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option signal diff --git a/docs/source/markdown/podman-pod-logs.1.md.in b/docs/source/markdown/podman-pod-logs.1.md.in index cc224eee30..326eab1847 100644 --- a/docs/source/markdown/podman-pod-logs.1.md.in +++ b/docs/source/markdown/podman-pod-logs.1.md.in @@ -21,9 +21,7 @@ By default `podman pod logs` retrieves logs for all the containers available wit @@option follow -#### **--latest**, **-l** - -Instead of providing the pod name or id, get logs of the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option names diff --git a/docs/source/markdown/podman-pod-rm.1.md.in b/docs/source/markdown/podman-pod-rm.1.md.in index 093966b368..aa5dff226e 100644 --- a/docs/source/markdown/podman-pod-rm.1.md.in +++ b/docs/source/markdown/podman-pod-rm.1.md.in @@ -21,9 +21,7 @@ Stop running containers and delete all stopped containers before removal of pod. @@option ignore -#### **--latest**, **-l** - -Instead of providing the pod name or ID, remove the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option pod-id-file.pod If specified, the pod-id-file will be removed along with the pod. diff --git a/docs/source/markdown/podman-pod-start.1.md.in b/docs/source/markdown/podman-pod-start.1.md.in index aec67b0098..5a681ba378 100644 --- a/docs/source/markdown/podman-pod-start.1.md.in +++ b/docs/source/markdown/podman-pod-start.1.md.in @@ -16,9 +16,7 @@ to be started. Starts all pods -#### **--latest**, **-l** - -Instead of providing the pod name or ID, start the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option pod-id-file.pod diff --git a/docs/source/markdown/podman-pod-stats.1.md.in b/docs/source/markdown/podman-pod-stats.1.md.in index 4ecb30bdbc..2dfb5cef0b 100644 --- a/docs/source/markdown/podman-pod-stats.1.md.in +++ b/docs/source/markdown/podman-pod-stats.1.md.in @@ -34,11 +34,9 @@ Valid placeholders for the Go template are listed below: | .PIDS | Number of PIDs | | .Pod | Pod ID | -When using a GO template, you may precede the format with `table` to print headers. +When using a Go template, precede the format with `table` to print headers. -#### **--latest**, **-l** - -Instead of providing the pod name or ID, use the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option no-reset diff --git a/docs/source/markdown/podman-pod-stop.1.md.in b/docs/source/markdown/podman-pod-stop.1.md.in index e6ffa4f76e..75650eafa8 100644 --- a/docs/source/markdown/podman-pod-stop.1.md.in +++ b/docs/source/markdown/podman-pod-stop.1.md.in @@ -17,9 +17,7 @@ Stops all pods @@option ignore -#### **--latest**, **-l** - -Instead of providing the pod name or ID, stop the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option pod-id-file.pod diff --git a/docs/source/markdown/podman-pod-top.1.md b/docs/source/markdown/podman-pod-top.1.md.in similarity index 74% rename from docs/source/markdown/podman-pod-top.1.md rename to docs/source/markdown/podman-pod-top.1.md.in index 6a20776564..8fcf84aff6 100644 --- a/docs/source/markdown/podman-pod-top.1.md +++ b/docs/source/markdown/podman-pod-top.1.md.in @@ -7,7 +7,7 @@ podman\-pod\-top - Display the running processes of containers in a pod **podman pod top** [*options*] *pod* [*format-descriptors*] ## DESCRIPTION -Display the running processes of containers in a pod. 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 specify options and/or additionally options of ps(1); in this case, Podman will fallback to executing ps with the specified arguments and options in the container. +Display the running processes of containers in a pod. 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 separate arguments or as a single comma-separated argument. Note that if additional options of ps(1) are specified, Podman falls back to executing ps with the specified arguments and options in the container. ## OPTIONS @@ -15,9 +15,7 @@ Display the running processes of containers in a pod. The *format-descriptors* a Print usage statement -#### **--latest**, **-l** - -Instead of providing the pod name or ID, use the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest ## FORMAT DESCRIPTORS diff --git a/docs/source/markdown/podman-port.1.md b/docs/source/markdown/podman-port.1.md.in similarity index 68% rename from docs/source/markdown/podman-port.1.md rename to docs/source/markdown/podman-port.1.md.in index c1c67a28df..45ac1bf128 100644 --- a/docs/source/markdown/podman-port.1.md +++ b/docs/source/markdown/podman-port.1.md.in @@ -15,13 +15,9 @@ List port mappings for the *container* or look up the public-facing port that is #### **--all**, **-a** -List all known port mappings for running containers. When using this option, you cannot pass any container names -or private ports/protocols as filters. +List all known port mappings for running containers; when using this option, container names or private ports/protocols filters cannot be used. -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest ## EXAMPLE diff --git a/docs/source/markdown/podman-restart.1.md.in b/docs/source/markdown/podman-restart.1.md.in index 71543ef6af..4a4838f97c 100644 --- a/docs/source/markdown/podman-restart.1.md.in +++ b/docs/source/markdown/podman-restart.1.md.in @@ -47,10 +47,7 @@ Valid filters are listed below: | pod | [Pod] name or full or partial ID of pod | | network | [Network] name or full ID of network | -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest #### **--running** diff --git a/docs/source/markdown/podman-rm.1.md.in b/docs/source/markdown/podman-rm.1.md.in index 802096b7ab..e8ac184848 100644 --- a/docs/source/markdown/podman-rm.1.md.in +++ b/docs/source/markdown/podman-rm.1.md.in @@ -60,10 +60,7 @@ whose OCI runtime has become unavailable. Further ignore when the specified `--cidfile` does not exist as it may have already been removed along with the container. -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option time diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index e23e88af32..a144248a9a 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -137,11 +137,11 @@ and specified with a _tag_. Detached mode: run the container in the background and print the new container ID. The default is *false*. -At any time you can run **podman ps** in -the other shell to view a list of the running containers. You can reattach to a -detached container with **podman attach**. +At any time run **podman ps** in +the other shell to view a list of the running containers. Reattach to a +detached container with **podman attach** command. -When attached in the tty mode, you can detach from the container (and leave it +When attached via tty mode, detach from the container (and leave it running) using a configurable key sequence. The default sequence is `ctrl-p,ctrl-q`. Specify the key sequence using the **--detach-keys** option, or configure it in the **containers.conf** file: see **containers.conf(5)** for more information. @@ -313,8 +313,8 @@ This is used to override the Podman provided user setup in favor of entrypoint c **Note:** If a container will be run within a pod, it is not necessary to publish the port for the containers in the pod. The port must only be published by the pod itself. Pod network -stacks act like the network stack on the host - you have a variety of containers in the pod, -and programs in the container, all sharing a single interface and IP address, and +stacks act like the network stack on the host - meaning a variety of containers in the pod +and programs in the container all share a single interface, IP address, and associated ports. If one container binds to a port, no other container can use that port within the pod while it is in use. Containers in the pod can also communicate over localhost by having one container bind to localhost in the pod, and another connect to that port. @@ -465,14 +465,14 @@ $ podman run --read-only --read-only-tmpfs=false --tmpfs /run -i -t fedora /bin/ ### Exposing log messages from the container to the host's log -If you want messages that are logged in your container to show up in the host's -syslog/journal then you should bind mount the _/dev/log_ directory as follows. +Bind mount the _/dev/log_ directory to have messages that are logged in the container show up in the host's +syslog/journal. ``` $ podman run -v /dev/log:/dev/log -i -t fedora /bin/bash ``` -From inside the container you can test this by sending a message to the log. +From inside the container test this by sending a message to the log. ``` (bash)# logger "Hello from my container" @@ -490,9 +490,8 @@ This should list the message sent to logger. ### Attaching to one or more from STDIN, STDOUT, STDERR -If you do not specify **-a**, Podman will attach everything (stdin, stdout, stderr). -You can specify to which of the three standard streams (stdin, stdout, stderr) -you'd like to connect instead, as in: +Without specifying the **-a** option, Podman will attach everything (stdin, stdout, stderr). +Override the default by specifying -a (stdin, stdout, stderr), as in: ``` $ podman run -a stdin -a stdout -i -t fedora /bin/bash @@ -579,7 +578,7 @@ To mount a host directory as a container volume, specify the absolute path to the directory and the absolute path for the container directory separated by a colon. If the source is a named volume maintained by Podman, it is recommended to use its name rather than the path to the volume. Otherwise the volume will be -considered as an orphan and wiped if you execute **podman volume prune**: +considered as an orphan and wiped by the **podman volume prune** command: ``` $ podman run -v /var/db:/data1 -i -t fedora bash @@ -630,10 +629,10 @@ changes will also be reflected on the host in _/var/db_. ### Using alternative security labeling -You can override the default labeling scheme for each container by specifying -the **--security-opt** flag. For example, you can specify the MCS/MLS level, a +Override the default labeling scheme for each container by specifying +the **--security-opt** flag. For example, specify the MCS/MLS level, a requirement for MLS systems. Specifying the level in the following command -allows you to share the same content between containers. +allows the same content to be shared between containers. ``` podman run --security-opt label=level:s0:c100,c200 -i -t fedora bash @@ -652,8 +651,8 @@ To disable the security labeling for this container versus running with the $ podman run --security-opt label=disable -i -t fedora bash ``` -If you want a tighter security policy on the processes within a container, -you can specify an alternate type for the container. You could run a container +Tighten the security policy on the processes within a container by specifying an +alternate type for the container. For example, run a container that is only allowed to listen on Apache ports by executing the following command: @@ -661,7 +660,7 @@ command: $ podman run --security-opt label=type:svirt_apache_t -i -t centos bash ``` -Note you would have to write policy defining a **svirt_apache_t** type. +Note an SELinux policy defining a **svirt_apache_t** type would need to be written. To mask additional specific paths in the container, specify the paths separated by a colon using the **mask** option with the **--security-opt** @@ -690,10 +689,7 @@ $ podman run --security-opt unmask=/proc/* fedora bash $ podman run --security-opt unmask=/foo/bar:/sys/firmware fedora bash ``` -### Setting device weight - -If you want to set _/dev/sda_ device weight to **200**, you can specify the device -weight by **--blkio-weight-device** flag. Use the following command: +### Setting device weight via **--blkio-weight-device** flag. ``` $ podman run -it --blkio-weight-device "/dev/sda:200" ubuntu diff --git a/docs/source/markdown/podman-start.1.md.in b/docs/source/markdown/podman-start.1.md.in index 52a3a8a124..34ba0acf3b 100644 --- a/docs/source/markdown/podman-start.1.md.in +++ b/docs/source/markdown/podman-start.1.md.in @@ -9,10 +9,10 @@ podman\-start - Start one or more containers **podman container start** [*options*] *container* ... ## DESCRIPTION -Start one or more containers. You may use container IDs or names as input. The *attach* and *interactive* +Start one or more containers using 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 -was created. If you attempt to start a running container with the *--attach* option, podman will simply -attach to the container. +was created. Starting an already running container with the *--attach* option, Podman simply +attaches to the container. ## OPTIONS @@ -53,10 +53,7 @@ Valid filters are listed below: @@option interactive -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option sig-proxy diff --git a/docs/source/markdown/podman-stats.1.md.in b/docs/source/markdown/podman-stats.1.md.in index a14bd81e64..2be6b376a9 100644 --- a/docs/source/markdown/podman-stats.1.md.in +++ b/docs/source/markdown/podman-stats.1.md.in @@ -62,16 +62,13 @@ Valid placeholders for the Go template are listed below: [1] Cgroups V1 only -When using a GO template, you may precede the format with `table` to print headers. +When using a Go template, precede the format with `table` to print headers. #### **--interval**, **-i**=*seconds* Time in seconds between stats reports, defaults to 5 seconds. -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option no-reset diff --git a/docs/source/markdown/podman-stop.1.md.in b/docs/source/markdown/podman-stop.1.md.in index ec5fd79b69..c87cf7f5a1 100644 --- a/docs/source/markdown/podman-stop.1.md.in +++ b/docs/source/markdown/podman-stop.1.md.in @@ -9,8 +9,8 @@ podman\-stop - Stop one or more running containers **podman container stop** [*options*] *container* ... ## DESCRIPTION -Stops one or more containers. You may use container IDs or names as input. The **--time** switch -allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command +Stops one or more containers using container IDs or names as input. The **--time** option +specifies the number of seconds to wait before forcibly stopping the container after the stop command is issued to the container. The default is 10 seconds. By default, containers are stopped with SIGTERM and then SIGKILL after the timeout. The SIGTERM default can be overridden by the image used to create the container and also via command line when creating the container. @@ -49,10 +49,7 @@ Valid filters are listed below: @@option ignore -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest @@option time diff --git a/docs/source/markdown/podman-system-prune.1.md b/docs/source/markdown/podman-system-prune.1.md index 775b397fe2..0b9482605e 100644 --- a/docs/source/markdown/podman-system-prune.1.md +++ b/docs/source/markdown/podman-system-prune.1.md @@ -9,7 +9,7 @@ podman\-system\-prune - Remove all unused pods, containers, images, networks, an ## DESCRIPTION **podman system prune** removes all unused containers (both dangling and unreferenced), pods, networks, and optionally, volumes from local storage. -With the **--all** option, you can delete all unused images. Unused images are dangling images as well as any image that does not have any containers based on it. +Use the **--all** option to delete all unused images. Unused images are dangling images as well as any image that does not have any containers based on it. By default, volumes are not removed to prevent important data from being deleted if there is currently no container using the volume. Use the **--volumes** flag when running the command to prune volumes as well. @@ -22,8 +22,7 @@ Recursively remove all unused pods, containers, images, networks, and volume dat Removes all leftover container storage files from local storage that are not managed by podman. In normal circumstances no such data should exist, but in case of an unclean shutdown the podman database may be corrupted and cause his. -However, when using transient storage mode, the podman database does not persist. This means containers can will leave the writable layers on disk after a reboot. If you use transient store -it it recommended that you run **podman system prune --external** once some time after each boot. +However, when using transient storage mode, the Podman database does not persist. This means containers will leave the writable layers on disk after a reboot. When using a transient store, it is recommended that the **podman system prune --external** command is run during boot. This option is incompatible with **--all** and **--filter** and drops the default behaviour of removing unused resources. diff --git a/docs/source/markdown/podman-system.1.md b/docs/source/markdown/podman-system.1.md index e7ef5da307..44a1f4acbd 100644 --- a/docs/source/markdown/podman-system.1.md +++ b/docs/source/markdown/podman-system.1.md @@ -7,7 +7,7 @@ podman\-system - Manage podman **podman system** *subcommand* ## DESCRIPTION -The system command allows you to manage the podman systems +The system command allows management of the podman systems ## COMMANDS diff --git a/docs/source/markdown/podman-systemd.unit.5.md b/docs/source/markdown/podman-systemd.unit.5.md index 366a9989d3..a326bfeb50 100644 --- a/docs/source/markdown/podman-systemd.unit.5.md +++ b/docs/source/markdown/podman-systemd.unit.5.md @@ -158,7 +158,7 @@ exact mapping of uids from host to container. You must specify these. In `auto` mode mode, the subuids and subgids allocated to the `containers` user is used to allocate host uids/gids to use for the container. By default this will try to estimate a count of the ids -to remap, but you can set RemapUidSize to use an explicit size. You can also Use `RemapUid` and +to remap, but RemapUidSize can be specified to use an explicit size. Use `RemapUid` and `RemapGid` key to force a particular host uid to be mapped to the container. In `keep-id` mode, the running user is mapped to the same id in the container. This is supported diff --git a/docs/source/markdown/podman-top.1.md b/docs/source/markdown/podman-top.1.md.in similarity index 80% rename from docs/source/markdown/podman-top.1.md rename to docs/source/markdown/podman-top.1.md.in index ceefe84e95..191cf53b1c 100644 --- a/docs/source/markdown/podman-top.1.md +++ b/docs/source/markdown/podman-top.1.md.in @@ -9,7 +9,7 @@ podman\-top - Display the running processes of a container **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. Please use the "h*" descriptors if you want to extract host-related information. For instance, `podman top $name hpid huser` to display the PID and user of the processes in the host context. +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 options and or flags of ps(1) can also be specified; in this case, Podman will fallback to executing ps with the specified arguments and flags in the container. Please use the "h*" descriptors to extract host-related information. For instance, `podman top $name hpid huser` to display the PID and user of the processes in the host context. ## OPTIONS @@ -17,10 +17,7 @@ Display the running processes of the container. The *format-descriptors* are ps Print usage statement -#### **--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.(This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest ## FORMAT DESCRIPTORS diff --git a/docs/source/markdown/podman-unmount.1.md b/docs/source/markdown/podman-unmount.1.md.in similarity index 83% rename from docs/source/markdown/podman-unmount.1.md rename to docs/source/markdown/podman-unmount.1.md.in index 5493f3c1e6..75eb45120f 100644 --- a/docs/source/markdown/podman-unmount.1.md +++ b/docs/source/markdown/podman-unmount.1.md.in @@ -39,11 +39,7 @@ processes have mounted it. Note: This could cause other processes that are using the file system to fail, as the mount point could be removed without their knowledge. -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest ## EXAMPLE diff --git a/docs/source/markdown/podman-unpause.1.md.in b/docs/source/markdown/podman-unpause.1.md.in index 85852708a5..3ff40f7b18 100644 --- a/docs/source/markdown/podman-unpause.1.md.in +++ b/docs/source/markdown/podman-unpause.1.md.in @@ -9,7 +9,7 @@ podman\-unpause - Unpause one or more containers **podman container unpause** [*options*]|[*container* ...] ## DESCRIPTION -Unpauses the processes in one or more containers. You may use container IDs or names as input. +Unpauses the processes in one or more containers. Container IDs or names can be used as input. ## OPTIONS @@ -43,10 +43,7 @@ Valid filters are listed below: | pod | [Pod] name or full or partial ID of pod | | network | [Network] name or full ID of network | -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +@@option latest ## EXAMPLE diff --git a/docs/source/markdown/podman-unshare.1.md b/docs/source/markdown/podman-unshare.1.md index a88e514d3a..4cd9f999e8 100644 --- a/docs/source/markdown/podman-unshare.1.md +++ b/docs/source/markdown/podman-unshare.1.md @@ -16,7 +16,7 @@ help of the *newuidmap(1)* and *newgidmap(1)* helpers. **podman unshare** is useful for troubleshooting unprivileged operations and for manually clearing storage and other data related to images and containers. -It is also useful if you want to use the **podman mount** command. If an unprivileged user wants to mount and work with a container, then they need to execute +It is also useful to use the **podman mount** command. If an unprivileged user wants to mount and work with a container, then they need to execute **podman unshare**. Executing **podman mount** fails for unprivileged users unless the user is running inside a **podman unshare** session. The unshare session defines two environment variables: diff --git a/docs/source/markdown/podman-volume-mount.1.md b/docs/source/markdown/podman-volume-mount.1.md index 2066ec19f5..9890341ac6 100644 --- a/docs/source/markdown/podman-volume-mount.1.md +++ b/docs/source/markdown/podman-volume-mount.1.md @@ -10,7 +10,7 @@ podman\-volume\-mount - Mount a volume filesystem Mounts the specified volumes' file system in a location which can be accessed from the host, and returns its location. -Rootless mode only supports mounting file volumes, unless you enter the user namespace +Rootless mode only supports mounting file volumes unless Podman is run within the user namespace via the `podman unshare` command. All other volume types will fail to mount. ## RETURN VALUE diff --git a/docs/source/markdown/podman-wait.1.md b/docs/source/markdown/podman-wait.1.md.in similarity index 78% rename from docs/source/markdown/podman-wait.1.md rename to docs/source/markdown/podman-wait.1.md.in index a6aadf28c9..ec942401ac 100644 --- a/docs/source/markdown/podman-wait.1.md +++ b/docs/source/markdown/podman-wait.1.md.in @@ -26,11 +26,7 @@ Condition to wait on (default "stopped") #### **--interval**, **-i**=*duration* Time interval to wait before polling for completion. A duration string is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Time unit defaults to "ms". -#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) - +@@option latest ## EXAMPLES diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 52d05943c5..d93f441596 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -64,7 +64,7 @@ If `--hooks-dir` is unset for root callers, Podman and libpod will currently def Podman and libpod currently support an additional `precreate` state which is called before the runtime's `create` operation. Unlike the other stages, which receive the container state on their standard input, `precreate` hooks receive the proposed runtime configuration on their standard input. They may alter that configuration as they see fit, and write the altered form to their standard output. -**WARNING**: the `precreate` hook lets you do powerful things, such as adding additional mounts to the runtime configuration. That power also makes it easy to break things. Before reporting libpod errors, try running your container with `precreate` hooks disabled to see if the problem is due to one of your hooks. +**WARNING**: the `precreate` hook allows powerful changes to occur, such as adding additional mounts to the runtime configuration. That power also makes it easy to break things. Before reporting libpod errors, try running a container with `precreate` hooks disabled to see if the problem is due to one of the hooks. #### **--identity**=*path* @@ -148,7 +148,7 @@ specify additional options via the `--storage-opt` flag. #### **--storage-opt**=*value* -Storage driver option, Default storage driver options are configured in `containers-storage.conf(5)`. The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options overrides all. If you specify --storage-opt="", no storage options will be used. +Specify a storage driver option. Default storage driver options are configured in `containers-storage.conf(5)`. The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options override all. Specify --storage-opt="" so no storage options will be used. #### **--syslog** @@ -415,8 +415,7 @@ Containers created by a non-root user are not visible to other users and are not It is required to have multiple uids/gids set for a user. Be sure the user is present in the files `/etc/subuid` and `/etc/subgid`. -If you have a recent version of usermod, you can execute the following -commands to add the ranges to the files +Execute the following commands to add the ranges to the files $ sudo usermod --add-subuids 10000-75535 USERNAME $ sudo usermod --add-subgids 10000-75535 USERNAME diff --git a/hack/markdown-preprocess b/hack/markdown-preprocess index 5da1750d2d..1d97508be7 100755 --- a/hack/markdown-preprocess +++ b/hack/markdown-preprocess @@ -75,7 +75,7 @@ class Preprocessor(): fh_out.write("####> This option file is used in:\n") used_by = ', '.join(x for x in self.used_by[optionfile]) fh_out.write(f"####> podman {used_by}\n") - fh_out.write("####> If you edit this file, make sure your changes\n") + fh_out.write("####> If file is edited, make sure the changes\n") fh_out.write("####> are applicable to all of those.\n") for line in fh_in: if not line.startswith('####>'):