Riferimento rapido

Scheda di riferimento sintassi pagine CLIP

Guida rapida per la specifica Command Line Interface Pages (CLIP): struttura pagina, segnaposto di comando e parametri opzionali ripetuti.

· Pubblicato

CLIP (Command Line Interface Pages) è una specifica Markdown strutturata per riferimenti ai comandi di terminale e pagine man semplificate.

Struttura della pagina

# command_name

> Breve descrizione di ciò che fa il comando.
> Ulteriori informazioni: https://example.com/docs

- Descrizione attività di esempio:

`command --option {{argument}}`

Sintassi dei segnaposto (Placeholders)

Segnaposto primitivi

- Sospendi l'esecuzione del terminale per un determinato numero di secondi:

`sleep {int seconds: 2}s`

Segnaposto per opzioni e argomenti ripetuti

- Crea un archivio e scrivilo su un file:

`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
  • {int name: default}: Parametro intero tipizzato.
  • {option: --flag, -f}: Variante flag da riga di comando.
  • {/?file name: target.tar}: Percorso file opzionale.
  • {/?path+ input}: Uno o più argomenti di percorso ripetibili.

Riferimenti

Argomenti correlati