9.1.1 コマンドの説明で使用する見出し

コマンドの説明で使用する,各見出しについて説明します。

形式
コマンドの記述形式をまとめています。オプション名とオプションの引数の間には,半角スペースまたはタブを入力してください。
機能
コマンドの機能を説明します。
オプション
オプションについて説明します。オプションの引数や,オプションを指定するときの注意事項などを説明します。
戻り値
コマンドの戻り値を説明します。
コマンドの戻り値は,標準出力または標準エラー出力に出力されますが,コマンドの種類によっては共通トレースに出力される場合があります。コマンドの戻り値が共通トレースに出力されるかどうかは,各コマンドの詳細を参照してください。
戻り値の種類は次のとおりです。
0
正常終了したことを示します。
コマンドの戻り値が0の場合,標準出力にメッセージが出力されます。
1
警告付きで正常終了したことを示します。コマンド処理は終了しましたが,処理中にコマンド内で解決できない問題が発生した場合です。
コマンドの戻り値が1の場合,標準出力にメッセージが出力されます。
2
引数エラーが発生したことを示します。コマンド実行時に指定した引数に過不足がある場合,または引数の指定方法に誤りがある場合です。この戻り値はUNIXの場合だけ出力されます。
コマンドの戻り値が2の場合,標準エラー出力にUsageとしてコマンドの正しい記述形式を出力します。Usageを参照して引数を指定し直してください。
-1
引数エラーが発生したことを示します。コマンド実行時に指定した引数に過不足がある場合,または引数の指定方法に誤りがある場合です。この戻り値はWindowsの場合だけ出力されます。
コマンドの戻り値が-1の場合,標準エラー出力にUsageとしてコマンドの正しい記述形式を出力します。Usageを参照して引数を指定し直してください。
その他
コマンド処理中に何らかの問題が発生したため,コマンド処理を中断したことを示します。この場合,標準エラー出力にメッセージが出力されます。
Windowsの場合は-2以下,UNIXの場合は3以上が返されます。
注意事項
コマンドの注意事項を説明します。
実行例
オプションを選択し,オプションの引数に具体値を入力したコマンド実行例を示します。