doc: afs_compile_et -h option
[openafs.git] / doc / man-pages / pod1 / afs_compile_et.pod
index 6f16662..eaa1b49 100644 (file)
@@ -8,7 +8,8 @@ afs_compile_et - Produce error text tables for compilation
 <div class="synopsis">
 
 B<afs_compile_et> [B<-debug>] S<<< [B<-language> <I<lang>>] >>>
-    S<<< [B<-prefix> <I<prefix>>] >>> S<<< [B<-v> <I<version>>] >>> <I<error_table>>
+    S<<< [B<-prefix> <I<prefix>>] >>> S<<< [B<-v> <I<version>>] >>>
+    S<<< [B<-h> <I<include>>] >>> <I<error_table>>
 
 =for html
 </div>
@@ -53,8 +54,25 @@ The B<-lang> <I<lang>> option is a synonym for B<-language> <I<lang>>>.
 
 =item B<-prefix> <I<prefix>>
 
-Specifies the directory to search for the F<error_table.et> file.
-The B<-p> <I<prefix>> option is a synonym for B<-prefix> <I<prefix>>.
+Specifies the directory to search for the F<error_table.et> file. Specifies
+the directory to search for the prolog file when the B<-h> option is
+given.  The B<-p> <I<prefix>> option is a synonym for B<-prefix> <I<prefix>>.
+
+=item B<-h> <I<include>>
+
+Specifies an input file, called a prolog file, and modifies the name of the
+header file generated by B<afs_compile_et>.
+
+When the B<-h> option is given, B<afs_compile_et> will search for a prolog file
+named <I<include>>F<.p.h>.  B<afs_compile_et> will search the current working
+directory for the prolog file, unless the B<-p> option is given.  If the prolog
+file is found, B<afs_compile_et> will place a verbatim copy of the prolog
+file contents into the generated header file.
+
+When the B<-h> option is given, the name of the header file generated by
+B<afs_compile_et> is <I<include>>F<.h>, instead of <I<error_table>>F<.h>.
+
+The B<-h> option does not affect the source file generated by B<afs_compile_et>.
 
 =item B<-v> <I<version>>