Subsections

• Syntax:
• Beispiel:
• Siehe auch:
• Die 13 goldenen Regeln für ein gelungenes Kommando

Intro(1) - oder die Erklärung der Erklärung

 

Syntax:

Nach einer knappen, einzeiligen Darstellung der Funktion eines bestimmten Kommandos wird nach dem Untertitel ,,Syntax:`` der Aufruf auf der Kommandozeile mit allen Optionen dargestellt. Dazu wird eine strenge Form benutzt:

name [-Optionen ...] [Argumente ...]

name

ist der Name des Kommandos. Das ist sowohl der vollständige Name der Datei, in der das Programm gespeichert ist als auch der Name, unter dem dieses Kommando aufgerufen werden muß. Besondere Endungen zur Kennzeichnung des Dateityps gibt es bei Linux nicht.

-Optionen

   sind ,,Befehle an das Programm``, mit denen dessen Verhalten manipuliert werden kann. Eine Option ist durch einen einzelnen Buchstaben bezeichnet. Bei den Optionen kann zwischen ,,Schaltern`` und ,,Reglern`` unterschieden werden. Während Schalter allein durch ihr Auftreten bzw. durch ihre Abwesenheit auf der Kommandozeile bestimmte Ereignisse auslösen, muß zu den Reglern noch ein Argument angegeben werden. Allen Optionen gemeinsam ist, daß sie durch ein Minuszeichen eingeleitet werden.

Neben den Optionen, die nur durch einen Buchstaben bezeichnet werden, gibt es bei den GNU Utilities häufig ausdrücklich benannte Optionen. Diese Optionen werden durch zwei Minuszeichen eingeleitet. In der Kommandobeschreibung werden diese Optionen nicht mehr aufgeführt. Ihre Funktion wird in allen Fällen auch durch Buchstabenoptionen abgedeckt.

Argumente

können entweder zu den oben erklärten regelnden Optionen gehören (Optionsargumente), oder sie können sich direkt auf das Kommando beziehen (Kommandoargumente, Operanden). In jedem Fall soll durch die kursive Schrift angedeutet werden, daß diese Argumente nicht wörtlich eingegeben werden sollen. Argumente dürfen nicht mit einem Minuszeichen beginnen. Als Ausnahme ist als Kommandoargument meistens ein einzelnes Minuszeichen als Symbol für den Standardeingabekanal erlaubt.

{ Argument1,Argument2}

ist die Darstellung für Optionsargumente mit einem eingeschränkten Wertebereich. Hier darf nur eines der zur Auswahl stehenden Argumente wörtlich eingesetzt werden.

[  ]

  eckige Klammern schließen in der Regel Kommandoteile ein, die wahlfrei sind. Mit solchen Erweiterungen wird das Verhalten eines Kommandos bestimmt und verändert. In den wenigen Fällen, wo die eckigen Klammern selbst Teil des Kommandos sind (wie zum Beispiel beim test-Kommando), wird der andere Charakter dieser Klammer durch besonders fetten Druck dargestellt.

...

Wenn mehrere gleichartige Elemente eines Kommandos mehrfach vorkommen können, wird das durch Fortsetzungspunkte `...' gekennzeichnet.

Bestimmte Tasten werden in kleinen Großbuchstaben (KAPITäLCHEN) benannt. Das sind vor allem das LEERZEICHEN oder SPACE, der TABULATOR oder TAB, der RüCKSCHRITT oder BACKSPACE, das ZEILENENDE, das meist als RETURN, manchmal aber auch als NEWLINE angesprochen wird, sowie die Umschalttasten ALT, CONTROL und ESCAPE.

Gelegentlich werden Tastenkombinationen CONTROL-Irgendetwas angesprochen. Dabei wird neben der ausgeschriebenen Tastenbezeichnung auch die Abkürzung CTRL oder die symbolische Darstellung durch ein Dach (Caret) `^' verwendet. Zum Beispiel steht ^D für CONTROL-D: das ist das EOF-Zeichen. Dieses Zeichen wird durch gemeinsames Drücken der CONTROL- und der `D'-Taste erzeugt. 

Beispiel:

Beispiele werden in Courier (Schreibmaschinenschrift) gegeben. Wenn ganze Kommandozeilen vorgeführt werden, wird der $ Standardprompt der Shell dargestellt. Die Zeilen bis zum nächsten Prompt zeigen gegebenenfalls die Bildschirmausgabe des Beispiels:

$ echo 'Hallo Welt!'
': Event not found.
$ _

Siehe auch:

Unter diesem Stichwort wird bei vielen Kommandobeschreibungen auf andere Stellen des Buches verwiesen, die weitere Information zum Thema bieten.

Zum Glück ist dieses Handbuch nicht die einzige Quelle gültiger Information. Ein umfangreiches Online-Hilfesystem bietet eine Vielzahl weiterer Antworten - wenn auch in der Regel in englischer Sprache. Am Ende vieler Kommandobeschreibungen in diesem Buch sind Verweise auf die Online-Hilfen gegeben.

Dabei kommen vor allem zwei Hilfe-Systeme in Frage:

• das man-Kommando, das zur Anzeige der klassischen Manual-Pages benutzt wird. Zu jedem Kommando gibt es solche ,,manpages`` (so sollte es zumindest sein). Die werden angezeigt, indem das man-Kommando mit dem fraglichen Kommandonamen als Argument aufgerufen wird. Unter der grafischen Benutzeroberfläche von Linux, dem X Window System, gibt es zur Anzeige der Manual-Pages das mausgesteuerte xman-Kommando. Nähere Information zum man-Kommando gibt es hier des Handbuches; zu xman wird beim Programmstart automatisch ein Hilfstext angezeigt.
• das info Hilfesystem, dem die TEXinfo Dateien zugrunde liegen. Diese Hilfstexte sind so konzipiert, daß sie sowohl mit dem TEX Satzsystem formatiert und anschließend ausgedruckt werden, als auch, entsprechend aufbereitet, mit speziellen Programmen durchsucht und gelesen werden können. Als Programme kommen info bzw. sein grafisches Pendant xinfo oder der emacs Editor in Frage. Der Editor bietet einen speziellen Info-Modus, mit dem exakt die gleiche Funktionalität wie mit dem separaten info Programm erzielt wird.

Bei der Referenzierung der Online-Hilfen wird entweder im Falle der Manual-Pages die Sektion angegeben, also beispielsweise

Siehe auch:
geqn(1), gsoelim(1), grotty(1)

für die Verwandten des groff aus Sektion 1, oder es steht anstelle der Sektion das Wort ,,info`` in den Klammern, was dann der entsprechende Verweis auf das TEXinfo-System ist.

Die 13 goldenen Regeln für ein gelungenes Kommando

  Für die Syntax eines Kommandos gibt es im POSIX 1003.2 Standard dreizehn Richtlinien. Diese Regeln sind nicht zwingend, es wird aber allen Autoren neuer Utilities empfohlen, sich daran zu halten. In einem Shellscript kann mit der Shellfunktion getopts eine nach den Regeln 3-10 eingegebene Kommandozeile analysiert werden. In C-Funktionen übernimmt getopt(3) diese Aufgabe.

1.

Kommandonamen sollten zwei bis neun Zeichen lang sein.

2.

Kommandonamen sollten nur aus ASCII-Kleinbuchstaben oder Ziffern bestehen.

3.

Jede Optionsbezeichnung    sollte aus einem einzelnen alphanumerischen Zeichen bestehen. Die Option -W soll für herstellerspezifische Erweiterungen reserviert sein.

4.

Alle Optionen sollten von einem Minuszeichen `-' eingeleitet werden.

5.

Optionen ohne Argumente (Schalter) sollten hinter einem einzigen Minuszeichen gruppiert werden können.

6.

Jedes Optionsargument sollte von der Option, auf die es sich bezieht, durch (ein) Leerzeichen getrennt sein.

7.

Ein Optionsargument sollte nicht optional sein.

8.

Wenn mehrere Optionsargumente gleichzeitig erlaubt sind, sollten diese als ein einziges Kommandozeilenargument erscheinen. Dazu können die Optionsargumente entweder in Anführungszeichen eingeschlossen, oder, durch Komma getrennt, ohne Leerzeichen aufgelistet werden.

9.

Alle Optionen sollten vor den Kommandoargumenten angegeben werden.

10.

Zwei Minuszeichen - sollten als Markierung für das Ende der Kommandozeilenoptionen interpretiert werden. Alle folgenden Argumente sollten als Operanden für das Kommando behandelt werden, auch wenn sie mit einem Minuszeichen beginnen. Das - Symbol sollte nicht als Option oder Operand benutzt werden.

11.

Die Reihenfolge der Optionen untereinander sollte keine Rolle spielen, es sei denn, eine Option ist als ausschließlich und dominant dokumentiert. Solche Optionen können alle vorhergehenden inkompatiblen Optionen abschalten. Wenn ein Regler (Option mit Optionsargument) wiederholt wird, sollte die Interpretation in der Reihenfolge des Auftretens erfolgen.

12.

Die Reihenfolge der Kommandoargumente (Operanden) kann von Bedeutung sein, und positionsabhängige Interpretationen sind für ein Utility spezifisch.

13.

Für Utilities, die als Operanden Dateien benutzen, die sie zum Lesen oder Schreiben öffnen, sollte ein einzelnes, von Blanks eingeschlossenes Minuszeichen `-' den Standardeingabekanal bezeichnen. Wenn es aus dem Zusammenhang eindeutig hervorgeht, kann auch der Standardausgabekanal so bezeichnet werden.