aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-02-10 17:57:11 +0100
committerPaul Holzinger <paul.holzinger@web.de>2021-03-29 15:00:09 +0200
commit6a78fcaa0a5451e8b9839c689b01c9264e391401 (patch)
treeaaf09ea076b9a531526d7836fd0709a98a8e606b /docs
parent259004f0a9cc18018127baec0bfcf8bc091dabb6 (diff)
downloadpodman-6a78fcaa0a5451e8b9839c689b01c9264e391401.tar.gz
podman-6a78fcaa0a5451e8b9839c689b01c9264e391401.tar.bz2
podman-6a78fcaa0a5451e8b9839c689b01c9264e391401.zip
Add powershell completions
Add support for generating powershell completion files. This is especially useful for people using the podman remote client on windows. [NO TESTS NEEDED] Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-completion.1.md25
1 files changed, 16 insertions, 9 deletions
diff --git a/docs/source/markdown/podman-completion.1.md b/docs/source/markdown/podman-completion.1.md
index 50b0b6145..59d88f699 100644
--- a/docs/source/markdown/podman-completion.1.md
+++ b/docs/source/markdown/podman-completion.1.md
@@ -4,10 +4,10 @@
podman\-completion - Generate shell completion scripts
## SYNOPSIS
-**podman completion** [*options*] *bash*|*zsh*|*fish*
+**podman completion** [*options*] *bash*|*zsh*|*fish*|*powershell*
## DESCRIPTION
-The completion command allows you to generate shell completion scripts. Supported shells are **bash**, **zsh** and **fish**.
+The completion command 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].
@@ -25,32 +25,39 @@ Do not provide description in the completions.
## Installation
### BASH
-Make sure you have `bash-completion` installed on your system.
+Make sure you have `bash-completion` installed on the system.
-To load the completion script into your current session run:
+To load the completion script into the current session run:
`source <(podman completion bash)`
-To make it available in all your bash sessions run:
+To make it available for all 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:
+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`
-To make it available in all your zsh sessions run:
+To make it available for all 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:
+To load the completion script into the current session run:
`podman completion fish | source`
-To make it available in all your fish sessions run:
+To make it available for all fish sessions run:
`podman completion fish -f ~/.config/fish/completions/podman.fish`
+### POWERSHELL
+To load the completion script into the current session run:
+`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`.
## SEE ALSO
[podman(1)](podman.1.md)