Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise completions docs #662

Merged
merged 2 commits into from
Jul 15, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@
- [Kommandos](./referenz/kommandos/index.md)
- [cat](./referenz/kommandos/cat.md)
- [convert](./referenz/kommandos/convert.md)
- [completions](./referenz/kommandos/completions.md)
Original file line number Diff line number Diff line change
@@ -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
Autovervollständigung verfügbar sind.
nwagner84 marked this conversation as resolved.
Show resolved Hide resolved

## 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:

Expand All @@ -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
Expand All @@ -38,34 +42,33 @@ $ pica completions bash \
-o $(brew --prefix)/etc/bash_completion.d/pica.bash-completion
```

### Elvish
## Elvish

```bash
$ mkdir -p ~/.local/share/elvish/lib/completions
$ 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
```
2 changes: 2 additions & 0 deletions docs/book/src/referenz/kommandos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading