日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
FMTMSG(3) FreeBSD ライブラリ関数マニュアル FMTMSG(3)
名称
fmtmsg -- 詳細な診断メッセージを表示する
ライブラリ
標準 C ライブラリ (libc, -lc)
書式
#include <fmtmsg.h>
int
fmtmsg(long classification, const char *label, int severity,
const char *text, const char *action, const char *tag);
解説
fmtmsg() 関数は、stderr および/または、システムコンソールに、供給された引
数に基づく詳細な診断メッセージを表示します。
classification 引数は、それぞれの以下の分類グループから 0 または明白な定
数の 1 つのビット毎の包括的な論理和 (OR) です。Output 分類グループは、
MM_PRINT と MM_CONSOLE の両方が指定されるときからの例外です。
Output
MM_PRINT 出力は、stderr に行われるべきです。
MM_CONSOLE 出力は、システムコンソールに行われるべきです。
状態のソース (メジャ)
MM_HARD 状態のソースは、関連するハードウェアです。
MM_SOFT 状態のソースは、関連するソフトウェアです。
MM_FIRM 状態のソースは、関連するファームウェアです。
状態のソース (マイナ)
MM_APPL 状態は、アプリケーションレベルで検出されました。
MM_UTIL 状態は、ユーティリティレベルで検出されました。
MM_OPSYS 状態は、オペレーティングシステムレベルで検出されまし
た。
Status
MM_RECOVER アプリケーションは、状態から復旧することができます。
MM_NRECOV アプリケーションは、状態から復旧することができませ
ん。
代わりに、MM_NULLMC の明白な定数は、分類を指定しないようにするために使用
されます。
label 引数は、メッセージのソースを示します。それは、コロン (`:') によって
分離された 2 つのフィールドから成ります。最初のフィールドは、最大 10 バイ
トを指定でき、2 番目のフィールドは、最大 14 バイトを指定できます。
MM_NULLLBL の明白な定数は、ラベルなしを指定するために使用されます。
severity 引数は、状態の重要性を識別します。次の明白な定数の 1 つは、この
引数に使用されるべきです。
MM_HALT アプリケーションは、重大な障害に直面し、停止します。
MM_ERROR アプリケーションは、障害を検出しました。
MM_WARNING アプリケーションは、問題を表すかもしれない、普通でない
状態を検出しました。
MM_INFO アプリケーションは、エラーでない状態に関する情報を提供
します。
MM_NOSEV 厳しいレベルが供給されません。
text 引数は、メッセージを引き起こしたエラー状態を詳しく述べます。この文字
列のサイズに制限はありません。MM_NULLTXT の明白な定数は、テキストなしを指
定するために使用されます。
action 引数は、エラー復旧のプロセスがどのように始まるべきであるかを詳しく
述べます。出力のときに、fmtmsg() は、action 引数の始めに "TO FIX:" を前に
置きます。MM_NULLACT の明白な定数は、動作なしを指定するために使用されま
す。
tag 引数は、メッセージのためのオンライン文書を参照すべきです。通常、これ
は、label とユニークな識別番号を含んでいます。タグの例は、"BSD:ls:168" で
す。MM_NULLTAG の明白な定数は、タグなしを指定するために使用されます。
戻り値
fmtmsg() 関数は、成功すれば、MM_OK、stderr への出力が失敗したのを示す
MM_NOMSG、システムコンソールへの出力が失敗したのを示す MM_NOCON、stderr
への出力とシステムコンソールの失敗を示す MM_NOTOK を返します。
環境変数
MSGVERB (メッセージ冗長) 環境変数は、stderr へ出力する fmtmsg() への引数
とどのような順序かを指定します。MSGVERB は、識別子のリストを分離するコロ
ン (`:') であるべきです。有効な識別子は: label, severity, text, action,
と tag です。無効の識別子を指定するか、または不正に分離するなら、デフォル
トメッセージの冗長と順序が使用されます。デフォルトの順序は、
"label:severity:text:action:tag" の値のための MSGVERB と同等です。
使用例
次のコードは:
fmtmsg(MM_UTIL | MM_PRINT, "BSD:ls", MM_ERROR,
"illegal option -- z", "refer to manual", "BSD:ls:001");
次のように:
BSD:ls: ERROR: illegal option -- z
TO FIX: refer to manual BSD:ls:001
stderr に出力されます。
同じコードは、"text:severity:action:tag" に設定された MSGVERB で次のよう
に発生されます:
illegal option -- z: ERROR
TO FIX: refer to manual BSD:ls:001
関連項目
err(3), exit(3), strerror(3)
規格
fmtmsg() 関数は、IEEE Std 1003.1-2001 (``POSIX.1'') に適合しています。
歴史
fmtmsg() 関数は、FreeBSD 5.0 ではじめて登場しました。
バグ
classification 引数のための MM_NULLMC の指定は、指定された出力なしで
fmtmsg() が何も役に立つことができないので、ほとんど意味がありません。
システムコンソールに出力する fmtmsg() のためには、実効ユーザは、
/dev/console に書き込むために適切なパーミッションがなければなりません。こ
れは、ほとんどのシステムで、実効ユーザが root でないなら fmtmsg() が
MM_NOCON を返すことを意味します。
FreeBSD 11.2 August 5, 2002 FreeBSD 11.2