INN commit: trunk (10 files)
INN Commit
Russ_Allbery at isc.org
Sun Aug 26 08:31:50 UTC 2007
Date: Sunday, August 26, 2007 @ 01:31:50
Author: iulius
Revision: 7659
New POD documentation for newslog(5), scanlogs(8) and tally.control(8)
based upon previous nroff documentation. Proof-reading, bunch of
updates and new presentation.
Added:
trunk/doc/pod/newslog.pod
trunk/doc/pod/scanlogs.pod
trunk/doc/pod/tally.control.pod
Modified:
trunk/MANIFEST
trunk/doc/man/ (properties)
trunk/doc/man/Makefile
trunk/doc/pod/Makefile
Deleted:
trunk/doc/man/newslog.5
trunk/doc/man/scanlogs.8
trunk/doc/man/tally.control.8
---------------------------+
MANIFEST | 3
doc/man/Makefile | 4
doc/man/newslog.5 | 227 -------------------------------------------
doc/man/scanlogs.8 | 41 -------
doc/man/tally.control.8 | 29 -----
doc/pod/Makefile | 11 +-
doc/pod/newslog.pod | 230 ++++++++++++++++++++++++++++++++++++++++++++
doc/pod/scanlogs.pod | 67 ++++++++++++
doc/pod/tally.control.pod | 57 ++++++++++
9 files changed, 367 insertions(+), 302 deletions(-)
Modified: MANIFEST
===================================================================
--- MANIFEST 2007-08-26 08:20:53 UTC (rev 7658)
+++ MANIFEST 2007-08-26 08:31:50 UTC (rev 7659)
@@ -295,6 +295,7 @@
doc/pod/news.pod Master file for NEWS
doc/pod/newsfeeds.pod Master file for newsfeeds.5
doc/pod/newsgroups.pod Master file for newsgroups.5
+doc/pod/newslog.pod Master file for newslog.5
doc/pod/ninpaths.pod Master file for ninpaths.8
doc/pod/nnrpd.pod Master file for nnrpd.8
doc/pod/ovdb.pod Master file for ovdb.5
@@ -312,11 +313,13 @@
doc/pod/readers.conf.pod Master file for readers.conf.5
doc/pod/readme.pod Master file for README
doc/pod/rnews.pod Master file for rnews.1
+doc/pod/scanlogs.pod Master file for scanlogs.8
doc/pod/sendinpaths.pod Master file for sendinpaths.8
doc/pod/simpleftp.pod Master file for simpleftp.1
doc/pod/sm.pod Master file for sm.1
doc/pod/storage.conf.pod Master file for storage.conf.5
doc/pod/subscriptions.pod Master file for subscriptions.5
+doc/pod/tally.control.pod Master file for tally.control.8
doc/pod/tdx-util.pod Master file for tdx-util.8
doc/pod/tinyleaf.pod Master file for tinyleaf.8
doc/pod/tst.pod Master file for tst.3
Property changes on: trunk/doc/man
___________________________________________________________________
Name: svn:ignore
- active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
auth_smb.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
control.ctl.5
convdate.1
ctlinnd.8
cycbuff.conf.5
distrib.pats.5
domain.8
expire.ctl.5
expireover.8
fastrm.1
getlist.1
grephistory.1
ident.8
inews.1
inn.conf.5
innbind.8
innconfval.1
innd.8
inndf.8
innmail.1
innupgrade.8
libauth.3
libinnhist.3
list.3
mailpost.8
makehistory.8
moderators.5
motd.news.5
newsfeeds.5
newsgroups.5
ninpaths.8
nnrpd.8
ovdb.5
ovdb_init.8
ovdb_monitor.8
ovdb_server.8
ovdb_stat.8
overchan.8
passwd.nntp.5
perl-nocem.8
pgpverify.1
pullnews.1
qio.3
radius.8
radius.conf.5
rc.news.8
readers.conf.5
rnews.1
sasl.conf.5
send-uucp.8
sendinpaths.8
simpleftp.1
sm.1
storage.conf.5
subscriptions.5
tdx-util.8
tinyleaf.8
tst.3
uwildmat.3
+ active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
auth_smb.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
control.ctl.5
convdate.1
ctlinnd.8
cycbuff.conf.5
distrib.pats.5
domain.8
expire.ctl.5
expireover.8
fastrm.1
getlist.1
grephistory.1
ident.8
inews.1
inn.conf.5
innbind.8
innconfval.1
innd.8
inndf.8
innmail.1
innupgrade.8
libauth.3
libinnhist.3
list.3
mailpost.8
makehistory.8
moderators.5
motd.news.5
newsfeeds.5
newslog.5
newsgroups.5
ninpaths.8
nnrpd.8
ovdb.5
ovdb_init.8
ovdb_monitor.8
ovdb_server.8
ovdb_stat.8
overchan.8
passwd.nntp.5
perl-nocem.8
pgpverify.1
pullnews.1
qio.3
radius.8
radius.conf.5
rc.news.8
readers.conf.5
rnews.1
sasl.conf.5
scanlogs.8
send-uucp.8
sendinpaths.8
simpleftp.1
sm.1
storage.conf.5
subscriptions.5
tally.control.8
tdx-util.8
tinyleaf.8
tst.3
uwildmat.3
Modified: doc/man/Makefile
===================================================================
--- doc/man/Makefile 2007-08-26 08:20:53 UTC (rev 7658)
+++ doc/man/Makefile 2007-08-26 08:31:50 UTC (rev 7659)
@@ -14,14 +14,14 @@
SEC5 = active.5 active.times.5 buffindexed.conf.5 control.ctl.5 \
cycbuff.conf.5 distrib.pats.5 expire.ctl.5 history.5 incoming.conf.5 \
inn.conf.5 innfeed.conf.5 innwatch.ctl.5 moderators.5 motd.news.5 \
- newsfeeds.5 nnrpd.track.5 newslog.5 nntpsend.ctl.5 ovdb.5 \
+ newsfeeds.5 newsgroups.5 newslog.5 nnrpd.track.5 nntpsend.ctl.5 ovdb.5 \
overview.fmt.5 passwd.nntp.5 radius.conf.5 readers.conf.5 \
storage.conf.5 subscriptions.5
SEC8 = actsync.8 archive.8 auth_smb.8 batcher.8 buffchan.8 ckpasswd.8 \
cnfsheadconf.8 cnfsstat.8 controlchan.8 ctlinnd.8 cvtbatch.8 \
domain.8 expire.8 expireover.8 expirerm.8 filechan.8 ident.8 \
- inncheck.8 innbind.8 innd.8 inndf.8 innreport.8 innstat.8 \
+ innbind.8 inncheck.8 innd.8 inndf.8 innreport.8 innstat.8 \
innupgrade.8 innwatch.8 innxbatch.8 innxmit.8 mailpost.8 makedbz.8 \
makehistory.8 mod-active.8 news.daily.8 news2mail.8 ninpaths.8 \
nnrpd.8 nntpsend.8 ovdb_init.8 ovdb_monitor.8 ovdb_server.8 \
Deleted: doc/man/newslog.5
===================================================================
--- doc/man/newslog.5 2007-08-26 08:20:53 UTC (rev 7658)
+++ doc/man/newslog.5 2007-08-26 08:31:50 UTC (rev 7659)
@@ -1,227 +0,0 @@
-.TH NEWSLOG 5
-.SH NAME
-newslog \- description of Usenet log files
-.SH DESCRIPTION
-Most log files created by Usenet programs reside in the
-.I <pathlog in inn.conf>
-directory and have a ``.log'' extension.
-Several versions are usually kept with an additional extension such as ``.1'',
-``.2'', etc. \(em the higher the number, the older the log.
-The older versions may be compressed and thus may have a ``.1.gz'',
-``.2.gz'', etc. extension.
-.PP
-The
-.I scanlogs
-script and related utilities (see
-.IR scanlogs (8))
-are responsible for rotating and compressing these files.
-.PP
-Some log files always have data, others only have data if there is a
-problem, and others are only created if a particular program is used
-or configuration parameter is set.
-The
-.I innstat
-script (see
-.IR innstat (8))
-monitors the size of all log files.
-.PP
-The following files will only accumulate data under the direction of
-.IR control.ctl (5):
-.sp 1
-.RS
-control.log
-miscctl.log
-newgroup.log
-rmgroup.log
-unwanted.log
-.RE
-.sp 1
-In order to create these files, the ``message'' and ``action'' fields of
-.I control.ctl
-should be chosen from the following table:
-.sp 1
-.RS
-.nf
-.ta \w'newgroup 'u +\w'doit=newgroup 'u
-Message Action Meaning
-all log=miscctl Log all messages by default
-default log=miscctl Log unknown messages
-newgroup doit=newgroup Create group and log message
-newgroup log=newgroup Log message
-rmgroup doit=rmgroup Remove group and log message
-rmgroup log=rmgroup Log message
-``other'' doit=miscctl log and process the message
-``other'' log=miscctl Log message
-.fi
-.RE
-.sp 1
-Here, ``other'' refers to any other control message such as:
-.sp 1
-.RS
-.nf
-checkgroups
-ihave
-sendme
-sendsys
-senduuname
-version
-.fi
-.RE
-.PP
-The following is a list of log files:
-.TP
-.I control.log
-This file maintains a count of the number of newgroup and rmgroup control
-messages seen for each newsgroup.
-The count is of the number of control messages with the indicated
-arguments, regardless if they were actually processed.
-All control arguments, including invalid ones, are counted.
-This file is updated by
-.IR tally.control ,
-which is invoked by
-.I scanlogs
-if either the newgroup or rmgroup logs exist.
-This file is not rotated.
-.TP
-.I errlog
-This file contains the standard output and standard error of any program
-spawned by
-.IR innd (8),
-such as channel feeds configured in
-.IR newsfeeds .
-This file should normally be empty.
-.I Scanlogs
-will print the entire contents of this log file if it is non-empty.
-.TP
-.I expire.log
-By default, when
-.I news.daily
-is going to expire old news articles, it writes the date to this file,
-followed by any output from
-.IR expire (8)
-and the ending date.
-All lines but the first are indented four spaces.
-.TP
-.I miscctl.log
-When
-.I control.ctl
-is configured as described above, all control messages except newgroup
-and rmgroup are appended to this file by
-.IR writelog .
-There will be a summary line describing the message and the action
-taken, followed by the article indented by four spaces, and a blank line.
-.TP
-.I newgroup.log
-When
-.I control.ctl
-is configured as described above, all newgroup messages are appended
-to this file using the same format as for
-.IR miscctl.log .
-.TP
-.I news
-This file logs articles received by
-.IR innd .
-.I Scanlogs
-summarizes the rejected articles reported in this file.
-.TP
-.I news.crit
-All critical error messages issued by
-.I innd
-are appended to this file via
-.IR syslog (3).
-This log file should be empty.
-.I Scanlogs
-will print the entire contents of this log file if it is non-empty.
-You should have the following line in your system
-.I syslog.conf
-file, using a tab character for the delimiter:
-.sp 1
-.RS
-.RS
-news.crit <pathlog in inn.conf>/news.crit
-.RE
-.RE
-.sp 1
-(A typical entry is shown; it should agree with
-.I <pathlog in inn.conf>.)
-.TP
-.I news.err
-All major error messages issued by
-.I innd
-are appended to this file via
-.IR syslog (3).
-This log file should be empty.
-.I Scanlogs
-will print the entire contents of this log file if it is non-empty.
-You should have the following line in your system
-.I syslog.conf
-file, using a tab character for the delimiter:
-.sp 1
-.RS
-.RS
-news.err <pathlog in inn.conf>/news.err
-.RE
-.RE
-.sp 1
-(A typical entry is shown; it should agree with
-.I <pathlog in inn.conf>.)
-.TP
-.I news.notice
-All standard error messages and status messages issued by
-.I innd
-are appended to this file via
-.IR syslog (3).
-.I Scanlogs
-uses the
-.IR perl (1)
-script
-.IR innreport (8)
-to summarize this file.
-You should have the following line in your system
-.I syslog.conf
-file, using a tab character for the delimiter:
-.sp 1
-.RS
-.RS
-news.notice <pathlog in inn.conf>/news.notice
-.RE
-.RE
-(A typical entry is shown; it should agree with
-.I <pathlog in inn.conf>.)
-.TP
-.I nntpsend.log
-The
-.IR nntpsend (8)
-programs appends all status messages to this file.
-.TP
-.I rmgroup.log
-When
-.I control.ctl
-is configured as described above, all rmgroup messages are appended to this
-file using the same format as for
-.IR miscctl.log .
-.TP
-.I unwanted.log
-This log maintains a count of the number of articles that were rejected
-because they were posted to newsgroups that do not exist at the local site.
-This file is updated by
-.I tally.unwanted
-and maintained in reverse numeric order (the most popular rejected group
-first).
-This file is not rotated.
-.SH HISTORY
-Written by Landon Curt Noll <chongo at toad.com> and Rich $alz
-<rsalz at uunet.uu.net> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-control.ctl(5),
-ctlinnd(8),
-expire(8),
-inn.conf(5),
-innd(8),
-news.daily(8),
-nntpsend(8),
-syslog.conf(5).
Deleted: doc/man/scanlogs.8
===================================================================
--- doc/man/scanlogs.8 2007-08-26 08:20:53 UTC (rev 7658)
+++ doc/man/scanlogs.8 2007-08-26 08:31:50 UTC (rev 7659)
@@ -1,41 +0,0 @@
-.TH SCANLOGS 8
-.SH NAME
-scanlogs \- summarize INN log files.
-.SH SYNOPSIS
-.B scanlogs
-[
-.B norotate
-]
-.SH DESCRIPTION
-.I Scanlogs
-summarizes the information recorded in the INN log files (see
-.IR newslog (5)).
-By default, it also rotates and cleans out the logs.
-It is normally invoked by the
-.IR news.daily (8)
-script.
-.SH KEYWORDS
-.PP
-The following keywords are accepted:
-.TP
-.I norotate
-Using this keyword disables the rotating and cleaning aspect of the log
-processing: the logs files are only scanned for information and no contents
-are altered.
-.PP
-If
-.I scanlogs
-is invoked more than once a day, the ``norotate'' keyword should be used
-to prevent premature log cleaning.
-.SH HISTORY
-Written by Landon Curt Noll <chongo at toad.com> and Rich $alz
-<rsalz at uunet.uu.net> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-innd(8),
-newslog(5),
-news.daily(8),
-nnrpd(8).
Deleted: doc/man/tally.control.8
===================================================================
--- doc/man/tally.control.8 2007-08-26 08:20:53 UTC (rev 7658)
+++ doc/man/tally.control.8 2007-08-26 08:31:50 UTC (rev 7659)
@@ -1,29 +0,0 @@
-.TH TALLY.CONTROL 8
-.SH NAME
-tally.control \- keep track of newsgroup creations and deletions.
-.SH SYNOPSIS
-tally.control
-.SH DECSRIPTION
-tally.control is normally invoked by
-.IR scanlogs (8).
-It
-reads its standard input, which should be the
-.I newgroup.log
-and
-.I rmgroup.log
-log files.
-It updates the cumulative list of newsgroup creations and deletions,
-.IR control.log .
-.SH HISTORY
-Written by Landon Curt Noll <chongo at toad.com> and Rich $alz
-<rsalz at uunet.uu.net> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-newslog(5),
-news.daily(8),
-scanlogs(8),
-tally.unwanted(8),
-writelog(8).
Modified: doc/pod/Makefile
===================================================================
--- doc/pod/Makefile 2007-08-26 08:20:53 UTC (rev 7658)
+++ doc/pod/Makefile 2007-08-26 08:31:50 UTC (rev 7659)
@@ -21,7 +21,8 @@
MAN5 = ../man/active.5 ../man/active.times.5 ../man/buffindexed.conf.5 \
../man/control.ctl.5 ../man/cycbuff.conf.5 ../man/distrib.pats.5 \
../man/expire.ctl.5 ../man/inn.conf.5 ../man/moderators.5 \
- ../man/motd.news.5 ../man/newsfeeds.5 ../man/newsgroups.5 ../man/ovdb.5 \
+ ../man/motd.news.5 ../man/newsfeeds.5 ../man/newsgroups.5 \
+ ../man/newslog.5 ../man/ovdb.5 \
../man/passwd.nntp.5 ../man/radius.conf.5 ../man/readers.conf.5 \
../man/storage.conf.5 ../man/subscriptions.5
@@ -33,7 +34,8 @@
../man/mailpost.8 ../man/makehistory.8 ../man/ninpaths.8 \
../man/ovdb_init.8 ../man/ovdb_monitor.8 ../man/ovdb_server.8 \
../man/ovdb_stat.8 ../man/overchan.8 ../man/radius.8 \
- ../man/rc.news.8 ../man/sendinpaths.8 ../man/tdx-util.8 \
+ ../man/rc.news.8 ../man/scanlogs.8 ../man/sendinpaths.8 \
+ ../man/tally.control.8 ../man/tdx-util.8 \
../man/tinyleaf.8
ALL = $(TEXT) $(MAN1) $(MAN3) $(MAN5) $(MAN8)
@@ -82,9 +84,10 @@
../man/expire.ctl.5: expire.ctl.pod ; $(POD2MAN) -s 5 $? > $@
../man/inn.conf.5: inn.conf.pod ; $(POD2MAN) -s 5 $? > $@
../man/moderators.5: moderators.pod ; $(POD2MAN) -s 5 $? > $@
-../man/motd.news.5: motd.news.pod ; $(POD2MAN) -s 5 $? > $@
+../man/motd.news.5: motd.news.pod ; $(POD2MAN) -s 5 $? > $@
../man/newsfeeds.5: newsfeeds.pod ; $(POD2MAN) -s 5 $? > $@
../man/newsgroups.5: newsgroups.pod ; $(POD2MAN) -s 5 $? > $@
+../man/newslog.5: newslog.pod ; $(POD2MAN) -s 5 $? > $@
../man/ovdb.5: ovdb.pod ; $(POD2MAN) -s 5 $? > $@
../man/passwd.nntp.5: passwd.nntp.pod ; $(POD2MAN) -s 5 $? > $@
../man/radius.conf.5: radius.conf.pod ; $(POD2MAN) -s 5 $? > $@
@@ -118,6 +121,8 @@
../man/overchan.8: overchan.pod ; $(POD2MAN) -s 8 $? > $@
../man/radius.8: radius.pod ; $(POD2MAN) -s 8 $? > $@
../man/rc.news.8: rc.news.pod ; $(POD2MAN) -s 8 $? > $@
+../man/scanlogs.8: scanlogs.pod ; $(POD2MAN) -s 8 $? > $@
../man/sendinpaths.8: sendinpaths.pod ; $(POD2MAN) -s 8 $? > $@
+../man/tally.control.8: tally.control.pod ; $(POD2MAN) -s 8 $? > $@
../man/tdx-util.8: tdx-util.pod ; $(POD2MAN) -s 8 $? > $@
../man/tinyleaf.8: tinyleaf.pod ; $(POD2MAN) -s 8 $? > $@
Added: doc/pod/newslog.pod
===================================================================
--- doc/pod/newslog.pod (rev 0)
+++ doc/pod/newslog.pod 2007-08-26 08:31:50 UTC (rev 7659)
@@ -0,0 +1,230 @@
+=head1 NAME
+
+newslog - Description of INN log files
+
+=head1 DESCRIPTION
+
+Most log files created by Usenet programs reside in the I<pathlog> directory
+set in F<inn.conf> and have a C<.log> extension. Several versions are usually
+kept with an additional extension such as C<.1>, C<.2>, etc. -- the higher
+the number, the older the log. These old versions are stored in I<pathlog>/OLD;
+they may be compressed and thus may have a C<.1.gz>, C<.2.gz>, etc. extension,
+up to C<.nn.gz> where C<nn> is the number of old logs kept by B<scanlogs>
+which is set by I<logcycles> in F<inn.conf>.
+
+The B<scanlogs> script and related utilities are responsible for rotating
+and compressing these files. Some log files always have data (like
+F<news.notice>), others only have data if there is a problem (like
+F<news.err>), and others are only created if a particular program is used
+(like F<send-uucp.log> used by B<send-uucp>) or if a configuration parameter
+is set (like F<innfeed.log> used by B<innfeed> when I<debug-level> is set
+in F<innfeed.conf>).
+
+Besides, the B<innstat> script monitors the size of all log files.
+
+Here are the log files used by INN:
+
+=over 4
+
+=item F<control.log>
+
+This file maintains a count of the number of newgroup and rmgroup control
+messages seen for each newsgroup. The count is of the number of control
+messages with the indicated arguments, regardless if they were actually
+processed. All control arguments, including invalid ones, are counted.
+An example of lines which can be found in that log file is:
+
+ 3 Control: newgroup foo.bar moderated
+ 3 Control: rmgroup misc.removed
+ 1 Control: newgroup misc.created
+
+This file is updated by B<tally.control>, which is invoked by B<scanlogs>
+if either one of these two log files exists in I<pathlog>:
+
+ newgroup.log
+ rmgroup.log
+
+These two log files contain a summary line describing the control message
+and the action taken by B<controlchan>, followed by the article indented
+by four spaces, and a blank line. Whereas these files are rotated,
+F<control.log> is not rotated so as to keep the count of seen control
+messages.
+
+Note that other control log files are also rotated by B<scanlogs>, if they
+exist, but their contents are not summarized. Here are their names:
+
+ checkgroups.log
+ default.log
+ ihave.log
+ miscctl.log
+ sendme.log
+ sendsys.log
+ senduuname.log
+ version.log
+
+In order to create these files, the <type> and <action> fields of
+relevant F<control.ctl> entries should be correctly set. For instance:
+
+ Type Action Meaning
+ ---- ------ -------
+ all log=miscctl Log all messages by default.
+ newgroup doit=newgroup Create group and log message.
+ newgroup log=newgroup Log message.
+ rmgroup verify-*=rmgroup PGP verify, remove group and log message.
+ checkgroups doit=checkgroups Process and log message.
+
+=item F<errlog>
+
+This file contains the standard output and standard error of any program
+spawned by B<innd>, such as channel feeds configured in F<newsfeeds>. This
+file should normally be empty. B<scanlogs> will print the entire contents
+of this log file if it is non-empty so that it appears in daily Usenet reports
+generated by B<news.daily>. Then, B<scanlogs> rotates this log file.
+
+=item F<expire.log>
+
+By default, when B<news.daily> is going to expire old news articles, it writes
+the name of the program it invokes, followed by C<start> and the time it has
+started. Any output from that program is then written, indented by four
+spaces. Then, the name of the program is written, followed by C<end> and
+the time it has ended.
+
+Programs called, if needed, are in order: B<expireover>, B<ctlinnd>
+(with the C<lowmark> option), B<expirerm> and B<expire>. Removed articles
+are listed in F<expire.list> and low marks for each newsgroup (that
+is to say the number of the oldest article available in the newsgroup) in
+F<expire.lastlowmark>.
+
+After the expiry process, B<scanlogs> rotates F<expire.log>.
+
+=item F<innfeed.log>
+
+When I<debug-level> is set in F<innfeed.conf>, B<innfeed> appends debugging
+messages to this file. Note that the name of this file can be changed with
+the I<log-file> parameter in F<innfeed.conf>. Be that as it may, the right
+log file is rotated by B<scanlogs>.
+
+B<innfeed> also logs its status in F<innfeed.status> (or the name set in
+I<status-file>) if I<gen-html> is set to false but this log file is not
+processed by B<scanlogs>.
+
+=item F<news>
+
+This file logs articles received by B<innd>. Typical lines are:
+
+ Aug 25 13:37:41.839 + news.server.fr <cancel.4066 at foo.com> 1658 a.peer other.server.org inpaths!
+ Aug 25 13:37:41.839 c news.server.fr <cancel.4066 at foo.com> Cancelling <m070725 at foo.com>
+ Aug 25 13:37:54.638 - a.peer <23k82 at bar.net> 437 Poison newsgroup
+
+The first one indicates that an article from C<news.server.fr> has been
+accepted (C<+>). Its Message-ID is C<< <cancel.4066 at foo.com> >> and we will
+send the article to two peers (C<a.peer> and C<other.server.org>, as specified
+in F<newsfeeds>) and C<inpaths!> (see B<ninpaths> for more details
+about it). The second line mentions that this previous article is a
+cancel message (C<c>) for C<< <m070725 at foo.com> >> and that it has been
+processed (inndeed, B<controlchan> processes all control articles except for
+cancels which are handled by B<innd>). The third line indicates that
+the article whose Message-ID is C<< <23k82 at bar.net> >> has been rejected (C<->)
+because it is posted to a poison newsgroup (a Perl or a Python filter
+located in I<pathfilter> must have brought that reject along).
+
+B<innreport> summarizes the rejected articles reported in this file
+and B<scanlogs> rotates it.
+
+=item F<news.crit>
+
+All critical error messages issued by B<innd> are appended to this file via
+syslog. This log file should normally be empty. B<scanlogs> will print the
+entire contents of this log file if it is non-empty so that it appears in
+daily Usenet reports generated by B<news.daily>. Then, B<scanlogs> rotates
+this log file.
+
+You should have the following line in your system F<syslog.conf> file, using
+a tab character for the delimiter:
+
+ news.crit <pathlog>/news.crit
+
+(A typical entry is shown; it should agree with I<pathlog> in F<inn.conf>.)
+
+=item F<news.err>
+
+All major error messages issued by B<innd> are appended to this file via
+syslog. This log file should normally be empty. B<innreport> will print
+the first I<max_unknown> lines of this log file if it is non-empty so that
+they appear in daily Usenet reports generated by B<news.daily>. This
+parameter can be set in F<innreport.conf>. Then, B<scanlogs> rotates
+this log file.
+
+You should have the following line in your system F<syslog.conf> file, using
+a tab character for the delimiter:
+
+ news.err <pathlog>/news.err
+
+(A typical entry is shown; it should agree with I<pathlog> in F<inn.conf>.)
+
+=item F<news.notice>
+
+All standard error messages and status messages issued by B<innd>, B<innfeed>,
+B<nnrpd> and some other programs are appended to this file via syslog.
+B<scanlogs> uses the Perl script B<innreport> to summarize this file. Then,
+B<scanlogs> rotates this log file.
+
+You should have the following line in your system F<syslog.conf> file, using
+a tab character for the delimiter:
+
+ news.notice <pathlog>/news.notice
+
+(A typical entry is shown; it should agree with I<pathlog> in F<inn.conf>.)
+
+=item F<nntpsend.log>
+
+The B<nntpsend> program appends all status messages to this file. It is
+rotated by B<scanlogs>.
+
+=item F<send-nntp.log>
+
+The B<send-nntp> program appends all status messages to this file. It is
+rotated by B<scanlogs>.
+
+=item F<send-uucp.log>
+
+The B<send-uucp> program appends all status messages to this file. It is
+rotated by B<scanlogs>.
+
+=item F<unwanted.log>
+
+This log maintains a count of the number of articles that were rejected
+because they were posted to newsgroups that do not exist at the local site.
+This file is updated by B<innreport> while processing the F<news.notice>
+log file and it is maintained in reverse numeric order (the most popular
+rejected group first). This file is not rotated so as to keep the count
+of the articles posted to newsgroups which are absent from the F<active>
+file of the news server.
+
+=back
+
+Finally, these files are also rotated by B<scanlogs>, if they exist, but
+their contents are not summarized. Here are their names:
+
+ badcontrol.log
+ badpgp.log
+ failedpgp.log
+
+They can be used by programs which PGP verify articles.
+
+=head1 HISTORY
+
+Written by Landon Curt Noll <chongo at toad.com> and Rich $alz
+<rsalz at uunet.uu.net> for InterNetNews. Rewritten and converted
+to POD by Julien Elie <julien at trigofacile.com>.
+
+$Id$
+
+=head1 SEE ALSO
+
+control.ctl(5), ctlinnd(8), expire(8), expireover(8), expirerm(8), inn.conf(5),
+innd(8), innfeed.conf(5), innreport(8), innreport.conf(5), news.daily(8),
+nnrpd(8), nntpsend(8), scanlogs(8), send-nntp(8), send-uucp(8), syslog.conf(5),
+tally.control(8).
+
+=cut
Property changes on: trunk/doc/pod/newslog.pod
___________________________________________________________________
Name: svn:keywords
+ Author Date Id Revision
Name: svn:eol-style
+ native
Added: doc/pod/scanlogs.pod
===================================================================
--- doc/pod/scanlogs.pod (rev 0)
+++ doc/pod/scanlogs.pod 2007-08-26 08:31:50 UTC (rev 7659)
@@ -0,0 +1,67 @@
+=head1 NAME
+
+scanlogs - Summarize and rotate INN log files
+
+=head1 SYNOPSIS
+
+B<scanlogs> [B<norotate>]
+
+=head1 DESCRIPTION
+
+B<scanlogs> summarizes the information recorded in the INN log files which
+reside in the I<pathlog> directory set in F<inn.conf> (see newslog(5) for
+further details about these log files). It is normally invoked by the
+news.daily(8) script which performs daily server maintenance tasks.
+
+It invokes C<ctlinnd flushlogs> to close the news and error log files,
+rename them to add C<.old> to the file names and open fresh news and
+error logs; the F<active> file is also flushed to disk, along with the
+history database.
+
+By default, B<scanlogs> rotates and cleans out the logs. It keeps up to
+I<logcycles> old compressed log files in I<pathlog>/OLD (the I<logcycles>
+parameter can be set in F<inn.conf>). B<scanlogs> also keeps archives
+of the F<active> file in this directory.
+
+It invokes B<tally.control> if F<newgroup.log> or F<rmgroup.log> exists
+in I<pathlog> (see the F<control.log> entry of newslog(5) for more
+information about that).
+
+B<scanlogs> displays the contents of F<errlog> and F<news.crit>, if non-empty,
+and runs B<innreport> to summarize the contents of F<news> and F<news.notice>,
+and to update the F<unwanted.log> file amongst other things (see more
+information about that in innreport(8)).
+
+=head1 OPTIONS
+
+Only one option is currently accepted:
+
+=over 4
+
+=item B<norotate>
+
+Using this option disables the rotating and cleaning aspect of the log
+processing: the logs files are only scanned for information and no contents
+are altered. If B<scanlogs> is invoked more than once a day, the B<norotate>
+option should be used to prevent premature log cleaning.
+
+=back
+
+=head1 FILES
+
+See newslog(5) for the list of log files processed by B<scanlogs>.
+
+=head1 HISTORY
+
+Written by Landon Curt Noll <chongo at toad.com> and Rich $alz
+<rsalz at uunet.uu.net> for InterNetNews. Converted to POD by Julien Elie
+<julien at trigofacile.com>.
+
+$Id$
+
+=head1 SEE ALSO
+
+inn.conf(5), innreport(8), news.daily(8), newslog(5), shlock(1),
+tally.control(8).
+
+=cut
Property changes on: trunk/doc/pod/scanlogs.pod
___________________________________________________________________
Name: svn:keywords
+ Author Date Id Revision
Name: svn:eol-style
+ native
Added: doc/pod/tally.control.pod
===================================================================
--- doc/pod/tally.control.pod (rev 0)
+++ doc/pod/tally.control.pod 2007-08-26 08:31:50 UTC (rev 7659)
@@ -0,0 +1,57 @@
+=head1 NAME
+
+tally.control - Keep track of newsgroup creations and deletions
+
+=head1 SYNOPSIS
+
+B<tally.control> < I<logfile>
+
+=head1 DESCRIPTION
+
+B<tally.control> is normally daily invoked by B<scanlogs>. It reads its
+standard input, which should be the F<newgroup.log> and F<rmgroup.log>
+control log files. They contain a summary line describing the control
+message and the action taken by B<controlchan>, followed by the article
+indented by four spaces, and a blank line. Then, B<tally.control> updates
+the cumulative list of newsgroup creations and deletions which is kept
+in F<control.log>.
+
+All these log files reside in the I<pathlog> directory set in F<inn.conf>.
+In order to generate them, you need to enable control articles logging
+in control.ctl(5), as explained in the F<control.log> entry of newslog(5).
+
+=head1 FILES
+
+=over 4
+
+=item I<pathbin>/tally.control
+
+The Shell script itself used to tally newsgroup creations and deletions up.
+
+=item I<pathlog>/control.log
+
+This file maintains a count of the number of newgroup and rmgroup control
+messages seen for each newsgroup. The count is of the number of control
+messages with the indicated arguments, regardless if they were actually
+processed. All control arguments, including invalid ones, are counted.
+An example of lines which can be found in that log file is:
+
+ 3 Control: newgroup foo.bar moderated
+ 3 Control: rmgroup misc.removed
+ 1 Control: newgroup misc.created
+
+=back
+
+=head1 HISTORY
+
+Written by Landon Curt Noll <chongo at toad.com> and Rich $alz
+<rsalz at uunet.uu.net> for InterNetNews. Rewritten and converted
+to POD by Julien Elie <julien at trigofacile.com>.
+
+$Id$
+
+=head1 SEE ALSO
+
+control.ctl(8), news.daily(8), newslog(5), scanlogs(8).
+
+=cut
Property changes on: trunk/doc/pod/tally.control.pod
___________________________________________________________________
Name: svn:keywords
+ Author Date Id Revision
Name: svn:eol-style
+ native
More information about the inn-committers
mailing list