Existe-t-il une syntaxe standardisée pour le prognam Linux?

Question

Sur un système Linux, il est courant de taper progname --help afin de voir la sortie d'aide de ce programme. Après cela, vous verrez une description comme: progname [SWITCHES] [FILES]... [ETC]

Ma question est; existe-t-il une syntaxe standardisée pour son type de documentation (en ligne de commande)? Pour décrire des choses comme des commutateurs optionnels, des paramètres multiples (comme une liste de fichiers), des modèles de commutation, etc. Il semble qu'il y aurait un standard pour que quiconque le connaît puisse interpréter correctement votre documentation.

Remarque: Il s'agit purement d'écrire ma propre documentation, pas d'analyser les arguments.

Answer 1

Le GNU Getopt Library est probablement le moyen le plus standard pour analyser les arguments maintenant. Il existe des liaisons de bibliothèque pour la plupart des langues que vous utiliserez.

Answer 2

Voulez-vous implémenter une telle aide dans votre programme? Il y a Linux standard des commandes pour cela:

getopt - à utiliser dans un script http://linuxmanpages.com/man1/getopt.1.php

getopt, getopt_long - à utiliser dans C +/C++ http://linuxmanpages.com/man3/getopt.3.php

Answer 3

Il est http://www.gnu.org/prep/standards/standards.html#g_t_002d_002dhelp et http://www.gnu.org/prep/standards/standards.html#Option-Table

Mais Je ne peux pas voir une définition standard stricte ...

Answer 4

J'ai parcouru beaucoup de pages man Linux et voici quelques choses que j'ai e vu que cela semble être la norme pour les pages man qui viennent standard avec linux. Comme l'ont dit certains contributeurs ci-dessus, il ne semble pas y avoir de norme de documentation publiée. J'ai vu quelques différences sur le Web, mais les pages qui viennent avec Linux semblent être assez cohérent.

1. La commande en question apparaît en premier.
2. Les paramètres fournis par l'utilisateur sont placés entre crochets, "<>", avec un nom entre parenthèses décrivant le paramètre. ex.
3. Les paramètres facultatifs sont placés entre crochets, "[]".
4. Si une valeur de paramètre doit être choisie dans un ensemble défini, les différentes options sont séparées par le symbole de tuyau, "|", représentant "ou".
5. Vous pouvez utiliser dot dot dot "..." pour simplifier une liste si son contenu suit une progression logique. ex. [...]
6. Attention aux espaces. Les espaces séparent les choses donc pas d'espaces au nom des choses simples. Utilisez "filename" ou "file_name", pas "nom de fichier".

C'est tout ce que je peux penser en ce moment. N'hésitez pas à ajouter et corriger si vous le souhaitez.