CLIP (Command Line Interface Pages) ist eine strukturierte Markdown-Spezifikation für Terminalbefehl-Referenzen und vereinfachte Manpages.
Seitenstruktur-Layout
# command_name
> Kurze Beschreibung der Funktion des Befehls.
> Weitere Informationen: https://example.com/docs
- Beispielhafte Aufgabenbeschreibung:
`command --option {{argument}}`
Platzhalter-Syntax (Placeholder Syntax)
Primitive Platzhalter
- Terminalausführung für eine angegebene Anzahl an Sekunden anhalten:
`sleep {int seconds: 2}s`
Platzhalter für Optionen & wiederholte Argumente
- Ein Archiv erstellen und in eine Datei schreiben:
`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
{int name: default}: Typisierter Ganzzahl-Parameter.{option: --flag, -f}: Befehlszeilen-Flag-Variante.{/?file name: target.tar}: Optionaler Dateipfad.{/?path+ input}: Ein oder mehrere wiederholbare Pfadargumente.