Wydawca 1 Introduction to Wydawca 2 Operation Overview 3 How to invoke 'wydawca'. 4 How to Configure 'wydawca'. 5 'Wydawca' configuration file. 6 'Wydawca' invocation summary. 7 How to Report a Bug Appendix A Architecture of the Wydawca Appendix B GNU Free Documentation License Concept Index Wydawca 1 Introduction to Wydawca 2 Operation Overview 2.1 Operation Modes 3 How to invoke 'wydawca'. 4 How to Configure 'wydawca'. 4.1 Configuration file syntax 4.1.1 Comments 4.1.2 Pragmatic Comments 4.1.3 Statements 4.1.4 Preprocessor 4.2 General Settings 4.3 Upload Directive Versions 4.4 User Privileges 4.5 Daemon Configuration 4.6 TCP Wrappers 4.7 Syslog Configuration Directives 4.8 SQL Databases 4.9 Dictionaries 4.9.1 SQL Dictionary 4.9.1.1 Project-owner: an SQL Implementation 4.9.1.2 Project-uploader: an SQL Implementation 4.9.2 Built-in Dictionary 4.9.3 External Dictionary 4.10 Directory Setup 4.11 Archivation 4.12 Distribution Spool 4.13 Distribution Verification 4.14 Statistics 4.15 Notification Mechanism 4.15.1 modules 4.15.2 Event Notification 4.15.3 'mod_mailutils'- Mail Notification 4.15.3.1 Mailer 4.15.3.2 Message Templates 4.15.3.3 Statistic Reports 4.15.3.4 'module-config' for 'mod_mailutils' 4.15.3.5 Example of mod_mailutils configuration 4.15.4 'mod_logstat' - statistics logging 5 'Wydawca' configuration file. 6 'Wydawca' invocation summary. 7 How to Report a Bug Appendix A Architecture of the Wydawca Event timestamps in WY_stat Appendix B GNU Free Documentation License B.1 ADDENDUM: How to use this License for your documents Concept Index Wydawca ******* This edition of the 'Wydawca Manual', last updated 6 January 2021, documents Wydawca Version 4.0.3. 1 Introduction to Wydawca ************************* Let's begin with a short synopsis. Suppose you run a developer's site, such as e.g. 'gnu.org'. You have two "distribution URLs": 'ftp.gnu.org', which distributes stable versions of the software, and 'alpha.gnu.org', which distributes alpha and pre-test versions. Package maintainers need a way of uploading their packages to one of these sites. This is done using the "Automated FTP Upload" method described in *note Automated FTP Uploads: (maintain)Automated FTP Uploads. The following is a short summary of it: there is an FTP "upload site", which has two "source directories", each one corresponding to a certain distribution URL. For example, Source Directory Distribution Site -------------------------------------------------------------------------- '/incoming/ftp' 'ftp.gnu.org' '/incoming/alpha' 'alpha.gnu.org' If maintainer of the project 'foo' wishes to make a release of the stable version 'foo-1.0.tar.gz', he first creates a detached signature 'foo-1.0.tar.gz.sig'. Then he creates a special "directive" file, which contains information about where the distributed tarball must be placed, and clear-signs it using his PGP key, thus obtaining the file 'foo-1.0.tar.gz.directive.asc'. Finally, he uploads these three files (a "triplet") to the upload site, storing them into the directory '/incoming/ftp'. From now on, it is the responsibility of a "release submission daemon" to scan source directories, gather triplets, verify them, and to move any files that had successfully passed verification to their distribution sites. 'Wydawca' is such a release submission daemon. It is able to handle any number of 'source/destination' pairs (called "spools") in real time, and offers extensible logging and notification mechanisms, allowing both package maintainers and site administrators to be immediately notified about any occurring problems. 'Wydawca' supports upload directive versions 1.1(1) and 1.2(2). The program is written entirely in C, is highly effective and consumes little resources. ---------- Footnotes ---------- (1) See Standalone directives (http://www.gnu.org/prep/maintain/html_node/FTP-Upload-Directive-File-_002d-v1_002e1.html). (2) See Standalone directives (http://www.gnu.org/prep/maintain/html_node/FTP-Upload-Directive-File-_002d-v1_002e2.html). 2 Operation Overview ******************** Usually, 'wydawca' is installed on the machine that receives release uploads. It may be run either periodically as a cron-job, or as a standalone daemon. It supposes that both upload and distribution directories are accessible in the local file system hierarchy. If that is not the case (e.g. if upload and distribution sites are handled by different machines), one of them should be mounted using NFS. Future versions will contain special provisions for that case. A configuration file defines a set of "spools", i.e. pairs of upload and corresponding distribution directories. In 'wydawca' terminology, upload directories are also called "source", and distribution directories - "destination" directories. The configuration file supplies also the information necessary to access user and project databases. When started, 'wydawca' scans each source directory and prepares a list of files found there. Then, it compacts this list by looking for "directive files" and re-arranging list members in "triplets". A "directive file" is a special file that must be supplied with each upload and contains instructions regarding the placement of the uploaded files. A "triplet" is a standard entity, consisting of three files: a clear-signed directive file, a file to be distributed, and a detached signature of the latter. In some special cases, a clear-signed directive file alone is valid. This happens when it contains only "standalone directives"(1). Each "incomplete" triplet, i.e. a triplet missing one or more necessary files, is then verified by checking if the modification date of its oldest file is older than a predefined amount of time (*note file-sweep-time: general.). If so, the triplet is considered "expired", and all its files are removed. This gives users the possibility to restart interrupted or otherwise broken uploads later. After completing these preliminary stages, 'wydawca' analyzes the directive file and extracts the project name from it. Using this name as a key, it searches in the "project dictionary" for a list of users authorized to make uploads for this project. This list contains user names and their corresponding public PGP keys. 'Wydawca' tries to verify the directive file using each PGP key from this list, until a matching key is found, or the list in exhausted. In the latter case, the triplet is rejected. Otherwise, the key and its owner are remembered for the next step. In this step, the uploaded file and its detached signature are verified. If they do not match the public key obtained in the previous step, the triplet is rejected. Finally, directives from the directive file are executed. On this stage of the processing, the uploaded files are actually moved to their destination directories, requested symbolic links are created, etc. ---------- Footnotes ---------- (1) Standalone directives (http://www.gnu.org/prep/maintain/html_node/FTP-Upload-Directive-File-_002d-v1_002e1.html). 2.1 Operation Modes =================== The program has two operation modes: 'cron mode' and 'daemon mode'. In "cron mode", 'wydawca' runs in foreground and exits when it is done with processing all required spools. By default it processes all configured spools, unless a subset of them is specified in the command line. This is called "cron mode", because this is the usual way for 'wydawca' to be used as a cron job. In "daemon mode", 'wydawca' detaches itself from the controlling terminal and runs in the background. It watches for the incoming uploads using one or both of the following methods. On modern GNU/Linux systems 'wydawca' uses "inotify" API (*note (inotify(7))monitoring file system events::), which enables it 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. 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 TCPMUX protocol(1) and operates as follows: After establishing connection, the remote party (the "client") sends the spool tag followed by a CRLF pair. The server scans its configuration for a spool that has the requested ID. If no such spool is found, the server replies with the string '- Unknown service name', followed by a CRLF pair and closes the connection. If a matching spool is found, the server replies with '+' acknowledgment, immediately followed by an optional message of explanation, and terminated with a CRLF. Upon receiving this acknowledgment, the client sends the login name of the user who did the upload(2). The following sample transaction illustrates this: C: stable S: +OK. URL ftp://ftp.domain.net C: smith When the user name is received, the server schedules a "job" for processing all triplets in the given spool. ---------- Footnotes ---------- (1) RFC 1078 (http://www.rfc-editor.org/rfc/rfc1078.txt). (2) The user name requirement is retained for backward compatibility. In fact, it is not used, so that any word can be sent instead. 3 How to invoke 'wydawca'. ************************** 'Wydawca' gets all information it needs from its "configuration file" (*note wydawca.conf::). The default configuration file is 'SYSCONFDIR/wydawca.conf', but if it is located elsewhere, you can specify its new location with the '--config-file' ('-c') command line option. If you wish to check your configuration file for syntax errors, use '--lint' ('-t') command line option. When given this option, 'wydawca' prints all diagnostics on its standard error and exits with code 0 if the file is OK, or 1 otherwise. Normally, 'wydawca' attempts to detect automatically whether 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 'syslog', using the facility given in the 'syslog-facility' configuration file statement (*note syslog::). Two options are provided if you wish to disable this autodetection: the option '--syslog' instructs the program to print all diagnostics via 'syslog', and the option '--stderr' (or '-e') instructs it to print everything on the standard error. The operation mode can be configured in the configuration file or in the command line. Command line options take precedence over configuration settings. The cron mode is the default. It can also be requested explicitly, using the '--cron' command line option. Similarly, the '--daemon' option enables daemon mode. Usually 'wydawca' attempts to process all the configured spools. You can instruct it to process only a subset of these by using the following options: '--spool=TAG' '-S TAG' Process only spool with the given tag. '--source=DIR' '-s DIR' Process only spool with DIR as the source directory. Any number of these options may be supplied, e.g.: $ wydawca --spool=ftp --spool=test --source=/home/ftp/test-upload The '--debug' ('-d') option tells the program to set its debugging level to the given integer value. "Debugging level" determines the amount of information the program reports when it runs. Default level is 0, which means that only errors and other critical conditions are reported. Raising it may be necessary when debugging new configurations. 'Wydawca' version 4.0.3 implements 4 distinct debugging levels. Yet another debugging facility is the '--dry-run' ('-n') option. It instructs 'wydawca' to avoid doing any modifications to the disk contents, and to print a verbose description of any actions it would have taken. It sets the debugging level to 1 and directs the diagnostics output to the standard error, as if '--debug=1 --stderr' options were given. You can further control the debugging level by supplying additional '--debug' options _after_ the '--dry-run' option. The '--dry-run' option is useful when testing new configurations, for example: $ wydawca -c new.cfg --dry-run In addition, the two usual informational options are available as well: '--help' ('-h') prints a short usage summary, and '--version' ('-v') prints program version number. 4 How to Configure 'wydawca'. ***************************** Upon startup, 'wydawca' reads its settings from the "configuration file" 'wydawca.conf'. By default it is located in $SYSCONFIDR (i.e., in most cases '/usr/local/etc', or '/etc'), but an alternative location may be specified using '--config-file' command line option (*note config-file: starting.). If any errors are encountered in the configuration file, the program reports them on its error output and exits with a non-zero status. To test the configuration file without starting the server use '--lint' ('-t') command line option. It causes 'wydawca' to check configuration file for syntax errors and other inconsistencies. If no errors were detected, the program exits with code 0. Otherwise, the exit code is 78. Using this option together with '-d1' ('--debug=1'), causes 'wydawca' to produce a dump of the configuration parse tree. Setting a higher debugging level (e.g. '-d2' option) will additionally prefix each statement in the dump with the file location where it appeared. Before parsing, configuration file is preprocessed using 'm4' (*note Preprocessor::). To see the preprocessed configuration without actually parsing it, use the '-E' command line option. To avoid preprocessing it, use '--no-preprocessor' option. The rest of this section describes the configuration file syntax in detail. You can receive a concise summary of all configuration directives any time by running 'wydawca --config-help'. 4.1 Configuration file syntax ============================= Wydawca configuration file consists of statements and comments. There are three classes of lexical tokens: keywords, values, and separators. Blanks, tabs, newlines and comments, collectively called "white space" are ignored except as they serve to separate tokens. Some white space is required to separate otherwise adjacent keywords and values. 4.1.1 Comments -------------- "Comments" may appear anywhere where white space may appear in the configuration file. There are two kinds of comments: single-line and multi-line comments. "Single-line" comments start with '#' or '//' and continue to the end of the line: # This is a comment // This too is a comment "Multi-line" or "C-style" comments start with the two characters '/*' (slash, star) and continue until the first occurrence of '*/' (star, slash). Multi-line comments cannot be nested. However, single-line comments may well appear within multi-line ones. 4.1.2 Pragmatic Comments ------------------------ Pragmatic comments are similar to usual single-line comments, except that they cause some changes in the way the configuration is parsed. Pragmatic comments begin with a '#' sign and end with the next physical newline character. Wydawca version 4.0.3, understands the following pragmatic comments: '#include ' '#include FILE' Include the contents of the file FILE. If FILE is an absolute file name, both forms are equivalent. Otherwise, the form with angle brackets searches for the file in the "include search path", while the second one looks for it in the current working directory first, and, if not found there, in the include search path. The default include search path is: 1. 'PREFIX/share/wydawca/include' 2. 'PREFIX/share/wydawca/4.0.3/include' where PREFIX is the installation prefix. New directories can be appended in front of it using '-I' ('--include-directory') command line option (*note include-directory: Preprocessor.). '#include_once ' '#include_once FILE' Same as '#include', except that, if the FILE has already been included, it will not be included again. '#line NUM' '#line NUM "FILE"' This line causes 'wydawca' to believe, for purposes of error diagnostics, that the line number of the next source line is given by NUM and the current input file is named by FILE. If the latter is absent, the remembered file name does not change. '# NUM "FILE"' This is a special form of '#line' statement, understood for compatibility with the C preprocessor. In fact, these statements provide a rudimentary preprocessing features. For more sophisticated ways to modify configuration before parsing, see *note Preprocessor::. 4.1.3 Statements ---------------- A "simple statement" consists of a keyword and value separated by any amount of whitespace. Simple statement is terminated with a semicolon (';'). Examples of simple statements: daemon yes; pidfile /var/run/wydawca.pid; A "keyword" begins with a letter and may contain letters, decimal digits, underscores ('_') and dashes ('-'). Examples of keywords are: 'group', 'file-sweep-time'. A "value" can be one of the following: number A number is a sequence of decimal digits. boolean A boolean value is one of the following: 'yes', 'true', 't' or '1', meaning "true", and 'no', 'false', 'nil', '0' meaning "false". unquoted string An unquoted string may contain letters, digits, and any of the following characters: '_', '-', '.', '/', '@', '*', ':'. quoted string A quoted string is any sequence of characters enclosed in double-quotes ('"'). A backslash appearing within a quoted string introduces an "escape sequence", which is replaced with a single character according to the following rules: Sequence Replaced with \a Audible bell character (ASCII 7) \b Backspace character (ASCII 8) \f Form-feed character (ASCII 12) \n Newline character (ASCII 10) \r Carriage return character (ASCII 13) \t Horizontal tabulation character (ASCII 9) \v Vertical tabulation character (ASCII 11) \\ A single backslash ('\') \" A double-quote. Table 4.1: Backslash escapes In addition, the sequence '\NEWLINE' is removed from the string. This allows to split long strings over several physical lines, e.g.: "a long string may be\ split over several lines" If the character following a backslash is not one of those specified above, the backslash is ignored and a warning is issued. Two or more adjacent quoted strings are concatenated, which gives another way to split long strings over several lines to improve readability. The following fragment produces the same result as the example above: "a long string may be" " split over several lines" Depending on the context, the quoted string may be subject to "variable expansion". During variable expansion, references to variables in the string are replaced with their actual values. A variable reference has two basic forms: $V ${V} where V is the variable name. The notation in curly braces serves several purposes. First, it should be used if the variable reference is immediately followed by an alphanumeric symbol, which will otherwise be considered part of it (as in '${home}dir'). Secondly, this form allows for specifying the action to take if the variable is undefined or expands to an empty value. The following special forms are recognized: ${VARIABLE:-WORD} "Use Default Values". If VARIABLE is unset or null, the expansion of WORD is substituted. Otherwise, the value of VARIABLE is substituted. ${VARIABLE:=WORD} "Assign Default Values". If VARIABLE is unset or null, the expansion of WORD is assigned to variable. The value of VARIABLE is then substituted. The assigned value remains in effet during expansion of the current string. ${VARIABLE:?WORD} "Display Error if Null or Unset". If VARIABLE is null or unset, the expansion of WORD (or a message to that effect if WORD is not present) is output to the current logging channel. Otherwise, the value of VARIABLE is substituted. ${VARIABLE:+WORD} "Use Alternate Value". If VARIABLE is null or unset, nothing is substituted, otherwise the expansion of WORD is substituted. These constructs test for a variable that is unset or null. Omitting the colon results in a test only for a variable that is unset. If a string contains a reference to an undefined variable, 'wydawca' will report an error and abort. To gracefully handle such cases, use the "default value construct", defined above. Here-document A "here-document" is a special construct that allows to introduce strings of text containing embedded newlines. The '<. 4.14 Statistics =============== Periodically 'wydawca' produces statistic dumps. These dumps are displayed on the diagnostic channel 'info' (and optionally mailed to the admimistrator). The frequency with which they are produced is defined by the 'stat-report-schedule' configuration statement. -- Config: stat-report-schedule time Schedules generation of statistic reports. The TIME argument is a time specification in 'crontab' format (*note (crontab(5))crontab::). By default, reports are generated hourly. To create reports each three hours, set stat-report-schedule "0 */3 * * *"; To create them at midnight, use stat-report-schedule "@midnight"; *Note Event timestamps in WY_stat::, if statistic reports appear to be generated one second prior to their scheduled time. Statistic report is suppressed if there were no uploads since the last report. The following example illustrates what you might get if you configured full statistic reports: errors: 0 warnings: 2 bad signatures: 0 access violation attempts: 0 complete triplets: 6 incomplete triplets: 2 bad triplets: 0 expired triplets: 0 triplet successes: 6 files uploaded: 12 files archived: 2 symlinks created: 0 symlinks removed: 0 Each item in this report is configurable, and a unique configuration keyword is associated with it. The statistic items and their corresponding keywords are described in the table below: 'errors' Any error that occurred during the run. 'warnings' Any warning condition occurred during the run. 'bad-signatures' A PGP signature not matches the public key for the user that issued it. 'access-violations' A user is attempting to upload files for some project, but it is not authorized to do so. 'complete-triplets' A complete triplet is registered. 'incomplete-triplets' An incomplete triplet is registered, i.e. such that misses one or more of its files. Notice, that a directive file alone is counted as a complete triplet, provided that its signature verifies correctly and that it does not contain 'file' directive. 'bad-triplets' A triplet contains files owned by different users. 'expired_triplets' A triplet has expired. 'triplet_success' A triplet is processed successfully 'uploads' 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. 'archives' An archivation is performed 'symlinks' A symlink is created. 'rmsymlinks' A symlink is removed. There are two ways to enable statistic reports. The "built-in" statistic output is enabled using the 'statistics' keyword. -- Config: statistics list The amount of information included in statistic report is configured using the '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 information about errors and warnings to be printed: statistics (errors, warnings); The output produced looks like: errors: 0 warnings: 2 A special keyword 'none' can be used to suppress this output altogether (which is the default), as in statistics none; Another special keyword is 'all'. It enables full statistic report. This keyword may also be followed by any number of statistic item names, which are in this case _excluded_ from the summary. For example, to output all statistic data, except errors and warnings one would set: statistics (all, errors, warnings); More elaborate output can be produced using the 'mod_logstat' loadable module. *Note mod_logstat::, for a detailed discussion. 4.15 Notification Mechanism =========================== While running, 'wydawca' keeps track of certain events occurring, such as, for example, broken PGP signatures or file uploads attempted by unauthorized users. It can issue notifications about such events using the supplied loadable modules. Configuration of notifications consists of two parts. First the required loadable module must be loaded and configured. Then, configure the notification itself. 4.15.1 modules -------------- A "loadable module" is a piece of software that provides notification mechanism for 'wydawca'. It is built as a UNIX dynamically loaded library and placed in one of the preconfigured directories which constitute a "library load path". To load a module, the following statement is used: -- Config: module NAME FILE Load the module NAME from FILE. Other places of the configuration file can refer to the module as NAME. The FILE argument is a file name of the module (normally, a 'file.so' or 'file.la' file). Unless FILE in the 'module' statement is an absolute file name, it will be searched in the library load path, which is defined as: 1. Optional "prefix" search directories specified by the 'module-prepend-load-path' directive (see below). 2. 'Wydawca' module directory: '$PREFIX/lib/wydawca'. 3. Additional search directories specified by the 'module-load-path' directive (see below). 4. The value of the environment variable 'LTDL_LIBRARY_PATH'. 5. The system dependent library search path (e.g. on GNU/Linux it is defined by the file '/etc/ld.so.conf' and the environment variable 'LD_LIBRARY_PATH'). The value of 'LTDL_LIBRARY_PATH' and 'LD_LIBRARY_PATH' must be a colon-separated list of absolute directory names, for example '/usr/lib/mypkg:/lib/foo'. In any of these directories, 'wydawca' first attempts to find and load the given filename. If this fails, it tries to append the following suffixes to it: 1. the libtool archive suffix: '.la' 2. the suffix used for native dynamic libraries on the host platform, e.g., '.so', '.sl', etc. The statements that modify the module search path are: -- Config: module-load-path LIST This directive adds the directories listed in its argument to the module load path. Example: module-load-path (/usr/lib/wydawca,/usr/local/wydawca/lib); -- Config: module-prepend-load-path LIST Same as above, but the directories from LIST are added to the beginning of the module search list, rather than to its end. The order of directories in LIST is preserved in both cases. Once loaded, the module can be initialized. This is done in the following block statement: -- Config: module-init NAME { ... } Initialize the module identified by NAME. The module must have been previously loaded using the 'module' statement, as described above. The statements between curly braces are module-specific configuration statements. See the module descriptions below for a detailed discussion of these. To list module-specific configuration directives with a short usage instructions, use the '--module-help' statement: wydawca --module-help=FILE If the FILE argument is the base module name (e.g. 'mod_mailutils'), it will be looked in the default library load path (*note library search path::). If it contains directory components, the FILE will be loaded from the specified directory. 4.15.2 Event Notification ------------------------- A number of "events" are tracked during the execution. Any of them can be used to trigger the notification mechanism. It is configured using the following statement: -- Config: notify-event { ... } notify-event { # Event on which to notify event EID; # Name of the module to invoke on event module MODNAME; # Module-specific configuration data module-config { ... } } -- Config: notify-event: event EID Trigger the notification when the event identified by EID occurs. The identified EID is one of the following: success Successful upload. bad-ownership An unauthorized user attempted to upload files for their project. bad-directive-signature The directive signature does not match the public key of the uploader. bad-detached-signature The detached signature does not match the public key of the uploader. check-failure Distribution verification failed. *Note verification::, for a detailed description. statistics This event produces statistics about the recent jobs performed by 'wydawca'. In daemon mode, it is scheduled periodically as controlled by the 'stat-report-schedule' statement. In cron mode it is emitted when all spools have been processed. For compatibility with 'wydawca' versions prior to 3.1.95, the event name 'finish' can be used instead of 'statistics'. *Note statreports::, for a detailed discussion. See also *note mod_logstat::. -- Config: notify-event: module MODNAME Identify the module responsible for the notification. The MODNAME argument must have been previously initialized in a 'module' statement (*note modules::). -- Config: notify-event: module-config { ... } This block provides module-specific configuration for MODNAME. Its content depends on the module used for notification. The version 4.0.3 of 'wydawca' is shipped with two notification modules: 'mod_mailutils' for notifications via electronic mail, and 'mod_logstat' for logging the information via 'syslog'. These modules are described in detail later. 4.15.3 'mod_mailutils'- Mail Notification ----------------------------------------- Mail notification is configured using the 'mod_mailutils' module. To load the module, add the following statement: module mailutils mod_mailutils.so; The 'module-init' section can contain the following statements: -- mod_mailutils: from-address address Set sender address for outgoing mails. E.g.: from-address ftp-uploads@gnu.org.ua; It is not strictly necessary to specify the sender address. In the absence of 'from-address' statement, the sender email will be constructed from the name of the user 'wydawca' runs as (*note user privileges::) and the full domain name of the machine it runs at. -- mod_mailutils: admin-address email Sets the admin email address or addresses. The statistic notifications and any notifications configured to be sent to admins will be forwarded to this address. The EMAIL argument is either a RFC 822 email address, or a list of such addresses. For example, the following statement configures a single admin address: admin-address root@gnu.org.ua; The example below illustrates how to configure multiple addresses: admin-address "root@gnu.org.ua,ftp-adm@gnu.org.ua"; Yet another way to configure them is: admin-address (root@gnu.org.ua, ftp-adm@gnu.org.ua); 4.15.3.1 Mailer ............... To send messages, 'mod_mailutils' uses a special logical entity called a "mailer". It is set in the 'module-init' block using the 'mailer' keyword. -- mod_mailutils: mailer url Set mailer URL. A mailer URL consists of a scheme specification, followed by '://' separator and additional data. The URLs supported by Wydawca version 4.0.3 are described in the table below. As usual, square brackets indicate optional parts: smtp://HOST[:PORT] Use an SMTP server on HOST to relay messages. The HOST part is either an IP address in dotted-quad notation or as a symbolic host name. In the latter case, DNS system is be used to resolve it. Optional PORT specifies port number or symbolic name (as defined in '/etc/services'). It defaults to 25. For example: mailer smtp://remote.server.net:24; sendmail://PROGNAME Use sendmail-compatible program PROGNAME. "Sendmail-compatible" means that the program must be able to read an RFC-822 message from its standard input and must support the following command line options: '-oi' Do not treat '.' as message terminator. '-f ADDR' Use ADDR as the sender address. '-t' Get recipient addresses from the message. Example: mailer sendmail:///usr/sbin/exim; sendmail: This is a special form of the 'sendmail' mailer. It uses the 'sendmail' binary from the '_PATH_SENDMAIL' macro in your '/usr/include/paths.h'. It is the default mailer. prog://PROGNAME?QUERY A "prog" mailer. This is a generalization of 'sendmail' mailer that allows to use arbitrary external programs as mailers. The full file name of the program is given in PROGNAME part. The QUERY part is a list of arguments, separated by '&' signs. Arguments may contain the following macro-substitutions: '${sender}' Expands to the sender email address. '${rcpt}' Expands to the recipient email addresses. The program PROGNAME must read an RFC-822 message from its standard input. An example of 'prog' mailer definition: mailer "prog:///bin/nullmail?localhost&-F${sender}&${rcpt} When sending a mail, 'wydawca' will invoke: /bin/nullmail localhost -FSENDER RCPT where SENDER means the sender address, and RCPT stands for the recipient email address. '| PROG ARGS..' Equivalent to the 'prog' mailer, described above, but written in a more natural fashion. In this notation, the example definition above becomes: mailer "|/bin/nullmail localhost -F${sender} ${rcpt}" 4.15.3.2 Message Templates .......................... Each notification message is built from a message template, by expanding variables (*note variable expansion::) within it. The message text may be specified either in place within the configuration directive it belongs to (*note notification::), or defined by 'define-message' statement. -- mod_mailutils: define-message name text Define message NAME to be TEXT. This message can be referred to from other configuration statements by '@NAME' notation. The message text must be formatted as a valid RFC-822 message, i.e. it must consist of two parts, message headers and body, separated by a single empty line. Therefore TEXT is usually a "here-document" construct (*note here-document::). For example: define-message my-message <'. check:result Code returned by external checker, in decimal. *Note check-result: verification, for a detailed description. check:diagn Diagnostics text returned by external checker. *Note verification::, for a detailed description. "Listings" referred to in the table above, are similar to those produced by the 'ls' command, and include information on file permissions, ownership, size and modification date. For example, here is a possible '${triplet:ls:full}' listing: -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 The example in the following subsection shows how to configure success notification for the user. ---------- Footnotes ---------- (1) It is equivalent to: ${triplet:ls:dist} ${triplet:ls:sig} ${triplet:ls:dir} (2) "Full" here means an email address with eventual personal part 4.15.3.5 Example of mod_mailutils configuration ............................................... This subsection provides a complete example for 'mod_mailutils' configuration. module mailutils mod_mailutils.la; module-init mailutils { admin-address "root@example.net"; from-address "wydawca@example.net"; mailer "sendmail:"; mail-statistics { statistics all; message <<- EOT Subject: upload statistics This is to notify you that the run of wydawca on ${date} caused the following results: errors ............................. ${stat:errors} warning ............................ ${stat:warnings} bad signatures ..................... ${stat:bad_signatures} access violation attempts .......... ${stat:access_violations} complete triplets .................. ${stat:complete_triplets} incomplete triplets ................ ${stat:incomplete_triplets} bad triplets ....................... ${stat:bad_triplets} expired triplets ................... ${stat:expired_triplets} triplet successes .................. ${stat:triplet_success} files uploaded ..................... ${stat:uploads} files archived ..................... ${stat:archives} symlinks created ................... ${stat:symlinks} symlinks removed ................... ${stat:rmsymlinks} verification failures .............. ${stat:check_failures} Regards, Wydawca EOT; } } notify-event { event statistics; module mailutils; } notify-event { event success; module mailutils; module-config { recipient user; message <<- EOT Subject: Upload of ${project} successful Upload of ${project} to ${url}/${dir} finished successfully. Files uploaded: ${triplet:ls:upload} Regards, Wydawca The Project Submission Robot EOT; } } For the sake of brevity, this example defines only two 'notify-event' statements. More statements for others events can be added as needed. 4.15.4 'mod_logstat' - statistics logging ----------------------------------------- The module 'mod_logstat' logs the supplied message at the 'statististics' event. The simplest configuration for this module is: module logstat mod_logstat.so; notify-event { event statistics; module logstat; } This will produce on the default logging channel the detailed statistics, as discussed in *note statistics::. There is no specific 'module-init' statements. The module should be called from 'notify-event' block on the 'statistics' event. The module's 'module-config' statement can contain the following statements: -- mod_logstat config: statistics list Configures what statistics items should be included in the output. *Note statistics::, for a detailed discussion of LIST. This statement is ignored if the 'message' statement is present. -- mod_logstat config: message text Specifies the message to be logged. The TEXT argument can contain references to statistic variables (*note statistic variables::). If no 'message' statement is present, the following default is assumed: message <. As the purpose of bug reporting is to improve software, please be sure to include a detailed information when reporting a bug. The minimum information needed is: * Program version you use (see the output of 'wydawca --version'. * A description of the bug. * Conditions under which the bug appears. * It is often helpful to send the contents of 'config.log' file along with your bug report. This file is created after running './configure' in 'wydawca' source root directory. Appendix A Architecture of the Wydawca ************************************** This appendix outlines the structure of the program. It serves as a short reminder for debugging the program. A running 'wydawca' process consists of at least four threads. Each upload is processed by its dedicated thread. Additional threads can be strarted to perform some specific tasks. If the operating system permits, each thread is assigned a name. Apart from the main thread, names of each thread begin with uppercase letters WY plus underscore. On a GNU/Linux system the name of a thread can be read from '/proc/PID/task/TID/comm', where PID is the PID of the 'wydawca' process and TID is the thread identifier. The following table describes each thread: 'wydawca' The main thread. It starts all other threads and waits for signals. When it exits, all other threads are terminated as well. 'WY_listener' The workhorse of the project. Listens on inotify descriptor and TCP socket for incoming notification events. This thread keeps a table of uploaded files, which is updated each time an inotify event is reported. Uploaded files are verified and ordered into triplets. Once a triplet is completed, a separate 'WY_triplet' thread is started in order to process it. If an incoming connection appears on upload notification socket (*note upload notification::), a 'WY_tcpmux' thread is started to handle it. 'WY_tricleaner' Keeps track of registered triplets and removes expired ones. 'WY_stat' This thread is responsible for statistic logging and notification. 'WY_connwatch' This thread is started by if the legacy upload notification is enabled (*note listen: daemon.). It enforces idle timeout for all started upload notification threads ('WY_tcpmux' instances). 'WY_tcpmux' Serves a particular notification upload connection. The number of threads of this type is limited by the 'max-connections' configuration file statement (*note max-connections: daemon.). 'WY_triplet' Processes a triplet. A separate thread of this type is started by 'WY_listener' for each valid triplet it detects. Event timestamps in WY_stat =========================== On GNU/Linux systems the events generated by the 'WY_stat' thread may appear to happen one second prior to their scheduled time. This happens if the software reporting the events uses 'time'(2) instead of 'gettimeofday'(2) for time reporting. The internal timekeeping mechanism of the linux kernel is designed so that the number of seconds returned by 'time' may be one less than the 'tv_sec' value after return from 'gettimeofday', if the two functions would be called the same instant(1). The two known cases are the legacy 'syslogd' used by default on Slackware systems, and the 'Sendmail' MTA. Since the results returned by 'gettimeofday' are more accurate, it was decided to leave this feature as it is, instead of installing workarounds of dubious nature just to satisfy older software. ---------- Footnotes ---------- (1) See , for details Appendix B GNU Free Documentation License ***************************************** Version 1.2, November 2002 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 0. PREAMBLE The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. 1. APPLICABILITY AND DEFINITIONS This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque". Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text. A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License. 2. VERBATIM COPYING You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies. 3. COPYING IN QUANTITY If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. 4. MODIFICATIONS You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice. H. Include an unaltered copy of this License. I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version. N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section. O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles. You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements." 6. COLLECTIONS OF DOCUMENTS You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. 7. AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title. 9. TERMINATION You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 10. FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See . Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. B.1 ADDENDUM: How to use this License for your documents ======================================================== To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (C) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''. If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this: with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. Concept Index ************* This is a general index of all issues discussed in this manual * Menu: * #include: Pragmatic Comments. (line 369) * #include_once: Pragmatic Comments. (line 388) * #line: Pragmatic Comments. (line 393) * /etc/hosts.allow: tcp-wrapper. (line 815) * /etc/services: daemon. (line 752) * access-violations, statistics: statistics. (line 1711) * admin: mail-config. (line 2217) * admin-address: mod_mailutils. (line 1960) * alias: spool. (line 1431) * all, statistics: statistics. (line 1769) * all-spools: daemon. (line 764) * allow-syslog-priority: tcp-wrapper. (line 823) * allow-table: tcp-wrapper. (line 815) * archivation methods: archivation. (line 1265) * archivation, defined: archivation. (line 1258) * archive: archivation. (line 1265) * archive <1>: archivation. (line 1271) * archive <2>: spool. (line 1510) * archive-signatures: archivation. (line 1394) * archives, statistics: statistics. (line 1738) * authpriv, syslog facility: syslog. (line 848) * backup: archivation. (line 1345) * bad-detached-signature: event notification. (line 1907) * bad-directive-signature: event notification. (line 1903) * bad-ownership: event notification. (line 1899) * bad-signatures, statistics: statistics. (line 1707) * bad-triplets, statistics: statistics. (line 1724) * block statement: Statements. (line 599) * boolean value: Statements. (line 430) * builtin: dictionaries. (line 1006) * builtin dictionary: builtin type. (line 1117) * c, -c short option, described: starting. (line 231) * c, -c short option, summary: invocation. (line 2734) * check-failure: event notification. (line 1911) * check-script: verification. (line 1565) * check-script <1>: verification. (line 1566) * check:diagn: mail-config. (line 2275) * check:result: mail-config. (line 2272) * command line options: invocation. (line 2730) * comment: dictionaries. (line 1054) * Comments in a configuration file: Comments. (line 345) * comments, pragmatic: Pragmatic Comments. (line 363) * complete-triplets, statistics: statistics. (line 1715) * config-file: sql. (line 890) * config-file, --config-file option, described: starting. (line 231) * config-file, --config-file option, summary: invocation. (line 2734) * config-group: sql. (line 893) * config-help, --config-help option, introduced: configuring. (line 327) * config-help, --config-help option, summary: invocation. (line 2740) * configuration file statements: Statements. (line 411) * configuration statements, reference: wydawca.conf. (line 2426) * create-directories: directory setup. (line 1219) * cron mode: operation modes. (line 181) * cron, --cron option, described: starting. (line 252) * cron, --cron option, summary: invocation. (line 2746) * cron, syslog facility: syslog. (line 848) * d, -d short option, described: starting. (line 274) * D, -D short option, introduced: Preprocessor. (line 644) * d, -d short option, summary: invocation. (line 2754) * D, -D short option, summary: invocation. (line 2765) * daemon: daemon. (line 738) * daemon <1>: tcp-wrapper. (line 810) * daemon mode: operation modes. (line 187) * daemon, --daemon option, described: starting. (line 257) * daemon, --daemon option, summary: invocation. (line 2751) * daemon, syslog facility: syslog. (line 848) * database: sql. (line 934) * database, MySQL: sql. (line 868) * database, SQL: sql. (line 868) * date: statreports. (line 2145) * debug, --debug option, described: starting. (line 274) * debug, --debug option, summary: invocation. (line 2754) * define, --define option, introduced: Preprocessor. (line 644) * define, --define option, summary: invocation. (line 2765) * define-message: templates. (line 2069) * defining source and distribution directories: spool. (line 1403) * deny-syslog-priority: tcp-wrapper. (line 826) * deny-table: tcp-wrapper. (line 819) * destination: spool. (line 1467) * destination directory: overview. (line 128) * destination-mode: spool. (line 1488) * destination-owner: spool. (line 1496) * dest_dir: dictionaries. (line 1043) * dest_dir <1>: mail-config. (line 2246) * detached signature: Intro. (line 84) * detached signature <1>: overview. (line 163) * detached signature <2>: overview. (line 163) * dictionaries: dictionaries. (line 970) * dictionary: overview. (line 153) * dictionary <1>: dictionaries. (line 977) * dictionary <2>: spool. (line 1514) * dir: dictionaries. (line 1039) * dir <1>: mail-config. (line 2244) * directory, archivation: archivation. (line 1294) * directory, destination: overview. (line 128) * directory, distribution: overview. (line 128) * directory, source: Intro. (line 73) * directory, source <1>: overview. (line 128) * directory, upload: overview. (line 128) * directory-mode: directory setup. (line 1223) * directory-mode <1>: archivation. (line 1368) * directory-owner: directory setup. (line 1233) * directory-owner <1>: archivation. (line 1376) * distribution directory: overview. (line 128) * distribution directory, defining: spool. (line 1403) * distribution spool: spool. (line 1403) * distribution verification: verification. (line 1559) * dry-run, --dry-run option, described: starting. (line 282) * dry-run, --dry-run option, summary: invocation. (line 2779) * dump-grammar-trace, --dump-grammar-trace option, summary: invocation. (line 2771) * dump-lex-trace, --dump-lex-trace option, summary: invocation. (line 2775) * e, -e short option, described: starting. (line 242) * E, -E short option, described: Preprocessor. (line 637) * E, -E short option, introduced: configuring. (line 322) * E, -E short option, summary: invocation. (line 2786) * e, -e short option, summary: invocation. (line 2840) * email:admin: mail-config. (line 2264) * email:owner: mail-config. (line 2267) * email:user: mail-config. (line 2269) * enable: tcp-wrapper. (line 807) * errors, statistics: statistics. (line 1701) * escape sequence: Statements. (line 438) * event: event notification. (line 1892) * existing, backup method: archivation. (line 1359) * expansion of undefined variables: Statements. (line 524) * expired triplet: overview. (line 146) * expired-triplets, statistics: statistics. (line 1727) * external: dictionaries. (line 1013) * external dictionary: external type. (line 1204) * facility: syslog. (line 847) * FDL, GNU Free Documentation License: Copying This Manual. (line 2955) * file-sweep-time: general. (line 668) * file-sweep-time <1>: spool. (line 1518) * finish: event notification. (line 1915) * force, --force option, summary: invocation. (line 2790) * foreground: general. (line 662) * foreground, --foreground option, summary: invocation. (line 2794) * from-address: mod_mailutils. (line 1950) * ftp, syslog facility: syslog. (line 848) * gpg-homedir: general. (line 676) * gpg-sign: statreports. (line 2135) * gpg-sign <1>: mail-config. (line 2229) * group: user privileges. (line 727) * h, -h short option, described: starting. (line 295) * h, -h short option, summary: invocation. (line 2797) * help, --help option, described: starting. (line 295) * help, --help option, summary: invocation. (line 2797) * here-document: Statements. (line 529) * host: sql. (line 927) * I, -I short option, introduced: Preprocessor. (line 648) * I, -I short option, summary: invocation. (line 2801) * idle-timeout: daemon. (line 773) * implicit signature archivation: archivation. (line 1387) * include-directory, --include-directory option, introduced: Preprocessor. (line 648) * include-directory, --include-directory option, summary: invocation. (line 2801) * incomplete triplet: overview. (line 146) * incomplete-triplets, statistics: statistics. (line 1718) * inotify: daemon. (line 741) * inotify <1>: operation modes. (line 191) * inotify <2>: spool. (line 1435) * introduction: Intro. (line 67) * invocation: starting. (line 231) * invocation <1>: invocation. (line 2730) * lint, --lint option, described: starting. (line 237) * lint, --lint option, introduced: configuring. (line 311) * lint, --lint option, summary: invocation. (line 2807) * list: Statements. (line 569) * listen: daemon. (line 748) * listing, triplet: mail-config. (line 2280) * local0 through local7, syslog facilities: syslog. (line 848) * m4: Preprocessor. (line 614) * mail notification: mod_mailutils. (line 1943) * mail, syslog facility: syslog. (line 848) * mail-statistics: statreports. (line 2097) * mailer: mailer. (line 1984) * mailer <1>: mailer. (line 1980) * mailer URL: mailer. (line 1987) * max-connections: daemon. (line 769) * max-version: versions. (line 708) * message: mail-config. (line 2212) * message <1>: statreports. (line 2116) * message <2>: mail-config. (line 2234) * message <3>: mod_logstat. (line 2399) * message template: templates. (line 2063) * min-version: versions. (line 704) * module: modules. (line 1801) * module <1>: event notification. (line 1927) * module-config: event notification. (line 1932) * module-help, --module-help option, introduced: modules. (line 1861) * module-help, --module-help option, summary: invocation. (line 2815) * module-init: modules. (line 1854) * module-load-path: modules. (line 1840) * module-prepend-load-path: modules. (line 1846) * multi-line comments: Comments. (line 353) * MySQL databases: sql. (line 868) * n, -n short option, described: starting. (line 282) * n, -n short option, summary: invocation. (line 2779) * name: archivation. (line 1297) * never, backup method: archivation. (line 1364) * nil, backup method: archivation. (line 1359) * no-preprocessor, --no-preprocessor option, defined: Preprocessor. (line 653) * no-preprocessor, --no-preprocessor option, introduced: configuring. (line 322) * no-preprocessor, --no-preprocessor option, summary: invocation. (line 2822) * none, archivation: archivation. (line 1288) * none, statistics: statistics. (line 1764) * notification: notification. (line 1783) * notification message template: templates. (line 2063) * notify-event: spool. (line 1524) * notify-event <1>: event notification. (line 1878) * numbered, backup method: archivation. (line 1355) * operation: overview. (line 120) * operation mode: operation modes. (line 179) * overview: overview. (line 120) * owner: mail-config. (line 2221) * params: dictionaries. (line 1057) * password: sql. (line 940) * PGP: Intro. (line 84) * PGP <1>: overview. (line 153) * PGP key: dictionaries. (line 970) * PGP signature: statistics. (line 1708) * pidfile: daemon. (line 780) * pp-setup: Preprocessor. (line 625) * pragmatic comments: Pragmatic Comments. (line 363) * preprocessor: Preprocessor. (line 614) * preprocessor, --preprocessor option, defined: Preprocessor. (line 656) * preprocessor, --preprocessor option, summary: invocation. (line 2825) * print-priority: syslog. (line 858) * project: dictionaries. (line 1024) * project <1>: mail-config. (line 2240) * project-owner: dictionaries. (line 991) * project-owner <1>: project-owner-sql. (line 1080) * project-uploader: dictionaries. (line 997) * project-uploader-sql: project-uploader-sql. (line 1099) * query: dictionaries. (line 1019) * quoted string: Statements. (line 438) * read: mail-config. (line 2212) * recipient: mail-config. (line 2208) * release submission daemon: Intro. (line 93) * rmsymlinks, statistics: statistics. (line 1744) * s, -s short option, summary: invocation. (line 2829) * S, -S short option, summary: invocation. (line 2835) * Savane: sql type. (line 1073) * signature files, archivation: archivation. (line 1387) * signature, detached: Intro. (line 84) * signature, detached <1>: overview. (line 163) * simple statements: Statements. (line 411) * simple, backup method: archivation. (line 1364) * single-line comments: Comments. (line 345) * source: spool. (line 1445) * source directory: Intro. (line 73) * source directory <1>: overview. (line 128) * source directory, defining: spool. (line 1403) * source, --source option, summary: invocation. (line 2829) * source-mode: spool. (line 1448) * source-owner: spool. (line 1456) * source_dir: dictionaries. (line 1046) * source_dir <1>: mail-config. (line 2247) * spool: overview. (line 128) * spool <1>: dictionaries. (line 1031) * spool <2>: spool. (line 1410) * spool <3>: mail-config. (line 2243) * spool, --spool option, described: starting. (line 263) * spool, --spool option, summary: invocation. (line 2835) * sql: dictionaries. (line 1009) * sql <1>: sql. (line 875) * SQL databases: sql. (line 868) * sql dictionary: sql type. (line 1063) * ssl-ca: sql. (line 943) * stat-report-schedule: statistics. (line 1661) * stat:access_violations: statreports. (line 2150) * stat:archives: statreports. (line 2158) * stat:bad_signatures: statreports. (line 2149) * stat:bad_triplets: statreports. (line 2154) * stat:check-failures: statreports. (line 2161) * stat:complete_triplets: statreports. (line 2151) * stat:errors: statreports. (line 2147) * stat:expired_triplets: statreports. (line 2155) * stat:incomplete_triplets: statreports. (line 2152) * stat:rmsymlinks: statreports. (line 2160) * stat:symlinks: statreports. (line 2159) * stat:triplet_success: statreports. (line 2156) * stat:uploads: statreports. (line 2157) * stat:warnings: statreports. (line 2148) * statement, block: Statements. (line 599) * statement, simple: Statements. (line 411) * statements, configuration file: Statements. (line 411) * statistics: event notification. (line 1915) * statistics <1>: statistics. (line 1750) * statistics <2>: statreports. (line 2125) * statistics <3>: statistics. (line 1656) * statistics <4>: mod_logstat. (line 2393) * stderr, --stderr option, described: starting. (line 242) * stderr, --stderr option, summary: invocation. (line 2840) * string, quoted: Statements. (line 438) * string, unquoted: Statements. (line 434) * success: event notification. (line 1896) * symlinks, statistics: statistics. (line 1741) * syslog: syslog. (line 840) * syslog priority, printing in diagnostics: syslog. (line 859) * syslog tag, configuring: syslog. (line 854) * syslog, --syslog option, described: starting. (line 242) * syslog, --syslog option, summary: invocation. (line 2846) * syslog, configuration: syslog. (line 836) * t, -t short option, described: starting. (line 237) * t, -t short option, summary: invocation. (line 2807) * t, backup method: archivation. (line 1355) * tag: syslog. (line 853) * tar, archivation: archivation. (line 1291) * tar-program: archivation. (line 1314) * tcp-wrapper: tcp-wrapper. (line 794) * TCPMUX notification: operation modes. (line 197) * templates, notification messages: templates. (line 2063) * Time Interval Specification: Statements. (line 586) * triplet listing: mail-config. (line 2280) * triplet, expired: overview. (line 146) * triplet, incomplete: overview. (line 146) * triplet-success, statistics: statistics. (line 1730) * triplet:dir: mail-config. (line 2250) * triplet:dist: mail-config. (line 2248) * triplet:dist <1>: mail-config. (line 2253) * triplet:ls:dir: mail-config. (line 2257) * triplet:ls:full: mail-config. (line 2251) * triplet:ls:sig: mail-config. (line 2255) * triplet:ls:upload: mail-config. (line 2252) * triplet:sig: mail-config. (line 2249) * type: dictionaries. (line 1003) * umask: general. (line 665) * undefined variable, expansion: Statements. (line 524) * upload directory: overview. (line 128) * upload site: Intro. (line 73) * uploads, statistics: statistics. (line 1733) * url: dictionaries. (line 1035) * url <1>: spool. (line 1441) * url <2>: mail-config. (line 2242) * URL, mailer: mailer. (line 1987) * user: user privileges. (line 724) * user <1>: dictionaries. (line 1049) * user <2>: sql. (line 937) * user <3>: mail-config. (line 2226) * user <4>: mail-config. (line 2258) * user:email: mail-config. (line 2263) * user:name: mail-config. (line 2260) * user:real_name: mail-config. (line 2262) * v, -v short option, described: starting. (line 295) * V, -V short option, summary: invocation. (line 2851) * variable expansion: Statements. (line 477) * variables: Statements. (line 477) * variables in admin notifications: statreports. (line 2143) * verification: verification. (line 1559) * version, --version option, described: starting. (line 295) * version, --version option, summary: invocation. (line 2851) * version-control Emacs variable: archivation. (line 1346) * warnings, statistics: statistics. (line 1704) * WYDAWCA_DEST: verification. (line 1579) * WYDAWCA_DIST_FILE: verification. (line 1588) * WYDAWCA_SOURCE: verification. (line 1575) * WYDAWCA_SPOOL: verification. (line 1572) * WYDAWCA_TRIPLET_BASE: verification. (line 1585) * WYDAWCA_URL: verification. (line 1582)