diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-12-08 22:31:29 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-12-08 22:31:29 +0200 |
commit | aecebd653ebb3751d2680a80bd49bcd1ed00ba62 (patch) | |
tree | a0716830898dc0e76863f6b2271f69288537e57a /doc/wydawca.texi | |
parent | 67ca2ef061a73bc90e4399471ee0cb3ce6f0ee41 (diff) | |
download | wydawca-aecebd653ebb3751d2680a80bd49bcd1ed00ba62.tar.gz wydawca-aecebd653ebb3751d2680a80bd49bcd1ed00ba62.tar.bz2 |
Minor changes.
* doc/Makefile.am (check-config)
(check-sub-config): New rules.
(all-check-docs): Depend on check-config
and check-sub-config.
* doc/wydawca.texi: Fix configuration statement
markers for use with check-config and check-sub-config
rules.
Diffstat (limited to 'doc/wydawca.texi')
-rw-r--r-- | doc/wydawca.texi | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi index c5eb691..82b8403 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi @@ -768,13 +768,13 @@ syslog @{ facility local1; tag wydawca; print-priority yes; @} @end smallexample -@deffn {Configuration} facility @var{name} +@deffn {Config: syslog} facility @var{name} @kwindex authpriv@r{, syslog facility} @kwindex cron@r{, syslog facility} @kwindex daemon@r{, syslog facility} @kwindex ftp@r{, syslog facility} @kwindex local0 @r{through} local7@r{, syslog facilities} @kwindex mail@r{, syslog facility} @@ -782,20 +782,20 @@ syslog @{ @samp{auth}, @samp{authpriv}, @samp{cron}, @samp{daemon}, @samp{ftp}, @samp{local0} through @samp{local7}, and @samp{mail}. These names are case-insensitive and may be optionally prefixed with @samp{log_} (case-insensitive as well). @end deffn -@deffn {Configuration} tag @var{string} +@deffn {Config: syslog} tag @var{string} @cindex syslog tag, configuring This statement sets the @dfn{syslog tag}, a string identifying each message issued by the program. By default, the name of the program (@samp{wydawca}) is used. @end deffn -@deffn {Configuration} print-priority @var{bool} +@deffn {Config: syslog} print-priority @var{bool} @cindex syslog priority, printing in diagnostics In addition to priority segregation, provided by @command{syslog}, you can instruct @command{wydawca} to prefix each syslog message with its priority. To do so, set: @smallexample @@ -833,30 +833,30 @@ sql @var{id} @{ Here, @var{id} is a string uniquely identifying this database. It is used by another configuration statements (e.g. by access methods, see the next section) to refer to this database. -@deffn {Configuration} host @var{hostname}[:@var{port-or-socket}] +@deffn {Config: sql} host @var{hostname}[:@var{port-or-socket}] Set the hostname or @acronym{IP} address of the host running the database. Optional @var{port-or-socket} specifies port number (for @acronym{TCP} connections) or socket name (for @acronym{UNIX} sockets) to use. In the latter case, the @var{hostname} and the colon may be omitted. If, however, it is present, it must be @samp{localhost}. @FIXME-xref{sql-host}, for more information and examples. @end deffn -@deffn {Configuration} database @var{name} +@deffn {Config: sql} database @var{name} Specifies the database name. @end deffn -@deffn {Configuration} user @var{name} +@deffn {Config: sql} user @var{name} Sets the database user name. @end deffn -@deffn {Configuration} password @var{string} +@deffn {Config: sql} password @var{string} Sets the password for accessing the database. @end deffn @noindent An example @code{sql} statement follows: @@ -925,13 +925,13 @@ name, in this order. method must return the system name of the user if he is allowed to make uploads. @end table The sub-statements of @code{access-method} are: -@deffn {Configuration} type @var{name} +@deffn {Config: access-method} type @var{name} Defines the type of this method. @var{Name} is one of the following: @table @asis @kwindex builtin @item builtin The data are supplied in the configuration file. @@ -947,13 +947,13 @@ Defines the type of this method. @var{Name} is one of the following: future use. @end table See below for a detailed description of these access methods. @end deffn -@deffn {Configuration} query @var{string} +@deffn {Config: access-method} query @var{string} Sets the query used for retrieving the data. The @var{string} is subject to meta-variable interpretation (@pxref{meta-interpretation}). The following meta-variables are defined: @table @code @kwindex u @@ -989,13 +989,13 @@ Spool destination directory (@pxref{spool, destination}). @item source-dir Spool source directory (@pxref{spool, source}). @end table @end deffn -@deffn {Configuration} params (@var{param1}, @var{param2}, ...) +@deffn {Config: access-method} params (@var{param1}, @var{param2}, ...) Supplies additional parameters for the method. @end deffn @menu * sql type:: * builtin type:: @@ -1149,13 +1149,13 @@ archive @var{type} @{ @kwindex directory@r{, archivation} @item directory Store file in a separate directory. @end table -@deffn {Configuration} name @var{file-or-dir} +@deffn {Config: archive} name @var{file-or-dir} Specify the name of the tar archive (if type @samp{tar} is used) or destination directory (if type @samp{directroy} is used). @end deffn If the archivation type @asis{tar} is used, the @code{name} statement sets the full name of the tar archive to use, e.g.: @@ -1209,13 +1209,13 @@ archive directory @{ @noindent mean that files from @file{/home/@/ftp/@/gnu/@/tar} will be archived in the directory @file{/home/@/ftp/@/gnu/@/tar/@/.archive}, files from @file{/home/@/ftp/@/gnu/@/tar/@/old} --- in @file{/home/@/ftp/@/gnu/@/tar/@/.archive/@/old}, etc. -@deffn {Configuration} backup @var{type} +@deffn {Config: archive} backup @var{type} @anchor{backup-methods} @vindex version-control @r{Emacs variable} When using the @samp{directory} archivation type, it may happen that the archive file with the same name as the one about to be created already exists. This statement specifies how to handle the existing copy, in other words, how to @dfn{backup} it. The @var{type} argument @@ -1300,22 +1300,22 @@ spool @var{tag} @{ @end smallexample The @var{tag} argument defines a unique identifier for this spool. It will be used in log messages, timers (@FIXME-pxref{timers}) and in meta-variable interpretation (@pxref{meta-interpretation}). -@deffn {Configuration} url @var{string} +@deffn {Config: spool} url @var{string} Defines download @acronym{URL}, associated with this spool. Its value may be used as @samp{$@{url@}} meta-variable in mail notifications. @end deffn -@deffn {Configuration} source @var{dir} +@deffn {Config: spool} source @var{dir} Specifies the location of the source directory. @end deffn -@deffn {Configuration} destination @var{dir} +@deffn {Config: spool} destination @var{dir} Specifies the type and location of the destination directory. The @var{dir} argument must be either an absolute name of a directory on the local file system, or a special @acronym{URL}. @command{Wydawca} version @value{VERSION} supports two destination @acronym{URL} schemes: @@ -1721,26 +1721,26 @@ Sending statistic reports to the system administrator is configured by mail-statistics @{ message @var{text-or-id}; statistics @var{item-list}; @} @end smallexample -@deffn {Configuration} message @var{text-or-id} +@deffn {Config: mail-statistics} message @var{text-or-id} Define the message text. The argument is either the message text template, or a reference to a template previously defined by a @code{define-message} (@pxref{templates}). The reference syntax is: @smallexample message @@@var{name}; @end smallexample @noindent where @var{name} is the message name as used in @code{define-message}. @end deffn -@deffn {Configuration} statistics @var{item-list} +@deffn {Config: mail-statistics} statistics @var{item-list} The argument is a list of statistics keywords as described in @ref{statistics}. A report will be sent only if statistics counters for at least one of the requested categories are not zero. For example, the following statement requires sending notifications only if there occurred any errors or access violation attempts, or any bad signature was uploaded: @@ -1831,13 +1831,13 @@ notify-event @{ event @var{ev-id}; recipient @var{who}; message @var{text-or-id}; @} @end smallexample -@deffn {Configuration} event @var{ev-id} +@deffn {Config: notify-event} event @var{ev-id} Send notification when the event @var{ev-id} occurs. The following table describes the available @var{ev-id}s: @table @asis @kwindex success @item success @@ -1856,13 +1856,13 @@ uploader. @item bad-detached-signature The detached signature does not match the public key of the uploader. @end table @end deffn -@deffn {Configuration} recipient @var{who} +@deffn {Config: notify-event} recipient @var{who} Determines who should receive the notification. The following values for @var{who} are allowed: @table @code @kwindex admin @item admin |