diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/pies.texi | 110 |
1 files changed, 70 insertions, 40 deletions
diff --git a/doc/pies.texi b/doc/pies.texi index 93a329e..0bc3bee 100644 --- a/doc/pies.texi +++ b/doc/pies.texi @@ -29,8 +29,10 @@ @include macros.texi @ifinfo -@dircategory GNU Utilities -@direntry (pies) pies. Program execution supervisor. +@dircategory System Administration +@direntry +* Pies: (pies). Program Invocation and Execution Supervisor. +* pies: (pies) Invocation. Pies Command Line Options. @end direntry @end ifinfo @@ -81,7 +83,7 @@ documents @command{pies} Version @value{VERSION}. * Pies Debugging:: * Configuration Example:: * Command Line Usage:: -* Pies Invocation:: +* Invocation:: * Reporting Bugs:: Appendices @@ -507,6 +509,24 @@ is similar to GNU m4 @option{--prefix-builtin} options, but has an advantage that it works with non-GNU @command{m4} implementations as well. +Additional preprocessor symbols may be defined and the existing +symbols may be undefined using the following command line options: + +@table @option +@xopindex{define, described} +@cindex @option{-D} +@item --define=@var{sym}[=@var{value}] +@itemx -D @var{symbol}[=@var{value}] +Define symbol @var{sym} as having @var{value}, or emtpy, if +the @var{value} is not given. + +@xopindex{undefine, described} +@cindex @option{-U} +@item --undefine=@var{sym} +@itemx -U @var{sym} +Undefine symbol @var{sym}. +@end table + @node Component Statement @section Component Statement @kwindex component @@ -1802,16 +1822,12 @@ smtpc: qmgr smtps: smar qmgr @end smallexample -@node Pies Invocation +@node Invocation @chapter Pies Invocation This section summarizes @command{pies} command line options. @table @option -@opsummary{config-help} -@item --config-help -Show configuration file summary. @xref{Pies Configuration File}. - @opsummary{config-file} @item --config-file=@var{file} @item -c @var{file} @@ -1820,6 +1836,30 @@ Read configuration from @var{file}, instead of the default @xref{Pies Configuration File}. +@opsummary{config-help} +@item --config-help +Show configuration file summary. @xref{Pies Configuration File}. + +@opsummary{define} +@item --define=@var{sym}[=@var{value}] +@itemx -D @var{symbol}[=@var{value}] +Define symbol @var{sym} as having @var{value}, or emtpy, if +the @var{value} is not given. @xref{Preprocessor}. + +@opsummary{debug} +@item --debug=@var{level} +@itemx -x @var{level} +Set debug verbosity level. @xref{Pies Debugging}, for a description +of @var{level}. + +@opsummary{dump-depmap} +@item --dump-depmap +Dump dependency map. @xref{dump-depmap}. + +@opsummary{dump-prereq} +@item --dump-prereq +Dump prerequisite charts. @xref{dump-prereq}. + @item -E Preprocess configuration file and exit. @xref{Preprocessor}. @@ -1831,28 +1871,35 @@ Force startup even if another instance may be running. @item --foreground Remain in foreground. -@opsummary{source-info} -@item --source-info -Show source info with debugging messages. @xref{source-info}. +@item --help +Display a short usage summary and exit. @opsummary{lint} @item --lint @itemx -t +@opsummary{source-info} +@item --source-info +Show source info with debugging messages. @xref{source-info}. + +@opsummary{status} +@item --status +@itemx -s +Display info about the running instance. @xref{pies-status}. + @opsummary{stderr} @item --stderr Log to standard error. +@opsummary{stop} +@item --stop +@itemx -S +Stop the running instance. + @opsummary{syslog} @item --syslog Log to syslog. This is the default. -@opsummary{debug} -@item -x @var{level} -@itemx --debug=@var{level} -Set debug verbosity level. @xref{Pies Debugging}, for a description -of @var{level}. - @opsummary{reload} @opsummary{hup} @item -r @@ -1865,33 +1912,16 @@ Reload the running instance of pies. @itemx --restart-component Restart components named in the command line. @xref{pies-restart}. -@opsummary{status} -@item -s -@itemx --status -Display info about the running instance. @xref{pies-status}. - -@opsummary{stop} -@item -S -@itemx --stop -Stop the running instance. - -@opsummary{dump-depmap} -@item --dump-depmap -Dump dependency map. @xref{dump-depmap}. - -@opsummary{dump-prereq} -@item --dump-prereq -Dump prerequisite charts. @xref{dump-prereq}. +@item --version +Display program version and license information and exit. -@item --help -Display a short usage summary and exit. +@xopindex{undefine} +@item --undefine=@var{sym} +@itemx -U @var{sym} +Undefine symbol @var{sym}. @xref{Preprocessor}. @item --usage Display a short summary of available options and exit. - -@item --version -Display program version and license information and exit. - @end table @node Reporting Bugs |