aboutsummaryrefslogtreecommitdiff
path: root/doc/wydawca.texi
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2009-12-08 22:31:29 +0200
committerSergey Poznyakoff <gray@gnu.org.ua>2009-12-08 22:31:29 +0200
commitaecebd653ebb3751d2680a80bd49bcd1ed00ba62 (patch)
treea0716830898dc0e76863f6b2271f69288537e57a /doc/wydawca.texi
parent67ca2ef061a73bc90e4399471ee0cb3ce6f0ee41 (diff)
downloadwydawca-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.texi38
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
@@ -771,7 +771,7 @@ syslog @{
771@} 771@}
772@end smallexample 772@end smallexample
773 773
774@deffn {Configuration} facility @var{name} 774@deffn {Config: syslog} facility @var{name}
775@kwindex authpriv@r{, syslog facility} 775@kwindex authpriv@r{, syslog facility}
776@kwindex cron@r{, syslog facility} 776@kwindex cron@r{, syslog facility}
777@kwindex daemon@r{, syslog facility} 777@kwindex daemon@r{, syslog facility}
@@ -785,14 +785,14 @@ case-insensitive and may be optionally prefixed with @samp{log_}
785(case-insensitive as well). 785(case-insensitive as well).
786@end deffn 786@end deffn
787 787
788@deffn {Configuration} tag @var{string} 788@deffn {Config: syslog} tag @var{string}
789@cindex syslog tag, configuring 789@cindex syslog tag, configuring
790 This statement sets the @dfn{syslog tag}, a string 790 This statement sets the @dfn{syslog tag}, a string
791identifying each message issued by the program. By default, the 791identifying each message issued by the program. By default, the
792name of the program (@samp{wydawca}) is used. 792name of the program (@samp{wydawca}) is used.
793@end deffn 793@end deffn
794 794
795@deffn {Configuration} print-priority @var{bool} 795@deffn {Config: syslog} print-priority @var{bool}
796@cindex syslog priority, printing in diagnostics 796@cindex syslog priority, printing in diagnostics
797 In addition to priority segregation, provided by @command{syslog}, 797 In addition to priority segregation, provided by @command{syslog},
798you can instruct @command{wydawca} to prefix each syslog message with 798you can instruct @command{wydawca} to prefix each syslog message with
@@ -836,7 +836,7 @@ database. It is used by another configuration statements (e.g. by
836access methods, see the next section) to refer to this 836access methods, see the next section) to refer to this
837database. 837database.
838 838
839@deffn {Configuration} host @var{hostname}[:@var{port-or-socket}] 839@deffn {Config: sql} host @var{hostname}[:@var{port-or-socket}]
840 Set the hostname or @acronym{IP} address of the host running the 840 Set the hostname or @acronym{IP} address of the host running the
841database. Optional @var{port-or-socket} specifies port number (for 841database. Optional @var{port-or-socket} specifies port number (for
842@acronym{TCP} connections) or socket name (for @acronym{UNIX} sockets) 842@acronym{TCP} connections) or socket name (for @acronym{UNIX} sockets)
@@ -845,15 +845,15 @@ omitted. If, however, it is present, it must be @samp{localhost}.
845@FIXME-xref{sql-host}, for more information and examples. 845@FIXME-xref{sql-host}, for more information and examples.
846@end deffn 846@end deffn
847 847
848@deffn {Configuration} database @var{name} 848@deffn {Config: sql} database @var{name}
849Specifies the database name. 849Specifies the database name.
850@end deffn 850@end deffn
851 851
852@deffn {Configuration} user @var{name} 852@deffn {Config: sql} user @var{name}
853Sets the database user name. 853Sets the database user name.
854@end deffn 854@end deffn
855 855
856@deffn {Configuration} password @var{string} 856@deffn {Config: sql} password @var{string}
857Sets the password for accessing the database. 857Sets the password for accessing the database.
858@end deffn 858@end deffn
859 859
@@ -928,7 +928,7 @@ make uploads.
928 928
929The sub-statements of @code{access-method} are: 929The sub-statements of @code{access-method} are:
930 930
931@deffn {Configuration} type @var{name} 931@deffn {Config: access-method} type @var{name}
932Defines the type of this method. @var{Name} is one of the following: 932Defines the type of this method. @var{Name} is one of the following:
933 933
934@table @asis 934@table @asis
@@ -950,7 +950,7 @@ future use.
950See below for a detailed description of these access methods. 950See below for a detailed description of these access methods.
951@end deffn 951@end deffn
952 952
953@deffn {Configuration} query @var{string} 953@deffn {Config: access-method} query @var{string}
954Sets the query used for retrieving the data. The @var{string} is 954Sets the query used for retrieving the data. The @var{string} is
955subject to meta-variable interpretation (@pxref{meta-interpretation}). The 955subject to meta-variable interpretation (@pxref{meta-interpretation}). The
956following meta-variables are defined: 956following meta-variables are defined:
@@ -992,7 +992,7 @@ Spool source directory (@pxref{spool, source}).
992@end table 992@end table
993@end deffn 993@end deffn
994 994
995@deffn {Configuration} params (@var{param1}, @var{param2}, ...) 995@deffn {Config: access-method} params (@var{param1}, @var{param2}, ...)
996Supplies additional parameters for the method. 996Supplies additional parameters for the method.
997@end deffn 997@end deffn
998 998
@@ -1152,7 +1152,7 @@ archive @var{type} @{
1152 Store file in a separate directory. 1152 Store file in a separate directory.
1153@end table 1153@end table
1154 1154
1155@deffn {Configuration} name @var{file-or-dir} 1155@deffn {Config: archive} name @var{file-or-dir}
1156 Specify the name of the tar archive (if type @samp{tar} is used) or 1156 Specify the name of the tar archive (if type @samp{tar} is used) or
1157destination directory (if type @samp{directroy} is used). 1157destination directory (if type @samp{directroy} is used).
1158@end deffn 1158@end deffn
@@ -1212,7 +1212,7 @@ directory @file{/home/@/ftp/@/gnu/@/tar/@/.archive}, files from
1212@file{/home/@/ftp/@/gnu/@/tar/@/old} --- in 1212@file{/home/@/ftp/@/gnu/@/tar/@/old} --- in
1213@file{/home/@/ftp/@/gnu/@/tar/@/.archive/@/old}, etc. 1213@file{/home/@/ftp/@/gnu/@/tar/@/.archive/@/old}, etc.
1214 1214
1215@deffn {Configuration} backup @var{type} 1215@deffn {Config: archive} backup @var{type}
1216@anchor{backup-methods} 1216@anchor{backup-methods}
1217@vindex version-control @r{Emacs variable} 1217@vindex version-control @r{Emacs variable}
1218 When using the @samp{directory} archivation type, it may happen that the 1218 When using the @samp{directory} archivation type, it may happen that the
@@ -1303,16 +1303,16 @@ The @var{tag} argument defines a unique identifier for this spool. It
1303will be used in log messages, timers (@FIXME-pxref{timers}) and in 1303will be used in log messages, timers (@FIXME-pxref{timers}) and in
1304meta-variable interpretation (@pxref{meta-interpretation}). 1304meta-variable interpretation (@pxref{meta-interpretation}).
1305 1305
1306@deffn {Configuration} url @var{string} 1306@deffn {Config: spool} url @var{string}
1307Defines download @acronym{URL}, associated with this spool. Its value 1307Defines download @acronym{URL}, associated with this spool. Its value
1308may be used as @samp{$@{url@}} meta-variable in mail notifications. 1308may be used as @samp{$@{url@}} meta-variable in mail notifications.
1309@end deffn 1309@end deffn
1310 1310
1311@deffn {Configuration} source @var{dir} 1311@deffn {Config: spool} source @var{dir}
1312Specifies the location of the source directory. 1312Specifies the location of the source directory.
1313@end deffn 1313@end deffn
1314 1314
1315@deffn {Configuration} destination @var{dir} 1315@deffn {Config: spool} destination @var{dir}
1316Specifies the type and location of the destination directory. The 1316Specifies the type and location of the destination directory. The
1317@var{dir} argument must be either an absolute name of a directory on 1317@var{dir} argument must be either an absolute name of a directory on
1318the local file system, or a special @acronym{URL}. @command{Wydawca} 1318the local file system, or a special @acronym{URL}. @command{Wydawca}
@@ -1724,7 +1724,7 @@ mail-statistics @{
1724@} 1724@}
1725@end smallexample 1725@end smallexample
1726 1726
1727@deffn {Configuration} message @var{text-or-id} 1727@deffn {Config: mail-statistics} message @var{text-or-id}
1728Define the message text. The argument is either the message text 1728Define the message text. The argument is either the message text
1729template, or a reference to a template previously defined by a 1729template, or a reference to a template previously defined by a
1730@code{define-message} (@pxref{templates}). The reference syntax is: 1730@code{define-message} (@pxref{templates}). The reference syntax is:
@@ -1737,7 +1737,7 @@ message @@@var{name};
1737where @var{name} is the message name as used in @code{define-message}. 1737where @var{name} is the message name as used in @code{define-message}.
1738@end deffn 1738@end deffn
1739 1739
1740@deffn {Configuration} statistics @var{item-list} 1740@deffn {Config: mail-statistics} statistics @var{item-list}
1741The argument is a list of statistics keywords as described in 1741The argument is a list of statistics keywords as described in
1742@ref{statistics}. A report will be sent only if statistics 1742@ref{statistics}. A report will be sent only if statistics
1743counters for at least one of the requested categories are not 1743counters for at least one of the requested categories are not
@@ -1834,7 +1834,7 @@ notify-event @{
1834@} 1834@}
1835@end smallexample 1835@end smallexample
1836 1836
1837@deffn {Configuration} event @var{ev-id} 1837@deffn {Config: notify-event} event @var{ev-id}
1838Send notification when the event @var{ev-id} occurs. The following 1838Send notification when the event @var{ev-id} occurs. The following
1839table describes the available @var{ev-id}s: 1839table describes the available @var{ev-id}s:
1840 1840
@@ -1859,7 +1859,7 @@ uploader.
1859@end table 1859@end table
1860@end deffn 1860@end deffn
1861 1861
1862@deffn {Configuration} recipient @var{who} 1862@deffn {Config: notify-event} recipient @var{who}
1863Determines who should receive the notification. The following values 1863Determines who should receive the notification. The following values
1864for @var{who} are allowed: 1864for @var{who} are allowed:
1865 1865

Return to:

Send suggestions and report system problems to the System administrator.