.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "AFS_COMPILE_ET 1" .TH AFS_COMPILE_ET 1 "2021-01-14" "OpenAFS" "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" afs_compile_et \- Produce error text tables for compilation .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBafs_compile_et\fR [\fB\-debug\fR] [\fB\-language\fR\ <\fIlang\fR>] [\fB\-prefix\fR\ <\fIprefix\fR>] [\fB\-v\fR\ <\fIversion\fR>] [\fB\-h\fR\ <\fIinclude\fR>] <[\fB\-emit\fR\ <\fIoutput\fR>] \fIerror_table\fR> .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBafs_compile_et\fR command builds the error text tables for compilation. This includes both a header file that contains a set of mappings between error names and values and a \fI.c\fR (or \fI.msf\fR) file that provides a text table of descriptions. .PP The <\fIerror_table\fR> argument specifies which error table to generate. The error table specification should exist in the current working directory or in the directory specified with \fB\-prefix\fR and should be named \fIerror_table.et\fR. .PP By default, \fBafs_compile_et\fR generates two files in one invocation. This is problematic for parallel build systems. The \fB\-emit\fR option may be used to generate the output files independently with two separate invocations of \&\fBafs_compile_et\fR for a given error table. This allows parallel build systems to generate the source and header files, and the targets which depend on the generated source and headers files, in parallel. .SH "CAUTIONS" .IX Header "CAUTIONS" This command is used internally within the build process for OpenAFS. Most users will access this information via \fBtranslate_et\fR\|(1) rather than via \fBafs_compile_et\fR. .PP This command does not use the standard \s-1AFS\s0 command-line parsing package. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-debug\fR" 4 .IX Item "-debug" Does nothing. It neither adds debugging information to the output nor provides additional information on its operation. .IP "\fB\-language\fR <\fIlang\fR>" 4 .IX Item "-language " Specifies the type of output to generate. Currently, only \s-1ANSI C\s0 and K&R are supported values (via the \fBc\fR and \fBk&r\-c\fR values, respectively). The default is \s-1ANSI C.\s0 There is some support for \*(C+ started, but that is not yet supported. .Sp The \fB\-lang\fR <\fIlang\fR> option is a synonym for \fB\-language\fR <\fIlang\fR>>. .IP "\fB\-prefix\fR <\fIprefix\fR>" 4 .IX Item "-prefix " Specifies the directory to search for the \fIerror_table.et\fR file. Specifies the directory to search for the prolog file when the \fB\-h\fR option is given. The \fB\-p\fR <\fIprefix\fR> option is a synonym for \fB\-prefix\fR <\fIprefix\fR>. .IP "\fB\-h\fR <\fIinclude\fR>" 4 .IX Item "-h " Specifies an input file, called a prolog file, and modifies the name of the header file generated by \fBafs_compile_et\fR. .Sp When the \fB\-h\fR option is given, \fBafs_compile_et\fR will search for a prolog file named <\fIinclude\fR>\fI.p.h\fR. \fBafs_compile_et\fR will search the current working directory for the prolog file, unless the \fB\-p\fR option is given. If the prolog file is found, \fBafs_compile_et\fR will place a verbatim copy of the prolog file contents into the generated header file. .Sp When the \fB\-h\fR option is given, the name of the header file generated by \&\fBafs_compile_et\fR is <\fIinclude\fR>\fI.h\fR, instead of <\fIerror_table\fR>\fI.h\fR. .Sp The \fB\-h\fR option does not affect the source file generated by \fBafs_compile_et\fR. .IP "\fB\-v\fR <\fIversion\fR>" 4 .IX Item "-v " Specified the type of output file: valid values are 1 (the default, for C files) or 2, for \fB.msf\fR file generation. .IP "\fB\-emit\fR <\fIoutput\fR>" 4 .IX Item "-emit " Specifies which program file to generate; the header file or the source file. Specify \fB\-emit header\fR (or \fB\-emit h\fR) to generate the \fI.h\fR header file. Specify \fB\-emit source\fR (or \fB\-emit c\fR) to generate the \fI.c\fR (or \fI.msf\fR) source file. .SH "EXAMPLES" .IX Header "EXAMPLES" The following command generates the files \fIpterror.h\fR and \fIpterror.c\fR, suitable for use with C programs: .PP .Vb 1 \& % afs_compile_et \-p path/to/src/ptserver pterror .Ve .PP The following command generates K&R style files instead: .PP .Vb 1 \& % afs_compile_et \-p path/to/src/ptserver \-lang \*(Aqk&r\-c\*(Aq pterror .Ve .PP The following command generates the \fIpterror.h\fR file, but not the \fIpterror.c\fR file. .PP .Vb 1 \& % afs_compile_et \-p path/to/src/ptserver \-emit header pterror .Ve .PP The following command generates the \fIpterror.c\fR file, but not the \fIpterror.h\fR file. .PP .Vb 1 \& % afs_compile_et \-p path/to/src/ptserver \-emit source pterror .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBtranslate_et\fR\|(1) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2009 Steven Jenkins .PP This documentation is covered by the \s-1IBM\s0 Public License Version 1.0. This man page was written by Steven Jenkins for OpenAFS.