構文図 この Information Center での表記規則 CLI 特殊文字

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

このトピックは、コマンド行インターフェース (CLI) コマンドを表す構文図の読み方を説明します。 説明の中で、CLI コマンド要素を表す記号が定義されています。

CLI コマンドは、『IBM TotalStorage Multiple Device Manager: Command-Line Interface User's Guide』に記載されています。 このガイドを使用してコマンド構文図を表示してください。 コマンド構文図は、Multiple Device Manager Information Center でも表示できます。

メインパス・ライン
構文図を読む構文図をスキップする>>-------------------------------------------------------------><

左側から二重矢印 (>>) で始まり、右側の互いに向かい合った 2 つの矢印 (><) で終わります。 構文図が 1 行で終わらない場合は、行の終わりに単一矢印 (>) が付き、次の行が単一矢印で開始します。 構文図は左から右、上から下へ、メインパス・ラインを読んでください。

キーワード
構文図を読む構文図をスキップする>>-esscli------------------------------------------------------><

コマンド、フラグ、パラメーター、または引き数の名前を表します。 キーワードはイタリック体ではありません。キーワードは、構文図に示されているとおりに入力してください。

必須キーワード
構文図を読む構文図をスキップする>>-+--a-- --AccessFile-----------------+-----------------------><
   '--u-- --Userid-- ---p-- --Password-'

そのコマンドで指定しなければならないパラメーターまたは引き数を示しています。 必須キーワードは、メインパス・ライン上に示されます。 相互に排他的な必須キーワードは、縦に並んで示されます。

オプション・キーワード
構文図を読む構文図をスキップする>>-+-------+---------------------------------------------------><
   +--h----+
   +--help-+
   '--?----'

そのコマンドで指定するか、しないかをユーザーが選択できるパラメーターまたは引き数を示しています。 オプション・キーワードは、メインパス・ラインの下に示されます。 相互に排他的なオプション・キーワードは、縦に並んで示されます。

デフォルト値
構文図を読む構文図をスキップする                .-FCP---.
>>-protocol--=--+-FICON-+--------------------------------------><

メインパス・ラインの上に示されます。

繰り返し指定できるキーワードまたは値
構文図を読む構文図をスキップする   .--------------------------------------.
   V                                      |
>>---newports--=--+-ALL-----------------+-+--------------------><
                  '-PortId1,PortId2,...-'

2 回以上指定できるパラメーターまたは引き数を表します。 繰り返し指定可能なキーワードまたは値は、キーワードまたは値の上を右から左へ戻る矢印で示しています。

変数
構文図を読む構文図をスキップする>>-AccessFile--------------------------------------------------><

パラメーターまたは引き数に指定する必要のある値 (ファイル名、ユーザー名、パスワードなど) を表しています。 変数はイタリック体です。

スペース分離文字
構文図を読む構文図をスキップする>>--u-- --Userid-- ---p-- --Password---------------------------><

前後のキーワード、パラメーター、引き数、または変数を区切るために、メインパス・ラインにブランク・スペースを追加します。

引用符区切り文字
構文図を読む構文図をスキップする>>--d-- --"--ess--=--EssId-- --host--=--'Host Name'-- --profile--=--ProfileName--"-><

複数の値が含まれるパラメーターまたは引き数の始まりと終わりを示します。 特定のパラメーターまたは引き数の、1 つ以上の名前値の対を二重引用符で囲みます。 パラメーター、または名前と値の対の値にブランクまたはスペースが含まれる場合は、値全体をI単一引用符で囲みます。

等号演算子
構文図を読む構文図をスキップする>>-"--ess--=--EssId-- --profile--=--ProfileName--"-------------><

名前と値の対の中で、名前とその値を区切ります。

構文フラグメント
構文図を読む構文図をスキップする>>-| フラグメント名 |------------------------------------------><

構文図を読む構文図をスキップするフラグメント名:

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

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

(C) Copyright International Business Machines Corporation 2004