はじめに

このドキュメントは、Oracle Solaris 11 システムインストールツールのマニュアルページを提供します。

概要

次に、マニュアルページの各セクションと、そこに含まれている情報について簡単について説明します。

• セクション 1 では、オペレーティングシステムで利用可能なコマンドについて説明します。

• セクション 1M では、システムの保守および管理目的で主に使用するコマンドについて説明します。

• セクション 5 には、文字セット表などのその他のドキュメントが含まれています。

以下に、マニュアルページの一般的な形式を示します。一般に、各マニュアルセクションのマニュアルページはこの順序に従いますが、必要な見出しのみが含まれています。たとえば、レポートするバグがない場合は、「使用上の留意点」セクションはありません。一般的なマニュアルページの詳細については、man コマンドを参照してください。

名前

このセクションでは、ドキュメント化されたコマンドまたは関数の名前に続いて、その動作について簡単な説明を示します。

形式

このセクションでは、コマンドまたは関数の構文を示します。コマンドまたはファイルが標準パスに存在しない場合は、そのフルパス名が表示されます。異なる引数順序が必要でないかぎり、オプションおよび引数はアルファベット順 (1 番目に単一文字の引数、次に引数が付いたオプション) で表示されます。

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

[ ]

角括弧。角括弧で囲まれたオプションまたは引数は省略可能です。角括弧を省略した場合は、引数を指定する必要があります。

. . .

省略記号。前の引数に複数の値を指定したり、前の引数を複数回指定したりできます (例: filename ...)。

|

区切り文字。この文字で区切られた引数のうち 1 つのみを一度に指定できます。

{ }

中括弧。中括弧で囲まれたオプション・引数は相互に依存しており、1 つの組として取り扱う必要があります。

プロトコル

このセクションは、サブセクション 3R でのみ発生し、プロトコルの説明ファイルを示します。

機能説明

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

オプション

このセクションでは、各オプションの動作についての簡潔なサマリーとともに、コマンドのオプションを一覧表示します。オプションは文字順および「形式」セクションで表示される順序で一覧表示されます。オプションに指定可能な引数については「オプション」で説明され、該当する場合はデフォルト値が示されます。

オペランド

このセクションでは、コマンドのオペランドを一覧表示し、コマンドの動作への影響について説明します。

出力

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

戻り値

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

エラー

大部分の関数は失敗時に、エラーの原因を示すエラーコードをグローバル変数 errno に配置します。このセクションでは、関数が生成できるすべてのエラーコードをアルファベット順に一覧表示し、各エラーが発生する条件について説明します。複数の条件で同じエラーが発生する可能性がある場合は、エラーコードの下にある個別の段落で各条件について説明します。

使用法

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

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

使用例

このセクションでは、コマンドまたは関数の使用例または使用方法を示します。可能なかぎり、コマンド行エントリおよびマシン応答を含む完全な例が表示されます。例が示される場合は、常にプロンプトは example% と表示され、ユーザーがスーパーユーザーになる必要がある場合は、example# と表示されます。例に続いて、説明、変数の置換規則、または戻り値が表示されます。ほとんどの例は、「形式」、「機能説明」、「オプション」、および「使用法」に記載されたコンセプトを例証しています。

環境変数

このセクションでは、コマンドまたは関数によって影響を受ける環境変数を一覧表示したあとに、その影響について簡潔に説明します。

終了ステータス

このセクションでは、コマンドが呼び出し元のプログラムまたはシェルに戻す値、およびそれらの値が戻される条件を一覧表示します。通常、正常に完了した場合はゼロが戻され、さまざまなエラー状況の場合はゼロ以外が戻されます。

ファイル

このセクションでは、マニュアルページで参照されるすべてのファイル名、対象のファイル、およびコマンドによって作成または要求されるファイルを一覧表示します。各ファイルのあとに、説明的なサマリーまたは説明が続きます。

属性

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

関連項目

このセクションでは、その他のマニュアルページ、Oracle のドキュメント、および社外出版物への参照を一覧表示します。

診断

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

警告

このセクションでは、作業状況に著しく影響を与える可能性のある特別な条件についての警告を一覧表示します。これは診断の一覧ではありません。

注意事項

このセクションでは、ページのどこにも属さない追加情報を一覧表示します。これはユーザーへの余談という形式を取り、特別に関心がある点について扱います。重大な情報については、ここでは扱いません。

使用上の留意点

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