.\" -*- 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 "SENDINPATHS 8"
.TH SENDINPATHS 8 2024-02-12 "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
sendinpaths \- Send Usenet Path header field statistics via e\-mail
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBsendinpaths\fR [\fB\-cdhn\fR] [\fB\-k\fR \fIkeep-days\fR] [\fB\-r\fR \fIreport-days\fR]
[\fIaddress\fR [\fIaddress\fR ...]]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBsendinpaths\fR checks \fIpathlog\fR/path for \fBninpaths\fR dump files, finds
dump files generated in the past \fIreport-days\fR days, makes sure they are
valid by running \fBninpaths\fR on each one and making sure the exit status
is zero, and passes them to \fBninpaths\fR to generate a cumulative report.
By default, that report is mailed to the e\-mail addresses configured at
the beginning of this script (by default, only one address is configured:
<top1000@anthologeek.net>) in order to supply the TOP1000 project with useful
statistics.  See <http://top1000.anthologeek.net/> for more information.
.PP
When finished, \fBsendinpaths\fR deletes all dump files in \fIpathlog\fR/path
that are older than \fIkeep-days\fR days.
.PP
For more information on how to set up \fBninpaths\fR, see ninpaths(8).
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-c\fR 4
.IX Item "-c"
When this flag is used, the report is also e\-mailed, besides the default
submission addresses or those given as command-line arguments, to the
newsmaster's address set at configure time.
.IP \fB\-d\fR 4
.IX Item "-d"
Enables debug messages.
.IP \fB\-h\fR 4
.IX Item "-h"
Gives usage information.
.IP "\fB\-k\fR \fIkeep-days\fR" 4
.IX Item "-k keep-days"
After having processed dump files, \fBsendinpaths\fR removes those that are
older than \fIkeep-days\fR days.  The default is \f(CW\*(C`0\*(C'\fR, that is to say to
remove all dump files.
.Sp
Setting \fIkeep-days\fR to another value can be useful for debugging purpose
because it permits keeping a few dump files.
.IP \fB\-n\fR 4
.IX Item "-n"
Don't e\-mail the report; instead, just print it to standard output.  Don't
delete old dump files.
.IP "\fB\-r\fR \fIreport-days\fR" 4
.IX Item "-r report-days"
Process dump files generated during the last \fIreport-days\fR days.
The default is \f(CW\*(C`32\*(C'\fR, that is to say to process all the dump files that
have been generated during the last 32 days (if, of course, they have
not been deleted yet by a previous run of \fBsendinpaths\fR according to the
value set by the \fB\-k\fR flag).
.IP "\fIaddress\fR ..." 4
.IX Item "address ..."
E\-mail the report to the mentioned address or addresses, instead of the
default one.  Several addresses can be used, separated by whitespace
(sending the e\-mail to your own e\-mail address can be useful for
debugging purpose, to check that everything works fine).  For instance,
for two addresses:
.Sp
.Vb 1
\&    sendinpaths pathsurvey@example.org top1000@anthologeek.net
.Ve
.SH HISTORY
.IX Header "HISTORY"
\&\fBsendinpaths\fR was written by Olaf Titz <olaf@bigred.inka.de>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
ninpaths(8).