はじめに

SunOS オペレーティングシステムの初心者でも、熟練したユーザーでも、オンラインのマニュアルページを使ってシステムおよびその機能に関する情報を入手できます。マニュアルページは、「それは何を行うのか」という質問に簡潔に回答するために作成されています。マニュアルページは一般にリファレンスマニュアルとなります。チュートリアルとしては作成されていません。

概要

次に、マニュアルページの各セクションと、それらのセクションで示される情報の概要を示します。

• セクション 1 では、オペレーティングシステムで使用できるコマンドをアルファベット順に説明しています。

• セクション 1M では、主にシステムの保守と管理のために使用されるコマンドをアルファベット順に説明しています。

• セクション 2 では、すべてのシステムコールについて説明しています。これらの呼び出しのほとんどは、1 つ以上のエラーを返します。エラー状態は、ほかの場合には返されない戻り値によって示されます。

• セクション 3 では、セクション 2 で説明されている UNIX システムプリミティブを直接呼び出す関数を除き、さまざまなライブラリにある関数について説明しています。

• セクション 4 では、各種ファイルの形式について説明しています。該当する場合は、ファイル形式を C 言語の構造体の宣言を使用して示します。

• セクション 5 では、文字セットテーブルなど、その他各種の情報について説明しています。

• セクション 7 では、特定のハードウェア周辺装置やデバイスドライバを参照する、さまざまな特殊ファイルについて説明しています。STREAMS ソフトウェアドライバ、モジュール、およびシステムコールの STREAMS 汎用セットについても説明します。

• セクション 9E では、開発者がデバイスドライバに組み込むことができる、DDI (デバイスドライバインタフェース)/DKI (ドライバ/カーネルインタフェース) 両用、DDI 専用、および DKI 専用のエントリポイントルーチンについて説明しています。

• セクション 9F では、デバイスドライバで使用できるカーネル関数について説明しています。

• セクション 9S では、ドライバとカーネルの間で情報を共有するためにドライバで使用されるデータ構造について説明しています。

マニュアルページの一般形式は次のとおりです。各マニュアルセクションのマニュアルページは、通常この順序に従っていますが、必要な項目だけを含んでいます。たとえば、記述すべきバグがコマンドにない場合、「使用上の留意点」というセクションはありません。各セクションの詳細については intro ページ、マニュアルページの一般的な情報については man(1) を参照してください。

名前

このセクションでは、コマンドまたは関数の名前および機能の概略を示します。

形式

このセクションでは、コマンドまたは関数の構文を示します。コマンドやファイルが標準パスに存在しない場合は、そのフルパス名が示されます。別の引数順序が必要な場合を除いて、オプションと引数はアルファベット順に、まず 1 文字の引数、次に引数付きのオプションが記述されます。

このセクションでは、次の特殊文字が使用されます。

[ ]

角括弧。角括弧に囲まれたオプションや引数は省略できます。角括弧がない場合、その引数は必須です。

. . .

省略記号。前の引数に複数の値を指定すること、または前の引数を複数回指定することができます (例: “filename . . .”)。

|

区切り文字。この文字で区切られている引数のうち 1 つだけを一度に指定できます。

{ }

中括弧。中括弧に囲まれたオプションや引数は相互に依存しているため、括弧内のすべてを一体として扱う必要があります。

プロトコル

このセクションは、プロトコルが記述されているファイルを示すためにサブセクション 3R でのみ使用されます。

機能説明

このセクションでは、サービスの機能と動作を定義します。つまり、コマンドの機能を簡潔に説明します。オプションの説明や使用例はここでは示されていません。対話形式のコマンド、サブコマンド、要求、マクロ、および関数については「使用法」で説明します。

IOCTL

このセクションは、セクション 7 のページだけに含まれます。ioctl(2) システムコールに適切なパラメータを提供するデバイスクラスのみが ioctl と呼ばれ、独自の見出しを生成します。特定のデバイスに関する ioctl 呼び出しは、(そのデバイスのマニュアルページに) アルファベット順に記述されています。ioctl 呼び出しは、mtio(7I) のように、すべて io で終わる特定クラスのデバイスに使用されます。

オプション

このセクションでは、コマンドオプションの一覧と各オプションの機能のサマリーを示します。オプションは、「形式」のセクションで示されている順序で、文字通りに記述されています。オプションに引数がある場合はそのオプションの下で説明され、該当する場合はデフォルト値が示されます。

オペランド

このセクションでは、コマンドのオペランドの一覧を示し、各オペランドがコマンドの動作にどのように影響を及ぼすかを説明します。

出力

このセクションでは、コマンドによって生成される出力 (標準出力、標準エラー、または出力ファイル) について説明します。

戻り値

値を返す関数のマニュアルページの場合、このセクションには、これらの値の一覧および値が返される条件が示されます。関数が 0 や -1 などの定数値だけを返す場合は、これらの値がタグ付き段落で一覧表示されます。それ以外の場合は、各関数の戻り値が 1 つの段落で説明されます。void と宣言された関数は値を返さないため、「戻り値」では扱われません。

エラー

エラー発生時、ほとんどの関数はエラーコードを大域変数 errno に格納し、エラーの理由を示します。このセクションでは、関数が生成しうるすべてのエラーコードの一覧をアルファベット順で示し、各エラーの発生条件について説明します。複数の条件が同じエラーの原因になる場合、そのエラーコードの下に各条件が別々の段落で記述されます。

使用法

このセクションでは、詳細な説明を必要とする特殊な規則、機能、およびコマンドを示します。次に示すサブセクションは、組み込まれている機能を説明するために使用されます。

コマンド 修飾子 変数 式 入力文法

使用例

このセクションでは、コマンドまたは関数の使用例または使用方法を説明します。可能な場合は、コマンド行の入力とマシンの応答を含む完全な例が示されます。例の中で、プロンプトは example% と表示されるか、スーパーユーザーでなければならない場合は example# と表示されます。例のあとに、説明、変数置換規則、または戻り値が示されます。ほとんどの例が、「形式」、「機能説明」、「オプション」、「使用法」のセクションの概念を示す実例となっています。

環境変数

このセクションでは、コマンドまたは関数が影響を与えるすべての環境変数の一覧を示し、その影響について簡単に説明します。

終了ステータス

このセクションでは、コマンドが呼び出し元のプログラムまたはシェルに返す値の一覧と、これらの値が返される条件を示します。通常、正常終了には 0 が返され、0 以外の値はそれぞれのエラー状態を示します。

ファイル

このセクションでは、マニュアルページが参照するファイル、関連ファイル、およびコマンドが作成または必要とするファイルの一覧を示します。それぞれのあとに、サマリーまたは説明があります。

属性

このセクションでは、属性タイプとその対応する値を定義することにより、コマンド、ユーティリティー、およびデバイスドライバの特性を示します。詳細については、attributes(5) を参照してください。

関連項目

このセクションでは、関連するマニュアルページ、当社のマニュアル、および外部の出版物を示します。

診断

このセクションでは、診断メッセージの一覧を示し、エラーの発生条件について簡単に説明します。

警告

このセクションでは、作業環境に重大な影響を与える可能性のある特殊な条件に関する警告の一覧を示します。これは診断の一覧ではありません。

注意事項

このセクションでは、このマニュアルページの他のどのセクションにも記載されない追加情報を示します。ユーザーへの参考情報として、特に関心を引く事項を扱います。ここで重要な情報が扱われることはありません。

使用上の留意点

このセクションでは、既知の問題について説明し、可能な場合は回避方法を示します。