Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man1/compile_et.1 @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
1 .\" Copyright (c) 1988 Massachusetts Institute of Technology,
2 .\" Student Information Processing Board. All rights reserved.
3 .\"
4 .\" util/et/compile_et.1
5 .\"
6 .TH COMPILE_ET 1 "22 Nov 1988" SIPB
7 .SH NAME
8 compile_et \- error table compiler
9 .SH SYNOPSIS
10 .B compile_et
11 [
12 .B \-\-textdomain
13 .I domain
14 [
15 .B \-\-localedir
16 .I dir
17 ] ]
18 file
19 .SH DESCRIPTION
20 .B Compile_et
21 converts a table listing error-code names and associated messages into
22 a C source file suitable for use with the
23 .IR com_err (3)
24 library.
25
26 The source file name must end with a suffix of ``.et''; the file
27 consists of a declaration supplying the name (up to four characters
28 long) of the error-code table:
29
30 .B error_table
31 .I name
32
33 followed by up to 256 entries of the form:
34
35 .B error_code
36 .I name,
37 "
38 .I string
39 "
40
41 and a final
42
43 .B end
44
45 to indicate the end of the table.
46
47 The name of the table is used to construct the name of a subroutine
48 .I initialize_XXXX_error_table
49 which must be called in order for the
50 .I com_err
51 library to recognize the error table.
52
53 The various error codes defined are assigned sequentially increasing
54 numbers (starting with a large number computed as a hash function of
55 the name of the table); thus for compatibility it is suggested that
56 new codes be added only to the end of an existing table, and that no
57 codes be removed from tables.
58
59 The names defined in the table are placed into a C header file with
60 preprocessor directives defining them as integer constants of up to
61 32 bits in magnitude.
62
63 A C source file is also generated which should be compiled and linked
64 with the object files which reference these error codes; it contains
65 the text of the messages and the initialization subroutine. Both C
66 files have names derived from that of the original source file, with
67 the ``.et'' suffix replaced by ``.c'' and ``.h''.
68
69 A ``#'' in the source file is treated as a comment character, and all
70 remaining text to the end of the source line will be ignored.
71
72 If a text domain is provided with the
73 .B \-\-textdomain
74 option, error messages will be looked up in the specified domain with
75 .BR gettext .
76 If a locale directory is also provided with the
77 .B \-\-localedir
78 option, the text domain will be bound to the specified locale
79 directory with
80 .B bindtextdomain
81 when the error table is initialized.
82
83 .SH BUGS
84
85 Since
86 .B compile_et
87 uses a very simple parser based on
88 .IR yacc (1),
89 its error recovery leaves much to be desired.
90
91 .\" .IR for manual entries
92 .\" .PP for paragraph breaks
93
94 .SH "SEE ALSO"
95 com_err (3).
96
97 Ken Raeburn, "A Common Error Description Library for UNIX".