構文図の見方
本書で説明するコマンドの構文構造は、構文図で示されています。
構文図 には、シンタックスダイアグラムのサンプルが示されており、そこには、「かどうか」などを示すさまざまな表記が含まれています。
- 項目がキーワードであるか、変数であるか。
- 項目が必須であるか、オプションであるか。
- 選択が可能であるかどうか。
- 値を指定しない場合、デフォルトを適用するかどうか。
- 項目の反復が可能であるかどうか。
fragment_name
構文図を読んで理解するためのヒントをいくつか示します。
- 読む順序
- 構文図は、直線のパスをたどって左から右、上から下に読みます。
►►─── 記号は、ステートメントの開始を示しています。
───► 記号は、ステートメントが次の行に継続していることを示しています。
►─── 記号は、ステートメントが前の行から継続していることを示しています。
───►◄ 記号は、ステートメントの終了を示しています。
- キーワード
- キーワードは、大文字で示します。
キーワードの最初の数文字を入力するだけでよいことがあります。この場合、キーワードの必須部分は大文字で示します。
この例では、「KEY」、「KEYW」、「KEYWO」、「KEYWOR」または「KEYWORD」と入力できます。
短縮したキーワードまたはキーワード全体を入力する場合、示されたとおりに正確に入力する必要があります。
- 変数
- 変数は、小文字で示します。変数はユーザーが指定する名前または値を表します。
- 必須項目
- 必須項目は、水平線 (メインパス) 上に示されます。
- オプション項目
- オプション項目は、メインパスの下に示されます。
- 項目の選択
- 複数の項目から選択可能な場合、これらの項目は縦方向に重ねて示されます。
複数の項目から 1 項目を選択する必要がある場合には、項目のいずれかがメインパス上に表示されます。
複数の項目から任意で 1 項目を選択する場合は、縦にスタックされた選択項目全体がメインパスの線よりも下に表示されます。
いずれの項目も選択しなかったときにデフォルト値が適用される場合は、デフォルト値をメインパスの上方に示します。
- 反復可能な項目
- メインパスの上にある左向きの矢印は、繰り返し可能な項目を示します。
反復可能な項目の間に分離文字 (コンマなど) を指定する必要がある場合は、左に戻る矢印付きの線の中で、指定する必要がある分離文字を示します。
- フラグメント
- 構文図を読みやすくするために、構文のセクションまたはフラグメントを分けて示すことがあります。fragment_name