構文図

構文図では、コマンドの要素を表す記号、およびこれらの要素を使用する場合の規則を指定する記号が使用されます。

表 1 は、コマンド・ライン・インターフェース (CLI) コマンドを表現する構文図の読み方を説明しています。説明の中で、CLI コマンド要素を表す記号が定義されています。

表 1. 構文図
要素 構文 説明
メインパス・ライン >>><>() () () 左から二重矢印 (>>) で始まり、右側の互いに向かい合った 2 つの矢印 ()>< で終わります。構文図が 1 行で終わらない場合は、行の終わりに単一矢印 (>) が付き、次の行が単一矢印で開始されます。構文図は左から右、上から下へ、メインパス・ラインに沿って読んでください。
キーワード
構文図を読む構文図をスキップする
>>-esscli------------------------------------------------------><

コマンド、フラグ、パラメーター、または引数の名前を表します。 キーワードはイタリック体ではありません。キーワードは、構文図に示されているとおりに入力してください。
必須キーワード
構文図を読む構文図をスキップする
>>-+-­a--AccessFile-+------------------------------------------><
   +-­u--Userid-----+   
   '-­p--Password---'   

コマンドに指定する必要があるパラメーターまたは引数を示します。 必須キーワードは、メインパス・ライン上に示されます。 一緒に指定できない必須キーワードは、縦に積み重ねて示されます。
オプション・キーワード
構文図を読む構文図をスキップする
>>-+--------+--------------------------------------------------><
   +-­h-----+   
   +- -help-+   
   '-­?-----'   

コマンドに選択して指定できるパラメーターまたは引数を示します。オプション・キーワードは、メインパス・ラインの下に示されます。 相互に排他的なオプション・キーワードは、縦に積み重ねて示されます。
デフォルト値
構文図を読む構文図をスキップする
                .-FCP---.   
>>-protocol--=--+-FICON-+--------------------------------------><

メインパス・ラインの上に示されます。
反復可能キーワードまたは値
構文図を読む構文図をスキップする
>>-newports--=--+-ALL-----------------+------------------------><
                '-PortId1,PortId2,...-'   

2 回以上指定できるパラメーターまたは引数を表します。 反復可能なキーワードまたは値は、キーワードまたは値の上を右から左へ戻る矢印で示しています。
変数
構文図を読む構文図をスキップする
>>-AccessFile--------------------------------------------------><

パラメーターまたは引数に指定する必要のある値 (ファイル名、ユーザー名、パスワードなど) を表しています。 変数はイタリック体です。
スペース分離文字
構文図を読む構文図をスキップする
>>-­u-- --Userid-- --p-- --Password----------------------------><

前後のキーワード、パラメーター、引数、または変数を区切るために、メインパス・ラインにブランク・スペースを追加します。
引用符区切り文字
構文図を読む構文図をスキップする
>>-­d-- --"--ess--=--EssId--host--=--'Host Name'-- --profile---->

>--=--ProfileName--"-------------------------------------------><

複数の値が含まれるパラメーターまたは引数の始まりと終わりを示します。 特定のパラメーターまたは引数の場合、1 つ以上の名前と値の対を二重引用符のセットで囲みます。パラメーター値または名前と値の対にブランクまたは空白文字が含まれる場合は、値全体を単一引用符のセットで囲みます。
等号演算子
構文図を読む構文図をスキップする
>>-"--ess--=--EssId-- --profile--=--ProfileName--"-------------><

名前と値の対の中で、名前とその値を区切ります。
構文フラグメント
構文図を読む構文図をスキップする
>>-Fragment Name-----------------------------------------------><

Fragment name

|--(--fragment details--)---------------------------------------|

非常に長い構文図、複雑な構文図、もしくは繰り返しの多い構文図を分割します。 フラグメント名はメインの構文図の中に示されます。実際のフラグメントは、メインの構文図の下に示されます。