コマンドの文法
コマンドの説明で使用する記号を，次のように定義します。
|
記号 |
意味 |
|---|---|
|
｜ (ストローク) |
複数の項目に対し，項目間の区切りを示し，「または」の意味を示す。 例 「A | B | C」は，「A，BまたはC」を示す。 |
|
｛ ｝ (波括弧) |
この記号で囲まれている複数の項目の中から，必ず1組の項目を選択する。項目の区切りは | で示す。 例 ｛A | B | C｝は「A，BまたはCのどれかを指定する」ことを示す。 |
|
[ ] (角括弧) |
この記号で囲まれている項目は任意に指定できる(省略してもよい)。 複数の項目が記述されている場合には，すべてを省略するか，どれか一つを選択する。 例 [A]は「何も指定しない」か「Aを指定する」ことを示す。 [B | C]は「何も指定しない」か「BまたはCを指定する」ことを示す。 |
|
... (点線) |
この記号の直前に示された項目を繰り返して複数個，指定できる。 例 「A，B，...」は「AのあとにBを必要個数指定する」ことを示す。 |
|
＿ (下線) |
括弧内のすべてを省略したときに，システムが取る標準値を示す。標準値がない場合は，指定した項目だけが有効である。 例 [A | B]はこの項目を指定しなかった場合に，Aを選択したと見なすことを示す。 |
また，コマンドの文法については基本的に次の形式で説明しています。
- 機能
-
コマンドの機能について説明します。
- 形式
-
コマンドの入力形式を示します。
- 実行権限
-
コマンドを実行できる権限を示します。
- 格納先フォルダ
-
コマンドの格納先フォルダを示します。
- 引数
-
コマンドの引数について説明します。
- 戻り値
-
コマンドの戻り値について説明します。
- 実行時の前提条件
-
コマンドの実行時の前提条件について説明します。
- 注意事項
-
コマンドを実行する上での注意事項について説明します。
- 使用例
-
コマンドの使用例を示します。