summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorplustik <plustik@tecks.eu>2023-11-18 21:47:34 +0100
committerplustik <plustik@tecks.eu>2023-11-18 21:47:34 +0100
commitbfb49c1915bf51d344b171316142210bcb843a04 (patch)
tree2315bcafee8c7adcb33911240526899addb9dd93
parente5167365b5c04e322b5ea2a6ba48180ce7fcbb2a (diff)
Add completion to manual
-rw-r--r--manual/src/SUMMARY.md1
-rw-r--r--manual/src/tips-and-tricks/shell-completion.md12
2 files changed, 13 insertions, 0 deletions
diff --git a/manual/src/SUMMARY.md b/manual/src/SUMMARY.md
index 21bd8360..26e5edf7 100644
--- a/manual/src/SUMMARY.md
+++ b/manual/src/SUMMARY.md
@@ -29,6 +29,7 @@
- [Using Delta with Magit](./tips-and-tricks/using-delta-with-magit.md)
- [Using Delta with tmux](./tips-and-tricks/using-delta-with-tmux.md)
- [Using Delta with VSCode](./tips-and-tricks/using-delta-with-vscode.md)
+ - [Generating shell completion files](./tips-and-tricks/shell-completion.md)
- [Comparisons with other tools](./comparisons-with-other-tools.md)
- [Build delta from source](./build-delta-from-source.md)
- [Related projects](./related-projects.md)
diff --git a/manual/src/tips-and-tricks/shell-completion.md b/manual/src/tips-and-tricks/shell-completion.md
new file mode 100644
index 00000000..8f5379cf
--- /dev/null
+++ b/manual/src/tips-and-tricks/shell-completion.md
@@ -0,0 +1,12 @@
+# Generating completion files for various shells
+
+Delta can generate completion files for various shells.
+Use the `--generate-completion` subcommand to print the completion script to stdout:
+
+```sh
+delta --generate-completion <SHELL>
+```
+<SHELL> should be replaced with the lowercase name of the shell for which the script is to be generated.
+Currently bash, elvish, fish, powershell and zsh are supported.
+
+The completion files in `etc/completion` were also generated with this function and may not be up-to-date.