コマンド解説書に付属している構文図を参照する場合は、ここで説明する規則を参考にしてください。
構文図は、先頭行の左端から右へ、上から下へと進みます。 水平線は、コマンドの入力時に使用するパラメーターのメインパスを表します。 メインパスから離れたパラメーターはオプションで、このパラメーターを省略した場合はデフォルト値が使用されます。
記号 | 説明 |
---|---|
>> | コマンド構文の開始を表わします。 |
> | コマンド構文が継続することを表わします。 |
| | コマンド構文のフラグメント (またはコマンドの一部) の開始と終了を表わします。 |
>< | コマンド構文の終了を表わします。 |
構文図に指定されている句読点 (コロン、セミコロン、コンマ、引用符、負符号 (-) など) は、すべて入力する必要があります。
.-Default_variable-. >>-Required_variable--+------------------+--Optional_parameter-><
パラメーターは、キーワードまたは変数として分類されます。キーワードは、図に記述されているとおり正確に入力する必要があります。構文図の変数 (指定する名前や値) は、イタリック体で記述されます。
次の例の USER コマンドはキーワードです。必須の変数パラメーターは user_id で、オプションの変数パラメーターは password です。 これらの変数パラメーターに、独自の値を設定します。
>>-USER-- --user_id-- --+----------+--------------------------->< '-password-'
構文図が複数行にわたる場合、1 行目の終わりと 2 行目の始まりにそれぞれ単一の矢印が記述されます。
>>-複数行にわたる構文図の最初の行--> >--サブコマンド、パラメーター、変数を 2 行目以降に記述-><
排他的な必須パラメーターの選択項目は、メインパスの線上を起点として垂直方向に記述されます。 この場合、いずれかのパラメーターを選択する必要があります。
>>-+-Choice_1-+------------------------------------------------>< '-Choice_2-'