Update

git-svn-id: file:///svnroot/gsc/trunk@287 d2de0444-eb31-0410-8365-af798a554d48

1 files changed, 277 insertions, 2 deletions

diff --git a/doc/gsc.texi b/doc/gsc.texi
index 423c68d..70dbbde 100644
--- a/doc/gsc.texi
+++ b/doc/gsc.texi
@@ -120,6 +120,7 @@ Root Utilities
 * firewall::             M4 Wrappers For Setting Firewalls.
 * session-cleanup::      Manage PHP Sessions.
 * jabberd::              Jabberd dispatcher daemon.
+* wydawca::              Automatic project release utility.
 
 firewall
 
@@ -799,6 +800,7 @@ cases, though not always. Such files should probably be inspected after
 * firewall::             M4 Wrappers For Setting Firewalls.
 * session-cleanup::      Manage PHP Sessions.
 * jabberd::              Jabberd dispatcher daemon.
+* wydawca::              Automatic project release utility.
 @end menu
 
 @node ckaliases
@@ -1466,7 +1468,7 @@ Wait @var{n} seconds for all children to shut down.
 @end deffn
 
 @deffn {Jabber Statement} syslog-facility @var{facility}
-Output diagnostics to the given syslog facility.  @var{facility} is
+Output diagnostics to the given syslog facility.  The @var{facility} 
 may be one of the following: @samp{USER}, @samp{DAEMON}, @samp{AUTH},
 @samp{AUTHPRIV}, @samp{LOCAL0} through @samp{LOCAL7}, and @samp{MAIL}.
 The string matching is case insensitive.  Optionally, @samp{LOG_}
@@ -1516,7 +1518,280 @@ transport jit
   stderr notice
 end
 @end smallexample
-  
+
+@node wydawca
+@section Automatic project release utility
+@UNREVISED{}
+
+@menu
+* wydawca.rc::          Wydawca configuration file.
+@end menu
+
+@node wydawca.rc
+@subsection Wydawca configuration file.
+@UNREVISED{}
+
+@deffn {Wydawca Statement} syslog-facility @var{facility}
+Output diagnostics to the given syslog facility.  The @var{facility} 
+may be one of the following: @samp{USER}, @samp{DAEMON}, @samp{AUTH},
+@samp{AUTHPRIV}, @samp{LOCAL0} through @samp{LOCAL7}, and @samp{MAIL}.
+The string matching is case insensitive.  Optionally, @samp{LOG_}
+prefix may be prepended to @var{facility}.    
+@end deffn
+
+@deffn {Wydawca Statement} syslog-tag @var{tag}
+Mark @command{wydawca} diagnostics with the given syslog tag.  By
+default the string @samp{wydawca} is used.
+@end deffn
+
+@deffn {Wydawca Statement} syslog-print-priority @var{bool}
+Begin each diagnostic message with its priority.
+@end deffn
+
+@deffn {Wydawca Statement} statistics @var{stat-list}
+Print usage statistics at the end of the run.  These data are output
+at @samp{info} priority.  The @var{stat-list} is a white-space
+separated list of items that specify what statistics data are to be
+printed. The valid items of @var{stat-list} are:
+
+@table @option
+@item archives
+Number of files successfully archived.
+
+@item bad_triplets
+Number of bad triplets detected.
+
+@item complete_triplets
+Number of complete triplets.
+
+@item errors
+Number of errors during the run.
+
+@item expired_triplets
+Number of expired triplets.
+
+@item incomplete_triplets
+Number of incomplete triplets.
+
+@item rmsymlinks
+Number of symlinks successfully removed.
+
+@item symlinks
+Number of symlinks successfully created.
+
+@item triplet_success
+Number of triplets successfully processed.
+
+@item uploads
+Number of successful uploads.
+
+@item warnings
+Number of warnings.
+@end table
+
+  Two special keywords are also recognized:
+
+@table @option
+@item all
+Print all information.
+
+@item none
+Do not print any statistics.
+@end table
+
+  These keywords must be the very first items in @var{stat-list}.
+When followed by another keywords, these special keywords modify list
+handling as follows:
+
+@table @option
+@item all
+The sense of all subsequent items is inverted. For example, to print
+everything, except the number of warnings and errors, one would use:
+
+@smallexample
+statistics all errors warning
+@end smallexample
+
+@item none
+Is ignored.
+@end table
+@end deffn
+
+@deffn {Wydawca Statement} file-sweep-time @var{interval}
+Sets the amount of time after which any unprocessed file will be
+removed.
+
+  The @var{interval} is a string that defines a time interval, much
+the same way we do this in English: it consists of one or more pairs
+``@samp{number} @samp{time unit}''.  For example, the following are
+valid interval specifications: 
+
+@smallexample
+@group
+1 hour
+2 hours 35 seconds
+1 year 7 months 2 weeks 2 days 11 hours 12 seconds
+@end group
+@end smallexample
+
+@noindent
+The pairs can occur in any order, however unusual it may sound to a
+human ear, e.g. @samp{2 days 1 year}.  If the @samp{time unit} is
+omitted, seconds are supposed.
+@end deffn
+
+@deffn {Wydawca Statement} umask @var{value}
+Sets the umask to be used.  The @var{value} must be octal.
+@end deffn
+
+@deffn {Wydawca Statement} tar-command @var{string}
+Sets the file name of the @command{tar} utility. If @var{string} is
+not an absolute file name, it will be searched in @env{PATH}.
+@end deffn
+
+@deffn {Wydawca Block Statement} sql @var{identifier}
+This statement begins an @dfn{MySQL database} definition. It may contain 
+several substatements, defining how to access the database. The
+statement ends with the @code{end} keyword on a line by itself.
+
+The @var{identifier} is the symbolic name that can be used in
+subsequent configuration statements to refer to this @acronym{SQL}
+database.
+
+@smallexample
+sql default
+  host localhost:/tmp/mysql.sock
+  database savane
+  user savane
+  password guessme
+end
+@end smallexample
+
+The following statements are recognized within the @code{sql} block:
+
+@deffn {Wydawca Statement} host @var{hostname}[:@var{port-or-socket}]
+Hostname where the database is running. The @var{hostname} is either
+a symbolic hostname of the machine, or its IP address in usual
+@samp{dotted-quad} notation.
+
+The 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} may be omitted. If,
+however, it is present, it must be @samp{localhost}.
+
+Examples:
+
+@smallexample
+host 10.10.10.1
+host sql.server.com
+host sql.server.com:3100
+host localhost:/tmp/mysql.sock
+host /tmp/mysql.sock
+@end smallexample
+@end deffn
+
+@deffn {Wydawca Statement} database @var{string}
+Specifies the database name.
+@end deffn
+
+@deffn {Wydawca Statement} user @var{string}
+Specifies the database user name.
+@end deffn
+
+@deffn {Wydawca Statement} password @var{string}
+Specifies the password.
+@end deffn
+@end deffn
+
+@deffn {Wydawca Block Statement} directory
+Defines a directory pair. The statement ends with the @code{end}
+keyword on a line by itself. 
+
+The following statements are recognized within the @code{sql} block:
+
+@deffn {Wydawca Statement} source @var{dirname}
+Sets source directory name. The @var{dirname} must be an absolute file
+name.
+@end deffn
+
+@deffn {Wydawca Statement} destination @var{dirname}
+Sets source directory name. The @var{dirname} must be an absolute file
+name.
+@end deffn
+
+@deffn {Wydawca Statement} verify-user @var{type} @var{id} @var{command}
+@FIXME{Description.}
+@end deffn
+
+@deffn {Wydawca Statement} gpg-key @var{type} @var{id} @var{command}
+@FIXME{Description.}
+@end deffn
+
+@deffn {Wydawca Statement} archive @var{type} @var{archive-name} @
+       [@var{backup-method}]
+Defines archivation defaults for the destination directory. The
+@var{type} specifies the archivation type:
+
+@table @asis
+@item tar
+The @var{archive-name} is a full file name of the @command{tar}
+archive used for archivation. Files being archived are appended to
+that archive using @command{tar -r} command (@FIXME-pxref{tar}).
+The default file name of the @command{tar} binary is set by
+@code{tar-program} statement.
+
+@item directory
+The @var{archive-name} specifies a directory name where to store
+archive copies. If it is a relative pathname, this directory will be
+created under the @code{destination} directory. If it is absolute file
+name, the archive name directory will be constructed for each triplet
+using the following rule:
+
+@smallexample
+@var{archive-name}/@var{dir}
+@end smallexample
+
+@noindent
+where @var{dir} is the value of @code{directory} directive from the
+triplet file.
+
+@vindex VERSION_CONTROL
+@cindex backups
+For @samp{directive} archivation type, the optional @var{backup-method}
+parameter specifies how to back up an existing archive whose name
+coincides with the one @command{wydawca} is about to create. If 
+@var{backup-method} is not specified, the value of the @env{VERSION_CONTROL}
+environment variable will be used.  And if @env{VERSION_CONTROL} is not set,
+the @samp{existing} method (see below) is used by default.
+
+@vindex version-control @r{Emacs variable}
+This option corresponds to the Emacs variable @samp{version-control};
+the same values for @var{backup-method} are accepted as in Emacs.  This option
+also allows more descriptive names.  The valid @var{method}s are:
+
+@table @samp
+@item t
+@itemx numbered
+@cindex numbered @r{backup method}
+Always make numbered backups.
+
+@item nil
+@itemx existing
+@cindex existing @r{backup method}
+Make numbered backups of files that already have them, simple backups.
+of the others.
+
+@item never
+@itemx simple
+@cindex simple @r{backup method}
+Always make simple backups.
+
+@end table
+@end table
+
+@end deffn
+@end deffn
+
 @node Sendmail mc Files, Startup Scripts, Root Utilities, Top
 @chapter Sendmail @file{mc} Files