INN commit: branches/2.5 (7 files)

INN Commit rra at isc.org
Tue Aug 18 14:02:02 UTC 2009


    Date: Tuesday, August 18, 2009 @ 07:02:02
  Author: iulius
Revision: 8577

Convert expire(8) and expirerm(8) documentation to POD.

Added:
  branches/2.5/doc/pod/expire.pod
  branches/2.5/doc/pod/expirerm.pod
Modified:
  branches/2.5/MANIFEST
  branches/2.5/doc/man/	(properties)
  branches/2.5/doc/pod/Makefile
Deleted:
  branches/2.5/doc/man/expire.8
  branches/2.5/doc/man/expirerm.8

----------------------+
 MANIFEST             |    2 
 doc/man/expire.8     |  251 -------------------------------------------------
 doc/man/expirerm.8   |   30 -----
 doc/pod/Makefile     |    6 -
 doc/pod/expire.pod   |  161 +++++++++++++++++++++++++++++++
 doc/pod/expirerm.pod |   33 ++++++
 6 files changed, 200 insertions(+), 283 deletions(-)

Modified: MANIFEST
===================================================================
--- MANIFEST	2009-08-18 13:55:11 UTC (rev 8576)
+++ MANIFEST	2009-08-18 14:02:02 UTC (rev 8577)
@@ -247,7 +247,9 @@
 doc/pod/docheckgroups.pod             Master file for docheckgroups.8
 doc/pod/domain.pod                    Master file for domain.8
 doc/pod/expire.ctl.pod                Master file for expire.ctl.5
+doc/pod/expire.pod                    Master file for expire.8
 doc/pod/expireover.pod                Master file for expireover.8
+doc/pod/expirerm.pod                  Master file for expirerm.8
 doc/pod/external-auth.pod             Master file for doc/external-auth
 doc/pod/fastrm.pod                    Master file for fastrm.1
 doc/pod/getlist.pod                   Master file for getlist.1


Property changes on: branches/2.5/doc/man
___________________________________________________________________
Modified: svn:ignore
   - active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
cnfsheadconf.8
cnfsstat.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

   + active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
cnfsheadconf.8
cnfsstat.8
control.ctl.5
convdate.1
ctlinnd.8
cycbuff.conf.5
distrib.pats.5
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expire.8
expireover.8
expirerm.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/expire.8
===================================================================
--- doc/man/expire.8	2009-08-18 13:55:11 UTC (rev 8576)
+++ doc/man/expire.8	2009-08-18 14:02:02 UTC (rev 8577)
@@ -1,251 +0,0 @@
-.\" $Revision$
-.TH EXPIRE 8
-.SH NAME
-expire \- Usenet article and history expiration program
-.SH SYNOPSIS
-.B expire
-[
-.BI \-d " dir"
-]
-[
-.BI \-f " file"
-]
-[
-.BI \-g " file"
-]
-[
-.BI \-h " file"
-]
-[
-.B \-i
-]
-[
-.B \-N
-]
-[
-.B \-n
-]
-[
-.B \-p
-]
-[
-.BI \-r " reason"
-]
-[
-.BI \-s " size"
-]
-[
-.B \-t
-]
-[
-.BI \-v " level"
-]
-[
-.BI \-w " number"
-]
-[
-.B \-x
-]
-[
-.BI \-z " file"
-]
-[
-.I expire.ctl
-]
-.SH DESCRIPTION
-.I Expire
-scans the
-.IR history (5)-format
-text file
-.I <pathdb in inn.conf>/history
-and uses the information recorded in it to purge itself of old news articles.
-Articles stored using a storage method that has self-expire
-functionality are by default not affected by
-.IR expire 's
-primary behavior (but see the ``\fB\-N\fP'' flag to disable this).  In
-this case,
-.I expire.ctl
-is ignored except ``/remember/'' line for that article;
-.I expire
-does still probe to see if the article still exists and purges the
-relevant history and overview entries if appropriate.
-However, if ``groupbaseexpiry'' in
-.I inn.conf
-is true,
-.I expire
-acts on all articles as specified by
-.I expire.ctl
-regardless of whether their storage methods have self-expire
-functionality.  In this case, the ``\fB\-e\fP'', \&``\fB\-k\fP'',
-``\fB\-N\fP'', ``\fB\-p\fP'', ``\fB\-q\fP'', ``\fB\-w\fP'' and
-``\fB\-z\fP'' flags are ignored.
-.PP
-Note that
-.I expire
-never purges articles which do not match any entry in
-.IR expire.ctl .
-.SH OPTIONS
-.TP
-.B \-d dir
-If the ``\fB\-d\fP'' flag is used, then the new history file and database is
-created in the specified directory,
-.IR dir .
-This is useful when the filesystem does not have sufficient space to
-hold both the old and new history files.
-When this flag is used,
-.I expire
-leaves the server paused and creates a zero-length file named after the
-new history file, with an extension of ``.done'' to indicate that
-it has successfully completed the expiration.
-The calling script should install the new history file and un-pause the server.
-The ``\fB\-r\fP'' flag should be used with this flag.
-.TP
-.B \-f file
-To specify an alternate history file, use the ``\fB\-f\fP'' flag.
-This flag is valid when used with the ``\fB\-d\fP'', and the output will
-be written to the specified file.
-The default without ``\fB\-f\fP'' flag is ``history''.
-.TP
-.B \-g file
-If the ``\fB\-g\fP'' flag is given, then a one-line summary equivalent to the
-output of ``\fB\-v\fP 1'', except preceded by the current time, will be
-appended to the specified
-.IR file .
-.TP
-.B \-h file
-To specify an alternate input text history file, use the ``\fB\-h\fP'' flag.
-.I Expire
-uses the old
-.IR dbz (3)
-database to determine the size of the new one.
-(If ``\fB\-d\fP'' flag is not used, the output filename will be the same
-as the input filename with an extension of ``.n''.)
-The default without ``\fB\-h\fP'' flag is
-.IR <pathdb\ in\ inn.conf>/history .
-.TP
-.B \-i
-To ignore the old database, use the ``\fB\-i\fP'' flag.
-.TP
-.B \-N
-The control file is normally ignored for articles in storage methods
-which have self-expire functionality.
-If the ``\fB\-N\fP'' flag is used,
-.I expire
-still uses the control file for these articles.
-.TP
-.B \-n
-If
-.I innd
-is not running, use the ``\fB\-n\fP'' flag and
-.I expire
-will not send the ``pause'' or ``go'' commands.
-(For more details on the commands, see
-.IR ctlinnd (8)).
-Note that
-.I expire
-only needs exclusive access for a very short time \(em long enough to see
-if any new articles arrived since it first hit the end of the file, and to
-rename the new files to the working files.
-.TP
-.B \-p
-.I Expire
-makes its decisions on the time the article arrived, as found in the
-.I history
-file.
-This means articles are often kept a little longer than with other
-expiration programs that base their decisions on the article's posting
-date.
-To use the article's posting date, use the ``\fB\-p\fP'' flag.
-.TP
-.B \-r reason
-.I Expire
-normally sends a ``pause'' command to the local
-.IR innd (8)
-daemon when it needs exclusive access to the history file, using
-the string ``Expiring'' as the reason.
-To give a different reason, use the ``\fB\-r\fP'' flag.
-The process ID will be appended to the reason.
-When
-.I expire
-is finished and the new history file is ready, it sends a ``go'' command.
-See also the ``\fB\-n\fP'' flag.
-.TP
-.B \-s size
-Optimize the new history database for approximately 
-.I size
-pairs (lines in
-.IR history ).
-Accurately specifying the size will create a more efficient database.
-(The size should be the estimated eventual size of the file, typically
-the size of the old file.)
-.TP
-.B \-t
-If the ``\fB\-t\fP'' flag is used, then
-.I expire
-will generate a list of the tokens that should be removed on its
-standard output, and the new history file will be left in
-.IR history.n ,
-.IR history.n.dir ,
-.I history.n.index
-and
-.IR history.n.hash .
-This flag be useful for debugging when used with the ``\fB\-n\fP''
-flags.  Note that if the ``\fB\-f\fP'' flag is used, then the
-name specified with that flag will be used instead of
-.IR history .
-.TP
-.B \-v level
-The ``\fB\-v\fP'' flag is used to increase the verbosity of the program,
-generating messages to standard output.
-The
-.I level
-should be a number, where higher numbers result in more output.
-Level one will print totals of the various actions done (not valid if a
-new history file is not written), level two will print a report on each
-individual file, while level five results in multiple lines of output
-for every history line processed.
-.TP
-.B \-w number
-Use the ``\fB\-w\fP'' flag to ``warp'' time so that
-.I expire
-thinks it is running at some time other then the current time.
-The value should be a signed floating point number indicating the number
-of days to use as the offset.
-.TP
-.B \-x
-If the ``\fB\-x\fP'' flag is used, then
-.I expire
-will not create any new history files.  This is most useful when combined
-with the ``\fB\-n\fP'' and `\fB`\-t\fP'' flags to see how
-different expiration policies would change the amount of disk space used.
-.TP
-.B \-z file
-If the ``\fB\-z\fP'' flag is used, then articles are not removed, but their
-names are appended to the specified
-.IR file .
-See the description of
-.I delayrm
-in
-.IR news.daily (8).
-.PP
-If a filename is specified, it is taken as the control file and parsed
-according to the rules in
-.IR expire.ctl .
-A single dash (``\-'') may be used to read the file from standard input.
-If no file is specified, the file
-.I <pathetc in inn.conf>/expire.ctl
-is read.
-.SH HISTORY
-Written by Rich $alz <rsalz at uunet.uu.net> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-ctlinnd(8),
-dbz(3),
-expire.ctl(5),
-history(5),
-inn.conf(5),
-innd(8),
-inndcomm(3).

Deleted: doc/man/expirerm.8
===================================================================
--- doc/man/expirerm.8	2009-08-18 13:55:11 UTC (rev 8576)
+++ doc/man/expirerm.8	2009-08-18 14:02:02 UTC (rev 8577)
@@ -1,30 +0,0 @@
-.TH EXPIRERM 8
-.SH NAME
-expirerm \- remove articles that have been expired.
-.SH SYNOPSIS
-.B expirerm
-.I file
-.SH DESCRIPTION
-.I Expirerm
-is a script that removes a list of files.
-The specified
-.I file
-lists the files.
-It is sorted, and then fed into a pipeline responsible for doing
-the removal, normally
-.IR fastrm (8).
-If there seemed to be a problem removing the files, then mail is sent to
-the news administrator.
-If there were no problems, then
-.I file
-is renamed to
-.I <pathlog in inn.conf>/expire.list
-where it is kept (for safety) until the next time expiration is done.
-.SH HISTORY
-Written by Landon Curt Noll <chongo at toad.com> and
-Rich $alz <rsalz at uunet.uu.net>
-.SH "SEE ALSO"
-expire(8),
-fastrm(8),
-inn.conf(5).
-

Modified: doc/pod/Makefile
===================================================================
--- doc/pod/Makefile	2009-08-18 13:55:11 UTC (rev 8576)
+++ doc/pod/Makefile	2009-08-18 14:02:02 UTC (rev 8577)
@@ -31,8 +31,8 @@
 	../man/batcher.8 ../man/buffchan.8 \
 	../man/ckpasswd.8 ../man/cnfsheadconf.8 ../man/cnfsstat.8 \
 	../man/ctlinnd.8 ../man/docheckgroups.8 \
-	../man/domain.8 \
-	../man/expireover.8 ../man/ident.8 ../man/innd.8 ../man/inndf.8 \
+	../man/domain.8 ../man/expire.8 ../man/expireover.8 \
+	../man/expirerm.8 ../man/ident.8 ../man/innd.8 ../man/inndf.8 \
 	../man/nnrpd.8 ../man/innbind.8 ../man/innupgrade.8 \
 	../man/makehistory.8 ../man/mod-active.8 \
 	../man/news.daily.8 ../man/news2mail.8 ../man/ninpaths.8 \
@@ -113,7 +113,9 @@
 ../man/ctlinnd.8:	ctlinnd.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/docheckgroups.8:	docheckgroups.pod	; $(POD2MAN) -s 8 $? > $@
 ../man/domain.8:	domain.pod		; $(POD2MAN) -s 8 $? > $@
+../man/expire.8:	expire.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/expireover.8:	expireover.pod		; $(POD2MAN) -s 8 $? > $@
+../man/expirerm.8:	expirerm.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/ident.8:		ident.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/innbind.8:	innbind.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/innd.8:		innd.pod		; $(POD2MAN) -s 8 $? > $@

Added: doc/pod/expire.pod
===================================================================
--- doc/pod/expire.pod	                        (rev 0)
+++ doc/pod/expire.pod	2009-08-18 14:02:02 UTC (rev 8577)
@@ -0,0 +1,161 @@
+=head1 NAME
+
+expire - Usenet article and history expiration program
+
+=head1 SYNOPSIS
+
+B<expire> [B<-iNnptx>] [B<-d> I<dir>] [B<-f> I<file>] [B<-g> I<file>]
+[B<-h> I<file>] [B<-r> I<reason>] [B<-s> I<size>] [B<-v> I<level>]
+[B<-w> I<number>] [B<-z> I<file>] [I<expire.ctl>]
+
+=head1 DESCRIPTION
+
+B<expire> scans the history(5)-format text file I<pathdb>/history
+and uses the information recorded in it to purge itself of old news articles.
+Articles stored using a storage method that has self-expire functionality
+are by default not affected by B<expire>'s primary behavior (but see the
+B<-N> flag to disable this).  In this case, F<expire.ctl> is ignored
+except the C</remember/> line for that article; B<expire> does still
+probe to see if the article still exists and purges the relevant history
+and overview entries if appropriate.  However, if I<groupbaseexpiry> in
+F<inn.conf> is true, B<expire> acts on all articles as specified by
+F<expire.ctl> regardless of whether their storage methods have
+self-expire functionality.
+
+Note that B<expire> never purges articles which do not match any entry
+in F<expire.ctl>.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-d> I<dir>
+
+If the B<-d> flag is used, then the new F<history> file and database
+is created in the specified directory I<dir>.  This is useful when the
+filesystem does not have sufficient space to hold both the old and
+new history files.  When this flag is used, B<expire> leaves the server
+paused and creates a zero-length file named after the new history file,
+with an extension of C<.done> to indicate that it has successfully completed
+the expiration.  The calling script should install the new history file and
+unpause the server.  The B<-r> flag should be used with this flag.
+
+=item B<-f> I<file>
+
+To specify an alternate history file, use the B<-f> flag.  This flag is
+valid when used with the B<-d> flag, and the output will be written
+to the specified file.  The default without B<-f> is C<history>.
+
+=item B<-g> I<file>
+
+If the B<-g> flag is given, then a one-line summary equivalent to the
+output of B<-v 1>, except preceded by the current time, will be appended
+to the specified I<file>.
+
+=item B<-h> I<file>
+
+To specify an alternate input text history file, use the B<-h> flag.
+B<expire> uses the old dbz(3) database to determine the size of the
+new one.  (If the B<-d> flag is not used, the output filename will be
+the same as the input filename with an extension of C<.n>.)
+
+The default without the B<-h> flag is I<pathdb>/history.
+
+=item B<-i>
+
+To ignore the old database, use the B<-i> flag.
+
+=item B<-N>
+
+The control file is normally ignored for articles in storage methods
+which have self-expire functionality.  If the B<-N> flag is used,
+B<expire> still uses the control file for these articles.
+
+=item B<-n>
+
+If B<innd> is not running, use the B<-n> flag and B<expire> will not
+send the C<pause> or C<go> commands.  (For more details on the commands,
+see ctlinnd(8)).  Note that B<expire> only needs exclusive access for
+a very short time S<-- long> enough to see if any new articles arrived
+since it first hit the end of the file, and to rename the new files
+to the working files.
+
+=item B<-p>
+
+B<expire> makes its decisions on the time the article arrived, as found
+in the F<history> file.  This means articles are often kept a little
+longer than with other expiration programs that base their decisions
+on the article's posting date.  To use the article's posting date,
+use the B<-p> flag.
+
+=item B<-r> I<reason>
+
+B<expire> normally sends a C<pause> command to the local B<innd> daemon
+when it needs exclusive access to the F<history> file, using the string
+C<Expiring> as the reason.  To give a different reason, use the B<-r> flag.
+The process ID will be appended to the reason.  When B<expire> is finished
+and the new F<history> file is ready, it sends a C<go> command.  See
+also the B<-n> flag.
+
+=item B<-s> I<size>
+
+Optimize the new history database for approximately I<size> pairs
+(lines in F<history>).  Accurately specifying the size will create
+a more efficient database.  (The size should be the estimated eventual size
+of the file, typically the size of the old file.)
+
+=item B<-t>
+
+If the B<-t> flag is used, then B<expire> will generate a list of the
+tokens that should be removed on its standard output, and the new F<history>
+file will be left in F<history.n>, F<history.n.dir>, F<history.n.index>
+and F<history.n.hash>.  This flag is useful for debugging when used with
+the B<-n> flag.  Note that if the B<-f> flag is used, then the name
+specified with that flag will be used instead of F<history>.
+
+=item B<-v> I<level>
+
+The B<-v> flag is used to increase the verbosity of the program, generating
+messages to standard output.  The I<level> should be a number, where higher
+numbers result in more output.  Level one will print totals of the various
+actions done (not valid if a new F<history> file is not written), level two
+will print a report on each individual file, while level five results in
+multiple lines of output for every history line processed.
+
+=item B<-w> I<number>
+
+Use the B<-w> flag to "warp" time so that B<expire> thinks it is running
+at some time other then the current time.  The value should be a signed
+floating point number indicating the number of days to use as the offset.
+
+=item B<-x>
+
+If the B<-x> flag is used, then B<expire> will not create any new history
+files.  This is most useful when combined with the B<-n> and B<-t> flags
+to see how different expiration policies would change the amount of disk
+space used.
+
+=item B<-z> I<file>
+
+If the B<-z> flag is used, then articles are not removed, but their names
+are appended to the specified I<file>.  See the description of B<delayrm>
+in news.daily(8).  If a filename is specified, it is taken as the control
+file and parsed according to the rules in F<expire.ctl>.  A single dash
+(C<->) may be used to read the file from standard input.  If no file
+is specified, the file I<pathetc>/expire.ctl is read.
+
+=back
+
+=head1 HISTORY
+
+Written by Rich $alz <rsalz at uunet.uu.net> for InterNetNews.  Converted to
+POD by Julien Elie.
+
+$Id$
+
+=head1 SEE ALSO
+
+ctlinnd(8), dbz(3), expire.ctl(5), history(5), inn.conf(5), innd(8),
+inndcomm(3), news.daily(8).
+
+=cut


Property changes on: branches/2.5/doc/pod/expire.pod
___________________________________________________________________
Added: svn:keywords
   + Author Date Id Revision
Added: svn:eol-style
   + native

Added: doc/pod/expirerm.pod
===================================================================
--- doc/pod/expirerm.pod	                        (rev 0)
+++ doc/pod/expirerm.pod	2009-08-18 14:02:02 UTC (rev 8577)
@@ -0,0 +1,33 @@
+=head1 NAME
+
+expirerm - Remove articles that have been expired
+
+=head1 SYNOPSIS
+
+B<expirerm> I<file>
+
+=head1 DESCRIPTION
+
+B<expirerm> is a script that removes a list of files.  The specified
+I<file> lists the files to be removed.  It is usually created by
+B<expire -z>.  This file is sorted, and then fed into a pipeline
+responsible for doing the removal, normally B<fastrm>.  (You may want
+to edit B<expirerm> to change the flags passed to B<fastrm>.)
+
+If there seemed to be a problem removing the files, then a mail is
+sent to the news administrator.  If there were no problems, then
+I<file> is renamed to I<pathlog>/expire.list where it is kept
+(for safety) until the next time expiration is done.
+
+=head1 HISTORY
+
+Written by Landon Curt Noll <chongo at toad.com> and Rich $alz
+<rsalz at uunet.uu.net>.  Converted to POD by Julien Elie.
+
+$Id$
+
+=head1 SEE ALSO
+
+expire(8), fastrm(8), newslog(5).
+
+=cut


Property changes on: branches/2.5/doc/pod/expirerm.pod
___________________________________________________________________
Added: svn:keywords
   + Author Date Id Revision
Added: svn:eol-style
   + native




More information about the inn-committers mailing list