Referință rapidă

Fişă de noțiuni sintaxă pagini CLIP

Ghid de referință rapidă pentru specificația Command Line Interface Pages (CLIP): aspectul paginilor, substituenți și opțiuni repetabile.

· Publicat

CLIP (Command Line Interface Pages) este o specificație Markdown structurată pentru referințe rapide de comenzi în terminal și pagini man simplificate.

Aspectul structurii paginii

# command_name

> Scurtă descriere a funcționalității comenzii.
> Mai multe informații: https://example.com/docs

- Descriere activitate exemplu:

`command --option {{argument}}`

Sintaxa substituenților (Placeholder Syntax)

Substituenți primitivi

- Întrerupe execuția în terminal pentru un număr dat de secunde:

`sleep {int seconds: 2}s`

Substituenți pentru opțiuni și argumente repetate

- Creează o arhivă și scrie-o într-un fișier:

`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
  • {int name: default}: Parametru întreg tipizat.
  • {option: --flag, -f}: Variantă opțiune linie de comandă.
  • {/?file name: target.tar}: Cale fișier opțională.
  • {/?path+ input}: Unul sau mai multe argumente de cale repetabile.

Referințe

Subiecte conexe