diff options
Diffstat (limited to 'doc/wydawca.texi')
| -rw-r--r-- | doc/wydawca.texi | 191 |
1 files changed, 187 insertions, 4 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi index 1f76e71..6f769d1 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi @@ -103,6 +103,7 @@ How to Configure @command{wydawca}. * syslog:: * sql:: * dictionaries:: +* directory setup:: * archivation:: * spool:: * verification:: @@ -127,12 +128,20 @@ SQL Dictionary * project-owner-sql:: * project-uploader-sql:: -Mail Notification +Notification Mechanism + +* modules:: +* event notification:: +* mod_mailutils:: Mail Notification +* mod_logstat:: Notification to syslog + +@command{mod_mailutils}-- Mail Notification * mailer:: * templates:: -* statreports:: -* event notification:: +* statreports:: +* mail-config:: @code{module-config} for @command{mod_mailutils} +* mod_mailutils example:: Example of @command{mod_mailutils} configuration @end detailmenu @end menu @@ -523,6 +532,7 @@ directives any time by running @command{wydawca --config-help}. * syslog:: * sql:: * dictionaries:: +* directory setup:: * archivation:: * spool:: * verification:: @@ -1716,6 +1726,54 @@ dictionary project-owner @{ As of version @value{VERSION} this dictionary is not yet implemented. +@node directory setup +@section Directory Setup + +@command{Wydawca} operates on three kinds of directories: spool source +directories (@pxref{spool, source}), destination directories +(@pxref{spool, destination}) and archive directories +(@pxref{archivation}). By default, @command{wydawca} assumes that all +directories specified in its configuration file already exist and have +proper ownership and modes. It will abort if it is not so. + +You can configure @command{wydawca} to create these directories as +needed, and to set up their ownership and modes automatically. + +@deffn {Config} create-directories bool +If set to @samp{yes}, this statement instructs @command{wydawca} to +create any missing directories. +@end deffn + +@deffn {Config} directory-mode mode +Specifies the mode for created directories (in octal). If the +directory already exists, its mode will be checked and if necessary +changed to @var{mode}. + +This statement is overridden by per-directory statements: +@code{source-mode} and @code{destination-mode} statements in +@code{spool} block (@pxref{spool}) and @code{directory-mode} statement +in @code{archive} block (@pxref{archivation}). +@end deffn + +@deffn {Config} directory-owner uid gid +Configures owner user and group IDs for source, destination and +archive directories. + +The @var{uid} argument is either a numeric UID prefixed with a plus +sign, or a symbolic user name, which will be converted to the numeric +UID using the system user database. If a number without the @samp{+} +prefix is supplied, it will first be looked in the password database +as the user name, and, if no such user is found, it will be used as +the numeric UID. + +The same holds for the @var{gid} argument. + +This statement is overridden by per-directory statements: +@code{source-owner} and @code{destination-owner} statements in +@code{spool} block (@pxref{spool}) and @code{directory-owner} statement +in @code{archive} block (@pxref{archivation}). +@end deffn + @node archivation @section Archivation @cindex archivation, defined @@ -1739,8 +1797,17 @@ where it affects only the given spool. @deffn {Config} archive type @smallexample archive @var{type} @{ + # Name of archive file or directory name @var{file-or-dir}; + + # Define backup type backup @var{type}; + + # mode for the archive directory + directory-mode @var{mode}; + + # owner user and group for the archive directory + directory-owner @var{uid} @var{gid}; @} @end smallexample @@ -1858,6 +1925,27 @@ Always make simple backups. If no backup method is given, @samp{existing} is assumed @end deffn +@deffn {Config: archive} directory-mode mode +Sets directory mode for creating the directory (octal). If the +directory already exists, its mode will be checked and if necessary +changed to @var{mode}. + +This statement overrides the global @code{directory-mode} statement +(@pxref{directory setup}). +@end deffn + +@deffn {Config} directory-owner uid gid +Configures owner user and group IDs for created archive directories. +If the archive directory already exists, its ownership will be checked +and if necessary reverted to @var{uid}:@var{gid}. + +@xref{directory setup, directory-owner}, for a discussion of the +syntax for @var{uid} and @var{gid}. + +This statement overrides the global @code{directory-mode} statement +(@pxref{directory setup}). +@end deffn + @cindex implicit signature archivation @cindex signature files, archivation Signature files (i.e. the ones ending with @samp{.sig}) are usually @@ -1899,7 +1987,11 @@ spool @var{tag} @{ alias (@var{aliases}); inotify @var{bool}; source @var{dir}; + source-mode @var{mode}; + source-owner @var{uid} @var{gid}; destination @var{dir}; + destination-mode @var{mode}; + destination-owner @var{uid} @var{gid}; file-sweep-time @var{interval}; dictionary @{ @dots{} @} archive @{ @dots{} @} @@ -1933,6 +2025,27 @@ may be used as @samp{$@{url@}} meta-variable in mail notifications. Specifies the location of the source directory. @end deffn +@deffn {Config: archive} source-mode mode +Sets directory mode for creating the source directory (octal). If the +directory already exists, its mode will be checked and if necessary +changed to @var{mode}. + +This statement overrides the global @code{directory-mode} statement +(@pxref{directory setup}). +@end deffn + +@deffn {Config} source-owner uid gid +Configures owner user and group IDs for the source directory. +If the directory already exists, its ownership will be checked +and if necessary reverted to @var{uid}:@var{gid}. + +@xref{directory setup, directory-owner}, for a discussion of the +syntax for @var{uid} and @var{gid}. + +This statement overrides the global @code{directory-mode} statement +(@pxref{directory setup}). +@end deffn + @deffn {Config: spool} destination dir Specifies the type and location of the destination directory. The @var{dir} argument must be either an absolute name of a directory on @@ -1954,6 +2067,30 @@ are useful mainly for diagnostic purposes. @end table @end deffn +The following two statements apply only if the destination is a local +directory (@samp{file://} or @samp{dir://} URL scheme): + +@deffn {Config: archive} destination-mode mode +Sets directory mode for creating the destination directory (octal). +If the directory already exists, its mode will be checked and if +necessary changed to @var{mode}. + +This statement overrides the global @code{directory-mode} statement +(@pxref{directory setup}). +@end deffn + +@deffn {Config} destination-owner uid gid +Configures owner user and group IDs for the destination directory. +If the directory already exists, its ownership will be checked +and if necessary reverted to @var{uid}:@var{gid}. + +@xref{directory setup, directory-owner}, for a discussion of the +syntax for @var{uid} and @var{gid}. + +This statement overrides the global @code{directory-mode} statement +(@pxref{directory setup}). +@end deffn + The following statements, if present, override the corresponding global definitions for this spool. @@ -2126,7 +2263,7 @@ EOT; @node statistics @section Statistics @cindex statistics -At the end of the run, @command{wydawca} prints a detailed +At the end of the run, @command{wydawca} can print a detailed statistics of its execution on the diagnostic channel @samp{info}. The statistics is printed only if at least one of its items is not zero. The following example illustrates what you might get if you configured @@ -2214,6 +2351,10 @@ A symlink is created. A symlink is removed. @end table +There are two ways to enable the statistics logging. The +@dfn{built-in} statistics output is enabled using the +@code{statistics} keyword. + @deffn {Config} statistics list The amount of information included in the statistics summary is configured using the @code{statistics} statement. This statement takes @@ -2253,6 +2394,9 @@ statistics (all, errors, warnings); @end smallexample @end deffn +More elaborate output can be produced using the @code{mod_logstat} +loadable module. @xref{mod_logstat}, for a detailed discussion. + @node notification @section Notification Mechanism @cindex notification @@ -3382,6 +3526,18 @@ syslog @{ # @xref{templates}. define-message @var{ident:@i{string}} @var{text:@i{string}}; +# @r{Create missing directories.} +# @xref{directory setup}. +create-directories @var{arg:@i{boolean}}; + +# @r{Mode for created directories.} +# @xref{directory setup}. +directory-mode @var{mode}:@i{octal}; + +# @r{Owner user and group for created directory.} +# @xref{directory setup}. +directory-owner @var{uid:@i{string}} @var{gid:@i{string}}; + # @r{Set up archivation.} # @xref{archivation}. archive @var{type:@i{string}} @{ @@ -3391,6 +3547,13 @@ archive @var{type:@i{string}} @{ # @r{Define backup type.} # @xref{backup-methods}. backup @var{type:@i{string}}; + + # @r{Mode for the archive directory.} + # @xref{archivation, directory-mode}. + directory-mode @var{mode:@i{octal}}; + + # @r{Owner user and group for the archive directory.} + directory-owner @var{uid:@i{string}} @var{gid:@i{string}}; @} # @r{Define data dictionary.} @@ -3418,9 +3581,29 @@ spool @var{tag:@i{string}} @{ # @r{Source directory.} source @var{dir:@i{string}}; + # @r{Mode for the source directory.} + # @xref{spool, source-mode}. + # @xref{directory setup}. + source-mode @var{mode:@i{octal}}; + + # @r{Owner user and group for the source directory.} + # @xref{spool, source-owner}. + # @xref{directory setup}. + source-owner @var{uid:@i{string}} @var{gid:@i{string}}; + # @r{Destination directory.} destination @var{dir:@i{string}}; + # @r{Mode for the destination directory.} + # @xref{spool, destination-mode}. + # @xref{directory setup}. + destination-mode @var{mode:@i{octal}}; + + # @r{Owner user and group for the destination directory.} + # @xref{spool, destination-owner}. + # @xref{directory setup}. + destination-owner @var{uid:@i{string}} @var{gid:@i{string}}; + # @r{Define file sweep time.} file-sweep-time @var{time:@i{interval}}; |