github.com/hanks177/podman/v4@v4.1.3-0.20220613032544-16d90015bc83/docs/source/markdown/podman-completion.1.md (about)

     1  % podman-completion(1)
     2  
     3  ## NAME
     4  podman\-completion - Generate shell completion scripts
     5  
     6  ## SYNOPSIS
     7  **podman completion** [*options*]   *bash* | *zsh* | *fish* | *powershell*
     8  
     9  ## DESCRIPTION
    10  **podman completion** generates shell completion scripts for a variety of shells. Supported shells are *bash*, *zsh*, *fish* and *powershell*.
    11  
    12  These script are used by the shell to provide suggestions and complete commands when the command is typed and `[TAB]` is pressed.
    13  
    14  Usually these scripts are automatically installed via the package manager.
    15  
    16  ## OPTIONS
    17  #### **--file**, **-f**=*file*
    18  
    19  Write the generated output to a file.
    20  
    21  #### **--no-desc**
    22  
    23  Do not provide description in the completions.\
    24  The default is **false**.
    25  
    26  ## Installation
    27  
    28  ### BASH
    29  `bash-completion` has to be installed on the system.
    30  
    31  To load the completion script into the current session run:\
    32  **source <(podman completion bash)**.
    33  
    34  To make it available for all bash sessions run:\
    35  **podman completion -f /etc/bash_completion.d/podman bash**.
    36  
    37  
    38  ### ZSH
    39  Shell completion needs to be already enabled in the environment. The following can be executed:\
    40  **echo "autoload -U compinit; compinit" >> ~/.zshrc**
    41  
    42  To make it available for all zsh sessions run:\
    43  **podman completion -f "${fpath[1]}/_podman" zsh**
    44  
    45  Once the shell is reloaded the auto-completion should be working.
    46  
    47  
    48  ### FISH
    49  To load the completion script into the current session run:
    50  **podman completion fish | source**
    51  
    52  To make it available for all fish sessions run:
    53  **podman completion -f ~/.config/fish/completions/podman.fish fish**
    54  
    55  ### POWERSHELL
    56  To load the completion script into the current session run:
    57  **podman.exe completion powershell | Out-String | Invoke-Expression**
    58  
    59  To make it available in all powershell sessions that a user has, write the
    60  completion output to a file and source that to the user's powershell profile.
    61  More information about profiles is available with **Get-Help about_Profiles**.
    62  
    63  ## SEE ALSO
    64  **[podman(1)](podman.1.md)**, **zsh(1)**, **fish(1)**, **powershell(1)**