構文図は、シンボルを使用して、コマンドの要素を表し、これらの要素を使用するための規則を指定します。
構文図
- メインパス行
>>-------------------------------------------------------------><
左側の二重矢印 (>>) で始まり、右側のそれぞれが向き合っている 2 つの矢印 (><) で終了します。 図が 1 行よりも長い場合には、継続するそれぞれの行は単一の矢印 (>) で終了し、次の行は単一の矢印で始まります。 図はメインパス行に続いて、左から右、上から下に読みます。
- キーワード
-
>>-dscli-------------------------------------------------------><
コマンド、フラグ、パラメーター、 または引き数の名前を表します。 キーワードはイタリックで示されていません。 キーワードは、構文図に示されているとおり正確なスペルを入力してください。
- 必須キーワード
-
>>-mkuser-- -pw--password-- -group--group_name [ . . . ]-------->
>--+-User Name-+-----------------------------------------------><
'-" - "-----'
コマンドに指定する必要があるパラメーターまたは引き数を示します。 必須キーワードは、メインパス行の上に表示されます。 相互に排他的な必須キーワードは、縦方向に積み重ねられています。
- オプションのキーワード
-
>>-+------------------+----------------------------------------><
'- -h-- -help-- -?-'
コマンドに指定することを選択可能なパラメーターまたは引き数を示します。 オプションのキーワードは、メインパス行の下に表示されます。 相互に排他的なオプションのキーワードは、縦方向に積み重ねられています。
- 変数
-
>>-variable----------------------------------------------------><
パラメーターまたは引き数に指定する必要がある値 (ファイル名、ユーザー名、またはパスワードなど) を表しています。 変数はイタリックです。
特殊文字
- - (マイナス) または / (スラッシュ) 記号
- フラグの接頭部は、- (マイナス) 記号です。フラグは、コマンドのアクションを定義するか、またはコマンドの操作を変更します。 コマンドの発行時に、パラメーターを付けた複数のフラグを使用できます。
- [ ] 大括弧
- オプションの値は、大括弧で囲まれています。
- { } 中括弧
- 必須の値、または推奨される値は、中括弧で囲まれています。
- | 垂直バー
- 垂直バーは、複数のオプションまたは引き数を選択できることを示しています。
たとえば、[ a | b ] は、a か b を選択するか、またはなにも選択しないことを示しています。 同様に、{ a | b } は、a または b のいずれかを選択する必要があることを示しています。
- ... 省略符号
- 省略符号は、コマンド行上または複数の値または引き数で反復可能な値を示しています。
- – ダッシュ
- ダッシュは、パラメーターを入力する代わりに、stdin から提供される値 (複数の場合あり) を示します。stdin は、設定により異なり、シングル・ショット・モードまたはスクリプト・モードを使用している場合に利用できます。このオプションは、対話モードでは利用できません。