diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2007-09-07 12:56:50 +0000 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2007-09-07 12:56:50 +0000 |
commit | 5e889958688b0ae315a93f4230f2e9a71a9095e9 (patch) | |
tree | b95b4d1e4370abd0dabb40123105feaf031389f4 /doc/wydawca.texi | |
parent | 399b6a3682437d576dc4b7d77f66b5d88be4f7f3 (diff) | |
download | wydawca-5e889958688b0ae315a93f4230f2e9a71a9095e9.tar.gz wydawca-5e889958688b0ae315a93f4230f2e9a71a9095e9.tar.bz2 |
Prepare for the release
git-svn-id: file:///svnroot/wydawca/trunk@320 6bb4bd81-ecc2-4fd4-a2d4-9571d19c0d33
Diffstat (limited to 'doc/wydawca.texi')
-rw-r--r-- | doc/wydawca.texi | 371 |
1 files changed, 200 insertions, 171 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi index 6bc79a9..02d650e 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi @@ -157,5 +157,5 @@ distributed tarball must be placed, and clear-signs it using his @cindex release submission daemon - From now on it is the responsibility of an @dfn{release submission daemon} -to scan the source directories, to gather the triplets, verify them, -and to any files that had passed the verification successfully to + From now on, it is the responsibility of a @dfn{release submission daemon} +to scan the source directories, gather the triplets, verify them, +and to move any files that had passed the verification successfully to their distribution sites. @@ -168,2 +168,14 @@ about any occurring problems. + @command{Wydawca} supports version 1.1 of directory file, as +described in +@ifnothtml +@ref{FTP Upload Directive File - v1.1, +Standalone directives, Standalone directives, +maintain, Information for maintainers of GNU software}. +@end ifnothtml +@ifhtml +@uref{http://www.gnu.org/prep/maintain/html_node/FTP-Upload-Directive-File-_002d-v1_002e1.html, +Standalone directives}. +@end ifhtml + The program is written entirely in @acronym{C}, is highly @@ -192,3 +204,3 @@ special provisions for that case. @cindex directory, destination - The configuration file supplies the utility with the set of + A configuration file supplies the utility with the set of @dfn{directory pairs}, i.e. pairs of upload and corresponding @@ -196,3 +208,3 @@ distribution directories. In @command{wydawca} terminology, upload directories are also called @dfn{source}, and distribution directories --- @dfn{destination} directories. It also supplies all the information +-- @dfn{destination} directories. The file also supplies all the information necessary to access user and project databases. @@ -203,4 +215,4 @@ looking for @dfn{directive files} and re-arranging list members in @dfn{triplets}. A @dfn{directive file} is a special file that must be -supplied with each upload, that contains directive regarding the -placement of the uploaded files. A @dfn{triplet}, is a standard +supplied with each upload and that contains directive regarding the +placement of the uploaded files. A @dfn{triplet} is a standard entity, consisting of three files: a clear-signed directive file, a @@ -222,3 +234,3 @@ Standalone directives}. necessary files, is then verified by checking if the modification -date of its oldest file is older than a predefined amount +date of its oldest file is older than a predefined amount of time (@pxref{file-sweep-time}), and if so, all files from this triplet are @@ -227,4 +239,4 @@ to restart interrupted or otherwise broken uploads later. - Then the utility ensures that each of the remaining triplets is -created by a single person, any triplets that do not are immediately + Then, the utility ensures that each of the remaining triplets is +created by a single person. Any triplets that do not are immediately removed. @@ -269,4 +281,4 @@ error and exits with code 0 if the file is OK, or 1 otherwise. Normally, @command{wydawca} attempts to detect automatically whether -it is run from an interactive console, and if so it prints it -diagnostics to the standard error. Otherwise, the diagnostics is +it is run from an interactive console, and if so it prints its +diagnostics on the standard error. Otherwise, the diagnostics is directed to the @command{syslog}, and the facility to use is gotten from the @@ -289,3 +301,3 @@ the same as @option{--syslog}, but it may change in the future. The @option{--debug} (@option{-d}) tells the program to increase its -debugging level by 1. The @dfn{debugging level} determines the amount +debugging level by 1. @dfn{Debugging level} determines the amount of information the program reports when it runs. By default it is 0, @@ -295,4 +307,5 @@ it may be necessary when debugging new configurations. Each @command{wydawca -dd} to obtain level 2, for example. The maximum -debugging level currently is 4, which prints impractically many -information and is useful primarily for @command{wydawca} developers. +debugging level currently is 4, which prints an impractically big +amount of information, which is useful mainly for @command{wydawca} +developers. @@ -302,9 +315,10 @@ information and is useful primarily for @command{wydawca} developers. Yet another debugging facility is the @option{--dry-run} -(@option{-n}) option. It instructs @command{wydawca} no to do any -modifications to the disk contents, but to verbosely print them. It -set the debugging level to 1 and directs the diagnostics output to the -standard error, as if @option{--debug --stderr} options have been -given. You can raise debugging level further by supplying additional -@option{--debug} options. The @option{--dry-run} option is useful when -testing new configurations, for example: +(@option{-n}) option. It instructs @command{wydawca} to avoid doing any +modifications to the disk contents, but to verbosely print any actions +it would have taken. Its set the debugging level to 1 and directs the +diagnostics output to the standard error, as if @option{--debug +--stderr} options have been given. You can raise debugging level +further by supplying additional @option{--debug} options. The +@option{--dry-run} option is useful when testing new configurations, +for example: @@ -318,3 +332,3 @@ $ wydawca -c new.cfg --dry-run @sopindex{v, described} - Two usual informational options are available as well: + In addition, the two usual informational options are available as well: @option{--help} (@option{-h}) prints a short usage summary, and @@ -327,4 +341,4 @@ syntax. Empty lines are ignored. Comments are introduced by a pound sign (@samp{#}): everything starting from the first occurrence of -@samp{#} up to the end of line is ignored. Non-empty non-comment lines -contain configuration statements. +@samp{#} up to the end of line is ignored as well. Non-empty +and non-comment lines must contain valid configuration statements. @@ -358,3 +372,3 @@ several lines, and ends with @code{end} statement, appearing on a line by itself. Within a compound statement any number of another -statements (both simple and compound) may appear). +statements (both simple and compound) may appear. @@ -362,3 +376,3 @@ statements (both simple and compound) may appear). When a statement appears outside of any block statement, we say that -@dfn{it appears at the top level} or @dfn{its scope is global}. When +it appears at @dfn{the top level} or @dfn{its scope is global}. When it appears within a block statement, we say that @dfn{it has block @@ -367,3 +381,3 @@ scope}. This subsection will guide you through the @command{wydawca} -configuration on step-by-step basis. +configuration on a step-by-step basis. @@ -385,3 +399,3 @@ configuration on step-by-step basis. You can request inclusion of any file into your configuration file -using @code{include} statement. As its argument give it the name of +using @code{include} statement. Its only argument supplies the name of file to be included. For example: @@ -399,3 +413,6 @@ keeping large static blocks of text in your configuration file, to make it more readable. An example of such large blocks of text are -templates for notification messages (@pxref{notification}). +templates for notification messages (@pxref{notification}), which we +suggest to keep in a separate file, and to include this file into the +main configuration (this approach is used in the default configuration +files). @@ -403,5 +420,5 @@ templates for notification messages (@pxref{notification}). @cindex default inclusion directory - Argument to the @code{include} statement may also be a relative + The @code{include} argument may also be a relative file name (i.e. one not beginning with @samp{/}). In this case, -@command{wydawca} will look for that file in the @dfn{inclusion +@command{wydawca} will look for that file in its @dfn{inclusion directory}. By default, the inclusion directory is your system @@ -427,6 +444,6 @@ argument must be separated from it by a single equals sign, as in If an argument is given, this option instructs @command{wydawca} to -use it as the inclusion path. Otherwise, if argument is omitted, -the include directory is defined as the directory part of the full +use it as the new inclusion path. Otherwise, if argument is omitted, +the include directory is defined as a directory part of the full file name of the configuration file. This form might be useful when -debugging new configurations. For example, the following invocation +debugging new configurations. For example, the following command runs @command{wydawca} in dry run mode, using configuration file @@ -449,5 +466,6 @@ effect. @kwindex syslog-facility - Syslog is the default diagnostics channel for @command{wydawca}. By -default, the program uses facility @samp{local1}. To change this, use -@code{syslog-facility} statement: + 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: @@ -467,3 +485,3 @@ values are: @samp{auth}, @samp{authpriv}, @samp{cron}, @samp{daemon}, @samp{mail}. These names are case-insensitive and may be optionally -prefixed with @samp{LOG_}. The default is @samp{local1}. +prefixed with @samp{log_} (case-insensitive as well). @@ -471,3 +489,3 @@ prefixed with @samp{LOG_}. The default is @samp{local1}. @cindex syslog tag, configuring - Another thing you may wish to tune is @dfn{syslog tag}, a string + Another thing you may wish to tune is the @dfn{syslog tag}, a string identifying each message issued by the program. By default it is a @@ -476,3 +494,3 @@ string @samp{wydawca}. To change it, use @code{syslog-tag} statement: @smallexample -syslog-tag wydawca +syslog-tag uploads @end smallexample @@ -513,7 +531,7 @@ end - Here, the @var{identifier} is a string uniquely identifying this + Here, @var{identifier} is a string uniquely identifying this database. It is used by another configuration statements (e.g. by -access methods, see the next section) to refer to this database. The -@var{statements} is a set of statements determining access to the -database. Allowed statements are: +access methods, see the next section) to refer to this +database. @var{statements} stand for a set of statements that +determine access credentials for the database. Allowed statements are: @@ -539,5 +557,6 @@ Specifies the database user name. @item password @var{string} -Specifies password for accessing the database. +Specifies the password for accessing the database. @end table +@noindent An example @code{sql} statement follows: @@ -559,3 +578,3 @@ end @cindex @acronym{PGP} key - An @dfn{access method} defines how @command{wydawca} can access some + An @dfn{access method} defines how @command{wydawca} accesses some piece of information it needs while verifying the submission. This @@ -564,5 +583,5 @@ permissions on a project. - @command{Wydawca} understands three access methods, only one of them -being implemented right now. These methods are summarized in the table -below: + @command{Wydawca} understands three types of access methods, only +one of them being implemented right now. These methods are summarized +in the table below: @@ -584,3 +603,3 @@ future use. - Access methods are defined in the configuration file using the + Access methods are defined in configuration file using the following syntax: @@ -598,4 +617,4 @@ where @var{method-name} is the predefined name of the access method, the configuration file, or inside a @code{directory} statement -(@pxref{directory pairs}). The global definitions affect all directory -pairs in the configuration file, the ones inside a @code{directory} +(@pxref{directory pairs}). Global definitions affect all directory +pairs in the configuration file, and ones inside a @code{directory} statement override them for that particular directory pair. @@ -604,15 +623,16 @@ statement override them for that particular directory pair. section. The @var{type} must currently always be @samp{sql}. The -@var{param1} is the identifier of one of the preceding @code{sql} blocks +@var{param1} is an identifier of one of the preceding @code{sql} blocks (@pxref{sql}), which determines database name and user credentials needed to access it. The @var{param2} is an @acronym{SQL} -statement that should be issued to obtain the requested data. A set of -@dfn{meta-variables} is available for use in @var{param2}. These -variables allow to supply to the query such additional information -that is available only at run-time. To use a meta-variable in a -query, it is preceded by a percent sign. If its name consists of -several letters, it must be surrounded by curly braces. For example, -following are two valid uses of macro-variables: @code{%u} and -@code{%@{user@}}, the first of them expands macro variable @samp{u}, -and the second one expands the variable @samp{user}. Undefined -variables are not expanded, but are left in the query intact. +statement that must be issued to obtain the requested data. Before +execution, this statement undergoes @dfn{variable expansion}, whereby +each occurrence of @code{%@{@var{name}@}} is replaced with the value +of meta-variable @var{name} (if @var{name} consists of a single +letter, the curly braces may be omitted). + + For example, following are two valid uses of macro-variables: +@code{%u} and @code{%@{user@}}, the first of them expands to the value +of macro variable @samp{u}, and the second one expands to the value of +the variable @samp{user}. Undefined variables are not expanded, but +are left in the query intact. @@ -662,3 +682,3 @@ gpg-key sql default SELECT gpg_key \ @dfn{owners}) of a project. It may return any number of rows, each one -consisting of two columns: email address and user name, in this order. +consisting of two columns: an email address and a user name, in this order. @@ -678,3 +698,3 @@ project-owner sql default SELECT user.email, user.realname \ Return email address and real name of a user. This method must -return one tuple, consisting of two columns: email address and user +return one tuple, consisting of two columns: an email address and a user name, in this order. @@ -695,3 +715,3 @@ make uploads. - The following definition allows uploads only to project + The following definition allows uploads only for project administrators: @@ -714,8 +734,9 @@ verify-user sql default SELECT user.user_name \ @cindex archivation, defined - Project maintainers may upload files having the same names as -the ones uploaded earlier. Although this practice is not encouraged, -it still can happen. In that case, @command{wydawca} needs to first -@dfn{archive} the already existing file, and then put the new one in -its place. Moreover, the directive file format allows maintainers to -explicitly require archivation of their existing files. + 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 +file, and then put the new one in its place. Moreover, the directive +file format allows maintainers to explicitly require archivation of +their existing files. @@ -744,6 +765,6 @@ the archivation type: @item directory - Use separate directory or directory hierarchy. + Use a separate directory or a directory hierarchy. @end table - When archivation type @asis{tar} is used, the second argument to + When the archivation type @asis{tar} is used, the second argument to @code{archive} sets the full name of the tar archive to use, e.g.: @@ -778,3 +799,3 @@ archive directory /var/backups/gnu all files from @file{/home/@/ftp/@/gnu/@/tar} will be archived in -@file{/var/@/backups/@/gnu/@/tar}, files from +@file{/var/@/backups/@/gnu/@/tar}, and files from @file{/home/@/ftp/@/gnu/@/tar/@/old} @@ -798,9 +819,8 @@ directory @file{/home/@/ftp/@/gnu/@/tar/@/.archive}, files from @vindex version-control @r{Emacs variable} - With the @samp{directory} archivation type, it may happen that the + When using the @samp{directory} archivation type, it may happen that the archive file with the same name as the one about to be created already -exists. In this case the third argument to @code{archive} specifies -how to handle the existing copy, in other words, how to @dfn{backup} -it. This argument corresponds to the Emacs variable @samp{version-control}, -and it accepts the same values as in Emacs. The following table -describes them: +exists. The third argument to @code{archive} specifies how to handle +the existing copy, in other words, how to @dfn{backup} it. This +argument corresponds to the Emacs variable @samp{version-control}, and +it accepts the same values as in Emacs. The following table describes them: @@ -843,18 +863,18 @@ not set, the @samp{existing} is used by default. A @dfn{directory pair} definition is a core of @command{wydawca} -configuration. It defines the location of the source directory and its -corresponding distribution directory. It may also set the archivation -type being used for that directory and various access methods, thus -overriding the global settings. The directory pair definition begins with -the @code{directory} keyword, optionally followed by the @acronym{URL} -of the distribution directory. This @acronym{URL}, if specified, is -then used in diagnostic messages regarding this directory -pair. Following the @code{directory} keyword is a list of statements -describing the pair. At least two statements are required: -@code{source}, specifying the location of the source directory and -@code{destination}, which specifies the location of destination (or -distribution) directory. Apart from these obligatory statements, the -@code{directory} block may contain @code{archive} statement +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 +various access methods, thus overriding the global settings. The +directory pair definition begins with the @code{directory} keyword, +optionally followed by the @acronym{URL} of the distribution +directory. This @acronym{URL}, if specified, is used in diagnostic +messages regarding this directory pair. Following the @code{directory} +keyword is a list of statements describing the pair. At least two +statements are required: @code{source}, specifying location of the +source directory and @code{destination}, which specifies location of +the destination directory. Apart from these obligatory statements, a +@code{directory} block may contain an @code{archive} statement (@pxref{archivation}) and access method definitions (@pxref{access methods}). Any of these statements, if present, overrides the -corresponding global definition for this directory pair. The +corresponding global definition for this directory pair. A @code{directory} statement ends with the @code{end} keyword on a @@ -862,3 +882,3 @@ separate line. - For example, the following definition says that the valid uploads to + For example, the following definition says that valid uploads to @file{/home/ftp/incoming/ftp} should be transferred to @file{/home/ftp/gnu}: @@ -874,3 +894,4 @@ end - This directory pair will be using archivation type and access methods +@noindent +This directory pair will be using the archivation type and access methods defined globally. @@ -878,3 +899,3 @@ defined globally. The following example shows the same directory pair block, that -additionally overrides archivation method: +additionally sets its own archivation method: @@ -892,5 +913,5 @@ end the same machine as the upload directory. If they are located on -different machines, one of the directories can be mounted using -@acronym{NFS}. The future versions will contain special provisions for -such case. +different machines, one of the directories should be mounted using +@acronym{NFS}. Future @command{wydawca} versions will contain special +provisions for such case. @@ -899,3 +920,3 @@ such case. @cindex statistics - At the end of the run, @command{wydawca} can print the detailed + At the end of the run, @command{wydawca} prints a detailed statistics of its execution on the diagnostic channel @samp{info}. @@ -932,3 +953,3 @@ Any error that occurred during the run. @item warnings -Any warning conditions occurred during the run. +Any warning condition occurred during the run. @@ -970,5 +991,4 @@ A triplet is processed successfully @item uploads -An upload is executed successfully. An upload is defined as a -successful move of a file and its detached signature from the source -to the destination directory. +An upload is processed successfully. An upload is defined as a move of +a file and its detached signature from the source to the destination directory. @@ -980,3 +1000,3 @@ An archivation is performed @item symlinks -A symlinks is created. +A symlink is created. @@ -988,5 +1008,5 @@ A symlink is removed. @kwindex statistics - The amount of information included in the statistics summary is -configured using the @code{statistics} statement. It takes arbitrary -number of arguments, each one being one of the keywords, described + Amount of information included in the statistics summary is +configured using the @code{statistics} statement. This statement takes +a list of arguments, each one being one of the keywords, described above. For example, the following statement causes only the @@ -998,3 +1018,4 @@ statistics errors warnings - It will produce the following output: +@noindent +It will produce the following output: @@ -1036,3 +1057,3 @@ previous section. @kwindex from-address - The sender email for these notifications can be set using the + The sender email address for these notifications is set using the @code{from-address} statement, e.g.: @@ -1108,3 +1129,3 @@ mailer. The @samp{smtp} protocol means to use an @acronym{SMTP} server directly. -In this case, the mailer location consists of two slashes, +In this case, mailer location consists of two slashes, followed by the @acronym{IP} address or host name of the @acronym{SMTP} @@ -1128,3 +1149,3 @@ mailer smtp://remote.server.net:24 expanding any occurrences of @samp{%@{@var{name}@}} within it with the value -of macro-variable @var{name}. The sets of defined macro-variables +of macro-variable @var{name}. Sets of defined macro-variables depend on the type of the notification and are described below. @@ -1141,3 +1162,4 @@ define-message @var{id} [-]@var{delimiter} - The @var{id} is a symbolic identifier used to refer to this message +@noindent +where @var{id} is a symbolic identifier used to refer to this message in another configuration statements, @var{delimiter} is a delimiter @@ -1146,3 +1168,3 @@ number of lines that form the message template. If @var{delimiter} is prefixed by a minus sign, any leading whitespace will be removed from -each template line, thus allowing to indent it in a natural +each template line, thus allowing to indent the template text in a natural way. Furthermore, the @var{delimiter} itself is optional. If it is @@ -1274,3 +1296,3 @@ end The following @dfn{events} are tracked during the execution. Any of -them can be used to trigger sending an email notification to any party +them can be used to trigger an email notification of any party concerned: the system administrator, project administrators, or @@ -1326,3 +1348,3 @@ A user who uploaded files. For example, the following two statements instruct @command{wydawca} -to email notifications about @code{bad-directive-signature} event to +to email notifications about any @code{bad-directive-signature} event to project administrators and to the user who did the upload, using two @@ -1344,2 +1366,3 @@ Project system name. @kwindex url +@item url @acronym{URL} of the distribution site. @@ -1347,2 +1370,3 @@ Project system name. @kwindex dir +@item dir Directory (relative to the project distribution root) to where the @@ -1351,2 +1375,3 @@ files where uploaded. @kwindex dest-dir +@item dest-dir Value of the @code{destination} keyword. @@ -1354,2 +1379,3 @@ Value of the @code{destination} keyword. @kwindex source-dir +@item source-dir Value of the @code{source} keyword. @@ -1358,3 +1384,3 @@ Value of the @code{source} keyword. @item triplet:full -Full listing of the uploaded triplet. It is equivalent to: +A full listing of the uploaded triplet. It is equivalent to: @@ -1368,9 +1394,3 @@ Full listing of the uploaded triplet. It is equivalent to: -For example: - -@smallexample --rw-r--r-- gray users 2707278 2007-09-06 22:14:35 tar-1.18.tar.gz --rw-r--r-- gray users 189 2007-09-06 22:14:35 tar-1.18.tar.gz.sig --rw-r--r-- gray user 62 2007-09-06 22:14:35 tar-1.18.tar.gz.directive.asc -@end smallexample +See below for an example. @@ -1378,8 +1398,3 @@ For example: @item triplet:upload -Listing of the uploaded files. E.g.: - -@smallexample --rw-r--r-- gray users 2707278 2007-09-06 22:14:35 tar-1.18.tar.gz --rw-r--r-- gray users 189 2007-09-06 22:14:35 tar-1.18.tar.gz.sig -@end smallexample +Listing of the uploaded files (see below). @@ -1387,3 +1402,3 @@ Listing of the uploaded files. E.g.: @item triplet:dist -Listing of the main distribution file. +Listing of the main distribution file (see below). @@ -1391,3 +1406,3 @@ Listing of the main distribution file. @item triplet:sig -Listing of the detached signature file. +Listing of the detached signature file (see below). @@ -1395,3 +1410,3 @@ Listing of the detached signature file. @item triplet:dir -Listing of the directive file. +Listing of the directive file (see below). @@ -1412,2 +1427,15 @@ Email of the user who uploaded the triplet. + @dfn{Listings} referred to in the table above, are similar to those +produced by @code{ls} command, and include information +on file permissions, ownership, size and modification date. For +example, here is a possible @code{%@{triplet:full@}} listing: + +@smallexample +-rw-r--r-- gray users 2707278 2007-09-06 22:14:35 tar-1.18.tar.gz +-rw-r--r-- gray users 189 2007-09-06 22:14:35 tar-1.18.tar.gz.sig +-rw-r--r-- gray user 62 2007-09-06 22:14:35 tar-1.18.tar.gz.directive.asc +@end smallexample + + + The following example shows how to configure success notification @@ -1416,2 +1444,3 @@ for the user: @smallexample +# @r{Define a message template.} define-message user-success @@ -1429,2 +1458,3 @@ end +# @r{Use this template in a success notification.} notify-event success user user-success @@ -1440,5 +1470,6 @@ file statements. [@var{backup-method}] -Defines archivation and backup methods for the destination -directory. @xref{archivation}, for a detailed discussion. The -@var{type} specifies the archivation type: +Defines archivation and backup methods. @xref{archivation}, for a +detailed discussion. @xref{archivation}, for a detailed explanation. + +The archivation type is specified by @var{type} argument: @@ -1446,3 +1477,3 @@ directory. @xref{archivation}, for a detailed discussion. The @item tar -The @var{archive-name} is a full file name of the @command{tar} +@var{archive-name} is a full file name of the @command{tar} archive used for archivation. Files being archived are appended to @@ -1454,3 +1485,3 @@ Appending Files to an Archive, Appending Files to an Archive, tar, @item directory -The @var{archive-name} specifies a directory name where to store +@var{archive-name} specifies a directory name where to store archive copies. If it is a relative file name, this directory will be @@ -1467,2 +1498,3 @@ where @var{dir} is the value of @code{directory} directive from the triplet file. +@end table @@ -1471,3 +1503,3 @@ triplet file. For @samp{directive} archivation type, the optional @var{backup-method} -parameter specifies how to back up an existing archive whose name +parameter specifies how to back up an existing file whose name coincides with the one @command{wydawca} is about to create. If @@ -1480,3 +1512,3 @@ 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: +also allows more descriptive names. Valid @var{method}s are: @@ -1497,3 +1529,2 @@ Always make simple backups. @end table -@end table @@ -1503,6 +1534,8 @@ Always make simple backups. 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}. +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_} +(sense-insensitive as well) prefix may be prepended to @var{facility}. + +@xref{syslog}, for more information. @end deffn @@ -1512,2 +1545,4 @@ Mark @command{wydawca} diagnostics with the given syslog tag. By default the string @samp{wydawca} is used. + +@xref{syslog}, for more information. @end deffn @@ -1516,2 +1551,4 @@ default the string @samp{wydawca} is used. Begin each diagnostic message with its priority. + +@xref{syslog}, for more information. @end deffn @@ -1569,18 +1606,3 @@ Do not print any statistics. - 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 +@xref{statistics}, for more information. @end deffn @@ -1629,3 +1651,3 @@ statement ends with the @code{end} keyword on a line by itself. -The @var{identifier} is the symbolic name that can be used in +@var{Identifier} is the symbolic name that can be used in subsequent configuration statements to refer to this @acronym{SQL} @@ -1646,3 +1668,3 @@ 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 +Hostname where the database is running; @var{hostname} is either a symbolic hostname of the machine, or its IP address in usual @@ -1652,3 +1674,3 @@ 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, +to use. In the latter case, @var{hostname} may be omitted. If, however, it is present, it must be @samp{localhost}. @@ -1772,3 +1794,4 @@ define-message @var{id} [[-]@var{delimiter}] - The @var{id} supplies the template identifier, @var{lines} gives +@noindent +where @var{id} supplies the template identifier, @var{lines} gives message headers and body, separated by a newline. If @var{delimiter} @@ -1791,3 +1814,3 @@ Sets the mailer @acronym{URL} to use. @cindex command line options - This chapter presents a short reference to all @command{wydawca} + This chapter presents a short reference of all @command{wydawca} command line options, in alphabetical order. @@ -1864,3 +1887,5 @@ Print the program version and exit. - As the purpose of bug reporting is to improve software, please be + Email bug reports to @email{bug-wydawca@@gnu.org.ua}. + + As the purpose of bug reporting is to improve software, please be sure to include maximum information when reporting a bug. The minimum @@ -1869,4 +1894,8 @@ information needed is: @itemize -@item Topmost date from the @file{ChangeLog} file. +@item Program version you use (see the output of @command{wydawca --version}. +@item A description of the bug. @item Conditions under which the bug appears. +@item It is often helpful to send the contents of @file{config.log} +file along with your bug report. This file is created after running +@command{./configure} in @command{wydawca} source root directory. @end itemize |