opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-05-21 00:56:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Use code blocks for commands in podman-completion

Browse Source 
Currently, due to sphinx smart quote features being enabled, fancy quotes are used in the commands. This means the docs are harder to use as the commands cannot be copy/pasted into a terminal.

Wrapping the code in code blocks fixes this. An alternative would be to disable smart quotes entirely, but this seems over-the-top (especially considering wrapping commands in code blocks harmonises this page with most of the other documentation)

Signed-off-by: Adam Jones <domdomegg+git@gmail.com>
This commit is contained in:
Adam Jones
2023-08-02 14:07:57 +01:00
committed by GitHub
parent cd5ce63724
commit 18e75daa53
1 changed files with 23 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/source/markdown/podman-completion.1.md
View File

@ -28,33 +28,47 @@ The default is **false**.
### BASH ### BASH
`bash-completion` has to be installed on the system. `bash-completion` has to be installed on the system.
To load the completion script into the current session run:\ To load the completion script into the current session run:
**source <(podman completion bash)** ```
source <(podman completion bash)
```
To make it available for all bash sessions run:\ To make it available for all bash sessions run:
**podman completion -f /etc/bash_completion.d/podman bash**. ```
podman completion -f /etc/bash_completion.d/podman bash
```
### ZSH ### ZSH
Shell completion needs to be already enabled in the environment. The following can be executed:\ Shell completion needs to be already enabled in the environment. The following can be executed:\
**echo "autoload -U compinit; compinit" >> ~/.zshrc** ```
echo "autoload -U compinit; compinit" >> ~/.zshrc
```
To make it available for all zsh sessions run:\ To make it available for all zsh sessions run:\
**podman completion -f "${fpath[1]}/_podman" zsh** ```
podman completion -f "${fpath[1]}/_podman" zsh
```
Once the shell is reloaded the auto-completion works. Once the shell is reloaded the auto-completion works.
### FISH ### FISH
To load the completion script into the current session run: 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: To make it available for all fish sessions run:
**podman completion -f ~/.config/fish/completions/podman.fish fish** ```
podman completion -f ~/.config/fish/completions/podman.fish fish
```
### POWERSHELL ### POWERSHELL
To load the completion script into the current session run: 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 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. completion output to a file and source that to the user's powershell profile.