INN commit: trunk (5 files)
INN Commit
Russ_Allbery at isc.org
Sun Dec 21 19:03:35 UTC 2008
Date: Sunday, December 21, 2008 @ 11:03:34
Author: iulius
Revision: 8244
Convert mod-active(8) man page into POD.
Mention that no syntax checking is performed on group names by the
script.
Added:
trunk/doc/pod/mod-active.pod
Modified:
trunk/MANIFEST
trunk/doc/man/ (properties)
trunk/doc/pod/Makefile
Deleted:
trunk/doc/man/mod-active.8
------------------------+
MANIFEST | 1
doc/man/mod-active.8 | 84 -----------------------------------------------
doc/pod/Makefile | 4 +-
doc/pod/mod-active.pod | 55 ++++++++++++++++++++++++++++++
4 files changed, 59 insertions(+), 85 deletions(-)
Modified: MANIFEST
===================================================================
--- MANIFEST 2008-12-21 11:50:47 UTC (rev 8243)
+++ MANIFEST 2008-12-21 19:03:34 UTC (rev 8244)
@@ -295,6 +295,7 @@
doc/pod/libinnhist.pod Master file for libinnhist.3
doc/pod/list.pod Master file for list.3
doc/pod/makehistory.pod Master file for makehistory.8
+doc/pod/mod-active.pod Master file for mod-active.8
doc/pod/moderators.pod Master file for moderators.5
doc/pod/motd.news.pod Master file for motd.news.5
doc/pod/news.daily.pod Master file for news.daily.pod.8
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
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expireover.8
fastrm.1
getlist.1
grephistory.1
ident.8
incoming.conf.5
inews.1
inn.conf.5
INN__Config.3pm
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
news.daily.8
news2mail.8
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
shlock.1
simpleftp.1
sm.1
storage.conf.5
subscriptions.5
tally.control.8
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
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expireover.8
fastrm.1
getlist.1
grephistory.1
ident.8
incoming.conf.5
inews.1
inn.conf.5
INN__Config.3pm
innbind.8
innconfval.1
innd.8
inndf.8
innmail.1
innupgrade.8
libauth.3
libinnhist.3
list.3
mailpost.8
makehistory.8
mod-active.8
moderators.5
motd.news.5
newsfeeds.5
news.daily.8
news2mail.8
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
shlock.1
simpleftp.1
sm.1
storage.conf.5
subscriptions.5
tally.control.8
tdx-util.8
tinyleaf.8
tst.3
uwildmat.3
Deleted: doc/man/mod-active.8
===================================================================
--- doc/man/mod-active.8 2008-12-21 11:50:47 UTC (rev 8243)
+++ doc/man/mod-active.8 2008-12-21 19:03:34 UTC (rev 8244)
@@ -1,84 +0,0 @@
-.\" $Revision$
-.TH MOD-ACTIVE 8
-.SH NAME
-mod-active \- batch processing of ctlinnd newgroup/rmgroup/changegroup
-.SH SYNOPSIS
-.B mod-active
-[
-.I ctlinnd_command_file
-]
-.SH DESCRIPTION
-.B mod-active
-is a
-.B perl
-script that updates the
-.I active
-file based on its input lines of ctlinnd newgroup, rmgroup and
-changegroup commands. It pauses the server briefly while the existing
-active file is read and rewritten, which not only keeps
-.B innd
-from updating the active file but also locks against other instances
-of
-.BR mod-active .
-.PP
-The input to
-.B mod-active
-can come either from one or more files named on the command line, or
-from the standard input. Typically its input is the output from the
-.B docheckgroups
-or
-.B actsync
-commands. Every line which contains the string "ctlinnd newgroup",
-"ctlinnd rmgroup", or "ctlinnd changegroup", optionally preceded by
-whitespace and/or the path to
-.BR ctlinnd ,
-is noted for the update. Redundant commands, such as a newgroup
-directive for a group that already exists, are silently ignored. All
-other lines in the input are also silently ignored.
-.PP
-After the new
-.I active
-file has been generated, the existing one is renamed to
-.I active.old
-and the new one is moved into place. The script then displays the
-differences between the two files.
-.PP
-Any groups that were added to the
-.I active
-file are also added to the
-.I active.times
-file with the string "checkgroups-update".
-.SH BUGS
-Though
-.B innd
-is paused while
-.B mod-active
-works, it is not inconceivable that there could be a conflict if
-something else tries to update the active file during the relatively
-short time that mod-active is working. The two most realistic ways I
-can think of for this to happen are either by an administrator
-concurrently doing a manual ctlinnd command, or by
-.B innd
-receiving a control message, then
-.B mod-active
-pausing the server, then the control message handler script that
-.B innd
-forked running its own
-.B ctlinnd
-command while
-.B mod-active
-is working.
-I've been using
-.B mod-active
-regularly for several years, though, and never had either problem.
-.SH HISTORY
-Written by David C Lawrence <tale at isc.org>.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.SH "SEE ALSO"
-.IR active (5),
-.IR active.times (5),
-.IR actsync (8),
-.IR ctlinnd (8),
-.IR innd (8).
Modified: doc/pod/Makefile
===================================================================
--- doc/pod/Makefile 2008-12-21 11:50:47 UTC (rev 8243)
+++ doc/pod/Makefile 2008-12-21 19:03:34 UTC (rev 8244)
@@ -33,7 +33,8 @@
../man/domain.8 \
../man/expireover.8 ../man/ident.8 ../man/innd.8 ../man/inndf.8 \
../man/nnrpd.8 ../man/innbind.8 ../man/innupgrade.8 \
- ../man/makehistory.8 ../man/news.daily.8 ../man/news2mail.8 ../man/ninpaths.8 \
+ ../man/makehistory.8 ../man/mod-active.8 \
+ ../man/news.daily.8 ../man/news2mail.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/scanlogs.8 ../man/sendinpaths.8 \
@@ -117,6 +118,7 @@
../man/inndf.8: inndf.pod ; $(POD2MAN) -s 8 $? > $@
../man/innupgrade.8: innupgrade.pod ; $(POD2MAN) -s 8 $? > $@
../man/makehistory.8: makehistory.pod ; $(POD2MAN) -s 8 $? > $@
+../man/mod-active.8: mod-active.pod ; $(POD2MAN) -s 8 $? > $@
../man/news.daily.8: news.daily.pod ; $(POD2MAN) -s 8 $? > $@
../man/news2mail.8: news2mail.pod ; $(POD2MAN) -s 8 $? > $@
../man/ninpaths.8: ninpaths.pod ; $(POD2MAN) -s 8 $? > $@
Added: doc/pod/mod-active.pod
===================================================================
--- doc/pod/mod-active.pod (rev 0)
+++ doc/pod/mod-active.pod 2008-12-21 19:03:34 UTC (rev 8244)
@@ -0,0 +1,55 @@
+=head1 NAME
+
+mod-active - Batch processing of newsgroups creation and removal commands
+
+=head1 SYNOPSIS
+
+B<mod-active> [I<ctlinnd-command-file> ...]
+
+=head1 DESCRIPTION
+
+B<mod-active> is a Perl script that updates the F<active> file based on
+its input lines of B<ctlinnd> C<newgroup>, C<rmgroup> and C<changegroup>
+commands. It pauses the server briefly while the existing F<active> file
+is read and rewritten, which not only keeps B<innd> from updating the
+F<active> file but also locks against other instances of B<mod-active>.
+
+The script must be run as the news user.
+
+The input to B<mod-active> can come either from one or more I<ctlinnd-command-file>
+files named on the command line, or from the standard input. Typically its input
+is the output from the B<docheckgroups> or B<actsync> commands. Every line which
+contains the string C<ctlinnd newgroup>, C<ctlinnd rmgroup>, or C<ctlinnd changegroup>,
+optionally preceded by whitespace and/or the path to B<ctlinnd>, is noted for
+the update. Redundant commands, such as a newgroup directive for a group
+that already exists, are silently ignored. All other lines in the input are
+also silently ignored. After the new F<active> file has been generated,
+the existing one is renamed to F<active.old> and the new one is moved into place.
+The script then displays the differences between the two files. Any groups
+that were added to the F<active> file are also added to the F<active.times>
+file with the string C<checkgroups-update>.
+
+Please note that no syntax checking is performed on group names by B<mod-active>.
+
+=head1 BUGS
+
+Though B<innd> is paused while B<mod-active> works, it is not inconceivable
+that there could be a conflict if something else tries to update the F<active>
+file during the relatively short time that B<mod-active> is working. The two
+most realistic ways for this to happen are either by an administrator
+concurrently doing a manual B<ctlinnd> command, or by B<innd> receiving
+a control message, then B<mod-active> pausing the server, then the control
+message handler script that B<innd> forked running its own B<ctlinnd> command
+while B<mod-active> is working. Note that such scenarios are I<very> unlikely
+to happen.
+
+=head1 HISTORY
+
+Written by David C Lawrence <tale at isc.org> for InterNetNews. Converted to POD
+by Julien Elie.
+
+=head1 SEE ALSO
+
+active(5), active.times(5), actsync(8), ctlinnd(8), docheckgroups(8), innd(8).
+
+=cut
Property changes on: trunk/doc/pod/mod-active.pod
___________________________________________________________________
Name: svn:keywords
+ Author Date Id Revision
Name: svn:eol-style
+ native
More information about the inn-committers
mailing list