コマンドの記述形式

コマンドの説明で使用する見出し,およびコマンドの指定形式について説明します。

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

このマニュアルでは,次の表に示す見出しを使ってコマンドの詳細を説明しています。

表3-1 コマンドの説明で使用する見出し

見出し説明
形式コマンドの記述形式をまとめています。形式の説明で使用する記号の意味については,「はじめに」を参照してください。
機能コマンドの機能を説明します。
実行権限コマンドの実行に必要な権限を説明します。
格納場所コマンドの格納場所を説明します。
引数コマンドの引数を説明します。なお,引数にはオプションも含まれます。
注意事項コマンドを使用する場合に注意することを説明します。また,条件によって制限を受けることがあれば説明します。
戻り値コマンドの実行後に戻される値を示します。
使用例オプションを選択したり,具体的な値を入力したりしたコマンドの使用例を示します。
補足事項補足事項を説明します。出力があるコマンドについては出力形式を説明します。

コマンドの指定形式

コマンドの指定形式を次に示します。

[図データ]

(1)をオプションと呼びます。(2)を引数と呼びます。

次に,引数の指定方法を説明します。