summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-completion.1.md
diff options
context:
space:
mode:
authorAlexander Richter <67486332+Procyhon@users.noreply.github.com>2021-06-08 14:09:29 +0200
committerAlexander Richter <67486332+Procyhon@users.noreply.github.com>2021-06-12 18:50:20 +0200
commit4bca1984a566fee9b62c4e798788082943d09e12 (patch)
tree056253356c6fc3e97d80abdca7dde283997a03d9 /docs/source/markdown/podman-completion.1.md
parentd03963380aeb337556e9598b406cdbd6a774fc3c (diff)
downloadpodman-4bca1984a566fee9b62c4e798788082943d09e12.tar.gz
podman-4bca1984a566fee9b62c4e798788082943d09e12.tar.bz2
podman-4bca1984a566fee9b62c4e798788082943d09e12.zip
UPDATE manpages with MANPAGE_SYNTAX
The following manpages have been adapted to the MANPAGE_SYNTAX: - podman-completion - podman-container-checkpoint - podman-container-cleanup - podman-container-exists The following manpages have had little changes: - podman-attach - podman-commit - MANPAGE_SYNTAX - Makefile Signed-off-by: Alexander Richter <67486332+Procyhon@users.noreply.github.com>
Diffstat (limited to 'docs/source/markdown/podman-completion.1.md')
-rw-r--r--docs/source/markdown/podman-completion.1.md42
1 files changed, 21 insertions, 21 deletions
diff --git a/docs/source/markdown/podman-completion.1.md b/docs/source/markdown/podman-completion.1.md
index 4ebe4e2e1..f8589ce68 100644
--- a/docs/source/markdown/podman-completion.1.md
+++ b/docs/source/markdown/podman-completion.1.md
@@ -4,60 +4,60 @@
podman\-completion - Generate shell completion scripts
## SYNOPSIS
-**podman completion** [*options*] *bash*|*zsh*|*fish*|*powershell*
+**podman completion** [*options*] *bash* | *zsh* | *fish* | *powershell*
## DESCRIPTION
-The completion command generates shell completion scripts for a variety of shells. Supported shells are **bash**, **zsh**, **fish** and **powershell**.
+**podman completion** generates shell completion scripts for a variety of shells. Supported shells are *bash*, *zsh*, *fish* and *powershell*.
-These script are used by the shell to provide suggestions and complete commands when you are typing the command and press [TAB].
+These script are used by the shell to provide suggestions and complete commands when the command is typed and `[TAB]` is pressed.
Usually these scripts are automatically installed via the package manager.
## OPTIONS
-#### **--file**, **-f**
+#### **--file**, **-f**=*file*
-Write the generated output to file.
+Write the generated output to a file.
#### **--no-desc**
-Do not provide description in the completions.
+Do not provide description in the completions. The default is **false**.
## Installation
### BASH
-Make sure you have `bash-completion` installed on the system.
+`bash-completion` has to be installed on the system.
-To load the completion script into the current session run:
-`source <(podman completion bash)`
+To load the completion script into the current session run:\
+**source <(podman completion bash)**.
-To make it available for all bash sessions run:
-`podman completion bash -f /etc/bash_completion.d/podman`
+To make it available for all bash sessions run:\
+**podman completion -f /etc/bash_completion.d/podman bash**.
### ZSH
-If shell completion is not already enabled in the environment you will need to enable it. You can execute the following once:
-`echo "autoload -U compinit; compinit" >> ~/.zshrc`
+Shell completion needs to be already enabled in the environment. The following can be executed:\
+**echo "autoload -U compinit; compinit" >> ~/.zshrc**
-To make it available for all zsh sessions run:
-`podman completion zsh -f "${fpath[1]}/_podman"`
+To make it available for all zsh sessions run:\
+**podman completion -f "${fpath[1]}/_podman zsh"**
-Once you reload the shell the auto-completion should be working.
+Once the shell is reloaded the auto-completion should be working.
### FISH
To load the completion script into the current session run:
-`podman completion fish | source`
+**podman completion fish | source**
To make it available for all fish sessions run:
-`podman completion fish -f ~/.config/fish/completions/podman.fish`
+**podman completion -f ~/.config/fish/completions/podman.fish fish**
### POWERSHELL
To load the completion script into the current session run:
-`podman.exe completion powershell | Out-String | Invoke-Expression`
+**podman.exe completion powershell | Out-String | Invoke-Expression**
To make it available in all powershell sessions that a user has, write the
completion output to a file and source that to the user's powershell profile.
-More information about profiles is available with `Get-Help about_Profiles`.
+More information about profiles is available with **Get-Help about_Profiles**.
## SEE ALSO
-[podman(1)](podman.1.md)
+**[podman(1)](podman.1.md)**, zsh(1), fish(1), powershell(1)