コマンド全体に共通する内容を説明します。
各コマンドの説明の構成は、以下のとおりです。
項目 | 内容 |
---|---|
名前 | コマンドの概要を説明します。 |
形式 | コマンドの記述形式を説明します。 |
機能説明 | コマンドの機能を説明します。 |
オプション | コマンドのオプションを説明します。 |
オペランド | コマンドのオペランド(オプション以外の指定項目)を説明します。なお、オペランドがないコマンドの説明では、本項目を省略しています。 |
実行可能ユーザ | コマンドを実行可能なユーザを示します。 |
使用例 | コマンドの代表的な使用例を示します。 |
コマンドの復帰コード | コマンドの復帰コードと意味を説明します。 |
注意事項 | コマンドの注意事項を説明します。 |
形式、オプション、オペランドで使用する記号の意味は以下のとおりです。
記号 | 意味 |
---|---|
{ | } | 複数の中から1個だけ指定することを示します。 例) {-a|-b} 例) -a {xxx|yyy} |
[ ] | 省略可であることを示します。この記号で囲まれていない場合、省略不可を示します。 例) -a [-b] [-c] 例) [{-a|-b}] |
xxx | オプション省略時の値を示します。(省略時の値を示す記号は、xxxそのものではなく、下線です。) 例) [-a {xxx|yyy}] |
《 》 | 複数の中から1個以上指定することを示します。 例) 《[-a] [-b] [-c]》 |
… | 繰り返し記述できることを示します。 例)ジョブ定義名 […] |
オプションやオペランドの指定値についての留意事項を説明します。
ディレクトリ名やファイル名の説明で、空白を禁止していないものは、空白を指定できます。ディレクトリ名やファイル名に空白を含む文字列を指定する場合、文字列全体を二重引用符で囲みます。
例) -f "/aaa/bbb/c cc"
例) -d "C:\Documents and Settings"
ディレクトリ名やファイル名の説明において、制限長が示されていないものや、“~を参照してください”などの説明のないものは、制限長がシステム上の制限と一致することを示します。
数値の説明では読みやすくするために3桁ごとにコンマで区切っていますが、コマンド入力時にコンマを含むというわけではありません。たとえば、“1~99,999,999の範囲で指定します”という説明では“1~99999999”の範囲で指定できることを示します。
複数指定可能なオプションやオペランドで、指定個数の上限が明記されていないものは、コマンドライン上入力可能な範囲が上限となります。