90 lines
2.1 KiB
Groff
90 lines
2.1 KiB
Groff
.nh
|
|
.TH podman-completion 1
|
|
.SH NAME
|
|
podman-completion \- Generate shell completion scripts
|
|
|
|
.SH SYNOPSIS
|
|
\fBpodman completion\fP [\fIoptions\fP] \fIbash\fP | \fIzsh\fP | \fIfish\fP | \fIpowershell\fP
|
|
|
|
.SH DESCRIPTION
|
|
\fBpodman completion\fP generates shell completion scripts for a variety of shells. Supported shells are \fIbash\fP, \fIzsh\fP, \fIfish\fP and \fIpowershell\fP\&.
|
|
|
|
.PP
|
|
These script are used by the shell to provide suggestions and complete commands when the command is typed and \fB[TAB]\fR is pressed.
|
|
|
|
.PP
|
|
Usually these scripts are automatically installed via the package manager.
|
|
|
|
.SH OPTIONS
|
|
.SS \fB--file\fP, \fB-f\fP=\fIfile\fP
|
|
Write the generated output to a file.
|
|
|
|
.SS \fB--no-desc\fP
|
|
Do not provide description in the completions.
|
|
.br
|
|
The default is \fBfalse\fP\&.
|
|
|
|
.SH Installation
|
|
.SS BASH
|
|
\fBbash-completion\fR has to be installed on the system.
|
|
|
|
.PP
|
|
To load the completion script into the current session run:
|
|
|
|
.EX
|
|
source <(podman completion bash)
|
|
.EE
|
|
|
|
.PP
|
|
To make it available for all bash sessions run:
|
|
|
|
.EX
|
|
podman completion -f /etc/bash_completion.d/podman bash
|
|
.EE
|
|
|
|
.SS ZSH
|
|
Shell completion needs to be already enabled in the environment. The following can be executed:
|
|
|
|
.EX
|
|
echo "autoload -U compinit; compinit" >> ~/.zshrc
|
|
.EE
|
|
|
|
.PP
|
|
To make it available for all zsh sessions run:
|
|
|
|
.EX
|
|
podman completion -f "${fpath[1]}/_podman" zsh
|
|
.EE
|
|
|
|
.PP
|
|
Once the shell is reloaded the auto-completion works.
|
|
|
|
.SS FISH
|
|
To load the completion script into the current session run:
|
|
|
|
.EX
|
|
podman completion fish | source
|
|
.EE
|
|
|
|
.PP
|
|
To make it available for all fish sessions run:
|
|
|
|
.EX
|
|
podman completion -f ~/.config/fish/completions/podman.fish fish
|
|
.EE
|
|
|
|
.SS POWERSHELL
|
|
To load the completion script into the current session run:
|
|
|
|
.EX
|
|
podman.exe completion powershell | Out-String | Invoke-Expression
|
|
.EE
|
|
|
|
.PP
|
|
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 \fBGet-Help about_Profiles\fP\&.
|
|
|
|
.SH SEE ALSO
|
|
\fBpodman(1)\fP, \fBzsh(1)\fP, \fBfish(1)\fP, \fBpowershell(1)\fP
|