Existe-t-il une norme pour l'ordre des arguments imprimés dans l'instruction d'utilisation d'un outil de ligne de commande?

Question

Salutations à mes experts vénérés! J'écris un outil de ligne de commande (semblable à ls ou cat ou uname etc.) et je me demandais s'il y avait une meilleure pratique pour commander les arguments dans l'instruction d'utilisation. Je suis confus parce que l'instruction d'utilisation de ls imprime les arguments dans l'ordre alphabétique, alors que l'instruction d'utilisation de cat ne le fait pas!

Essayez cat --help et ls --help.

Pouvez-vous me référer à une documentation, s'il y a une norme?

Answer 1

Ha, standard! Non, certainement rien de tel. Choisissez votre favori, celui qui a l'air bien et est bien organisé et est déjà sur l'ordinateur de tout le monde, et imitez-le.

Mes opinions suivent:

• je ne vois aucune valeur dans l'ordre alphabétique.
• Ordonnez-le logiquement, rangez-le dans des catégories et mettez d'abord des choses utiles.
• Assurez-vous que le moteur d'analyse est solide et «standard», de préférence en utilisant quelqu'un d'autre. Les Program Options de Boost ou les optparse de Python sont bons s'ils sont dans la bonne langue pour vous. La plupart des autres langues en ont aussi.
• Assurez-vous d'inclure de nombreux exemples couvrant toute la gamme d'utilisation.

Answer 2

Il n'y a pas de norme, bien qu'il y ait quelques conventions générales, que, je suppose, vous connaissez déjà. Ce n'est pas 100% cependant.

Answer 3

Pas de norme pour ainsi dire, mais ils devraient probablement être groupés par les habitudes d'utilisation qui est la façon dont la plupart des gens les utilisent (et non par ordre alphabétique).

Comme pour toute la documentation et la rédaction technique, vous devez d'abord décider de votre public.

Par exemple, si vous voulez savoir comment obtenir sort pour ignorer les cas, vous savez déjà que ce rarement est -f (fold cas, qui la pensée de l'enfer de qui?). La sortie la plus utile aurait une section sur les options de transformation des données (par exemple, ignorer les cas, traiter les caractères accentués comme inaccentués), une autre sur la sélection des clés (par exemple, quels champs ou sous-champs), une autre , collation) et ainsi de suite.

Dans tous les cas, le genre de personne qui sait déjà c'est l'option -f saura aussi comment utiliser less pour rechercher cette option sans avoir à la page par une foule d'informations inutiles :-)

En fait, J'irais mieux. Avoir deux sorties possibles. Faire par défaut un format basé sur l'utilisation mais, au sommet de cela, faire la première utilisation d'un moyen d'obtenir une liste alphabétique:

pax> paxprog --help 

paxprog - truly an amazing program. 

    paxprog is capable of doing anything you want. 

    Help output options: 

     --help 
      Usage-based assistance (default). 

     --alpha-help 
      All options in alphabetical order. 

    Coffee-making options: 

     --temp=chilled|tepid|hot|damnhot 
      Selects the temperature. 

    Blah, blah, blah ... 

Answer 4

est Il certainement une norme: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html. Remarquez le paragraphe 3: «Les options sont généralement énumérées par ordre alphabétique à moins que cela ne rende la description de l'utilitaire plus confuse."