diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 312d73de1..85b4252ff 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -12,3 +12,4 @@ - [Kommandos](./referenz/kommandos/index.md) - [cat](./referenz/kommandos/cat.md) - [convert](./referenz/kommandos/convert.md) + - [completions](./referenz/kommandos/completions.md) diff --git a/docs/book.bak/src/de/guide/cmds/completions.md b/docs/book/src/referenz/kommandos/completions.md similarity index 66% rename from docs/book.bak/src/de/guide/cmds/completions.md rename to docs/book/src/referenz/kommandos/completions.md index d7adbda0e..ea945e5b7 100644 --- a/docs/book.bak/src/de/guide/cmds/completions.md +++ b/docs/book/src/referenz/kommandos/completions.md @@ -1,9 +1,22 @@ # completions -Das `completions`-Kommando erzeugt Dateien, die Anweisungen enthalten, welche Argumente -und Optionen des pica-Kommandos für eine -[Shell](https://de.wikipedia.org/wiki/Shell_(Betriebssystem)) zur Autovervollständigung -verfügbar sind. +![stability-badge](https://img.shields.io/badge/stability-stable-green?style=flat-square) + +Das `completions`-Kommando erzeugt Dateien, die Anweisungen enthalten, +welche Argumente und Optionen des Toolkits für eine +[Shell](https://de.wikipedia.org/wiki/Shell_(Betriebssystem)) zur +Befehlszeilenergänzung verfügbar sind. + +## Beschreibung + +> **Hinweis:** Mit jeder neuen `pica`-Version können sich die Argumente +> und Optionen des _command-line interface_ (CLI) ändern. Daher ist ein +> regelmäßiges Updaten der Skripte zu empfehlen. + +Nachfolgend werden exemplarisch die Befehle gezeigt, die für die +Einbindung in die jeweilige Shell nötig sind. Die Schritte sind vom +System sowie der Nutzereinstellung abhängig und müssen ggf. angepasst +werden. Es werden folgende Shells unterstützt: @@ -13,23 +26,14 @@ Es werden folgende Shells unterstützt: - [Powershell](https://docs.microsoft.com/en-us/powershell/) - und [ZSH](https://zsh.sourceforge.io/). -## Beschreibung - -Nachfolgend werden exemplarisch die Befehle gezeigt, die für die Einbindung in die jeweilige -Shell nötig sind. Die Schritte sind vom System sowie der Nutzereinstellung abhängig und müssen -ggf. angepasst werden. - -> Hinweis: Mit jeder neuen `pica`-Version können sich die Argumente und Optionen des -> _command-line interface_ (CLI) ändern. Daher ist ein regelmäßiges Updaten der Skripte -> zu empfehlen. - -### Bash +## Bash ```bash $ mkdir -p ~/.local/share/bash-completion/completions $ pica completions bash \ -o ~/.local/share/bash-completion/completions/pica ``` + ### Bash (macOS/Homebrew) ```bash @@ -38,7 +42,7 @@ $ pica completions bash \ -o $(brew --prefix)/etc/bash_completion.d/pica.bash-completion ``` -### Elvish +## Elvish ```bash $ mkdir -p ~/.local/share/elvish/lib/completions @@ -46,26 +50,25 @@ $ pica completions elvish -o ~/.local/share/elvish/lib/completions/pica.elv $ echo "use completions/pica" >> ~/.elvish/rc.elv ``` -### Fish +## Fish ```bash $ mkdir -p ~/.config/fish/completions $ pica completions fish -o ~/.config/fish/completions/pica.fish ``` - -### Powershell +## Powershell ```bash $ pica completions powershell \ >> ${env:USERPROFILE}\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 ``` -### ZSH +## ZSH -Der Pfad `~/.zfunc` muss in der Variable `$fpath` gesetzt sein, bevor die Funktion -`compinit` aufgerufen wird. +Der Pfad `~/.zfunc` muss in der Variable `$fpath` gesetzt sein, bevor +die Funktion `compinit` aufgerufen wird. ```bash -$ pica completions zsh -o ~/.zfunc/_pica. +$ pica completions zsh -o ~/.zfunc/_pica ``` diff --git a/docs/book/src/referenz/kommandos/index.md b/docs/book/src/referenz/kommandos/index.md index f1a6233cb..7448b1798 100644 --- a/docs/book/src/referenz/kommandos/index.md +++ b/docs/book/src/referenz/kommandos/index.md @@ -5,3 +5,5 @@ * [cat](./cat.md) — Zusammenfügen (Konkatenieren) von Datensätzen * [convert](./convert.md) — Konvertierung zwischen verschiedenen PICA-Formaten +* [completions](./completions.md) — Erzeugung von Shell-Skripten zur + Autovervollständigung