mirror of
https://github.com/containers/podman.git
synced 2025-05-17 23:26:08 +08:00
Remove 'you' from man pages
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This commit is contained in:
17
docs/source/markdown/.gitignore
vendored
17
docs/source/markdown/.gitignore
vendored
@ -2,10 +2,16 @@ podman-attach.1.md
|
||||
podman-auto-update.1.md
|
||||
podman-build.1.md
|
||||
podman-container-clone.1.md
|
||||
podman-container-diff.1.md
|
||||
podman-container-runlabel.1.md
|
||||
podman-container-inspect.1.md
|
||||
podman-create.1.md
|
||||
podman-diff.1.md
|
||||
podman-exec.1.md
|
||||
podman-image-sign.1.md
|
||||
podman-init.1.md
|
||||
podman-init.1.md
|
||||
podman-inspect.1.md
|
||||
podman-kill.1.md
|
||||
podman-kube-play.1.md
|
||||
podman-login.1.md
|
||||
@ -14,17 +20,23 @@ podman-logs.1.md
|
||||
podman-manifest-add.1.md
|
||||
podman-manifest-annotate.1.md
|
||||
podman-manifest-create.1.md
|
||||
podman-manifest-push.1.md
|
||||
podman-manifest-inspect.1.md
|
||||
podman-manifest-push.1.md
|
||||
podman-mount.1.md
|
||||
podman-network-reload.1.md
|
||||
podman-pause.1.md
|
||||
podman-pod-clone.1.md
|
||||
podman-pod-create.1.md
|
||||
podman-pod-inspect.1.md
|
||||
podman-pod-inspect.1.md
|
||||
podman-pod-kill.1.md
|
||||
podman-pod-logs.1.md
|
||||
podman-pod-rm.1.md
|
||||
podman-pod-start.1.md
|
||||
podman-pod-stats.1.md
|
||||
podman-pod-stop.1.md
|
||||
podman-pod-top.1.md
|
||||
podman-port.1.md
|
||||
podman-pull.1.md
|
||||
podman-push.1.md
|
||||
podman-restart.1.md
|
||||
@ -34,5 +46,8 @@ podman-search.1.md
|
||||
podman-start.1.md
|
||||
podman-stats.1.md
|
||||
podman-stop.1.md
|
||||
podman-top.1.md
|
||||
podman-unmount.1.md
|
||||
podman-unpause.1.md
|
||||
podman-update.1.md
|
||||
podman-wait.1.md
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, create, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--add-host**=*host:ip*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, kube play, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--annotation**=*key=value*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman manifest add, manifest annotate
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--annotation**=*annotation=value*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, pull, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--arch**=*ARCH*
|
||||
Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`.
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--attach**, **-a**=*stdin* | *stdout* | *stderr*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman auto update, build, container runlabel, create, image sign, kube play, login, logout, manifest add, manifest push, pull, push, run, search
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--authfile**=*path*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--blkio-weight-device**=*device:weight*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--blkio-weight**=*weight*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cap-add**=*capability*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cap-drop**=*capability*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container runlabel, image sign, kube play, login, manifest add, manifest push, pull, push
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cert-dir**=*path*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cgroup-conf**=*KEY=VALUE*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, create, pod clone, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cgroup-parent**=*path*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cgroupns**=*mode*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cgroups**=*how*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--chrootdirs**=*path*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman kill, pause, rm, stop, unpause
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cidfile**=*file*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cidfile**=*file*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman logs, pod logs
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--color**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman manifest push, push
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--compression-format**=**gzip** | *zstd* | *zstd:chunked*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--conmon-pidfile**=*file*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container clone, create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cpu-period**=*limit*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container clone, create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cpu-quota**=*limit*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cpu-rt-period**=*microseconds*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cpu-rt-runtime**=*microseconds*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cpu-shares**, **-c**=*shares*
|
||||
|
||||
|
@ -1,12 +1,12 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cpus**=*number*
|
||||
|
||||
Number of CPUs. The default is *0.0* which means no limit. This is shorthand
|
||||
for **--cpu-period** and **--cpu-quota**, so you may only set either
|
||||
**--cpus** or **--cpu-period** and **--cpu-quota**.
|
||||
for **--cpu-period** and **--cpu-quota**, therfore the option cannot be specified with
|
||||
**--cpu-period** or **--cpu-quota**.
|
||||
|
||||
On some systems, changing the CPU limits may not be allowed for non-root
|
||||
users. For more details, see
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cpuset-cpus**=*number*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--cpuset-mems**=*nodes*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container runlabel, kube play, manifest add, manifest push, pull, push
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--creds**=*[username[:password]]*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, pull, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--decryption-key**=*key[:passphrase]*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, pod clone
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--destroy**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman attach, exec, run, start
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--detach-keys**=*sequence*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--device-cgroup-rule**=*"type major:minor mode"*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--device-read-bps**=*path:rate*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--device-read-iops**=*path:rate*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--device-write-bps**=*path:rate*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--device-write-iops**=*path:rate*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, create, pod clone, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--device**=*host-device[:container-device][:permissions]*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman manifest push, push
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--digestfile**=*Digestfile*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, create, pull, push, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--disable-content-trust**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--dns-option**=*option*
|
||||
|
||||
|
@ -1,8 +1,8 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--dns-search**=*domain*
|
||||
|
||||
Set custom DNS search domains. Invalid if using **--dns-search** with **--network** that is set to **none** or **container:**_id_.
|
||||
Use **--dns-search=.** if you don't wish to set the search domain.
|
||||
Use **--dns-search=.** to remove the search domain.
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--dns**=*ipaddr*
|
||||
|
||||
|
@ -1,21 +1,18 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--entrypoint**=*"command"* | *'["command", "arg1", ...]'*
|
||||
|
||||
Overwrite the default ENTRYPOINT of the image.
|
||||
|
||||
This option allows you to overwrite the default entrypoint of the image.
|
||||
Override the default ENTRYPOINT from the image.
|
||||
|
||||
The ENTRYPOINT of an image is similar to a COMMAND
|
||||
because it specifies what executable to run when the container starts, but it is
|
||||
(purposely) more difficult to override. The ENTRYPOINT gives a container its
|
||||
default nature or behavior, so that when you set an ENTRYPOINT you can run the
|
||||
container as if it were that binary, complete with default options, and you can
|
||||
pass in more options via the COMMAND. But, sometimes an operator may want to run
|
||||
something else inside the container, so you can override the default ENTRYPOINT
|
||||
at runtime by using a **--entrypoint** and a string to specify the new
|
||||
ENTRYPOINT.
|
||||
default nature or behavior. When the ENTRYPOINT is set, the
|
||||
container runs as if it were that binary, complete with default options. More options can be
|
||||
passed in via the COMMAND. But, if a user wants to run
|
||||
something else inside the container, the **--entrypoint** option allows a new
|
||||
ENTRYPOINT to be specified.
|
||||
|
||||
You need to specify multi option commands in the form of a json string.
|
||||
Specify multi option commands in the form of a json string.
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, exec, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--env-file**=*file*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--env-host**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--env-merge**=*env*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, exec, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--env**, **-e**=*env*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--expose**=*port*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman manifest add, manifest annotate
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--features**
|
||||
|
||||
|
@ -1,11 +1,11 @@
|
||||
####> This option file is used in:
|
||||
####> podman logs, pod logs
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--follow**, **-f**
|
||||
|
||||
Follow log output. Default is false.
|
||||
|
||||
Note: If you are following a <<container|pod>> which is removed by `podman <<container|pod>> rm`
|
||||
or removed on exit (`podman run --rm ...`), then there is a chance that the log
|
||||
Note: When following a <<container|pod>> which is removed by `podman <<container|pod>> rm`
|
||||
or removed on exit (`podman run --rm ...`), there is a chance that the log
|
||||
file will be removed before `podman<< pod|>> logs` reads the final content.
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--gidmap**=*container_gid:host_gid:amount*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman pod clone, pod create
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--gidmap**=*pod_gid:host_gid:amount*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--group-add**=*group* | *keep-groups*
|
||||
|
||||
@ -11,5 +11,5 @@ Assign additional groups to the primary user running within the container proces
|
||||
Allows container to use the user's supplementary group access. If file systems or
|
||||
devices are only accessible by the rootless user's group, this flag tells the OCI
|
||||
runtime to pass the group access into the container. Currently only available
|
||||
with the `crun` OCI runtime. Note: `keep-groups` is exclusive, you cannot add any other groups
|
||||
with the `crun` OCI runtime. Note: `keep-groups` is exclusive, other groups cannot be specified
|
||||
with this flag. (Not available for remote commands, including Mac and Windows (excluding WSL2) machines)
|
||||
|
@ -1,11 +1,11 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-cmd**=*"command"* | *'["command", "arg1", ...]'*
|
||||
|
||||
Set or alter a healthcheck command for a container. The command is a command to be executed inside your
|
||||
container that determines your container health. The command is required for other healthcheck options
|
||||
Set or alter a healthcheck command for a container. The command is a command to be executed inside the
|
||||
container that determines the container health. The command is required for other healthcheck options
|
||||
to be applied. A value of **none** disables existing healthchecks.
|
||||
|
||||
Multiple options can be passed in the form of a JSON array; otherwise, the command will be interpreted
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-interval**=*interval*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-on-failure**=*action*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-retries**=*retries*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-start-period**=*period*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-startup-cmd**=*"command"* | *'["command", "arg1", ...]'*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-startup-interval**=*interval*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-startup-retries**=*retries*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-startup-success**=*retries*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-startup-timeout**=*timeout*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--health-timeout**=*timeout*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--hostname**, **-h**=*name*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman pod clone, pod create
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--hostname**=*name*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--hostuser**=*name*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--http-proxy**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman pod rm, pod stop, rm, stop
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--ignore**, **-i**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--image-volume**=**bind** | *tmpfs* | *ignore*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman pod clone, pod create
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--infra-command**=*command*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman pod clone, pod create
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--infra-conmon-pidfile**=*file*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman pod clone, pod create
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--infra-name**=*name*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--init-path**=*path*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--init**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, exec, run, start
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--interactive**, **-i**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--ip**=*ipv4*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--ip6**=*ipv6*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--ipc**=*ipc*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, pod clone, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--label-file**=*file*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, pod clone, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--label**, **-l**=*key=value*
|
||||
|
||||
|
10
docs/source/markdown/options/latest.md
Normal file
10
docs/source/markdown/options/latest.md
Normal file
@ -0,0 +1,10 @@
|
||||
####> This option file is used in:
|
||||
####> podman attach, container diff, container inspect, diff, exec, init, inspect, kill, logs, mount, network reload, pause, pod inspect, pod kill, pod logs, pod rm, pod start, pod stats, pod stop, pod top, port, restart, rm, start, stats, stop, top, unmount, unpause, wait
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--latest**, **-l**
|
||||
|
||||
Instead of providing the <<container|pod>> name or ID, use the last created <<container|pod>>.
|
||||
Note: the last started <<container|pod>> could be from other users of Podman on the host machine.
|
||||
(This option is not available with the remote Podman client, including Mac and Windows
|
||||
(excluding WSL2) machines)
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--link-local-ip**=*ip*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--log-driver**=*driver*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, kube play, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--log-opt**=*name=value*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--mac-address**=*address*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--memory-reservation**=*number[unit]*
|
||||
|
||||
@ -8,7 +8,7 @@ Memory soft limit. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebi
|
||||
|
||||
After setting memory reservation, when the system detects memory contention
|
||||
or low memory, containers are forced to restrict their consumption to their
|
||||
reservation. So you should always set the value below **--memory**, otherwise the
|
||||
reservation. So always set the value below **--memory**, otherwise the
|
||||
hard limit will take precedence. By default, memory reservation will be the same
|
||||
as memory limit.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--memory-swap**=*number[unit]*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman container clone, create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--memory-swappiness**=*number*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, container clone, create, pod clone, pod create, run, update
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--memory**, **-m**=*number[unit]*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--name**=*name*
|
||||
|
||||
@ -14,5 +14,5 @@ The operator can identify a container in three ways:
|
||||
|
||||
Podman generates a UUID for each container, and if a name is not assigned
|
||||
to the container with **--name** then it will generate a random
|
||||
string name. The name is useful any place you need to identify a container.
|
||||
string name. The name can be useful as a more human-friendly way to identify containers.
|
||||
This works for both background and foreground containers.
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman logs, pod logs
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--names**, **-n**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--network-alias**=*alias*
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, kube play, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--network**=*mode*, **--net**
|
||||
|
||||
@ -17,7 +17,7 @@ Valid _mode_ values are:
|
||||
|
||||
For example to set a static ipv4 address and a static mac address, use `--network bridge:ip=10.88.0.10,mac=44:33:22:11:00:99`.
|
||||
|
||||
- \<network name or ID\>[:OPTIONS,...]: Connect to a user-defined network; this is the network name or ID from a network created by **[podman network create](podman-network-create.1.md)**. Using the network name implies the bridge network mode. It is possible to specify the same options described under the bridge mode above. You can use the **--network** option multiple times to specify additional networks.
|
||||
- \<network name or ID\>[:OPTIONS,...]: Connect to a user-defined network; this is the network name or ID from a network created by **[podman network create](podman-network-create.1.md)**. Using the network name implies the bridge network mode. It is possible to specify the same options described under the bridge mode above. Use the **--network** option multiple times to specify additional networks.
|
||||
- **none**: Create a network namespace for the container but do not configure network interfaces for it, thus the container has no network connectivity.
|
||||
- **container:**_id_: Reuse another container's network stack.
|
||||
- **host**: Do not create a network namespace, the container will use the host's network. Note: The host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
|
||||
@ -33,7 +33,7 @@ Valid _mode_ values are:
|
||||
- **outbound_addr6=INTERFACE**: Specify the outbound interface slirp should bind to (ipv6 traffic only).
|
||||
- **outbound_addr6=IPv6**: Specify the outbound ipv6 address slirp should bind to.
|
||||
- **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default.
|
||||
Note: Rootlesskit changes the source IP address of incoming packets to an IP address in the container network namespace, usually `10.0.2.100`. If your application requires the real source IP address, e.g. web server logs, use the slirp4netns port handler. The rootlesskit port handler is also used for rootless containers when connected to user-defined networks.
|
||||
Note: Rootlesskit changes the source IP address of incoming packets to an IP address in the container network namespace, usually `10.0.2.100`. If the application requires the real source IP address, e.g. web server logs, use the slirp4netns port handler. The rootlesskit port handler is also used for rootless containers when connected to user-defined networks.
|
||||
- **port_handler=slirp4netns**: Use the slirp4netns port forwarding, it is slower than rootlesskit but preserves the correct source IP address. This port handler cannot be used for user-defined networks.
|
||||
|
||||
- **pasta[:OPTIONS,...]**: use **pasta**(1) to create a user-mode networking
|
||||
@ -75,5 +75,4 @@ Valid _mode_ values are:
|
||||
host, using the loopback interface instead of the tap interface for improved
|
||||
performance
|
||||
|
||||
NOTE: For backward compatibility reasons, if you have a network named `pasta`,
|
||||
Podman will use this instead of the pasta mode.
|
||||
NOTE: For backward compatibility reasons, if there is an existing network named `pasta`, Podman will use it instead of the pasta mode."?
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--no-healthcheck**
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
####> This option file is used in:
|
||||
####> podman build, create, kube play, pod create, run
|
||||
####> If you edit this file, make sure your changes
|
||||
####> If file is edited, make sure the changes
|
||||
####> are applicable to all of those.
|
||||
#### **--no-hosts**
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user