SunOS オペレーティングシステムの初心者でも、熟練したユーザーでも、オンラインのマニュアルページを使ってシステムおよびその機能に関する情報を入手できます。マニュアルページは、「それは何を行うのか」という質問に簡潔に回答するために作成されています。マニュアルページは一般にリファレンスマニュアルとなります。チュートリアルとしては作成されていません。
次に、マニュアルページの各セクションと、そこに含まれている情報について簡単に説明します。
セクション 1 では、オペレーティングシステムで使用できるコマンドをアルファベット順に説明しています。このセクションでは、セクション 1G で説明されている Solaris コマンドの代替オープンソース実装も提供します。
セクション 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 つのみを一度に指定できます。
中括弧。中括弧で囲まれたオプション・引数は相互に依存しており、1 つの組として取り扱う必要があります。
このセクションは、サブセクション 3R でのみ発生し、プロトコルの説明ファイルを示します。
このセクションでは、サービスの機能および動作を定義します。つまり、コマンドの動作について簡潔に説明しています。オプションについて説明したり、例を示したりはしていません。対話型のコマンド、サブコマンド、要求、マクロ、および関数については、「使用法」で説明されています。
このセクションは、セクション 7 のページだけに含まれます。ioctl(2) システムコールに適切なパラメータを提供するデバイスクラスのみが ioctl と呼ばれ、独自の見出しを生成します。特定のデバイスに関する ioctl 呼び出しは、(そのデバイスのマニュアルページに) アルファベット順に記述されています。ioctl 呼び出しは、mtio(7I) のように、すべて io で終わる特定クラスのデバイスに使用されます。
このセクションでは、各オプションの動作についての簡潔なサマリーとともに、コマンドのオプションを一覧表示します。オプションは文字順および「形式」セクションで表示される順序で一覧表示されます。オプションに指定可能な引数については「オプション」で説明され、該当する場合はデフォルト値が示されます。
このセクションでは、コマンドのオペランドの一覧を示し、各オペランドがコマンドの動作にどのように影響を及ぼすかを説明します。
このセクションでは、コマンドによって生成される出力 (標準出力、標準エラー、または出力ファイル) について説明します。
値を返す関数のマニュアルページの場合、このセクションには、これらの値の一覧および値が返される条件が示されます。関数が 0 や -1 などの定数値だけを返す場合は、これらの値がタグ付き段落で一覧表示されます。それ以外の場合は、各関数の戻り値が 1 つの段落で説明されます。void と宣言された関数は値を返さないため、「戻り値」では扱われません。
エラー発生時、ほとんどの関数はエラーコードを大域変数 errno に格納し、エラーの理由を示します。このセクションでは、関数が生成しうるすべてのエラーコードの一覧をアルファベット順で示し、各エラーの発生条件について説明します。複数の条件が同じエラーの原因になる場合、そのエラーコードの下に各条件が別々の段落で記述されます。
このセクションでは、詳細な説明を必要とする特殊な規則、機能、およびコマンドを示します。次に示すサブセクションは、組み込まれている機能を説明するために使用されます。
|
このセクションでは、コマンドまたは関数の使用例または使用方法を説明します。可能な場合は、コマンド行の入力とマシンの応答を含む完全な例が示されます。例の中で、プロンプトは example% と表示されるか、スーパーユーザーでなければならない場合は example# と表示されます。例のあとに、説明、変数置換規則、または戻り値が示されます。ほとんどの例が、「形式」、「機能説明」、「オプション」、「使用法」のセクションの概念を示す実例となっています。
このセクションでは、コマンドまたは関数が影響を与えるすべての環境変数の一覧を示し、その影響について簡単に説明します。
このセクションでは、コマンドが呼び出し元のプログラムまたはシェルに返す値の一覧と、これらの値が返される条件を示します。通常、正常終了には 0 が返され、0 以外の値はそれぞれのエラー状態を示します。
このセクションでは、マニュアルページで参照されるすべてのファイル名、対象のファイル、およびコマンドによって作成または要求されるファイルを一覧表示します。各ファイルのあとに、説明的なサマリーまたは説明が続きます。
このセクションでは、属性タイプおよび対応する値を定義して、コマンド、ユーティリティー、およびデバイスドライバの特性を一覧表示します。詳細は attributes(5) を参照してください。
このセクションでは、その他のマニュアルページ、Oracle のドキュメント、および社外出版物への参照を一覧表示します。
このセクションでは、診断メッセージの一覧を示し、エラーの発生条件について簡単に説明します。
このセクションでは、作業環境に重大な影響を与える可能性のある特殊な条件に関する警告の一覧を示します。これは診断の一覧ではありません。
このセクションでは、ページのどこにも属さない追加情報を一覧表示します。これはユーザーへの余談という形式を取り、特別に関心がある点について扱います。重大な情報については、ここでは扱いません。
このセクションでは、既知のバグについて説明し、可能な場合は回避方法を示します。
この製品に関する最新情報および既知の問題については、ドキュメントライブラリ (http://www.oracle.com/pls/topic/lookup?ctx=E56342) に記載されています。
Oracle のお客様は、My Oracle Support を通じて電子的なサポートを利用することができます。詳細は、http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info を参照してください。聴覚に障害をお持ちの場合は、http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs を参照してください。
Oracle のアクセシビリティーに対する取り組みの詳細は、Oracle Accessibility Program の Web サイト (http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc) を参照してください。
このドキュメントに関するフィードバックを http://www.oracle.com/goto/docfeedback からお聞かせください。