Référence rapide

Aide-mémoire de syntaxe des pages CLIP

Guide de référence rapide pour Command Line Interface Pages (CLIP) : mise en page, balises d'arguments et options répétées.

· Publié le

CLIP (Command Line Interface Pages) est une spécification Markdown structurée pour les références de commandes de terminal et les pages man simplifiées.

Structure générale de la page

# command_name

> Courte description expliquant le rôle de la commande.
> Plus d'informations : https://example.com/docs

- Description d'une tâche exemple :

`command --option {{argument}}`

Syntaxe des espaces réservés (Placeholders)

Espaces réservés primitifs

- Suspendre l'exécution du terminal pendant un nombre défini de secondes :

`sleep {int seconds: 2}s`

Espaces réservés d'options et d'arguments répétés

- Créer une archive et l'enregistrer dans un fichier :

`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
  • {int name: default} : Paramètre entier typé.
  • {option: --flag, -f} : Variante d'option en ligne de commande.
  • {/?file name: target.tar} : Chemin de fichier optionnel.
  • {/?path+ input} : Un ou plusieurs chemins répétés.

Références

Sujets associés