From c9c2f644dac42243189473c41baa7995202043df Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Thu, 20 Oct 2022 09:42:18 -0600 Subject: [PATCH] markdown-preprocess: cross-reference where opts are used In each options/foo.md, keep a list of where the option is used. This will be valuable to anyone making future edits, and to those reviewing those edits. This may be a controversial commit, because those crossref lists are autogenerated as a side effect of the script that reads them. It definitely violates POLA. And one day, some kind person will reconcile (e.g.) --label, using it in more man pages, and maybe forget to git-commit the rewritten file, and CI will fail. I think this is a tough tradeoff, but worth doing. Without this, it's much too easy for someone to change an option file in a way that renders it inapplicable/misleading for some podman commands. Signed-off-by: Ed Santiago --- Makefile | 2 +- docs/source/markdown/options/add-host.md | 4 ++ .../markdown/options/annotation.container.md | 4 ++ .../markdown/options/annotation.manifest.md | 4 ++ docs/source/markdown/options/arch.md | 4 ++ docs/source/markdown/options/attach.md | 4 ++ docs/source/markdown/options/authfile.md | 4 ++ .../markdown/options/blkio-weight-device.md | 4 ++ docs/source/markdown/options/blkio-weight.md | 4 ++ docs/source/markdown/options/cap-add.md | 4 ++ docs/source/markdown/options/cap-drop.md | 4 ++ docs/source/markdown/options/cert-dir.md | 4 ++ docs/source/markdown/options/cgroup-conf.md | 4 ++ docs/source/markdown/options/cgroup-parent.md | 4 ++ docs/source/markdown/options/cgroupns.md | 4 ++ docs/source/markdown/options/cgroups.md | 4 ++ docs/source/markdown/options/chrootdirs.md | 4 ++ docs/source/markdown/options/cidfile.read.md | 4 ++ docs/source/markdown/options/cidfile.write.md | 4 ++ docs/source/markdown/options/color.md | 4 ++ .../markdown/options/compression-format.md | 4 ++ .../source/markdown/options/conmon-pidfile.md | 4 ++ docs/source/markdown/options/cpu-period.md | 4 ++ docs/source/markdown/options/cpu-quota.md | 4 ++ docs/source/markdown/options/cpu-rt-period.md | 4 ++ .../source/markdown/options/cpu-rt-runtime.md | 4 ++ docs/source/markdown/options/cpu-shares.md | 4 ++ .../source/markdown/options/cpus.container.md | 4 ++ docs/source/markdown/options/cpuset-cpus.md | 4 ++ docs/source/markdown/options/cpuset-mems.md | 4 ++ docs/source/markdown/options/creds.md | 4 ++ docs/source/markdown/options/destroy.md | 4 ++ docs/source/markdown/options/detach-keys.md | 4 ++ .../markdown/options/device-cgroup-rule.md | 4 ++ .../markdown/options/device-read-bps.md | 4 ++ .../markdown/options/device-read-iops.md | 4 ++ .../markdown/options/device-write-bps.md | 4 ++ .../markdown/options/device-write-iops.md | 4 ++ docs/source/markdown/options/device.md | 4 ++ docs/source/markdown/options/digestfile.md | 4 ++ .../markdown/options/disable-content-trust.md | 4 ++ .../markdown/options/dns-option.container.md | 4 ++ .../markdown/options/dns-search.container.md | 4 ++ docs/source/markdown/options/dns.md | 4 ++ docs/source/markdown/options/entrypoint.md | 4 ++ docs/source/markdown/options/env-file.md | 4 ++ docs/source/markdown/options/env-host.md | 4 ++ docs/source/markdown/options/env-merge.md | 4 ++ docs/source/markdown/options/env.md | 4 ++ docs/source/markdown/options/expose.md | 4 ++ docs/source/markdown/options/features.md | 4 ++ docs/source/markdown/options/follow.md | 4 ++ .../markdown/options/gidmap.container.md | 4 ++ docs/source/markdown/options/gidmap.pod.md | 4 ++ docs/source/markdown/options/group-add.md | 4 ++ docs/source/markdown/options/health-cmd.md | 4 ++ .../markdown/options/health-interval.md | 4 ++ .../markdown/options/health-on-failure.md | 4 ++ .../source/markdown/options/health-retries.md | 4 ++ .../markdown/options/health-start-period.md | 4 ++ .../source/markdown/options/health-timeout.md | 4 ++ .../markdown/options/hostname.container.md | 4 ++ docs/source/markdown/options/hostname.pod.md | 4 ++ docs/source/markdown/options/hostuser.md | 4 ++ docs/source/markdown/options/http-proxy.md | 4 ++ docs/source/markdown/options/ignore.md | 4 ++ docs/source/markdown/options/image-volume.md | 4 ++ docs/source/markdown/options/infra-command.md | 4 ++ .../markdown/options/infra-conmon-pidfile.md | 4 ++ docs/source/markdown/options/infra-name.md | 4 ++ docs/source/markdown/options/init-path.md | 4 ++ docs/source/markdown/options/init.md | 4 ++ docs/source/markdown/options/interactive.md | 4 ++ docs/source/markdown/options/ip.md | 4 ++ docs/source/markdown/options/ip6.md | 4 ++ docs/source/markdown/options/ipc.md | 4 ++ docs/source/markdown/options/label-file.md | 4 ++ docs/source/markdown/options/label.md | 4 ++ docs/source/markdown/options/link-local-ip.md | 4 ++ docs/source/markdown/options/log-driver.md | 4 ++ docs/source/markdown/options/log-opt.md | 4 ++ docs/source/markdown/options/mac-address.md | 4 ++ .../markdown/options/memory-reservation.md | 4 ++ docs/source/markdown/options/memory-swap.md | 4 ++ .../markdown/options/memory-swappiness.md | 4 ++ docs/source/markdown/options/memory.md | 4 ++ docs/source/markdown/options/mount.md | 4 ++ .../source/markdown/options/name.container.md | 4 ++ docs/source/markdown/options/names.md | 4 ++ docs/source/markdown/options/network-alias.md | 4 ++ docs/source/markdown/options/network.md | 4 ++ .../source/markdown/options/no-healthcheck.md | 4 ++ docs/source/markdown/options/no-hosts.md | 4 ++ docs/source/markdown/options/no-reset.md | 4 ++ docs/source/markdown/options/no-stream.md | 4 ++ .../markdown/options/oom-kill-disable.md | 4 ++ docs/source/markdown/options/oom-score-adj.md | 4 ++ docs/source/markdown/options/os-version.md | 4 ++ docs/source/markdown/options/os.pull.md | 4 ++ docs/source/markdown/options/passwd-entry.md | 4 ++ docs/source/markdown/options/personality.md | 4 ++ docs/source/markdown/options/pid.container.md | 4 ++ docs/source/markdown/options/pid.pod.md | 4 ++ docs/source/markdown/options/pidfile.md | 4 ++ docs/source/markdown/options/pids-limit.md | 4 ++ docs/source/markdown/options/platform.md | 4 ++ .../markdown/options/pod-id-file.container.md | 4 ++ .../markdown/options/pod-id-file.pod.md | 4 ++ docs/source/markdown/options/pod.run.md | 4 ++ docs/source/markdown/options/preserve-fds.md | 4 ++ docs/source/markdown/options/privileged.md | 4 ++ docs/source/markdown/options/publish-all.md | 4 ++ docs/source/markdown/options/publish.md | 4 ++ docs/source/markdown/options/pull.md | 4 ++ .../markdown/options/read-only-tmpfs.md | 4 ++ docs/source/markdown/options/read-only.md | 4 ++ docs/source/markdown/options/replace.md | 4 ++ docs/source/markdown/options/requires.md | 4 ++ docs/source/markdown/options/restart.md | 4 ++ docs/source/markdown/options/rootfs.md | 4 ++ docs/source/markdown/options/sdnotify.md | 4 ++ .../source/markdown/options/seccomp-policy.md | 4 ++ docs/source/markdown/options/secret.md | 4 ++ docs/source/markdown/options/shm-size.md | 4 ++ docs/source/markdown/options/sig-proxy.md | 4 ++ .../markdown/options/sign-passphrase-file.md | 4 ++ docs/source/markdown/options/signal.md | 4 ++ docs/source/markdown/options/since.md | 4 ++ docs/source/markdown/options/stop-signal.md | 4 ++ docs/source/markdown/options/stop-timeout.md | 4 ++ docs/source/markdown/options/subgidname.md | 4 ++ docs/source/markdown/options/subuidname.md | 4 ++ docs/source/markdown/options/sysctl.md | 4 ++ docs/source/markdown/options/systemd.md | 4 ++ docs/source/markdown/options/tail.md | 4 ++ docs/source/markdown/options/time.md | 4 ++ docs/source/markdown/options/timeout.md | 4 ++ docs/source/markdown/options/timestamps.md | 4 ++ docs/source/markdown/options/tls-verify.md | 4 ++ docs/source/markdown/options/tmpfs.md | 4 ++ docs/source/markdown/options/tty.md | 4 ++ docs/source/markdown/options/tz.md | 4 ++ .../markdown/options/uidmap.container.md | 4 ++ docs/source/markdown/options/uidmap.pod.md | 4 ++ docs/source/markdown/options/ulimit.md | 4 ++ docs/source/markdown/options/umask.md | 4 ++ docs/source/markdown/options/unsetenv-all.md | 4 ++ docs/source/markdown/options/unsetenv.md | 4 ++ docs/source/markdown/options/until.md | 4 ++ docs/source/markdown/options/user.md | 4 ++ .../markdown/options/userns.container.md | 4 ++ docs/source/markdown/options/userns.pod.md | 4 ++ docs/source/markdown/options/uts.container.md | 4 ++ docs/source/markdown/options/uts.pod.md | 4 ++ .../markdown/options/variant.container.md | 4 ++ .../markdown/options/variant.manifest.md | 4 ++ docs/source/markdown/options/volume.md | 4 ++ docs/source/markdown/options/volumes-from.md | 4 ++ docs/source/markdown/options/workdir.md | 4 ++ hack/markdown-preprocess | 48 ++++++++++++++++--- 160 files changed, 675 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index 0dc385c475..672401d3c2 100644 --- a/Makefile +++ b/Makefile @@ -438,7 +438,7 @@ pkg/api/swagger.yaml: make -C pkg/api $(MANPAGES_MD_GENERATED): %.md: %.md.in $(MANPAGES_SOURCE_DIR)/options/*.md - hack/markdown-preprocess $< + hack/markdown-preprocess $(MANPAGES): %: %.md .install.md2man docdir diff --git a/docs/source/markdown/options/add-host.md b/docs/source/markdown/options/add-host.md index a6021cd3be..dc1ea7bab7 100644 --- a/docs/source/markdown/options/add-host.md +++ b/docs/source/markdown/options/add-host.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, create, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--add-host**=*host:ip* Add a custom host-to-IP mapping (host:ip) diff --git a/docs/source/markdown/options/annotation.container.md b/docs/source/markdown/options/annotation.container.md index 0d155e5e4b..6049d9826f 100644 --- a/docs/source/markdown/options/annotation.container.md +++ b/docs/source/markdown/options/annotation.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, kube play, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--annotation**=*key=value* Add an annotation to the container<<| or pod>>. This option can be set multiple times. diff --git a/docs/source/markdown/options/annotation.manifest.md b/docs/source/markdown/options/annotation.manifest.md index 715c33eeba..e884e761e2 100644 --- a/docs/source/markdown/options/annotation.manifest.md +++ b/docs/source/markdown/options/annotation.manifest.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman manifest add, manifest annotate +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--annotation**=*annotation=value* Set an annotation on the entry for the image. diff --git a/docs/source/markdown/options/arch.md b/docs/source/markdown/options/arch.md index 76fb349a05..4d357ac7d7 100644 --- a/docs/source/markdown/options/arch.md +++ b/docs/source/markdown/options/arch.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pull, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. Unless overridden, subsequent lookups of the same image in the local storage will match this architecture, regardless of the host. diff --git a/docs/source/markdown/options/attach.md b/docs/source/markdown/options/attach.md index 028a956ac2..bd7259df64 100644 --- a/docs/source/markdown/options/attach.md +++ b/docs/source/markdown/options/attach.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--attach**, **-a**=*stdin* | *stdout* | *stderr* Attach to STDIN, STDOUT or STDERR. diff --git a/docs/source/markdown/options/authfile.md b/docs/source/markdown/options/authfile.md index d6198aa249..9832acd6a6 100644 --- a/docs/source/markdown/options/authfile.md +++ b/docs/source/markdown/options/authfile.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--authfile**=*path* Path of the authentication file. Default is `${XDG_RUNTIME_DIR}/containers/auth.json`, which is set using **[podman login](podman-login.1.md)**. diff --git a/docs/source/markdown/options/blkio-weight-device.md b/docs/source/markdown/options/blkio-weight-device.md index 55c5fd4fd9..12eb3762e2 100644 --- a/docs/source/markdown/options/blkio-weight-device.md +++ b/docs/source/markdown/options/blkio-weight-device.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--blkio-weight-device**=*device:weight* Block IO relative device weight. diff --git a/docs/source/markdown/options/blkio-weight.md b/docs/source/markdown/options/blkio-weight.md index 04a1071c09..226ce734c8 100644 --- a/docs/source/markdown/options/blkio-weight.md +++ b/docs/source/markdown/options/blkio-weight.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--blkio-weight**=*weight* Block IO relative weight. The _weight_ is a value between **10** and **1000**. diff --git a/docs/source/markdown/options/cap-add.md b/docs/source/markdown/options/cap-add.md index 4476afebb2..1945e44d84 100644 --- a/docs/source/markdown/options/cap-add.md +++ b/docs/source/markdown/options/cap-add.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cap-add**=*capability* Add Linux capabilities. diff --git a/docs/source/markdown/options/cap-drop.md b/docs/source/markdown/options/cap-drop.md index 8d7371ea20..bb8eb962b2 100644 --- a/docs/source/markdown/options/cap-drop.md +++ b/docs/source/markdown/options/cap-drop.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cap-drop**=*capability* Drop Linux capabilities. diff --git a/docs/source/markdown/options/cert-dir.md b/docs/source/markdown/options/cert-dir.md index 4d05075cf9..7abf09c26c 100644 --- a/docs/source/markdown/options/cert-dir.md +++ b/docs/source/markdown/options/cert-dir.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. (Default: /etc/containers/certs.d) diff --git a/docs/source/markdown/options/cgroup-conf.md b/docs/source/markdown/options/cgroup-conf.md index 91d724ab6c..62fbdfa158 100644 --- a/docs/source/markdown/options/cgroup-conf.md +++ b/docs/source/markdown/options/cgroup-conf.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cgroup-conf**=*KEY=VALUE* When running on cgroup v2, specify the cgroup file to write to and its value. For example **--cgroup-conf=memory.high=1073741824** sets the memory.high limit to 1GB. diff --git a/docs/source/markdown/options/cgroup-parent.md b/docs/source/markdown/options/cgroup-parent.md index f376e48606..fac5e79739 100644 --- a/docs/source/markdown/options/cgroup-parent.md +++ b/docs/source/markdown/options/cgroup-parent.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cgroup-parent**=*path* Path to cgroups under which the cgroup for the <> will be created. If the diff --git a/docs/source/markdown/options/cgroupns.md b/docs/source/markdown/options/cgroupns.md index 6117b3fe1a..4b13af4e15 100644 --- a/docs/source/markdown/options/cgroupns.md +++ b/docs/source/markdown/options/cgroupns.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cgroupns**=*mode* Set the cgroup namespace mode for the container. diff --git a/docs/source/markdown/options/cgroups.md b/docs/source/markdown/options/cgroups.md index 0dbbb15f37..1138c579a0 100644 --- a/docs/source/markdown/options/cgroups.md +++ b/docs/source/markdown/options/cgroups.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cgroups**=*how* Determines whether the container will create CGroups. diff --git a/docs/source/markdown/options/chrootdirs.md b/docs/source/markdown/options/chrootdirs.md index 624a106243..f79f066b3f 100644 --- a/docs/source/markdown/options/chrootdirs.md +++ b/docs/source/markdown/options/chrootdirs.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--chrootdirs**=*path* Path to a directory inside the container that should be treated as a `chroot` directory. diff --git a/docs/source/markdown/options/cidfile.read.md b/docs/source/markdown/options/cidfile.read.md index 414700fca3..85439b4108 100644 --- a/docs/source/markdown/options/cidfile.read.md +++ b/docs/source/markdown/options/cidfile.read.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman kill, pause, rm, stop, unpause +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cidfile**=*file* Read container ID from the specified *file* and <> the container. diff --git a/docs/source/markdown/options/cidfile.write.md b/docs/source/markdown/options/cidfile.write.md index b5e7435b27..376dc50661 100644 --- a/docs/source/markdown/options/cidfile.write.md +++ b/docs/source/markdown/options/cidfile.write.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cidfile**=*file* Write the container ID to *file*. diff --git a/docs/source/markdown/options/color.md b/docs/source/markdown/options/color.md index 343c79c881..a211a60b60 100644 --- a/docs/source/markdown/options/color.md +++ b/docs/source/markdown/options/color.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman logs, pod logs +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--color** Output the containers with different colors in the log. diff --git a/docs/source/markdown/options/compression-format.md b/docs/source/markdown/options/compression-format.md index 14c8c04997..72818953e4 100644 --- a/docs/source/markdown/options/compression-format.md +++ b/docs/source/markdown/options/compression-format.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman manifest push, push +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--compression-format**=**gzip** | *zstd* | *zstd:chunked* Specifies the compression format to use. Supported values are: `gzip`, `zstd` and `zstd:chunked`. The default is `gzip` unless overridden in the containers.conf file. diff --git a/docs/source/markdown/options/conmon-pidfile.md b/docs/source/markdown/options/conmon-pidfile.md index e0e337cc83..5732209598 100644 --- a/docs/source/markdown/options/conmon-pidfile.md +++ b/docs/source/markdown/options/conmon-pidfile.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--conmon-pidfile**=*file* Write the pid of the **conmon** process to a file. As **conmon** runs in a separate process than Podman, this is necessary when using systemd to restart Podman containers. diff --git a/docs/source/markdown/options/cpu-period.md b/docs/source/markdown/options/cpu-period.md index 5c5eb56e73..dc35fb747c 100644 --- a/docs/source/markdown/options/cpu-period.md +++ b/docs/source/markdown/options/cpu-period.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, container clone, create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cpu-period**=*limit* Set the CPU period for the Completely Fair Scheduler (CFS), which is a diff --git a/docs/source/markdown/options/cpu-quota.md b/docs/source/markdown/options/cpu-quota.md index 81d5db3d25..d756f6b5f7 100644 --- a/docs/source/markdown/options/cpu-quota.md +++ b/docs/source/markdown/options/cpu-quota.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, container clone, create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cpu-quota**=*limit* Limit the CPU Completely Fair Scheduler (CFS) quota. diff --git a/docs/source/markdown/options/cpu-rt-period.md b/docs/source/markdown/options/cpu-rt-period.md index 36e88632e3..8a180d8975 100644 --- a/docs/source/markdown/options/cpu-rt-period.md +++ b/docs/source/markdown/options/cpu-rt-period.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman container clone, create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cpu-rt-period**=*microseconds* Limit the CPU real-time period in microseconds. diff --git a/docs/source/markdown/options/cpu-rt-runtime.md b/docs/source/markdown/options/cpu-rt-runtime.md index 64f0ec38b2..4cb35d5307 100644 --- a/docs/source/markdown/options/cpu-rt-runtime.md +++ b/docs/source/markdown/options/cpu-rt-runtime.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman container clone, create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cpu-rt-runtime**=*microseconds* Limit the CPU real-time runtime in microseconds. diff --git a/docs/source/markdown/options/cpu-shares.md b/docs/source/markdown/options/cpu-shares.md index c0e2c30351..6e3acc5b2e 100644 --- a/docs/source/markdown/options/cpu-shares.md +++ b/docs/source/markdown/options/cpu-shares.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--cpu-shares**, **-c**=*shares* CPU shares (relative weight). diff --git a/docs/source/markdown/options/cpus.container.md b/docs/source/markdown/options/cpus.container.md index 63f243e112..7d112394b0 100644 --- a/docs/source/markdown/options/cpus.container.md +++ b/docs/source/markdown/options/cpus.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--cpus**=*number* Number of CPUs. The default is *0.0* which means no limit. This is shorthand diff --git a/docs/source/markdown/options/cpuset-cpus.md b/docs/source/markdown/options/cpuset-cpus.md index 8a2a82e9f6..b34d466bae 100644 --- a/docs/source/markdown/options/cpuset-cpus.md +++ b/docs/source/markdown/options/cpuset-cpus.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--cpuset-cpus**=*number* CPUs in which to allow execution. Can be specified as a comma-separated list diff --git a/docs/source/markdown/options/cpuset-mems.md b/docs/source/markdown/options/cpuset-mems.md index b86d0ef6b7..15e7fee01e 100644 --- a/docs/source/markdown/options/cpuset-mems.md +++ b/docs/source/markdown/options/cpuset-mems.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--cpuset-mems**=*nodes* Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on diff --git a/docs/source/markdown/options/creds.md b/docs/source/markdown/options/creds.md index 5ea7a13718..58ce1de641 100644 --- a/docs/source/markdown/options/creds.md +++ b/docs/source/markdown/options/creds.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--creds**=*[username[:password]]* The [username[:password]] to use to authenticate with the registry, if required. diff --git a/docs/source/markdown/options/destroy.md b/docs/source/markdown/options/destroy.md index 885c962018..0889baba53 100644 --- a/docs/source/markdown/options/destroy.md +++ b/docs/source/markdown/options/destroy.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman container clone, pod clone +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--destroy** Remove the original <> that we are cloning once used to mimic the configuration. diff --git a/docs/source/markdown/options/detach-keys.md b/docs/source/markdown/options/detach-keys.md index e4dfb2c536..dfa726d076 100644 --- a/docs/source/markdown/options/detach-keys.md +++ b/docs/source/markdown/options/detach-keys.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman attach, exec, run, start +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--detach-keys**=*sequence* Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-` characters where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*. diff --git a/docs/source/markdown/options/device-cgroup-rule.md b/docs/source/markdown/options/device-cgroup-rule.md index 0ba3d46680..2dfd414ed2 100644 --- a/docs/source/markdown/options/device-cgroup-rule.md +++ b/docs/source/markdown/options/device-cgroup-rule.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--device-cgroup-rule**=*"type major:minor mode"* Add a rule to the cgroup allowed devices list. The rule is expected to be in the format specified in the Linux kernel documentation (Documentation/cgroup-v1/devices.txt): diff --git a/docs/source/markdown/options/device-read-bps.md b/docs/source/markdown/options/device-read-bps.md index f6617ab773..65a85d13bd 100644 --- a/docs/source/markdown/options/device-read-bps.md +++ b/docs/source/markdown/options/device-read-bps.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--device-read-bps**=*path:rate* Limit read rate (in bytes per second) from a device (e.g. **--device-read-bps=/dev/sda:1mb**). diff --git a/docs/source/markdown/options/device-read-iops.md b/docs/source/markdown/options/device-read-iops.md index 944c664419..6b819014e7 100644 --- a/docs/source/markdown/options/device-read-iops.md +++ b/docs/source/markdown/options/device-read-iops.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--device-read-iops**=*path:rate* Limit read rate (in IO operations per second) from a device (e.g. **--device-read-iops=/dev/sda:1000**). diff --git a/docs/source/markdown/options/device-write-bps.md b/docs/source/markdown/options/device-write-bps.md index ebcda01818..bbc948034b 100644 --- a/docs/source/markdown/options/device-write-bps.md +++ b/docs/source/markdown/options/device-write-bps.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--device-write-bps**=*path:rate* Limit write rate (in bytes per second) to a device (e.g. **--device-write-bps=/dev/sda:1mb**). diff --git a/docs/source/markdown/options/device-write-iops.md b/docs/source/markdown/options/device-write-iops.md index 6de273d187..16cd23a0c6 100644 --- a/docs/source/markdown/options/device-write-iops.md +++ b/docs/source/markdown/options/device-write-iops.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--device-write-iops**=*path:rate* Limit write rate (in IO operations per second) to a device (e.g. **--device-write-iops=/dev/sda:1000**). diff --git a/docs/source/markdown/options/device.md b/docs/source/markdown/options/device.md index bd6d7f9d93..5403194591 100644 --- a/docs/source/markdown/options/device.md +++ b/docs/source/markdown/options/device.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--device**=*host-device[:container-device][:permissions]* Add a host device to the <>. Optional *permissions* parameter diff --git a/docs/source/markdown/options/digestfile.md b/docs/source/markdown/options/digestfile.md index de013e2872..22c42b23b6 100644 --- a/docs/source/markdown/options/digestfile.md +++ b/docs/source/markdown/options/digestfile.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman manifest push, push +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--digestfile**=*Digestfile* After copying the image, write the digest of the resulting image to the file. diff --git a/docs/source/markdown/options/disable-content-trust.md b/docs/source/markdown/options/disable-content-trust.md index a2d1d8ad7c..a69b870d1a 100644 --- a/docs/source/markdown/options/disable-content-trust.md +++ b/docs/source/markdown/options/disable-content-trust.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, create, pull, push, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--disable-content-trust** This is a Docker-specific option to disable image verification to a container diff --git a/docs/source/markdown/options/dns-option.container.md b/docs/source/markdown/options/dns-option.container.md index cfbded5e68..1c8bc03aa3 100644 --- a/docs/source/markdown/options/dns-option.container.md +++ b/docs/source/markdown/options/dns-option.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--dns-option**=*option* Set custom DNS options. Invalid if using **--dns-option** with **--network** that is set to **none** or **container:**_id_. diff --git a/docs/source/markdown/options/dns-search.container.md b/docs/source/markdown/options/dns-search.container.md index 5a803ba39c..e27e60eba8 100644 --- a/docs/source/markdown/options/dns-search.container.md +++ b/docs/source/markdown/options/dns-search.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your 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_. diff --git a/docs/source/markdown/options/dns.md b/docs/source/markdown/options/dns.md index 39380ace20..585c8c085a 100644 --- a/docs/source/markdown/options/dns.md +++ b/docs/source/markdown/options/dns.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--dns**=*ipaddr* Set custom DNS servers. diff --git a/docs/source/markdown/options/entrypoint.md b/docs/source/markdown/options/entrypoint.md index 0da5e42afe..d3cc6cbb41 100644 --- a/docs/source/markdown/options/entrypoint.md +++ b/docs/source/markdown/options/entrypoint.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--entrypoint**=*"command"* | *'["command", "arg1", ...]'* Overwrite the default ENTRYPOINT of the image. diff --git a/docs/source/markdown/options/env-file.md b/docs/source/markdown/options/env-file.md index f08dc09f09..d2165419c8 100644 --- a/docs/source/markdown/options/env-file.md +++ b/docs/source/markdown/options/env-file.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, exec, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--env-file**=*file* Read in a line-delimited file of environment variables. diff --git a/docs/source/markdown/options/env-host.md b/docs/source/markdown/options/env-host.md index 665fca016a..1ca125c319 100644 --- a/docs/source/markdown/options/env-host.md +++ b/docs/source/markdown/options/env-host.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--env-host** Use host environment inside of the container. See **Environment** note below for precedence. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) diff --git a/docs/source/markdown/options/env-merge.md b/docs/source/markdown/options/env-merge.md index aa1aa003d5..8b18f09fa8 100644 --- a/docs/source/markdown/options/env-merge.md +++ b/docs/source/markdown/options/env-merge.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--env-merge**=*env* Preprocess default environment variables for the containers. For example diff --git a/docs/source/markdown/options/env.md b/docs/source/markdown/options/env.md index ace25138e7..41e648525a 100644 --- a/docs/source/markdown/options/env.md +++ b/docs/source/markdown/options/env.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, exec, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--env**, **-e**=*env* Set environment variables. diff --git a/docs/source/markdown/options/expose.md b/docs/source/markdown/options/expose.md index 04b5aad664..22c653cf06 100644 --- a/docs/source/markdown/options/expose.md +++ b/docs/source/markdown/options/expose.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--expose**=*port* Expose a port, or a range of ports (e.g. **--expose=3300-3310**) to set up port redirection diff --git a/docs/source/markdown/options/features.md b/docs/source/markdown/options/features.md index b6ac4de34c..47f2f74797 100644 --- a/docs/source/markdown/options/features.md +++ b/docs/source/markdown/options/features.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman manifest add, manifest annotate +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--features** Specify the features list which the list or index records as requirements for diff --git a/docs/source/markdown/options/follow.md b/docs/source/markdown/options/follow.md index 75b65cf49f..2886531110 100644 --- a/docs/source/markdown/options/follow.md +++ b/docs/source/markdown/options/follow.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman logs, pod logs +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--follow**, **-f** Follow log output. Default is false. diff --git a/docs/source/markdown/options/gidmap.container.md b/docs/source/markdown/options/gidmap.container.md index a3c9df33df..226f10e7a2 100644 --- a/docs/source/markdown/options/gidmap.container.md +++ b/docs/source/markdown/options/gidmap.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--gidmap**=*container_gid:host_gid:amount* Run the container in a new user namespace using the supplied GID mapping. This diff --git a/docs/source/markdown/options/gidmap.pod.md b/docs/source/markdown/options/gidmap.pod.md index 0d58cc527a..8d5e8bbe8e 100644 --- a/docs/source/markdown/options/gidmap.pod.md +++ b/docs/source/markdown/options/gidmap.pod.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--gidmap**=*pod_gid:host_gid:amount* GID map for the user namespace. Using this flag will run all containers in the pod with user namespace enabled. diff --git a/docs/source/markdown/options/group-add.md b/docs/source/markdown/options/group-add.md index ac9ade3a78..a33c87920c 100644 --- a/docs/source/markdown/options/group-add.md +++ b/docs/source/markdown/options/group-add.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--group-add**=*group* | *keep-groups* Assign additional groups to the primary user running within the container process. diff --git a/docs/source/markdown/options/health-cmd.md b/docs/source/markdown/options/health-cmd.md index df04743936..d3d9f0b925 100644 --- a/docs/source/markdown/options/health-cmd.md +++ b/docs/source/markdown/options/health-cmd.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your 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 diff --git a/docs/source/markdown/options/health-interval.md b/docs/source/markdown/options/health-interval.md index 581e35f656..690be2cc02 100644 --- a/docs/source/markdown/options/health-interval.md +++ b/docs/source/markdown/options/health-interval.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--health-interval**=*interval* Set an interval for the healthchecks. An _interval_ of **disable** results in no automatic timer setup. The default is **30s**. diff --git a/docs/source/markdown/options/health-on-failure.md b/docs/source/markdown/options/health-on-failure.md index c25a1c574f..d5c93e50f5 100644 --- a/docs/source/markdown/options/health-on-failure.md +++ b/docs/source/markdown/options/health-on-failure.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--health-on-failure**=*action* Action to take once the container transitions to an unhealthy state. The default is **none**. diff --git a/docs/source/markdown/options/health-retries.md b/docs/source/markdown/options/health-retries.md index e96dd30335..6cecaae49b 100644 --- a/docs/source/markdown/options/health-retries.md +++ b/docs/source/markdown/options/health-retries.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--health-retries**=*retries* The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is **3**. diff --git a/docs/source/markdown/options/health-start-period.md b/docs/source/markdown/options/health-start-period.md index e88e270c65..9568166a42 100644 --- a/docs/source/markdown/options/health-start-period.md +++ b/docs/source/markdown/options/health-start-period.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--health-start-period**=*period* The initialization time needed for a container to bootstrap. The value can be expressed in time format like diff --git a/docs/source/markdown/options/health-timeout.md b/docs/source/markdown/options/health-timeout.md index 5102ea81be..02459f9156 100644 --- a/docs/source/markdown/options/health-timeout.md +++ b/docs/source/markdown/options/health-timeout.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--health-timeout**=*timeout* The maximum time allowed to complete the healthcheck before an interval is considered failed. Like start-period, the diff --git a/docs/source/markdown/options/hostname.container.md b/docs/source/markdown/options/hostname.container.md index 6c525ac5b0..df7860665d 100644 --- a/docs/source/markdown/options/hostname.container.md +++ b/docs/source/markdown/options/hostname.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--hostname**, **-h**=*name* Container host name diff --git a/docs/source/markdown/options/hostname.pod.md b/docs/source/markdown/options/hostname.pod.md index 418e1e8a7c..9a35bfbe80 100644 --- a/docs/source/markdown/options/hostname.pod.md +++ b/docs/source/markdown/options/hostname.pod.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--hostname**=*name* Set a hostname to the pod. diff --git a/docs/source/markdown/options/hostuser.md b/docs/source/markdown/options/hostuser.md index d1d12c88fb..647003b7a6 100644 --- a/docs/source/markdown/options/hostuser.md +++ b/docs/source/markdown/options/hostuser.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--hostuser**=*name* Add a user account to /etc/passwd from the host to the container. The Username diff --git a/docs/source/markdown/options/http-proxy.md b/docs/source/markdown/options/http-proxy.md index f83dcde4ae..51c12a414b 100644 --- a/docs/source/markdown/options/http-proxy.md +++ b/docs/source/markdown/options/http-proxy.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--http-proxy** By default proxy environment variables are passed into the container if set diff --git a/docs/source/markdown/options/ignore.md b/docs/source/markdown/options/ignore.md index 231d75957f..979584d4c2 100644 --- a/docs/source/markdown/options/ignore.md +++ b/docs/source/markdown/options/ignore.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod rm, pod stop, rm, stop +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--ignore**, **-i** Ignore errors when specified <> are not in the container store. A user diff --git a/docs/source/markdown/options/image-volume.md b/docs/source/markdown/options/image-volume.md index 2a549ef3c4..174f74f886 100644 --- a/docs/source/markdown/options/image-volume.md +++ b/docs/source/markdown/options/image-volume.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--image-volume**=**bind** | *tmpfs* | *ignore* Tells Podman how to handle the builtin image volumes. Default is **bind**. diff --git a/docs/source/markdown/options/infra-command.md b/docs/source/markdown/options/infra-command.md index 24edcddfe6..aca30a9bec 100644 --- a/docs/source/markdown/options/infra-command.md +++ b/docs/source/markdown/options/infra-command.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--infra-command**=*command* The command that will be run to start the infra container. Default: "/pause". diff --git a/docs/source/markdown/options/infra-conmon-pidfile.md b/docs/source/markdown/options/infra-conmon-pidfile.md index f1c5186825..2e75cdd9e3 100644 --- a/docs/source/markdown/options/infra-conmon-pidfile.md +++ b/docs/source/markdown/options/infra-conmon-pidfile.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--infra-conmon-pidfile**=*file* Write the pid of the infra container's **conmon** process to a file. As **conmon** runs in a separate process than Podman, this is necessary when using systemd to manage Podman containers and pods. diff --git a/docs/source/markdown/options/infra-name.md b/docs/source/markdown/options/infra-name.md index d8cd3989dd..3fb98e0ee4 100644 --- a/docs/source/markdown/options/infra-name.md +++ b/docs/source/markdown/options/infra-name.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--infra-name**=*name* The name that will be used for the pod's infra container. diff --git a/docs/source/markdown/options/init-path.md b/docs/source/markdown/options/init-path.md index c2be278749..d9e1f1e61f 100644 --- a/docs/source/markdown/options/init-path.md +++ b/docs/source/markdown/options/init-path.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--init-path**=*path* Path to the container-init binary. diff --git a/docs/source/markdown/options/init.md b/docs/source/markdown/options/init.md index caf300efe7..b9755c8960 100644 --- a/docs/source/markdown/options/init.md +++ b/docs/source/markdown/options/init.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--init** Run an init inside the container that forwards signals and reaps processes. diff --git a/docs/source/markdown/options/interactive.md b/docs/source/markdown/options/interactive.md index a280883682..8e44123194 100644 --- a/docs/source/markdown/options/interactive.md +++ b/docs/source/markdown/options/interactive.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, exec, run, start +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--interactive**, **-i** When set to **true**, keep stdin open even if not attached. The default is **false**. diff --git a/docs/source/markdown/options/ip.md b/docs/source/markdown/options/ip.md index 8f251ee2e7..8566cafe1e 100644 --- a/docs/source/markdown/options/ip.md +++ b/docs/source/markdown/options/ip.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--ip**=*ipv4* Specify a static IPv4 address for the <>, for example **10.88.64.128**. diff --git a/docs/source/markdown/options/ip6.md b/docs/source/markdown/options/ip6.md index feaae7c448..84c6f0145d 100644 --- a/docs/source/markdown/options/ip6.md +++ b/docs/source/markdown/options/ip6.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--ip6**=*ipv6* Specify a static IPv6 address for the <>, for example **fd46:db93:aa76:ac37::10**. diff --git a/docs/source/markdown/options/ipc.md b/docs/source/markdown/options/ipc.md index 699b64eec9..47df3affdb 100644 --- a/docs/source/markdown/options/ipc.md +++ b/docs/source/markdown/options/ipc.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--ipc**=*ipc* Set the IPC namespace mode for a container. The default is to create diff --git a/docs/source/markdown/options/label-file.md b/docs/source/markdown/options/label-file.md index fe4bc91765..27b24fbf42 100644 --- a/docs/source/markdown/options/label-file.md +++ b/docs/source/markdown/options/label-file.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--label-file**=*file* Read in a line-delimited file of labels. diff --git a/docs/source/markdown/options/label.md b/docs/source/markdown/options/label.md index 629aa82e67..0022c31fbc 100644 --- a/docs/source/markdown/options/label.md +++ b/docs/source/markdown/options/label.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--label**, **-l**=*key=value* Add metadata to a <>. diff --git a/docs/source/markdown/options/link-local-ip.md b/docs/source/markdown/options/link-local-ip.md index 5bedff01e3..5ac1a54ad3 100644 --- a/docs/source/markdown/options/link-local-ip.md +++ b/docs/source/markdown/options/link-local-ip.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--link-local-ip**=*ip* Not implemented. diff --git a/docs/source/markdown/options/log-driver.md b/docs/source/markdown/options/log-driver.md index 195e1f284b..730249bd42 100644 --- a/docs/source/markdown/options/log-driver.md +++ b/docs/source/markdown/options/log-driver.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--log-driver**=*driver* Logging driver for the container. Currently available options are **k8s-file**, **journald**, **none** and **passthrough**, with **json-file** aliased to **k8s-file** for scripting compatibility. (Default **journald**). diff --git a/docs/source/markdown/options/log-opt.md b/docs/source/markdown/options/log-opt.md index 4eafc1fb05..d1701c54f1 100644 --- a/docs/source/markdown/options/log-opt.md +++ b/docs/source/markdown/options/log-opt.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, kube play, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--log-opt**=*name=value* Logging driver specific options. diff --git a/docs/source/markdown/options/mac-address.md b/docs/source/markdown/options/mac-address.md index 0939ceaad9..2575889eb2 100644 --- a/docs/source/markdown/options/mac-address.md +++ b/docs/source/markdown/options/mac-address.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--mac-address**=*address* <> network interface MAC address (e.g. 92:d0:c6:0a:29:33) diff --git a/docs/source/markdown/options/memory-reservation.md b/docs/source/markdown/options/memory-reservation.md index 410f1dd7cc..bdbc330548 100644 --- a/docs/source/markdown/options/memory-reservation.md +++ b/docs/source/markdown/options/memory-reservation.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman container clone, create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--memory-reservation**=*number[unit]* Memory soft limit. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebibytes), or **g** (gibibytes). diff --git a/docs/source/markdown/options/memory-swap.md b/docs/source/markdown/options/memory-swap.md index 08ee8b1a02..89c4d30d5b 100644 --- a/docs/source/markdown/options/memory-swap.md +++ b/docs/source/markdown/options/memory-swap.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--memory-swap**=*number[unit]* A limit value equal to memory plus swap. diff --git a/docs/source/markdown/options/memory-swappiness.md b/docs/source/markdown/options/memory-swappiness.md index 1e6a511881..a34fbc1084 100644 --- a/docs/source/markdown/options/memory-swappiness.md +++ b/docs/source/markdown/options/memory-swappiness.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman container clone, create, run, update +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--memory-swappiness**=*number* Tune a container's memory swappiness behavior. Accepts an integer between *0* and *100*. diff --git a/docs/source/markdown/options/memory.md b/docs/source/markdown/options/memory.md index 1be9159c3c..8cf93dca46 100644 --- a/docs/source/markdown/options/memory.md +++ b/docs/source/markdown/options/memory.md @@ -1,3 +1,7 @@ +####> 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 +####> are applicable to all of those. #### **--memory**, **-m**=*number[unit]* Memory limit. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebibytes), or **g** (gibibytes). diff --git a/docs/source/markdown/options/mount.md b/docs/source/markdown/options/mount.md index e81af539de..99490b91d7 100644 --- a/docs/source/markdown/options/mount.md +++ b/docs/source/markdown/options/mount.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]* Attach a filesystem mount to the container diff --git a/docs/source/markdown/options/name.container.md b/docs/source/markdown/options/name.container.md index 0c3df6ef14..6835907ef1 100644 --- a/docs/source/markdown/options/name.container.md +++ b/docs/source/markdown/options/name.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--name**=*name* Assign a name to the container. diff --git a/docs/source/markdown/options/names.md b/docs/source/markdown/options/names.md index 54fda40ee1..b056ba11d9 100644 --- a/docs/source/markdown/options/names.md +++ b/docs/source/markdown/options/names.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman logs, pod logs +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--names**, **-n** Output the container names instead of the container IDs in the log. diff --git a/docs/source/markdown/options/network-alias.md b/docs/source/markdown/options/network-alias.md index f48a1bb954..fa775483d1 100644 --- a/docs/source/markdown/options/network-alias.md +++ b/docs/source/markdown/options/network-alias.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--network-alias**=*alias* Add a network-scoped alias for the <>, setting the alias for all networks that the container joins. To set a diff --git a/docs/source/markdown/options/network.md b/docs/source/markdown/options/network.md index e2a2dc36aa..32f650d260 100644 --- a/docs/source/markdown/options/network.md +++ b/docs/source/markdown/options/network.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, kube play, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--network**=*mode*, **--net** Set the network mode for the <>. diff --git a/docs/source/markdown/options/no-healthcheck.md b/docs/source/markdown/options/no-healthcheck.md index a722ac5b5f..2dae29915f 100644 --- a/docs/source/markdown/options/no-healthcheck.md +++ b/docs/source/markdown/options/no-healthcheck.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--no-healthcheck** Disable any defined healthchecks for container. diff --git a/docs/source/markdown/options/no-hosts.md b/docs/source/markdown/options/no-hosts.md index 5b1e95b86a..47b21f8b60 100644 --- a/docs/source/markdown/options/no-hosts.md +++ b/docs/source/markdown/options/no-hosts.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, create, kube play, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--no-hosts** Do not create _/etc/hosts_ for the <>. diff --git a/docs/source/markdown/options/no-reset.md b/docs/source/markdown/options/no-reset.md index ce5b950572..165e2eb5d5 100644 --- a/docs/source/markdown/options/no-reset.md +++ b/docs/source/markdown/options/no-reset.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod stats, stats +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--no-reset** Do not clear the terminal/screen in between reporting intervals diff --git a/docs/source/markdown/options/no-stream.md b/docs/source/markdown/options/no-stream.md index a9d548ba05..531dce1b00 100644 --- a/docs/source/markdown/options/no-stream.md +++ b/docs/source/markdown/options/no-stream.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod stats, stats +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--no-stream** Disable streaming <<|pod >>stats and only pull the first result, default setting is false diff --git a/docs/source/markdown/options/oom-kill-disable.md b/docs/source/markdown/options/oom-kill-disable.md index 24ed9a8892..b8bb26eafb 100644 --- a/docs/source/markdown/options/oom-kill-disable.md +++ b/docs/source/markdown/options/oom-kill-disable.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--oom-kill-disable** Whether to disable OOM Killer for the container or not. diff --git a/docs/source/markdown/options/oom-score-adj.md b/docs/source/markdown/options/oom-score-adj.md index 123e8e243a..14612c59c5 100644 --- a/docs/source/markdown/options/oom-score-adj.md +++ b/docs/source/markdown/options/oom-score-adj.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--oom-score-adj**=*num* Tune the host's OOM preferences for containers (accepts values from **-1000** to **1000**). diff --git a/docs/source/markdown/options/os-version.md b/docs/source/markdown/options/os-version.md index d812e6f65e..8394e23fc8 100644 --- a/docs/source/markdown/options/os-version.md +++ b/docs/source/markdown/options/os-version.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman manifest add, manifest annotate +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--os-version** Specify the OS version which the list or index records as a requirement for the diff --git a/docs/source/markdown/options/os.pull.md b/docs/source/markdown/options/os.pull.md index 547a9fff8e..b2be86753d 100644 --- a/docs/source/markdown/options/os.pull.md +++ b/docs/source/markdown/options/os.pull.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pull, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. diff --git a/docs/source/markdown/options/passwd-entry.md b/docs/source/markdown/options/passwd-entry.md index 33c179d121..00d316be89 100644 --- a/docs/source/markdown/options/passwd-entry.md +++ b/docs/source/markdown/options/passwd-entry.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--passwd-entry**=*ENTRY* Customize the entry that is written to the `/etc/passwd` file within the container when `--passwd` is used. diff --git a/docs/source/markdown/options/personality.md b/docs/source/markdown/options/personality.md index 663f14782e..728d580e51 100644 --- a/docs/source/markdown/options/personality.md +++ b/docs/source/markdown/options/personality.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--personality**=*persona* Personality sets the execution domain via Linux personality(2). diff --git a/docs/source/markdown/options/pid.container.md b/docs/source/markdown/options/pid.container.md index d0cbef1d5f..58e805d1ca 100644 --- a/docs/source/markdown/options/pid.container.md +++ b/docs/source/markdown/options/pid.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--pid**=*mode* Set the PID namespace mode for the container. diff --git a/docs/source/markdown/options/pid.pod.md b/docs/source/markdown/options/pid.pod.md index 4086736b65..620cbfa4b0 100644 --- a/docs/source/markdown/options/pid.pod.md +++ b/docs/source/markdown/options/pid.pod.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--pid**=*pid* Set the PID mode for the pod. The default is to create a private PID namespace for the pod. Requires the PID namespace to be shared via --share. diff --git a/docs/source/markdown/options/pidfile.md b/docs/source/markdown/options/pidfile.md index a494b522e4..44f8e953e9 100644 --- a/docs/source/markdown/options/pidfile.md +++ b/docs/source/markdown/options/pidfile.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--pidfile**=*path* When the pidfile location is specified, the container process' PID will be written to the pidfile. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) diff --git a/docs/source/markdown/options/pids-limit.md b/docs/source/markdown/options/pids-limit.md index efcaef2e20..14cb89cb3a 100644 --- a/docs/source/markdown/options/pids-limit.md +++ b/docs/source/markdown/options/pids-limit.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--pids-limit**=*limit* Tune the container's pids limit. Set to **-1** to have unlimited pids for the container. The default is **4096** on systems that support "pids" cgroup controller. diff --git a/docs/source/markdown/options/platform.md b/docs/source/markdown/options/platform.md index b66efdfb2b..85552a1e4c 100644 --- a/docs/source/markdown/options/platform.md +++ b/docs/source/markdown/options/platform.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pull, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--platform**=*OS/ARCH* Specify the platform for selecting the image. (Conflicts with --arch and --os) diff --git a/docs/source/markdown/options/pod-id-file.container.md b/docs/source/markdown/options/pod-id-file.container.md index 1c102dc6b9..4f2aa2ddda 100644 --- a/docs/source/markdown/options/pod-id-file.container.md +++ b/docs/source/markdown/options/pod-id-file.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--pod-id-file**=*file* Run container in an existing pod and read the pod's ID from the specified *file*. diff --git a/docs/source/markdown/options/pod-id-file.pod.md b/docs/source/markdown/options/pod-id-file.pod.md index 69e2ac6e90..8514d9bbd8 100644 --- a/docs/source/markdown/options/pod-id-file.pod.md +++ b/docs/source/markdown/options/pod-id-file.pod.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod rm, pod start, pod stop +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--pod-id-file**=*file* Read pod ID from the specified *file* and <> the pod. Can be specified multiple times. diff --git a/docs/source/markdown/options/pod.run.md b/docs/source/markdown/options/pod.run.md index 6ba3c718b0..5f1f949455 100644 --- a/docs/source/markdown/options/pod.run.md +++ b/docs/source/markdown/options/pod.run.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your 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:**. diff --git a/docs/source/markdown/options/preserve-fds.md b/docs/source/markdown/options/preserve-fds.md index 61e33bdf4e..046833711b 100644 --- a/docs/source/markdown/options/preserve-fds.md +++ b/docs/source/markdown/options/preserve-fds.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman exec, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--preserve-fds**=*N* Pass down to the process N additional file descriptors (in addition to 0, 1, 2). diff --git a/docs/source/markdown/options/privileged.md b/docs/source/markdown/options/privileged.md index 8d9746d6b1..6d50684190 100644 --- a/docs/source/markdown/options/privileged.md +++ b/docs/source/markdown/options/privileged.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, exec, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--privileged** Give extended privileges to this container. The default is **false**. diff --git a/docs/source/markdown/options/publish-all.md b/docs/source/markdown/options/publish-all.md index 9c19712331..195bc8473b 100644 --- a/docs/source/markdown/options/publish-all.md +++ b/docs/source/markdown/options/publish-all.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--publish-all**, **-P** Publish all exposed ports to random ports on the host interfaces. The default is **false**. diff --git a/docs/source/markdown/options/publish.md b/docs/source/markdown/options/publish.md index a0394b6924..45acb4fea1 100644 --- a/docs/source/markdown/options/publish.md +++ b/docs/source/markdown/options/publish.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--publish**, **-p**=*[[ip:][hostPort]:]containerPort[/protocol]* Publish a container's port, or range of ports,<<| within this pod>> to the host. diff --git a/docs/source/markdown/options/pull.md b/docs/source/markdown/options/pull.md index ae0911507c..a67dac65e1 100644 --- a/docs/source/markdown/options/pull.md +++ b/docs/source/markdown/options/pull.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--pull**=*policy* Pull image policy. The default is **missing**. diff --git a/docs/source/markdown/options/read-only-tmpfs.md b/docs/source/markdown/options/read-only-tmpfs.md index 7e14f7fefc..cae57e888b 100644 --- a/docs/source/markdown/options/read-only-tmpfs.md +++ b/docs/source/markdown/options/read-only-tmpfs.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--read-only-tmpfs** If container is running in **--read-only** mode, then mount a read-write tmpfs on _/run_, _/tmp_, and _/var/tmp_. The default is **true**. diff --git a/docs/source/markdown/options/read-only.md b/docs/source/markdown/options/read-only.md index ae5244a228..9de13a8a14 100644 --- a/docs/source/markdown/options/read-only.md +++ b/docs/source/markdown/options/read-only.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--read-only** Mount the container's root filesystem as read-only. diff --git a/docs/source/markdown/options/replace.md b/docs/source/markdown/options/replace.md index 6cd849fb4b..353685bf29 100644 --- a/docs/source/markdown/options/replace.md +++ b/docs/source/markdown/options/replace.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--replace** If another <> with the same name already exists, replace and remove it. The default is **false**. diff --git a/docs/source/markdown/options/requires.md b/docs/source/markdown/options/requires.md index fa2e9a8f32..4c784d7dd3 100644 --- a/docs/source/markdown/options/requires.md +++ b/docs/source/markdown/options/requires.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--requires**=*container* Specify one or more requirements. diff --git a/docs/source/markdown/options/restart.md b/docs/source/markdown/options/restart.md index 825ae613fd..60c536f57b 100644 --- a/docs/source/markdown/options/restart.md +++ b/docs/source/markdown/options/restart.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--restart**=*policy* Restart policy to follow when containers exit. diff --git a/docs/source/markdown/options/rootfs.md b/docs/source/markdown/options/rootfs.md index a03c4eef1c..07cbd485ff 100644 --- a/docs/source/markdown/options/rootfs.md +++ b/docs/source/markdown/options/rootfs.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--rootfs** If specified, the first argument refers to an exploded container on the file system. diff --git a/docs/source/markdown/options/sdnotify.md b/docs/source/markdown/options/sdnotify.md index d090cbf7c7..c5c6de4e06 100644 --- a/docs/source/markdown/options/sdnotify.md +++ b/docs/source/markdown/options/sdnotify.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--sdnotify**=**container** | *conmon* | *ignore* Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. diff --git a/docs/source/markdown/options/seccomp-policy.md b/docs/source/markdown/options/seccomp-policy.md index 3b2eb75530..08c6af67a2 100644 --- a/docs/source/markdown/options/seccomp-policy.md +++ b/docs/source/markdown/options/seccomp-policy.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--seccomp-policy**=*policy* Specify the policy to select the seccomp profile. If set to *image*, Podman will look for a "io.containers.seccomp.profile" label in the container-image config and use its value as a seccomp profile. Otherwise, Podman will follow the *default* policy by applying the default profile unless specified otherwise via *--security-opt seccomp* as described below. diff --git a/docs/source/markdown/options/secret.md b/docs/source/markdown/options/secret.md index ff2c0ab83d..68e1825f2d 100644 --- a/docs/source/markdown/options/secret.md +++ b/docs/source/markdown/options/secret.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--secret**=*secret[,opt=opt ...]* Give the container access to a secret. Can be specified multiple times. diff --git a/docs/source/markdown/options/shm-size.md b/docs/source/markdown/options/shm-size.md index 45b3bb03a0..79d1506fe3 100644 --- a/docs/source/markdown/options/shm-size.md +++ b/docs/source/markdown/options/shm-size.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--shm-size**=*number[unit]* Size of _/dev/shm_. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebibytes), or **g** (gibibytes). diff --git a/docs/source/markdown/options/sig-proxy.md b/docs/source/markdown/options/sig-proxy.md index bb940aed3f..66c5b85fca 100644 --- a/docs/source/markdown/options/sig-proxy.md +++ b/docs/source/markdown/options/sig-proxy.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman attach, run, start +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--sig-proxy** Proxy received signals to the container process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. diff --git a/docs/source/markdown/options/sign-passphrase-file.md b/docs/source/markdown/options/sign-passphrase-file.md index 46e724db18..c8aa2d965c 100644 --- a/docs/source/markdown/options/sign-passphrase-file.md +++ b/docs/source/markdown/options/sign-passphrase-file.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman manifest push, push +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--sign-passphrase-file**=*path* If signing the image (using either **--sign-by** or **--sign-by-sigstore-private-key**), read the passphrase to use from the specified path. diff --git a/docs/source/markdown/options/signal.md b/docs/source/markdown/options/signal.md index 6e6c036573..5b713e62cb 100644 --- a/docs/source/markdown/options/signal.md +++ b/docs/source/markdown/options/signal.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman kill, pod kill +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--signal**, **-s**=**signal** Signal to send to the container<<|s in the pod>>. For more information on Linux signals, refer to *signal(7)*. diff --git a/docs/source/markdown/options/since.md b/docs/source/markdown/options/since.md index 9f20722df2..71eb14f2af 100644 --- a/docs/source/markdown/options/since.md +++ b/docs/source/markdown/options/since.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman logs, pod logs +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--since**=*TIMESTAMP* Show logs since TIMESTAMP. The --since option can be Unix timestamps, date formatted timestamps, or Go duration diff --git a/docs/source/markdown/options/stop-signal.md b/docs/source/markdown/options/stop-signal.md index e70d715b83..33442a5ba1 100644 --- a/docs/source/markdown/options/stop-signal.md +++ b/docs/source/markdown/options/stop-signal.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--stop-signal**=*signal* Signal to stop a container. Default is **SIGTERM**. diff --git a/docs/source/markdown/options/stop-timeout.md b/docs/source/markdown/options/stop-timeout.md index 2845e70ae8..4a6fb0b065 100644 --- a/docs/source/markdown/options/stop-timeout.md +++ b/docs/source/markdown/options/stop-timeout.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--stop-timeout**=*seconds* Timeout to stop a container. Default is **10**. diff --git a/docs/source/markdown/options/subgidname.md b/docs/source/markdown/options/subgidname.md index 1ca0496d07..9c0b814846 100644 --- a/docs/source/markdown/options/subgidname.md +++ b/docs/source/markdown/options/subgidname.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--subgidname**=*name* Run the container in a new user namespace using the map with _name_ in the _/etc/subgid_ file. diff --git a/docs/source/markdown/options/subuidname.md b/docs/source/markdown/options/subuidname.md index bd7b615755..c92810be73 100644 --- a/docs/source/markdown/options/subuidname.md +++ b/docs/source/markdown/options/subuidname.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--subuidname**=*name* Run the container in a new user namespace using the map with _name_ in the _/etc/subuid_ file. diff --git a/docs/source/markdown/options/sysctl.md b/docs/source/markdown/options/sysctl.md index 6fc1bbebef..3b6ad104ce 100644 --- a/docs/source/markdown/options/sysctl.md +++ b/docs/source/markdown/options/sysctl.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--sysctl**=*name=value* Configure namespaced kernel parameters <>. diff --git a/docs/source/markdown/options/systemd.md b/docs/source/markdown/options/systemd.md index a341edbc24..07ceb4fcdb 100644 --- a/docs/source/markdown/options/systemd.md +++ b/docs/source/markdown/options/systemd.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--systemd**=*true* | *false* | *always* Run container in systemd mode. The default is **true**. diff --git a/docs/source/markdown/options/tail.md b/docs/source/markdown/options/tail.md index 463b6fc3f9..5607dbbab0 100644 --- a/docs/source/markdown/options/tail.md +++ b/docs/source/markdown/options/tail.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman logs, pod logs +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--tail**=*LINES* Output the specified number of LINES at the end of the logs. LINES must be an integer. Defaults to -1, diff --git a/docs/source/markdown/options/time.md b/docs/source/markdown/options/time.md index 85d571d189..e4da5236bb 100644 --- a/docs/source/markdown/options/time.md +++ b/docs/source/markdown/options/time.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod rm, pod stop, restart, rm, stop +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--time**, **-t**=*seconds* Seconds to wait before forcibly stopping <>. diff --git a/docs/source/markdown/options/timeout.md b/docs/source/markdown/options/timeout.md index 731feb973f..6b1ca1b98e 100644 --- a/docs/source/markdown/options/timeout.md +++ b/docs/source/markdown/options/timeout.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--timeout**=*seconds* Maximum time a container is allowed to run before conmon sends it the kill diff --git a/docs/source/markdown/options/timestamps.md b/docs/source/markdown/options/timestamps.md index a449216aa4..a228bdb6e4 100644 --- a/docs/source/markdown/options/timestamps.md +++ b/docs/source/markdown/options/timestamps.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman logs, pod logs +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--timestamps**, **-t** Show timestamps in the log outputs. The default is false diff --git a/docs/source/markdown/options/tls-verify.md b/docs/source/markdown/options/tls-verify.md index b6fbaef07c..597beb6755 100644 --- a/docs/source/markdown/options/tls-verify.md +++ b/docs/source/markdown/options/tls-verify.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman build, container runlabel, create, kube play, login, manifest add, manifest create, manifest push, pull, push, run, search +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: **true**). diff --git a/docs/source/markdown/options/tmpfs.md b/docs/source/markdown/options/tmpfs.md index 0d6652dcdb..5e9fa6bc7c 100644 --- a/docs/source/markdown/options/tmpfs.md +++ b/docs/source/markdown/options/tmpfs.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--tmpfs**=*fs* Create a tmpfs mount. diff --git a/docs/source/markdown/options/tty.md b/docs/source/markdown/options/tty.md index 04bd8af2ce..e5579b4342 100644 --- a/docs/source/markdown/options/tty.md +++ b/docs/source/markdown/options/tty.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, exec, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--tty**, **-t** Allocate a pseudo-TTY. The default is **false**. diff --git a/docs/source/markdown/options/tz.md b/docs/source/markdown/options/tz.md index 0442e8a763..258da5414a 100644 --- a/docs/source/markdown/options/tz.md +++ b/docs/source/markdown/options/tz.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--tz**=*timezone* Set timezone in container. This flag takes area-based timezones, GMT time, as well as `local`, which sets the timezone in the container to match the host machine. See `/usr/share/zoneinfo/` for valid timezones. diff --git a/docs/source/markdown/options/uidmap.container.md b/docs/source/markdown/options/uidmap.container.md index 9e21494dd7..19409bb351 100644 --- a/docs/source/markdown/options/uidmap.container.md +++ b/docs/source/markdown/options/uidmap.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--uidmap**=*container_uid:from_uid:amount* Run the container in a new user namespace using the supplied UID mapping. This diff --git a/docs/source/markdown/options/uidmap.pod.md b/docs/source/markdown/options/uidmap.pod.md index ad1f1658f1..5fc3dc150d 100644 --- a/docs/source/markdown/options/uidmap.pod.md +++ b/docs/source/markdown/options/uidmap.pod.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--uidmap**=*container_uid:from_uid:amount* Run all containers in the pod in a new user namespace using the supplied mapping. This diff --git a/docs/source/markdown/options/ulimit.md b/docs/source/markdown/options/ulimit.md index c23163acc1..fb8264b630 100644 --- a/docs/source/markdown/options/ulimit.md +++ b/docs/source/markdown/options/ulimit.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--ulimit**=*option* Ulimit options. You can use **host** to copy the current configuration from the host. diff --git a/docs/source/markdown/options/umask.md b/docs/source/markdown/options/umask.md index 55668b6da0..b20833f314 100644 --- a/docs/source/markdown/options/umask.md +++ b/docs/source/markdown/options/umask.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--umask**=*umask* Set the umask inside the container. Defaults to `0022`. diff --git a/docs/source/markdown/options/unsetenv-all.md b/docs/source/markdown/options/unsetenv-all.md index 3aad2e805e..98328f9fde 100644 --- a/docs/source/markdown/options/unsetenv-all.md +++ b/docs/source/markdown/options/unsetenv-all.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--unsetenv-all** Unset all default environment variables for the container. Default environment diff --git a/docs/source/markdown/options/unsetenv.md b/docs/source/markdown/options/unsetenv.md index 3f4d31d487..38ec4e5f3c 100644 --- a/docs/source/markdown/options/unsetenv.md +++ b/docs/source/markdown/options/unsetenv.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--unsetenv**=*env* Unset default environment variables for the container. Default environment diff --git a/docs/source/markdown/options/until.md b/docs/source/markdown/options/until.md index d656d976bb..b3b11d844a 100644 --- a/docs/source/markdown/options/until.md +++ b/docs/source/markdown/options/until.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman logs, pod logs +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--until**=*TIMESTAMP* Show logs until TIMESTAMP. The --until option can be Unix timestamps, date formatted timestamps, or Go duration diff --git a/docs/source/markdown/options/user.md b/docs/source/markdown/options/user.md index 6cf12d3473..68f60e1845 100644 --- a/docs/source/markdown/options/user.md +++ b/docs/source/markdown/options/user.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, exec, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--user**, **-u**=*user[:group]* Sets the username or UID used and, optionally, the groupname or GID for the specified command. Both *user* and *group* may be symbolic or numeric. diff --git a/docs/source/markdown/options/userns.container.md b/docs/source/markdown/options/userns.container.md index 8f96892dfb..2562dbbba0 100644 --- a/docs/source/markdown/options/userns.container.md +++ b/docs/source/markdown/options/userns.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, kube play, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--userns**=*mode* Set the user namespace mode for the container. It defaults to the **PODMAN_USERNS** environment variable. An empty value ("") means user namespaces are disabled unless an explicit mapping is set with the **--uidmap** and **--gidmap** options. diff --git a/docs/source/markdown/options/userns.pod.md b/docs/source/markdown/options/userns.pod.md index 389f47bd52..96352c163d 100644 --- a/docs/source/markdown/options/userns.pod.md +++ b/docs/source/markdown/options/userns.pod.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--userns**=*mode* Set the user namespace mode for all the containers in a pod. It defaults to the **PODMAN_USERNS** environment variable. An empty value ("") means user namespaces are disabled. diff --git a/docs/source/markdown/options/uts.container.md b/docs/source/markdown/options/uts.container.md index 74a5f33d1c..7d5ebdb49f 100644 --- a/docs/source/markdown/options/uts.container.md +++ b/docs/source/markdown/options/uts.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--uts**=*mode* Set the UTS namespace mode for the container. The following values are supported: diff --git a/docs/source/markdown/options/uts.pod.md b/docs/source/markdown/options/uts.pod.md index 6144e3f708..bc4c2415df 100644 --- a/docs/source/markdown/options/uts.pod.md +++ b/docs/source/markdown/options/uts.pod.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman pod clone, pod create +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--uts**=*mode* Set the UTS namespace mode for the pod. The following values are supported: diff --git a/docs/source/markdown/options/variant.container.md b/docs/source/markdown/options/variant.container.md index ed7cd29d3e..a039825852 100644 --- a/docs/source/markdown/options/variant.container.md +++ b/docs/source/markdown/options/variant.container.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pull, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--variant**=*VARIANT* Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. diff --git a/docs/source/markdown/options/variant.manifest.md b/docs/source/markdown/options/variant.manifest.md index b1d7b28aa5..8f63ac681c 100644 --- a/docs/source/markdown/options/variant.manifest.md +++ b/docs/source/markdown/options/variant.manifest.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman manifest add, manifest annotate +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--variant** Specify the variant which the list or index records for the image. This option diff --git a/docs/source/markdown/options/volume.md b/docs/source/markdown/options/volume.md index 36a8a8430f..3f463c5402 100644 --- a/docs/source/markdown/options/volume.md +++ b/docs/source/markdown/options/volume.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--volume**, **-v**=*[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]* Create a bind mount. If `-v /HOST-DIR:/CONTAINER-DIR` is specified, Podman diff --git a/docs/source/markdown/options/volumes-from.md b/docs/source/markdown/options/volumes-from.md index ebef116e7c..977ba41f1d 100644 --- a/docs/source/markdown/options/volumes-from.md +++ b/docs/source/markdown/options/volumes-from.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, pod clone, pod create, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--volumes-from**=*CONTAINER[:OPTIONS]* Mount volumes from the specified container(s). Used to share volumes between diff --git a/docs/source/markdown/options/workdir.md b/docs/source/markdown/options/workdir.md index 12f3ddd44b..4e1226cfa9 100644 --- a/docs/source/markdown/options/workdir.md +++ b/docs/source/markdown/options/workdir.md @@ -1,3 +1,7 @@ +####> This option file is used in: +####> podman create, exec, run +####> If you edit this file, make sure your changes +####> are applicable to all of those. #### **--workdir**, **-w**=*dir* Working directory inside the container. diff --git a/hack/markdown-preprocess b/hack/markdown-preprocess index d298f27dfd..5da1750d2d 100755 --- a/hack/markdown-preprocess +++ b/hack/markdown-preprocess @@ -6,6 +6,7 @@ Simpleminded include mechanism for podman man pages. """ +import filecmp import glob import os import re @@ -20,6 +21,7 @@ class Preprocessor(): def __init__(self): self.infile = '' self.pod_or_container = '' + self.used_by = {} def process(self, infile:str): """ @@ -42,6 +44,7 @@ class Preprocessor(): if line.startswith('@@option '): _, optionname = line.strip().split(" ") optionfile = os.path.join("options", optionname + '.md') + self.track_optionfile(optionfile) self.insert_file(fh_out, optionfile) # '@@include relative-path/must-exist.md' elif line.startswith('@@include '): @@ -53,6 +56,36 @@ class Preprocessor(): os.chmod(outfile_tmp, 0o444) os.rename(outfile_tmp, outfile) + def track_optionfile(self, optionfile: str): + """ + Keep track of which man pages use which option files + """ + if optionfile not in self.used_by: + self.used_by[optionfile] = [] + self.used_by[optionfile].append(self.podman_subcommand('full')) + + def rewrite_optionfiles(self): + """ + Rewrite all option files, such that they include header comments + cross-referencing all the man pages in which they're used. + """ + for optionfile in self.used_by: + tmpfile = optionfile + '.tmp' + with open(optionfile, 'r') as fh_in, open(tmpfile, 'w') as fh_out: + 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("####> are applicable to all of those.\n") + for line in fh_in: + if not line.startswith('####>'): + fh_out.write(line) + # Compare files; only rewrite if the new one differs + if not filecmp.cmp(optionfile, tmpfile): + os.rename(tmpfile, optionfile) + else: + os.unlink(tmpfile) + def insert_file(self, fh_out, path: str): """ Reads one option file, writes it out to the given output filehandle @@ -65,6 +98,8 @@ class Preprocessor(): fh_out.write("\n[//]: # (BEGIN included file " + path + ")\n") with open(path, 'r') as fh_included: for opt_line in fh_included: + if opt_line.startswith('####>'): + continue opt_line = self.replace_type(opt_line) opt_line = opt_line.replace('<>', self.podman_subcommand()) opt_line = opt_line.replace('<>', self.podman_subcommand('full')) @@ -133,15 +168,16 @@ def main(): except FileNotFoundError as ex: raise Exception("Please invoke me from the base repo dir") from ex - # If called with args, process only those files - infiles = [ os.path.basename(x) for x in sys.argv[1:] ] - if len(infiles) == 0: - # Called without args: process all *.md.in files - infiles = glob.glob('*.md.in') + # No longer possible to invoke us with args: reject any such invocation + if len(sys.argv) > 1: + raise Exception("This script accepts no arguments") preprocessor = Preprocessor() - for infile in infiles: + for infile in sorted(glob.glob('*.md.in')): preprocessor.process(infile) + # Now rewrite all option files + preprocessor.rewrite_optionfiles() + if __name__ == "__main__": main()