Refactor OpenBSD param files into common and architecture-specific
[openafs.git] / doc / man-pages / pod1 / compile_et.pod
1 =head1 NAME
2
3 compile_et - Produce error text tables for compilation
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<compile_et> [B<-debug>] S<<< [B<-language> <I<lang>>] >>>
11     S<<< [B<-prefix> <I<prefix>>] >>> [B<-v> <I<version>>] <I<error_table>>
12
13 =for html
14 </div>
15
16 =head1 DESCRIPTION
17
18 The B<compile_et> command builds the error text tables for compilation.
19 This includes both a header file that contains a set of mappings between
20 error names and values and a F<.c> (or F<.msf>) file that provides a text
21 table of descriptions.
22
23 The <I<error_table>> argument specifies which error table to generate.
24 The error table specification should exist in the current working
25 directory or in the directory specified with B<-prefix> and should be
26 named F<error_table.et>.
27
28 =head1 CAUTIONS
29
30 This command is used internally within the build process for OpenAFS.
31 Most users will access this information via L<translate_et(1)> rather than
32 via B<compile_et>.
33
34 This command does not use the standard AFS command-line parsing package.
35
36 =head1 OPTIONS
37
38 =over 4
39
40 =item B<-debug>
41
42 Does nothing.  It neither adds debugging information to the output nor
43 provides additional information on its operation.
44
45 =item B<-language> <I<lang>>
46
47 Specifies the type of output to generate.  Currently, only ANSI C and K&R
48 are supported values (via the B<c> and B<k&r-c> values, respectively).
49 The default is ANSI C.  There is some support for C++ started, but that is
50 not yet supported.
51
52 =item B<-prefix <I<prefix>>
53
54 Specifies the directory to search for the F<error_table.et> file.
55
56 =item B<-v> <I<version>>
57
58 Specified the type of output file: valid values are 1 (the default, for C
59 files) or 2, for B<.msf> file generation.
60
61 =back
62
63 =head1 EXAMPLES
64
65 The following command generates the files F<pterror.h> and F<pterror.c>, 
66 suitable for use with C programs:
67
68    % compile_et -p path/to/src/ptserver pterror
69
70 The following command generates K&R style files instead:
71
72    % compile_et -p path/to/src/ptserver -lang 'k&r-c' pterror
73
74 =head1 SEE ALSO
75
76 L<translate_et(1)>
77
78 =head1 COPYRIGHT
79
80 Copyright 2009 Steven Jenkins <steven@endpoint.com>
81
82 This documentation is covered by the IBM Public License Version 1.0.  This
83 man page was written by Steven Jenkins for OpenAFS.