Inhaltsangabe in der Manpage verstehen

27

Ich habe den Abschnitt SYNOPSIS in der Manpage eines Befehls nicht verstanden. Lassen Sie uns zum Beispiel die Manpage von sich manselbst sehen. Von 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. Beschreibt der Abschnitt SYNOPSIS die Syntax für den Befehl?
  2. was diejenigen tun [...]und im [...]Inneren [...] bedeuten? Bedeuten sie etwas Optionales?
  3. Bedeutet |ODER?
  4. Was ,bedeutet in [-m system[,...]]?
  5. Entspricht der Abschnitt SYNOPSIS den Regeln für reguläre Ausdrücke?
Tim
quelle
Verwandte: "Utility-Konventionen" im POSIX-Standard: pubs.opengroup.org/onlinepubs/9699919799/basedefs/…
Kusalananda

Antworten:

25
  1. Der Abschnitt mit der Übersicht enthält normalerweise einige Anwendungsbeispiele. Manchmal haben Unterbefehle unterschiedliche Optionen, sodass möglicherweise mehrere Beispiele angezeigt werden.
  2. Klammern []kennzeichnen immer optionale Schalter, Argumente, Optionen usw.
  3. Ja, das Rohr |bedeutet oder, besonders wenn es in Klammern oder Klammern steht.
  4. Klammern in Klammern bedeuten nur, dass der zweite Teil vom ersten abhängt und auch selbst optional ist. Einige Schalter können Sie einzeln verwenden oder ihnen einen Wert hinzufügen. Kommas am Anfang einer Klammer zeigen an, dass es mehrere durch Kommas getrennte Werte geben kann.
  5. Sie stützen sich auf Regex-Konzepte, sind jedoch für den Menschen lesbar. Befolgen Sie daher nicht alle Ausweichregeln usw.
Caleb
quelle
Vielen Dank! Gibt es einige Verweise, die die Syntax der Übersicht erläutern?
Tim
@ Tim: Das ist eines der verrücktesten, die ich je gesehen habe. Ich denke, wenn Sie ein paar mehr lesen, werden Sie den Dreh raus haben. Es ist nur Konvention, keine Magie.
Caleb
9

Wenn Sie eine Referenz wünschen, basieren sie lose auf EBNF .

Kim
quelle
3

Aus der manManpage:


Die folgenden Konventionen gelten für den Abschnitt SYNOPSIS und können in anderen Abschnitten als Richtlinie verwendet werden. Mann Inhaltsangabe Beschreibung

Das genaue Rendern kann je nach Ausgabegerät variieren. Beispielsweise kann man in einem Terminal normalerweise keine Kursivschrift ausführen und verwendet stattdessen in der Regel unterstrichenen oder farbigen Text.

Die Abbildung des Befehls oder der Funktion ist ein Muster, das mit allen möglichen Aufrufen übereinstimmen sollte. In einigen Fällen ist es ratsam, mehrere exklusive Aufrufe zu veranschaulichen, wie im Abschnitt SYNOPSIS dieser Handbuchseite gezeigt.

Jules Randolph
quelle
3

Eine weitere Quelle für das Verständnis der Bedeutung der Syntax des Befehlszeilen-Dienstprogramms sind die in Kapitel 12 und in Kapitel 9 des POSIX.1-2008 (2013 Edition) -Standards dokumentierten Konventionen für die Syntax von Dienstprogrammargumenten .

Faultiere
quelle