chiark / gitweb /
REORG Delete everything that's not innduct or build system or changed for innduct
[innduct.git] / doc / man / makehistory.8
diff --git a/doc/man/makehistory.8 b/doc/man/makehistory.8
deleted file mode 100644 (file)
index 5c8582e..0000000
+++ /dev/null
@@ -1,308 +0,0 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
-.\"
-.\" Standard preamble:
-.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Vb \" Begin verbatim text
-.ft CW
-.nf
-.ne \\$1
-..
-.de Ve \" End verbatim text
-.ft R
-.fi
-..
-.\" Set up some character translations and predefined strings.  \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
-.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.ie n \{\
-.    ds -- \(*W-
-.    ds PI pi
-.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
-.    ds L" ""
-.    ds R" ""
-.    ds C` ""
-.    ds C' ""
-'br\}
-.el\{\
-.    ds -- \|\(em\|
-.    ds PI \(*p
-.    ds L" ``
-.    ds R" ''
-'br\}
-.\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
-.\" entries marked with X<> in POD.  Of course, you'll have to process the
-.\" output yourself in some meaningful fashion.
-.if \nF \{\
-.    de IX
-.    tm Index:\\$1\t\\n%\t"\\$2"
-..
-.    nr % 0
-.    rr F
-.\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
-.    \" fudge factors for nroff and troff
-.if n \{\
-.    ds #H 0
-.    ds #V .8m
-.    ds #F .3m
-.    ds #[ \f1
-.    ds #] \fP
-.\}
-.if t \{\
-.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-.    ds #V .6m
-.    ds #F 0
-.    ds #[ \&
-.    ds #] \&
-.\}
-.    \" simple accents for nroff and troff
-.if n \{\
-.    ds ' \&
-.    ds ` \&
-.    ds ^ \&
-.    ds , \&
-.    ds ~ ~
-.    ds /
-.\}
-.if t \{\
-.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-.    \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-.    \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-.    \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-.    ds : e
-.    ds 8 ss
-.    ds o a
-.    ds d- d\h'-1'\(ga
-.    ds D- D\h'-1'\(hy
-.    ds th \o'bp'
-.    ds Th \o'LP'
-.    ds ae ae
-.    ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
-.\" ========================================================================
-.\"
-.IX Title "MAKEHISTORY 8"
-.TH MAKEHISTORY 8 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
-.SH "NAME"
-makehistory \- Initialize or rebuild INN history database
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-\&\fBmakehistory\fR [\fB\-abeFIOx\fR] [\fB\-f\fR \fIfilename\fR] [\fB\-l\fR \fIcount\fR]
-[\fB\-T\fR \fItmpdir\fR] [\fB\-s\fR \fIsize\fR]
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-\&\fBmakehistory\fR rebuilds the \fIhistory\fR\|(5) text file, which contains a list of
-Message-IDs of articles already seen by the server.  It can also be used
-to rebuild the overview database.  Note that the \fIdbz\fR\|(3) indexes for the
-history file are rebuilt by \fImakedbz\fR\|(8), not by \fBmakehistory\fR as in
-earlier versions of \s-1INN\s0.
-.PP
-The default location of the history text file is \fIpathdb\fR/history; to
-specify an alternate location, use the \fB\-f\fR flag.
-.PP
-By default, \fBmakehistory\fR will scan the entire spool, using the storage
-manager, and write a history line for every article.  To also generate
-overview information, use the \fB\-O\fR flag.
-.PP
-\&\s-1WARNING:\s0 If you're trying to rebuild the overview database, be sure to
-stop \fIinnd\fR\|(8) and delete or zero out the existing database before you start
-for the best results.  An overview rebuild should not be done while the
-server is running.  Unless the existing overview is deleted, you may end
-up with problems like out-of-order overview entries, excessively large
-overview buffers, and the like.
-.PP
-If \fIovmethod\fR in \fIinn.conf\fR is \f(CW\*(C`ovdb\*(C'\fR, you must have the ovdb processes
-running while rebuilding overview.  ovdb needs them available while
-writing overview entries.  You can start them by hand separate from the
-rest of the server by running \fBovdb_init\fR; see \fIovdb_init\fR\|(8) for more
-details.
-.SH "OPTIONS"
-.IX Header "OPTIONS"
-.IP "\fB\-a\fR" 4
-.IX Item "-a"
-Append to the history file rather than generating a new one.  If you
-append to the main history file, make sure \fIinnd\fR\|(8) is throttled or not
-running, or you can corrupt the history.
-.IP "\fB\-b\fR" 4
-.IX Item "-b"
-Delete any messages found in the spool that do not have valid Message-ID
-headers in them.
-.IP "\fB\-e\fR" 4
-.IX Item "-e"
-Compute Bytes headers which is used for overview data.  This option is valid
-only if \fB\-O\fR flag is specified and \fIoverview.fmt\fR includes \f(CW\*(C`Bytes:\*(C'\fR.
-.IP "\fB\-f\fR \fIfilename\fR" 4
-.IX Item "-f filename"
-Rather than writing directly to \fIpathdb\fR/history, instead write to
-\&\fIfilename\fR.
-.IP "\fB\-F\fR" 4
-.IX Item "-F"
-Fork a separate process to flush overview data to disk rather than doing
-it directly.  The advantage of this is that it allows \fBmakehistory\fR to
-continue to collect more data from the spool while the first batch of data
-is being written to the overview database.  The disadvantage is that up to
-twice as much temporary disk space will be used for the generated overview
-data.  This option only makes sense in combination with \fB\-O\fR.  With
-\&\f(CW\*(C`buffindexed\*(C'\fR, the \f(CW\*(C`overchan\*(C'\fR program is invoked to write overview.
-.IP "\fB\-I\fR" 4
-.IX Item "-I"
-Don't store overview data for articles numbered lower than the lowest
-article number in \fIactive\fR.  This is useful if there are for whatever
-reason old articles on disk that shouldn't be available to readers or put
-into the overview database.
-.IP "\fB\-l\fR \fIcount\fR" 4
-.IX Item "-l count"
-This option specifies how many articles to process before writing the
-accumulated overview information out to the overview database.  The
-default is \f(CW10000\fR.  Since overview write performance is faster with
-sorted data, each \*(L"batch\*(R" gets sorted.  Increasing the batch size
-with this option may further improve write performance, at the cost
-of longer sort times.  Also, temporary space will be needed to store
-the overview batches.  At a rough estimate, about 300 * \fIcount\fR bytes
-of temporary space will be required (not counting temp files created
-by \fIsort\fR\|(1)).  See the description of the \fB\-T\fR option for how to
-specify the temporary storage location.  This option has no effect
-with \f(CW\*(C`buffindexed\*(C'\fR, because \f(CW\*(C`buffindexed\*(C'\fR does not need sorted
-overview and no batching is done.
-.IP "\fB\-s\fR \fIsize\fR" 4
-.IX Item "-s size"
-Size the history database for approximately \fIsize\fR pairs.  Accurately
-specifying the size is an optimization that will create a more
-efficient database.  (The size should be the estimated eventual size
-of the \fIhistory\fR file, typically the size of the old file, in lines.)
-.IP "\fB\-O\fR" 4
-.IX Item "-O"
-Create the overview database as well as the history file.  Overview
-information is only required if the server supports readers; it is not
-needed for a transit-only server (see \fIenableoverview\fR in \fIinn.conf\fR\|(5)).
-If you are using the \f(CW\*(C`buffindexed\*(C'\fR overview storage method, erase all of
-your overview buffers before running \fBmakehistory\fR with \fB\-O\fR.
-.IP "\fB\-T\fR \fItmpdir\fR" 4
-.IX Item "-T tmpdir"
-If \fB\-O\fR is given, \fBmakehistory\fR needs a location to write temporary
-overview data.  By default, it uses \fIpathtmp\fR, set in \fIinn.conf\fR, but if
-this option is given, the provided \fItmpdir\fR is used instead.  This is
-also used for temporary files created by \fIsort\fR\|(1) (which is invoked in the
-process of writing overview information since sorted overview information
-writes faster).  By default, sort usually uses your system temporary
-directory; see the \fIsort\fR\|(1) man page on your system to be sure.
-.IP "\fB\-x\fR" 4
-.IX Item "-x"
-If this option is given, \fBmakehistory\fR won't write out history file
-entries.  This is useful mostly for building overview without generating
-a new history file.
-.SH "EXAMPLES"
-.IX Header "EXAMPLES"
-Here's a typical example of rebuilding the entire history and overview
-database, removing broken articles in the news spool.  This uses the
-default temporary file locations and should be done while innd isn't
-running (or is throttled).
-.PP
-.Vb 1
-\&    makehistory \-b \-f history.n \-O \-l 30000 \-I
-.Ve
-.PP
-This will rebuild the overview (if using \f(CW\*(C`buffindexed\*(C'\fR, erase the
-existing overview buffers before running this command) and leave a new
-history file as \f(CW\*(C`history.n\*(C'\fR in \fIpathdb\fR.  To preserve all of the history
-entries from the old history file that correspond to rejected articles or
-expired articles, follow the above command with:
-.PP
-.Vb 2
-\&    cd /usr/local/news/db
-\&    awk 'NF == 2 { print }' < history >> history.n
-.Ve
-.PP
-(replacing the path with your \fIpathdb\fR, if it isn't the default).  Then
-look over the new history file for problems and run:
-.PP
-.Vb 1
-\&    makedbz \-s `wc \-l < history` \-f history.n
-.Ve
-.PP
-Then rename all of the files matching \f(CW\*(C`history.n.*\*(C'\fR to \f(CW\*(C`history.*\*(C'\fR,
-replacing the current history database and indexes.  After that, it's safe
-to unthrottle innd.
-.PP
-For a simpler example:
-.PP
-.Vb 1
-\&    makehistory \-b \-f history.n \-I \-O
-.Ve
-.PP
-will scan the spool, removing broken articles and generating history and
-overview entries for articles missing from history.
-.PP
-To just rebuild overview:
-.PP
-.Vb 1
-\&    makehistory \-O \-x \-F
-.Ve
-.SH "FILES"
-.IX Header "FILES"
-.IP "inn.conf" 4
-.IX Item "inn.conf"
-Read for \fIpathdb\fR, \fIpathtmp\fR, and other settings.
-.IP "\fIpathdb\fR/history" 4
-.IX Item "pathdb/history"
-This is the default output file for \fBmakehistory\fR.
-.IP "\fIpathtmp\fR" 4
-.IX Item "pathtmp"
-Where temporary files are written unless \fB\-T\fR is given.
-.SH "HISTORY"
-.IX Header "HISTORY"
-Originally written by Rich \f(CW$alz\fR <rsalz@uunet.uu.net> for InterNetNews and
-updated by various other people since.
-.PP
-$Id: makehistory.8 7880 2008-06-16 20:37:13Z iulius $
-.SH "SEE ALSO"
-.IX Header "SEE ALSO"
-\&\fIdbz\fR\|(3), \fIactive\fR\|(5), \fIhistory\fR\|(5), \fIinn.conf\fR\|(5), \fIctlinnd\fR\|(8), \fIinnd\fR\|(8),
-\&\fImakedbz\fR\|(8), \fIovdb_init\fR\|(8), \fIoverview.fmt\fR\|(5).