Gibt es einen Standard zum Schreiben einer Befehlssynopse?

14

Es scheint mir, dass jeder seine eigene Idee hat, wie man eine Zusammenfassung schreibt , die die Befehlsverwendung für den Endbenutzer beschreibt.

Dies ist beispielsweise das Format von man grep:

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

Dies hat nun eine Syntax, die in anderen Hilfeseiten erscheint. []wird als optional erkannt und ...ist als Mehrfaches derselben Eingabe sinnvoll.

Aber die Leute benutzen |oder /für den OP und es gibt andere, die umkehren, was []bedeutet. Oder sie geben keinen Hinweis darauf, wohin es [OPTIONS]geht.

Ich möchte einen Standard für das, was ich schreibe, befolgen, aber jede Website, die ich betrachte, sagt mir etwas anderes.

Gibt es eine Standardmethode zum Verfassen von Synopsen oder ist die Konvention genau das, was die Leute im Laufe der Zeit getan haben?

command-line man Tormyst
quelle
Wähle einen aus und bleibe dabei.
Kevin
Aus irgendeinem Grund glaube ich nicht, dass das helfen würde. Jeder Mensch würde dort seinen eigenen Standard haben, und dann würde nie etwas dagegen unternommen werden.
Tormyst
4
Ist das der Standard, den Sie meinen? pubs.opengroup.org/onlinepubs/009695399/basedefs/…
Mark Plotnick
Ja, genau das habe ich gesucht. Vielen Dank.
Tormyst
1
@MarkPlotnick - Ich würde das zu einem A machen, damit das OP es akzeptieren kann. Das ist der Standard, wenn es jemals einen gab. Verweisen Sie auf den Link, auf den illuminÉ verwiesen hat.
SLM

Antworten:

8

Der klassische Standard hierfür ist POSIX, Utility Argument Syntax (danke an @ illuminÉ für den aktualisierten Link). Es beschreibt beispielsweise die Syntax, die in Manpages verwendet werden soll

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]

Als Klassiker wird die Verwendung von Optionen mit einem Zeichen -Wempfohlen, die von Anbietern empfohlen werden. Auf diese Weise werden Optionen mit mehreren Zeichen unterstützt (siehe z. B. Zusammenfassung der gcc-Optionen ).

GNU-Software führte Mehrzeichenoptionen ein, die mit beginnen --. Einige Richtlinien von GNU zum Formatieren von Manpages mit diesen Optionen finden Sie in der help2man-Referenz .

Mark Plotnick
quelle