マニュアルページのセクションの形式

次のリファレンス情報では、マニュアルページの各セクションの内容、各セクション内の情報、および、Oracle Solarisの すべてのマニュアルページで使用されている標準レイアウトについて説明します。

マニュアルページのセクションの説明

次の表では、マニュアルページの各セクションと、それぞれのマニュアルページが参照する情報について説明します。

表 1-1 マニュアルページのセクションの説明

マニュアルページの形式

マニュアルページでは、次のサブセクションの一部または全部を含む標準形式を使用します。ここで示すサブセクションの順序は、個別のマニュアルページセクションで情報が出現する順序に一致しています。

NAME

コマンド、ライブラリ関数、ファイル、またはデバイスドライバの名前を、構文の動作な簡単な説明とあわせて示します。

SYNOPSIS

コマンド、ライブラリ関数、ファイル、またはデバイスドライバの構文を示します。

DESCRIPTION

サービスの機能と動作を定義します。

IOCTL

mtio(7I) のように、すべて末尾が io である特定クラスのデバイスに対して使用します。このセクションはセクション 7 のページのみに出現します。

OPTIONS

コマンドオプションの一覧を、各オプションの動作の簡潔な要約とあわせて示します。

OPERANDS

コマンドオペランドの一覧を示し、オペランドがコマンドの動作に及ぼす影響について説明します。

OUTPUT

コマンド、ライブラリ関数、ファイル、またはデバイスドライバによって生成される出力、標準出力、標準エラー、または出力ファイルについて説明します。

RETURN VALUES

値の一覧を示し、それぞれの値が返される条件について説明します (戻り値のある関数について記述したマニュアルページのみに該当します)。

ERRORS

関数ライブラリが生成する可能性のあるすべてのエラーコードをアルファベット順の一覧で示し、それぞれのエラーが発生する条件について説明します。

USAGE

詳しい説明を必要とする特殊な規則、機能、およびコマンドの一覧を示します。

EXAMPLES

コマンド、ライブラリ関数、ファイル、またはデバイスドライバの構文または使用方法の例を提供します。

ENVIRONMENT VARIABLES

コマンド、ライブラリ関数、ファイル、またはデバイスドライバが影響を及ぼす環境変数の一覧を、その影響の簡単な説明とあわせて示します。

EXIT STATUS

呼び出し元のプログラムまたはシェルにコマンドが返す値と、これらの値が返される原因となる条件の一覧を示します。

FILES

関連するファイルや、コマンドによって作成または要求されるファイルなど、マニュアルページで言及しているすべてのファイル名を一覧で示します。

ATTRIBUTES

コマンド、ユーティリティー、およびデバイスドライバの特性の一覧を、属性の型とその対応する値を定義することによって示します。attributes(5) のマニュアルページを参照してください。

関連項目

関連するコマンドまたはライブラリ関数を示します。

DIAGNOSTICS

診断メッセージの一覧を、エラーの原因となる条件の簡単な説明とあわせて示します。

WARNINGS

作業条件に重大な影響を及ぼす可能性がある特殊条件についての警告を一覧で示します。これは診断の一覧ではありません。

NOTES

ページのほかの部分に分類されない追加情報の一覧を示します。

BUGS

既知のバグについて説明し、可能な場合には回避方法を提示します。