1.2.1　記述形式の詳細

(1)　記述形式

コマンドの文法について次の形式で説明します。なお，各コマンドは，アルファベットの順に説明します。

形式

コマンドの入力形式を示します。

機能

コマンドの機能について説明します。

引数

コマンドの引数およびオプションについて説明します。

出力形式

コマンドの出力形式を示します。

入力例・出力例

コマンドの入力例および出力例を示します。

戻り値

コマンドの戻り値について説明します。

注意事項

コマンドを実行する上での注意事項について説明します。

参考

各コマンドの説明では，上記の項目のうち必要な項目についてだけ説明しています。また，上記の項目以外に，各コマンドの固有情報を記載している場合があります。

ページの先頭へ

(2)　使用する記号

コマンドの文法は次の表に示す記号および構文要素を使用して記述します。

表1‒6　文法で使用している記号

記号	意　味
｜	横に並べられた複数の項目に対する項目間の区切りを示し，「または」を意味します。 （例）　A｜B 　AまたはBを指定することを示します。
{ 　 }	この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの一つを選択します。 （例）　｛A｜B｜C｝ 　A，BまたはCのどれかを指定することを示します。
［　］	この記号で囲まれている項目は省略してもよいことを示します。複数の項目が横に並べて記述されている場合には，すべてを省略するか，記号｛ ｝と同じくどれか一つを選択します。 （例1）　［A］ 　「何も指定しない」か「Aを指定する」ことを示します。 （例2）　［B｜C］ 　「何も指定しない」か「BまたはCを指定する」ことを示します。
…	記述が省略されていることを示します。 （例）　ABC… 　ABCの後ろに記述があり，その記述が省略されていることを示します。
<　>	この記号で囲まれている項目は，該当する要素やファイルなどを指定したり，該当する要素が表示されたりすることを示します。 （例1）　<プロパティ> 　プロパティを記述します。またはプロパティが表示されます。 （例2）　<ファイル名> 　ファイル名を指定します。
...	この記号の直前に示す記号を繰り返し，複数個指定できることを示します。 （例）　<プロパティ>... 　プロパティは複数個，繰り返して指定できます。

表1‒7　文法で使用している構文要素

構文要素	定義
英字	A〜Z　a〜z
英小文字	a〜z
英大文字	A〜Z
数字	0〜9
英数字	A〜Z　a〜z　0〜9
記号	!　"　#　$　%　&　'　(　)　+　,　_　・　.　/　:　;　<　=　>　@　[　]　^　−　｛　｝　￣　タブ　空白

ページの先頭へ