diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-02-26 17:39:08 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-02-26 17:39:08 +0200 |
commit | 514797c56e431f37de9a00834281f990a7b15c46 (patch) | |
tree | 1f35e3b06d387e424f5a0d866390dccd34efd202 /doc/wydawca.texi | |
parent | 5b1f7f7213c1033211ce08307922e04044f872f4 (diff) | |
download | wydawca-514797c56e431f37de9a00834281f990a7b15c46.tar.gz wydawca-514797c56e431f37de9a00834281f990a7b15c46.tar.bz2 |
Minor fixes
Diffstat (limited to 'doc/wydawca.texi')
-rw-r--r-- | doc/wydawca.texi | 1035 |
1 files changed, 676 insertions, 359 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi index ad274b2..589f2f7 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi | |||
@@ -31,7 +31,7 @@ Published by the Free Software Foundation, | |||
31 | 51 Franklin Street, Fifth Floor | 31 | 51 Franklin Street, Fifth Floor |
32 | Boston, MA 02110-1301, USA | 32 | Boston, MA 02110-1301, USA |
33 | 33 | ||
34 | Copyright @copyright{} 2007 Sergey Poznyakoff | 34 | Copyright @copyright{} 2007, 2009 Sergey Poznyakoff |
35 | 35 | ||
36 | Permission is granted to copy, distribute and/or modify this document | 36 | Permission is granted to copy, distribute and/or modify this document |
37 | under the terms of the GNU Free Documentation License, Version 1.2 or | 37 | under the terms of the GNU Free Documentation License, Version 1.2 or |
@@ -59,13 +59,12 @@ Software Foundation raise funds for GNU development.'' | |||
59 | @page | 59 | @page |
60 | @contents | 60 | @contents |
61 | 61 | ||
62 | @node Top, Intro, (dir), (dir) | 62 | @ifnottex |
63 | 63 | @node Top | |
64 | @ifinfo | 64 | @top Wydawca |
65 | @chapter Wydawca | ||
66 | This edition of the @cite{Wydawca Manual}, last updated @value{UPDATED}, | 65 | This edition of the @cite{Wydawca Manual}, last updated @value{UPDATED}, |
67 | documents Wydawca Version @value{VERSION}. | 66 | documents Wydawca Version @value{VERSION}. |
68 | @end ifinfo | 67 | @end ifnottex |
69 | 68 | ||
70 | @menu | 69 | @menu |
71 | * Intro:: What is Wydawca | 70 | * Intro:: What is Wydawca |
@@ -90,12 +89,11 @@ already listed, mentioned here so you can get to them in one step: | |||
90 | 89 | ||
91 | How to Configure @command{wydawca}. | 90 | How to Configure @command{wydawca}. |
92 | 91 | ||
93 | * include:: | ||
94 | * syslog:: | 92 | * syslog:: |
95 | * sql:: | 93 | * sql:: |
96 | * access methods:: | 94 | * access methods:: |
97 | * archivation:: | 95 | * archivation:: |
98 | * directory pairs:: | 96 | * spool:: |
99 | * statistics:: | 97 | * statistics:: |
100 | * notification:: | 98 | * notification:: |
101 | 99 | ||
@@ -109,7 +107,7 @@ Mail Notification | |||
109 | @end detailmenu | 107 | @end detailmenu |
110 | @end menu | 108 | @end menu |
111 | 109 | ||
112 | @node Intro, overview, Top, Top | 110 | @node Intro |
113 | @chapter Introduction to Wydawca | 111 | @chapter Introduction to Wydawca |
114 | @cindex introduction | 112 | @cindex introduction |
115 | Let's begin with a short synopsis. Suppose you run a developer's | 113 | Let's begin with a short synopsis. Suppose you run a developer's |
@@ -150,21 +148,21 @@ signature @file{foo-1.0.tar.gz.sig}. Then he creates a special | |||
150 | @dfn{directive} file, that contains information about where the | 148 | @dfn{directive} file, that contains information about where the |
151 | distributed tarball must be placed, and clear-signs it using his | 149 | distributed tarball must be placed, and clear-signs it using his |
152 | @acronym{PGP} key, thus obtaining file | 150 | @acronym{PGP} key, thus obtaining file |
153 | @file{foo-1.0.tar.gz.directive.asc}. Then he uploads these three files | 151 | @file{foo-1.0.tar.gz.directive.asc}. Finally, he uploads these three files |
154 | (a @dfn{triplet}) to the upload site, storing them into the directory | 152 | (a @dfn{triplet}) to the upload site, storing them into the directory |
155 | @file{/incoming/ftp}. | 153 | @file{/incoming/ftp}. |
156 | 154 | ||
157 | @cindex release submission daemon | 155 | @cindex release submission daemon |
158 | From now on, it is the responsibility of a @dfn{release submission daemon} | 156 | From now on, it is the responsibility of a @dfn{release submission daemon} |
159 | to scan the source directories, gather the triplets, verify them, | 157 | to scan the source directories, gather the triplets, verify them, |
160 | and to move any files that had passed the verification successfully to | 158 | and to move any files that had successfully passed verification to |
161 | their distribution sites. | 159 | their distribution sites. |
162 | 160 | ||
163 | @command{Wydawca} is such a release submission daemon. It is able to | 161 | @command{Wydawca} is such a release submission daemon. It is able to |
164 | handle any number of @samp{source/destination} pairs, offers an | 162 | handle any number of @samp{source/destination} pairs (called |
165 | extensible logging and mail notification mechanism, allowing both | 163 | @dfn{spools}, offers an extensible logging and mail notification |
166 | package maintainers and site administrators to be immediately notified | 164 | mechanism, allowing both package maintainers and site administrators |
167 | about any occurring problems. | 165 | to be immediately notified about any occurring problems. |
168 | 166 | ||
169 | @command{Wydawca} supports version 1.1 of directory file, as | 167 | @command{Wydawca} supports version 1.1 of directory file, as |
170 | described in | 168 | described in |
@@ -181,19 +179,20 @@ Standalone directives}. | |||
181 | The program is written entirely in @acronym{C}, is highly | 179 | The program is written entirely in @acronym{C}, is highly |
182 | effective and consumes little resources. | 180 | effective and consumes little resources. |
183 | 181 | ||
184 | @node overview, starting, Intro, Top | 182 | @node overview |
185 | @chapter Operation Overview | 183 | @chapter Operation Overview |
186 | @cindex operation | 184 | @cindex operation |
187 | @cindex overview | 185 | @cindex overview |
188 | Usually, @command{wydawca} is installed on the machine that receives | 186 | Usually, @command{wydawca} is installed on the machine that receives |
189 | release uploads and is run periodically as a cron-job. It supposes | 187 | release uploads. It may be run either periodically as a cron-job, or |
190 | that both upload and distribution directories are accessible in the | 188 | as a standalone daemon. It supposes that both upload and distribution |
191 | local file system hierarchy. If that is not the case (e.g. if upload | 189 | directories are accessible in the local file system hierarchy. If that |
192 | and distribution sites are handled by different machines), one of them | 190 | is not the case (e.g. if upload and distribution sites are handled by |
193 | should be mounted using @acronym{NFS}. Future versions will contain | 191 | different machines), one of them should be mounted using |
194 | special provisions for that case. | 192 | @acronym{NFS}. Future versions will contain special provisions for |
195 | 193 | that case. | |
196 | @cindex directory pair | 194 | |
195 | @cindex spool | ||
197 | @cindex upload directory | 196 | @cindex upload directory |
198 | @cindex directory, upload | 197 | @cindex directory, upload |
199 | @cindex source directory | 198 | @cindex source directory |
@@ -202,11 +201,11 @@ special provisions for that case. | |||
202 | @cindex directory, distribution | 201 | @cindex directory, distribution |
203 | @cindex destination directory | 202 | @cindex destination directory |
204 | @cindex directory, destination | 203 | @cindex directory, destination |
205 | A configuration file supplies the utility with the set of | 204 | A configuration file defines a set of @dfn{spools}, i.e. pairs of |
206 | @dfn{directory pairs}, i.e. pairs of upload and corresponding | 205 | upload and corresponding distribution directories. In |
207 | distribution directories. In @command{wydawca} terminology, upload | 206 | @command{wydawca} terminology, upload directories are also called |
208 | directories are also called @dfn{source}, and distribution directories | 207 | @dfn{source}, and distribution directories -- @dfn{destination} |
209 | -- @dfn{destination} directories. The file also supplies all the information | 208 | directories. The file also supplies all the information |
210 | necessary to access user and project databases. | 209 | necessary to access user and project databases. |
211 | 210 | ||
212 | When started, @command{wydawca} scans each source directory and | 211 | When started, @command{wydawca} scans each source directory and |
@@ -254,12 +253,13 @@ this stage of the processing, the uploaded files are actually moved to | |||
254 | their destination directories, requested symbolic links are created, | 253 | their destination directories, requested symbolic links are created, |
255 | etc. | 254 | etc. |
256 | 255 | ||
257 | @node starting, configuring, overview, Top | 256 | @node starting |
258 | @chapter How to invoke @command{wydawca}. | 257 | @chapter How to invoke @command{wydawca}. |
259 | @cindex invocation | 258 | @cindex invocation |
260 | @anchor{config-file} | 259 | @anchor{config-file} |
261 | @xopindex{config-file, described} | 260 | @xopindex{config-file, described} |
262 | @sopindex{c, described} | 261 | @sopindex{c, described} |
262 | @UNREVISED{} | ||
263 | @command{Wydawca} gets all information it needs from its | 263 | @command{Wydawca} gets all information it needs from its |
264 | @dfn{configuration file} (@pxref{wydawca.rc}). The default | 264 | @dfn{configuration file} (@pxref{wydawca.rc}). The default |
265 | configuration file is @file{@var{sysconfdir}/wydawca.rc}, but if it is | 265 | configuration file is @file{@var{sysconfdir}/wydawca.rc}, but if it is |
@@ -292,8 +292,7 @@ the standard error. | |||
292 | @xopindex{cron, described} | 292 | @xopindex{cron, described} |
293 | Usually you will run @command{wydawca} as a cron job. In that case, | 293 | Usually you will run @command{wydawca} as a cron job. In that case, |
294 | it seldom needs any additional arguments, but we suggest to use | 294 | it seldom needs any additional arguments, but we suggest to use |
295 | @option{--cron} command line option anyway. Currently, its effect is | 295 | @option{--cron} command line option anyway. |
296 | the same as @option{--syslog}, but it may change in the future. | ||
297 | 296 | ||
298 | @anchor{debug} | 297 | @anchor{debug} |
299 | @xopindex{debug, described} | 298 | @xopindex{debug, described} |
@@ -334,179 +333,379 @@ $ wydawca -c new.cfg --dry-run | |||
334 | @option{--help} (@option{-h}) prints a short usage summary, and | 333 | @option{--help} (@option{-h}) prints a short usage summary, and |
335 | @option{--version} (@option{-v}) prints program version number. | 334 | @option{--version} (@option{-v}) prints program version number. |
336 | 335 | ||
337 | @node configuring, wydawca.rc, starting, Top | 336 | @node configuring |
338 | @chapter How to Configure @command{wydawca}. | 337 | @chapter How to Configure @command{wydawca}. |
339 | @UNREVISED | 338 | Upon startup, @command{wydawca} reads its settings from the |
340 | The @command{wydawca} configuration file has a simple line-oriented | 339 | @dfn{configuration file} @file{wydawca.rc}. By default it is located |
341 | syntax. Empty lines are ignored. Comments are introduced by a pound | 340 | in @var{$sysconfidr} (i.e., in most cases @file{/usr/local/etc}, or |
342 | sign (@samp{#}): everything starting from the first occurrence of | 341 | @file{/etc}), but an alternative location may be specified using |
343 | @samp{#} up to the end of line is ignored as well. Non-empty | 342 | @option{--config} command line option (@FIXME-pxref{--config}). |
344 | and non-comment lines must contain valid configuration statements. | 343 | |
345 | 344 | If any errors are encountered in the configuration file, the program | |
346 | A @dfn{configuration statement} consists of a @dfn{command word} | 345 | reports them on its error output and exits with a non-zero status. |
347 | optionally followed by one or more @dfn{arguments}, separated by any | 346 | |
348 | amount of whitespace. There are @samp{simple} and @samp{compound} | 347 | @xopindex{lint, introduced} |
349 | configuration statements. @dfn{Simple statements} occupy a single | 348 | To test the configuration file without starting the server use |
350 | line, for example: | 349 | @option{--lint} (@option{-t}) command line option. It causes |
350 | @command{wydawca} to check configuration file for syntax errors and | ||
351 | other inconsistencies and to exit with status 0 if no errors were | ||
352 | detected, and withs status 1 otherwise. | ||
353 | |||
354 | @opindex -E, introduced | ||
355 | @xopindex{no-preprocessor, introduced} | ||
356 | Before parsing, configuration file is preprocessed using | ||
357 | @command{m4} (@FIXME-pxref{Preprocessor}). To see the preprocessed | ||
358 | configuration without actually parsing it, use @option{-E} command | ||
359 | line option. To avoid preprocessing it, use | ||
360 | @option{--no-preprocessor} option. | ||
361 | |||
362 | @xopindex{config-help, introduced} | ||
363 | The rest of this section describes the configuration file syntax in | ||
364 | detail. You can receive a concise summary of all configuration | ||
365 | directives any time by running @command{wydawca --config-help}. | ||
366 | |||
367 | @menu | ||
368 | * Syntax:: Configuration file syntax. | ||
369 | * syslog:: | ||
370 | * sql:: | ||