summaryrefslogtreecommitdiff
path: root/completions/Readme.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2020-11-08 21:50:51 +0100
committerPaul Holzinger <paul.holzinger@web.de>2020-11-12 11:40:29 +0100
commitae3816614de1c2a0c9ab9cd05afebc5b1dda6429 (patch)
tree11deb2f5b2bb87d1869f7258b8f2e9cc46b57e00 /completions/Readme.md
parentb5d1d89a377e38762a75c2042dcc50a370ba6707 (diff)
downloadpodman-ae3816614de1c2a0c9ab9cd05afebc5b1dda6429.tar.gz
podman-ae3816614de1c2a0c9ab9cd05afebc5b1dda6429.tar.bz2
podman-ae3816614de1c2a0c9ab9cd05afebc5b1dda6429.zip
Install the new shell completion logic
Add a new make target (completion) to generate the shell completion scripts. This will generate the scripts for bash, zsh and fish for both podman and podman-remote with `podman completion`. The scripts are put into the completions directory and can be installed system wide with `sudo make install.completions`. This commit replaces the current handwritten scripts for bash and zsh. The `validate.completion` target has been adjusted to make sure nobody edits these scripts directly. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'completions/Readme.md')
-rw-r--r--completions/Readme.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/completions/Readme.md b/completions/Readme.md
new file mode 100644
index 000000000..9a3eac480
--- /dev/null
+++ b/completions/Readme.md
@@ -0,0 +1,7 @@
+# Shell completion scripts
+
+Podman offers shell completion scripts for bash, zsh and fish. The completion scripts are available for both `podman` and `podman-remote`.
+
+The shell completion scripts are generated by `make completion`, do not edit these files directly. To install them you can run `sudo make install.completions`.
+
+For information about these sripts see [`man podman-completion`](../docs/source/markdown/podman-completion.1.md)