Snelle referentie

CLIP Opdrachtregelpagina's Syntaxis Spiekbrief

Beknopte handleiding voor de Command Line Interface Pages (CLIP) specificatie: paginalay-outs, tijdelijke aanduidingen en herhaalde opties.

· Gepubliceerd

CLIP (Command Line Interface Pages) is een gestructureerde Markdown-specificatie voor terminalopdrachtreferenties en vereenvoudigde man-pagina's.

Paginastructuurindeling

# command_name

> Korte beschrijving die uitlegt wat de opdracht doet.
> Meer informatie: https://example.com/docs

- Beschrijving van voorbeeldtaak:

`command --option {{argument}}`

Plaatshouder-syntaxis (Placeholder Syntax)

Primitieve tijdelijke aanduidingen

- Pauzeer terminaluitvoering voor een opgegeven aantal seconden:

`sleep {int seconds: 2}s`

Optie- & herhaalde argumentplaathouders

- Maak een archief en schrijf het naar een bestand:

`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
  • {int name: default}: Getypeerde geheelgetalparameter.
  • {option: --flag, -f}: Opdrachtregel-flagvariant.
  • {/?file name: target.tar}: Optioneel bestandspad.
  • {/?path+ input}: Een of meer herhaalbare padargumenten.

Referenties

Verwante onderwerpen