diff options
113 files changed, 960 insertions, 962 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index e3715937d..883e1240e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -29,13 +29,9 @@ author = "team" # ones. extensions = [ "sphinx_markdown_tables", + "recommonmark" ] -source_parsers = { - ".md": "recommonmark.parser.CommonMarkParser", -} - - # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/source/markdown/podman-attach.1.md b/docs/source/markdown/podman-attach.1.md index c4a5eec50..eb770d07d 100644 --- a/docs/source/markdown/podman-attach.1.md +++ b/docs/source/markdown/podman-attach.1.md @@ -14,24 +14,24 @@ or name, either to view its ongoing output or to control it interactively. You can detach from the container (and leave it running) using a configurable key sequence. The default sequence is `ctrl-p,ctrl-q`. -Configure the keys sequence using the **--detach-keys** option, or specifying +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. (This option is not available with the remote Podman 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 ad1e425aa..f82a1375c 100644 --- a/docs/source/markdown/podman-auto-update.1.md +++ b/docs/source/markdown/podman-auto-update.1.md @@ -34,7 +34,7 @@ Podman ships with a `podman-auto-update.service` systemd unit. This unit is tri ## 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 8fcfe555e..1bb3c2c3a 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 containers. 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 +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. (This option is not available with the remote Podman client) -#### **--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. @@ -104,40 +104,40 @@ CAP\_FSETID, CAP\_KILL, CAP\_MKNOD, CAP\_NET\_BIND\_SERVICE, CAP\_SETFCAP, CAP\_SETGID, CAP\_SETPCAP, CAP\_SETUID, and CAP\_SYS\_CHROOT capabilities are granted by default; this option can be used to remove them. -If a capability is specified to both the **--cap-add** and **--cap-drop** +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_. (This option is not available with the remote Podman client) -#### **--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. (This option is not available with the remote Podman client) -#### **--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 @@ -148,20 +148,20 @@ 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. Limit the container's CPU usage. By default, containers run with the full CPU resource. The limit is a number in microseconds. If you provide a number, the container will be allowed to use that much CPU time until the CPU period -ends (controllable via **--cpu-period**). +ends (controllable via **\-\-cpu-period**). 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) @@ -169,7 +169,7 @@ By default, all containers get the same proportion of CPU cycles. This proportion can be modified by changing the container's CPU share weighting relative to the weighting of all other running containers. -To modify the proportion from the default of 1024, use the **--cpu-shares** +To modify the proportion from the default of 1024, use the **\-\-cpu-shares** flag to set the weighting to 2 or higher. The proportion will only apply when CPU-intensive processes are running. @@ -199,11 +199,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. @@ -212,26 +212,26 @@ 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. -#### **--decryption-key**=*key[:passphrase]* +#### **\-\-decryption-key**=*key[:passphrase]* The [key[:passphrase]] to be used for decryption of images. Key can point to keys and/or certificates. Decryption will be tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise. -#### **--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 **r** for read, **w** for write, and **m** for **mknod**(2). -Example: **--device=/dev/sdc:/dev/xvdc:rwm**. +Example: **\-\-device=/dev/sdc:/dev/xvdc:rwm**. Note: if _host_device_ is a symbolic link then it will be resolved first. The container will only store the major and minor numbers of the host device. @@ -239,24 +239,24 @@ 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, because image layers are compressed automatically when they are pushed to 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**. +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. (This option is not available with the remote Podman client) -#### **--dns**=*dns* +#### **\-\-dns**=*dns* Set custom DNS servers to be used during the build. @@ -269,15 +269,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 to be used during the build. -#### **--dns-search**=*domain* +#### **\-\-dns-search**=*domain* Set custom DNS search domains to be used during the build. -#### **--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 @@ -290,12 +290,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 true). -#### **--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 @@ -304,28 +304,28 @@ Recognized formats include *oci* (OCI image-spec v1.0, the default) and Note: You can also override the default format by setting the BUILDAH\_FORMAT environment variable. `export BUILDAH_FORMAT=docker` -#### **--from** +#### **\-\-from** Overrides the first `FROM` instruction within the Containerfile. If there are multiple FROM instructions in a Containerfile, only the first is changed. -**-h**, **--help** +**-h**, **\-\-help** Print usage statement -#### **--http-proxy** +#### **\-\-http-proxy** Pass through HTTP Proxy environment variables. -#### **--iidfile**=*ImageIDfile* +#### **\-\-iidfile**=*ImageIDfile* Write the image ID to the file. -#### **--ignorefile** +#### **\-\-ignorefile** Path to an alternative .dockerignore 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 @@ -334,7 +334,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 @@ -348,13 +348,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. @@ -369,30 +369,30 @@ 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. -#### **--manifest** "manifest" +#### **\-\-manifest** "manifest" Name of the manifest list to which the image will be added. Creates the manifest list if it does not exist. This option is useful for building multi architecture images. -#### **--memory**, **-m**=*LIMIT* +#### **\-\-memory**, **-m**=*LIMIT* Memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) @@ -403,18 +403,18 @@ 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** -(**--memory**) value. By default, the swap `LIMIT` will be set to double +(**\-\-memory**) flag. The swap `LIMIT` should always be larger than **-m** +(**\-\-memory**) value. By default, the swap `LIMIT` will be set to double the value of --memory. 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. -#### **--network**=*mode*, **--net** +#### **\-\-network**=*mode*, **\-\-net** Sets the configuration for network namespaces when handling `RUN` instructions. @@ -427,17 +427,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 @@ -446,13 +446,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. Raise an error if the image could not be pulled, even if the image is present locally. @@ -461,28 +461,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 and is not present locally. -#### **--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. @@ -490,7 +490,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 @@ -510,7 +510,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`. @@ -518,40 +518,40 @@ 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. (This option is not available with the remote Podman client) -#### **--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. -#### **--stdin** +#### **\-\-stdin** Pass stdin into the RUN containers. Sometime commands being RUN within a Containerfile want to request information from the user. For example apt asking for a confirmation for install. Use --stdin to be able to interact from the terminal during the build. -#### **--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 @@ -562,12 +562,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). (This option is not available with the remote Podman client) -#### **--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 @@ -588,7 +588,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 @@ -597,7 +597,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. @@ -618,7 +618,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. @@ -639,7 +639,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 @@ -654,7 +654,7 @@ suitable user name to use as the default setting for this option. mappings are relative to the rootless usernamespace in the container, rather than being relative to the host as it would be when run rootful. -#### **--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 @@ -669,7 +669,7 @@ suitable group name to use as the default setting for this option. mappings are relative to the rootless usernamespace in the container, rather than being relative to the host as it would be when run rootful. -#### **--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 @@ -678,11 +678,11 @@ 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. -#### **--variant**="" +#### **\-\-variant**="" Set the architecture variant of the image to be pulled. -#### **--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 7485e9bd9..35ee1d010 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-completion.1.md b/docs/source/markdown/podman-completion.1.md index 50b0b6145..ca7d97728 100644 --- a/docs/source/markdown/podman-completion.1.md +++ b/docs/source/markdown/podman-completion.1.md @@ -14,11 +14,11 @@ These script are used by the shell to provide suggestions and complete commands Usually these scripts are automatically installed via the package manager. ## OPTIONS -#### **--file**, **-f** +#### **\-\-file**, **-f** Write the generated output to file. -#### **--no-desc** +#### **\-\-no-desc** Do not provide description in the completions. diff --git a/docs/source/markdown/podman-container-checkpoint.1.md b/docs/source/markdown/podman-container-checkpoint.1.md index 46b6cb646..a93464508 100644 --- a/docs/source/markdown/podman-container-checkpoint.1.md +++ b/docs/source/markdown/podman-container-checkpoint.1.md @@ -10,61 +10,61 @@ 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. (This option is not available with the remote Podman 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** +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** +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** to explicitly disable including changes to the root file-system into the checkpoint archive file. -#### **--ignore-volumes** +#### **\-\-ignore-volumes** -This option must be used in combination with the **--export, -e** option. +This option must be used in combination with the **\-\-export, -e** option. When this option is specified, the content of volumes associated with the container will not be included into the checkpoint tar.gz file. -#### **--pre-checkpoint**, **-P** +#### **\-\-pre-checkpoint**, **-P** Dump the container's memory information only, leaving the container running. Later operations will supersede prior dumps. It only works on runc 1.0-rc3 or higher. -#### **--with-previous** +#### **\-\-with-previous** Check out the container with previous criu image files in pre-dump. It only works -without **--pre-checkpoint** or **-P**. It only works on runc 1.0-rc3 or higher. +without **\-\-pre-checkpoint** or **-P**. It only works on runc 1.0-rc3 or higher. ## EXAMPLE diff --git a/docs/source/markdown/podman-container-cleanup.1.md b/docs/source/markdown/podman-container-cleanup.1.md index 8fd267b47..bd650c6af 100644 --- a/docs/source/markdown/podman-container-cleanup.1.md +++ b/docs/source/markdown/podman-container-cleanup.1.md @@ -12,26 +12,26 @@ 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. +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. (This option is not available with the remote Podman 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 381d968ab..28f1832a2 100644 --- a/docs/source/markdown/podman-container-exists.1.md +++ b/docs/source/markdown/podman-container-exists.1.md @@ -14,10 +14,10 @@ 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** +**-h**, **\-\-help** Print usage statement ## EXAMPLES diff --git a/docs/source/markdown/podman-container-prune.1.md b/docs/source/markdown/podman-container-prune.1.md index b199f9ebb..abdf58981 100644 --- a/docs/source/markdown/podman-container-prune.1.md +++ b/docs/source/markdown/podman-container-prune.1.md @@ -11,7 +11,7 @@ podman-container-prune - Remove all stopped containers from local storage ## OPTIONS -#### **--filter**=*filters* +#### **\-\-filter**=*filters* Provide filter values. @@ -26,11 +26,11 @@ The until filter can be Unix timestamps, date formatted timestamps, or Go durati The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes containers with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes containers without the specified labels. -#### **--force**, **-f** +#### **\-\-force**, **-f** Do not provide an interactive prompt for container removal. -**-h**, **--help** +**-h**, **\-\-help** Print usage statement diff --git a/docs/source/markdown/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md index ef8722279..3b517fb3d 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 @@ -21,18 +21,18 @@ files created during checkpointing. The size required by the checkpoint directory is roughly the same as the amount of memory required by the processes in the checkpointed container. -Without the **-k**, **--keep** option the checkpoint will be consumed and cannot be used +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. (This option is not available with the remote Podman 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. @@ -40,58 +40,58 @@ 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. -#### **--import-previous** +#### **\-\-import-previous** Import a pre-checkpoint tar.gz file which was exported by Podman. This option -must be used with **-i** or **--import**. It only works on runc 1.0-rc3 or higher. +must be used with **-i** or **\-\-import**. It only works on runc 1.0-rc3 or higher. -#### **--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 +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 way it is possible to restore a container from a checkpoint multiple times with different names. -If the **--name, -n** option is used, Podman will not attempt to assign the same IP +If the **\-\-name, -n** option is used, Podman will not attempt to assign the same IP address to the container it was using before checkpointing as each IP address can only 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**. +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 +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 +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 +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 -a container is restored multiple times from an exported checkpoint with **--name, -n**. +a container is restored multiple times from an exported checkpoint with **\-\-name, -n**. -Using **--ignore-static-ip** tells Podman to ignore the IP address if it was configured -with **--ip** during container creation. +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 +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 in use. This can happen, if a container is restored multiple times from an -exported checkpoint with **--name, -n**. +exported checkpoint with **\-\-name, -n**. -Using **--ignore-static-mac** tells Podman to ignore the MAC address if it was -configured with **--mac-address** during container creation. +Using **\-\-ignore-static-mac** tells Podman to ignore the MAC address if it was +configured with **\-\-mac-address** during container creation. -#### **--ignore-volumes** +#### **\-\-ignore-volumes** -This option must be used in combination with the **--import, -i** option. +This option must be used in combination with the **\-\-import, -i** option. When restoring containers from a checkpoint tar.gz file with this option, the content of associated volumes will not be restored. diff --git a/docs/source/markdown/podman-container-runlabel.1.md b/docs/source/markdown/podman-container-runlabel.1.md index 36bcbab3d..84d283cf8 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_. (This option is not available with the remote Podman client) -#### **--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-create.1.md b/docs/source/markdown/podman-create.1.md index 5c53f8601..b5e5fb2fc 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -65,22 +65,22 @@ and specified with a _tag_. $ podman create oci-archive:/tmp/fedora echo hello ## 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** +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. +The **\-\-annotation** option can be set multiple times. -#### **--arch**=*ARCH* +#### **\-\-arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. -#### **--attach**, **-a**=*location* +#### **\-\-attach**, **-a**=*location* Attach to STDIN, STDOUT or STDERR. @@ -91,30 +91,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. @@ -124,33 +124,33 @@ 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*. The *enabled* option will create a new cgroup under the cgroup-parent. -The *disabled* option will force the container to not create CGroups, and thus conflicts with CGroup options (**--cgroupns** and **--cgroup-parent**). +The *disabled* option will force the container to not create CGroups, and thus conflicts with CGroup options (**\-\-cgroupns** and **\-\-cgroup-parent**). 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. +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 @@ -161,26 +161,26 @@ 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. Limit the container's CPU usage. By default, containers run with the full CPU resource. The limit is a number in microseconds. If you provide a number, the container will be allowed to use that much CPU time until the CPU period -ends (controllable via **--cpu-period**). +ends (controllable via **\-\-cpu-period**). 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 @@ -189,7 +189,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) @@ -197,7 +197,7 @@ By default, all containers get the same proportion of CPU cycles. This proportio can be modified by changing the container's CPU share weighting relative to the weighting of all other running containers. -To modify the proportion from the default of 1024, use the **--cpu-shares** +To modify the proportion from the default of 1024, use the **\-\-cpu-shares** flag to set the weighting to 2 or higher. The proportion will only apply when CPU-intensive processes are running. @@ -226,21 +226,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**. +for **\-\-cpu-period** and **\-\-cpu-quota**, so you may only set either +#### **\-\-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. @@ -248,75 +248,75 @@ 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 **r** for read, **w** for write, and **m** for **mknod**(2). -Example: **--device=/dev/sdc:/dev/xvdc:rwm**. +Example: **\-\-device=/dev/sdc:/dev/xvdc:rwm**. Note: if _host_device_ is a symbolic link then it will be resolved first. 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**. +workaround for this by adding the option **\-\-annotation run.oci.keep_original_groups=1**. 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>`. +Set custom DNS servers. Invalid if using **\-\-dns** and **\-\-network** that is set to 'none' or `container:<name|id>`. This option can be used to override the DNS configuration passed to the container. Typically this is necessary when the host DNS configuration is invalid for the container (e.g., 127.0.0.1). When this -is the case the **--dns** flags is necessary for every run. +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>`. +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) +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 @@ -328,12 +328,12 @@ default nature or behavior, so that when you set an ENTRYPOINT you can run the container as if it were that binary, complete with default options, and you can pass in more options via the COMMAND. But, sometimes an operator may want to run something else inside the container, so you can override the default ENTRYPOINT -at runtime by using a **--entrypoint** and a string to specify the new +at runtime by using a **\-\-entrypoint** and a string to specify the new ENTRYPOINT. You need to specify multi option commands in the form of a json string. -#### **--env**, **-e**=*env* +#### **\-\-env**, **-e**=*env* Set environment variables @@ -341,30 +341,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. (This option is not available with the remote Podman client) -#### **--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 @@ -373,35 +373,35 @@ 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`. -#### **--hostname**=*name*, **-h** +#### **\-\-hostname**=*name*, **-h** 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 pod's 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` @@ -421,7 +421,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**. @@ -430,37 +430,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)) @@ -470,34 +470,34 @@ 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: - **path**: specify a path to the log file -(e.g. **--log-opt path=/var/log/container/mycontainer.json**); +(e.g. **\-\-log-opt path=/var/log/container/mycontainer.json**); - **max-size**: specify a max size of the log file -(e.g. **--log-opt max-size=10mb**); +(e.g. **\-\-log-opt max-size=10mb**); - **tag**: specify a custom log tag for the container -(e.g. **--log-opt tag="{{.ImageName}}"**. +(e.g. **\-\-log-opt tag="{{.ImageName}}"**. It supports the same keys as **podman inspect --format**. @@ -509,7 +509,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) @@ -517,7 +517,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)) @@ -527,32 +527,32 @@ 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)) After setting memory reservation, when the system detects memory contention or low memory, containers are forced to restrict their consumption to their -reservation. So you should always set the value below **--memory**, otherwise the +reservation. So you should always set the value below **\-\-memory**, otherwise the 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** -(**--memory**) value. By default, the swap `LIMIT` will be set to double +(**\-\-memory**) flag. The swap `LIMIT` should always be larger than **-m** +(**\-\-memory**) value. By default, the swap `LIMIT` will be set to double the value of --memory. 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 @@ -609,7 +609,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 @@ -619,13 +619,13 @@ UUID short identifier (“f78375b1c487”) Name (“jonah”) podman generates a UUID for each container, and if a name is not assigned -to the container with **--name** then it will generate a random +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**=*mode*, **--net** +#### **\-\-network**=*mode*, **\-\-net** -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_. If used together with **--pod**, the container will not join the pod's network namespace. +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_. If used together with **\-\-pod**, the container will not join the pod's network namespace. Valid _mode_ values are: @@ -648,33 +648,33 @@ 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* Add network-scoped alias for the container -#### **--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. -This option conflicts with **--add-host**. +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. +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) -#### **--os**=*OS* +#### **\-\-os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -#### **--pid**=*pid* +#### **\-\-pid**=*pid* Set the PID mode for the container Default is to create a private PID namespace for the container @@ -683,25 +683,25 @@ 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). -#### **--platform**=*OS/ARCH* +#### **\-\-platform**=*OS/ARCH* Specify the platform for selecting the image. (Conflicts with --arch and --os) The `--platform` option can be used to override the current architecture and operating system. -#### **--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*. @@ -717,7 +717,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 @@ -740,7 +740,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*. @@ -752,7 +752,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. @@ -761,11 +761,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. @@ -773,15 +773,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. @@ -797,18 +797,18 @@ 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*. -#### **--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. @@ -819,13 +819,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. -#### **--secret**=*secret* +#### **\-\-secret**=*secret* Give the container access to a secret. Can be specified multiple times. @@ -840,7 +840,7 @@ secret value will still remain. Secrets are managed using the `podman secret` command. -#### **--security-opt**=*option* +#### **\-\-security-opt**=*option* Security Options @@ -871,30 +871,30 @@ 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. Remote connections use local containers.conf for defaults -#### **--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 @@ -910,7 +910,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*. @@ -934,7 +934,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 @@ -947,7 +947,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*. @@ -958,29 +958,29 @@ 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. Remote connections use local containers.conf for defaults -#### **--umask**=*umask* +#### **\-\-umask**=*umask* Set the umask inside the container. Defaults to `0022`. Remote connections use local containers.conf for defaults -#### **--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. @@ -989,12 +989,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. @@ -1009,9 +1009,9 @@ Set the user namespace mode for the container. It defaults to the **PODMAN_USERN - `ns`: run the container in the given existing user namespace. - `private`: create a new namespace for the container (default) -This option is incompatible with **--gidmap**, **--uidmap**, **--subuidname** and **--subgidname**. +This option is incompatible with **\-\-gidmap**, **\-\-uidmap**, **\-\-subuidname** and **\-\-subgidname**. -#### **--uts**=*mode* +#### **\-\-uts**=*mode* Set the UTS namespace mode for the container. The following values are supported: @@ -1020,10 +1020,10 @@ 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. -#### **--variant**=*VARIANT* +#### **\-\-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. -#### **--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 @@ -1176,7 +1176,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: @@ -1209,7 +1209,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 @@ -1274,11 +1274,11 @@ Environment variables within containers can be set using multiple different opti Precedence order (later entries override earlier entries): -- **--env-host** : Host environment of the process executing Podman is added. -- **--http-proxy**: By default, several environment variables will be passed in from the host, such as **http_proxy** and **no_proxy**. See **--http-proxy** for details. +- **\-\-env-host** : Host environment of the process executing Podman is added. +- **\-\-http-proxy**: By default, several environment variables will be passed in from the host, such as **http_proxy** and **no_proxy**. See **\-\-http-proxy** for details. - Container image : Any environment variables specified in the container image. -- **--env-file** : Any environment variables specified via env-files. If multiple files specified, then they override each other in order of entry. -- **--env** : Any environment variables specified will override previous settings. +- **\-\-env-file** : Any environment variables specified via env-files. If multiple files specified, then they override each other in order of entry. +- **\-\-env** : Any environment variables specified will override previous settings. Create containers and set the environment ending with a __*__ and a ***** diff --git a/docs/source/markdown/podman-diff.1.md b/docs/source/markdown/podman-diff.1.md index dbab2d4db..5a4132783 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md index 4f9e9418f..0a73712b3 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 524ee50f0..f412cadd8 100644 --- a/docs/source/markdown/podman-exec.1.md +++ b/docs/source/markdown/podman-exec.1.md @@ -13,37 +13,37 @@ 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. (This option is not available with the remote Podman 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*. @@ -59,17 +59,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 63989a4db..172be035e 100644 --- a/docs/source/markdown/podman-export.1.md +++ b/docs/source/markdown/podman-export.1.md @@ -24,11 +24,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 0e5a31ae6..90b4c59fb 100644 --- a/docs/source/markdown/podman-generate-kube.1.md +++ b/docs/source/markdown/podman-generate-kube.1.md @@ -18,11 +18,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 43cb30f59..431163d56 100644 --- a/docs/source/markdown/podman-generate-systemd.1.md +++ b/docs/source/markdown/podman-generate-systemd.1.md @@ -14,46 +14,46 @@ _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. -#### **--no-header** +#### **\-\-no-header** Do not generate the header including meta data such as the Podman version and the timestamp. -#### **--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 fa10d5dca..41abef204 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 2dd41e9f5..cebb45054 100644 --- a/docs/source/markdown/podman-history.1.md +++ b/docs/source/markdown/podman-history.1.md @@ -12,9 +12,9 @@ podman\-history - Show the history of an image **podman history** displays the history of an image by printing out information about each layer used in the image. The information printed out for each layer include Created (time and date), Created By, Size, and Comment. The output can -be truncated or not using the **--no-trunc** flag. If the **--human** flag is +be truncated or not using the **\-\-no-trunc** flag. If the **\-\-human** flag is set, the time of creation and size are printed out in a human readable format. -The **--quiet** flag displays the ID of the image only when set and the **--format** +The **\-\-quiet** flag displays the ID of the image only when set and the **\-\-format** flag is used to print the information using the Go template provided by the user. Valid placeholders for the Go template are listed below: @@ -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 9b1dfa45a..4c03fcd09 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 5d5cb1647..370d28daa 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 8cb9684a7..766f337ad 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 73024ffb8..16e6c9b03 100644 --- a/docs/source/markdown/podman-image-prune.1.md +++ b/docs/source/markdown/podman-image-prune.1.md @@ -14,11 +14,11 @@ 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. @@ -33,11 +33,11 @@ The until filter can be Unix timestamps, date formatted timestamps, or Go durati The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes images with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes images without the specified labels. -#### **--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 b9addc062..994578530 100644 --- a/docs/source/markdown/podman-image-sign.1.md +++ b/docs/source/markdown/podman-image-sign.1.md @@ -15,24 +15,24 @@ By default, the signature will be written into `/var/lib/containers/sigstore` fo ## OPTIONS -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement. -#### **--all**, **-a** +#### **\-\-all**, **-a** Sign all the manifests of the multi-architecture image (default false). -#### **--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_. (This option is not available with the remote Podman client) -#### **--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 fe36929cc..5f5473f28 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 6e2c2287a..63280c4d7 100644 --- a/docs/source/markdown/podman-image-trust.1.md +++ b/docs/source/markdown/podman-image-trust.1.md @@ -37,15 +37,15 @@ Require signature (“signedBy”). Trust may be updated using the command **podman image trust set** for an existing trust scope. ## OPTIONS -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement. -#### **--pubkeysfile**=*KEY1*, **-f** +#### **\-\-pubkeysfile**=*KEY1*, **-f** A path to an exported public key on the local system. Key paths will be referenced in policy.json. Any path to a file may be used but locating the file in **/etc/pki/containers** is recommended. Options may be used multiple times to - require an image be signed by multiple keys. The **--pubkeysfile** option is required for the **signedBy** type. + require an image be signed by multiple keys. The **\-\-pubkeysfile** option is required for the **signedBy** type. -#### **--type**=*value*, **-t** +#### **\-\-type**=*value*, **-t** The trust type for this policy entry. Accepted values: **signedBy** (default): Require signatures with corresponding list of @@ -56,10 +56,10 @@ 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 -#### **--json**, **-j** +#### **\-\-json**, **-j** Output trust as JSON for machine parsing ## EXAMPLES diff --git a/docs/source/markdown/podman-image-unmount.1.md b/docs/source/markdown/podman-image-unmount.1.md index 62e879fa1..075ae5968 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 23cce450a..4aac40a61 100644 --- a/docs/source/markdown/podman-images.1.md +++ b/docs/source/markdown/podman-images.1.md @@ -15,15 +15,15 @@ Displays locally stored images, their names, and their IDs. ## OPTIONS -#### **--all**, **-a** +#### **\-\-all**, **-a** Show all images (by default filter out the intermediate image layers). The default is false. -#### **--digests** +#### **\-\-digests** Show image digests -#### **--filter**=*filter*, **-f** +#### **\-\-filter**=*filter*, **-f** Filter output based on conditions provided @@ -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 427c67da4..38c2ab680 100644 --- a/docs/source/markdown/podman-import.1.md +++ b/docs/source/markdown/podman-import.1.md @@ -11,26 +11,26 @@ podman\-import - Import a tarball and save it as a filesystem image ## DESCRIPTION **podman import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) and saves it as a filesystem image. Remote tarballs can be specified using a URL. -Various image instructions can be configured with the **--change** flag and -a commit message can be set using the **--message** flag. +Various image instructions can be configured with the **\-\-change** flag and +a commit message can be set using the **\-\-message** flag. **reference**, if present, is a tag to assign to the image. **podman import** is used for importing from the archive generated by **podman export**, that includes the container's filesystem. To import the archive of image layers created by **podman save**, use **podman load**. Note: `:` is a restricted character and cannot be part of the file name. ## OPTIONS -#### **--change**=*instruction*, **-c** +#### **\-\-change**=*instruction*, **-c** Apply the following possible instructions to the created image: **CMD** | **ENTRYPOINT** | **ENV** | **EXPOSE** | **LABEL** | **STOPSIGNAL** | **USER** | **VOLUME** | **WORKDIR** 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 @@ -38,7 +38,7 @@ Shows progress on the import Print additional debugging information -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-info.1.md b/docs/source/markdown/podman-info.1.md index 4af51d3eb..ee7961be0 100644 --- a/docs/source/markdown/podman-info.1.md +++ b/docs/source/markdown/podman-info.1.md @@ -15,11 +15,11 @@ Displays information pertinent to the host, current storage stats, configured co ## OPTIONS -#### **--debug**, **-D** +#### **\-\-debug**, **-D** Show additional information -#### **--format**=*format*, **-f** +#### **\-\-format**=*format*, **-f** Change output format to "json" or a Go template. diff --git a/docs/source/markdown/podman-init.1.md b/docs/source/markdown/podman-init.1.md index 5f3636686..4fd552e65 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-inspect.1.md b/docs/source/markdown/podman-inspect.1.md index bfd0cea3d..7feb36de1 100644 --- a/docs/source/markdown/podman-inspect.1.md +++ b/docs/source/markdown/podman-inspect.1.md @@ -24,24 +24,24 @@ 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. This option can be used to inspect the latest pod created when used with --type pod. (This option is not available with the remote Podman 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 e5f1d4bbe..e4e984836 100644 --- a/docs/source/markdown/podman-kill.1.md +++ b/docs/source/markdown/podman-kill.1.md @@ -12,20 +12,20 @@ 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. -#### **--cidfile** +#### **\-\-cidfile** Read container ID from the specified file and remove the container. Can be specified multiple times. -#### **--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. (This option is not available with the remote Podman 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 3ff03e9e7..4f3208377 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 274869042..c7779788f 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_. (This option is not available with the remote Podman client) -#### **--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 c35c4856b..caa8c9021 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 8f1301102..863e8278a 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,28 +23,28 @@ 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. (This option is not available with the remote Podman client) -#### **--names**, **-n** +#### **\-\-names**, **-n** 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-machine-init.1.md b/docs/source/markdown/podman-machine-init.1.md index be07a7bd5..e2ed1eb10 100644 --- a/docs/source/markdown/podman-machine-init.1.md +++ b/docs/source/markdown/podman-machine-init.1.md @@ -18,27 +18,27 @@ tied to the Linux kernel. ## OPTIONS -#### **--cpus**=*number* +#### **\-\-cpus**=*number* Number of CPUs. -#### **--disk-size**=*number* +#### **\-\-disk-size**=*number* Size of the disk for the guest VM in GB. -#### **--ignition-path** +#### **\-\-ignition-path** Fully qualified path of the ignition file -#### **--image-path** +#### **\-\-image-path** Fully qualified path of the uncompressed image file -#### **--memory**, **-m**=*number* +#### **\-\-memory**, **-m**=*number* Memory (in MB). -#### **--help** +#### **\-\-help** Print usage statement. diff --git a/docs/source/markdown/podman-machine-rm.1.md b/docs/source/markdown/podman-machine-rm.1.md index 4da17fdcb..e80f26d6d 100644 --- a/docs/source/markdown/podman-machine-rm.1.md +++ b/docs/source/markdown/podman-machine-rm.1.md @@ -19,23 +19,23 @@ is used. ## OPTIONS -#### **--help** +#### **\-\-help** Print usage statement. -#### **--force** +#### **\-\-force** Delete without confirmation -#### **--save-ignition** +#### **\-\-save-ignition** Do not delete the generated ignition file -#### **--save-image** +#### **\-\-save-image** Do not delete the VM image -#### **--save-keys** +#### **\-\-save-keys** Do not delete the SSH keys for the VM. The system connection is always deleted. diff --git a/docs/source/markdown/podman-machine-ssh.1.md b/docs/source/markdown/podman-machine-ssh.1.md index 01cec1f57..fa78f876a 100644 --- a/docs/source/markdown/podman-machine-ssh.1.md +++ b/docs/source/markdown/podman-machine-ssh.1.md @@ -16,11 +16,11 @@ tied to the Linux kernel. ## OPTIONS -#### **--execute**, **-e** +#### **\-\-execute**, **-e** Execute the given command on the VM -#### **--help** +#### **\-\-help** Print usage statement. diff --git a/docs/source/markdown/podman-machine-start.1.md b/docs/source/markdown/podman-machine-start.1.md index 7f3a9f592..22942767a 100644 --- a/docs/source/markdown/podman-machine-start.1.md +++ b/docs/source/markdown/podman-machine-start.1.md @@ -18,7 +18,7 @@ tied to the Linux kernel. ## OPTIONS -#### **--help** +#### **\-\-help** Print usage statement. diff --git a/docs/source/markdown/podman-machine-stop.1.md b/docs/source/markdown/podman-machine-stop.1.md index f4be54511..33c67f70b 100644 --- a/docs/source/markdown/podman-machine-stop.1.md +++ b/docs/source/markdown/podman-machine-stop.1.md @@ -18,7 +18,7 @@ tied to the Linux kernel. ## OPTIONS -#### **--help** +#### **\-\-help** Print usage statement. diff --git a/docs/source/markdown/podman-manifest-add.1.md b/docs/source/markdown/podman-manifest-add.1.md index f2d188766..c3c1ea1cf 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_. (This option is not available with the remote Podman client) -#### **--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 2126b71ec..70b077e5b 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 3a3d5e4b0..3017fb515 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-exists.1.md b/docs/source/markdown/podman-manifest-exists.1.md index e15110126..944cc04c8 100644 --- a/docs/source/markdown/podman-manifest-exists.1.md +++ b/docs/source/markdown/podman-manifest-exists.1.md @@ -14,7 +14,7 @@ An exit code of `125` indicates there was another issue. ## OPTIONS -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement. diff --git a/docs/source/markdown/podman-manifest-push.1.md b/docs/source/markdown/podman-manifest-push.1.md index a8169cb56..4e7118dad 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. (Default true) -#### **--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_. (This option is not available with the remote Podman client) -#### **--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). -#### **--quiet**, **-q** +#### **\-\-quiet**, **-q** When writing the manifest, suppress progress output -#### **--rm** +#### **\-\-rm** Delete the manifest list or image index from local storage if pushing succeeds. -#### **--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 1b1b09120..780437a9c 100644 --- a/docs/source/markdown/podman-mount.1.md +++ b/docs/source/markdown/podman-mount.1.md @@ -26,21 +26,21 @@ 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 started container could be from either of those methods. (This option is not available with the remote Podman client) -#### **--notruncate** +#### **\-\-notruncate** Do not truncate IDs in output. diff --git a/docs/source/markdown/podman-network-connect.1.md b/docs/source/markdown/podman-network-connect.1.md index cff4336d6..bb765a677 100644 --- a/docs/source/markdown/podman-network-connect.1.md +++ b/docs/source/markdown/podman-network-connect.1.md @@ -13,7 +13,7 @@ Once connected, the container can communicate with other containers in the same This command is not available for rootless users. ## OPTIONS -#### **--alias** +#### **\-\-alias** Add network-scoped alias for the container. If the network is using the `dnsname` CNI plugin, these aliases can be used for name resolution on the given network. Multiple *--alias* options may be specified as input. diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md index 3d5d98055..9a8c4f72d 100644 --- a/docs/source/markdown/podman-network-create.1.md +++ b/docs/source/markdown/podman-network-create.1.md @@ -18,16 +18,16 @@ 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. -#### **--driver**, **-d** +#### **\-\-driver**, **-d** Driver to manage the network (default "bridge"). Currently only `bridge` is supported. -#### **--opt**=*option*, **-o** +#### **\-\-opt**=*option*, **-o** Set driver specific options. @@ -35,37 +35,37 @@ For the `bridge` driver the following options are supported: `mtu` and `vlan`. The `mtu` option sets the Maximum Transmission Unit (MTU) and takes an integer value. The `vlan` option assign VLAN tag and enables vlan\_filtering. Defaults to none. -#### **--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. Note when using this option, the dnsname plugin will be automatically disabled. -#### **--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. -#### **--label** +#### **\-\-label** Set metadata for a network (e.g., --label mykey=value). -#### **--macvlan** +#### **\-\-macvlan** *This option is being deprecated* 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-disconnect.1.md b/docs/source/markdown/podman-network-disconnect.1.md index 8b7125282..ed5a5637a 100644 --- a/docs/source/markdown/podman-network-disconnect.1.md +++ b/docs/source/markdown/podman-network-disconnect.1.md @@ -12,7 +12,7 @@ Disconnects a container from a network. This command is not available for rootless users. ## OPTIONS -#### **--force**, **-f** +#### **\-\-force**, **-f** Force the container to disconnect from a network diff --git a/docs/source/markdown/podman-network-exists.1.md b/docs/source/markdown/podman-network-exists.1.md index 3ad3ccedb..bc3c88014 100644 --- a/docs/source/markdown/podman-network-exists.1.md +++ b/docs/source/markdown/podman-network-exists.1.md @@ -15,7 +15,7 @@ of `0` when the network is found. A `1` will be returned otherwise. An exit cod ## OPTIONS -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md index 56515d0c1..af6907906 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. ## 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 9d2dd52a8..12dbb01d3 100644 --- a/docs/source/markdown/podman-network-ls.1.md +++ b/docs/source/markdown/podman-network-ls.1.md @@ -10,7 +10,7 @@ podman\-network\-ls - Display a summary of CNI networks Displays a list of existing podman networks. ## OPTIONS -#### **--filter**, **-f** +#### **\-\-filter**, **-f** Filter output based on conditions given. Multiple filters can be given with multiple uses of the --filter flag. @@ -27,7 +27,7 @@ Valid filters are listed below: | plugin | [Plugin] CNI plugins included in a network (e.g `bridge`,`portmap`,`firewall`,`tuning`,`dnsname`,`macvlan`) | | driver | [Driver] Only `bridge` is supported | -#### **--format** +#### **\-\-format** Change the default output format. This can be of a supported type like 'json' or a Go template. @@ -41,11 +41,11 @@ Valid placeholders for the Go template are listed below: | .Labels | Network labels | | .Version | CNI Version of the config file | -#### **--no-trunc** +#### **\-\-no-trunc** -Do not truncate the network ID. The network ID is not displayed by default and must be specified with **--format**. +Do not truncate the network ID. The network ID is not displayed by default and must be specified with **\-\-format**. -#### **--quiet**, **-q** +#### **\-\-quiet**, **-q** The `quiet` option will restrict the output to only the network names. diff --git a/docs/source/markdown/podman-network-prune.1.md b/docs/source/markdown/podman-network-prune.1.md index af0a7295d..909db462c 100644 --- a/docs/source/markdown/podman-network-prune.1.md +++ b/docs/source/markdown/podman-network-prune.1.md @@ -12,7 +12,7 @@ has no containers connected or configured to connect to it. It will not remove the so-called default network which goes by the name of *podman*. ## OPTIONS -#### **--force**, **-f** +#### **\-\-force**, **-f** Do not prompt for confirmation diff --git a/docs/source/markdown/podman-network-reload.1.md b/docs/source/markdown/podman-network-reload.1.md index 011640c86..a4204a397 100644 --- a/docs/source/markdown/podman-network-reload.1.md +++ b/docs/source/markdown/podman-network-reload.1.md @@ -16,11 +16,11 @@ the network connectivity. This command is not available for rootless users since rootless containers are not affected by such connectivity problems. ## OPTIONS -#### **--all**, **-a** +#### **\-\-all**, **-a** Reload network configuration of all 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-network-rm.1.md b/docs/source/markdown/podman-network-rm.1.md index ad4bc11e2..9777975df 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 123362822..98948739c 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 1be597b94..6206a2ea9 100644 --- a/docs/source/markdown/podman-play-kube.1.md +++ b/docs/source/markdown/podman-play-kube.1.md @@ -19,7 +19,7 @@ Note: If the `:latest` tag is used, Podman will attempt to pull the image from a ## 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`. @@ -27,50 +27,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` -#### **--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_. (This option is not available with the remote Podman client) -#### **--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. -#### **--log-driver**=driver +#### **\-\-log-driver**=driver Set logging driver for all created containers. -#### **--network**=*networks*, **--net** +#### **\-\-network**=*networks*, **\-\-net** 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"). (This option is not available with the remote Podman client) -#### **--start**=*true|false* +#### **\-\-start**=*true|false* Start the pod after creating it, set to false to only create it. -#### **--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 22eb07bf3..9ecde1ca3 100644 --- a/docs/source/markdown/podman-pod-create.1.md +++ b/docs/source/markdown/podman-pod-create.1.md @@ -15,71 +15,71 @@ 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. -#### **--label**=*label*, **-l** +#### **\-\-label**=*label*, **-l** 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. -#### **--name**=*name*, **-n** +#### **\-\-name**=*name*, **-n** Assign a name to the pod. -#### **--network**=*mode*, **--net** +#### **\-\-network**=*mode*, **\-\-net** 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,19 +96,19 @@ 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. -#### **--network-alias**=strings +#### **\-\-network-alias**=strings Add a DNS alias for the container. When the container is joined to a CNI network with support for the dnsname plugin, the container will be accessible through this name from other containers in the network. -#### **--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. -#### **--publish**=*port*, **-p** +#### **\-\-publish**=*port*, **-p** Publish a port or range of ports from the pod to the host. @@ -119,11 +119,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. @@ -133,7 +133,7 @@ UUID short identifier (“f78375b1c487”) Name (“jonah”) podman generates a UUID for each pod, and if a name is not assigned -to the container with **--name** then a random string name will be generated +to the container with **\-\-name** then a random string name will be generated for it. The name is useful any place you need to identify a pod. ## EXAMPLES diff --git a/docs/source/markdown/podman-pod-inspect.1.md b/docs/source/markdown/podman-pod-inspect.1.md index 1f4e6cb06..9265b824c 100644 --- a/docs/source/markdown/podman-pod-inspect.1.md +++ b/docs/source/markdown/podman-pod-inspect.1.md @@ -11,12 +11,12 @@ 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. (This option is not available with the remote Podman client) -#### **--format**=*format*, **-f** +#### **\-\-format**=*format*, **-f** Change the default output format. This can be of a supported type like 'json' or a Go template. diff --git a/docs/source/markdown/podman-pod-kill.1.md b/docs/source/markdown/podman-pod-kill.1.md index d4eef2307..38bcaab17 100644 --- a/docs/source/markdown/podman-pod-kill.1.md +++ b/docs/source/markdown/podman-pod-kill.1.md @@ -10,16 +10,16 @@ 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. (This option is not available with the remote Podman 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 2c849a932..51dee5939 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-pod-prune.1.md b/docs/source/markdown/podman-pod-prune.1.md index e90164c15..7b7137186 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 7c1c4a0b4..0be22c2b1 100644 --- a/docs/source/markdown/podman-pod-ps.1.md +++ b/docs/source/markdown/podman-pod-ps.1.md @@ -26,35 +26,35 @@ 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) (This option is not available with the remote Podman 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: | .InfraID | Pod infra container ID | | .Networks | Show all networks connected to the infra container | -#### **--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. Multiple filters can be given with multiple uses of the --filter flag. @@ -99,7 +99,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 65d05f977..15261d5aa 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-pod-rm.1.md b/docs/source/markdown/podman-pod-rm.1.md index d185385b6..025bedc61 100644 --- a/docs/source/markdown/podman-pod-rm.1.md +++ b/docs/source/markdown/podman-pod-rm.1.md @@ -11,25 +11,25 @@ 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. (This option is not available with the remote Podman 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 40a71d879..78656b954 100644 --- a/docs/source/markdown/podman-pod-start.1.md +++ b/docs/source/markdown/podman-pod-start.1.md @@ -12,15 +12,15 @@ 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. (This option is not available with the remote Podman 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 3158ffc1c..6d67295d8 100644 --- a/docs/source/markdown/podman-pod-stats.1.md +++ b/docs/source/markdown/podman-pod-stats.1.md @@ -11,23 +11,23 @@ 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. (This option is not available with the remote Podman 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 77f6af433..b68ee2377 100644 --- a/docs/source/markdown/podman-pod-stop.1.md +++ b/docs/source/markdown/podman-pod-stop.1.md @@ -11,25 +11,25 @@ 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. (This option is not available with the remote Podman 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 d374a0dca..ea86c3999 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-pod-unpause.1.md b/docs/source/markdown/podman-pod-unpause.1.md index 98022a50b..75230113f 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-port.1.md b/docs/source/markdown/podman-port.1.md index 7a84d181a..1db174e7d 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md index 75eede527..b950fede4 100644 --- a/docs/source/markdown/podman-ps.1.md +++ b/docs/source/markdown/podman-ps.1.md @@ -13,7 +13,7 @@ podman\-ps - Prints out information about containers **podman container ls** [*options*] ## DESCRIPTION -**podman ps** lists the running containers on the system. Use the **--all** flag to view +**podman ps** lists the running containers on the system. Use the **\-\-all** flag to view all the containers information. By default it lists: * container id @@ -26,17 +26,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. @@ -61,7 +61,7 @@ Valid filters are listed below: | network | [Network] name or full ID of network | -#### **--format**=*format* +#### **\-\-format**=*format* Pretty-print containers to JSON or using a Go template @@ -84,52 +84,52 @@ 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) (This option is not available with the remote Podman 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 02ba736f2..79563fb57 100644 --- a/docs/source/markdown/podman-pull.1.md +++ b/docs/source/markdown/podman-pull.1.md @@ -65,16 +65,16 @@ 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. -#### **--arch**=*ARCH* +#### **\-\-arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. -#### **--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`. @@ -82,46 +82,46 @@ 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_. (This option is not available with the remote Podman client) -#### **--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. -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement -#### **--os**=*OS* +#### **\-\-os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -#### **--platform**=*OS/ARCH* +#### **\-\-platform**=*OS/ARCH* Specify the platform for selecting the image. (Conflicts with --arch and --os) The `--platform` option can be used to override the current architecture and operating system. -#### **--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. -#### **--variant**=*VARIANT* +#### **\-\-variant**=*VARIANT* Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. diff --git a/docs/source/markdown/podman-push.1.md b/docs/source/markdown/podman-push.1.md index f42ee1020..1bef7ebdb 100644 --- a/docs/source/markdown/podman-push.1.md +++ b/docs/source/markdown/podman-push.1.md @@ -54,7 +54,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`. @@ -62,49 +62,49 @@ 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_. (This option is not available with the remote Podman client) -#### **--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. (This option is not available with the remote Podman client) -#### **--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, v2s2, or v2s1) to use when pushing an image. -#### **--quiet**, **-q** +#### **\-\-quiet**, **-q** When writing the output image, suppress progress output -#### **--remove-signatures** +#### **\-\-remove-signatures** Discard any pre-existing signatures in the image. (This option is not available with the remote Podman client) -#### **--sign-by**=*key* +#### **\-\-sign-by**=*key* Add a signature at the destination using the specified key. (This option is not available with the remote Podman client) -#### **--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 1a6c7d3cc..3e20e1ded 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 2b37e2ea4..0d6d3b595 100644 --- a/docs/source/markdown/podman-restart.1.md +++ b/docs/source/markdown/podman-restart.1.md @@ -14,17 +14,17 @@ 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. (This option is not available with the remote Podman client) -#### **--running** +#### **\-\-running** Restart all containers that are already in the *running* state. -#### **--time**=*time*, **-t** +#### **\-\-time**=*time*, **-t** Timeout to wait before forcibly stopping the container. diff --git a/docs/source/markdown/podman-rm.1.md b/docs/source/markdown/podman-rm.1.md index 0abf2768c..1fce9d2f3 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,21 +30,21 @@ 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. (This option is not available with the remote Podman 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**. +created with **podman volume create**, or the **\-\-volume** option of **podman run** and **podman create**. ## EXAMPLE Remove a container by its name *mywebserver* diff --git a/docs/source/markdown/podman-rmi.1.md b/docs/source/markdown/podman-rmi.1.md index 765c1bd6d..037a0a170 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 f61344099..ab8455e2a 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -25,7 +25,7 @@ pull** _image_ , before it starts the container from that image. Several files will be automatically created within the container. These include _/etc/hosts_, _/etc/hostname_, and _/etc/resolv.conf_ to manage networking. These will be based on the host's version of the files, though they can be -customized with options (for example, **--dns** will override the host's DNS +customized with options (for example, **\-\-dns** will override the host's DNS servers in the created _resolv.conf_). Additionally, a container environment file is created in each container to indicate to programs they are running in a container. This file is located at _/run/.containerenv_. When using the @@ -83,20 +83,20 @@ and specified with a _tag_. $ podman run oci-archive:/tmp/fedora echo hello ## 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. -#### **--arch**=*ARCH* +#### **\-\-arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. -#### **--attach**, **-a**=**stdin**|**stdout**|**stderr** +#### **\-\-attach**, **-a**=**stdin**|**stdout**|**stderr** Attach to STDIN, STDOUT or STDERR. @@ -107,30 +107,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. @@ -141,34 +141,34 @@ 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. Default is **enabled**. The **enabled** option will create a new cgroup under the cgroup-parent. -The **disabled** option will force the container to not create CGroups, and thus conflicts with CGroup options (**--cgroupns** and **--cgroup-parent**). +The **disabled** option will force the container to not create CGroups, and thus conflicts with CGroup options (**\-\-cgroupns** and **\-\-cgroup-parent**). 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**. +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. +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 @@ -179,26 +179,26 @@ 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. Limit the container's CPU usage. By default, containers run with the full CPU resource. The limit is a number in microseconds. If you provide a number, the container will be allowed to use that much CPU time until the CPU period -ends (controllable via **--cpu-period**). +ends (controllable via **\-\-cpu-period**). 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. @@ -207,7 +207,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). @@ -232,8 +232,8 @@ cores. Even if a container is limited to less than 100% of CPU time, it can use 100% of each individual CPU core. For example, consider a system with more than three cores. If you start one -container **{C0}** with **--cpu-shares=512** running one process, and another container -**{C1}** with **--cpu-shares=1024** running two processes, this can result in the following +container **{C0}** with **\-\-cpu-shares=512** running one process, and another container +**{C1}** with **\-\-cpu-shares=1024** running two processes, this can result in the following division of CPU shares: | PID | container | CPU | CPU share | @@ -242,30 +242,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**. +for **\-\-cpu-period** and **\-\-cpu-quota**, so you may only set either +#### **\-\-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** +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*. @@ -275,10 +275,10 @@ detached container with **podman attach**. When attached in the tty mode, you can detach from the container (and leave it running) using a configurable key sequence. The default sequence is `ctrl-p,ctrl-q`. -Configure the keys sequence using the **--detach-keys** option, or specifying +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*. @@ -286,73 +286,73 @@ 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 **r** for read, **w** for write, and **m** for **mknod**(2). -Example: **--device=/dev/sdc:/dev/xvdc:rwm**. +Example: **\-\-device=/dev/sdc:/dev/xvdc:rwm**. Note: if _host_device_ is a symbolic link then it will be resolved first. 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**. +workaround for this by adding the option **\-\-annotation run.oci.keep_original_groups=1**. 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**). +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**). +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**). +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**). +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_. +Set custom DNS servers. Invalid if using **\-\-dns** with **\-\-network** that is set to **none** or **container:**_id_. This option can be used to override the DNS configuration passed to the container. Typically this is necessary when the host DNS configuration is invalid for the container (e.g., **127.0.0.1**). When this -is the case the **--dns** flags is necessary for every run. +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_. +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. +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. @@ -365,12 +365,12 @@ default nature or behavior, so that when you set an ENTRYPOINT you can run the container as if it were that binary, complete with default options, and you can pass in more options via the COMMAND. But, sometimes an operator may want to run something else inside the container, so you can override the default ENTRYPOINT -at runtime by using a **--entrypoint** and a string to specify the new +at runtime by using a **\-\-entrypoint** and a string to specify the new ENTRYPOINT. You need to specify multi option commands in the form of a json string. -#### **--env**, **-e**=*env* +#### **\-\-env**, **-e**=*env* Set environment variables. @@ -378,37 +378,37 @@ 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. (This option is not available with the remote Podman client) -#### **--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 +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. +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**. +The example maps gids **0-1999** in the container to the gids **30000-31999** on the host: **\-\-gidmap=0:30000:2000**. -**Important note:** The new user namespace mapping based on **--gidmap** is based on the initial mapping made in the _/etc/subgid_ file. +**Important note:** The new user namespace mapping based on **\-\-gidmap** is based on the initial mapping made in the _/etc/subgid_ file. Assuming there is a _/etc/subgid_ mapping **groupname:100000:65536**, then **groupname** is initially mapped to a namespace starting with -gid **100000** for **65536** ids. From here the **--gidmap** mapping to the new namespace starts from **0** again, but is based on the initial mapping. -Meaning **groupname** is initially mapped to gid **100000** which is referenced as **0** in the following **--gidmap** mapping. In terms of the example +gid **100000** for **65536** ids. From here the **\-\-gidmap** mapping to the new namespace starts from **0** again, but is based on the initial mapping. +Meaning **groupname** is initially mapped to gid **100000** which is referenced as **0** in the following **\-\-gidmap** mapping. In terms of the example above: The group **groupname** is mapped to group **100000** of the initial namespace then the **30000**st id of this namespace (which is gid 130000 in this namespace) is mapped to container namespace group id **0**. (groupname -> 100000 / 30000 -> 0) -#### **--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 @@ -417,35 +417,35 @@ 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 -#### **--hostname**=*name*, **-h** +#### **\-\-hostname**=*name*, **-h** 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 pod's 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**. @@ -455,12 +455,12 @@ those. This option is only needed when the host system must use a proxy but the container should not use any proxy. Proxy environment variables specified for the container in any other way will override the values that would have been passed through from the host. (Other ways to specify the proxy for the -container include passing the values with the **--env** flag, or hard coding the +container include passing the values with the **\-\-env** flag, or hard coding the proxy environment at container build time.) (This option is not available with the remote Podman client) 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**. @@ -469,30 +469,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. @@ -501,7 +501,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). @@ -511,40 +511,40 @@ 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. Set custom logging configuration. The following *name*s are supported: **path**: specify a path to the log file - (e.g. **--log-opt path=/var/log/container/mycontainer.json**); + (e.g. **\-\-log-opt path=/var/log/container/mycontainer.json**); **max-size**: specify a max size of the log file - (e.g. **--log-opt max-size=10mb**); + (e.g. **\-\-log-opt max-size=10mb**); **tag**: specify a custom log tag for the container - (e.g. **--log-opt tag="{{.ImageName}}"**. + (e.g. **\-\-log-opt tag="{{.ImageName}}"**. 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**). @@ -552,7 +552,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). @@ -562,33 +562,33 @@ 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). After setting memory reservation, when the system detects memory contention or low memory, containers are forced to restrict their consumption to their -reservation. So you should always set the value below **--memory**, otherwise the +reservation. So you should always set the value below **\-\-memory**, otherwise the 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). -Must be used with the **-m** (**--memory**) flag. +Must be used with the **-m** (**\-\-memory**) flag. The argument value should always be larger than that of - **-m** (**--memory**) By default, it is set to double -the value of **--memory**. + **-m** (**\-\-memory**) By default, it is set to double +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 @@ -644,7 +644,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. @@ -655,13 +655,13 @@ The operator can identify a container in three ways: - Name (“jonah”). Podman generates a UUID for each container, and if a name is not assigned -to the container with **--name** then it will generate a random +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**=*mode*, **--net** +#### **\-\-network**=*mode*, **\-\-net** -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_. If used together with **--pod**, the container will not join the pods network namespace. +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_. If used together with **\-\-pod**, the container will not join the pods network namespace. Valid _mode_ values are: @@ -684,34 +684,34 @@ 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* Add network-scoped alias for the container -#### **--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. -This option conflicts with **--add-host**. +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. +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**). -#### **--os**=*OS* +#### **\-\-os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -#### **--pid**=*mode* +#### **\-\-pid**=*mode* Set the PID namespace mode for the container. The default is to create a private PID namespace for the container. @@ -721,32 +721,32 @@ The default 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. -#### **--platform**=*OS/ARCH* +#### **\-\-platform**=*OS/ARCH* Specify the platform for selecting the image. (Conflicts with --arch and --os) The `--platform` option can be used to override the current architecture and operating system. -#### **--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**. @@ -761,7 +761,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. @@ -784,7 +784,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**. @@ -797,7 +797,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**. @@ -805,27 +805,27 @@ 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. 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 +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**. +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. @@ -841,16 +841,16 @@ 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**. -#### **--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. @@ -860,7 +860,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. @@ -871,13 +871,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. -#### **--secret**=*secret* +#### **\-\-secret**=*secret* Give the container access to a secret. Can be specified multiple times. @@ -892,7 +892,7 @@ secret value will still remain. Secrets are managed using the `podman secret` command -#### **--security-opt**=*option* +#### **\-\-security-opt**=*option* Security Options @@ -917,38 +917,38 @@ 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**. Remote connections use local containers.conf for defaults -#### **--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**. +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**. +This flag conflicts with **\-\-userns** and **\-\-uidmap**. -#### **--sysctl**=_name_=_value_ +#### **\-\-sysctl**=_name_=_value_ Configure namespaced kernel parameters at runtime. @@ -964,15 +964,15 @@ For the IPC namespace, the following sysctls are allowed: - kernel.shm_rmid_forced - Sysctls beginning with fs.mqueue.\* -Note: if you use the **--ipc=host** option, the above sysctls will not be allowed. +Note: if you use the **\-\-ipc=host** option, the above sysctls will not be allowed. For the network namespace, the following sysctls are allowed: - Sysctls beginning with net.\* -Note: if you use the **--network=host** option, these sysctls will not be 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**. @@ -1001,7 +1001,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. @@ -1016,7 +1016,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**. @@ -1030,39 +1030,39 @@ interactive shell. The default is **false**. echo "asdf" | podman run --rm -i someimage /bin/cat ``` -#### **--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. Remote connections use local containers.conf for defaults -#### **--umask**=*umask* +#### **\-\-umask**=*umask* Set the umask inside the container. Defaults to `0022`. Remote connections use local containers.conf for defaults -#### **--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. +with the **\-\-userns** and **\-\-subuidname** 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 following example maps uids 0-1999 in the container to the uids 30000-31999 on the host: **--uidmap=0:30000:2000**. +The following example maps uids 0-1999 in the container to the uids 30000-31999 on the host: **\-\-uidmap=0:30000:2000**. -**Important note:** The new user namespace mapping based on **--uidmap** is based on the initial mapping made in the _/etc/subuid_ file. +**Important note:** The new user namespace mapping based on **\-\-uidmap** is based on the initial mapping made in the _/etc/subuid_ file. Assuming there is a _/etc/subuid_ mapping **username:100000:65536**, then **username** is initially mapped to a namespace starting with -uid **100000** for **65536** ids. From here the **--uidmap** mapping to the new namespace starts from **0** again, but is based on the initial mapping. -Meaning **username** is initially mapped to uid **100000** which is referenced as **0** in the following **--uidmap** mapping. In terms of the example +uid **100000** for **65536** ids. From here the **\-\-uidmap** mapping to the new namespace starts from **0** again, but is based on the initial mapping. +Meaning **username** is initially mapped to uid **100000** which is referenced as **0** in the following **\-\-uidmap** mapping. In terms of the example above: The user **username** is mapped to user **100000** of the initial namespace then the **30000**st id of this namespace (which is uid 130000 in this namespace) is mapped to container namespace user id **0**. (username -> 100000 / 30000 -> 0) _Note_: A minimal mapping has to have at least container uid **0** mapped to the parent user namespace. -#### **--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. @@ -1070,7 +1070,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. @@ -1084,9 +1084,9 @@ Set the user namespace mode for the container. It defaults to the **PODMAN_USERN - **private**: create a new namespace for the container. - **container**: join the user namespace of the specified container. -This option is incompatible with **--gidmap**, **--uidmap**, **--subuidname** and **--subgidname**. +This option is incompatible with **\-\-gidmap**, **\-\-uidmap**, **\-\-subuidname** and **\-\-subgidname**. -#### **--uts**=*mode* +#### **\-\-uts**=*mode* Set the UTS namespace mode for the container. The following values are supported: @@ -1095,10 +1095,10 @@ 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. -#### **--variant**=*VARIANT* +#### **\-\-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. -#### **--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 @@ -1251,7 +1251,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: @@ -1284,7 +1284,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. @@ -1329,7 +1329,7 @@ During container image development, containers often need to write to the image content. Installing packages into _/usr_, for example. In production, applications seldom need to write to the image. Container applications write to volumes if they need to write to file systems at all. Applications can be -made more secure by running them in read-only mode using the **--read-only** switch. +made more secure by running them in read-only mode using the **\-\-read-only** switch. This protects the containers image from modification. Read only containers may still need to write temporary data. The best way to handle this is to mount tmpfs directories on _/run_ and _/tmp_. @@ -1379,7 +1379,7 @@ $ podman run -a stdin -a stdout -i -t fedora /bin/bash Using **shm_server.c** available here: https://www.cs.cf.ac.uk/Dave/C/node27.html -Testing **--ipc=host** mode: +Testing **\-\-ipc=host** mode: Host shows a shared memory segment with 7 pids attached, happens to be from httpd: @@ -1400,7 +1400,7 @@ $ podman run -it shm ipcs -m key shmid owner perms bytes nattch status ``` -Run a container with the new **--ipc=host** option, and it now sees the shared memory segment from the host httpd: +Run a container with the new **\-\-ipc=host** option, and it now sees the shared memory segment from the host httpd: ``` $ podman run -it --ipc=host shm ipcs -m @@ -1409,7 +1409,7 @@ $ podman run -it --ipc=host shm ipcs -m key shmid owner perms bytes nattch status 0x01128e25 0 root 600 1000 7 ``` -Testing **--ipc=container:**_id_ mode: +Testing **\-\-ipc=container:**_id_ mode: Start a container with a program to create a shared memory segment: ``` @@ -1429,7 +1429,7 @@ $ podman run shm ipcs -m key shmid owner perms bytes nattch status ``` -Create a 3rd container using the **--ipc=container:**_id_ option, now it shows the shared memory segment from the first: +Create a 3rd container using the **\-\-ipc=container:**_id_ option, now it shows the shared memory segment from the first: ``` $ podman run -it --ipc=container:ed735b2264ac shm ipcs -m @@ -1468,7 +1468,7 @@ $ podman run -v /var/cache/dnf:/var/cache/dnf:O -ti fedora dnf -y update $ podman run -d -e MYSQL_ROOT_PASSWORD=root --user mysql --userns=keep-id -v ~/data:/var/lib/mysql:z,U mariadb ``` -Using **--mount** flags to mount a host directory as a container folder, specify +Using **\-\-mount** flags to mount a host directory as a container folder, specify the absolute path to the directory or the volume name, and the absolute path within the container directory: @@ -1497,7 +1497,7 @@ changes will also be reflected on the host in _/var/db_. ### Using alternative security labeling You can override the default labeling scheme for each container by specifying -the **--security-opt** flag. For example, you can specify the MCS/MLS level, a +the **\-\-security-opt** flag. For example, you can specify the MCS/MLS level, a requirement for MLS systems. Specifying the level in the following command allows you to share the same content between containers. @@ -1512,7 +1512,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 @@ -1530,7 +1530,7 @@ $ podman run --security-opt label=type:svirt_apache_t -i -t centos bash Note you would have to write policy defining a **svirt_apache_t** type. To mask additional specific paths in the container, specify the paths -separated by a colon using the **mask** option with the **--security-opt** +separated by a colon using the **mask** option with the **\-\-security-opt** flag. ``` @@ -1552,7 +1552,7 @@ $ podman run --security-opt unmask=/foo/bar:/sys/firmware fedora bash ### Setting device weight If you want to set _/dev/sda_ device weight to **200**, you can specify the device -weight by **--blkio-weight-device** flag. Use the following command: +weight by **\-\-blkio-weight-device** flag. Use the following command: ``` $ podman run -it --blkio-weight-device "/dev/sda:200" ubuntu @@ -1567,7 +1567,7 @@ asdf ### Setting Namespaced Kernel Parameters (Sysctls) -The **--sysctl** sets namespaced kernel parameters (sysctls) in the +The **\-\-sysctl** sets namespaced kernel parameters (sysctls) in the container. For example, to turn on IP forwarding in the containers network namespace, run this command: @@ -1579,7 +1579,7 @@ Note that not all sysctls are namespaced. Podman does not support changing sysct inside of a container that also modify the host system. As the kernel evolves we expect to see more sysctls become namespaced. -See the definition of the **--sysctl** option above for the current list of +See the definition of the **\-\-sysctl** option above for the current list of supported sysctls. ### Set UID/GID mapping in a new user namespace @@ -1622,7 +1622,7 @@ In order for users to run rootless, there must be an entry for their username in Rootless Podman works better if the fuse-overlayfs and slirp4netns packages are installed. The **fuse-overlay** package provides a userspace overlay storage driver, otherwise users need to use the **vfs** storage driver, which is diskspace expensive and does not perform well. slirp4netns is -required for VPN, without it containers need to be run with the **--network=host** flag. +required for VPN, without it containers need to be run with the **\-\-network=host** flag. ## ENVIRONMENT @@ -1630,10 +1630,10 @@ Environment variables within containers can be set using multiple different opti in the following order of precedence (later entries override earlier entries): - Container image: Any environment variables specified in the container image. -- **--http-proxy**: By default, several environment variables will be passed in from the host, such as **http_proxy** and **no_proxy**. See **--http-proxy** for details. -- **--env-host**: Host environment of the process executing Podman is added. -- **--env-file**: Any environment variables specified via env-files. If multiple files specified, then they override each other in order of entry. -- **--env**: Any environment variables specified will override previous settings. +- **\-\-http-proxy**: By default, several environment variables will be passed in from the host, such as **http_proxy** and **no_proxy**. See **\-\-http-proxy** for details. +- **\-\-env-host**: Host environment of the process executing Podman is added. +- **\-\-env-file**: Any environment variables specified via env-files. If multiple files specified, then they override each other in order of entry. +- **\-\-env**: Any environment variables specified will override previous settings. Run containers and set the environment ending with a __*__ and a __*****__: diff --git a/docs/source/markdown/podman-save.1.md b/docs/source/markdown/podman-save.1.md index fb79cfd2a..e6f6e993b 100644 --- a/docs/source/markdown/podman-save.1.md +++ b/docs/source/markdown/podman-save.1.md @@ -24,16 +24,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) ``` @@ -42,15 +42,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 ec610d3ba..23aa6acd1 100644 --- a/docs/source/markdown/podman-search.1.md +++ b/docs/source/markdown/podman-search.1.md @@ -11,9 +11,9 @@ podman\-search - Search a registry for an image The user can specify which registry to search by prefixing the registry in the search term (example **registry.fedoraproject.org/fedora**), default is the registries in the **registries.search** table in the config file - **/etc/containers/registries.conf**. -The default number of results is 25. The number of results can be limited using the **--limit** flag. +The default number of results is 25. The number of results can be limited using the **\-\-limit** flag. If more than one registry is being searched, the limit will be applied to each registry. The output can be filtered -using the **--filter** flag. To get all available images in a registry without a specific +using the **\-\-filter** flag. To get all available images in a registry without a specific search term, the user can just enter the registry name with a trailing "/" (example **registry.fedoraproject.org/**). Note, searching without a search term will only work for registries that implement the v2 API. @@ -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-secret-create.1.md b/docs/source/markdown/podman-secret-create.1.md index af4dc1d97..ca92dd38e 100644 --- a/docs/source/markdown/podman-secret-create.1.md +++ b/docs/source/markdown/podman-secret-create.1.md @@ -20,11 +20,11 @@ Secrets will not be commited to an image with `podman commit`, and will not be i ## OPTIONS -#### **--driver**=*driver* +#### **\-\-driver**=*driver* Specify the secret driver (default **file**, which is unencrypted). -#### **--help** +#### **\-\-help** Print usage statement. diff --git a/docs/source/markdown/podman-secret-inspect.1.md b/docs/source/markdown/podman-secret-inspect.1.md index 383db8375..042cc25d9 100644 --- a/docs/source/markdown/podman-secret-inspect.1.md +++ b/docs/source/markdown/podman-secret-inspect.1.md @@ -15,11 +15,11 @@ Secrets can be queried individually by providing their full name or a unique par ## OPTIONS -#### **--format**=*format* +#### **\-\-format**=*format* Format secret output using Go template. -#### **--help** +#### **\-\-help** Print usage statement. diff --git a/docs/source/markdown/podman-secret-ls.1.md b/docs/source/markdown/podman-secret-ls.1.md index 688784e05..57a606738 100644 --- a/docs/source/markdown/podman-secret-ls.1.md +++ b/docs/source/markdown/podman-secret-ls.1.md @@ -8,11 +8,11 @@ podman\-secret\-ls - List all available secrets ## DESCRIPTION -Lists all the secrets that exist. The output can be formatted to a Go template using the **--format** option. +Lists all the secrets that exist. The output can be formatted to a Go template using the **\-\-format** option. ## OPTIONS -#### **--format**=*format* +#### **\-\-format**=*format* Format secret output using Go template. diff --git a/docs/source/markdown/podman-secret-rm.1.md b/docs/source/markdown/podman-secret-rm.1.md index c6f5079ba..72d6a1af4 100644 --- a/docs/source/markdown/podman-secret-rm.1.md +++ b/docs/source/markdown/podman-secret-rm.1.md @@ -18,11 +18,11 @@ the old secret value will still remain. ## OPTIONS -#### **--all**, **-a** +#### **\-\-all**, **-a** Remove all existing secrets. -#### **--help** +#### **\-\-help** Print usage statement. diff --git a/docs/source/markdown/podman-start.1.md b/docs/source/markdown/podman-start.1.md index 600d3859a..1822eab34 100644 --- a/docs/source/markdown/podman-start.1.md +++ b/docs/source/markdown/podman-start.1.md @@ -16,25 +16,25 @@ 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. (This option is not available with the remote Podman 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 300106796..a4f4f68a3 100644 --- a/docs/source/markdown/podman-stats.1.md +++ b/docs/source/markdown/podman-stats.1.md @@ -20,24 +20,24 @@ 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. (This option is not available with the remote Podman 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 a1e9675c1..bcb928e57 100644 --- a/docs/source/markdown/podman-stop.1.md +++ b/docs/source/markdown/podman-stop.1.md @@ -9,7 +9,7 @@ podman\-stop - Stop one or more running containers **podman container stop** [*options*] *container* ... ## DESCRIPTION -Stops one or more containers. You may use container IDs or names as input. The **--time** switch +Stops one or more containers. You may use container IDs or names as input. The **\-\-time** switch allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command is issued to the container. The default is 10 seconds. By default, containers are stopped with SIGTERM and then SIGKILL after the timeout. The SIGTERM default can be overridden by the image used to create the @@ -17,26 +17,26 @@ 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. (This option is not available with the remote Podman 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 32c16d6a1..5f5d2bc7d 100644 --- a/docs/source/markdown/podman-system-connection-add.1.md +++ b/docs/source/markdown/podman-system-connection-add.1.md @@ -15,21 +15,21 @@ The user will be prompted for the remote ssh login password or key file pass phr ## OPTIONS -#### **--default**=*false*, **-d** +#### **\-\-default**=*false*, **-d** 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. Podman prompts for the login password on the remote server. -#### **--port**=*port*, **-p** +#### **\-\-port**=*port*, **-p** 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 f3db2d020..98c8ad3ad 100644 --- a/docs/source/markdown/podman-system-df.1.md +++ b/docs/source/markdown/podman-system-df.1.md @@ -10,11 +10,11 @@ podman\-system\-df - Show podman disk usage Show podman disk usage ## OPTIONS -#### **--format**=*format* +#### **\-\-format**=*format* Pretty-print images using a Go template -#### **--verbose**, **-v** +#### **\-\-verbose**, **-v** Show detailed information on space usage ## EXAMPLE diff --git a/docs/source/markdown/podman-system-migrate.1.md b/docs/source/markdown/podman-system-migrate.1.md index 913f119b0..45f2ce547 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 791503a2c..50a25bf6d 100644 --- a/docs/source/markdown/podman-system-prune.1.md +++ b/docs/source/markdown/podman-system-prune.1.md @@ -9,16 +9,16 @@ podman\-system\-prune - Remove all unused pod, container, image and volume data ## DESCRIPTION **podman system prune** removes all unused containers (both dangling and unreferenced), pods and optionally, volumes from local storage. -With the **--all** option, you can delete all unused images. Unused images are dangling images as well as any image that does not have any containers based on it. +With the **\-\-all** option, you can delete all unused images. Unused images are dangling images as well as any image that does not have any containers based on it. -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. +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** Recursively remove all unused pod, container, image and volume data (Maximum 50 iterations.) -#### **--filter**=*filters* +#### **\-\-filter**=*filters* Provide filter values. @@ -33,15 +33,15 @@ The until filter can be Unix timestamps, date formatted timestamps, or Go durati The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes containers and images with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes containers and images without the specified labels. -#### **--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 744f917df..9644d8d90 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 93f18adf1..83ede074c 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -25,12 +25,12 @@ Note: The default systemd unit files (system and user) change the log-level opti ## 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, therefore 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 7eab62028..70a09fc3c 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 09e8f7423..1bfe0dccb 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.(This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-unmount.1.md b/docs/source/markdown/podman-unmount.1.md index 2832e5fdb..d09762d46 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 ae178647a..2c344236f 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 70053c940..351faadbb 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 a54e66372..ba03c4809 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 a06411000..093b978a7 100644 --- a/docs/source/markdown/podman-volume-create.1.md +++ b/docs/source/markdown/podman-volume-create.1.md @@ -10,24 +10,24 @@ podman\-volume\-create - Create a new volume Creates an empty volume and prepares it to be used by containers. The volume can be created with a specific name, if a name is not given a random name is -generated. You can add metadata to the volume by using the **--label** flag and -driver options can be set using the **--opt** flag. +generated. You can add metadata to the volume by using the **\-\-label** flag and +driver options can be set using the **\-\-opt** flag. ## OPTIONS -#### **--driver**=*driver* +#### **\-\-driver**=*driver* Specify the volume driver name (default **local**). Setting this to a value other than **local** Podman will attempt to create the volume using a volume plugin with the given name. Such plugins must be defined in the **volume_plugins** section of the **containers.conf**(5) configuration file. -#### **--help** +#### **\-\-help** Print usage statement -#### **--label**=*label*, **-l** +#### **\-\-label**=*label*, **-l** Set metadata for a volume (e.g., --label mykey=value). -#### **--opt**=*option*, **-o** +#### **\-\-opt**=*option*, **-o** Set driver specific options. For the default driver, **local**, this allows a volume to be configured to mount a filesystem on the host. diff --git a/docs/source/markdown/podman-volume-exists.1.md b/docs/source/markdown/podman-volume-exists.1.md index ead806bd9..e75159d56 100644 --- a/docs/source/markdown/podman-volume-exists.1.md +++ b/docs/source/markdown/podman-volume-exists.1.md @@ -14,7 +14,7 @@ of `0` when the volume is found. A `1` will be returned otherwise. An exit code ## OPTIONS -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman-volume-inspect.1.md b/docs/source/markdown/podman-volume-inspect.1.md index ea0ee91b4..7273b817a 100644 --- a/docs/source/markdown/podman-volume-inspect.1.md +++ b/docs/source/markdown/podman-volume-inspect.1.md @@ -9,22 +9,22 @@ podman\-volume\-inspect - Get detailed information on one or more volumes ## DESCRIPTION Display detailed information on one or more volumes. The output can be formatted using -the **--format** flag and a Go template. To get detailed information about all the -existing volumes, use the **--all** flag. +the **\-\-format** flag and a Go template. To get detailed information about all the +existing volumes, use the **\-\-all** flag. Volumes can be queried individually by providing their full name or a unique partial name. ## OPTIONS -#### **--all**, **-a** +#### **\-\-all**, **-a** Inspect all volumes. -#### **--format**=*format*, **-f** +#### **\-\-format**=*format*, **-f** 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 48853bdfd..5214980a3 100644 --- a/docs/source/markdown/podman-volume-ls.1.md +++ b/docs/source/markdown/podman-volume-ls.1.md @@ -8,25 +8,25 @@ podman\-volume\-ls - List all the available volumes ## DESCRIPTION -Lists all the volumes that exist. The output can be filtered using the **--filter** -flag and can be formatted to either JSON or a Go template using the **--format** -flag. Use the **--quiet** flag to print only the volume names. +Lists all the volumes that exist. The output can be filtered using the **\-\-filter** +flag and can be formatted to either JSON or a Go template using the **\-\-format** +flag. Use the **\-\-quiet** flag to print only the volume names. ## OPTIONS -#### **--filter**=*filter*, **-f** +#### **\-\-filter**=*filter*, **-f** Filter volume output. -#### **--format**=*format* +#### **\-\-format**=*format* Format volume output using Go template. -#### **--help** +#### **\-\-help** Print usage statement. -#### **--quiet**, **-q** +#### **\-\-quiet**, **-q** Print volume output in quiet mode. Only print the volume names. diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md index 9477cb5d5..b1ca72623 100644 --- a/docs/source/markdown/podman-volume-prune.1.md +++ b/docs/source/markdown/podman-volume-prune.1.md @@ -8,18 +8,18 @@ podman\-volume\-prune - Remove all unused volumes ## DESCRIPTION -Removes unused volumes. By default all unused volumes will be removed, the **--filter** flag can +Removes unused volumes. By default all unused volumes will be removed, the **\-\-filter** flag can be used to filter specific volumes. You will be prompted to confirm the removal of all the -unused volumes. To bypass the confirmation, use the **--force** flag. +unused volumes. To bypass the confirmation, use the **\-\-force** flag. ## OPTIONS -#### **--force**, **-f** +#### **\-\-force**, **-f** Do not prompt for confirmation. -#### **--filter** +#### **\-\-filter** Filter volumes to be pruned. Volumes can be filtered by the following attributes: @@ -30,7 +30,7 @@ Filter volumes to be pruned. Volumes can be filtered by the following attributes - opt - scope -#### **--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 c066d1c6e..2727ea640 100644 --- a/docs/source/markdown/podman-volume-rm.1.md +++ b/docs/source/markdown/podman-volume-rm.1.md @@ -9,22 +9,22 @@ podman\-volume\-rm - Remove one or more volumes ## DESCRIPTION Removes one or more volumes. Only volumes that are not being used will be removed. -If a volume is being used by a container, an error will be returned unless the **--force** -flag is being used. To remove all volumes, use the **--all** flag. +If a volume is being used by a container, an error will be returned unless the **\-\-force** +flag is being used. To remove all volumes, use the **\-\-all** flag. Volumes can be removed individually by providing their full name or a unique partial name. ## OPTIONS -#### **--all**, **-a** +#### **\-\-all**, **-a** Remove all volumes. -#### **--force**, **-f** +#### **\-\-force**, **-f** 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 fac017fe6..3697cc94a 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. (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 7bf7aa210..7a6a51c39 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -25,34 +25,34 @@ man pages. ## 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`) Remote connections use local containers.conf for default. -#### **--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**. When *file* is specified, the events are stored under a subdirectory -of the *tmpdir* location (see **--tmpdir** below). +of the *tmpdir* location (see **\-\-tmpdir** below). -#### **--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. @@ -68,7 +68,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. @@ -80,23 +80,23 @@ Identity value resolution precedence: - `containers.conf` Remote connections use local containers.conf for default. -#### **--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 Remote connections use local containers.conf for default. -#### **--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>]` @@ -115,21 +115,21 @@ URL value resolution precedence: - `unix://run/podman/podman.sock` Remote connections use local containers.conf for default. -#### **--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: "/run/containers/storage" for UID 0, "/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 @@ -139,30 +139,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 diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages index 08e56c77e..42dd3634f 100755 --- a/hack/xref-helpmsgs-manpages +++ b/hack/xref-helpmsgs-manpages @@ -320,7 +320,7 @@ sub podman_man { } } - # Options should always be of the form '**-f**' or '**--flag**', + # Options should always be of the form '**-f**' or '**\-\-flag**', # possibly separated by comma-space. elsif ($section eq 'flags') { # e.g. 'podman run --ip6', documented in man page, but nonexistent @@ -334,9 +334,11 @@ sub podman_man { # If option has long and short form, long must come first. # This is a while-loop because there may be multiple long # option names, e.g. --net/--network - while ($line =~ s/^\*\*(--[a-z0-9-]+)\*\*(=\*[a-zA-Z0-9-]+\*)?(,\s+)?//g) { - $man{$1} = 1; - push @most_recent_flags, $1; + while ($line =~ s/^\*\*\\-\\-([a-z0-9-]+)\*\*(=\*[a-zA-Z0-9-]+\*)?(,\s+)?//g) { + # add -- to the flag name + my $flag = "--".$1; + $man{$flag} = 1; + push @most_recent_flags, $flag; } # Short form if ($line =~ s/^\*\*(-[a-zA-Z0-9])\*\*(=\*[a-zA-Z0-9-]+\*)?//g) { |