INN commit: trunk (backends/send-uucp.in control/perl-nocem.in)

Thu Aug 30 19:20:38 UTC 2007

Date: Thursday, August 30, 2007 @ 12:20:38
  Author: iulius
Revision: 7661

Improve POD documentation (FILES section, paths and a typo).

Modified:
  trunk/backends/send-uucp.in
  trunk/control/perl-nocem.in

-----------------------+
 backends/send-uucp.in |   42 +++++++++++++++++++++++-------------------
 control/perl-nocem.in |   32 ++++++++++++++++++++++----------
 2 files changed, 45 insertions(+), 29 deletions(-)

Modified: backends/send-uucp.in
===================================================================

--- backends/send-uucp.in	2007-08-26 08:40:21 UTC (rev 7660)
+++ backends/send-uucp.in	2007-08-30 19:20:38 UTC (rev 7661)
@@ -266,7 +266,7 @@
 
 The B<send-uucp> program processes batch files written by innd(8) to send
 Usenet articles to UUCP sites.  It reads a configuration file to control how
-it behaves with various sites.  Normally, it's run periodically out of cron
+it behaves with various sites.  Normally, it is run periodically out of cron
 to put together batches and send them to remote UUCP sites.
 
 It makes it possible to reduce bandwidth usage and to send news to remote
@@ -283,8 +283,8 @@
 =head1 CONFIGURATION
 
 The sites to which articles are to be sent must be configured in the
-configuration file F<send-uucp.cf>.  Each site is specified with a line of
-the form:
+configuration file F<send-uucp.cf> in I<pathetc> as set in F<inn.conf>.  Each
+site is specified with a line of the form:
 
     site[:host[:funnel]] [compressor [maxsize [batchtime]]]
 
@@ -335,7 +335,7 @@
 
 =head1 EXAMPLE
 
-Here is an example F<send-uucp.cf> configuration file:
+Here is an example for the F<send-uucp.cf> configuration file:
 
     zoetermeer      gzip            1048576         5,18,22
     hoofddorp       gzip            1048576         5,18,22
@@ -348,16 +348,24 @@
 
 This defines eight UUCP sites.  The first three use C<gzip> compression, the
 following site uses C<bzip2> and the last three use C<compress>.  The first
-six use a batch size of 1MB, and the last site ("able") uses the default of
-500,000 bytes.  The "zoetermeer", "hoofddorp", "pa3ebv", and "manhole" sites
+six use a batch size of 1 MB, and the last site (C<able>) uses the default of
+500,000 bytes.  The C<zoetermeer>, C<hoofddorp>, C<pa3ebv>, and C<manhole> sites
 will only have batches generated for them during the hours of 05:00, 18:00,
-and 22:00, and the "drinkel" site will only have batches generated during those
+and 22:00, and the C<drinkel> site will only have batches generated during those
 hours and 06:00, 20:00, 00:00, and 02:00.  There are no restrictions on when
-batches will be generated for "owl" or "able".
+batches will be generated for C<owl> or C<able>.
 
-The "pern" site is configured as a funnel into C<MYFUNNEL!>.  B<send-uucp> will
+The C<pern> site is configured as a funnel into C<MYFUNNEL!>.  B<send-uucp> will
 issue C<ctlinnd flush MYFUNNEL!> instead of C<ctlinnd flush pern>.
 
+As for the F<newsfeeds> file, the usual flags used for a UUCP feed are
+C<Tf,Wnb>.  Here is a typical entry for C<zoetermeer>, where the batching
+is kept between 4 KB and 1 KB:
+
+    zoetermeer\
+        :*,!junk,!control/!foo\
+        :Tf,Wnb,B4096/1024:
+
 =head1 FILES
 
 =over 4
@@ -368,23 +376,19 @@
 
 =item I<pathetc>/send-uucp.cf
 
-Configuration file specifying a list of sites to be processed.
+The configuration file which specifies a list of sites to be processed.
 
 =back
 
-=head1 NOTES
+=head1 HISTORY
 
-The usual flags used for a UUCP feed in the F<newsfeeds> file are C<Tf,Wnb>.
+This program was originally written by Edvard Tuinder <ed at elm.net> and then
+maintained and extended by Miquel van Smoorenburg <miquels at cistron.nl>.
+Marco d'Itri <md at linux.it> cleaned up the code for inclusion in INN.  This
+manual page was written by Mark Brown <broonie at sirena.org.uk>.
 
 =head1 SEE ALSO
 
 innd(8), newsfeeds(5), uucp(8).
 
-=head1 AUTHOR
-
-This program was originally written by Edvard Tuinder <ed at elm.net> and then
-maintained and extended by Miquel van Smoorenburg <miquels at cistron.nl>.
-Marco d'Itri <md at linux.it> cleaned up the code for inclusion in INN.  This
-manual page was written by Mark Brown <broonie at sirena.org.uk>.
-
 =cut

Modified: control/perl-nocem.in
===================================================================
--- control/perl-nocem.in	2007-08-26 08:40:21 UTC (rev 7660)
+++ control/perl-nocem.in	2007-08-30 19:20:38 UTC (rev 7661)
@@ -520,17 +520,17 @@
 Import the keys of the NoCeM issuers you trust in order to check
 the authenticity of their notices.  You can do:
 
-    gpg --primary-keyring /usr/local/news/etc/pgp/ncmring.gpg --import
-        <key-file>
+    gpg --primary-keyring <pathetc>/pgp/ncmring.gpg --import <key-file>
 
-where <key-file> is the file containing the key(s) to import.  The keyring
+where <pathetc> is the value of the I<pathetc> parameter set in F<inn.conf>
+and <key-file> the file containing the key(s) to import.  The keyring
 must be located in I<pathetc>/pgp/ncmring.gpg (create the directory
 before using B<gpg>).  For old PGP-generated keys, you may have to use
 B<--allow-non-selfsigned-uid> if they are not properly self-signed,
 but anyone creating a key really should self-sign the key.  Current
 PGP implementations do this automatically.
 
-The keys of NoCeM issuers can be found in the web site of I<The NoCem Registry>:
+The keys of NoCeM issuers can be found in the web site of I<The NoCeM Registry>:
 L<http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html>.  You can even
 download there a unique file which contains all the keys.
 
@@ -548,7 +548,7 @@
 criteria specified after the colon.
 
 You will also find information about that on the web site of
-I<The NoCem Registry>.
+I<The NoCeM Registry>.
 
 =item 3.
 
@@ -557,9 +557,9 @@
 news.lists.filter:
 
     nocem!:!*,alt.nocem.misc,news.lists.filter\
-        :Tc,Wf,Ap:/usr/local/news/bin/perl-nocem
+        :Tc,Wf,Ap:<pathbin>/perl-nocem
 
-with the correct path to B<perl-nocem>, located in I<pathbin>.  Then, reload
+with the correct path to B<perl-nocem>, located in <pathbin>.  Then, reload
 the F<newsfeeds> file (C<ctlinnd reload newsfeeds 'NoCeM channel feed'>).
 
 Note that you should at least carry news.lists.filters on your news
@@ -581,10 +581,22 @@
 
 =head1 FILES
 
-/usr/local/news/bin/perl-nocem
-/usr/local/news/etc/nocem.ctl
-/usr/local/news/etc/pgp/ncmring.gpg
+=over 4
 
+=item I<pathbin>/perl-nocem
+
+The Perl script itself used to process NoCeM notices.
+
+=item I<pathetc>/nocem.ctl
+
+The configuration file which specifies the NoCeM notices to be processed.
+
+=item I<pathetc>/pgp/ncmring.gpg
+
+The keyring which contains the public keys of trusted NoCeM issuers.
+
+=back
+
 =head1 BUGS
 
 The Subject: header is not checked for the @@NCM string and there is no

