summaryrefslogtreecommitdiffabout
path: root/doc/wydawca.texi
authorSergey Poznyakoff <gray@gnu.org.ua>2009-02-16 14:17:03 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2009-02-16 14:23:53 (GMT)
commit6cfe6f8fe1b7506e772403fecc9d7298fc52dc74 (patch) (side-by-side diff)
tree64e579d8895bfecfadceb9914f9f795d75e4ccbb /doc/wydawca.texi
parent98ca4bb1bc96cc95bdd141cb653b17029957de38 (diff)
downloadwydawca-6cfe6f8fe1b7506e772403fecc9d7298fc52dc74.tar.gz
wydawca-6cfe6f8fe1b7506e772403fecc9d7298fc52dc74.tar.bz2
Improve keyword (meta) expansion, add testsuite framework
* src/meta.c: New file. * src/Makefile.am (wydawca_SOURCES): Add meta.c. * Makefile.am (SUBDIRS): Add tests. * configure.ac: Initialize testsuite. * src/cmdline.opt: Add preprocessor-related options: --[no-]preprocessor, -E * src/mail.c, src/triplet.c, src/verify.c, src/wydawca.c, src/wydawca.h: Use new expansion functions. * src/update-2.0.awk: Replace % markup with $. * etc/wydawca.rc: Switch to new meta-variable syntax. * gnulib.modules: Add c-ctype. * doc/Makefile.am (check-options): Rewrite. * doc/wydawca.texi: Mark unrevised/obsolete material. * tests/: New directory
Diffstat (limited to 'doc/wydawca.texi') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/wydawca.texi46
1 files changed, 31 insertions, 15 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi
index e54cc8e..3f5a682 100644
--- a/doc/wydawca.texi
+++ b/doc/wydawca.texi
@@ -337,6 +337,7 @@ $ wydawca -c new.cfg --dry-run
@node configuring, wydawca.rc, starting, Top
@chapter How to Configure @command{wydawca}.
+@UNREVISED
The @command{wydawca} configuration file has a simple line-oriented
syntax. Empty lines are ignored. Comments are introduced by a pound
sign (@samp{#}): everything starting from the first occurrence of
@@ -398,7 +399,8 @@ configuration on a step-by-step basis.
@section Include Statement
@cindex inclusion, configuration file
@kwindex include
- You can request inclusion of any file into your configuration file
+@UNREVISED
+You can request inclusion of any file into your configuration file
using @code{include} statement. Its only argument supplies the name of
file to be included. For example:
@@ -466,7 +468,8 @@ effect.
@section Syslog Configuration Directives
@cindex syslog, configuration
@kwindex syslog-facility
- Unless told otherwise, @command{wydawca} uses @code{syslog} to print
+@UNREVISED
+Unless told otherwise, @command{wydawca} uses @code{syslog} to print
its diagnostic messages. By default, the program uses the
@samp{local1} facility. To change this, use @code{syslog-facility}
statement:
@@ -513,7 +516,8 @@ syslog-print-priority yes
@cindex @acronym{SQL} databases
@cindex @command{MySQL} databases
@cindex database, @command{MySQL}
- Several statements in configuration file may need to access
+@UNREVISED
+Several statements in configuration file may need to access
@acronym{SQL} database. @command{Wydawca} can use any number of
databases simultaneously, the only restriction being that they must be
@command{MySQL} databases (this restriction will be removed in future
@@ -578,7 +582,8 @@ end
@section Access Methods
@cindex Access method
@cindex @acronym{PGP} key
- An @dfn{access method} defines how @command{wydawca} accesses some
+@UNREVISED
+An @dfn{access method} defines how @command{wydawca} accesses some
piece of information it needs while verifying the submission. This
information can be, for example, the user's @acronym{PGP} key or his
permissions on a project.
@@ -736,7 +741,8 @@ verify-user sql default SELECT user.user_name \
@cindex sendfile
@cindex Invalid value, warning message
@cindex Function not implemented, warning message
- If compiled for GNU/Linux, @command{wydawca} tries to optimize disk
+@UNREVISED
+If compiled for GNU/Linux, @command{wydawca} tries to optimize disk
transfer operations by using @code{sendfile} system call. If it
fails, and the error is recoverable, @command{wydawca} falls back to
copying files using user space. This is indicated by one of the following
@@ -764,7 +770,8 @@ higher.
@node archivation
@section Archivation
@cindex archivation, defined
- There may be cases when project maintainers need to overwrite
+@UNREVISED
+There may be cases when project maintainers need to overwrite
existing distributed files with another ones, having the same names.
(Note, hovewer, that this practice is not encouraged). In that case,
@command{wydawca} needs to first @dfn{archive} the already existing
@@ -913,7 +920,8 @@ archive-signatures no
@cindex source directory, defining
@kwindex source
@kwindex destination
- A @dfn{directory pair} definition is a core of @command{wydawca}
+@UNREVISED
+A @dfn{directory pair} definition is a core of @command{wydawca}
configuration. It defines the location of the source directory and the
corresponding distribution (or @dfn{destination}) directory. It may
also set the archivation type being used for that directory and
@@ -971,7 +979,8 @@ provisions for such case.
@node statistics
@section Statistics
@cindex statistics
- At the end of the run, @command{wydawca} prints a detailed
+@UNREVISED
+At the end of the run, @command{wydawca} prints a detailed
statistics of its execution on the diagnostic channel @samp{info}.
The statistics is printed only if at least one of the items is not zero.
The following example illustrates what you might get if you configured
@@ -1100,7 +1109,8 @@ statistics all errors warnings
@node notification
@section Mail Notification
@cindex mail notification
- While running, @command{wydawca} keeps track of certain events
+@UNREVISED
+While running, @command{wydawca} keeps track of certain events
occurring, such as, for example, broken @acronym{PGP} signatures or
file uploads attempted by unauthorized users. The utility can notify,
via email, project administrators about any of those events that
@@ -1133,7 +1143,8 @@ from the name of the user @command{wydawca} runs as (usually
@subsection Mailer
@cindex mailer
@kwindex mailer
- To send messages, @command{wydawca} uses a special logical entity
+@UNREVISED
+To send messages, @command{wydawca} uses a special logical entity
called @dfn{mailer}. It is set in the configuration file using
@code{mailer} keyword:
@@ -1199,7 +1210,8 @@ mailer smtp://remote.server.net:24
@cindex templates, notification messages
@cindex notification message template
@cindex message template
- Each notification message is build from a message template, by
+@UNREVISED
+Each notification message is build from a message template, by
expanding any occurrences of @samp{%@{@var{name}@}} within it with the value
of macro-variable @var{name}. Sets of defined macro-variables
depend on the type of the notification and are described below.
@@ -1262,7 +1274,8 @@ EOT
@node statreports
@subsection Statistic Reports
@kwindex mail-admin-stat
- Sending statistic reports to the system administrator is enabled by
+@UNREVISED
+Sending statistic reports to the system administrator is enabled by
@code{mail-admin-stat} statement. It takes two or more arguments.
The first argument supplies the identifier of a message template,
which should be previously defined by a @code{define-message}.
@@ -1347,7 +1360,8 @@ end
@node event notification
@subsection Event Notification
@cindex event notification
- The following @dfn{events} are tracked during the execution. Any of
+@UNREVISED
+The following @dfn{events} are tracked during the execution. Any of
them can be used to trigger an email notification of any party
concerned: the system administrator, project administrators, or
the user that initiated the upload:
@@ -1517,7 +1531,8 @@ notify-event success user user-success
@node wydawca.rc, invocation, configuring, Top
@chapter @command{Wydawca} configuration file.
@cindex configuration statements, reference
- This chapter contains a concise reference list of all configuration
+@UNREVISED
+This chapter contains a concise reference list of all configuration
file statements.
@deffn {Wydawca Statement} archive @var{type} @var{archive-name} @
@@ -1866,7 +1881,8 @@ Sets the mailer @acronym{URL} to use.
@chapter @command{Wydawca} invocation summary.
@cindex invocation
@cindex command line options
- This chapter presents a short reference of all @command{wydawca}
+@UNREVISED
+This chapter presents a short reference of all @command{wydawca}
command line options, in alphabetical order.
@table @option

Return to:

Send suggestions and report system problems to the System administrator.