Comprendre le synopsis dans la page de manuel

27

Je n'ai pas pu comprendre la section SYNOPSIS dans la page de manuel d'une commande. Par exemple, voyons la page de manuel de manlui - même. Par man man:

SYNOPSIS
       man  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R encoding] [-L
       locale] [-m system[,...]] [-M path] [-S list]  [-e  extension]  [-i|-I]
       [--regex|--wildcard]   [--names-only]  [-a]  [-u]  [--no-subpages]  [-P
       pager] [-r prompt] [-7] [-E encoding] [--no-hyphenation] [--no-justifi‐
       cation]  [-p  string]  [-t]  [-T[device]]  [-H[browser]] [-X[dpi]] [-Z]
       [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man -l [-C file] [-d] [-D] [--warnings[=warnings]]  [-R  encoding]  [-L
       locale]  [-P  pager]  [-r  prompt]  [-7] [-E encoding] [-p string] [-t]
       [-T[device]] [-H[browser]] [-X[dpi]] [-Z] file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-hV]
  1. La section SYNOPSIS décrit-elle la syntaxe de la commande?
  2. que signifient ceux-ci [...]et l' [...]intérieur [...]? Signifient-ils quelque chose de facultatif?
  3. Cela |signifie- t -il OU?
  4. Qu'est - ce que ,moyenne en [-m system[,...]]?
  5. La section SYNOPSIS suit-elle les règles utilisées pour les expressions régulières?
Tim
la source
Connexes: "Conventions utilitaires" dans la norme POSIX: pubs.opengroup.org/onlinepubs/9699919799/basedefs/…
Kusalananda

Réponses:

25
  1. La section synopsis donne généralement quelques exemples de cas d'utilisation. Parfois, les sous-commandes ont différentes options, donc plusieurs exemples peuvent être affichés.
  2. Les crochets []indiquent toujours les commutateurs, arguments, options facultatifs, etc.
  3. Oui, le tuyau |signifie ou, en particulier lorsqu'il est placé entre parenthèses ou parenthèses.
  4. Les parenthèses entre parenthèses signifient simplement que la seconde partie dépend de la première, et elle-même facultative. Certains commutateurs que vous pouvez utiliser seuls ou leur ajouter une valeur. Des virgules au début d'une parenthèse indiqueraient qu'il peut y avoir plusieurs valeurs séparées par des virgules.
  5. Ils s'appuient sur les concepts Regex, mais sont censés être lisibles par l'homme, alors ne suivez pas toutes les règles d'échappement, etc.
Caleb
la source
Merci! Y a-t-il des références expliquant la syntaxe du synopsis?
Tim
@Tim: C'est l'un des plus fous que j'ai vus, je pense que si vous en lisez un peu plus, vous comprendrez. C'est juste une convention, pas de la magie.
Caleb
9

Si vous voulez une référence, elles sont librement basées sur EBNF .

Kim
la source
3

Depuis la manpage de manuel:


Les conventions suivantes s'appliquent à la section SYNOPSIS et peuvent être utilisées comme guide dans d'autres sections. synopsis homme description

Le rendu exact peut varier en fonction du périphérique de sortie. Par exemple, man ne sera généralement pas en mesure de rendre l'italique lors de l'exécution dans un terminal et utilisera généralement du texte souligné ou coloré à la place.

L'illustration de la commande ou de la fonction est un modèle qui doit correspondre à toutes les invocations possibles. Dans certains cas, il est conseillé d'illustrer plusieurs invocations exclusives comme indiqué dans la section SYNOPSIS de cette page de manuel.

Jules Randolph
la source
3

Une autre source pour comprendre la signification de la syntaxe d'argument de l'utilitaire de ligne de commande serait les conventions de syntaxe de l'utilitaire d'utilitaire documentées au chapitre 12 et les expressions régulières documentées au chapitre 9 de la norme POSIX.1-2008 (édition 2013).

Slothworks
la source