errinstall コマンド

目的

エラー・ログ・メッセージ・セットにメッセージをインストールします。

構文

errinstall [ -c ] [ -f ] [ -q ] [ -z FileName ] ファイル

説明

errinstall コマンドは、エラー・ログ・メッセージ・カタログ内のエラーの説明、推定原因、ユーザー原因、インストール原因、障害原因、推奨処置、詳細データ ID メッセージのセットの追加または置換に用いられるインストール用の補助機能です。

File パラメーターは、追加または置換されるメッセージが入っている入力ファイルを指定します。 File パラメーターを指定しないか、または - (負符号) を指定すると、 errinstall コマンドは標準入力から読み込みます。

取り消し機能

errinstall コマンドは、 File.undo ファイルという名前の現行ディレクトリーに undo ファイルを作成します。 ( errinstall コマンドが標準入力から読み取りを行っている場合、取り消しファイル情報は標準出力に書き込まれます。) File.undo ファイルを errinstall コマンドへの入力として使用し、errinstall コマンドが行ったばかりの変更を取り消すことができます。 変更を元に戻すには、 -f フラグを指定して errinstall コマンドを実行し、 File パラメーターに File.undo ファイルを指定します。

入力ファイル (または標準入力) ファイル・フォーマット

エラー・ログ・メッセージ・カタログ内の単一メッセージに追加または置換を行うには、2 つの別々の行に情報を入れる必要があります。 1 つのファイルに、複数の追加や置換を入れることができます。 最初の行には、メッセージが追加または置換されるメッセージ・セットを指定します。 入力は次のフォーマットを使用します。

SET MessageSetID

この場合、MessageSetID パラメーターは、次のいずれかの 1 文字です。

2 行目は、追加または置換を行うエラー・メッセージのエラー・メッセージ ID をリストします。 この行は、メッセージ・セットを指定する単一行の後に少なくとも 1 つは必要であり、複数あってもかまいません。 上記のとおり、メッセージ ID を入手するには、最寄りのサービス技術員に連絡してください。 ただし、社内アプリケーションのみのためにメッセージが必要な場合を除きます (この場合は、事前定義エラー・メッセージ ID を使わず、errmsg コマンドを 使ってエラー・メッセージをインストール)。

エラー・メッセージ ID とエラー・メッセージの間には、スペースを 1 つ入れ、次のように、エラー・メッセージのテキストを二重引用符で囲まなければなりません。

message ID "message text"

2 つの必須情報行の他に、コメント行も追加できます。 コメント行には、最初の桁にドル記号 ($) またはアスタリスク (*) 演算子が含まれていなければなりません。 アスタリスクのほうが適しています。

注: 「エラーの説明」、「推定原因」、および「詳細データ ID」の各メッセージ・セットに追加するメッセージは、長さが 40 文字を超えてはなりません。 ユーザー原因、インストール原因、障害原因、 および推奨処置メッセージ・セットに追加されるメッセージは、 128 字以内の長さに納めなければなりません。 メッセージがこれらの長さを超えると、errinstall コマンドは警告メッセージを表示します。メッセージはコード・ポイント・カタログに追加されます。 これらのメッセージは、要約 errpt コマンドによって表示されるときに切り捨てられます。

フラグ

セキュリティー

アクセス制御: root ユーザーのみがこのコマンドを実行できます。

例

1. ライセンス製品のエラー・ログ・メッセージをインストールするには、以下のようにします。lpp次のように入力します。

   errinstall -f /tmp/lpp.desc

2. 上記の errinstall コマンドの例によってエラー・ログ・メッセージ・カタログに加えられた変更を取り消すには、次のように入力します。

   errinstall -f /tmp/lpp.desc.undo

3. 推定原因メッセージ・セットにエラー・メッセージをインストールするには、次のように入力します。

   errinstall
    
   * Add a probable cause for widget failure:
   SET P
   E100 "widget adapter"

4. 推定原因メッセージ・セット内の重複する ID を持つメッセージを置き換えるには、次のように入力します。

   errinstall -f
    
   * Replace the message associated with ID E100 in the
   * Recommended Action message set
   SET R
   E100 "Replace disk drive"

5. 入力ファイルに in_file という名前を付け、それを使用して新しいエラー・メッセージをインストールする場合は、次のように入力します。

   errinstall in_file

6. メッセージ・セット内の既存のエラー・メッセージを上書きするには、 in_fileで以前に定義した ID 番号を使用し、次のように errinstall コマンドで -f フラグを指定します。

   errinstall -f in_file

7. 以下の例は、インストールする入力ファイルのサンプル・コンテンツを示しています。

   *
   * Add these error messages to the Detailed Data message set:
   *
   SET D
   8105 "Logical channel number"
   8106 "Timer reference stamp"
   *
   * Add these error messages to the Probable Cause message set:
   *
   SET P
   E861 "Bad memory card"
   E865 "Unexpected System Halt"
   E876 "Fiber Optic Cable"
   *
   * Add this message to the Recommended Action message set:
   *
   SET R
   E850 "Install updated driver code"

ファイル