5.3 コマンドの文法の記述形式
以降で説明するコマンドの文法について，次の形式で記述します。なお，各コマンドは，アルファベットの順に説明します。
- 形式
-
コマンドの入力形式を示します。
- 機能
-
コマンドの機能について説明します。
- 引数
-
コマンドの引数およびオプションについて説明します。
- 出力形式
-
コマンドの出力形式を示します。
- 入力例
-
コマンドの入力例を示します。
- 表示形式
-
コマンドの出力形式を示します。
- 表示例
-
コマンドの表示例を示します。
- 戻り値
-
コマンドの戻り値について示します。
- 注意事項
-
コマンドを実行する上での全体的な注意事項について説明します。
- 注
-
すべてのコマンドで上記の項目をすべて説明しているわけではありません。また，上記以外に，各コマンドの固有情報を記載している場合があります。
この章の文法の説明で使用している記号を次に示します。
|
記号 |
意味 |
|---|---|
|
｜ |
横に並べられた複数の項目に対する項目間の区切りを示し，「または」を意味します。 （例） A｜B AまたはBを指定することを示します。 |
|
{ } |
この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの1つを選択します。 （例） ｛A｜B｜C｝ A，BまたはCのどれかを指定することを示します。 |
|
［ ］ |
この記号で囲まれている項目は省略してもよいことを示します。 （例） ［A］ 「何も指定しない」か「Aを指定する」ことを示します。 |
|
< > |
この記号で囲まれている項目は，該当する要素を指定することを示します。 （例） <プロパティ> プロパティを記述します。 |
|
… |
記述が省略されていることを示します。 （例） ABC… ABCの後ろに記述があり，その記述が省略されていることを示します。 |
|
〜 |
この記号の前に示された項目が，記号〜に続く＜ ＞，(( ))，<< >>などの規則に従うことを示します。 |
|
＜ ＞ |
項目を記述するときに従わなければならない構文要素を示します。構文要素については，次の表を参照してください。 |
|
(( )) |
項目で指定できる値の範囲を示します。 |
|
<< >> |
項目を省略したときに，システムが仮定する標準値を示します。 |
この章で使用している構文要素の種類と定義を次に示します。
|
種類 |
定義 |
|---|---|
|
英字 |
A〜Z a〜z |
|
英小文字 |
a〜z |
|
英大文字 |
A〜Z |
|
数字 |
0〜9 |
|
英数字 |
A〜Z a〜z 0〜9 |
|
記号 |
_ . - |
|
文字列 |
任意の文字の配列 |