From c4b4a65f12ac60ccdc964a866875cf3c8d42fcd5 Mon Sep 17 00:00:00 2001
From: Sergey Poznyakoff <gray@gnu.org>
Date: Mon, 22 Jul 2019 17:29:02 +0300
Subject: Verion 3.0

---
 doc/wydawca.texi | 116 +++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 82 insertions(+), 34 deletions(-)

(limited to 'doc/wydawca.texi')

diff --git a/doc/wydawca.texi b/doc/wydawca.texi
index 6f769d1..2763b6d 100644
--- a/doc/wydawca.texi
+++ b/doc/wydawca.texi
@@ -930,6 +930,11 @@ is similar to GNU m4 @option{--prefix-builtin} options, but has an
 advantage that it works with non-GNU @command{m4} implementations as
 well.
 
+@sopindex{E, described}
+  To examine the preprocessed configuration, use the @option{-E}
+option.  The output from @command{m4} will be printed on the standard
+output and the program will terminate.
+
   Additional control over the preprocessor is provided via the
 following command line options:
 
@@ -1774,6 +1779,11 @@ This statement is overridden by per-directory statements:
 in @code{archive} block (@pxref{archivation}).
 @end deffn
 
+Notice, that both @code{directory-mode} and @code{directory-owner}
+apply only to the last component of the created directory
+(@samp{basename}).  Any intermediate directories are created with
+default mode and ownership.
+
 @node archivation
 @section Archivation
 @cindex archivation, defined
@@ -2437,6 +2447,7 @@ Unless @var{file} in the @samp{module} statement it is an absolute
 file name, it will be searched in the library load path, which is
 defined as:
 
+@anchor{library search path}
 @enumerate 1
 @item
 Optional @dfn{prefix} search directories specified by the
@@ -2501,6 +2512,21 @@ configuration statements. See the module descriptions below for a
 detailed discussion of these.
 @end deffn
 
+@xopindex{module-help, introduced}
+To list module-specific configuration directives with a short usage
+instructions, use the @option{--module-help} statement:
+
+@smallexample
+wydawca --module-help=@var{file}
+@end smallexample
+
+@noindent
+If the @var{file} argument is the base module name
+(e.g. @samp{mod_mailutils}), it will be looked in the default 
+library load path (@pxref{library search path}).  If it contains
+directory components, the @var{file} will be loaded from the specified
+directory.
+
 @node event notification
 @subsection Event Notification
 
@@ -3625,25 +3651,34 @@ spool @var{tag:@i{string}} @{
 @cindex invocation
 @cindex command line options
 This chapter presents a short reference of all @command{wydawca}
-command line options, in alphabetical order.
+command line options.  The entries are sorted alphabetically by their
+long option name.  Where no long option exists, short option
+is used instead.
 
 @table @option
 @opsummary{config-file}
+@sopindex{c, summary}
 @item --config-file=@var{file}
 @itemx -c @var{file}
-Use @var{file} instead of the default configuration
-file.
+Use @var{file} instead of the default configuration file.
 
 @xref{config-file, The @option{--config-file} option}.
 
+@opsummary{config-help}
+@item --config-help
+Display a concise summary of the available configuration directives.
+This does not include statements specific for particular loadable
+modules.  To display these, use the @option{--module-help} option
+(@pxref{modules, --module-help}).
+
 @opsummary{cron}
-@opsummary{syslog}
 @item --cron
 Run in cron mode. @xref{starting,, cron}.
 
 @xref{stderr, The @option{--syslog} option}.
 
 @opsummary{debug}
+@sopindex{d, summary}
 @item --debug
 @itemx -d
 Increase debugging level by 1.
@@ -3651,8 +3686,9 @@ Increase debugging level by 1.
 @xref{debug, The @option{--debug} option}.
 
 @opsummary{define}
+@sopindex{D, summary}
 @item --define=@var{name}[=@var{value}]
-@itemx -D@var{name}[=@var{value}]
+@itemx -D @var{name}[=@var{value}]
   Define the preprocessor symbol @var{name} as having @var{value}, or
 empty. @xref{Preprocessor}.
 
@@ -3667,6 +3703,7 @@ Dump lexical analyzer traces. This is useful for debugging
 @command{wydawca} configuration file parser.
 
 @opsummary{dry-run}
+@sopindex{n, summary}
 @item --dry-run
 @itemx -n
 @dfn{Dry-run mode}: do nothing, print almost everything. This option
@@ -3674,28 +3711,11 @@ implies @option{--debug --stderr}.
 
 @xref{dry-run, The dry-run mode}.
 
-@opsummary{stderr}
-@item --stderr
-@itemx -e
-Log to the standard error.
-
-@xref{stderr, The @option{--stderr} option}.
-
-@opsummary{spool}
-@item --spool=@var{tag}
-@itemx -S @var{tag}
-Process only spool with the given tag. @xref{spool selection}.
-
-@item --source=@var{dir}
-@itemx -s @var{dir}
-Process only spool with @var{dir} as the source directory.
-@xref{spool selection}.
-  
-@opsummary{syslog}
-@item --syslog
-Log all diagnostics to syslog.
-
-@xref{stderr, The @option{--syslog} option}.
+@anchor{-E}
+@sopindex{E, summary}
+@item -E
+Dump the preprocessed configuration to stdout and exit.
+@pxref{Preprocessor}.
 
 @opsummary{force}
 @item --force
@@ -3706,7 +3726,14 @@ Force start-up, even if if the PID file already exists.
 Remain in the foreground. This is mostly for debugging
 @command{wydawca}.
 
+@opsummary{help}
+@sopindex{h, summary}
+@item --help
+@itemx -h
+Print a concise usage summary and exit.
+
 @opsummary{include-directory}
+@sopindex{I, summary}
 @item --include-directory=@var{dir}
 @itemx -I @var{dir}
 Add @var{dir} to include search path.
@@ -3714,6 +3741,7 @@ Add @var{dir} to include search path.
 @xref{Pragmatic Comments, #include}. @xref{Preprocessor}.
 
 @opsummary{lint}
+@sopindex{t, summary}
 @item --lint
 @itemx -t
 Parse configuration file, report any errors on the standard error and
@@ -3721,6 +3749,14 @@ exit with code 0, if the syntax is OK, and with code 1 otherwise.
 
 @xref{lint, The @option{--lint} option}.
 
+@opsummary{module-help}
+@item --module-help=@var{file}
+Loads module @var{file} (@pxref{modules}) and displays help about its
+configuration.  If @var{file} is an absolute or relative pathname,
+it will be loaded as is.  Otherwise, @command{wydawca} will search for
+module @var{file} in its default library load path (@pxref{library
+search path}).
+
 @opsummary{no-preprocessor}
 @item --no-preprocessor
 Disable preprocessor. @pxref{Preprocessor}.
@@ -3735,27 +3771,39 @@ Serialize job invocations by not forking subprocesses for each job.
 @emph{Do not use this option in production environment}.
 
 @opsummary{source}
+@sopindex{s, summary}
 @item --source=@var{name}
-@itemx -s@var{name} 
+@itemx -s @var{name}
 Process only the spool with the given source name. This option
 may be given multiple times, to select several spools by their
 source names.
 
 @opsummary{spool}
+@sopindex{S, summary}
 @item --spool=@var{tag}
-@itemx -S@var{tag}
+@itemx -S @var{tag}
 Process only spool with the given tag. This option
 may be given multiple times, to select several spools by their
 tag names.
 
-@opsummary{help}
-@item --help
-@itemx -h
-Print a concise usage summary and exit.
+@opsummary{stderr}
+@sopindex{e, summary}
+@item --stderr
+@itemx -e
+Log to the standard error.
+
+@xref{stderr, The @option{--stderr} option}.
+
+@opsummary{syslog}
+@item --syslog
+Log all diagnostics to syslog.
+
+@xref{stderr, The @option{--syslog} option}.
 
 @opsummary{version}
+@sopindex{V, summary}
 @item --version
-@itemx -v
+@itemx -V
 Print the program version and exit.
 @end table
 
-- 
cgit v1.2.1