ここではコマンドに関する説明を記述します。
実行環境
コマンドを実行するための環境について説明します。
名前
コマンド、および機能名称を記述します。
形式
コマンドの入力形式を記述します。
|：選択肢を分ける
{ }：すべての選択肢を囲む
[ ]：パラメータを示す
機能説明
コマンドについての説明、および個々のパラメータについて記述します。
復帰値
コマンドを実行した結果、返される値についての説明を記述します。
実行方法
コマンド実行結果について記述します。
表示形式
コマンドを実行した結果、取得できる情報の表示形式について記述します。
表示内容
コマンドを実行した結果、取得できる情報のタイトルと内容について記述します。
注意事項
コマンドを実行する場合に必要な注意について記述します。
表示例
コマンド実行結果の表示例を記述します。
使用例
場合別のコマンド実行時の記述例を示します。
実行例
実際にコマンドを実行した場合の結果の表示内容について記述します。
実行できるユーザ
当該コマンドを実行できる資格について記述します。
