CLIP (Command Line Interface Pages) to ustrukturyzowana specyfikacja Markdown dla dokumentacji poleceń terminala i uproszczonych stron man.
Układ struktury strony
# command_name
> Krótki opis wyjaśniający działanie polecenia.
> Więcej informacji: https://example.com/docs
- Przykładowy opis zadania:
`command --option {{argument}}`
Składnia symboli zastępczych (Placeholders)
Podstawowe symbole zastępcze
- Wstrzymaj wykonywanie poleceń w terminalu na określoną liczbę sekund:
`sleep {int seconds: 2}s`
Symbole opcji i powtarzalnych argumentów
- Utwórz archiwum i zapisz je w pliku:
`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
{int name: default}: Parametr liczby całkowitej.{option: --flag, -f}: Wariant flagi wiersza poleceń.{/?file name: target.tar}: Opcjonalna ścieżka do pliku.{/?path+ input}: Jeden lub więcej powtarzalnych argumentów ścieżki.