Syntaxdiagramm lesen

Im Syntaxdiagramm wird gezeigt, wie ein Befehl angegeben wird, damit das Betriebssystem die Eingabe korrekt interpretieren kann. Lesen Sie das Syntaxdiagramm von links nach rechts und von oben nach unten entlang der horizontalen Linie (Hauptpfad).

Symbole und Interpunktion

In den Syntaxdiagrammen werden die folgenden Symbole benutzt:

Symbol
Beschreibung
>>
Markiert den Anfang der Befehlssyntax.
><
Markiert das Ende der Befehlssyntax.

Alle im Syntaxdiagramm aufgeführten Interpunktionszeichen, beispielsweise Doppelpunkte, Fragezeichen und Minuszeichen, müssen wie gezeigt übernommen werden.

Parameter

In den Syntaxdiagrammen werden die folgenden Arten von Parametern benutzt:

Parameter
Beschreibung
Erforderlich
Erforderliche Parameter werden im Hauptpfad gezeigt.
Optional
Optionale Parameter werden unter dem Hauptpfad gezeigt.

Parameter werden als Schlüsselwörter oder Variablen klassifiziert. Schlüsselwörter werden in Kleinbuchstaben gezeigt und können in Kleinbuchstaben eingegeben werden. Ein Befehlsname ist beispielsweise ein Schlüsselwort. Variablen stehen in Kursivschrift und stellen Namen oder Werte dar, die von Ihnen angegeben werden müssen.

Beispiele für die Syntax

In dem folgenden Beispiel ist der Befehl user ein Schlüsselwort. Die erforderliche Variable ist die Benutzer-ID und die optionale Variable das Kennwort. Ersetzen Sie die Variablen durch Ihre eigenen Werte.

Syntaxdiagramm lesenSyntaxdiagramm überspringen>>-user--Benutzer-ID--+----------+-----------------------------><
                      '-Kennwort-'
 

Erforderliche Schlüsselwörter: Erforderliche Schlüsselwörter und Variablen stehen im Hauptpfad.

Syntaxdiagramm lesenSyntaxdiagramm überspringen>>-erforderliches_Schlüsselwort--------------------------------><
 

Erforderliche Schlüsselwörter und Werte müssen eingegeben werden.

Sich gegenseitig ausschließende Parameter aus einer Gruppe auswählen: Sind mehrere Schlüsselwörter oder Variablen aufgeführt, die sich gegenseitig ausschließen und aus denen ein Schlüsselwort oder eine Variable ausgewählt werden muss, sind sie vertikal in alphanumerischer Anordnung aufgeführt.

Syntaxdiagramm lesenSyntaxdiagramm überspringen>>-+-erforderlicher_Parameter_1-+------------------------------><
   '-erforderlicher_Parameter_2-'
 

Optionale Werte: Optionale Schlüsselwörter und Variablen stehen unter dem Hauptpfad.

Syntaxdiagramm lesenSyntaxdiagramm überspringen>>-+---------------+-------------------------------------------><
   '-Schlüsselwort-'
 

Sie können auswählen, ob Sie optionale Schlüsselwörter oder Variablen angeben wollen oder nicht.

Optionale Schlüsselwörter oder Parameter aus einer Gruppe auswählen: Sind mehrere Schlüsselwörter oder Variablen aufgeführt, die sich gegenseitig ausschließen und aus denen ein Schlüsselwort oder eine Variable ausgewählt werden kann, sind sie vertikal in alphanumerischer Anordnung unter dem Hauptpfad aufgeführt.

Syntaxdiagramm lesenSyntaxdiagramm überspringen>>-+-------------+---------------------------------------------><
   +-Parameter_1-+
   '-Parameter_2-'
 

Variablen: Wörter in Kursivschrift sind Variablen. Erscheint eine Variable in der Syntax, muss sie wie im Text angegeben durch einen erlaubten Namen oder Werte ersetzt werden.

Syntaxdiagramm lesenSyntaxdiagramm überspringen>>-Variable----------------------------------------------------><
 

Zeichen, die keine alphanumerischen Zeichen sind: Enthält ein Diagramm ein Zeichen, das kein alphanumerisches Zeichen ist (beispielsweise einen Doppelpunkt, ein Anführungszeichen oder ein Minuszeichen), müssen Sie dieses Zeichen als Teil der Syntax angeben. Im folgenden Beispiel müssen Sie den Cluster und den Port im Format Cluster:Port angeben.

Syntaxdiagramm lesenSyntaxdiagramm überspringen>>-Cluster:Port------------------------------------------------><