summaryrefslogtreecommitdiffstats
path: root/usr.bin/compile_et/compile_et.1
diff options
context:
space:
mode:
authorcharnier <charnier@FreeBSD.org>1997-06-30 06:42:43 +0000
committercharnier <charnier@FreeBSD.org>1997-06-30 06:42:43 +0000
commitf6e53120d810b99aa2372965b1e8abfa8bf85727 (patch)
tree04a31d1b338bb57cbe8ea42c217856fd83ebfc75 /usr.bin/compile_et/compile_et.1
parent6f0d89b1c2877708009204b20b664c31a23c2020 (diff)
downloadFreeBSD-src-f6e53120d810b99aa2372965b1e8abfa8bf85727.zip
FreeBSD-src-f6e53120d810b99aa2372965b1e8abfa8bf85727.tar.gz
Mdoc'ify man page. Use err(3). Remove whoami.
Diffstat (limited to 'usr.bin/compile_et/compile_et.1')
-rw-r--r--usr.bin/compile_et/compile_et.173
1 files changed, 36 insertions, 37 deletions
diff --git a/usr.bin/compile_et/compile_et.1 b/usr.bin/compile_et/compile_et.1
index f17a278..e5cef6a 100644
--- a/usr.bin/compile_et/compile_et.1
+++ b/usr.bin/compile_et/compile_et.1
@@ -1,79 +1,78 @@
.\" Copyright (c) 1988 Massachusetts Institute of Technology,
.\" Student Information Processing Board. All rights reserved.
.\"
-.\" $Header$
+.\" $Header: /home/ncvs/src/usr.bin/compile_et/compile_et.1,v 1.1 1995/01/14 22:29:30 wollman Exp $
.\"
-.TH COMPILE_ET 1 "22 Nov 1988" SIPB
-.SH NAME
-compile_et \- error table compiler
-.SH SYNOPSIS
-.B compile_et
-file
-.SH DESCRIPTION
-.B Compile_et
+.Dd November 22, 1988
+.Os
+.Dt COMPILE_ET 1
+.Sh NAME
+.Nm compile_et
+.Nd error table compiler
+.Sh SYNOPSIS
+.Nm compile_et
+.Ar file
+.Sh DESCRIPTION
+.Nm Compile_et
converts a table listing error-code names and associated messages into
a C source file suitable for use with the
-.IR com_err (3)
+.Xr com_err 3
library.
-
+.Pp
The source file name must end with a suffix of ``.et''; the file
consists of a declaration supplying the name (up to four characters
long) of the error-code table:
-.B error_table
-.I name
+.Em error_table name
followed by up to 256 entries of the form:
-.B error_code
-.I name,
+.Em error_code name ,
"
-.I string
+.Em string
"
and a final
-.B end
+.Em end
to indicate the end of the table.
-
+.Pp
The name of the table is used to construct the name of a subroutine
-.I initialize_XXXX_error_table
+.Em initialize_XXXX_error_table
which must be called in order for the
-.I com_err
+.Xr com_err 3
library to recognize the error table.
-
+.Pp
The various error codes defined are assigned sequentially increasing
numbers (starting with a large number computed as a hash function of
the name of the table); thus for compatibility it is suggested that
new codes be added only to the end of an existing table, and that no
codes be removed from tables.
-
+.Pp
The names defined in the table are placed into a C header file with
preprocessor directives defining them as integer constants of up to
32 bits in magnitude.
-
+.Pp
A C source file is also generated which should be compiled and linked
with the object files which reference these error codes; it contains
the text of the messages and the initialization subroutine. Both C
files have names derived from that of the original source file, with
the ``.et'' suffix replaced by ``.c'' and ``.h''.
-
+.Pp
A ``#'' in the source file is treated as a comment character, and all
remaining text to the end of the source line will be ignored.
-
-.SH BUGS
-
+.Sh BUGS
Since
-.B compile_et
+.Nm compile_et
uses a very simple parser based on
-.IR yacc (1),
+.Xr yacc 1 ,
its error recovery leaves much to be desired.
-
-.\" .IR for manual entries
-.\" .PP for paragraph breaks
-
-.SH "SEE ALSO"
-com_err (3).
-
-Ken Raeburn, "A Common Error Description Library for UNIX".
+.Sh "SEE ALSO"
+.Xr yacc 1 ,
+.Xr com_err 3
+.Pp
+.Rs
+.%A Ken Raeburn
+.%T "A Common Error Description Library for UNIX"
+.Re
OpenPOWER on IntegriCloud