構文図は、オペレーティング・システムが正しくユーザーの入力を解釈できるように、コマンドの指定方法を示すものです。構文図は左から右へ、 上から下へ、水平線 (メインパス) に沿って読み進めます。
構文図では、以下の記号が使用されます。
構文図に示されているコロン、引用符、負符号 (-) などの句読点は、すべてそのとおりに指定してください。
構文図では、以下のようなタイプのパラメーターが使用されています。
パラメーターは、キーワードまたは変数に分類されます。キーワードは小文字で示され、小文字で入力することが可能です。例えば、コマンド名などがキーワードになります。変数はイタリックで示され、ユーザーの入力する名前や値を示します。
以下の例では、user コマンドがキーワードになります。user_id は必須の変数であり、password は任意指定の変数です。変数の値はユーザーが独自に置き換えます。
>>-user--user_id--+----------+--------------------------------->< '-password-'
必須のキーワード: 必須のキーワードおよび変数はメインパス上に示されます。
>>-required_keyword--------------------------------------------><
必須のキーワードおよび値は必ずコーディングしなければなりません。
スタックの中から必須項目を 1 つ選択する: 一緒に指定できない複数の必須キーワードまたは必須変数の中から 1 つを指定しなければならない場合には、項目は英数字順に縦方向に並べてスタックされます。
>>-+-required_parameter_1-+------------------------------------>< '-required_parameter_2-'
任意指定の値: 任意指定のキーワードおよび変数はメインパスの下に示されます。
>>-+---------+------------------------------------------------->< '-keyword-'
任意指定キーワードおよび変数は必ずしも指定する必要はありません。
スタックの中から任意指定項目を 1 つ選択する: 一緒に指定できない複数の任意指定キーワードまたは変数の中から 1 つを指定しなければならない場合には、項目は英数字順にメインパスより下に縦方向でスタックされます。
>>-+-------------+--------------------------------------------->< +-parameter_1-+ '-parameter_2-'
変数: イタリックで示される単語はすべて 変数 です。構文内に変数がある場合には、ユーザーがテキストの定義に従って使用可能な名前または値で置き換える必要があります。
>>-variable----------------------------------------------------><
英数字以外の文字: 構文図に英数字以外の文字 (コロン、引用符、負符号 (-) など) が示されている場合には、それらの文字も構文の一部としてコーディングする必要があります。この例では、cluster:port とコーディングします。
>>-クラスター (cluster):port-----------------------------------><