INN commit: trunk (8 files)

INN Commit rra at isc.org
Thu Aug 20 21:51:56 UTC 2009


    Date: Thursday, August 20, 2009 @ 14:51:56
  Author: iulius
Revision: 8583

Convert makedbz(8) and prunehistory(8) documentation to POD.

Added:
  trunk/doc/pod/makedbz.pod
  trunk/doc/pod/prunehistory.pod
Modified:
  trunk/MANIFEST
  trunk/doc/man/	(properties)
  trunk/doc/pod/Makefile
  trunk/expire/prunehistory.c
Deleted:
  trunk/doc/man/makedbz.8
  trunk/doc/man/prunehistory.8

--------------------------+
 MANIFEST                 |    2 +
 doc/man/makedbz.8        |   78 ---------------------------------------------
 doc/man/prunehistory.8   |   67 --------------------------------------
 doc/pod/Makefile         |    7 ++--
 doc/pod/makedbz.pod      |   61 +++++++++++++++++++++++++++++++++++
 doc/pod/prunehistory.pod |   58 +++++++++++++++++++++++++++++++++
 expire/prunehistory.c    |    2 -
 7 files changed, 127 insertions(+), 148 deletions(-)

Modified: MANIFEST
===================================================================
--- MANIFEST	2009-08-19 08:04:32 UTC (rev 8582)
+++ MANIFEST	2009-08-20 21:51:56 UTC (rev 8583)
@@ -271,6 +271,7 @@
 doc/pod/libauth.pod                   Master file for libauth.3
 doc/pod/libinnhist.pod                Master file for libinnhist.3
 doc/pod/list.pod                      Master file for list.3
+doc/pod/makedbz.pod                   Master file for makedbz.8
 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
@@ -290,6 +291,7 @@
 doc/pod/ovdb_stat.pod                 Master file for ovdb_stat.8
 doc/pod/overchan.pod                  Master file for overchan.8
 doc/pod/passwd.nntp.pod               Master file for passwd.nntp.5
+doc/pod/prunehistory.pod              Master file for prunehistory.8
 doc/pod/pullnews.pod                  Master file for pullnews.1
 doc/pod/qio.pod                       Master file for qio.3
 doc/pod/radius.conf.pod               Master file for radius.conf.5


Property changes on: trunk/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
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

   + 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
makedbz.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
prunehistory.8
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/makedbz.8
===================================================================
--- doc/man/makedbz.8	2009-08-19 08:04:32 UTC (rev 8582)
+++ doc/man/makedbz.8	2009-08-20 21:51:56 UTC (rev 8583)
@@ -1,78 +0,0 @@
-.\" $Revision$
-.TH MAKEDBZ 8
-.SH NAME
-makedbz \- rebuild dbz files
-.SH SYNOPSIS
-.B makedbz
-[
-.BI \-f " filename"
-]
-[
-.B \-i
-]
-[
-.B \-o
-]
-[
-.BI \-s " size"
-]
-.SH DESCRIPTION
-.PP
-.I Makedbz
-rebuilds
-.IR dbz (3)
-database.
-The default name of the text file is
-.IR <pathdb\ in\ inn.conf>/history ;
-to specify a different name, use the ``\fB\-f\fP'' flag.
-.SH OPTIONS
-.TP
-.B \-f file
-If the ``\fB\-f\fP'' flag is used, then the database files are named
-.IR file.dir ,
-.IR file.index ,
-and
-.IR file.hash .
-If the ``\fB\-f\fP'' flag is not used, then a temporary link to the name
-.I history.n
-is made and the database files are written as
-.I history.n.index
-,
-.I history.n.hash
-and
-.IR history.n.dir .
-.TP
-.B \-i
-To ignore the old database use the ``\fB\-i\fP'' flag.
-Using the ``\fB\-o\fP'' or ``\fB\-s\fP'' flags implies the ``\fB\-i\fP'' flag.
-.TP
-.B \-o
-If the ``\fB\-o\fP'' flag is used, then the link is not made and any existing
-history files are overwritten.
-If the old database exists,
-.I makedbz
-will use it to determine the size of the new database.
-.TP
-.B \-s size
-The program will also ignore any old database if the ``\fB\-s\fP'' flag is used
-to specify the approximate number of entries in the new database.
-Accurately specifying the size is an optimization that will create a more
-efficient database.  Size is measured in key-value pairs (i.e., lines).
-(The size should be the estimated eventual size of the file, typically
-the size of the old file.)
-For more information, see the discussion of
-.I dbzfresh
-and
-.I dbzsize
-in
-.IR dbz (3).
-.SH HISTORY
-Written by Katsuhiro Kondou <kondou at nec.co.jp> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-dbz(3),
-history(5),
-inn.conf(5).

Deleted: doc/man/prunehistory.8
===================================================================
--- doc/man/prunehistory.8	2009-08-19 08:04:32 UTC (rev 8582)
+++ doc/man/prunehistory.8	2009-08-20 21:51:56 UTC (rev 8583)
@@ -1,67 +0,0 @@
-.\" $Revision$
-.TH PRUNEHISTORY 8
-.SH NAME
-prunehistory \- remove tokens from Usenet history file
-.SH SYNOPSIS
-.B prunehistory
-[
-.BI \-f " filename"
-]
-[
-.B \-p
-]
-.SH DESCRIPTION
-.I Prunehistory
-modifies a
-.IR history (5)-format
-text file to ``remove'' a set of tokens from it.
-The tokens are removed by overwriting them with spaces, so that the
-size and position of any following entries does not change.  This has an
-effect similar to expiring the article, in that it is still mentioned in
-the history database but cannot be retrieved.
-.PP
-.I Prunehistory
-reads the standard input.
-The input is taken as a set of lines.
-Blank lines and lines starting with a number sign (``#'') are ignored.
-All other lines are should consist of a Message-ID followed by zero or
-more other fields (which are ignored).
-.PP
-The Message-ID is used as the
-.IR dbz (3)
-key to get an offset into the text file.
-.PP
-Since
-.IR innd (8)
-only appends
-to the text file,
-.I prunehistory
-does not need to have any interaction with it.
-.SH OPTIONS
-.TP
-.B \-p
-.I Prunehistory
-will normally complain about lines that do not follow the correct format.
-If the ``\-p'' flag is used, then the program will silently print any
-invalid lines on its standard output.
-(Blank lines and comment lines are also passed through.)
-This can be useful when
-.I prunehistory
-is used as a filter for other programs such as
-.IR reap .
-.TP
-.BI \-f " filename"
-The default name of the history file is
-.IR <pathdb\ in\ inn.conf>/history ;
-to specify a different name, use the ``\-f'' flag.
-.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"
-dbz(3),
-history(5),
-inn.conf(5),
-innd(8).

Modified: doc/pod/Makefile
===================================================================
--- doc/pod/Makefile	2009-08-19 08:04:32 UTC (rev 8582)
+++ doc/pod/Makefile	2009-08-20 21:51:56 UTC (rev 8583)
@@ -34,10 +34,11 @@
 	../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/makedbz.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/ovdb_stat.8 ../man/overchan.8 \
+        ../man/prunehistory.8 ../man/radius.8 \
 	../man/rc.news.8 ../man/scanlogs.8 ../man/sendinpaths.8 \
 	../man/tally.control.8 ../man/tdx-util.8 \
 	../man/tinyleaf.8
@@ -121,6 +122,7 @@
 ../man/innd.8:		innd.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/inndf.8:		inndf.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/innupgrade.8:	innupgrade.pod		; $(POD2MAN) -s 8 $? > $@
+../man/makedbz.8:	makedbz.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 $? > $@
@@ -132,6 +134,7 @@
 ../man/ovdb_server.8:	ovdb_server.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/ovdb_stat.8:	ovdb_stat.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/overchan.8:	overchan.pod		; $(POD2MAN) -s 8 $? > $@
+../man/prunehistory.8:	prunehistory.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 $? > $@

Added: doc/pod/makedbz.pod
===================================================================
--- doc/pod/makedbz.pod	                        (rev 0)
+++ doc/pod/makedbz.pod	2009-08-20 21:51:56 UTC (rev 8583)
@@ -0,0 +1,61 @@
+=head1 NAME
+
+makedbz - Rebuild dbz files
+
+=head1 SYNOPSIS
+
+B<makedbz> [B<-io>] [B<-f> I<filename>] [B<-s> I<size>]
+
+=head1 DESCRIPTION
+
+B<makedbz> rebuilds dbz(3) database.  The default name of the text
+file is I<pathdb>/history; to specify a different name, use the B<-f> flag.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-f> I<filename>
+
+If the B<-f> flag is used, then the database files are named C<I<filename>.dir>,
+C<I<filename>.index>, and C<I<filename>.hash>.  If the B<-f> flag is not used,
+then a temporary link to the name C<history.n> is made and the database files
+are written as C<history.n.index> , C<history.n.hash> and C<history.n.dir>.
+
+=item B<-i>
+
+To ignore the old database, use the B<-i> flag.  Using the B<-o> or B<-s>
+flags implies the B<-i> flag.
+
+=item B<-o>
+
+If the B<-o> flag is used, then the link is not made and any existing history
+files are overwritten.  If the old database exists, B<makedbz> will use it to
+determine the size of the new database.
+
+=item B<-s> I<size>
+
+B<makedbz> will also ignore any old database if the B<-s> flag is used to
+specify the approximate number of entries in the new database.  Accurately
+specifying the size is an optimization that will create a more efficient
+database.  Size is measured in key-value pairs (i.e. lines).  (The size
+should be the estimated eventual size of the file, typically the size
+of the old file.)
+
+For more information, see the discussion of B<dbzfresh> and B<dbzsize>
+in dbz(3).
+
+=back
+
+=head1 HISTORY
+
+Written by Katsuhiro Kondou <kondou at nec.co.jp> for InterNetNews.  Converted to
+POD by Julien Elie.
+
+$Id$
+
+=head1 SEE ALSO
+
+dbz(3), history(5).
+
+=cut


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

Added: doc/pod/prunehistory.pod
===================================================================
--- doc/pod/prunehistory.pod	                        (rev 0)
+++ doc/pod/prunehistory.pod	2009-08-20 21:51:56 UTC (rev 8583)
@@ -0,0 +1,58 @@
+=head1 NAME
+
+prunehistory - Remove tokens from Usenet F<history> file
+
+=head1 SYNOPSIS
+
+B<prunehistory> [B<-p>] [B<-f> I<filename>]
+
+=head1 DESCRIPTION
+
+B<prunehistory> modifies a history(5)-format text file to "remove"
+a set of tokens from it.  The tokens are removed by overwriting
+them with spaces, so that the size and position of any following entries
+does not change.  This has an effect similar to expiring the article, in
+that it is still mentioned in the history database but cannot be retrieved.
+
+B<prunehistory> reads the standard input.  The input is taken as a set of lines.
+Blank lines and lines starting with a number sign (C<#>) are ignored.  All other
+lines should consist of a message-ID followed by zero or more other fields
+(which are ignored).  The message-ID is used as the dbz(3) key to get
+an offset into the text file.  Since B<innd> only appends to the text file,
+B<prunehistory> does not need to have any interaction with it.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-p>
+
+B<prunehistory> will normally complain about lines that do not follow
+the correct format.  If the B<-p> flag is used, then the program will
+silently print any invalid lines on its standard output.  (Blank lines
+and comment lines are also passed through.)
+
+This can be useful when B<prunehistory> is used as a filter for other
+programs such as B<reap> (a legacy program, probably no longer useful
+with current versions of INN, but still available at
+L<ftp://ftp.ruhr-uni-bochum.de/.subdisc1/local/jk.collection/>).
+
+=item B<-f> I<filename>
+
+The default name of the F<history> file is I<pathdb>/history; to specify
+a different name, use the B<-f> flag.
+
+=back
+
+=head1 HISTORY
+
+Written by Rich $alz <rsalz at uunet.uu.net> for InterNetNews.  Converted to
+POD by Julien Elie.
+
+$Id$
+
+=head1 SEE ALSO
+
+dbz(3), history(5), innd(8).
+
+=cut


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

Modified: expire/prunehistory.c
===================================================================
--- expire/prunehistory.c	2009-08-19 08:04:32 UTC (rev 8582)
+++ expire/prunehistory.c	2009-08-20 21:51:56 UTC (rev 8583)
@@ -21,7 +21,7 @@
 static void
 Usage(void)
 {
-    fprintf(stderr, "Usage:  prunehistory [-p] [-f file] [input]\n");
+    fprintf(stderr, "Usage:  prunehistory [-p] [-f file]\n");
     exit(1);
 }
 




More information about the inn-committers mailing list