diff options
Diffstat (limited to 'doc/wydawca.texi')
-rw-r--r-- | doc/wydawca.texi | 34 |
1 files changed, 32 insertions, 2 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi index 1d47cf5..21b015a 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi @@ -327,8 +327,22 @@ this is the usual way for @command{wydawca} to be used as a cron job. @cindex daemon mode In @dfn{daemon mode}, @command{wydawca} detaches itself from -the controlling terminal and runs in the background, listening on -a preconfigured socket. The socket implements the @acronym{TCPMUX} +the controlling terminal and runs in the background. It watches for +the incoming uploads using one or both of the following methods. + +@anchor{inotify} +@cindex inotify + On modern GNU/Linux systems @command{wydawca} uses @dfn{inotify} API +(@pxref{monitoring file system events,,,inotify(7),inotify man page}), +which makes it possible to react on each upload immediately after a +complete triplet is uploaded and to clean up unfinished or incomplete +uploads. This is a preferred mode of operation. + +@cindex TCPMUX notification + On other systems, the daemon can be configured to listen on +a socket for upload notifications. This method can also be used +together with inotify, should the need be. This feature uses the +@acronym{TCPMUX} protocol@footnote{@uref{http://www.rfc-editor.org/rfc/rfc1078.txt, RFC 1078}.} and operates as follows: @@ -1045,6 +1059,14 @@ group (nogroup, ftp); Enable daemon mode. @end deffn +@deffn {Config} inotify bool +Enables or disables the @dfn{inotify} watcher. By default, inotify is +always enabled on GNU/Linux systems (unless disabled at the configure +time). It can also be configured for each spool individually +(@xref{spool, inotify}. @xref{inotify}, for a detailed description of +this feature. +@end deffn + @deffn {Config} listen url Define a socket to listen on. Allowed values for @var{url} are: @@ -1867,6 +1889,7 @@ The @code{spool} block statement defines a distribution spool: spool @var{tag} @{ url @var{url}; alias (@var{aliases}); + inotify @var{bool}; source @var{dir}; destination @var{dir}; file-sweep-time @var{interval}; @@ -1886,6 +1909,13 @@ Defines a list of @dfn{aliases}, i.e. alternative tag names for this spool. @end deffn +@deffn {Config: spool} inotify bool +Enables or disables the @dfn{inotify} watcher for this spool. By +default, inotify is always enabled on GNU/Linux systems (unless +disabled at the configure time). @xref{inotify}, for a detailed +description of this feature. +@end deffn + @deffn {Config: spool} url string Defines download @acronym{URL}, associated with this spool. Its value may be used as @samp{$@{url@}} meta-variable in mail notifications. |