diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/Commands.rst | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-build.1.md | 9 | ||||
| -rw-r--r-- | docs/source/markdown/podman-completion.1.md | 56 | ||||
| -rw-r--r-- | docs/source/markdown/podman-volume-ls.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman.1.md | 5 |
5 files changed, 70 insertions, 4 deletions
diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst index 881dcb4b6..cd5d894da 100644 --- a/docs/source/Commands.rst +++ b/docs/source/Commands.rst @@ -3,7 +3,7 @@ Commands ======== -:doc:`Podman <markdown/podman.1>` (Pod Manager) Global Options +:doc:`Podman <markdown/podman.1>` (Pod Manager) Global Options, Environment Variables, Exit Codes, Configuration Files, and more :doc:`attach <markdown/podman-attach.1>` Attach to a running container diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md index 130d3365e..4570bf3ff 100644 --- a/docs/source/markdown/podman-build.1.md +++ b/docs/source/markdown/podman-build.1.md @@ -219,6 +219,13 @@ 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]* + +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_] Add a host device to the container. Optional *permissions* parameter @@ -394,7 +401,7 @@ The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap. -#### **--network**=*mode* +#### **--network**=*mode*, **--net** Sets the configuration for network namespaces when handling `RUN` instructions. diff --git a/docs/source/markdown/podman-completion.1.md b/docs/source/markdown/podman-completion.1.md new file mode 100644 index 000000000..50b0b6145 --- /dev/null +++ b/docs/source/markdown/podman-completion.1.md @@ -0,0 +1,56 @@ +% podman-completion(1) + +## NAME +podman\-completion - Generate shell completion scripts + +## SYNOPSIS +**podman completion** [*options*] *bash*|*zsh*|*fish* + +## DESCRIPTION +The completion command allows you to generate shell completion scripts. Supported shells are **bash**, **zsh** and **fish**. + +These script are used by the shell to provide suggestions and complete commands when you are typing the command and press [TAB]. + +Usually these scripts are automatically installed via the package manager. + +## OPTIONS +#### **--file**, **-f** + +Write the generated output to file. + +#### **--no-desc** + +Do not provide description in the completions. + +## Installation + +### BASH +Make sure you have `bash-completion` installed on your system. + +To load the completion script into your current session run: +`source <(podman completion bash)` + +To make it available in all your bash sessions run: +`podman completion bash -f /etc/bash_completion.d/podman` + + +### ZSH +If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once: +`echo "autoload -U compinit; compinit" >> ~/.zshrc` + +To make it available in all your zsh sessions run: +`podman completion zsh -f "${fpath[1]}/_podman"` + +Once you reload the shell the autocompletion should be working. + + +### FISH +To load the completion script into your current session run: +`podman completion fish | source` + +To make it available in all your fish sessions run: +`podman completion fish -f ~/.config/fish/completions/podman.fish` + + +## SEE ALSO +[podman(1)](podman.1.md) diff --git a/docs/source/markdown/podman-volume-ls.1.md b/docs/source/markdown/podman-volume-ls.1.md index 98c3fae54..48853bdfd 100644 --- a/docs/source/markdown/podman-volume-ls.1.md +++ b/docs/source/markdown/podman-volume-ls.1.md @@ -40,6 +40,8 @@ $ podman volume ls --format json $ podman volume ls --format "{{.Driver}} {{.Scope}}" $ podman volume ls --filter name=foo,label=blue + +$ podman volume ls --filter label=key=value ``` ## SEE ALSO diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 993f285ed..1954ca2aa 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -168,7 +168,7 @@ podman --remote flag, only the global options `--url`, `--identity`, `--log-leve Connection information can also be managed using the containers.conf file. -## Exit Status +## Exit Codes The exit code from `podman` gives information about why the container failed to run or why it exited. When `podman` commands exit with a non-zero code, @@ -205,6 +205,7 @@ the exit codes follow the `chroot` standard, see below: | [podman-auto-update(1)](podman-auto-update.1.md) | Auto update containers according to their auto-update policy | | [podman-build(1)](podman-build.1.md) | Build a container image using a Containerfile. | | [podman-commit(1)](podman-commit.1.md) | Create new image based on the changed container. | +| [podman-completion(1)](podman-completion.1.md) | Generate shell completion scripts | | [podman-container(1)](podman-container.1.md) | Manage containers. | | [podman-cp(1)](podman-cp.1.md) | Copy files/folders between a container and the local filesystem. | | [podman-create(1)](podman-create.1.md) | Create a new container. | @@ -256,7 +257,7 @@ the exit codes follow the `chroot` standard, see below: | [podman-volume(1)](podman-volume.1.md) | Simple management tool for volumes. | | [podman-wait(1)](podman-wait.1.md) | Wait on one or more containers to stop and print their exit codes. | -## FILES +## CONFIGURATION FILES **containers.conf** (`/usr/share/containers/containers.conf`, `/etc/containers/containers.conf`, `$HOME/.config/containers/containers.conf`) |