.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SCANSPOOL 8"
.TH SCANSPOOL 8 2024-04-01 "INN 2.7.2" "InterNetNews Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
scanspool \- Perform a sanity scan over all articles in news spool
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBscanspool\fR [\fB\-cnrv\fR] [\fB\-a\fR \fIactive-file\fR] [\fB\-s\fR \fIspool-dir\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBscanspool\fR is a Perl script for use with a \fItradspool\fR article spool.
It will scan the \fIactive\fR file as well as all articles in the spool and
report on the errors it encounters.  As this may take a while, using the
\&\fB\-v\fR switch is recommended to see how far the program has progressed.
.PP
\&\fBscanspool\fR will skip any file named other than just all-digits when treating
the contents of the news spool.
.PP
First, \fBscanspool\fR scans the \fIactive\fR file, noting problems such as:
.IP \(bu 4
malformed lines;
.IP \(bu 4
duplicate entries;
.IP \(bu 4
newsgroups aliased to a non-existent newsgroup;
.IP \(bu 4
newsgroups aliased to a newsgroup that is also aliased.
.PP
Then it will examine all articles under your news spool directory,
complaining about articles that:
.IP \(bu 4
have a basename that starts with a leading 0;
.IP \(bu 4
have a basename that is out of range according to the low and high water marks
of the \fIactive\fR file;
.IP \(bu 4
do not contain a Newsgroups header field;
.IP \(bu 4
are in a directory for which there is no newsgroup in the \fIactive\fR file;
.IP \(bu 4
are in a newsgroup to which they do not belong.
.PP
\&\fBscanspool\fR will also complain about directories with an all-digit component,
in case the parent directory is a newsgroup with a high water mark below that
all-digit component, as the name of such directories will conflict with a
future article file with the same name.
.PP
\&\fBscanspool\fR understands aliased newsgroups.  Thus, if an article is posted
to foo.old.name that is aliased to foo.bar, it will be expected to
be found under foo.bar and not foo.old.name.
.PP
\&\fBscanspool\fR assumes that the path of a valid newsgroup's directory
from the root of the spool tree will not contain any \f(CW\*(C`.\*(C'\fR character.
Thus, directories such as \fIout.going\fR, \fItmp.dir\fR, \fIin.coming\fR and
\&\fInews.archive\fR will not be searched.  This program also assumes that
article basenames contain only decimal digits.  Last, files under
the top level directory \fIlost+found\fR are not scanned.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-a\fR \fIactive-file\fR" 4
.IX Item "-a active-file"
The \fIactive\fR file to use; \fIpathdb\fR/active is the default.
.IP \fB\-c\fR 4
.IX Item "-c"
Only check article filenames.  \fBscanspool\fR will therefore not actually
scan the Newsgroups header field of the articles.
.IP \fB\-n\fR 4
.IX Item "-n"
Don't throttle \fBinnd\fR while scanning.
.IP \fB\-r\fR 4
.IX Item "-r"
Remove articles reported to have a problem.  To see the list of articles in
question, run \fBscanspool\fR without this flag first.
.Sp
Be warned that using this flag may result in inaccessible articles if articles
are removed whereas they are perfectly valid articles.  Have a look at them to
ensure they can be safely removed, and then use this flag.
.IP "\fB\-s\fR \fIspool-dir\fR" 4
.IX Item "-s spool-dir"
The root of the spool tree; \fIpatharticles\fR is the default.
.IP \fB\-v\fR 4
.IX Item "-v"
Setting this flag enables a verbose mode.  \fBscanspool\fR will then print
which newsgroup is currently worked upon.  It will list all the articles
found in non\-\fIactive\fR directories (that is to say articles sorted into
groups no longer present in the \fIactive\fR file), rather than just printing
the group once.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
The output of \fBscanspool\fR will start with one of the following forms:
.ie n .IP """FATAL:"" (to stderr)" 4
.el .IP "\f(CWFATAL:\fR (to stderr)" 4
.IX Item "FATAL: (to stderr)"
Fatal or internal error.
.ie n .IP """WARNING:"" (to stderr)" 4
.el .IP "\f(CWWARNING:\fR (to stderr)" 4
.IX Item "WARNING: (to stderr)"
\&\fIactive\fR or article format problem, newsgroup alias problem, find(1)
error, article open error.
.ie n .IP """path/123:"" (to stdout)" 4
.el .IP "\f(CWpath/123:\fR (to stdout)" 4
.IX Item "path/123: (to stdout)"
Issues such as:
.RS 4
.IP \(bu 4
basename starts with 0;
.IP \(bu 4
article number out of range;
.IP \(bu 4
article in the wrong directory;
.IP \(bu 4
article in a directory not related to an \fIactive\fR non-aliased newsgroup.
.RE
.RS 4
.RE
.ie n .IP """\et ..."" (to stdout)" 4
.el .IP "\f(CW\et ...\fR (to stdout)" 4
.IX Item "t ... (to stdout)"
Verbose messages start with a tab.
.SH HISTORY
.IX Header "HISTORY"
\&\fBscanspool\fR was written by Landon Curt Noll (chongo was here /\e../\e).
.PP
This manual page was written by Florian Schlichting, largely based on
comments in the script.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
active(5).