errupdate 命令

用途

更新错误记录模板库。

语法

errupdate [ -c ] [ -f ] [ -h ] [ -n ] [ -p ] [ -q ] [ -yFileName ][ 文件 ]

描述

errupdate 命令在错误记录模板库中增加或者删除记录，或者修改日志、报表，或者对现存记录的特征发出警报。 errupdate 命令从指定的 File 参数中读入。 如果 File 参数没有指定的话，那么 errupdate 命令从标准输入读入并写到标准输出。

每个要增加、删除或者修改的记录必须前面有一个运算符。 有效的运算符为：

在输入文件中的记录必须由一个空行隔开。

输入文件中的注释可以放置在模板之间，并由 *(星号) 位于第一列中。

如果在错误模板中使用 X/Open 可移植性指南问题 4 消息，那么必须指定消息目录。 这可以用这样一行来完成：

<*!catalog-name>

例如

*!mycat.cat

指定的目录适用于在后续模板中找到的 XPG4 消息，直到另一个 "*!" 目录说明符。 并且，“*!” 说明符可以基于单个模板用“catname”关键字覆盖。

除非有到该目录的完整路径被指定，否则要遵守检索消息目录的一般规则。 例如，在上面的示例中，mycat.cat 假定是在 /usr/lib/nls/msg/%L 中。

要增加的记录必须以特定的格式定义。 错误记录模板的一般形式是：

Error Record Template
 
        + LABEL:
                         Comment=
                         Class=
                         Log=
                         Report=
                         Alert=
                         Err_Type=
                         Err_Desc=
                         Prob_Causes=
                         User_Causes=
                         User_Actions=
                         Inst_Causes=
                         Inst_Actions=
                         Fail_Causes=
                         Fail_Actions=
                         Detail_Data= <data_len>, <data_id>,
                         <data_encoding>

此外，可以使用以下命令指定 XPG4 消息的目录名称:

catname = <catalog>

包含 XPG4 消息， catname 关键字以及 8 个以上详细信息数据项的任何模板都将称为 XPG4 模板。 XPG4 模板不可警醒，并且对错误标识使用稍微不同的计算。

错误记录模板字段的描述如下所示：

catname 用于指定要用于检索当前模板的 XPG4 条消息的消息目录。 它会覆盖由前面的“"*!”目录标识 指定的目录。 包含 XPG4 消息的任何模板都必须具有使用 catname 或 "*!" 指定的目录。 目录名称必须用引号括起来。 除非有到该目录的完整路径被指定，否则要遵守检索消息目录的一般规则。

例如，如果

catname = "mycat.cat"

已指定，mycat.cat假定在 /usr/lib/nls/msg/ %L中。

"错误描述" ， "可能原因" ， "用户原因" ， "安装原因" ， "故障原因" ， "建议操作" 和 "详细数据标识" 消息必须是错误日志消息目录中保留的错误消息标识或 XPG4 消息。

错误消息标识包含最多四位的十六进制数，前面没有 "Ox"。 例如，1234 或 ABCD。 可使用errmsg -w命令打印这些信息及其标识符。 可以使用 错误消息 命令来添加新消息。

XPG4 消息是使用表单指定的

{<set>, <number>, <"default text">}

集合、编号和缺省文本都是需要的。 不支持符号消息引用。 此外，包含 XPG4 消息的模板也不可警报。

必须为 XPG4 条消息指定消息目录。 这通过“*!” 目录说明符或 catname 关键字完成。

错误记录不支持一般错误消息的全部功能。 在错误日志模板中使用的字符串必须符合某些限制。

• 不支持变量替换。 例如，这些字符串不可以用作格式说明符来打印值。 字符串只能包含格式字符 "\t" 和 "\n"。
• 缺省的文本字符串不可以超过 1kb，即 1024 字节。
• 必须注意的是，错误描述是在非详细报表中的 40 字符区域中打印的。 对于这些报表没有完成字符串格式化，只有头 40 个字符才会被打印出来。
• 字符串后面不应该包含一个新行。 这是由 errpt 提供的。

对每个增加进来的条目，errupdate 命令都指定了一个唯一的错误 ID，该 ID 被写入到由 File.h 指定的头文件中（这里 File 参数是 errupdate 命令的输入文件）。 如果 errupdate 命令正在从标准输入读取，那么 #define将语句写入标准输出。 为以下对象提供的值: Class, Err_Desc, Err_Type, Fail_Actions, Fail_Causes, Inst_Actions, Inst_Causes, Prob_Causes, User_Actions, User_Causes字段和 Detail_Data.data_id值，用于计算该错误的唯一 "错误标识"。 对于 XPG4 模板，标签也会包含在计算中。

以下项的内容: Log, Report和 Alert字段不包含在唯一错误标识的计算中; 因此，在使用 错误更新 命令存储在 "错误记录模板存储库" 中的错误条目定义中，可以随时修改特定错误的日志，报告和警报特征。 还要注意详细数据字段的 data_len 和 data_encode 部分没有使用到。

errupdate 命令还在名为 File.undo 的当前目录中创建了一个撤销文件。 如果 errupdate 命令是从标准输入中读入的话 undo 文件就被写入到 errids.undo 文件中。 undo 文件包含了 errupdate 命令的输入，用来撤销 errupdate 命令已经作出的改动。

errpt -t命令可用于查看错误记录模板库的内容。 该模板由于会在实际错误报表中出现，因此会被处理和打印。

注：如果您更改了错误模板，请注意这些模板可能会被后续的更新所更改。 您应该保存一个所有进行的改动的记录，当您的系统被更新的时候重新进行这些改动。 这种情况只有在进行了一些主要的系统更新如移动到一个新的操作系统级别等之后才有必要。 还有，如果您重新安装，这样一个记录会允许您更改您的模板。 保存这样的记录的最简单的方式就是让您的模板修改总是在同一个 errupdate 源文件进行。

标志

安全性

访问控制：无，但是对于要更改的模板文件（缺省情况下为 /var/adm/ras/errtmplt），您必须具有写权限。

示例

1. 要添加条目，请按以下方式在输入文件中定义该条目:

   + CDROM_ERR22:
           Comment=        “Temporary CDROM read error”
           Class=  H
           Log=            True
           Report= True
           Alert=          False
           Err_Type=       TEMP
           Err_Desc=       E801
           Prob_Causes=    5004
           Fail_Causes=    E800, 6312
           Fail_Actions=   1601, 0000
           Detail_Data=    120, 11, HEX
           Detail_Data=    4, 8058, DEC
           Detail_Data=    4, 8059, DEC

   要输入数据，

   errupdate <input file>

2. 要修改条目的日志，报告和警报特征，请执行以下操作: 99999999，指定 modify 运算符 = (等号) ，后跟唯一的错误标识，以及要修改的条目的新特征:

   errupdate
    =99999999:
    Report = False
    Log = True

3. 删除条目 99999999从 "错误记录模板存储库" 中，指定删除运算符-(减号) ，后跟要删除的条目的唯一错误标识:

   errupdate
    -99999999:

4. 要使用 "*!" 覆盖为此输入流指定的 XPG4 消息目录， 使用 "catname" 关键字。

   *!mycat.cat

   * mycat.cat用于从现在开始的所有 XPG4 消息。

   *除了这个：

   + CDROM_ERR23:
            Comment=        "Temporary CDROM read error"
            catname= "othercat.cat"
            Class=  H
            Log=            True
            Report= True
            Alert=          False
            Err_Type=       TEMP
            Err_Desc=       {1, 1, "CD ROM is broken"}
            Prob_Causes=    {2, 1, "cause 1"},\
                           {2, 2, "Cause 2"}
            Fail_Causes=    E800, 6312
            Fail_Actions=   1601, 0000
            Detail_Data=    120, 11, HEX
            Detail_Data=    4, 8058, DEC
            Detail_Data=    4, 8059, DEC

目录 othercat.cat 将会被只用作 CDROM_ERR23 模板。

注: 模板可能同时包含 XPG4 消息以及传统的错误标识或代码点。

文件