『Oracle Solaris Cluster 4.3 Quorum Server リファレンスマニュアル』には、Oracle Solaris Cluster Quorum Server ソフトウェアのコマンド、ファイル形式、その他の公開インタフェースについての参考情報が記載されています。このマニュアルは、Oracle ソフトウェアおよびハードウェアに詳しいシステム管理者を対象にしています。このマニュアルは、企画やプレセールスに使用する目的で作成したものではありません。このマニュアルの内容は、Oracle Solaris オペレーティングシステムに関する知識と、Oracle Solaris Cluster ソフトウェアとともに使用するボリュームマネージャーソフトウェアに関する専門知識を前提にしています。
Oracle Solaris オペレーティングシステムの使用経験の深さとは関係なく、オンラインのマニュアルページはSPARCベースのシステムや x86 ベースのシステムとその機能に関する情報の習得に役立ちます。
マニュアルページは、コマンドの機能を一定の書式で簡潔に説明するための資料です。マニュアルページは、リファレンス (参照用) マニュアルです。チュートリアル（独習用）として作成したものではありません。
このマニュアルページの各セクションの内容と、そこで参照できる情報の要約を次に示します。
セクション 1CL では、Oracle Solaris Cluster Quorum Server の保守と管理に使用するコマンドをアルファベット順に説明しています。
セクション 1M: 主にシステムの保守と管理に使用されるコマンドをアルファベット順に説明しています。
セクション 4 では、各種ファイル形式の概要について説明します。該当する場合は、ファイル書式についての C 言語の構造体宣言を記載してあります。
マニュアルページの一般形式は、次のようになります。各マニュアルセクションのマニュアルページの一期な書式と見出し項目の順序を示します。ただし、実際には必要な見出し項目の記事だけが記載されます。たとえば、バグが報告されていない場合は、「バグ」のセクションは省かれます。詳しくは intro のページおよび各ページセクションの記事を参照してください。また、マニュアルページに関する一般的な情報については、man(1) のページを参照してください。
このセクションには、文書化されたコマンドや機能の名称が記載され、それに続いてそれらのものの機能が説明されています。
このセクションには、コマンドまたは機能の構文が示されています。コマンドやファイルが標準パス内に存在しない場合は、そのフルパス名が示されています。オプションと引数は、アルファベット順に、1 文字の引数を最初に、引数付きのオプションを次に配列してあります。ただし、必要な場合はこの順序を変更してあります。
このセクションでは、次の特殊文字が使用されます。
大かっこ。大かっこで囲まれたオプションや引数は、任意選択です。大かっこで囲まれていない引数は、必ず指定しなければなりません。
反復記号。前にある引数にいくつかの値を指定できるか、前にある引数を繰り返し指定できることを表します (例: "filename …")。
セパレータ。この文字で分けられている引数のの内、どちらか 1 つのみを 1 時点で指定することができます。
中かっこ。中かっこで囲まれたオプションや引数は、互いに依存しています。中かっこに囲まれたすべての文字をそれぞれ 1 つのユニットとして扱う必要があります。
このセクションは、サブセクション 3R のみにあり、プロトコル記述ファイルを示しています。
このセクションには、サービスの機能と動作が定義されています。それにより、そのコマンドが何をするのかが簡潔に説明されます。「説明」では、「オプション」や引用「例」は扱いません。対話型コマンド、サブコマンド、リクエスト、マクロ、および関数は、「用途」で説明されます。
このセクションは、セクション 7 のページだけに現れます。該当するパラメータを ioctl(2) システムコールに提供するデバイスクラスのみが ioctl と呼ばれ、独自の見出しで記載されます。特定のデバイスに対するioctl コールが、その特定のデバイスのマニュアルページにアルファベット順で一覧表示されます。ioctl コールは、特定のデバイスクラスに対して使用されます。この種のすべてのコールの名前の末尾は io で終わっています (例: mtio(7I))。
このセクションにはコマンドオプションが一覧表示され、それぞれのオプションの働きについて簡潔なサマリーが示されます。オプションは文字通りに一覧表示され、「形式」セクションに記載された順序で示されます。オプションに指定できる引数については、このオプションの項とで説明され、該当する値がある場合は、デフォルト値が示されます。
このセクションでは、コマンドのオペランドの一覧を示し、各オペランドがコマンドのアクションにどのように影響を及ぼすかを説明します。
このセクションでは、標準出力、標準エラー、またはコマンドが生成する出力ファイルなどの出力が説明されます。
マニュアルページの関数が戻り値を返す場合は、このセクションにそれらの値がリストされ、それが返される条件が示されます。関数が 0 や -1 などの定数しか返せない場合は、それらの値がタグ付きの段落に示されます。さもなければ、1 つの段落に各関数の戻り値が示されます。空 (void) として宣言された関数は、値を返しません。したがって、「戻り値」では説明されません。
実行に失敗すると、ほとんどの関数は広域変数 errno に失敗の原因を示すエラーコードをセットします。このセクションでは、関数が発生するすべてのエラーコードをリストし、それらのエラーの原因になる条件が説明されます。複数の条件が同じエラーを起こす場合は、それぞれの条件が段落を分けエラーコードとともに示されます。
このセクションには、詳細な説明を必要とする特別な規則、機能、およびコマンドが記載されます。ここに掲載されるサブセクションでは、次の組み込み機能が説明されます。
|
このセクションでは、使用例やコマンドや関数の使用法が説明されます。可能な場合は、コマンド行入力とそれに対するマシンの応答出力を示す完全な例が示されます。例が記載されている場合、プロンプトが example% として示されるか、またはユーザーがスーパーユーザーでなければならない場合は example# として示されます。例のあとには、説明、変数の置換規則、または戻り値が示されます。ほとんどの例では、「形式」、「説明」、「オプション」、および「用途」セクションのコンセプトが例証されます。
このセクションには、コマンドや関数が影響を与える環境変数は一覧表示され、そのあとにその効果が要約して示されます。
このセクションには、コマンドからそれを呼び出したプログラムやシェルに返される値がリストされ、そのような値が返される原因になる条件が示されます。通常は、実行に成功するとゼロが返され、さまざまなエラー条件に対してはゼロ以外の値が返されます。
このセクションには、マニュアルページで参照されているすべてのファイル名、関連ファイル、およびコマンドが作成するか必要とするファイルがリストされます。それぞれのファイル名のあとに、サマリーまたは説明が付きます。
このセクションでは、コマンドの特性、ユーティリティー、およびデバイスドライバがリストされ、属性タイプとその値の定義が示されます。詳細は attributes(5) を参照してください。
このセクションには、他のマニュアルページ、社内ドキュメント、および外部出版物への参照先が示されます。
このセクションには、診断メッセージとその発生原因の要約が示されます。
このセクションには、重大な支障をもたらす恐れのある特別な条件に対する警告メッセージが示されます。「警告」は、診断レベルのメッセージとは異なります。
このセクションには、ページ上のどのセクションにも属さない、その他の情報が示されます。「注」は、知っていると役に立つことがらの要点をユーザーに示します。ここでは、重大な情報は扱われません。
このセクションには、既知のバグと、可能な場合はその対策が示されます。
この製品および関連製品のドキュメントとリソースは http://www.oracle.com/pls/topic/lookup?ctx=E62281 で入手可能です。
このドキュメントに関するフィードバックを http://www.oracle.com/goto/docfeedback からお聞かせください。