diff options
Diffstat (limited to 'docs/source')
96 files changed, 715 insertions, 705 deletions
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css new file mode 100644 index 000000000..6974d8514 --- /dev/null +++ b/docs/source/_static/custom.css @@ -0,0 +1,7 @@ +h2,h3,h4,h5,h6{ + /* Sphinx doesn't respect using a h4 header without using h1,h2,h3. + The flag names will be rendered as h2 and by default way to big + so make the font size for all headers except h1 smaller. + */ + font-size: 120% !important; +} diff --git a/docs/source/conf.py b/docs/source/conf.py index d95290f72..6adaf4308 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -53,5 +53,8 @@ html_theme = 'alabaster' # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_css_files = [ + 'custom.css', +] # -- Extension configuration ------------------------------------------------- diff --git a/docs/source/markdown/podman-attach.1.md b/docs/source/markdown/podman-attach.1.md index cb3ffa92e..06d3c205d 100644 --- a/docs/source/markdown/podman-attach.1.md +++ b/docs/source/markdown/podman-attach.1.md @@ -18,22 +18,22 @@ Configure the keys sequence using the **--detach-keys** option, or specifying it in the **containers.conf** file: see **containers.conf(5)** for more information. ## OPTIONS -**--detach-keys**=*sequence* +#### **--detach-keys**=*sequence* Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--no-stdin** +#### **--no-stdin** Do not attach STDIN. The default is false. -**--sig-proxy**=*true*|*false* +#### **--sig-proxy**=*true*|*false* Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*. diff --git a/docs/source/markdown/podman-auto-update.1.md b/docs/source/markdown/podman-auto-update.1.md index 3ab097388..76dc85180 100644 --- a/docs/source/markdown/podman-auto-update.1.md +++ b/docs/source/markdown/podman-auto-update.1.md @@ -28,7 +28,7 @@ Systemd units that start and stop a container cannot run a new image. ## OPTIONS -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md index 405628912..a411d32ab 100644 --- a/docs/source/markdown/podman-build.1.md +++ b/docs/source/markdown/podman-build.1.md @@ -45,14 +45,14 @@ command to see these contaienrs. External containers can be removed with the ## OPTIONS -**--add-host**=*host* +#### **--add-host**=*host* Add a custom host-to-IP mapping (host:ip) Add a line to /etc/hosts. The format is hostname:ip. The **--add-host** option can be set multiple times. -**--annotation**=*annotation* +#### **--annotation**=*annotation* Add an image *annotation* (e.g. annotation=*value*) to the image metadata. Can be used multiple times. @@ -60,12 +60,12 @@ be used multiple times. Note: this information is not present in Docker image formats, so it is discarded when writing images in Docker formats. -**--arch**=*arch* +#### **--arch**=*arch* Set the ARCH of the image to the provided value instead of the architecture of the host. -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. @@ -76,26 +76,26 @@ Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--build-arg**=*arg=value* +#### **--build-arg**=*arg=value* Specifies a build argument and its value, which will be interpolated in instructions read from the Containerfiles in the same way that environment variables are, but which will not be added to environment variable list in the resulting image's configuration. -**--cache-from** +#### **--cache-from** Images to utilize as potential cache sources. Podman does not currently support caching so this is a NOOP. -**--cap-add**=*CAP\_xxx* +#### **--cap-add**=*CAP\_xxx* When executing RUN instructions, run the command specified in the instruction with the specified capability added to its capability set. Certain capabilities are granted by default; this option can be used to add more. -**--cap-drop**=*CAP\_xxx* +#### **--cap-drop**=*CAP\_xxx* When executing RUN instructions, run the command specified in the instruction with the specified capability removed from its capability set. @@ -108,37 +108,37 @@ If a capability is specified to both the **--cap-add** and **--cap-drop** options, it will be dropped, regardless of the order in which the options were given. -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--cgroup-parent**=*path* +#### **--cgroup-parent**=*path* Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist. -**--compress** +#### **--compress** This option is added to be aligned with other containers CLIs. Podman doesn't communicate with a daemon or a remote server. Thus, compressing the data before sending it is irrelevant to Podman. -**--cni-config-dir**=*directory* +#### **--cni-config-dir**=*directory* Location of CNI configuration files which will dictate which plugins will be used to configure network interfaces and routing for containers created for handling `RUN` instructions, if those containers will be run in their own network namespaces, and networking is not disabled. -**--cni-plugin-path**=*directory[:directory[:directory[...]]]* +#### **--cni-plugin-path**=*directory[:directory[:directory[...]]]* List of directories in which the CNI plugins which will be used for configuring network namespaces can be found. -**--cpu-period**=*limit* +#### **--cpu-period**=*limit* Set the CPU period for the Completely Fair Scheduler (CFS), which is a duration in microseconds. Once the container's CPU quota is used up, it will @@ -149,7 +149,7 @@ On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error -**--cpu-quota**=*limit* +#### **--cpu-quota**=*limit* Limit the CPU Completely Fair Scheduler (CFS) quota. @@ -162,7 +162,7 @@ On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error -**--cpu-shares**, **-c**=*shares* +#### **--cpu-shares**, **-c**=*shares* CPU shares (relative weight) @@ -200,11 +200,11 @@ division of CPU shares: 101 {C1} 1 100% of CPU1 102 {C1} 2 100% of CPU2 -**--cpuset-cpus**=*num* +#### **--cpuset-cpus**=*num* CPUs in which to allow execution (0-3, 0,1) -**--cpuset-mems**=*nodes* +#### **--cpuset-mems**=*nodes* Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. @@ -213,13 +213,13 @@ If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1` then processes in your container will only use memory from the first two memory nodes. -**--creds**=*creds* +#### **--creds**=*creds* The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--device**=_host-device_[**:**_container-device_][**:**_permissions_] +#### **--device**=_host-device_[**:**_container-device_][**:**_permissions_] Add a host device to the container. Optional *permissions* parameter can be used to specify device permissions, it is combination of @@ -233,9 +233,9 @@ The container will only store the major and minor numbers of the host device. Note: if the user only has access rights via a group, accessing the device from inside a rootless container will fail. The **crun**(1) runtime offers a workaround for this by adding the option -**--annotation run.oci.keep_original_groups=1**. +#### **--annotation run.oci.keep_original_groups=1**. -**--disable-compression**, **-D** +#### **--disable-compression**, **-D** Don't compress filesystem layers when building the image unless it is required by the location where the image is being written. This is the default setting, @@ -244,13 +244,13 @@ registries, and images being written to local storage would only need to be decompressed again to be stored. Compression can be forced in all cases by specifying **--disable-compression=false**. -**--disable-content-trust** +#### **--disable-content-trust** This is a Docker specific option to disable image verification to a Docker registry and is not supported by Podman. This flag is a NOOP and provided solely for scripting compatibility. -**--dns**=*dns* +#### **--dns**=*dns* Set custom DNS servers @@ -263,15 +263,15 @@ The special value **none** can be specified to disable creation of /etc/resolv.conf in the container by Podman. The /etc/resolv.conf file in the image will be used without changes. -**--dns-option**=*option* +#### **--dns-option**=*option* Set custom DNS options -**--dns-search**=*domain* +#### **--dns-search**=*domain* Set custom DNS search domains -**--file**, **-f**=*Containerfile* +#### **--file**, **-f**=*Containerfile* Specifies a Containerfile which contains instructions for building the image, either a local file or an **http** or **https** URL. If more than one @@ -284,12 +284,12 @@ context. If you specify `-f -`, the Containerfile contents will be read from stdin. -**--force-rm**=*true|false* +#### **--force-rm**=*true|false* Always remove intermediate containers after a build, even if the build fails (default false). -**--format** +#### **--format** Control the format for the built image's manifest and configuration data. Recognized formats include *oci* (OCI image-spec v1.0, the default) and @@ -302,15 +302,15 @@ environment variable. `export BUILDAH_FORMAT=docker` Print usage statement -**--http-proxy** +#### **--http-proxy** Pass through HTTP Proxy environment variables. -**--iidfile**=*ImageIDfile* +#### **--iidfile**=*ImageIDfile* Write the image ID to the file. -**--ipc**=*how* +#### **--ipc**=*how* Sets the configuration for IPC namespaces when handling `RUN` instructions. The configured value can be "" (the empty string) or "container" to indicate @@ -319,7 +319,7 @@ that the IPC namespace in which `podman` itself is being run should be reused, or it can be the path to an IPC namespace which is already in use by another process. -**--isolation**=*type* +#### **--isolation**=*type* Controls what type of isolation is used for running processes as part of `RUN` instructions. Recognized types include *oci* (OCI-compatible runtime, the @@ -333,13 +333,13 @@ chroot(1) than container technology). Note: You can also override the default isolation type by setting the BUILDAH\_ISOLATION environment variable. `export BUILDAH_ISOLATION=oci` -**--jobs**=*number* +#### **--jobs**=*number* Run up to N concurrent stages in parallel. If the number of jobs is greater than 1, stdin will be read from /dev/null. If 0 is specified, then there is no limit in the number of jobs that run in parallel. -**--label**=*label* +#### **--label**=*label* Add an image *label* (e.g. label=*value*) to the image metadata. Can be used multiple times. @@ -354,25 +354,25 @@ capabilities is a subset of the default list. If the specified capabilities are not in the default set, Podman will print an error message and will run the container with the default capabilities. -**--layers** +#### **--layers** Cache intermediate images during the build process (Default is `true`). Note: You can also override the default value of layers by setting the BUILDAH\_LAYERS environment variable. `export BUILDAH_LAYERS=true` -**--logfile**=*filename* +#### **--logfile**=*filename* Log output which would be sent to standard output and standard error to the specified file instead of to standard output and standard error. -**--loglevel**=*number* +#### **--loglevel**=*number* Adjust the logging level up or down. Valid option values range from -2 to 3, with 3 being roughly equivalent to using the global *--debug* option, and values below 0 omitting even error messages which accompany fatal errors. -**--memory**, **-m**=*LIMIT* +#### **--memory**, **-m**=*LIMIT* Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) @@ -383,7 +383,7 @@ not limited. The actual limit may be rounded up to a multiple of the operating system's page size (the value would be very large, that's millions of trillions). -**--memory-swap**=*LIMIT* +#### **--memory-swap**=*LIMIT* A limit value equal to memory plus swap. Must be used with the **-m** (**--memory**) flag. The swap `LIMIT` should always be larger than **-m** @@ -394,7 +394,7 @@ The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap. -**--net**, **--network**=*string* +#### **--net**, **--network**=*string* Sets the configuration for network namespaces when handling `RUN` instructions. @@ -407,17 +407,17 @@ considered insecure. - **ns:**_path_: path to a network namespace to join. - `private`: create a new namespace for the container (default). -**--no-cache** +#### **--no-cache** Do not use existing cached images for the container build. Build from the start with a new set of cached layers. -**--os**=*string* +#### **--os**=*string* Set the OS to the provided value instead of the current operating system of the host. -**--pid**=*pid* +#### **--pid**=*pid* Sets the configuration for PID namespaces when handling `RUN` instructions. The configured value can be "" (the empty string) or "container" to indicate @@ -426,13 +426,13 @@ that the PID namespace in which `podman` itself is being run should be reused, or it can be the path to a PID namespace which is already in use by another process. -**--platform**="Linux" +#### **--platform**="Linux" This option has no effect on the build. Other container engines use this option to control the execution platform for the build (e.g., Windows, Linux) which is not required for Buildah as it supports only Linux. -**--pull** +#### **--pull** When the option is specified or set to "true", pull the image from the first registry it is found in as listed in registries.conf. Raise an error if not @@ -442,28 +442,28 @@ If the option is disabled (with *--pull=false*), or not specified, pull the image from the registry only if the image is not present locally. Raise an error if the image is not found in the registries. -**--pull-always** +#### **--pull-always** Pull the image from the first registry it is found in as listed in registries.conf. Raise an error if not found in the registries, even if the image is present locally. -**--pull-never** +#### **--pull-never** Do not pull the image from the registry, use only the local version. Raise an error if the image is not present locally. -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress output messages which indicate which instruction is being processed, and of progress when pulling images from a registry, and when writing the output image. -**--rm**=*true|false* +#### **--rm**=*true|false* Remove intermediate containers after a successful build (default true). -**--runtime**=*path* +#### **--runtime**=*path* The *path* to an alternate OCI-compatible runtime, which will be used to run commands specified by the **RUN** instruction. @@ -471,7 +471,7 @@ commands specified by the **RUN** instruction. Note: You can also override the default runtime by setting the BUILDAH\_RUNTIME environment variable. `export BUILDAH_RUNTIME=/usr/local/bin/runc` -**--security-opt**=*option* +#### **--security-opt**=*option* Security Options @@ -491,7 +491,7 @@ container - `seccomp=profile.json` : White listed syscalls seccomp Json file to be used as a seccomp filter -**--shm-size**=*size* +#### **--shm-size**=*size* Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`. @@ -499,34 +499,34 @@ Unit is optional and can be `b` (bytes), `k` (kilobytes), `m`(megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`. -**--sign-by**=*fingerprint* +#### **--sign-by**=*fingerprint* Sign the image using a GPG key with the specified FINGERPRINT. -**--squash** +#### **--squash** Squash all of the image's new layers into a single new layer; any preexisting layers are not squashed. -**--squash-all** +#### **--squash-all** Squash all of the new image's layers (including those inherited from a base image) into a single new layer. -**--tag**, **-t**=*imageName* +#### **--tag**, **-t**=*imageName* Specifies the name which will be assigned to the resulting image if the build process completes successfully. If _imageName_ does not include a registry name, the registry name *localhost* will be prepended to the image name. -**--target**=*stageName* +#### **--target**=*stageName* Set the target build stage to build. When building a Containerfile with multiple build stages, --target can be used to specify an intermediate build stage by name as the final stage for the resulting image. Commands after the target stage will be skipped. -**--timestamp** *seconds* +#### **--timestamp** *seconds* Set the create timestamp to seconds since epoch to allow for deterministic builds (defaults to current time). By default, the created timestamp is changed @@ -537,12 +537,12 @@ specified and therefore not changed, allowing the image's sha256 hash to remain same. All files committed to the layers of the image will be created with the timestamp. -**--tls-verify**=*true|false* +#### **--tls-verify**=*true|false* Require HTTPS and verify certificates when talking to container registries (defaults to true). -**--ulimit**=*type*=*soft-limit*[:*hard-limit*] +#### **--ulimit**=*type*=*soft-limit*[:*hard-limit*] Specifies resource limits to apply to processes launched when processing `RUN` instructions. This option can be specified multiple times. Recognized resource @@ -563,7 +563,7 @@ types include: "sigpending": maximum number of pending signals (ulimit -i) "stack": maximum stack size (ulimit -s) -**--userns**=*how* +#### **--userns**=*how* Sets the configuration for user namespaces when handling `RUN` instructions. The configured value can be "" (the empty string) or "container" to indicate @@ -572,7 +572,7 @@ the user namespace in which `podman` itself is being run should be reused, or it can be the path to an user namespace which is already in use by another process. -**--userns-uid-map**=*mapping* +#### **--userns-uid-map**=*mapping* Directly specifies a UID mapping which should be used to set ownership, at the filesystem level, on the working container's contents. @@ -593,7 +593,7 @@ If none of --userns-uid-map-user, --userns-gid-map-group, or --userns-uid-map are specified, but --userns-gid-map is specified, the UID map will be set to use the same numeric values as the GID map. -**--userns-gid-map**=*mapping* +#### **--userns-gid-map**=*mapping* Directly specifies a GID mapping which should be used to set ownership, at the filesystem level, on the working container's contents. @@ -614,7 +614,7 @@ If none of --userns-uid-map-user, --userns-gid-map-group, or --userns-gid-map are specified, but --userns-uid-map is specified, the GID map will be set to use the same numeric values as the UID map. -**--userns-uid-map-user**=*user* +#### **--userns-uid-map-user**=*user* Specifies that a UID mapping which should be used to set ownership, at the filesystem level, on the working container's contents, can be found in entries @@ -625,7 +625,7 @@ If --userns-gid-map-group is specified, but --userns-uid-map-user is not specified, `podman` will assume that the specified group name is also a suitable user name to use as the default setting for this option. -**--userns-gid-map-group**=*group* +#### **--userns-gid-map-group**=*group* Specifies that a GID mapping which should be used to set ownership, at the filesystem level, on the working container's contents, can be found in entries @@ -636,7 +636,7 @@ If --userns-uid-map-user is specified, but --userns-gid-map-group is not specified, `podman` will assume that the specified user name is also a suitable group name to use as the default setting for this option. -**--uts**=*how* +#### **--uts**=*how* Sets the configuration for UTS namespaces when the handling `RUN` instructions. The configured value can be "" (the empty string) or "container" to indicate @@ -645,7 +645,7 @@ that the UTS namespace in which `podman` itself is being run should be reused, or it can be the path to a UTS namespace which is already in use by another process. -**--volume**, **-v**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*] +#### **--volume**, **-v**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*] Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, Podman bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the Podman diff --git a/docs/source/markdown/podman-commit.1.md b/docs/source/markdown/podman-commit.1.md index 13e46a899..7485e9bd9 100644 --- a/docs/source/markdown/podman-commit.1.md +++ b/docs/source/markdown/podman-commit.1.md @@ -22,39 +22,39 @@ If *image* is not provided, the values for the `REPOSITORY` and `TAG` values of ## OPTIONS -**--author**, **-a**=*author* +#### **--author**, **-a**=*author* Set the author for the committed image -**--change**, **-c**=*instruction* +#### **--change**, **-c**=*instruction* Apply the following possible instructions to the created image: **CMD** | **ENTRYPOINT** | **ENV** | **EXPOSE** | **LABEL** | **ONBUILD** | **STOPSIGNAL** | **USER** | **VOLUME** | **WORKDIR** Can be set multiple times -**--format**, **-f**=*format* +#### **--format**, **-f**=*format* Set the format of the image manifest and metadata. The currently supported formats are _oci_ and _docker_. If not specifically set, the default format used is _oci_. -**--iidfile**=*ImageIDfile* +#### **--iidfile**=*ImageIDfile* Write the image ID to the file. -**--include-volumes** +#### **--include-volumes** Include in the committed image any volumes added to the container by the `--volume` or `--mount` options to the `podman create` and `podman run` commands. -**--message**, **-m**=*message* +#### **--message**, **-m**=*message* Set commit message for committed image. The message field is not supported in _oci_ format. -**--pause**, **-p** +#### **--pause**, **-p** Pause the container when creating an image -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress output diff --git a/docs/source/markdown/podman-container-checkpoint.1.md b/docs/source/markdown/podman-container-checkpoint.1.md index 1bac477c8..bfda782c5 100644 --- a/docs/source/markdown/podman-container-checkpoint.1.md +++ b/docs/source/markdown/podman-container-checkpoint.1.md @@ -10,42 +10,42 @@ podman\-container\-checkpoint - Checkpoints one or more running containers Checkpoints all the processes in one or more containers. You may use container IDs or names as input. ## OPTIONS -**--keep**, **-k** +#### **--keep**, **-k** Keep all temporary log and statistics files created by CRIU during checkpointing. These files are not deleted if checkpointing fails for further debugging. If checkpointing succeeds these files are theoretically not needed, but if these files are needed Podman can keep the files for further analysis. -**--all**, **-a** +#### **--all**, **-a** Checkpoint all running containers. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, checkpoint the last created container. The latest option is not supported on the remote client. -**--leave-running**, **-R** +#### **--leave-running**, **-R** Leave the container running after checkpointing instead of stopping it. -**--tcp-established** +#### **--tcp-established** Checkpoint a container with established TCP connections. If the checkpoint image contains established TCP connections, this options is required during restore. Defaults to not checkpointing containers with established TCP connections. -**--export**, **-e** +#### **--export**, **-e** Export the checkpoint to a tar.gz file. The exported checkpoint can be used to import the container on another system and thus enabling container live migration. This checkpoint archive also includes all changes to the container's root file-system, if not explicitly disabled using **--ignore-rootfs** -**--ignore-rootfs** +#### **--ignore-rootfs** This only works in combination with **--export, -e**. If a checkpoint is exported to a tar.gz file it is possible with the help of **--ignore-rootfs** diff --git a/docs/source/markdown/podman-container-cleanup.1.md b/docs/source/markdown/podman-container-cleanup.1.md index a200c2c36..eabb462e8 100644 --- a/docs/source/markdown/podman-container-cleanup.1.md +++ b/docs/source/markdown/podman-container-cleanup.1.md @@ -12,28 +12,28 @@ Sometimes container's mount points and network stacks can remain if the podman c ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Cleanup all containers. -**--exec**=_session_ +#### **--exec**=_session_ Clean up an exec session for a single container. Can only be specified if a single container is being cleaned up (conflicts with **--all** as such). If **--rm** is not specified, temporary files for the exec session will be cleaned up; if it is, the exec session will be removed from the container. Conflicts with **--rmi** as the container is not being cleaned up so the image cannot be removed. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--rm** +#### **--rm** After cleanup, remove the container entirely. -**--rmi** +#### **--rmi** After cleanup, remove the image entirely. diff --git a/docs/source/markdown/podman-container-exists.1.md b/docs/source/markdown/podman-container-exists.1.md index d81a38515..381d968ab 100644 --- a/docs/source/markdown/podman-container-exists.1.md +++ b/docs/source/markdown/podman-container-exists.1.md @@ -14,7 +14,7 @@ was an issue accessing the local storage. ## OPTIONS -**--external**=*true|false* +#### **--external**=*true|false* Check for external containers as well as Podman containers. These external containers are generally created via other container technology such as Buildah or CRI-O. **-h**, **--help** diff --git a/docs/source/markdown/podman-container-prune.1.md b/docs/source/markdown/podman-container-prune.1.md index d56a1e7f5..4b4effb0b 100644 --- a/docs/source/markdown/podman-container-prune.1.md +++ b/docs/source/markdown/podman-container-prune.1.md @@ -11,11 +11,11 @@ podman-container-prune - Remove all stopped containers from local storage ## OPTIONS -**--filter**=*filters* +#### **--filter**=*filters* Provide filter values. -**--force**, **-f** +#### **--force**, **-f** Do not provide an interactive prompt for container removal. diff --git a/docs/source/markdown/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md index a7b0f199b..494e7db1e 100644 --- a/docs/source/markdown/podman-container-restore.1.md +++ b/docs/source/markdown/podman-container-restore.1.md @@ -10,7 +10,7 @@ podman\-container\-restore - Restores one or more containers from a checkpoint Restores a container from a checkpoint. You may use container IDs or names as input. ## OPTIONS -**--keep**, **-k** +#### **--keep**, **-k** Keep all temporary log and statistics files created by CRIU during checkpointing as well as restoring. These files are not deleted if restoring @@ -24,17 +24,17 @@ processes in the checkpointed container. Without the **-k**, **--keep** option the checkpoint will be consumed and cannot be used again. -**--all**, **-a** +#### **--all**, **-a** Restore all checkpointed containers. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, restore the last created container. The latest option is not supported on the remote client. -**--tcp-established** +#### **--tcp-established** Restore a container with established TCP connections. If the checkpoint image contains established TCP connections, this option is required during restore. @@ -42,13 +42,13 @@ If the checkpoint image does not contain established TCP connections this option is ignored. Defaults to not restoring containers with established TCP connections. -**--import**, **-i** +#### **--import**, **-i** Import a checkpoint tar.gz file, which was exported by Podman. This can be used to import a checkpointed container from another host. Do not specify a *container* argument when using this option. -**--name**, **-n** +#### **--name**, **-n** This is only available in combination with **--import, -i**. If a container is restored from a checkpoint tar.gz file it is possible to rename it with **--name, -n**. This @@ -60,14 +60,14 @@ address to the container it was using before checkpointing as each IP address ca be used once and the restored container will have another IP address. This also means that **--name, -n** cannot be used in combination with **--tcp-established**. -**--ignore-rootfs** +#### **--ignore-rootfs** This is only available in combination with **--import, -i**. If a container is restored from a checkpoint tar.gz file it is possible that it also contains all root file-system changes. With **--ignore-rootfs** it is possible to explicitly disable applying these root file-system changes to the restored container. -**--ignore-static-ip** +#### **--ignore-static-ip** If the container was started with **--ip** the restored container also tries to use that IP address and restore fails if that IP address is already in use. This can happen, if @@ -76,7 +76,7 @@ a container is restored multiple times from an exported checkpoint with **--name Using **--ignore-static-ip** tells Podman to ignore the IP address if it was configured with **--ip** during container creation. -**--ignore-static-mac** +#### **--ignore-static-mac** If the container was started with **--mac-address** the restored container also tries to use that MAC address and restore fails if that MAC address is already diff --git a/docs/source/markdown/podman-container-runlabel.1.md b/docs/source/markdown/podman-container-runlabel.1.md index 676ad12d0..54d675705 100644 --- a/docs/source/markdown/podman-container-runlabel.1.md +++ b/docs/source/markdown/podman-container-runlabel.1.md @@ -41,7 +41,7 @@ is used. Any additional arguments will be appended to the command. ## OPTIONS -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. @@ -49,39 +49,39 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--display** +#### **--display** Display the label's value of the image having populated its environment variables. The runlabel command will not execute if --display is specified. -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--creds**=*[username[:password]]* +#### **--creds**=*[username[:password]]* The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--name**, **-n**=*name* +#### **--name**, **-n**=*name* Use this name for creating content for the container. NAME will default to the IMAGENAME if it is not specified. -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress output information when pulling images -**--replace** +#### **--replace** If a container exists of the default or given name, as needed it will be stopped, deleted and a new container will be created from this image. -**--tls-verify** +#### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, diff --git a/docs/source/markdown/podman-cp.1.md b/docs/source/markdown/podman-cp.1.md index 0f54b2e8b..8f63c00ee 100644 --- a/docs/source/markdown/podman-cp.1.md +++ b/docs/source/markdown/podman-cp.1.md @@ -59,11 +59,11 @@ If you use a : in a local machine path, you must be explicit with a relative or ## OPTIONS -**--extract** +#### **--extract** Extract the tar file into the destination directory. If the destination directory is not provided, extract the tar file into the root directory. -**--pause** +#### **--pause** Pause the container while copying into it to avoid potential security issues around symlinks. Defaults to *true*. On rootless containers with cgroups V1, defaults to false. diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md index e243a5842..afb7f9cbf 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -19,19 +19,19 @@ any point. The initial status of the container created with **podman create** is 'created'. ## OPTIONS -**--add-host**=*host* +#### **--add-host**=*host* Add a custom host-to-IP mapping (host:ip) Add a line to /etc/hosts. The format is hostname:ip. The **--add-host** option can be set multiple times. -**--annotation**=*key=value* +#### **--annotation**=*key=value* Add an annotation to the container. The format is key=value. The **--annotation** option can be set multiple times. -**--attach**, **-a**=*location* +#### **--attach**, **-a**=*location* Attach to STDIN, STDOUT or STDERR. @@ -42,30 +42,30 @@ error. It can even pretend to be a TTY (this is what most commandline executables expect) and pass along signals. The **-a** option can be set for each of stdin, stdout, and stderr. -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--blkio-weight**=*weight* +#### **--blkio-weight**=*weight* Block IO weight (relative weight) accepts a weight value between 10 and 1000. -**--blkio-weight-device**=*weight* +#### **--blkio-weight-device**=*weight* Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`). -**--cap-add**=*capability* +#### **--cap-add**=*capability* Add Linux capabilities -**--cap-drop**=*capability* +#### **--cap-drop**=*capability* Drop Linux capabilities -**--cgroupns**=*mode* +#### **--cgroupns**=*mode* Set the cgroup namespace mode for the container. **host**: use the host's cgroup namespace inside the container. @@ -75,7 +75,7 @@ Set the cgroup namespace mode for the container. If the host uses cgroups v1, the default is set to **host**. On cgroups v2 the default is **private**. -**--cgroups**=*mode* +#### **--cgroups**=*mode* Determines whether the container will create CGroups. Valid values are *enabled*, *disabled*, *no-conmon*, *split*, which the default being *enabled*. @@ -85,23 +85,23 @@ The *disabled* option will force the container to not create CGroups, and thus c The *no-conmon* option disables a new CGroup only for the conmon process. The *split* option splits the current cgroup in two sub-cgroups: one for conmon and one for the container payload. It is not possible to set *--cgroup-parent* with *split*. -**--cgroup-parent**=*path* +#### **--cgroup-parent**=*path* Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist. -**--cgroup-conf**=*KEY=VALUE* +#### **--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. -**--cidfile**=*id* +#### **--cidfile**=*id* Write the container ID to the file -**--conmon-pidfile**=*path* +#### **--conmon-pidfile**=*path* Write the pid of the `conmon` process to a file. `conmon` runs in a separate process than Podman, so this is necessary when using systemd to restart Podman containers. -**--cpu-period**=*limit* +#### **--cpu-period**=*limit* Set the CPU period for the Completely Fair Scheduler (CFS), which is a duration in microseconds. Once the container's CPU quota is used up, it will @@ -112,7 +112,7 @@ On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error -**--cpu-quota**=*limit* +#### **--cpu-quota**=*limit* Limit the CPU Completely Fair Scheduler (CFS) quota. @@ -125,13 +125,13 @@ On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error -**--cpu-rt-period**=*microseconds* +#### **--cpu-rt-period**=*microseconds* Limit the CPU real-time period in microseconds Limit the container's Real Time CPU usage. This flag tell the kernel to restrict the container's Real Time CPU usage to the period you specify. -**--cpu-rt-runtime**=*microseconds* +#### **--cpu-rt-runtime**=*microseconds* Limit the CPU real-time runtime in microseconds @@ -140,7 +140,7 @@ Period of 1,000,000us and Runtime of 950,000us means that this container could c The sum of all runtimes across containers cannot exceed the amount allotted to the parent cgroup. -**--cpu-shares**=*shares* +#### **--cpu-shares**=*shares* CPU shares (relative weight) @@ -177,21 +177,21 @@ PID container CPU CPU share 101 {C1} 1 100% of CPU1 102 {C1} 2 100% of CPU2 -**--cpus**=*number* +#### **--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**. +#### **--cpus** or **--cpu-period** and **--cpu-quota**. On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error -**--cpuset-cpus**=*cpus* +#### **--cpuset-cpus**=*cpus* CPUs in which to allow execution (0-3, 0,1) -**--cpuset-mems**=*nodes* +#### **--cpuset-mems**=*nodes* Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. @@ -199,7 +199,7 @@ If you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1` then processes in your container will only use memory from the first two memory nodes. -**--device**=_host-device_[**:**_container-device_][**:**_permissions_] +#### **--device**=_host-device_[**:**_container-device_][**:**_permissions_] Add a host device to the container. Optional *permissions* parameter can be used to specify device permissions, it is combination of @@ -218,36 +218,36 @@ Podman may load kernel modules required for using the specified device. The devices that podman will load modules when necessary are: /dev/fuse. -**--device-cgroup-rule**="type major:minor mode" +#### **--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): - type: a (all), c (char), or b (block); - major and minor: either a number, or * for all; - mode: a composition of r (read), w (write), and m (mknod(2)). -**--device-read-bps**=*path* +#### **--device-read-bps**=*path* Limit read rate (bytes per second) from a device (e.g. --device-read-bps=/dev/sda:1mb) -**--device-read-iops**=*path* +#### **--device-read-iops**=*path* Limit read rate (IO per second) from a device (e.g. --device-read-iops=/dev/sda:1000) -**--device-write-bps**=*path* +#### **--device-write-bps**=*path* Limit write rate (bytes per second) to a device (e.g. --device-write-bps=/dev/sda:1mb) -**--device-write-iops**=*path* +#### **--device-write-iops**=*path* Limit write rate (IO per second) to a device (e.g. --device-write-iops=/dev/sda:1000) -**--disable-content-trust** +#### **--disable-content-trust** This is a Docker specific option to disable image verification to a Docker registry and is not supported by Podman. This flag is a NOOP and provided solely for scripting compatibility. -**--dns**=*dns* +#### **--dns**=*dns* Set custom DNS servers. Invalid if using **--dns** and **--network** that is set to 'none' or 'container:<name|id>'. @@ -259,15 +259,15 @@ is the case the **--dns** flags is necessary for every run. The special value **none** can be specified to disable creation of **/etc/resolv.conf** in the container by Podman. The **/etc/resolv.conf** file in the image will be used without changes. -**--dns-opt**=*option* +#### **--dns-opt**=*option* Set custom DNS options. Invalid if using **--dns-opt** and **--network** that is set to 'none' or 'container:<name|id>'. -**--dns-search**=*domain* +#### **--dns-search**=*domain* Set custom DNS search domains. Invalid if using **--dns-search** and **--network** that is set to 'none' or 'container:<name|id>'. (Use --dns-search=. if you don't wish to set the search domain) -**--entrypoint**=*"command"* | *'["command", "arg1", ...]'* +#### **--entrypoint**=*"command"* | *'["command", "arg1", ...]'* Overwrite the default ENTRYPOINT of the image @@ -284,7 +284,7 @@ ENTRYPOINT. You need to specify multi option commands in the form of a json string. -**--env**, **-e**=*env* +#### **--env**, **-e**=*env* Set environment variables @@ -292,30 +292,30 @@ This option allows arbitrary environment variables that are available for the pr See [**Environment**](#environment) note below for precedence and examples. -**--env-host**=*true|false* +#### **--env-host**=*true|false* Use host environment inside of the container. See **Environment** note below for precedence. (Not available for remote commands) -**--env-file**=*file* +#### **--env-file**=*file* Read in a line delimited file of environment variables. See **Environment** note below for precedence. -**--expose**=*port* +#### **--expose**=*port* Expose a port, or a range of ports (e.g. --expose=3300-3310) to set up port redirection on the host system. -**--gidmap**=*container_gid:host_gid:amount* +#### **--gidmap**=*container_gid:host_gid:amount* GID map for the user namespace. Using this flag will run the container with user namespace enabled. It conflicts with the `--userns` and `--subgidname` flags. The following example maps uids 0-2000 in the container to the uids 30000-31999 on the host and gids 0-2000 in the container to the gids 30000-31999 on the host. `--gidmap=0:30000:2000` -**--group-add**=*group* +#### **--group-add**=*group* Add additional groups to run as -**--health-cmd**=*"command"* | *'["command", "arg1", ...]'* +#### **--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 @@ -324,20 +324,20 @@ 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 as an argument to `/bin/sh -c`. -**--health-interval**=*interval* +#### **--health-interval**=*interval* Set an interval for the healthchecks (a value of `disable` results in no automatic timer setup) (default "30s") -**--health-retries**=*retries* +#### **--health-retries**=*retries* The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is `3`. -**--health-start-period**=*period* +#### **--health-start-period**=*period* The initialization time needed for a container to bootstrap. The value can be expressed in time format like `2m3s`. The default value is `0s` -**--health-timeout**=*timeout* +#### **--health-timeout**=*timeout* The maximum time allowed to complete the healthcheck before an interval is considered failed. Like start-period, the value can be expressed in a time format such as `1m22s`. The default value is `30s`. @@ -348,11 +348,11 @@ Container host name Sets the container host name that is available inside the container. Can only be used with a private UTS namespace `--uts=private` (default). If `--pod` is specified and the pod shares the UTS namespace (default) the pods hostname will be used. -**--help** +#### **--help** Print usage statement -**--http-proxy**=*true|false* +#### **--http-proxy**=*true|false* By default proxy environment variables are passed into the container if set for the Podman process. This can be disabled by setting the `--http-proxy` @@ -372,7 +372,7 @@ container: Defaults to `true` -**--image-volume**, **builtin-volume**=*bind|tmpfs|ignore* +#### **--image-volume**, **builtin-volume**=*bind|tmpfs|ignore* Tells Podman how to handle the builtin image volumes. Default is **bind**. @@ -381,37 +381,37 @@ Tells Podman how to handle the builtin image volumes. Default is **bind**. content that disappears when the container is stopped. - **ignore**: All volumes are just ignored and no action is taken. -**--init** +#### **--init** Run an init inside the container that forwards signals and reaps processes. -**--init-path**=*path* +#### **--init-path**=*path* Path to the container-init binary. -**--interactive**, **-i**=*true|false* +#### **--interactive**, **-i**=*true|false* Keep STDIN open even if not attached. The default is *false*. -**--ip6**=*ip* +#### **--ip6**=*ip* Not implemented -**--ip**=*ip* +#### **--ip**=*ip* Specify a static IP address for the container, for example **10.88.64.128**. This option can only be used if the container is joined to only a single network - i.e., `--network=_network-name_` is used at most once - and if the container is not joining another container's network namespace via `--network=container:_id_`. The address must be within the CNI network's IP address pool (default **10.88.0.0/16**). -**--ipc**=*ipc* +#### **--ipc**=*ipc* Default is to create a private IPC namespace (POSIX SysV IPC) for the container 'container:<name|id>': reuses another container shared memory, semaphores and message queues 'host': use the host shared memory,semaphores and message queues inside the container. Note: the host mode gives the container full access to local shared memory and is therefore considered insecure. 'ns:<path>' path to an IPC namespace to join. -**--kernel-memory**=*number[unit]* +#### **--kernel-memory**=*number[unit]* Kernel memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) @@ -421,23 +421,23 @@ is not limited. If you specify a limit, it may be rounded up to a multiple of the operating system's page size and the value can be very large, millions of trillions. -**--label**, **-l**=*label* +#### **--label**, **-l**=*label* Add metadata to a container (e.g., --label com.example.key=value) -**--label-file**=*file* +#### **--label-file**=*file* Read in a line delimited file of labels -**--link-local-ip**=*ip* +#### **--link-local-ip**=*ip* Not implemented -**--log-driver**="*k8s-file*" +#### **--log-driver**="*k8s-file*" Logging driver for the container. Currently available options are *k8s-file*, *journald*, and *none*, with *json-file* aliased to *k8s-file* for scripting compatibility. -**--log-opt**=*name*=*value* +#### **--log-opt**=*name*=*value* Set custom logging configuration. The following *name*s are supported: @@ -460,7 +460,7 @@ It supports the same keys as `podman inspect --format`. It is currently supported only by the journald log driver. -**--mac-address**=*address* +#### **--mac-address**=*address* Container MAC address (e.g. 92:d0:c6:0a:29:33) @@ -468,7 +468,7 @@ Remember that the MAC address in an Ethernet network must be unique. The IPv6 link-local address will be based on the device's MAC address according to RFC4862. -**--memory**, **-m**=*limit* +#### **--memory**, **-m**=*limit* Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) @@ -478,7 +478,7 @@ RAM. If a limit of 0 is specified (not using **-m**), the container's memory is not limited. The actual limit may be rounded up to a multiple of the operating system's page size (the value would be very large, that's millions of trillions). -**--memory-reservation**=*limit* +#### **--memory-reservation**=*limit* Memory soft limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) @@ -488,7 +488,7 @@ reservation. So you should always set the value below **--memory**, otherwise th hard limit will take precedence. By default, memory reservation will be the same as memory limit. -**--memory-swap**=*limit* +#### **--memory-swap**=*limit* A limit value equal to memory plus swap. Must be used with the **-m** (**--memory**) flag. The swap `LIMIT` should always be larger than **-m** @@ -499,11 +499,11 @@ The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap. -**--memory-swappiness**=*number* +#### **--memory-swappiness**=*number* Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. -**--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]* +#### **--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]* Attach a filesystem mount to the container @@ -560,7 +560,7 @@ Current supported mount TYPEs are **bind**, **volume**, **image**, **tmpfs** and · notmpcopyup: Disable copying files from the image to the tmpfs. -**--name**=*name* +#### **--name**=*name* Assign a name to the container @@ -574,7 +574,7 @@ 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. This works for both background and foreground containers. -**--network**, **--net**="*bridge*" +#### **--network**, **--net**="*bridge*" Set the Network mode for the container. Invalid if using **--dns**, **--dns-opt**, or **--dns-search** with **--network** that is set to 'none' or 'container:<name|id>'. @@ -598,39 +598,39 @@ Valid values are: - **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default. - **port_handler=slirp4netns**: Use the slirp4netns port forwarding. -**--network-alias**=*alias* +#### **--network-alias**=*alias* Not implemented -**--no-healthcheck**=*true|false* +#### **--no-healthcheck**=*true|false* Disable any defined healthchecks for container. -**--no-hosts**=*true|false* +#### **--no-hosts**=*true|false* Do not create /etc/hosts for the container. By default, Podman will manage /etc/hosts, adding the container's own IP address and any hosts from **--add-host**. -**--no-hosts** disables this, and the image's **/etc/host** will be preserved unmodified. +#### **--no-hosts** disables this, and the image's **/etc/host** will be preserved unmodified. This option conflicts with **--add-host**. -**--oom-kill-disable**=*true|false* +#### **--oom-kill-disable**=*true|false* Whether to disable OOM Killer for the container or not. -**--oom-score-adj**=*num* +#### **--oom-score-adj**=*num* Tune the host's OOM preferences for containers (accepts -1000 to 1000) -**--override-arch**=*ARCH* +#### **--override-arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. -**--override-os**=*OS* +#### **--override-os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -**--override-variant**=*VARIANT* +#### **--override-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. -**--pid**=*pid* +#### **--pid**=*pid* Set the PID mode for the container Default is to create a private PID namespace for the container @@ -639,20 +639,20 @@ Default is to create a private PID namespace for the container - `ns`: join the specified PID namespace - `private`: create a new namespace for the container (default) -**--pids-limit**=*limit* +#### **--pids-limit**=*limit* Tune the container's pids limit. Set `0` to have unlimited pids for the container. (default "4096" on systems that support PIDS cgroups). -**--pod**=*name* +#### **--pod**=*name* Run container in an existing pod. If you want Podman to make the pod for you, preference the pod name with `new:`. To make a pod with more granular options, use the `podman pod create` command before creating a container. -**--pod-id-file**=*path* +#### **--pod-id-file**=*path* Run container in an existing pod and read the pod's ID from the specified file. If a container is run within a pod, and the pod has an infra-container, the infra-container will be started before the container is. -**--privileged**=*true|false* +#### **--privileged**=*true|false* Give extended privileges to this container. The default is *false*. @@ -668,7 +668,7 @@ container. Rootless containers cannot have more privileges than the account that launched them. -**--publish**, **-p**=*port* +#### **--publish**, **-p**=*port* Publish a container's port, or range of ports, to the host @@ -691,7 +691,7 @@ associated ports. If one container binds to a port, no other container can use t within the pod while it is in use. Containers in the pod can also communicate over localhost by having one container bind to localhost in the pod, and another connect to that port. -**--publish-all**, **-P**=*true|false* +#### **--publish-all**, **-P**=*true|false* Publish all exposed ports to random ports on the host interfaces. The default is *false*. @@ -703,7 +703,7 @@ port to a random port on the host within an *ephemeral port range* defined by `/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host ports and the exposed ports, use `podman port`. -**--pull**=*missing* +#### **--pull**=*missing* Pull image before creating ("always"|"missing"|"never") (default "missing"). 'missing': default value, attempt to pull the latest image from the registries listed in registries.conf if a local image does not exist.Raise an error if the image is not in any listed registry and is not present locally. @@ -712,11 +712,11 @@ Pull image before creating ("always"|"missing"|"never") (default "missing"). Defaults to *missing*. -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress output information when pulling images -**--read-only**=*true|false* +#### **--read-only**=*true|false* Mount the container's root filesystem as read only. @@ -724,15 +724,15 @@ By default a container will have its root filesystem writable allowing processes to write files anywhere. By specifying the `--read-only` flag the container will have its root filesystem mounted as read only prohibiting any writes. -**--read-only-tmpfs**=*true|false* +#### **--read-only-tmpfs**=*true|false* If container is running in --read-only mode, then mount a read-write tmpfs on /run, /tmp, and /var/tmp. The default is *true* -**--replace**=**true**|**false** +#### **--replace**=**true**|**false** If another container with the same name already exists, replace and remove it. The default is **false**. -**--restart**=*policy* +#### **--restart**=*policy* Restart policy to follow when containers exit. Restart policy will not take effect if a container is stopped via the `podman kill` or `podman stop` commands. @@ -748,7 +748,7 @@ Please note that restart will not restart containers after a system reboot. If this functionality is required in your environment, you can invoke Podman from a systemd unit file, or create an init script for whichever init system is in use. To generate systemd unit files, please see *podman generate systemd* -**--rm**=*true|false* +#### **--rm**=*true|false* Automatically remove the container when it exits. The default is *false*. @@ -756,14 +756,14 @@ Note that the container will not be removed when it could not be created or started successfully. This allows the user to inspect the container after failure. -**--rootfs** +#### **--rootfs** If specified, the first argument refers to an exploded container on the file system. This is useful to run a container without requiring any image management, the rootfs of the container is assumed to be managed externally. -**--sdnotify**=**container**|**conmon**|**ignore** +#### **--sdnotify**=**container**|**conmon**|**ignore** Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. @@ -774,13 +774,13 @@ has started. The socket is never passed to the runtime or the container. The **ignore** option removes NOTIFY_SOCKET from the environment for itself and child processes, for the case where some other process above Podman uses NOTIFY_SOCKET and Podman should not use it. -**--seccomp-policy**=*policy* +#### **--seccomp-policy**=*policy* Specify the policy to select the seccomp profile. If set to *image*, Podman will look for a "io.podman.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. Note that this feature is experimental and may change in the future. -**--security-opt**=*option* +#### **--security-opt**=*option* Security Options @@ -804,29 +804,29 @@ Security Options Note: Labeling can be disabled for all containers by setting label=false in the **containers.conf** (`/etc/containers/containers.conf` or `$HOME/.config/containers/containers.conf`) file. -**--shm-size**=*size* +#### **--shm-size**=*size* Size of `/dev/shm` (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`. When size is `0`, there is no limit on the amount of memory used for IPC by the container. -**--stop-signal**=*SIGTERM* +#### **--stop-signal**=*SIGTERM* Signal to stop a container. Default is SIGTERM. -**--stop-timeout**=*seconds* +#### **--stop-timeout**=*seconds* Timeout (in seconds) to stop a container. Default is 10. -**--subgidname**=*name* +#### **--subgidname**=*name* Name for GID map from the `/etc/subgid` file. Using this flag will run the container with user namespace enabled. This flag conflicts with `--userns` and `--gidmap`. -**--subuidname**=*name* +#### **--subuidname**=*name* Name for UID map from the `/etc/subuid` file. Using this flag will run the container with user namespace enabled. This flag conflicts with `--userns` and `--uidmap`. -**--sysctl**=*SYSCTL* +#### **--sysctl**=*SYSCTL* Configure namespaced kernel parameters at runtime @@ -842,7 +842,7 @@ Network Namespace - current sysctls allowed: Note: if you use the --network=host option these sysctls will not be allowed. -**--systemd**=*true|false|always* +#### **--systemd**=*true|false|always* Run container in systemd mode. The default is *true*. @@ -866,7 +866,7 @@ The `container_manage_cgroup` boolean must be enabled for this to be allowed on `setsebool -P container_manage_cgroup true` -**--tmpfs**=*fs* +#### **--tmpfs**=*fs* Create a tmpfs mount @@ -879,7 +879,7 @@ options are the same as the Linux default `mount` flags. If you do not specify any options, the systems uses the following options: `rw,noexec,nosuid,nodev`. -**--tty**, **-t**=*true|false* +#### **--tty**, **-t**=*true|false* Allocate a pseudo-TTY. The default is *false*. @@ -890,27 +890,27 @@ interactive shell. The default is false. Note: The **-t** option is incompatible with a redirection of the Podman client standard input. -**--tz**=*timezone* +#### **--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. -**--umask**=*umask* +#### **--umask**=*umask* Set the umask inside the container. Defaults to `0022`. -**--uidmap**=*container_uid:host_uid:amount* +#### **--uidmap**=*container_uid:host_uid:amount* UID map for the user namespace. Using this flag will run the container with user namespace enabled. It conflicts with the `--userns` and `--subuidname` flags. The following example maps uids 0-2000 in the container to the uids 30000-31999 on the host and gids 0-2000 in the container to the gids 30000-31999 on the host. `--uidmap=0:30000:2000` -**--ulimit**=*option* +#### **--ulimit**=*option* Ulimit options You can pass `host` to copy the current configuration from the host. -**--user**, **-u**=*user* +#### **--user**, **-u**=*user* Sets the username or UID used and optionally the groupname or GID for the specified command. @@ -919,12 +919,12 @@ The following examples are all valid: Without this argument the command will be run as root in the container. -**--userns**=*auto*[:OPTIONS] -**--userns**=*host* -**--userns**=*keep-id* -**--userns**=container:container -**--userns**=private -**--userns**=*ns:my_namespace* +#### **--userns**=*auto*[:OPTIONS] +#### **--userns**=*host* +#### **--userns**=*keep-id* +#### **--userns**=container:container +#### **--userns**=private +#### **--userns**=*ns:my_namespace* Set the user namespace mode for the container. It defaults to the **PODMAN_USERNS** environment variable. An empty value means user namespaces are disabled. @@ -941,7 +941,7 @@ Set the user namespace mode for the container. It defaults to the **PODMAN_USER This option is incompatible with --gidmap, --uidmap, --subuid and --subgid -**--uts**=*mode* +#### **--uts**=*mode* Set the UTS namespace mode for the container. The following values are supported: @@ -950,7 +950,7 @@ Set the UTS namespace mode for the container. The following values are supported - **ns:[path]**: run the container in the given existing UTS namespace. - **container:[container]**: join the UTS namespace of the specified container. -**--volume**, **-v**[=*[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]*] +#### **--volume**, **-v**[=*[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]*] Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, podman bind mounts `/HOST-DIR` in the host to `/CONTAINER-DIR` in the podman @@ -1091,7 +1091,7 @@ will convert /foo into a `shared` mount point. Alternatively one can directly change propagation properties of source mount. Say `/` is source mount for `/foo`, then use `mount --make-shared /` to convert `/` into a `shared` mount. -**--volumes-from**[=*CONTAINER*[:*OPTIONS*]] +#### **--volumes-from**[=*CONTAINER*[:*OPTIONS*]] Mount volumes from the specified container(s). Used to share volumes between containers. The *options* is a comma delimited list with the following available elements: @@ -1124,7 +1124,7 @@ If the location of the volume from the source container overlaps with data residing on a target container, then the volume hides that data on the target. -**--workdir**, **-w**=*dir* +#### **--workdir**, **-w**=*dir* Working directory inside the container diff --git a/docs/source/markdown/podman-diff.1.md b/docs/source/markdown/podman-diff.1.md index 5b0434a07..227da4864 100644 --- a/docs/source/markdown/podman-diff.1.md +++ b/docs/source/markdown/podman-diff.1.md @@ -13,11 +13,11 @@ Displays changes on a container or image's filesystem. The container or image w ## OPTIONS -**--format** +#### **--format** Alter the output into a different format. The only valid format for diff is `json`. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md index d0bc3cef8..4f9e9418f 100644 --- a/docs/source/markdown/podman-events.1.md +++ b/docs/source/markdown/podman-events.1.md @@ -70,16 +70,16 @@ The *volume* type will report the following statuses: ## OPTIONS -**--help** +#### **--help** Print usage statement. -**--format** +#### **--format** Format the output to JSON Lines or using the given Go template. -**--filter**=*filter* +#### **--filter**=*filter* Filter events that are displayed. They must be in the format of "filter=value". The following filters are supported: @@ -93,12 +93,12 @@ filters are supported: In the case where an ID is used, the ID may be in its full or shortened form. -**--since**=*timestamp* +#### **--since**=*timestamp* Show all events created since the given timestamp -**--until**=*timestamp* +#### **--until**=*timestamp* Show all events created until the given timestamp diff --git a/docs/source/markdown/podman-exec.1.md b/docs/source/markdown/podman-exec.1.md index f44a3d3d9..17d620cf8 100644 --- a/docs/source/markdown/podman-exec.1.md +++ b/docs/source/markdown/podman-exec.1.md @@ -13,39 +13,39 @@ podman\-exec - Execute a command in a running container ## OPTIONS -**--detach**, **-d** +#### **--detach**, **-d** Start the exec session, but do not attach to it. The command will run in the background and the exec session will be automatically removed when it completes. The **podman exec** command will print the ID of the exec session and exit immediately after it starts. -**--detach-keys**=*sequence* +#### **--detach-keys**=*sequence* Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*. -**--env**, **-e** +#### **--env**, **-e** You may specify arbitrary environment variables that are available for the command to be executed. -**--env-file**=*file* +#### **--env-file**=*file* Read in a line delimited file of environment variables. -**--interactive**, **-i**=*true|false* +#### **--interactive**, **-i**=*true|false* When set to true, keep stdin open even if not attached. The default is *false*. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--preserve-fds**=*N* +#### **--preserve-fds**=*N* Pass down to the process N additional file descriptors (in addition to 0, 1, 2). The total FDs will be 3+N. -**--privileged** +#### **--privileged** Give extended privileges to this container. The default is *false*. @@ -61,17 +61,17 @@ points, Apparmor/SELinux separation, and Seccomp filters are all disabled. Rootless containers cannot have more privileges than the account that launched them. -**--tty**, **-t** +#### **--tty**, **-t** Allocate a pseudo-TTY. -**--user**, **-u** +#### **--user**, **-u** Sets the username or UID used and optionally the groupname or GID for the specified command. The following examples are all valid: --user [user | user:group | uid | uid:gid | user:gid | uid:group ] -**--workdir**, **-w**=*path* +#### **--workdir**, **-w**=*path* Working directory inside the container diff --git a/docs/source/markdown/podman-export.1.md b/docs/source/markdown/podman-export.1.md index 4286d0e2f..647c25770 100644 --- a/docs/source/markdown/podman-export.1.md +++ b/docs/source/markdown/podman-export.1.md @@ -22,11 +22,11 @@ Note: `:` is a restricted character and cannot be part of the file name. ## OPTIONS -**--output**, **-o** +#### **--output**, **-o** Write to a file, default is STDOUT -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-generate-kube.1.md b/docs/source/markdown/podman-generate-kube.1.md index 47d6e0445..6fad89b1f 100644 --- a/docs/source/markdown/podman-generate-kube.1.md +++ b/docs/source/markdown/podman-generate-kube.1.md @@ -14,11 +14,11 @@ Note that the generated Kubernetes YAML file can be used to re-run the deploymen ## OPTIONS -**--filename**, **-f**=**filename** +#### **--filename**, **-f**=**filename** Output to the given file, instead of STDOUT. If the file already exists, `generate kube` will refuse to replace it and return an error. -**--service**, **-s** +#### **--service**, **-s** Generate a Kubernetes service object in addition to the Pods. Used to generate a Service specification for the corresponding Pod output. In particular, if the object has portmap bindings, the service specification will include a NodePort declaration to expose the service. A random port is assigned by Podman in the specification. diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md index f95c57399..445888d30 100644 --- a/docs/source/markdown/podman-generate-systemd.1.md +++ b/docs/source/markdown/podman-generate-systemd.1.md @@ -14,42 +14,42 @@ _Note: If you use this command with the remote client, you would still have to p ## OPTIONS -**--files**, **-f** +#### **--files**, **-f** Generate files instead of printing to stdout. The generated files are named {container,pod}-{ID,name}.service and will be placed in the current working directory. Note: On a system with SELinux enabled, the generated files will inherit contexts from the current working directory. Depending on the SELinux setup, changes to the generated files using `restorecon`, `chcon`, or `semanage` may be required to allow systemd to access these files. Alternatively, use the `-Z` option when running `mv` or `cp`. -**--format**=*format* +#### **--format**=*format* Print the created units in specified format (json). If `--files` is specified the paths to the created files will be printed instead of the unit content. -**--name**, **-n** +#### **--name**, **-n** Use the name of the container for the start, stop, and description in the unit file -**--new** +#### **--new** Using this flag will yield unit files that do not expect containers and pods to exist. Instead, new containers and pods are created based on their configuration files. The unit files are created best effort and may need to be further edited; please review the generated files carefully before using them in production. -**--time**, **-t**=*value* +#### **--time**, **-t**=*value* Override the default stop timeout for the container with the given value. -**--restart-policy**=*policy* +#### **--restart-policy**=*policy* Set the systemd restart policy. The restart-policy must be one of: "no", "on-success", "on-failure", "on-abnormal", "on-watchdog", "on-abort", or "always". The default policy is *on-failure*. -**--container-prefix**=*prefix* +#### **--container-prefix**=*prefix* Set the systemd unit name prefix for containers. The default is *container*. -**--pod-prefix**=*prefix* +#### **--pod-prefix**=*prefix* Set the systemd unit name prefix for pods. The default is *pod*. -**--separator**=*separator* +#### **--separator**=*separator* Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is *-*. diff --git a/docs/source/markdown/podman-healthcheck-run.1.md b/docs/source/markdown/podman-healthcheck-run.1.md index 546d847eb..fa10d5dca 100644 --- a/docs/source/markdown/podman-healthcheck-run.1.md +++ b/docs/source/markdown/podman-healthcheck-run.1.md @@ -21,7 +21,7 @@ Possible errors that can occur during the healthcheck are: * container is not running ## OPTIONS -**--help** +#### **--help** Print usage statement diff --git a/docs/source/markdown/podman-history.1.md b/docs/source/markdown/podman-history.1.md index 26b213af9..2dd41e9f5 100644 --- a/docs/source/markdown/podman-history.1.md +++ b/docs/source/markdown/podman-history.1.md @@ -29,26 +29,26 @@ Valid placeholders for the Go template are listed below: ## OPTIONS -**--human**, **-H**=*true|false* +#### **--human**, **-H**=*true|false* Display sizes and dates in human readable format (default *true*). -**--no-trunc**=*true|false* +#### **--no-trunc**=*true|false* Do not truncate the output (default *false*). -**--notruncate** +#### **--notruncate** Do not truncate the output -**--quiet**, **-q**=*true|false* +#### **--quiet**, **-q**=*true|false* Print the numeric IDs only (default *false*). -**--format**=*format* +#### **--format**=*format* Alter the output for a format like 'json' or a Go template. -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-image-diff.1.md b/docs/source/markdown/podman-image-diff.1.md index 1e7397cd8..9b1dfa45a 100644 --- a/docs/source/markdown/podman-image-diff.1.md +++ b/docs/source/markdown/podman-image-diff.1.md @@ -11,7 +11,7 @@ Displays changes on a container or image's filesystem. The container or image w ## OPTIONS -**--format** +#### **--format** Alter the output into a different format. The only valid format for diff is `json`. diff --git a/docs/source/markdown/podman-image-exists.1.md b/docs/source/markdown/podman-image-exists.1.md index 877324cd1..5d5cb1647 100644 --- a/docs/source/markdown/podman-image-exists.1.md +++ b/docs/source/markdown/podman-image-exists.1.md @@ -14,7 +14,7 @@ was an issue accessing the local storage. ## OPTIONS -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-image-mount.1.md b/docs/source/markdown/podman-image-mount.1.md index f98b46571..8cb9684a7 100644 --- a/docs/source/markdown/podman-image-mount.1.md +++ b/docs/source/markdown/podman-image-mount.1.md @@ -22,11 +22,11 @@ returned. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Mount all images. -**--format**=*format* +#### **--format**=*format* Print the mounted images in specified format (json). diff --git a/docs/source/markdown/podman-image-prune.1.md b/docs/source/markdown/podman-image-prune.1.md index d4fbe45c3..d8558d244 100644 --- a/docs/source/markdown/podman-image-prune.1.md +++ b/docs/source/markdown/podman-image-prune.1.md @@ -14,19 +14,19 @@ does not have any containers based on it. The image prune command does not prune cache images that only use layers that are necessary for other images. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Remove dangling images and images that have no associated containers. -**--filter**=*filters* +#### **--filter**=*filters* Provide filter values. -**--force**, **-f** +#### **--force**, **-f** Do not provide an interactive prompt for container removal. -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-image-sign.1.md b/docs/source/markdown/podman-image-sign.1.md index fa75691bc..1bd6e5b9d 100644 --- a/docs/source/markdown/podman-image-sign.1.md +++ b/docs/source/markdown/podman-image-sign.1.md @@ -13,20 +13,20 @@ derived from the registry configuration files in /etc/containers/registries.d. B ## OPTIONS -**--help**, **-h** +#### **--help**, **-h** Print usage statement. -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--directory**, **-d**=*dir* +#### **--directory**, **-d**=*dir* Store the signatures in the specified directory. Default: /var/lib/containers/sigstore -**--sign-by**=*identity* +#### **--sign-by**=*identity* Override the default identity of the signature. diff --git a/docs/source/markdown/podman-image-tree.1.md b/docs/source/markdown/podman-image-tree.1.md index c4624e05c..9a52e8444 100644 --- a/docs/source/markdown/podman-image-tree.1.md +++ b/docs/source/markdown/podman-image-tree.1.md @@ -13,11 +13,11 @@ If you do not provide a *tag*, Podman will default to `latest` for the *image*. Layers are indicated with image tags as `Top Layer of`, when the tag is known locally. ## OPTIONS -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--whatrequires** +#### **--whatrequires** Show all child images and layers of the specified image diff --git a/docs/source/markdown/podman-image-trust.1.md b/docs/source/markdown/podman-image-trust.1.md index 8b80ca602..222ecf912 100644 --- a/docs/source/markdown/podman-image-trust.1.md +++ b/docs/source/markdown/podman-image-trust.1.md @@ -56,7 +56,7 @@ Trust may be updated using the command **podman image trust set** for an existin ## show OPTIONS -**--raw** +#### **--raw** Output trust policy file as raw JSON **-j**, **--json** diff --git a/docs/source/markdown/podman-image-unmount.1.md b/docs/source/markdown/podman-image-unmount.1.md index c026c49ac..62e879fa1 100644 --- a/docs/source/markdown/podman-image-unmount.1.md +++ b/docs/source/markdown/podman-image-unmount.1.md @@ -19,11 +19,11 @@ counter reaches zero indicating no other processes are using the mount. An unmount can be forced with the --force flag. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** All of the currently mounted images will be unmounted. -**--force**, **-f** +#### **--force**, **-f** Force the unmounting of specified images' root file system, even if other processes have mounted it. diff --git a/docs/source/markdown/podman-images.1.md b/docs/source/markdown/podman-images.1.md index 379f7573e..fe5ad6843 100644 --- a/docs/source/markdown/podman-images.1.md +++ b/docs/source/markdown/podman-images.1.md @@ -19,7 +19,7 @@ Displays locally stored images, their names, and their IDs. Show all images (by default filter out the intermediate image layers). The default is false. -**--digests** +#### **--digests** Show image digests @@ -47,7 +47,7 @@ Filter output based on conditions provided **reference=** Filter by image name, specified as regular expressions. -**--format**=*format* +#### **--format**=*format* Change the default output format. This can be of a supported type like 'json' or a Go template. @@ -64,23 +64,23 @@ Valid placeholders for the Go template are listed below: | .Size | Size of layer on disk | | .History | History of the image layer | -**--history** +#### **--history** Display the history of image names. If an image gets re-tagged or untagged, then the image name history gets prepended (latest image first). This is especially useful when undoing a tag operation or an image does not contain any name because it has been untagged. -**--noheading**, **-n** +#### **--noheading**, **-n** Omit the table headings from the listing of images. -**--no-trunc** +#### **--no-trunc** Do not truncate output. -**--quiet**, **-q** +#### **--quiet**, **-q** Lists only the image IDs. -**--sort**=*sort* +#### **--sort**=*sort* Sort by created, id, repository, size or tag (default: created) diff --git a/docs/source/markdown/podman-import.1.md b/docs/source/markdown/podman-import.1.md index b6d88aeac..db0bad241 100644 --- a/docs/source/markdown/podman-import.1.md +++ b/docs/source/markdown/podman-import.1.md @@ -25,11 +25,11 @@ Apply the following possible instructions to the created image: Can be set multiple times -**--message**, **-m**=*message* +#### **--message**, **-m**=*message* Set commit message for imported image -**--quiet**, **-q** +#### **--quiet**, **-q** Shows progress on the import @@ -37,7 +37,7 @@ Shows progress on the import Print additional debugging information -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-init.1.md b/docs/source/markdown/podman-init.1.md index 3b49cfb99..e37902e13 100644 --- a/docs/source/markdown/podman-init.1.md +++ b/docs/source/markdown/podman-init.1.md @@ -18,11 +18,11 @@ This can be used to inspect the container before it runs, or debug why a contain ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Initialize all containers. Containers that have already initialized (including containers that have been started and are running) are ignored. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. diff --git a/docs/source/markdown/podman-inspect.1.md b/docs/source/markdown/podman-inspect.1.md index eb7cf74c6..d0e2fbc99 100644 --- a/docs/source/markdown/podman-inspect.1.md +++ b/docs/source/markdown/podman-inspect.1.md @@ -24,17 +24,17 @@ For more inspection options, see: ## OPTIONS -**--type**, **-t**=*type* +#### **--type**, **-t**=*type* Return JSON for the specified type. Type can be 'container', 'image', 'volume', 'network', 'pod', or 'all' (default: all) (Only meaningful when invoked as *podman inspect*) -**--format**, **-f**=*format* +#### **--format**, **-f**=*format* Format the output using the given Go template. The keys of the returned JSON can be used as the values for the --format flag (see examples below). -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. @@ -43,7 +43,7 @@ This option can be used to inspect the latest pod created when used with --type The latest option is not supported on the remote client or when invoked as *podman image inspect*. -**--size**, **-s** +#### **--size**, **-s** In addition to normal output, display the total file size if the type is a container. diff --git a/docs/source/markdown/podman-kill.1.md b/docs/source/markdown/podman-kill.1.md index 010c04edc..5956c03da 100644 --- a/docs/source/markdown/podman-kill.1.md +++ b/docs/source/markdown/podman-kill.1.md @@ -12,18 +12,18 @@ podman\-kill - Kill the main process in one or more containers The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Signal all running containers. This does not include paused containers. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--signal**, **-s** +#### **--signal**, **-s** Signal to send to the container. For more information on Linux signals, refer to *man signal(7)*. diff --git a/docs/source/markdown/podman-load.1.md b/docs/source/markdown/podman-load.1.md index 308a3493b..cdc99fbf2 100644 --- a/docs/source/markdown/podman-load.1.md +++ b/docs/source/markdown/podman-load.1.md @@ -26,7 +26,7 @@ Note: `:` is a restricted character and cannot be part of the file name. ## OPTIONS -**--input**, **-i**=*input* +#### **--input**, **-i**=*input* Read from archive file, default is STDIN. @@ -34,11 +34,11 @@ The remote client requires the use of this option. NOTE: Use the environment variable `TMPDIR` to change the temporary storage location of container images. Podman defaults to use `/var/tmp`. -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress the progress output -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-login.1.md b/docs/source/markdown/podman-login.1.md index 7c09d99fe..89ef289e3 100644 --- a/docs/source/markdown/podman-login.1.md +++ b/docs/source/markdown/podman-login.1.md @@ -28,41 +28,41 @@ For more details about format and configurations of the auth.json file, please r ## OPTIONS -**--password**, **-p**=*password* +#### **--password**, **-p**=*password* Password for registry -**--password-stdin** +#### **--password-stdin** Take the password from stdin -**--username**, **-u**=*username* +#### **--username**, **-u**=*username* Username for registry -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json. Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--get-login** +#### **--get-login** Return the logged-in user for the registry. Return error if no login is found. -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--tls-verify**=*true|false* +#### **--tls-verify**=*true|false* Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-logout.1.md b/docs/source/markdown/podman-logout.1.md index 25f6d97b1..c35c4856b 100644 --- a/docs/source/markdown/podman-logout.1.md +++ b/docs/source/markdown/podman-logout.1.md @@ -21,18 +21,18 @@ All the cached credentials can be removed by setting the **all** flag. ## OPTIONS -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json. Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--all**, **-a** +#### **--all**, **-a** Remove the cached credentials for all registries in the auth file -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-logs.1.md b/docs/source/markdown/podman-logs.1.md index bcfc0bae8..bd8a01840 100644 --- a/docs/source/markdown/podman-logs.1.md +++ b/docs/source/markdown/podman-logs.1.md @@ -15,7 +15,7 @@ any logs at the time you execute podman logs). ## OPTIONS -**--follow**, **-f** +#### **--follow**, **-f** Follow log output. Default is false. @@ -23,7 +23,7 @@ Note: If you are following a container which is removed `podman container rm` or removed on exit `podman run --rm ...`, then there is a chance the the log file will be removed before `podman logs` reads the final content. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. @@ -34,19 +34,19 @@ The latest option is not supported on the remote client. Output the container name in the log -**--since**=*TIMESTAMP* +#### **--since**=*TIMESTAMP* Show logs since TIMESTAMP. The --since option can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the client machine's time. Supported formats for date formatted time stamps include RFC3339Nano, RFC3339, 2006-01-02T15:04:05, 2006-01-02T15:04:05.999999999, 2006-01-02Z07:00, and 2006-01-02. -**--tail**=*LINES* +#### **--tail**=*LINES* Output the specified number of LINES at the end of the logs. LINES must be an integer. Defaults to -1, which prints all lines -**--timestamps**, **-t** +#### **--timestamps**, **-t** Show timestamps in the log outputs. The default is false diff --git a/docs/source/markdown/podman-manifest-add.1.md b/docs/source/markdown/podman-manifest-add.1.md index 4c0bad2ae..6e6409765 100644 --- a/docs/source/markdown/podman-manifest-add.1.md +++ b/docs/source/markdown/podman-manifest-add.1.md @@ -15,25 +15,25 @@ The list image's ID. ## OPTIONS -**--all** +#### **--all** If the image which should be added to the list or index is itself a list or index, add all of the contents to the local list. By default, only one image from such a list or index will be added to the list or index. Combining *--all* with any of the other options described below is NOT recommended. -**--annotation** *annotation=value* +#### **--annotation** *annotation=value* Set an annotation on the entry for the newly-added image. -**--arch** +#### **--arch** Override the architecture which the list or index records as a requirement for the image. If *imageName* refers to a manifest list or image index, the architecture information will be retrieved from it. Otherwise, it will be retrieved from the image's configuration information. -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. @@ -41,39 +41,39 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--creds**=*creds* +#### **--creds**=*creds* The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--features** +#### **--features** Specify the features list which the list or index records as requirements for the image. This option is rarely used. -**--os** +#### **--os** Override the OS which the list or index records as a requirement for the image. If *imagename* refers to a manifest list or image index, the OS information will be retrieved from it. Otherwise, it will be retrieved from the image's configuration information. -**--os-version** +#### **--os-version** Specify the OS version which the list or index records as a requirement for the image. This option is rarely used. -**--tls-verify** +#### **--tls-verify** Require HTTPS and verify certificates when talking to container registries (defaults to true). -**--variant** +#### **--variant** Specify the variant which the list or index records for the image. This option is typically used to distinguish between multiple entries which share the same diff --git a/docs/source/markdown/podman-manifest-annotate.1.md b/docs/source/markdown/podman-manifest-annotate.1.md index 25ad4642e..2126b71ec 100644 --- a/docs/source/markdown/podman-manifest-annotate.1.md +++ b/docs/source/markdown/podman-manifest-annotate.1.md @@ -12,39 +12,39 @@ Adds or updates information about an image included in a manifest list or image ## OPTIONS -**--annotation** *annotation=value* +#### **--annotation** *annotation=value* Set an annotation on the entry for the specified image. -**--arch** +#### **--arch** Override the architecture which the list or index records as a requirement for the image. This is usually automatically retrieved from the image's configuration information, so it is rarely necessary to use this option. -**--features** +#### **--features** Specify the features list which the list or index records as requirements for the image. This option is rarely used. -**--os** +#### **--os** Override the OS which the list or index records as a requirement for the image. This is usually automatically retrieved from the image's configuration information, so it is rarely necessary to use this option. -**--os-features** +#### **--os-features** Specify the OS features list which the list or index records as requirements for the image. This option is rarely used. -**--os-version** +#### **--os-version** Specify the OS version which the list or index records as a requirement for the image. This option is rarely used. -**--variant** +#### **--variant** Specify the variant which the list or index records for the image. This option is typically used to distinguish between multiple entries which share the same diff --git a/docs/source/markdown/podman-manifest-create.1.md b/docs/source/markdown/podman-manifest-create.1.md index 537a641f2..3a3d5e4b0 100644 --- a/docs/source/markdown/podman-manifest-create.1.md +++ b/docs/source/markdown/podman-manifest-create.1.md @@ -16,7 +16,7 @@ index. ## OPTIONS -**--all** +#### **--all** If any of the images which should be added to the new list or index are themselves lists or indexes, add all of their contents. By default, only one diff --git a/docs/source/markdown/podman-manifest-push.1.md b/docs/source/markdown/podman-manifest-push.1.md index 9cf0b159c..0c1e5ea04 100644 --- a/docs/source/markdown/podman-manifest-push.1.md +++ b/docs/source/markdown/podman-manifest-push.1.md @@ -14,12 +14,12 @@ The list image's ID and the digest of the image's manifest. ## OPTIONS -**--all** +#### **--all** Push the images mentioned in the manifest list or image index, in addition to the list or index itself. -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. @@ -27,42 +27,42 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--creds**=*creds* +#### **--creds**=*creds* The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--digestfile**=*Digestfile* +#### **--digestfile**=*Digestfile* After copying the image, write the digest of the resulting image to the file. -**--format**, **-f**=*format* +#### **--format**, **-f**=*format* Manifest list type (oci or v2s2) to use when pushing the list (default is oci). -**--purge** +#### **--purge** Delete the manifest list or image index from local storage if pushing succeeds. -**--quiet**, **-q** +#### **--quiet**, **-q** When writing the manifest, suppress progress output -**--remove-signatures** +#### **--remove-signatures** Don't copy signatures when pushing images. -**--sign-by**=*fingerprint* +#### **--sign-by**=*fingerprint* Sign the pushed images using the GPG key that matches the specified fingerprint. -**--tls-verify** +#### **--tls-verify** Require HTTPS and verify certificates when talking to container registries. (defaults to true) diff --git a/docs/source/markdown/podman-mount.1.md b/docs/source/markdown/podman-mount.1.md index a6ed3f10d..3e7aeaa32 100644 --- a/docs/source/markdown/podman-mount.1.md +++ b/docs/source/markdown/podman-mount.1.md @@ -26,15 +26,15 @@ returned. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Mount all podman containers. (External containers will not be mounted) -**--format**=*format* +#### **--format**=*format* Print the mounted containers in specified format (json). -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last @@ -42,7 +42,7 @@ started container could be from either of those methods. The latest option is not supported on the remote client. -**--notruncate** +#### **--notruncate** Do not truncate IDs in output. diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md index 0a7ea0586..4d52749fa 100644 --- a/docs/source/markdown/podman-network-create.1.md +++ b/docs/source/markdown/podman-network-create.1.md @@ -17,7 +17,7 @@ If no options are provided, Podman will assign a free subnet and name for your n Upon completion of creating the network, Podman will display the path to the newly added network file. ## OPTIONS -**--disable-dns** +#### **--disable-dns** Disables the DNS plugin for this network which if enabled, can perform container to container name resolution. @@ -26,30 +26,30 @@ resolution. Driver to manage the network (default "bridge"). Currently only `bridge` is supported. -**--gateway** +#### **--gateway** Define a gateway for the subnet. If you want to provide a gateway address, you must also provide a *subnet* option. -**--internal** +#### **--internal** Restrict external access of this network -**--ip-range** +#### **--ip-range** Allocate container IP from a range. The range must be a complete subnet and in CIDR notation. The *ip-range* option must be used with a *subnet* option. -**--macvlan** +#### **--macvlan** Create a *Macvlan* based connection rather than a classic bridge. You must pass an interface name from the host for the Macvlan connection. -**--subnet** +#### **--subnet** The subnet in CIDR notation. -**--ipv6** +#### **--ipv6** Enable IPv6 (Dual Stack) networking. You must pass a IPv6 subnet. The *subnet* option must be used with the *ipv6* option. diff --git a/docs/source/markdown/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md index c75c6788a..47d647b3f 100644 --- a/docs/source/markdown/podman-network-inspect.1.md +++ b/docs/source/markdown/podman-network-inspect.1.md @@ -10,7 +10,7 @@ podman\-network\-inspect - Displays the raw CNI network configuration for one or Display the raw (JSON format) network configuration. This command is not available for rootless users. ## OPTIONS -**--format**, **-f** +#### **--format**, **-f** Pretty-print networks to JSON or using a Go template. diff --git a/docs/source/markdown/podman-network-ls.1.md b/docs/source/markdown/podman-network-ls.1.md index 7b20cf5e0..34b40b3ae 100644 --- a/docs/source/markdown/podman-network-ls.1.md +++ b/docs/source/markdown/podman-network-ls.1.md @@ -10,15 +10,15 @@ podman\-network\-ls - Display a summary of CNI networks Displays a list of existing podman networks. This command is not available for rootless users. ## OPTIONS -**--quiet**, **-q** +#### **--quiet**, **-q** The `quiet` option will restrict the output to only the network names. -**--format**, **-f** +#### **--format**, **-f** Pretty-print networks to JSON or using a Go template. -**--filter** +#### **--filter** Provide filter values (e.g. 'name=podman'). diff --git a/docs/source/markdown/podman-network-rm.1.md b/docs/source/markdown/podman-network-rm.1.md index 616bb2514..ad4bc11e2 100644 --- a/docs/source/markdown/podman-network-rm.1.md +++ b/docs/source/markdown/podman-network-rm.1.md @@ -10,7 +10,7 @@ podman\-network\-rm - Remove one or more CNI networks Delete one or more Podman networks. ## OPTIONS -**--force**, **-f** +#### **--force**, **-f** The `force` option will remove all containers that use the named network. If the container is running, the container will be stopped and removed. diff --git a/docs/source/markdown/podman-pause.1.md b/docs/source/markdown/podman-pause.1.md index dfd4da416..123362822 100644 --- a/docs/source/markdown/podman-pause.1.md +++ b/docs/source/markdown/podman-pause.1.md @@ -13,7 +13,7 @@ Pauses all the processes in one or more containers. You may use container IDs o ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Pause all running containers. diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md index 97b0dc09a..d595afb3e 100644 --- a/docs/source/markdown/podman-play-kube.1.md +++ b/docs/source/markdown/podman-play-kube.1.md @@ -17,7 +17,7 @@ Note: HostPath volume types created by play kube will be given an SELinux privat ## OPTIONS -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. @@ -25,42 +25,42 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--configmap**=*path* +#### **--configmap**=*path* Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod. Note: The *--configmap* option can be used multiple times or a comma-separated list of paths can be used to pass multiple Kubernetes configmap YAMLs. -**--creds** +#### **--creds** The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--network**=*cni networks* +#### **--network**=*cni networks* A comma-separated list of the names of CNI networks the pod should join. -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress output information when pulling images -**--seccomp-profile-root**=*path* +#### **--seccomp-profile-root**=*path* Directory path for seccomp profiles (default: "/var/lib/kubelet/seccomp"). (Not available for remote commands) -**--tls-verify**=*true|false* +#### **--tls-verify**=*true|false* Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md index 7b0902c19..1e1724aeb 100644 --- a/docs/source/markdown/podman-pod-create.1.md +++ b/docs/source/markdown/podman-pod-create.1.md @@ -15,51 +15,51 @@ containers added to it. The pod id is printed to STDOUT. You can then use ## OPTIONS -**--add-host**=_host_:_ip_ +#### **--add-host**=_host_:_ip_ Add a host to the /etc/hosts file shared between all containers in the pod. -**--cgroup-parent**=*path* +#### **--cgroup-parent**=*path* Path to cgroups under which the cgroup for the pod will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist. -**--dns**=*ipaddr* +#### **--dns**=*ipaddr* Set custom DNS servers in the /etc/resolv.conf file that will be shared between all containers in the pod. A special option, "none" is allowed which disables creation of /etc/resolv.conf for the pod. -**--dns-opt**=*option* +#### **--dns-opt**=*option* Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod. -**--dns-search**=*domain* +#### **--dns-search**=*domain* Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod. -**--help** +#### **--help** Print usage statement. -**--hostname**=name +#### **--hostname**=name Set a hostname to the pod -**--infra**=**true**|**false** +#### **--infra**=**true**|**false** Create an infra container and associate it with the pod. An infra container is a lightweight container used to coordinate the shared kernel namespace of a pod. Default: true. -**--infra-conmon-pidfile**=*file* +#### **--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. -**--infra-command**=*command* +#### **--infra-command**=*command* The command that will be run to start the infra container. Default: "/pause". -**--infra-image**=*image* +#### **--infra-image**=*image* The image that will be created for the infra container. Default: "k8s.gcr.io/pause:3.1". -**--ip**=*ipaddr* +#### **--ip**=*ipaddr* Set a static IP for the pod's shared network. @@ -67,11 +67,11 @@ Set a static IP for the pod's shared network. Add metadata to a pod (e.g., --label com.example.key=value). -**--label-file**=*label* +#### **--label-file**=*label* Read in a line delimited file of labels. -**--mac-address**=*address* +#### **--mac-address**=*address* Set a static MAC address for the pod's shared network. @@ -79,7 +79,7 @@ Set a static MAC address for the pod's shared network. Assign a name to the pod. -**--network**=*mode* +#### **--network**=*mode* Set network mode for the pod. Supported values are - `bridge`: Create a network stack on the default bridge. This is the default for rootful containers. @@ -96,11 +96,11 @@ Set network mode for the pod. Supported values are - **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default. - **port_handler=slirp4netns**: Use the slirp4netns port forwarding. -**--no-hosts**=**true**|**false** +#### **--no-hosts**=**true**|**false** Disable creation of /etc/hosts for the pod. -**--pod-id-file**=*path* +#### **--pod-id-file**=*path* Write the pod ID to the file. @@ -115,11 +115,11 @@ Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPO NOTE: This cannot be modified once the pod is created. -**--replace**=**true**|**false** +#### **--replace**=**true**|**false** If another pod with the same name already exists, replace and remove it. The default is **false**. -**--share**=*namespace* +#### **--share**=*namespace* A comma delimited list of kernel namespaces to share. If none or "" is specified, no namespaces will be shared. The namespaces to choose from are ipc, net, pid, uts. diff --git a/docs/source/markdown/podman-pod-inspect.1.md b/docs/source/markdown/podman-pod-inspect.1.md index bc04b2b32..c35ebee65 100644 --- a/docs/source/markdown/podman-pod-inspect.1.md +++ b/docs/source/markdown/podman-pod-inspect.1.md @@ -11,7 +11,7 @@ Displays configuration and state information about a given pod. It also display that belong to the pod. ## OPTIONS -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman to run pods such as CRI-O, the last started pod could be from either of those methods. diff --git a/docs/source/markdown/podman-pod-kill.1.md b/docs/source/markdown/podman-pod-kill.1.md index 596e15cea..d791b7cbd 100644 --- a/docs/source/markdown/podman-pod-kill.1.md +++ b/docs/source/markdown/podman-pod-kill.1.md @@ -10,18 +10,18 @@ podman\-pod\-kill - Kill the main process of each container in one or more pods The main process of each container inside the pods specified will be sent SIGKILL, or any signal specified with option --signal. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Sends signal to all containers associated with a pod. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman to run pods such as CRI-O, the last started pod could be from either of those methods. The latest option is not supported on the remote client. -**--signal**, **-s** +#### **--signal**, **-s** Signal to send to the containers in the pod. For more information on Linux signals, refer to *man signal(7)*. diff --git a/docs/source/markdown/podman-pod-pause.1.md b/docs/source/markdown/podman-pod-pause.1.md index 9533ed4a1..fc1727737 100644 --- a/docs/source/markdown/podman-pod-pause.1.md +++ b/docs/source/markdown/podman-pod-pause.1.md @@ -11,11 +11,11 @@ Pauses all the running processes in the containers of one or more pods. You may ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Pause all pods. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, pause the last created pod. diff --git a/docs/source/markdown/podman-pod-prune.1.md b/docs/source/markdown/podman-pod-prune.1.md index 5b4c4661c..e90164c15 100644 --- a/docs/source/markdown/podman-pod-prune.1.md +++ b/docs/source/markdown/podman-pod-prune.1.md @@ -11,7 +11,7 @@ podman-pod-prune - Remove all stopped pods and their containers ## OPTIONS -**--force**, **-f** +#### **--force**, **-f** Force removal of all running pods and their containers. The default is false. ## EXAMPLES diff --git a/docs/source/markdown/podman-pod-ps.1.md b/docs/source/markdown/podman-pod-ps.1.md index 3df4403b7..94747cd10 100644 --- a/docs/source/markdown/podman-pod-ps.1.md +++ b/docs/source/markdown/podman-pod-ps.1.md @@ -26,37 +26,37 @@ By default it lists: ## OPTIONS -**--ctr-names** +#### **--ctr-names** Includes the container names in the container info field -**--ctr-ids** +#### **--ctr-ids** Includes the container IDs in the container info field -**--ctr-status** +#### **--ctr-status** Includes the container statuses in the container info field -**--latest**, **-l** +#### **--latest**, **-l** Show the latest pod created (all states) The latest option is not supported on the remote client. -**--no-trunc** +#### **--no-trunc** Display the extended information -**--ns** +#### **--ns** Display namespace information of the pod -**--quiet**, **-q** +#### **--quiet**, **-q** Print the numeric IDs of the pods only -**--format**=*format* +#### **--format**=*format* Pretty-print containers to JSON or using a Go template @@ -72,13 +72,13 @@ Valid placeholders for the Go template are listed below: | .Cgroup | Cgroup path of pod | | .Created | Creation time of pod | | .InfraID | Pod infra container ID | -**--sort** +#### **--sort** Sort by created, ID, name, status, or number of containers Default: created -**--filter**, **-f**=*filter* +#### **--filter**, **-f**=*filter* Filter output based on conditions given @@ -94,7 +94,7 @@ Valid filters are listed below: | ctr-status | Container status within the pod | | ctr-number | Number of containers in the pod | -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-pod-restart.1.md b/docs/source/markdown/podman-pod-restart.1.md index 57f479102..19c46b9de 100644 --- a/docs/source/markdown/podman-pod-restart.1.md +++ b/docs/source/markdown/podman-pod-restart.1.md @@ -14,11 +14,11 @@ When restarting multiple pods, an error from restarting one pod will not effect ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Restarts all pods -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, restart the last created pod. diff --git a/docs/source/markdown/podman-pod-rm.1.md b/docs/source/markdown/podman-pod-rm.1.md index dd89694ec..4ca113cf7 100644 --- a/docs/source/markdown/podman-pod-rm.1.md +++ b/docs/source/markdown/podman-pod-rm.1.md @@ -11,27 +11,27 @@ podman\-pod\-rm - Remove one or more stopped pods and containers ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Remove all pods. Can be used in conjunction with \-f as well. -**--ignore**, **-i** +#### **--ignore**, **-i** Ignore errors when specified pods are not in the container store. A user might have decided to manually remove a pod which would lead to a failure during the ExecStop directive of a systemd service referencing that pod. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, remove the last created pod. The latest option is not supported on the remote client. -**--force**, **-f** +#### **--force**, **-f** Stop running containers and delete all stopped containers before removal of pod. -**--pod-id-file** +#### **--pod-id-file** Read pod ID from the specified file and remove the pod. Can be specified multiple times. diff --git a/docs/source/markdown/podman-pod-start.1.md b/docs/source/markdown/podman-pod-start.1.md index 6c6cfa2cf..38117ebe8 100644 --- a/docs/source/markdown/podman-pod-start.1.md +++ b/docs/source/markdown/podman-pod-start.1.md @@ -12,17 +12,17 @@ to be started. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Starts all pods -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, start the last created pod. The latest option is not supported on the remote client. -**--pod-id-file** +#### **--pod-id-file** Read pod ID from the specified file and start the pod. Can be specified multiple times. diff --git a/docs/source/markdown/podman-pod-stats.1.md b/docs/source/markdown/podman-pod-stats.1.md index f70a5a919..b1b23cd06 100644 --- a/docs/source/markdown/podman-pod-stats.1.md +++ b/docs/source/markdown/podman-pod-stats.1.md @@ -11,25 +11,25 @@ Display a live stream of containers in one or more pods resource usage statistic ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Show all containers. Only running containers are shown by default -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, use the last created pod. The latest option is not supported on the remote client. -**--no-reset** +#### **--no-reset** Do not clear the terminal/screen in between reporting intervals -**--no-stream** +#### **--no-stream** Disable streaming pod stats and only pull the first result, default setting is false -**--format**=*template* +#### **--format**=*template* Pretty-print container statistics to JSON or using a Go template diff --git a/docs/source/markdown/podman-pod-stop.1.md b/docs/source/markdown/podman-pod-stop.1.md index 7ce9ff941..df1b36fc4 100644 --- a/docs/source/markdown/podman-pod-stop.1.md +++ b/docs/source/markdown/podman-pod-stop.1.md @@ -11,27 +11,27 @@ Stop containers in one or more pods. You may use pod IDs or names as input. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Stops all pods -**--ignore**, **-i** +#### **--ignore**, **-i** Ignore errors when specified pods are not in the container store. A user might have decided to manually remove a pod which would lead to a failure during the ExecStop directive of a systemd service referencing that pod. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, stop the last created pod. The latest option is not supported on the remote client. -**--time**, **-t**=*time* +#### **--time**, **-t**=*time* Timeout to wait before forcibly stopping the containers in the pod. -**--pod-id-file** +#### **--pod-id-file** Read pod ID from the specified file and stop the pod. Can be specified multiple times. diff --git a/docs/source/markdown/podman-pod-top.1.md b/docs/source/markdown/podman-pod-top.1.md index 1f2ffd662..80334ebd0 100644 --- a/docs/source/markdown/podman-pod-top.1.md +++ b/docs/source/markdown/podman-pod-top.1.md @@ -11,11 +11,11 @@ Display the running processes of containers in a pod. The *format-descriptors* a ## OPTIONS -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, use the last created pod. diff --git a/docs/source/markdown/podman-pod-unpause.1.md b/docs/source/markdown/podman-pod-unpause.1.md index e0a88c2e3..0b3c2d384 100644 --- a/docs/source/markdown/podman-pod-unpause.1.md +++ b/docs/source/markdown/podman-pod-unpause.1.md @@ -11,11 +11,11 @@ Unpauses all the paused processes in the containers of one or more pods. You ma ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Unpause all pods. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the pod name or ID, unpause the last created pod. diff --git a/docs/source/markdown/podman-port.1.md b/docs/source/markdown/podman-port.1.md index c9833f447..9d56d5e8c 100644 --- a/docs/source/markdown/podman-port.1.md +++ b/docs/source/markdown/podman-port.1.md @@ -13,12 +13,12 @@ List port mappings for the *container* or lookup the public-facing port that is ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** List all known port mappings for running containers. When using this option, you cannot pass any container names or private ports/protocols as filters. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md index 90f147222..5869f2307 100644 --- a/docs/source/markdown/podman-ps.1.md +++ b/docs/source/markdown/podman-ps.1.md @@ -30,17 +30,17 @@ all the containers information. By default it lists: ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Show all the containers created by Podman, default is only running containers. Note: Podman shares containers storage with other tools such as Buildah and CRI-O. In some cases these `external` containers might also exist in the same storage. Use the `--external` option to see these external containers. External containers show the 'storage' status. -**--external** +#### **--external** Display external containers that are not controlled by Podman but are stored in containers storage. These external containers are generally created via other container technology such as Buildah or CRI-O and may depend on the same container images that Podman is also using. External containers are denoted with either a 'buildah' or 'storage' in the COMMAND and STATUS column of the ps output. Only used with the --all option. -**--filter**, **-f** +#### **--filter**, **-f** Filter what containers are shown in the output. Multiple filters can be given with multiple uses of the --filter flag. @@ -62,7 +62,7 @@ Valid filters are listed below: | volume | [VolumeName] or [MountpointDestination] Volume mounted in container | | health | [Status] healthy or unhealthy | -**--format**=*format* +#### **--format**=*format* Pretty-print containers to JSON or using a Go template @@ -84,54 +84,54 @@ Valid placeholders for the Go template are listed below: | .Labels | All the labels assigned to the container | | .Mounts | Volumes mounted in the container | -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--last**, **-n** +#### **--last**, **-n** Print the n last created containers (all states) -**--latest**, **-l** +#### **--latest**, **-l** Show the latest container created (all states) The latest option is not supported on the remote client. -**--namespace**, **--ns** +#### **--namespace**, **--ns** Display namespace information -**--no-trunc** +#### **--no-trunc** Display the extended information -**--pod**, **-p** +#### **--pod**, **-p** Display the pods the containers are associated with -**--quiet**, **-q** +#### **--quiet**, **-q** Print the numeric IDs of the containers only -**--sort** +#### **--sort** Sort by command, created, id, image, names, runningfor, size, or status", Note: Choosing size will sort by size of rootFs, not alphabetically like the rest of the options Default: created -**--size**, **-s** +#### **--size**, **-s** Display the total file size -**--sync** +#### **--sync** Force a sync of container state with the OCI runtime. In some cases, a container's state in the runtime can become out of sync with Podman's state. This will update Podman's state based on what the OCI runtime reports. Forcibly syncing is much slower, but can resolve inconsistent state issues. -**--watch**, **-w** +#### **--watch**, **-w** Refresh the output with current containers on an interval in seconds. diff --git a/docs/source/markdown/podman-pull.1.md b/docs/source/markdown/podman-pull.1.md index 9e3911704..130c54ba9 100644 --- a/docs/source/markdown/podman-pull.1.md +++ b/docs/source/markdown/podman-pull.1.md @@ -48,13 +48,13 @@ Images are stored in local image storage. ## OPTIONS -**--all-tags**, **a** +#### **--all-tags**, **a** All tagged images in the repository will be pulled. Note: When using the all-tags flag, Podman will not iterate over the search registries in the containers-registries.conf(5) but will always use docker.io for unqualified image names. -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. @@ -62,44 +62,44 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--creds**=*[username[:password]]* +#### **--creds**=*[username[:password]]* The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--disable-content-trust** +#### **--disable-content-trust** This is a Docker specific option to disable image verification to a Docker registry and is not supported by Podman. This flag is a NOOP and provided solely for scripting compatibility. -**--override-arch**=*ARCH* +#### **--override-arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. -**--override-os**=*OS* +#### **--override-os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -**--override-variant**=*VARIANT* +#### **--override-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. -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress output information when pulling images -**--tls-verify**=*true|false* +#### **--tls-verify**=*true|false* Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-push.1.md b/docs/source/markdown/podman-push.1.md index e9b63dc43..87e64858c 100644 --- a/docs/source/markdown/podman-push.1.md +++ b/docs/source/markdown/podman-push.1.md @@ -43,7 +43,7 @@ Images are pushed from those stored in local image storage. ## OPTIONS -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. @@ -51,50 +51,50 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--creds**=*[username[:password]]* +#### **--creds**=*[username[:password]]* The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--cert-dir**=*path* +#### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--compress** +#### **--compress** Compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type, compressed or uncompressed, as source) Note: This flag can only be set when using the **dir** transport -**--digestfile** *Digestfile* +#### **--digestfile** *Digestfile* After copying the image, write the digest of the resulting image to the file. (Not available for remote commands) -**--disable-content-trust** +#### **--disable-content-trust** This is a Docker specific option to disable image verification to a Docker registry and is not supported by Podman. This flag is a NOOP and provided solely for scripting compatibility. -**--format**, **-f**=*format* +#### **--format**, **-f**=*format* Manifest Type (oci, v2s1, or v2s2) to use when pushing an image to a directory using the 'dir:' transport (default is manifest type of source) Note: This flag can only be set when using the **dir** transport -**--quiet**, **-q** +#### **--quiet**, **-q** When writing the output image, suppress progress output -**--remove-signatures** +#### **--remove-signatures** Discard any pre-existing signatures in the image -**--sign-by**=*key* +#### **--sign-by**=*key* Add a signature at the destination using the specified key -**--tls-verify**=*true|false* +#### **--tls-verify**=*true|false* Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, diff --git a/docs/source/markdown/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md index b621c846a..1a6c7d3cc 100644 --- a/docs/source/markdown/podman-remote.1.md +++ b/docs/source/markdown/podman-remote.1.md @@ -25,15 +25,15 @@ The `containers.conf` file should be placed under `$HOME/.config/containers/cont ## GLOBAL OPTIONS -**--connection**=*name*, **-c** +#### **--connection**=*name*, **-c** Remote connection name -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--identity**=*path* +#### **--identity**=*path* Path to ssh identity file. If the identity file has been encrypted, Podman prompts the user for the passphrase. If no identity file is provided and no user is given, Podman defaults to the user running the podman command. @@ -44,11 +44,11 @@ Identity value resolution precedence: - environment variable `CONTAINER_SSHKEY`, if `CONTAINER_HOST` is found - `containers.conf` -**--log-level**=*level* +#### **--log-level**=*level* Log messages above specified level: debug, info, warn, error (default), fatal or panic -**--url**=*value* +#### **--url**=*value* URL to access Podman service (default from `containers.conf`, rootless "unix://run/user/$UID/podman/podman.sock" or as root "unix://run/podman/podman.sock). @@ -67,7 +67,7 @@ URL value resolution precedence: - `containers.conf` - `unix://run/podman/podman.sock` -**--version** +#### **--version** Print the version diff --git a/docs/source/markdown/podman-restart.1.md b/docs/source/markdown/podman-restart.1.md index 127aaa074..5f83bedde 100644 --- a/docs/source/markdown/podman-restart.1.md +++ b/docs/source/markdown/podman-restart.1.md @@ -14,16 +14,16 @@ Containers will be stopped if they are running and then restarted. Stopped containers will not be stopped and will only be started. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Restart all containers regardless of their current state. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--running** +#### **--running** Restart all containers that are already in the *running* state. **-t**, **--time**=*time* diff --git a/docs/source/markdown/podman-rm.1.md b/docs/source/markdown/podman-rm.1.md index 36904a128..cba9a0b49 100644 --- a/docs/source/markdown/podman-rm.1.md +++ b/docs/source/markdown/podman-rm.1.md @@ -14,15 +14,15 @@ Running or unusable containers will not be removed without the **-f** option. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Remove all containers. Can be used in conjunction with **-f** as well. -**--cidfile** +#### **--cidfile** Read container ID from the specified file and remove the container. Can be specified multiple times. -**--force**, **-f** +#### **--force**, **-f** Force the removal of running and paused containers. Forcing a container removal also removes containers from container storage even if the container is not known to podman. @@ -30,20 +30,20 @@ Containers could have been created by a different container engine. In addition, forcing can be used to remove unusable containers, e.g. containers whose OCI runtime has become unavailable. -**--ignore**, **-i** +#### **--ignore**, **-i** Ignore errors when specified containers are not in the container store. A user might have decided to manually remove a container which would lead to a failure during the ExecStop directive of a systemd service referencing that container. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--volumes**, **-v** +#### **--volumes**, **-v** Remove anonymous volumes associated with the container. This does not include named volumes created with **podman volume create**, or the **--volume** option of **podman run** and **podman create**. diff --git a/docs/source/markdown/podman-rmi.1.md b/docs/source/markdown/podman-rmi.1.md index 27fe3b235..765c1bd6d 100644 --- a/docs/source/markdown/podman-rmi.1.md +++ b/docs/source/markdown/podman-rmi.1.md @@ -13,11 +13,11 @@ Removes one or more locally stored images. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Remove all images in the local storage. -**--force**, **-f** +#### **--force**, **-f** This option will cause podman to remove all containers that are using the image before removing the image from the system. diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index 0166a344a..3098803c7 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -34,17 +34,17 @@ When running from a user defined network namespace, the _/etc/netns/NSNAME/resol will be used if it exists, otherwise _/etc/resolv.conf_ will be used. ## OPTIONS -**--add-host**=_host_:_ip_ +#### **--add-host**=_host_:_ip_ Add a line to container's _/etc/hosts_ for custom host-to-IP mapping. This option can be set multiple times. -**--annotation**=_key_=_value_ +#### **--annotation**=_key_=_value_ Add an annotation to the container. This option can be set multiple times. -**--attach**, **-a**=**stdin**|**stdout**|**stderr** +#### **--attach**, **-a**=**stdin**|**stdout**|**stderr** Attach to STDIN, STDOUT or STDERR. @@ -55,30 +55,30 @@ error. It can even pretend to be a TTY (this is what most commandline executables expect) and pass along signals. The **-a** option can be set for each of **stdin**, **stdout**, and **stderr**. -**--authfile**[=*path*] +#### **--authfile**[=*path*] Path to the authentication file. Default is *${XDG_RUNTIME_DIR}/containers/auth.json*. Note: You can also override the default path of the authentication file by setting the **REGISTRY_AUTH_FILE** environment variable. -**--blkio-weight**=*weight* +#### **--blkio-weight**=*weight* Block IO relative weight. The _weight_ is a value between **10** and **1000**. -**--blkio-weight-device**=*device*:*weight* +#### **--blkio-weight-device**=*device*:*weight* Block IO relative device weight. -**--cap-add**=*capability* +#### **--cap-add**=*capability* Add Linux capabilities. -**--cap-drop**=*capability* +#### **--cap-drop**=*capability* Drop Linux capabilities. -**--cgroupns**=*mode* +#### **--cgroupns**=*mode* Set the cgroup namespace mode for the container. @@ -89,7 +89,7 @@ Set the cgroup namespace mode for the container. If the host uses cgroups v1, the default is set to **host**. On cgroups v2, the default is **private**. -**--cgroups**=**enabled**|**disabled**|**no-conmon**|**split** +#### **--cgroups**=**enabled**|**disabled**|**no-conmon**|**split** Determines whether the container will create CGroups. @@ -100,23 +100,23 @@ The **disabled** option will force the container to not create CGroups, and thus The **no-conmon** option disables a new CGroup only for the **conmon** process. The **split** option splits the current cgroup in two sub-cgroups: one for conmon and one for the container payload. It is not possible to set **--cgroup-parent** with **split**. -**--cgroup-parent**=*path* +#### **--cgroup-parent**=*path* Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist. -**--cgroup-conf**=*KEY=VALUE* +#### **--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. -**--cidfile**=*file* +#### **--cidfile**=*file* Write the container ID to *file*. -**--conmon-pidfile**=*file* +#### **--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. -**--cpu-period**=*limit* +#### **--cpu-period**=*limit* Set the CPU period for the Completely Fair Scheduler (CFS), which is a duration in microseconds. Once the container's CPU quota is used up, it will @@ -127,7 +127,7 @@ On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error -**--cpu-quota**=*limit* +#### **--cpu-quota**=*limit* Limit the CPU Completely Fair Scheduler (CFS) quota. @@ -140,13 +140,13 @@ On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error -**--cpu-rt-period**=*microseconds* +#### **--cpu-rt-period**=*microseconds* Limit the CPU real-time period in microseconds. Limit the container's Real Time CPU usage. This flag tell the kernel to restrict the container's Real Time CPU usage to the period you specify. -**--cpu-rt-runtime**=*microseconds* +#### **--cpu-rt-runtime**=*microseconds* Limit the CPU real-time runtime in microseconds. @@ -155,7 +155,7 @@ Period of 1,000,000us and Runtime of 950,000us means that this container could c The sum of all runtimes across containers cannot exceed the amount allotted to the parent cgroup. -**--cpu-shares**=*shares* +#### **--cpu-shares**=*shares* CPU shares (relative weight). @@ -190,30 +190,30 @@ division of CPU shares: | 101 | {C1} | 1 | 100% of CPU1 | | 102 | {C1} | 2 | 100% of CPU2 | -**--cpus**=*number* +#### **--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**. +#### **--cpus** or **--cpu-period** and **--cpu-quota**. On some systems, changing the CPU limits may not be allowed for non-root users. For more details, see https://github.com/containers/podman/blob/master/troubleshooting.md#26-running-containers-with-cpu-limits-fails-with-a-permissions-error -**--cpuset-cpus**=*number* +#### **--cpuset-cpus**=*number* CPUs in which to allow execution. Can be specified as a comma-separated list (e.g. **0,1**), as a range (e.g. **0-3**), or any combination thereof (e.g. **0-3,7,11-15**). -**--cpuset-mems**=*nodes* +#### **--cpuset-mems**=*nodes* Memory nodes (MEMs) in which to allow execution. Only effective on NUMA systems. For example, if you have four memory nodes (0-3) on your system, use **--cpuset-mems=0,1** to only use memory from the first two memory nodes. -**--detach**, **-d**=**true**|**false** +#### **--detach**, **-d**=**true**|**false** Detached mode: run the container in the background and print the new container ID. The default is *false*. @@ -226,7 +226,7 @@ running) using a configurable key sequence. The default sequence is `ctrl-p,ctrl Configure the keys sequence using the **--detach-keys** option, or specifying it in the **containers.conf** file: see **containers.conf(5)** for more information. -**--detach-keys**=*sequence* +#### **--detach-keys**=*sequence* Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*. @@ -234,7 +234,7 @@ This option can also be set in **containers.conf**(5) file. Specifying "" will disable this feature. The default is **ctrl-p,ctrl-q**. -**--device**=_host-device_[**:**_container-device_][**:**_permissions_] +#### **--device**=_host-device_[**:**_container-device_][**:**_permissions_] Add a host device to the container. Optional *permissions* parameter can be used to specify device permissions, it is combination of @@ -253,33 +253,33 @@ Podman may load kernel modules required for using the specified device. The devices that podman will load modules when necessary are: /dev/fuse. -**--device-cgroup-rule**=rule +#### **--device-cgroup-rule**=rule Add a rule to the cgroup allowed devices list -**--device-read-bps**=_path_:_rate_ +#### **--device-read-bps**=_path_:_rate_ Limit read rate (in bytes per second) from a device (e.g. **--device-read-bps=/dev/sda:1mb**). -**--device-read-iops**=_path_:_rate_ +#### **--device-read-iops**=_path_:_rate_ Limit read rate (in IO operations per second) from a device (e.g. **--device-read-iops=/dev/sda:1000**). -**--device-write-bps**=_path_:_rate_ +#### **--device-write-bps**=_path_:_rate_ Limit write rate (in bytes per second) to a device (e.g. **--device-write-bps=/dev/sda:1mb**). -**--device-write-iops**=_path_:_rate_ +#### **--device-write-iops**=_path_:_rate_ Limit write rate (in IO operations per second) to a device (e.g. **--device-write-iops=/dev/sda:1000**). -**--disable-content-trust** +#### **--disable-content-trust** This is a Docker specific option to disable image verification to a Docker registry and is not supported by Podman. This flag is a NOOP and provided solely for scripting compatibility. -**--dns**=*ipaddr* +#### **--dns**=*ipaddr* Set custom DNS servers. Invalid if using **--dns** with **--network** that is set to **none** or **container:**_id_. @@ -291,16 +291,16 @@ is the case the **--dns** flags is necessary for every run. The special value **none** can be specified to disable creation of _/etc/resolv.conf_ in the container by Podman. The _/etc/resolv.conf_ file in the image will be used without changes. -**--dns-opt**=*option* +#### **--dns-opt**=*option* Set custom DNS options. Invalid if using **--dns-opt** with **--network** that is set to **none** or **container:**_id_. -**--dns-search**=*domain* +#### **--dns-search**=*domain* Set custom DNS search domains. Invalid if using **--dns-search** and **--network** that is set to **none** or **container:**_id_. Use **--dns-search=.** if you don't wish to set the search domain. -**--entrypoint**=*"command"* | *'["command", "arg1", ...]'* +#### **--entrypoint**=*"command"* | *'["command", "arg1", ...]'* Overwrite the default ENTRYPOINT of the image. @@ -318,7 +318,7 @@ ENTRYPOINT. You need to specify multi option commands in the form of a json string. -**--env**, **-e**=*env* +#### **--env**, **-e**=*env* Set environment variables. @@ -326,30 +326,30 @@ This option allows arbitrary environment variables that are available for the pr See [**Environment**](#environment) note below for precedence and examples. -**--env-host**=**true**|**false** +#### **--env-host**=**true**|**false** Use host environment inside of the container. See **Environment** note below for precedence. (Not available for remote commands) -**--env-file**=*file* +#### **--env-file**=*file* Read in a line delimited file of environment variables. See **Environment** note below for precedence. -**--expose**=*port* +#### **--expose**=*port* Expose a port, or a range of ports (e.g. **--expose=3300-3310**) to set up port redirection on the host system. -**--gidmap**=*container_gid*:*host_gid*:*amount* +#### **--gidmap**=*container_gid*:*host_gid*:*amount* Run the container in a new user namespace using the supplied mapping. This option conflicts with the **--userns** and **--subgidname** flags. This option can be passed several times to map different ranges. If calling **podman run** as an unprivileged user, the user needs to have the right to use the mapping. See **subuid**(5). The example maps gids **0-1999** in the container to the gids **30000-31999** on the host: **--gidmap=0:30000:2000**. -**--group-add**=*group* +#### **--group-add**=*group* Add additional groups to run as -**--health-cmd**=*"command"* | *'["command", "arg1", ...]'* +#### **--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 @@ -358,25 +358,25 @@ 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 as an argument to **/bin/sh -c**. -**--health-interval**=*interval* +#### **--health-interval**=*interval* Set an interval for the healthchecks. An _interval_ of **disable** results in no automatic timer setup. The default is **30s**. -**--health-retries**=*retries* +#### **--health-retries**=*retries* The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is **3**. -**--health-start-period**=*period* +#### **--health-start-period**=*period* The initialization time needed for a container to bootstrap. The value can be expressed in time format like **2m3s**. The default value is **0s**. -**--health-timeout**=*timeout* +#### **--health-timeout**=*timeout* The maximum time allowed to complete the healthcheck before an interval is considered failed. Like start-period, the value can be expressed in a time format such as **1m22s**. The default value is **30s**. -**--help** +#### **--help** Print usage statement @@ -386,7 +386,7 @@ Container host name Sets the container host name that is available inside the container. Can only be used with a private UTS namespace `--uts=private` (default). If `--pod` is specified and the pod shares the UTS namespace (default) the pods hostname will be used. -**--http-proxy**=**true**|**false** +#### **--http-proxy**=**true**|**false** By default proxy environment variables are passed into the container if set for the Podman process. This can be disabled by setting the value to **false**. @@ -401,7 +401,7 @@ proxy environment at container build time.) (Not available for remote commands) Defaults to **true**. -**--image-volume**, **builtin-volume**=**bind**|**tmpfs**|**ignore** +#### **--image-volume**, **builtin-volume**=**bind**|**tmpfs**|**ignore** Tells Podman how to handle the builtin image volumes. Default is **bind**. @@ -410,30 +410,30 @@ Tells Podman how to handle the builtin image volumes. Default is **bind**. content that disappears when the container is stopped. - **ignore**: All volumes are just ignored and no action is taken. -**--init** +#### **--init** Run an init inside the container that forwards signals and reaps processes. -**--init-path**=*path* +#### **--init-path**=*path* Path to the container-init binary. -**--interactive**, **-i**=**true**|**false** +#### **--interactive**, **-i**=**true**|**false** When set to **true**, keep stdin open even if not attached. The default is **false**. -**--ip6**=*ip* +#### **--ip6**=*ip* Not implemented. -**--ip**=*ip* +#### **--ip**=*ip* Specify a static IP address for the container, for example **10.88.64.128**. This option can only be used if the container is joined to only a single network - i.e., `--network=_network-name_` is used at most once and if the container is not joining another container's network namespace via `--network=container:_id_`. The address must be within the CNI network's IP address pool (default **10.88.0.0/16**). -**--ipc**=*mode* +#### **--ipc**=*mode* Set the IPC namespace mode for a container. The default is to create a private IPC namespace. @@ -442,7 +442,7 @@ a private IPC namespace. - **host**: use the host shared memory,semaphores and message queues inside the container. Note: the host mode gives the container full access to local shared memory and is therefore considered insecure. - **ns:**_path_: path to an IPC namespace to join. -**--kernel-memory**=_number_[_unit_] +#### **--kernel-memory**=_number_[_unit_] Kernel memory limit. A _unit_ can be **b** (bytes), **k** (kilobytes), **m** (megabytes), or **g** (gigabytes). @@ -452,23 +452,23 @@ is not limited. If you specify a limit, it may be rounded up to a multiple of the operating system's page size and the value can be very large, millions of trillions. -**--label**, **-l**=*key*=*value* +#### **--label**, **-l**=*key*=*value* Add metadata to a container. -**--label-file**=*file* +#### **--label-file**=*file* Read in a line-delimited file of labels. -**--link-local-ip**=*ip* +#### **--link-local-ip**=*ip* Not implemented. -**--log-driver**="*driver*" +#### **--log-driver**="*driver*" Logging driver for the container. Currently available options are **k8s-file**, **journald**, and **none**, with **json-file** aliased to **k8s-file** for scripting compatibility. -**--log-opt**=*name*=*value* +#### **--log-opt**=*name*=*value* Logging driver specific options. @@ -485,7 +485,7 @@ Set custom logging configuration. The following *name*s are supported: This option is currently supported only by the **journald** log driver. -**--mac-address**=*address* +#### **--mac-address**=*address* Container MAC address (e.g. **92:d0:c6:0a:29:33**). @@ -493,7 +493,7 @@ Remember that the MAC address in an Ethernet network must be unique. The IPv6 link-local address will be based on the device's MAC address according to RFC4862. -**--memory**, **-m**=_number_[_unit_] +#### **--memory**, **-m**=_number_[_unit_] Memory limit. A _unit_ can be **b** (bytes), **k** (kilobytes), **m** (megabytes), or **g** (gigabytes). @@ -503,7 +503,7 @@ RAM. If a limit of 0 is specified (not using **-m**), the container's memory is not limited. The actual limit may be rounded up to a multiple of the operating system's page size (the value would be very large, that's millions of trillions). -**--memory-reservation**=_number_[_unit_] +#### **--memory-reservation**=_number_[_unit_] Memory soft limit. A _unit_ can be **b** (bytes), **k** (kilobytes), **m** (megabytes), or **g** (gigabytes). @@ -513,7 +513,7 @@ reservation. So you should always set the value below **--memory**, otherwise th hard limit will take precedence. By default, memory reservation will be the same as memory limit. -**--memory-swap**=_number_[_unit_] +#### **--memory-swap**=_number_[_unit_] A limit value equal to memory plus swap. A _unit_ can be **b** (bytes), **k** (kilobytes), **m** (megabytes), or **g** (gigabytes). @@ -525,11 +525,11 @@ the value of **--memory**. Set _number_ to **-1** to enable unlimited swap. -**--memory-swappiness**=*number* +#### **--memory-swappiness**=*number* Tune a container's memory swappiness behavior. Accepts an integer between *0* and *100*. -**--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]* +#### **--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]* Attach a filesystem mount to the container @@ -585,7 +585,7 @@ Current supported mount TYPEs are **bind**, **volume**, **image**, **tmpfs** and · notmpcopyup: Disable copying files from the image to the tmpfs. -**--name**=*name* +#### **--name**=*name* Assign a name to the container. @@ -600,7 +600,7 @@ 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. This works for both background and foreground containers. -**--network**, **--net**=*mode* +#### **--network**, **--net**=*mode* Set the network mode for the container. Invalid if using **--dns**, **--dns-opt**, or **--dns-search** with **--network** that is set to **none** or **container:**_id_. @@ -624,40 +624,40 @@ Valid _mode_ values are: - **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default. - **port_handler=slirp4netns**: Use the slirp4netns port forwarding. -**--network-alias**=*alias* +#### **--network-alias**=*alias* Not implemented. -**--no-healthcheck**=*true|false* +#### **--no-healthcheck**=*true|false* Disable any defined healthchecks for container. -**--no-hosts**=**true**|**false** +#### **--no-hosts**=**true**|**false** Do not create _/etc/hosts_ for the container. By default, Podman will manage _/etc/hosts_, adding the container's own IP address and any hosts from **--add-host**. -**--no-hosts** disables this, and the image's _/etc/hosts_ will be preserved unmodified. +#### **--no-hosts** disables this, and the image's _/etc/hosts_ will be preserved unmodified. This option conflicts with **--add-host**. -**--oom-kill-disable**=**true**|**false** +#### **--oom-kill-disable**=**true**|**false** Whether to disable OOM Killer for the container or not. -**--oom-score-adj**=*num* +#### **--oom-score-adj**=*num* Tune the host's OOM preferences for containers (accepts values from **-1000** to **1000**). -**--override-arch**=*ARCH* +#### **--override-arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. -**--override-os**=*OS* +#### **--override-os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -**--override-variant**=*VARIANT* +#### **--override-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. -**--pid**=*mode* +#### **--pid**=*mode* Set the PID namespace mode for the container. The efault is to create a private PID namespace for the container. @@ -667,25 +667,25 @@ The efault is to create a private PID namespace for the container. - **private**: create a new namespace for the container (default) - **ns:**_path_: join the specified PID namespace. -**--pids-limit**=*limit* +#### **--pids-limit**=*limit* Tune the container's pids limit. Set to **0** to have unlimited pids for the container. The default is **4096** on systems that support "pids" cgroup controller. -**--pod**=*name* +#### **--pod**=*name* Run container in an existing pod. If you want Podman to make the pod for you, prefix the pod name with **new:**. To make a pod with more granular options, use the **podman pod create** command before creating a container. If a container is run with a pod, and the pod has an infra-container, the infra-container will be started before the container is. -**--pod-id-file**=*path* +#### **--pod-id-file**=*path* Run container in an existing pod and read the pod's ID from the specified file. If a container is run within a pod, and the pod has an infra-container, the infra-container will be started before the container is. -**--preserve-fds**=*N* +#### **--preserve-fds**=*N* Pass down to the process N additional file descriptors (in addition to 0, 1, 2). The total FDs will be 3+N. -**--privileged**=**true**|**false** +#### **--privileged**=**true**|**false** Give extended privileges to this container. The default is **false**. @@ -700,7 +700,7 @@ points, Apparmor/SELinux separation, and Seccomp filters are all disabled. Rootless containers cannot have more privileges than the account that launched them. -**--publish**, **-p**=_ip_:_hostPort_:_containerPort_ | _ip_::_containerPort_ | _hostPort_:_containerPort_ | _containerPort_ +#### **--publish**, **-p**=_ip_:_hostPort_:_containerPort_ | _ip_::_containerPort_ | _hostPort_:_containerPort_ | _containerPort_ Publish a container's port, or range of ports, to the host. @@ -723,7 +723,7 @@ associated ports. If one container binds to a port, no other container can use t within the pod while it is in use. Containers in the pod can also communicate over localhost by having one container bind to localhost in the pod, and another connect to that port. -**--publish-all**, **-P**=**true**|**false** +#### **--publish-all**, **-P**=**true**|**false** Publish all exposed ports to random ports on the host interfaces. The default is **false**. @@ -736,7 +736,7 @@ When using this option, Podman will bind any exposed port to a random port on th within an ephemeral port range defined by */proc/sys/net/ipv4/ip_local_port_range*. To find the mapping between the host ports and the exposed ports, use **podman port**. -**--pull**=**always**|**missing**|**never** +#### **--pull**=**always**|**missing**|**never** Pull image before running. The default is **missing**. @@ -744,11 +744,11 @@ Pull image before running. The default is **missing**. - **always**: Pull the image from the first registry it is found in as listed in registries.conf. Raise an error if not found in the registries, even if the image is present locally. - **never**: do not pull the image from the registry, use only the local version. Raise an error if the image is not present locally. -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress output information when pulling images -**--read-only**=**true**|**false** +#### **--read-only**=**true**|**false** Mount the container's root filesystem as read only. @@ -756,15 +756,15 @@ By default a container will have its root filesystem writable allowing processes to write files anywhere. By specifying the **--read-only** flag, the container will have its root filesystem mounted as read only prohibiting any writes. -**--read-only-tmpfs**=**true**|**false** +#### **--read-only-tmpfs**=**true**|**false** If container is running in **--read-only** mode, then mount a read-write tmpfs on _/run_, _/tmp_, and _/var/tmp_. The default is **true**. -**--replace**=**true**|**false** +#### **--replace**=**true**|**false** If another container with the same name already exists, replace and remove it. The default is **false**. -**--restart**=*policy* +#### **--restart**=*policy* Restart policy to follow when containers exit. Restart policy will not take effect if a container is stopped via the **podman kill** or **podman stop** commands. @@ -780,7 +780,7 @@ Please note that restart will not restart containers after a system reboot. If this functionality is required in your environment, you can invoke Podman from a **systemd.unit**(5) file, or create an init script for whichever init system is in use. To generate systemd unit files, please see **podman generate systemd**. -**--rm**=**true**|**false** +#### **--rm**=**true**|**false** Automatically remove the container when it exits. The default is **false**. @@ -788,12 +788,12 @@ Note that the container will not be removed when it could not be created or started successfully. This allows the user to inspect the container after failure. -**--rmi**=*true|false* +#### **--rmi**=*true|false* After exit of the container, remove the image unless another container is using it. The default is *false*. -**--rootfs** +#### **--rootfs** If specified, the first argument refers to an exploded container on the file system. @@ -803,7 +803,7 @@ of the container is assumed to be managed externally. Note: On **SELinux** systems, the rootfs needs the correct label, which is by default **unconfined_u:object_r:container_file_t**. -**--sdnotify**=**container**|**conmon**|**ignore** +#### **--sdnotify**=**container**|**conmon**|**ignore** Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. @@ -814,13 +814,13 @@ has started. The socket is never passed to the runtime or the container. The **ignore** option removes NOTIFY_SOCKET from the environment for itself and child processes, for the case where some other process above Podman uses NOTIFY_SOCKET and Podman should not use it. -**--seccomp-policy**=*policy* +#### **--seccomp-policy**=*policy* Specify the policy to select the seccomp profile. If set to *image*, Podman will look for a "io.podman.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. Note that this feature is experimental and may change in the future. -**--security-opt**=*option* +#### **--security-opt**=*option* Security Options @@ -840,37 +840,37 @@ Security Options Note: Labeling can be disabled for all containers by setting **label=false** in the **containers.conf**(5) file. -**--shm-size**=_number_[_unit_] +#### **--shm-size**=_number_[_unit_] Size of _/dev/shm_. A _unit_ can be **b** (bytes), **k** (kilobytes), **m** (megabytes), or **g** (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the default is **64m**. When _size_ is **0**, there is no limit on the amount of memory used for IPC by the container. -**--sig-proxy**=**true**|**false** +#### **--sig-proxy**=**true**|**false** Sets whether the signals sent to the **podman run** command are proxied to the container process. SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is **true**. -**--stop-signal**=*signal* +#### **--stop-signal**=*signal* Signal to stop a container. Default is **SIGTERM**. -**--stop-timeout**=*seconds* +#### **--stop-timeout**=*seconds* Timeout to stop a container. Default is **10**. -**--subgidname**=*name* +#### **--subgidname**=*name* Run the container in a new user namespace using the map with _name_ in the _/etc/subgid_ file. If calling **podman run** as an unprivileged user, the user needs to have the right to use the mapping. See **subgid**(5). This flag conflicts with **--userns** and **--gidmap**. -**--subuidname**=*name* +#### **--subuidname**=*name* Run the container in a new user namespace using the map with _name_ in the _/etc/subuid_ file. If calling **podman run** as an unprivileged user, the user needs to have the right to use the mapping. See **subuid**(5). This flag conflicts with **--userns** and **--uidmap**. -**--sysctl**=_name_=_value_ +#### **--sysctl**=_name_=_value_ Configure namespaced kernel parameters at runtime. @@ -894,7 +894,7 @@ For the network namespace, the following ysctls areallowed: Note: if you use the **--network=host** option, these sysctls will not be allowed. -**--systemd**=**true**|**false**|**always** +#### **--systemd**=**true**|**false**|**always** Run container in systemd mode. The default is **true**. @@ -923,7 +923,7 @@ The **container_manage_cgroup** boolean must be enabled for this to be allowed o setsebool -P container_manage_cgroup true ``` -**--tmpfs**=*fs* +#### **--tmpfs**=*fs* Create a tmpfs mount. @@ -938,7 +938,7 @@ options are the same as the Linux default mount flags. If you do not specify any options, the systems uses the following options: **rw,noexec,nosuid,nodev**. -**--tty**, **-t**=**true**|**false** +#### **--tty**, **-t**=**true**|**false** Allocate a pseudo-TTY. The default is **false**. @@ -949,15 +949,15 @@ interactive shell. The default is **false**. **NOTE**: The **-t** option is incompatible with a redirection of the Podman client standard input. -**--tz**=*timezone* +#### **--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. -**--umask**=*umask* +#### **--umask**=*umask* Set the umask inside the container. Defaults to `0022`. -**--uidmap**=*container_uid*:*host_uid*:*amount* +#### **--uidmap**=*container_uid*:*host_uid*:*amount* Run the container in a new user namespace using the supplied mapping. This option conflicts with the **--userns** and **--subuidname** flags. @@ -966,11 +966,11 @@ as an unprivileged user, the user needs to have the right to use the mapping. Se The following example maps uids 0-1999 in the container to the uids 30000-31999 on the host: **--uidmap=0:30000:2000**. -**--ulimit**=*option* +#### **--ulimit**=*option* Ulimit options. You can use **host** to copy the current configuration from the host. -**--user**, **-u**=[_user_ | _user_:_group_ | _uid_ | _uid_:_gid_ | _user_:_gid_ | _uid_:_group_ ] +#### **--user**, **-u**=[_user_ | _user_:_group_ | _uid_ | _uid_:_gid_ | _user_:_gid_ | _uid_:_group_ ] Sets the username or UID used and optionally the groupname or GID for the specified command. @@ -978,7 +978,7 @@ Without this argument, the command will run as the user specified in the contain When a user namespace is not in use, the UID and GID used within the container and on the host will match. When user namespaces are in use, however, the UID and GID in the container may correspond to another UID and GID on the host. In rootless containers, for example, a user namespace is always used, and root in the container will by default correspond to the UID and GID of the user invoking Podman. -**--userns**=**auto**|**host**|**keep-id**|**container:**_id_|**ns:**_namespace_ +#### **--userns**=**auto**|**host**|**keep-id**|**container:**_id_|**ns:**_namespace_ 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 they `--uidmapping` and `--gidmapping` options. @@ -994,7 +994,7 @@ Set the user namespace mode for the container. It defaults to the **PODMAN_USER This option is incompatible with **--gidmap**, **--uidmap**, **--subuid** and **--subgid**. -**--uts**=*mode* +#### **--uts**=*mode* Set the UTS namespace mode for the container. The following values are supported: @@ -1003,7 +1003,7 @@ Set the UTS namespace mode for the container. The following values are supported - **ns:[path]**: run the container in the given existing UTS namespace. - **container:[container]**: join the UTS namespace of the specified container. -**--volume**, **-v**[=[[_source-volume_|_host-dir_:]_container-dir_[:_options_]]] +#### **--volume**, **-v**[=[[_source-volume_|_host-dir_:]_container-dir_[:_options_]]] Create a bind mount. If you specify _/host-dir_:_/container-dir_, Podman bind mounts _host-dir_ in the host to _container-dir_ in the Podman @@ -1141,7 +1141,7 @@ will convert /foo into a shared mount point. Alternatively, one can directly change propagation properties of source mount. Say, if _/_ is source mount for _/foo_, then use **mount --make-shared /** to convert _/_ into a shared mount. -**--volumes-from**[=*CONTAINER*[:*OPTIONS*]] +#### **--volumes-from**[=*CONTAINER*[:*OPTIONS*]] Mount volumes from the specified container(s). Used to share volumes between containers. The *options* is a comma delimited list with the following available elements: @@ -1174,7 +1174,7 @@ If the location of the volume from the source container overlaps with data residing on a target container, then the volume hides that data on the target. -**--workdir**, **-w**=*dir* +#### **--workdir**, **-w**=*dir* Working directory inside the container. @@ -1400,7 +1400,7 @@ $ podman run --security-opt label=level:TopSecret -i -t rhel7 bash ``` To disable the security labeling for this container versus running with the -**--permissive** flag, use the following command: +#### **--permissive** flag, use the following command: ``` $ podman run --security-opt label=disable -i -t fedora bash diff --git a/docs/source/markdown/podman-save.1.md b/docs/source/markdown/podman-save.1.md index f19c9723a..bfb52e7f8 100644 --- a/docs/source/markdown/podman-save.1.md +++ b/docs/source/markdown/podman-save.1.md @@ -22,16 +22,16 @@ Note: `:` is a restricted character and cannot be part of the file name. ## OPTIONS -**--compress** +#### **--compress** Compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type, compressed or uncompressed, as source) Note: This flag can only be set when using the **dir** transport i.e --format=oci-dir or --format-docker-dir -**--output**, **-o**=*file* +#### **--output**, **-o**=*file* Write to a file, default is STDOUT -**--format**=*format* +#### **--format**=*format* Save image to **oci-archive, oci-dir** (directory with oci manifest type), or **docker-dir** (directory with v2s2 manifest type) ``` @@ -40,15 +40,15 @@ Save image to **oci-archive, oci-dir** (directory with oci manifest type), or ** --format docker-dir ``` -**--multi-image-archive**, **-m** +#### **--multi-image-archive**, **-m** Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for **docker-archive**. -**--quiet**, **-q** +#### **--quiet**, **-q** Suppress the output -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-search.1.md b/docs/source/markdown/podman-search.1.md index 15a38383a..ec610d3ba 100644 --- a/docs/source/markdown/podman-search.1.md +++ b/docs/source/markdown/podman-search.1.md @@ -25,14 +25,14 @@ Note, searching without a search term will only work for registries that impleme ## OPTIONS -**--authfile**=*path* +#### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--filter**, **-f**=*filter* +#### **--filter**, **-f**=*filter* Filter output based on conditions provided (default []) @@ -42,7 +42,7 @@ Supported filters are: * is-automated (boolean - true | false) - is the image automated or not * is-official (boolean - true | false) - is the image official or not -**--format**=*format* +#### **--format**=*format* Change the output format to a Go template @@ -60,7 +60,7 @@ Valid placeholders for the Go template are listed below: Note: use .Tag only if the --list-tags is set. -**--limit**=*limit* +#### **--limit**=*limit* Limit the number of results (default 25). Note: The results from each registry will be limited to this value. @@ -68,24 +68,24 @@ Example if limit is 10 and two registries are being searched, the total number of results will be 20, 10 from each (if there are at least 10 matches in each). The order of the search results is the order in which the API endpoint returns the results. -**--list-tags** +#### **--list-tags** List the available tags in the repository for the specified image. **Note:** --list-tags requires the search term to be a fully specified image name. The result contains the Image name and its tag, one line for every tag associated with the image. -**--no-trunc** +#### **--no-trunc** Do not truncate the output -**--tls-verify**=*true|false* +#### **--tls-verify**=*true|false* Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used if needed. If not specified, default registries will be searched through (in /etc/containers/registries.conf), and TLS will be skipped if a default registry is listed in the insecure registries. -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-start.1.md b/docs/source/markdown/podman-start.1.md index 84af9d800..4f8aa2b18 100644 --- a/docs/source/markdown/podman-start.1.md +++ b/docs/source/markdown/podman-start.1.md @@ -16,27 +16,27 @@ attach to the container. ## OPTIONS -**--attach**, **-a** +#### **--attach**, **-a** Attach container's STDOUT and STDERR. The default is false. This option cannot be used when starting multiple containers. -**--detach-keys**=*sequence* +#### **--detach-keys**=*sequence* Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*. -**--interactive**, **-i** +#### **--interactive**, **-i** Attach container's STDIN. The default is false. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--sig-proxy**=*true|false* +#### **--sig-proxy**=*true|false* Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true* when attaching, *false* otherwise. diff --git a/docs/source/markdown/podman-stats.1.md b/docs/source/markdown/podman-stats.1.md index 042da26d1..d5de8caf2 100644 --- a/docs/source/markdown/podman-stats.1.md +++ b/docs/source/markdown/podman-stats.1.md @@ -20,26 +20,26 @@ about their networking usage. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Show all containers. Only running containers are shown by default -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--no-reset** +#### **--no-reset** Do not clear the terminal/screen in between reporting intervals -**--no-stream** +#### **--no-stream** Disable streaming stats and only pull the first result, default setting is false -**--format**=*template* +#### **--format**=*template* Pretty-print container statistics to JSON or using a Go template diff --git a/docs/source/markdown/podman-stop.1.md b/docs/source/markdown/podman-stop.1.md index 1534063a5..83570f50d 100644 --- a/docs/source/markdown/podman-stop.1.md +++ b/docs/source/markdown/podman-stop.1.md @@ -17,28 +17,28 @@ container and also via command line when creating the container. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Stop all running containers. This does not include paused containers. -**--cidfile** +#### **--cidfile** Read container ID from the specified file and remove the container. Can be specified multiple times. -**--ignore**, **-i** +#### **--ignore**, **-i** Ignore errors when specified containers are not in the container store. A user might have decided to manually remove a container which would lead to a failure during the ExecStop directive of a systemd service referencing that container. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. The latest option is not supported on the remote client. -**--time**, **-t**=*time* +#### **--time**, **-t**=*time* Time to wait before forcibly stopping the container diff --git a/docs/source/markdown/podman-system-connection-add.1.md b/docs/source/markdown/podman-system-connection-add.1.md index 5059803a2..f314e8c56 100644 --- a/docs/source/markdown/podman-system-connection-add.1.md +++ b/docs/source/markdown/podman-system-connection-add.1.md @@ -19,7 +19,7 @@ The user will be prompted for the remote ssh login password or key file pass phr Make the new destination the default for this user. -**--identity**=*path* +#### **--identity**=*path* Path to ssh identity file. If the identity file has been encrypted, Podman prompts the user for the passphrase. If no identity file is provided and no user is given, Podman defaults to the user running the podman command. @@ -29,7 +29,7 @@ Podman prompts for the login password on the remote server. Port for ssh destination. The default value is `22`. -**--socket-path**=*path* +#### **--socket-path**=*path* Path to the Podman service unix domain socket on the ssh destination host diff --git a/docs/source/markdown/podman-system-df.1.md b/docs/source/markdown/podman-system-df.1.md index 57c02b8e1..e0aa2fa47 100644 --- a/docs/source/markdown/podman-system-df.1.md +++ b/docs/source/markdown/podman-system-df.1.md @@ -10,7 +10,7 @@ podman\-system\-df - Show podman disk usage Show podman disk usage ## OPTIONS -**--format**=*format* +#### **--format**=*format* Pretty-print images using a Go template diff --git a/docs/source/markdown/podman-system-migrate.1.md b/docs/source/markdown/podman-system-migrate.1.md index 29c0ef94b..913f119b0 100644 --- a/docs/source/markdown/podman-system-migrate.1.md +++ b/docs/source/markdown/podman-system-migrate.1.md @@ -26,7 +26,7 @@ newly configured mappings. ## OPTIONS -**--new-runtime**=*runtime* +#### **--new-runtime**=*runtime* Set a new OCI runtime for all containers. This can be used after a system upgrade which changes the default OCI runtime to move all containers to the new runtime. diff --git a/docs/source/markdown/podman-system-prune.1.md b/docs/source/markdown/podman-system-prune.1.md index 9c6ef5d8b..9a078648b 100644 --- a/docs/source/markdown/podman-system-prune.1.md +++ b/docs/source/markdown/podman-system-prune.1.md @@ -14,19 +14,19 @@ With the **--all** option, you can delete all unused images. Unused images are By default, volumes are not removed to prevent important data from being deleted if there is currently no container using the volume. Use the **--volumes** flag when running the command to prune volumes as well. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Remove all unused images not just dangling ones. -**--force**, **-f** +#### **--force**, **-f** Do not prompt for confirmation -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--volumes** +#### **--volumes** Prune volumes currently unused by any container diff --git a/docs/source/markdown/podman-system-reset.1.md b/docs/source/markdown/podman-system-reset.1.md index 1e5ef7235..744f917df 100644 --- a/docs/source/markdown/podman-system-reset.1.md +++ b/docs/source/markdown/podman-system-reset.1.md @@ -18,11 +18,11 @@ of the relevant configurations. If the administrator modified the configuration `podman system reset` might not be able to clean up the previous storage. ## OPTIONS -**--force**, **-f** +#### **--force**, **-f** Do not prompt for confirmation -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md index 580630cdc..39e30ec02 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -19,12 +19,12 @@ Both APIs are versioned, but the server will not reject requests with an unsuppo ## OPTIONS -**--time**, **-t** +#### **--time**, **-t** The time until the session expires in _seconds_. The default is 5 seconds. A value of `0` means no timeout and the session will not expire. -**--help**, **-h** +#### **--help**, **-h** Print usage statement. diff --git a/docs/source/markdown/podman-tag.1.md b/docs/source/markdown/podman-tag.1.md index 064ea401d..7eab62028 100644 --- a/docs/source/markdown/podman-tag.1.md +++ b/docs/source/markdown/podman-tag.1.md @@ -16,7 +16,7 @@ provided, then podman will default to `latest` for both the *image* and the ## OPTIONS -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-top.1.md b/docs/source/markdown/podman-top.1.md index 6a04ab91a..f307f96da 100644 --- a/docs/source/markdown/podman-top.1.md +++ b/docs/source/markdown/podman-top.1.md @@ -13,11 +13,11 @@ Display the running processes of the container. The *format-descriptors* are ps ## OPTIONS -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. diff --git a/docs/source/markdown/podman-unmount.1.md b/docs/source/markdown/podman-unmount.1.md index 08d1286ab..97780111a 100644 --- a/docs/source/markdown/podman-unmount.1.md +++ b/docs/source/markdown/podman-unmount.1.md @@ -27,11 +27,11 @@ External containers are containers created in container/storage by other tools l Buildah and CRI-O. ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** All of the currently mounted containers will be unmounted. -**--force**, **-f** +#### **--force**, **-f** Force the unmounting of specified containers' root file system, even if other processes have mounted it. @@ -39,7 +39,7 @@ processes have mounted it. Note: This could cause other processes that are using the file system to fail, as the mount point could be removed without their knowledge. -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last diff --git a/docs/source/markdown/podman-unpause.1.md b/docs/source/markdown/podman-unpause.1.md index f5538d6d5..ae178647a 100644 --- a/docs/source/markdown/podman-unpause.1.md +++ b/docs/source/markdown/podman-unpause.1.md @@ -13,7 +13,7 @@ Unpauses the processes in one or more containers. You may use container IDs or ## OPTIONS -**--all**, **-a** +#### **--all**, **-a** Unpause all paused containers. diff --git a/docs/source/markdown/podman-untag.1.md b/docs/source/markdown/podman-untag.1.md index d6ed7f3ea..70053c940 100644 --- a/docs/source/markdown/podman-untag.1.md +++ b/docs/source/markdown/podman-untag.1.md @@ -13,7 +13,7 @@ Remove one or more names from an image in the local storage. The image can be r ## OPTIONS -**--help**, **-h** +#### **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-version.1.md b/docs/source/markdown/podman-version.1.md index 185e8e296..a54e66372 100644 --- a/docs/source/markdown/podman-version.1.md +++ b/docs/source/markdown/podman-version.1.md @@ -12,11 +12,11 @@ OS, and Architecture. ## OPTIONS -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--format**, **-f**=*format* +#### **--format**, **-f**=*format* Change output format to "json" or a Go template. diff --git a/docs/source/markdown/podman-volume-create.1.md b/docs/source/markdown/podman-volume-create.1.md index 5672a80a5..9df8e2ec5 100644 --- a/docs/source/markdown/podman-volume-create.1.md +++ b/docs/source/markdown/podman-volume-create.1.md @@ -15,11 +15,11 @@ driver options can be set using the **--opt** flag. ## OPTIONS -**--driver**=*driver* +#### **--driver**=*driver* Specify the volume driver name (default local). -**--help** +#### **--help** Print usage statement diff --git a/docs/source/markdown/podman-volume-inspect.1.md b/docs/source/markdown/podman-volume-inspect.1.md index b889383b1..5652d9faa 100644 --- a/docs/source/markdown/podman-volume-inspect.1.md +++ b/docs/source/markdown/podman-volume-inspect.1.md @@ -24,7 +24,7 @@ Inspect all volumes. Format volume output using Go template -**--help** +#### **--help** Print usage statement diff --git a/docs/source/markdown/podman-volume-ls.1.md b/docs/source/markdown/podman-volume-ls.1.md index a4fb925f8..353d37fd7 100644 --- a/docs/source/markdown/podman-volume-ls.1.md +++ b/docs/source/markdown/podman-volume-ls.1.md @@ -18,11 +18,11 @@ flag. Use the **--quiet** flag to print only the volume names. Filter volume output. -**--format**=*format* +#### **--format**=*format* Format volume output using Go template. -**--help** +#### **--help** Print usage statement. diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md index 25ea701a3..753c816b5 100644 --- a/docs/source/markdown/podman-volume-prune.1.md +++ b/docs/source/markdown/podman-volume-prune.1.md @@ -18,7 +18,7 @@ unused volumes. To bypass the confirmation, use the **--force** flag. Do not prompt for confirmation. -**--help** +#### **--help** Print usage statement diff --git a/docs/source/markdown/podman-volume-rm.1.md b/docs/source/markdown/podman-volume-rm.1.md index ed4a83f9e..c831ad7b9 100644 --- a/docs/source/markdown/podman-volume-rm.1.md +++ b/docs/source/markdown/podman-volume-rm.1.md @@ -24,7 +24,7 @@ Remove all volumes. Remove a volume by force. If it is being used by containers, the containers will be removed first. -**--help** +#### **--help** Print usage statement diff --git a/docs/source/markdown/podman-wait.1.md b/docs/source/markdown/podman-wait.1.md index f0ccb1f9e..07e42ca6e 100644 --- a/docs/source/markdown/podman-wait.1.md +++ b/docs/source/markdown/podman-wait.1.md @@ -16,17 +16,17 @@ separated by newline in the same order as they were given to the command. ## OPTIONS -**--condition**=*state* +#### **--condition**=*state* Condition to wait on (default "stopped") -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--interval**, **-i**=*duration* +#### **--interval**, **-i**=*duration* Time interval to wait before polling for completion. A duration string is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Time unit defaults to "ms". -**--latest**, **-l** +#### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 2d5110ad9..993f285ed 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -21,31 +21,31 @@ created by the other. ## GLOBAL OPTIONS -**--cgroup-manager**=*manager* +#### **--cgroup-manager**=*manager* The CGroup manager to use for container cgroups. Supported values are cgroupfs or systemd. Default is systemd unless overridden in the containers.conf file. Note: Setting this flag can cause certain commands to break when called on containers previously created by the other CGroup manager type. Note: CGroup manager is not supported in rootless mode when using CGroups Version V1. -**--cni-config-dir** +#### **--cni-config-dir** Path of the configuration directory for CNI networks. (Default: `/etc/cni/net.d`) -**--connection**, **-c** +#### **--connection**, **-c** Connection to use for remote podman (Default connection is configured in `containers.conf`) -**--conmon** +#### **--conmon** Path of the conmon binary (Default path is configured in `containers.conf`) -**--events-backend**=*type* +#### **--events-backend**=*type* Backend to use for storing events. Allowed values are **file**, **journald**, and **none**. -**--help**, **-h** +#### **--help**, **-h** Print usage statement -**--hooks-dir**=*path* +#### **--hooks-dir**=*path* Each `*.json` file in the path configures a hook for Podman containers. For more details on the syntax of the JSON files and the semantics of hook injection, see `oci-hooks(5)`. Podman and libpod currently support both the 1.0.0 and 0.1.0 hook schemas, although the 0.1.0 schema is deprecated. @@ -61,7 +61,7 @@ Podman and libpod currently support an additional `precreate` state which is cal **WARNING**: the `precreate` hook lets you do powerful things, such as adding additional mounts to the runtime configuration. That power also makes it easy to break things. Before reporting libpod errors, try running your container with `precreate` hooks disabled to see if the problem is due to one of your hooks. -**--identity**=*path* +#### **--identity**=*path* Path to ssh identity file. If the identity file has been encrypted, podman prompts the user for the passphrase. If no identity file is provided and no user is given, podman defaults to the user running the podman command. @@ -72,22 +72,22 @@ Identity value resolution precedence: - environment variable `CONTAINER_SSHKEY`, if `CONTAINER_HOST` is found - `containers.conf` -**--log-level**=*level* +#### **--log-level**=*level* Log messages above specified level: debug, info, warn, error (default), fatal or panic (default: "error") -**--namespace**=*namespace* +#### **--namespace**=*namespace* Set libpod namespace. Namespaces are used to separate groups of containers and pods in libpod's state. When namespace is set, created containers and pods will join the given namespace, and only containers and pods in the given namespace will be visible to Podman. -**--network-cmd-path**=*path* +#### **--network-cmd-path**=*path* Path to the command binary to use for setting up a network. It is currently only used for setting up a slirp4netns network. If "" is used then the binary is looked up using the $PATH environment variable. -**--remote**, **-r** +#### **--remote**, **-r** Access Podman service will be remote -**--url**=*value* +#### **--url**=*value* URL to access Podman service (default from `containers.conf`, rootless `unix://run/user/$UID/podman/podman.sock` or as root `unix://run/podman/podman.sock`). - `CONTAINER_HOST` is of the format `<schema>://[<user[:<password>]@]<host>[:<port>][<path>]` @@ -105,21 +105,21 @@ URL value resolution precedence: - `containers.conf` - `unix://run/podman/podman.sock` -**--root**=*value* +#### **--root**=*value* Storage root dir in which data, including images, is stored (default: "/var/lib/containers/storage" for UID 0, "$HOME/.local/share/containers/storage" for other users). Default root dir configured in `/etc/containers/storage.conf`. -**--runroot**=*value* +#### **--runroot**=*value* Storage state directory where all state information is stored (default: "/var/run/containers/storage" for UID 0, "/var/run/user/$UID/run" for other users). Default state dir configured in `/etc/containers/storage.conf`. -**--runtime**=*value* +#### **--runtime**=*value* Name of the OCI runtime as specified in containers.conf or absolute path to the OCI compatible binary used to run containers. -**--runtime-flag**=*flag* +#### **--runtime-flag**=*flag* Adds global flags for the container runtime. To list the supported flags, please consult the manpages of the selected container runtime (`runc` is the default @@ -129,30 +129,30 @@ for cgroup V2, the default runtime is `crun`, the manpage to consult is `crun(8) Note: Do not pass the leading `--` to the flag. To pass the runc flag `--log-format json` to podman build, the option given would be `--runtime-flag log-format=json`. -**--storage-driver**=*value* +#### **--storage-driver**=*value* Storage driver. The default storage driver for UID 0 is configured in /etc/containers/storage.conf (`$HOME/.config/containers/storage.conf` in rootless mode), and is *vfs* for non-root users when *fuse-overlayfs* is not available. The `STORAGE_DRIVER` environment variable overrides the default. The --storage-driver specified driver overrides all. Overriding this option will cause the *storage-opt* settings in /etc/containers/storage.conf to be ignored. The user must specify additional options via the `--storage-opt` flag. -**--storage-opt**=*value* +#### **--storage-opt**=*value* Storage driver option, Default storage driver options are configured in /etc/containers/storage.conf (`$HOME/.config/containers/storage.conf` in rootless mode). The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options overrides all. -**--syslog**=*true|false* +#### **--syslog**=*true|false* Output logging information to syslog as well as the console (default *false*). On remote clients, logging is directed to the file $HOME/.config/containers/podman.log. -**--tmpdir** +#### **--tmpdir** Path to the tmp directory, for libpod runtime content. NOTE --tmpdir is not used for the temporary storage of downloaded images. Use the environment variable `TMPDIR` to change the temporary storage location of downloaded container images. Podman defaults to use `/var/tmp`. -**--version**, **-v** +#### **--version**, **-v** Print the version |