Die Beschreibung eines jeden Kommandos hält sich, soweit möglich, an ein festes Raster:
Hauptüberschrift
Beschreibung des Kommandos
Syntax
Syntaxbeschreibung
Endestatus (optional)
Fehlermeldung(en) (optional)
Datei(en) (optional)
Umgebungsvariable(n) (optional)
Internationale Umgebung (optional)
Beispiel(e) (optional)
Siehe auch (optional)
Die hier aufgeführten Bestandteile werden im Folgenden erläutert.
Hauptüberschrift
Die Hauptüberschrift enthält:
den Namen des Kommandos
eine Kurzbeschreibung des Kommandos
den Zusatz (BS2000), wenn das Kommando speziell für das Zusammenspiel mit dem BS2000 angeboten wird.
Beschreibung des Kommandos
Hier ist beschrieben:
- die Arbeitsweise des Kommandos
- die unterschiedlichen Aufgaben der verschiedenen Kommando-Formate, falls mehrere Formate vorhanden sind
- in welcher Umgebung das Kommando zu verwenden ist (z.B. Einträge in Dateien, Zugriffsrechte, ...)
- Hintergrundinformationen
- was vor oder nach dem Kommandoaufruf zu beachten ist.
Bei Kommandos, die komplexe Programme aufrufen (z.B. awk, sh), ist hier nur der Programmaufruf beschrieben. Weitergehende Informationen, z.B. die Arbeitsweise von awk, finden Sie im Anschluss an die Syntax.
Syntax
|
Die Bedeutung der Metasyntax können Sie der folgenden Beschreibung entnehmen.
In der Syntax:
halbfette Zeichen
Konstanten: Diese Zeichen sind direkt so einzugeben, wie sie gedruckt sind.
normale Zeichen
Variablen: Diese Zeichen sind Stellvertreter für andere Zeichen, die Sie auswählen und eingeben.
[ ]
Optional: Alles, was zwischen den eckigen Klammern steht, können, aber müssen Sie nicht eingeben. Welche Auswirkungen das hat, entnehmen Sie der Beschreibung der Optionen und Argumente. Die eckigen Klammern selbst dürfen Sie nicht eingeben, es sei denn, es ist ausdrücklich angegeben.
|Ein senkrechter Strich kennzeichnet Alternativen, von denen nur eine ausgewählt werden darf.
' '
Ein Leerzeichen, das Sie eingeben müssen.
...
Der vorhergehende Ausdruck kann wiederholt werden. Falls zwischen den Wiederholungen Leerzeichen eingegeben werden müssen, die nicht im Ausdruck enthalten sind, steht vor ... ein ' ' (Leerzeichen).
Syntaxbeschreibung
option
(Näheres zu Optionen siehe Abschnitt „Optionen angeben“)
argument
Beschreibung der übrigen Argumente, die Sie beim Aufruf an ein Kommando übergeben können, z.B. Eingabedateien, Ausgabedateien, Parameter, Variablen, Feldtrenner usw.
Endestatus (optional)
Der Endestatus ist der Wert, den ein Kommando nach seiner Ausführung an den aufrufenden Prozess zurückliefert. Der Endestatus gibt Auskunft darüber, wie das Kommando abgelaufen ist. Der Endestatus ist ein Zahlenwert und wird in der Variablen ? abgelegt. Sie können den Endestatus mit dem Befehl echo $? abfragen.
Der Abschnitt Endestatus ist nur angegeben, wenn er von folgendem Regelfall abweicht:
| 0 | nach korrekter Durchführung des Kommandos |
| >0 | bei Fehler |
Fehlermeldung(en) (optional)
Hier werden wichtige Fehlermeldungen angegeben und erläutert sowie Hinweise zur Fehlervermeidung und -behebung gegeben.
Fehlermeldungen werden standardmäßig auf die Standard-Fehlerausgabe ausgegeben. Normalerweise ist der Bildschirm die Standard-Fehlerausgabe.
Datei(en) (optional)
Hier werden solche Dateien angegeben, auf die das betreffende Kommando zugreift oder die dieses anlegt.
Umgebungsvariable(n) (optional)
Einige Kommandos greifen auf Umgebungsvariablen zu. Diese werden hier aufgeführt.
Internationale Umgebung (optional)
Hier sind die Auswirkungen des NLS auf das Kommando beschrieben (siehe Kapitel „Internationale Umgebung - NLS“).
Beispiel(e) (optional)
Beispiele sollen veranschaulichen:
die Hauptfunktion des Kommandos
den Einsatz der wesentlichen Optionen
sinnvolle komplexe Kombinationen von Optionen und Argumenten
Siehe auch (optional)
In diesem Abschnitt finden Sie Verweise auf andere Kommandos, die eine ähnliche
Funktionsweise haben oder mit dem betreffenden Kommando zusammenarbeiten. Außerdem
wird auf weitere Literatur zu diesem Kommando verwiesen.
Systemaufrufe und Bibliotheksfunktionen für den C-Software-Entwickler sind durch ein
Paar runder Klammern gekennzeichnet, z.B. chdir().
Hinweise und Warnungen
BS2000
Abschnitte, die auf Besonderheiten im Zusammenspiel mit dem BS2000 hinweisen, sind auf diese Weise gekennzeichnet.
Dieses Symbol kennzeichnet wichtige Hinweise, die Sie unbedingt beachten sollten.
Dieses Symbol steht vor Warnungen, die Sie im Interesse der System- und Betriebssicherheit unbedingt beachten müssen.
Verweise
Die folgenden Beispiele zeigen, in welcher Form auf andere Textabschnitte, Handbücher, Kommandos, Funktionen, Systemaufrufe und Dateiformate verwiesen wird.
| siehe Abschnitt „Kommando- Übersicht“ | Verweis auf den Abschnitt „Kommando-Übersicht“ im vorliegenden Handbuch |
| siehe "POSIX Grundlagen für Anwender und Systemverwalter" [1] | Verweis auf ein Handbuch, das im Literaturverzeichnis unter der Nummer [1] aufgeführt ist |
| siehe auch awk | Verweis auf das Kommando awk im vorliegenden Handbuch |
| siehe auch chdir() [4] | Verweis auf die C-Funktion, den Systemaufruf oder das Dateiformat chdir() in dem Handbuch, das im Literaturverzeichnis unter der Nummer [4] aufgeführt ist |