INN commit: trunk (17 files)

INN Commit Russ_Allbery at isc.org
Mon Sep 3 09:17:40 UTC 2007


    Date: Monday, September 3, 2007 @ 02:17:40
  Author: iulius
Revision: 7665

* Mention that actsyncd uses mod-active if there are commands for ctlinnd.
* Add a warning in buffindexed.conf.pod not to mistake group.index in pathdb
  for group.index in pathoverview!
* Detabify perl-nocem.
* Fix almost all occurrences of hard-written paths (it is better to
  refer to inn.conf).

Modified:
  trunk/control/perl-nocem.in
  trunk/doc/pod/actsync.pod
  trunk/doc/pod/buffindexed.conf.pod
  trunk/doc/pod/cycbuff.conf.pod
  trunk/doc/pod/expireover.pod
  trunk/doc/pod/fastrm.pod
  trunk/doc/pod/hook-perl.pod
  trunk/doc/pod/inndf.pod
  trunk/doc/pod/makehistory.pod
  trunk/doc/pod/news.pod
  trunk/doc/pod/newsfeeds.pod
  trunk/doc/pod/nnrpd.pod
  trunk/doc/pod/ovdb_init.pod
  trunk/doc/pod/rc.news.pod
  trunk/doc/pod/readers.conf.pod
  trunk/doc/pod/tdx-util.pod
  trunk/doc/pod/tinyleaf.pod

------------------------------+
 control/perl-nocem.in        |    6 +++---
 doc/pod/actsync.pod          |    3 ++-
 doc/pod/buffindexed.conf.pod |   16 +++++++++-------
 doc/pod/cycbuff.conf.pod     |    8 ++++----
 doc/pod/expireover.pod       |    4 ++--
 doc/pod/fastrm.pod           |    6 +++---
 doc/pod/hook-perl.pod        |   10 ++++------
 doc/pod/inndf.pod            |    6 +++---
 doc/pod/makehistory.pod      |    2 +-
 doc/pod/news.pod             |    4 ++--
 doc/pod/newsfeeds.pod        |   13 +++++--------
 doc/pod/nnrpd.pod            |   12 ++++++------
 doc/pod/ovdb_init.pod        |   16 ++++++++--------
 doc/pod/rc.news.pod          |    8 ++++----
 doc/pod/readers.conf.pod     |    4 ++--
 doc/pod/tdx-util.pod         |    2 +-
 doc/pod/tinyleaf.pod         |    8 ++++----
 17 files changed, 63 insertions(+), 65 deletions(-)

Modified: control/perl-nocem.in
===================================================================
--- control/perl-nocem.in	2007-09-02 12:58:07 UTC (rev 7664)
+++ control/perl-nocem.in	2007-09-03 09:17:40 UTC (rev 7665)
@@ -382,9 +382,9 @@
     my $r;
     
     if ($nntp_open and time - $socket_timeout > $last_cancel) {
-	logmsg('Close socket for timeout');
-	close (NNTP);
-	$nntp_open = 0;
+        logmsg('Close socket for timeout');
+        close (NNTP);
+        $nntp_open = 0;
     }
     if (not $nntp_open) {
         use Socket;

Modified: doc/pod/actsync.pod
===================================================================
--- doc/pod/actsync.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/actsync.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -95,7 +95,8 @@
 run B<actsync>.  If a host is not initially reachable, the daemon will
 retry up to 9 additional times, waiting 6 minutes before each retry.  This
 daemon runs in the foreground, sending output to standard output and
-standard error.
+standard error.  It then uses mod-active(8) to update the F<active> file
+if there are commands for B<ctlinnd> in its output.
 
 If the B<-x> flag is given to B<actsyncd>, then C<ctlinnd xexec> will be
 used instead of a C<ctlinnd reload> to load the newly modified F<active>

Modified: doc/pod/buffindexed.conf.pod
===================================================================
--- doc/pod/buffindexed.conf.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/buffindexed.conf.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -15,7 +15,9 @@
 newsgroups.
 
 In addition to the buffers, buffindexed also stores information in a file
-named F<group.index> in I<pathdb>.  It contains information about each
+named F<group.index> in I<pathdb>.  (This file should not be mistaken for
+the one named F<group.index> in I<pathoverview> which is used by the
+tradindexed overview method.)  It contains information about each
 newsgroup:  the pointer to the index block for the newsgroup, the high
 mark, the low mark, the flag of the group, the number of articles, and so
 forth.  This file is created automatically when all buffers are
@@ -54,8 +56,8 @@
 
 An example of F<buffindexed.conf> file can be:
 
-    0:/usr/local/news/spool/overview/OV1:1536000
-    1:/usr/local/news/spool/overview/OV2:1536000
+    0:<pathoverview in inn.conf>/OV1:1536000
+    1:<pathoverview in inn.conf>/OV2:1536000
 
 When you first start B<innd> with everything configured properly, you
 should see messages like this in I<pathlog>/news.notice:
@@ -126,10 +128,10 @@
     base=`echo "$1" | sed 's%.*/%%'`
     major=`ls -Ll "$1" | awk '{print $5}' | tr -d ,`
     minor=`ls -Ll "$1" | awk '{print $6}`
-    mkdir -p /usr/local/news/spool/overview
-    mknod /usr/local/news/spool/overview/"$base" b "$major" "$minor"
-    chown news:news /usr/local/news/spool/overview/"$base"
-    chmod 644 /usr/local/news/spool/overview/"$base"
+    mkdir -p <pathoverview in inn.conf>
+    mknod <pathoverview>/"$base" b "$major" "$minor"
+    chown news:news <pathoverview>/"$base"
+    chmod 644 <pathoverview>/"$base"
 
 Make sure that the created files are owned by the news user and news
 group, as specified at configure time (the default being C<news> for

Modified: doc/pod/cycbuff.conf.pod
===================================================================
--- doc/pod/cycbuff.conf.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/cycbuff.conf.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -180,10 +180,10 @@
     base=`echo "$1" | sed 's%.*/%%'`
     major=`ls -Ll "$1" | awk '{print $5}' | tr -d ,`
     minor=`ls -Ll "$1" | awk '{print $6}`
-    mkdir -p /usr/local/news/spool/cycbuffs
-    mknod /usr/local/news/spool/cycbuffs/"$base" b "$major" "$minor"
-    chown news:news /usr/local/news/spool/cycbuffs/"$base"
-    chmod 644 /usr/local/news/spool/cycbuffs/"$base"
+    mkdir -p <pathspool in inn.conf>/cycbuffs
+    mknod <pathspool>/cycbuffs/"$base" b "$major" "$minor"
+    chown news:news <pathspool>/cycbuffs/"$base"
+    chmod 644 <pathspool>/cycbuffs/"$base"
 
 Make sure that the created files are owned by the news user and news
 group, as specified at configure time (the default being C<news> for

Modified: doc/pod/expireover.pod
===================================================================
--- doc/pod/expireover.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/expireover.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -131,8 +131,8 @@
 Sometimes it's convenient to manually expire a particular newsgroup,
 however.  This can be done with a command like:
 
-    echo example.test | expireover -f - -Z /usr/local/news/tmp/lowmark
-    ctlinnd lowmark /usr/local/news/tmp/lowmark
+    echo example.test | expireover -f - -Z <pathtmp in inn.conf>/lowmark
+    ctlinnd lowmark <pathtmp>/lowmark
 
 This can be particularly useful if a lot of articles in a particular group
 have expired but the overview information is still present, causing some

Modified: doc/pod/fastrm.pod
===================================================================
--- doc/pod/fastrm.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/fastrm.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -143,17 +143,17 @@
 B<fastrm> is typically invoked by INN via expirerm(8) using a command
 like:
 
-    fastrm -e /usr/local/news/spool/articles < expire.list
+    fastrm -e <patharticles in inn.conf> < expire.list
 
 To enable all optimizations and see the affect on the order of removal
 caused by B<-s>, use:
 
-    fastrm -d -s -e -u ~news/spool/articles < expire.list
+    fastrm -d -s -e -u <patharticles> < expire.list
 
 If your file system has indexed directory lookups, but you have a deeply
 nested directory structure, you may want to use a set of flags like:
 
-    fastrm -e -u3 ~news/spool/articles < expire.list
+    fastrm -e -u3 <patharticles> < expire.list
 
 to strongly prefer relative paths but not to use readdir(2) to order the
 calls to unlink(2).

Modified: doc/pod/hook-perl.pod
===================================================================
--- doc/pod/hook-perl.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/hook-perl.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -33,8 +33,7 @@
 in F<include/inn/paths.h>, by default F<startup_innd.pl>) and then loads the
 file INN_PATH_PERL_FILTER_INND (also defined in F<include/inn/paths.h>, by
 default F<filter_innd.pl>).  Both of these files must be located in the
-directory specified by pathfilter in F<inn.conf>
-(F</usr/local/news/bin/filter> by default).  The default directory for
+directory specified by I<pathfilter> in F<inn.conf>.  The default directory for
 filter code can be specified at configure time by giving the flag
 B<--with-filter-dir> to configure.
 
@@ -278,10 +277,9 @@
 Whenever Perl support is needed in nnrpd, it first loads the file
 INN_PATH_PERL_FILTER_NNRPD (defined in F<include/inn/paths.h>, by default
 F<filter_nnrpd.pl>).  This file must be located in the directory
-specified by pathfilter in F<inn.conf> (F</usr/local/news/bin/filter>
-by default).  The default directory for filter code can be specified
-at configure time by giving the flag B<--with-filter-dir> to
-configure.
+specified by I<pathfilter> in F<inn.conf>.  The default directory for
+filter code can be specified at configure time by giving the flag
+B<--with-filter-dir> to configure.
 
 If F<filter_nnrpd.pl> loads successfully and defines the Perl function
 filter_post(), Perl filtering is turned on.  Otherwise, it's turned off.

Modified: doc/pod/inndf.pod
===================================================================
--- doc/pod/inndf.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/inndf.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -42,7 +42,7 @@
 
 =item B<-F>
 
-Like B<-f> execpt that the filename is I<pathetc>/filesystems and it is
+Like B<-f> except that the filename is I<pathetc>/filesystems and it is
 not an error if this file doesn't exist.  (This option is used primarily
 by such things as innstat(8), so that the news administrator can add
 additional file systems to check to I<pathetc>/filesystems without having
@@ -74,11 +74,11 @@
 
 =head1 EXAMPLES
 
-Print the free kilobytes in /news/spool as a simple number:
+Print the free kilobytes in F</news/spool> as a simple number:
 
     inndf /news/spool
 
-Report the free inodes in /usr/local/news and /news/spool in a format
+Report the free inodes in F</usr/local/news> and F</news/spool> in a format
 designed for human readability:
 
     inndf -i /usr/local/news /news/spool

Modified: doc/pod/makehistory.pod
===================================================================
--- doc/pod/makehistory.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/makehistory.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -147,7 +147,7 @@
 entries from the old history file that correspond to rejected articles or
 expired articles, follow the above command with:
 
-    cd /usr/local/news/db
+    cd <pathdb>
     awk 'NF == 2 { print }' < history >> history.n
 
 (replacing the path with your I<pathdb>, if it isn't the default).  Then

Modified: doc/pod/news.pod
===================================================================
--- doc/pod/news.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/news.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -749,9 +749,9 @@
 and the overview information, but some of its options have been changed.
 To rebuild the history and overview files, use something like:
 
-    makehistory -b -f history.n -O -T/usr/local/news/tmp -l 600000
+    makehistory -b -f history.n -O -T /usr/local/news/tmp -l 600000
 
-(change the /usr/local/news/tmp path to some directory that has plenty of
+(change the F</usr/local/news/tmp> path to some directory that has plenty of
 temporary space, and leave off -O if you're running a transit-only server
 and don't intend to expire based on group name, and therefore don't need
 overview.)  Or if your overview is buffindexed, use:

Modified: doc/pod/newsfeeds.pod
===================================================================
--- doc/pod/newsfeeds.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/newsfeeds.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -638,10 +638,6 @@
 
 =head1 EXAMPLES
 
-All of the following examples assume that INN was installed with a prefix
-of F</usr/local/news>; if you installed it somewhere else, modify the
-paths as appropriate.
-
 The syntax of the F<newsfeeds> file is so complex because you can specify
 a staggering variety of feeds.  INN is capable of interacting with a wide
 variety of programs that do various things with news articles.  Far and
@@ -671,9 +667,10 @@
 rather than C<feed.example.com>.
 
 The typical feed entry for innfeed(8) is a good example of a channel feed
-that's the target of various funnel feeds:
+that's the target of various funnel feeds (make sure the path to B<innfeed>
+is properly set):
 
-    innfeed!:!*:Tc,Wnm*:/usr/local/news/bin/innfeed -y
+    innfeed!:!*:Tc,Wnm*:<pathbin in inn.conf>/innfeed -y
 
 Note that the I<pattern> for this feed is just C<!*> so that it won't
 receive any articles directly.  The feed should only receive those
@@ -723,11 +720,11 @@
 which will mail the article to both Peter and Sue.
 
 Finally, another very useful example of a channel feed:  the standard
-entry for controlchan(8).
+entry for controlchan(8).  Make sure its path is properly set.
 
     controlchan!\
         :!*,control,control.*,!control.cancel/!collabra-internal\
-        :Tc,Wnsm:/usr/local/news/bin/controlchan
+        :Tc,Wnsm:<pathbin in inn.conf>/controlchan
 
 This program only wants information about articles posted to a control
 newsgroup other than control.cancel, which due to the sorting of control

Modified: doc/pod/nnrpd.pod
===================================================================
--- doc/pod/nnrpd.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/nnrpd.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -172,12 +172,12 @@
 the default path by running C<make cert> after C<make install> when
 installing INN, or by running the following commands:
 
-    openssl req -new -x509 -nodes -out /usr/local/news/lib/cert.pem \
-        -days 366 -keyout /usr/local/news/lib/key.pem
-    chown news:news /usr/local/news/lib/cert.pem
-    chmod 640 /usr/local/news/lib/cert.pem
-    chown news:news /usr/local/news/lib/key.pem
-    chmod 600 /usr/local/news/lib/key.pem
+    openssl req -new -x509 -nodes -out <pathnews>/lib/cert.pem \
+        -days 366 -keyout <pathnews>/lib/key.pem
+    chown news:news <pathnews>/lib/cert.pem
+    chmod 640 <pathnews>/lib/cert.pem
+    chown news:news <pathnews>/lib/key.pem
+    chmod 600 <pathnews>/lib/key.pem
 
 Replace the paths with something appropriate to your INN installation.
 This will create a self-signed certificate that will expire in a year.

Modified: doc/pod/ovdb_init.pod
===================================================================
--- doc/pod/ovdb_init.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/ovdb_init.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -99,33 +99,33 @@
 
 =item 1
 
-Build and install the S<Berkeley DB 3.1.17>
+Build and install the S<Berkeley DB 3.1.17>;
 
 =item 2
 
 Run configure in the INN source tree and make sure it picks up the
-right S<Berkeley DB> directory (e.g., /usr/local/BerkeleyDB.3.1)
+right S<Berkeley DB> directory (e.g., F</usr/local/BerkeleyDB.3.1>);
 
 =item 3
 
-Do a C<make>
+Do a C<make>;
 
 =item 4
 
-Shut down INN (e.g., with C<rc.news stop>).  Be sure to kill all nnrpds as
-well.
+Shut down INN (e.g., with C<rc.news stop>) and be sure to kill all
+instances of B<nnrpd> as well;
 
 =item 5
 
-Do a C<make update> to install the new binaries.
+Do a C<make update> to install the new binaries;
 
 =item 6
 
-Run C<ovdb_init -u> as the news user.
+Run C<ovdb_init -u> as the news user;
 
 =item 7
 
-Start INN with C<rc.news>
+Start INN with C<rc.news>.
 
 =back
 

Modified: doc/pod/rc.news.pod
===================================================================
--- doc/pod/rc.news.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/rc.news.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -63,16 +63,16 @@
 
 To start INN and leave certain error messages going to the terminal:
 
-       su - news -c ~news/bin/rc.news
+       su - news -c <pathbin in inn.conf>/rc.news
 
 To run INN at startup time from appropriate system boot scripts:
 
-       su - news -c ~news/bin/rc.news >/dev/console
+       su - news -c <pathbin>/rc.news >/dev/console
 
 To stop INN (throttling first):
 
-       ~news/bin/ctlinnd throttle reason
-       su - news -c '~news/bin/rc.news stop'
+       <pathbin>/ctlinnd throttle reason
+       su - news -c '<pathbin>/rc.news stop'
 
 =head1 BUGS
 

Modified: doc/pod/readers.conf.pod
===================================================================
--- doc/pod/readers.conf.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/readers.conf.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -615,7 +615,7 @@
 usernames and passwords, and then against the system shadow password file:
 
     auth all {
-        auth: "ckpasswd -d /usr/local/news/db/newsusers"
+        auth: "ckpasswd -d <pathdb in inn.conf>/newsusers"
         auth: "ckpasswd -s"
     }
 
@@ -665,7 +665,7 @@
 cannot.
 
     auth default {
-        auth: "ckpasswd -f /usr/local/news/db/newsusers"
+        auth: "ckpasswd -f <pathdb in inn.conf>/newsusers"
         default: <FAIL>
         default-domain: example.com
     }

Modified: doc/pod/tdx-util.pod
===================================================================
--- doc/pod/tdx-util.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/tdx-util.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -219,7 +219,7 @@
 Rebuild the overview information for example.test from a traditional spool
 directory:
 
-    tdx-util -R /news/spool/articles/example/test -n example.test
+    tdx-util -R <patharticles in inn.conf>/example/test -n example.test
 
 The last command may be useful for recovering from a bad crash or
 corrupted overview information for a particular group, if you are also

Modified: doc/pod/tinyleaf.pod
===================================================================
--- doc/pod/tinyleaf.pod	2007-09-02 12:58:07 UTC (rev 7664)
+++ doc/pod/tinyleaf.pod	2007-09-03 09:17:40 UTC (rev 7665)
@@ -57,14 +57,14 @@
 Then, add a line like:
 
     nntp stream tcp nowait archive /usr/sbin/tcpd \
-      /usr/local/bin/tinyleaf /var/spool/tinyleaf /usr/local/bin/archive
+      <pathbin>/tinyleaf <pathspool>/tinyleaf <pathbin>/archive
 
 (all on one line S<-- the> backslash and split in this line is just for
 readability) where C<archive> is the user that owns the archive,
-C</usr/sbin/tcpd> is the path to tcpd(8), C</usr/local/bin/tinyleaf> is
-the path to this program, F</var/spool/tinyleaf> is some scratch directory
+F</usr/sbin/tcpd> is the path to tcpd(8), I<pathbin>/tinyleaf is
+the path to this program, I<pathspool>/tinyleaf is some scratch directory
 that the user C<archive> has write access to, and
-C</usr/local/bin/archive> is the path to your archive script.
+I<pathbin>/archive is the path to your B<archive> script.
 
 You can now restrict access to B<tinyleaf> to just your local news server
 with C</etc/hosts.allow> and C</etc/hosts.deny> and set up an ordinary



More information about the inn-committers mailing list