test

SunOS リファレンスマニュアル 1M : システム管理コマンド

はじめに

SunOS オペレーティングシステムの初心者でも、熟練したユーザーでも、オンラインのマニュアルページを使ってシステムおよびその機能に関する情報を入手できます。すでに発見されているバ~グについて説明しています。可能な場合は対処法も示しています。マニュアルページは一般に参照マニュアルとして作られています。通常、マニュアルページには、リファレンスマニュアルの内容が含まれています。チュートリアルな要素は含んでいません。

概要

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

以下に、このマニュアルの項目を説明します。ほとんどのマニュアルページが下記の項目からなる共通の書式で書かれていますが、必要でない項目については省略されています。たとえば、記述すべきバグがコマンドにない場合などは、「使用上の留意点」という項目はありません。各マニュアルページの詳細は各セクションの 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) のマニュアルページを参照してください。

関連項目

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

診断

このセクションでは、エラー原因となった条件に関する簡単な説明と診断メッセージが示されています。

警告

作業に支障を与えるような現象について説明しています。これは診断メッセージの一覧ではありません。

注意事項

この項では、このマニュアルページの他のどの項にも記載されない追加情報を提供します。マニュアルページの内容とは直接関係のない事柄も参照用に扱っています。重要不可欠な情報はこの項では説明しません。

使用上の留意点

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