1.2 コマンドリファレンスの見方
コマンドリファレンスを読むために必要な情報について説明しています。
記述形式
コマンドについて次の形式で説明します。各コマンドの説明では、次の項目のうち必要な項目についてだけ説明しています。また、次の項目以外に、各コマンドの固有情報を記載している場合があります。
- 書式
-
コマンドの入力形式を示します。
- 格納先
-
コマンドが格納されているパスを示します。
- 機能
-
コマンドの機能について説明します。
- 実行権限
-
コマンドの実行権限を示します。
- 前提条件
-
コマンドを実行する上で前提となる条件を示します。
- 引数
-
コマンドの引数およびオプションについて説明します。
オプションでは、そのオプションに対するオプション引数が必要な場合があります。
Java EEサーバで使用するコマンドのデフォルト値は、オプションに必要なオプション引数だけを省略した場合ではなく、オプション自体を指定しなかった場合の値を示します。
- 出力形式
-
コマンドの出力形式を示します。
- 使用例
-
コマンドの入力例、出力例などを示します。
- 戻り値
-
コマンドの戻り値について説明します。
- 注意事項
-
コマンドを実行する上での注意事項について説明します。
使用している記号
コマンドの文法では、次の表に示す記号を使用して記述しています。
|
記号 |
意味 |
|---|---|
|
| |
横に並べられた複数の項目に対する項目間の区切りを示し、「または」を意味します。 （例） A｜B AまたはBを指定することを示します。 |
|
{ } |
この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目が横に並べられ、記号|で区切られている場合は、そのうちの1つを選択します。 （例） {A|B|C} A、BまたはCのどれかを指定することを示します。 |
|
[ ] |
この記号で囲まれている項目は省略してもよいことを示します。複数の項目が横に並べて記述されている場合には、すべてを省略するか、記号{ }と同じくどれか1つを選択します。 （例1） [A] 「何も指定しない」か「Aを指定する」ことを示します。 （例2） [B|C] 「何も指定しない」か「BまたはCを指定する」ことを示します。 |
|
... |
この記号の直前に示す項目を繰り返し、複数個指定できることを示します。 （例） [プロパティー]... プロパティーは複数個、繰り返して指定できます。 |
|
項目 |
斜体で表記されている項目は、該当する要素やファイルなどを指定したり、該当する要素が表示されたりすることを示します。 （例1） プロパティー プロパティーを記述します。またはプロパティーが表示されます。 （例2） ファイル名 ファイル名を指定します。 |
使用している構文要素
コマンドの説明では、次の表に定義した構文要素を使用して記述しています。
|
構文要素 |
定義 |
|---|---|
|
英字 |
A〜Z a〜z |
|
英小文字 |
a〜z |
|
英大文字 |
A〜Z |
|
数字 |
0〜9 |
|
英数字 |
A〜Z a〜z 0〜9 |
|
記号 |
! " # $ % & ' ( ) + , _ ・ . / : ; < = > @ [ ] ^ - { } ~ タブ スペース |
- 注
-
すべて半角文字を使用します。
フォルダーとパスの表記
このマニュアルでは、OS共通の内容の場合、「フォルダー」を「ディレクトリー」と表記しています。また、「\」を「/」と表記しています。「ディレクトリー」を「フォルダー」に、「/」を「\」に置き換えてお読みください。