test

Sun Cluster Geographic Edition リファレンスマニュアル

はじめに

『Sun Cluster Geographic Edition リファレンスマニュアル』では、SunTM Cluster Geographic Edition ソフトウェアのパブリックインタフェース (コマンドや関数など) のリファレンス情報を挙げています。このマニュアルは、Sun のソフトウェアとハードウェアについて幅広い知識を持つ、経験豊かなシステム管理者を対象としています。このマニュアルを計画または事前販売のガイドとして使用しないでください。このマニュアルに記載されている情報は、SolarisTM オペレーティングシステム (Solaris OS) に関する知識と、Sun Cluster ソフトウェアとともに使用するボリュームマネージャーソフトウェアの専門知識があることを前提としています。

Solaris OS に不慣れなユーザーも、この OS に詳しいユーザーも、オンラインマニュアルページを使用して、使用している SPARC® ベースシステムとその機能についての情報を入手できます。

マニュアルページは、「このコマンドにはどのような機能があるか」という疑問に簡潔に答えることを目的としています。通常、マニュアルページには、リファレンスマニュアルの内容が含まれています。一般マニュアルページは解説書としてではなく、リファレンスマニュアルとして利用するのに適しています。

リファレンスマニュアルの構成

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

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

名前

この項には、記載されているコマンドまたは関数の名前が示され、続いてコマンドまたは関数の動作の概略が続きます。

形式

この項には、コマンドまたは関数の構文が示されます。標準パス内にコマンドまたはファイルが存在しない場合は、フルパス名が示されます。オプションと引数は、アルファベット順に並んでいます。異なる順序で引数を指定する必要がある場合を除き、1 文字の引数、引数の付いたオプションの順に示されています。

この項では、次の特殊文字を使用します。

[ ]

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

. . .

省略符号。前の引数に複数の値を指定するか、または前の引数を複数回指定できます。 (例:filename . を参照してください。を参照してください。)

|

区切り記号。一度に指定できるのは、この文字で分割されている引数のうち 1 つだけです。

{ }

中括弧。中括弧に囲まれた複数のオプションまたは引数は相互依存関係にあります。中括弧内のすべての文字を 1 つの単位として扱います。

プロトコル

この項が使用されているのはサブセクション 3R 内だけであり、プロトコルが記述されているファイルを示しています。

機能説明

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

IOCTL

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

オプション

この項では、コマンドのオプション名を一覧で挙げ、各オプションの動作の概略を示しています。オプションは入力する文字どおりに示され、「形式」で出現する順序で一覧表示されています。オプションに対して引数が使用可能な場合は、そのオプションの項目に記載します。該当する場合は、デフォルト値も示します。

オペランド

この項では、コマンドのオペランド一覧と、それらがコマンドの動作に与える影響について説明します。

出力

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

戻り値

値を戻す関数のマニュアルページの場合、これらの戻り値と、戻される条件を示します。関数が 0 または -1 のような定数だけを戻す場合、その値と説明を記述します。それ以外の場合は、各関数の戻り値を文章で説明します。void と宣言された関数には戻り値がないため、ここでは扱いません。

エラー

エラーが発生した場合、ほとんどの関数はエラーコードをグローバル変数 errno に格納し、エラーの理由を示します。この項では、関数が生成しうるすべてのエラーコードの一覧 (アルファベット順) と、各エラーの発生条件を示します。

使用法

この項では、詳しい説明を要する特殊な規則、機能、コマンドが示されています。組み込み機能については、次の小項目で説明しています。

  • Commands
  • Modifiers
  • Variables
  • Expressions
  • Input Grammar

使用例

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

環境変数

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

終了ステータス

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

ファイル

マニュアルページが参照するファイルや関連ファイル、コマンドによって作成されるファイル、コマンドが必要とするファイルなどの名前を示し、そのあとに各ファイルの概要を示しています。

属性

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

関連項目

関連するマニュアルページ、当社のマニュアル、および一般の出版物が示されています。

診断

エラーの発生状況の簡単な説明と、診断メッセージが示されています。

警告

作業に重大な影響を及ぼす可能性のある特殊な状況についての警告を挙げています。警告は診断のリストではありません。

注意事項

どの項にも該当しない補足的な情報が示されています。この項では参考情報を挙げています。重要不可欠な情報はこの項では説明しません。

使用上の留意点

すでに発見されているバグについて説明しています。可能な場合は対処法も示しています。