.\" -*- 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 "INNREPORT 8" .TH INNREPORT 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 innreport \- Summarize INN log files .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBinnreport\fR \fB\-f\fR \fIconfig-file\fR [\fB\-config\fR] [\fB\-help\fR] [\fB\-v\fR] [\fB\-\fR[\fBno\fR]\fBarchive\fR] [\fB\-\fR[\fBno\fR]\fBcasesensitive\fR] [\fB\-\fR[\fBno\fR]\fBgraph\fR] [\fB\-\fR[\fBno\fR]\fBhtml\fR] [\fB\-\fR[\fBno\fR]\fBhtml-unknown\fR] [\fB\-\fR[\fBno\fR]\fBnotdaily\fR] [\fB\-\fR[\fBno\fR]\fBunknown\fR] [\fB\-cycle\fR \fInum-cycle\fR] [\fB\-dir\fR \fIhttp-dir\fR] [\fB\-index\fR \fIindex-file\fR] [\fB\-maxunrec\fR \fInum-lines\fR] [\fB\-path\fR \fIpictures-dir\fR] [\fB\-separator\fR \fIchar\fR] [\fB\-webpath\fR \fIpictures-path\fR] \fIlog-file\fR [\fIlog-file\fR ...] .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBinnreport\fR is a Perl script that summarizes INN log files, with optional HTML output and graphs. It is normally invoked by scanlogs(8) which includes the output of \fBinnreport\fR in daily Usenet reports. .PP Supported programs are \fBbatcher\fR, \fBcnfsstat\fR, \fBcontrolchan\fR, \fBinnd\fR, \&\fBinnfeed\fR, \fBinnxbatch\fR, \fBinnxmit\fR, \fBnnrpd\fR, \fBnntplink\fR (an external program), \fBoverchan\fR, \fBperl-nocem\fR and \fBrnews\fR. .PP \&\fBinnreport\fR also updates the count of newsgroups not locally carried by the news server, and for which articles have been received, in the \&\fIunwanted.log\fR log file. If that update should not be done, as it should occur only once a day while parsing daily logs, the \fB\-notdaily\fR flag should be given to \fBinnreport\fR. .PP If you want \fBinnreport\fR to generate graphs in its HTML reports, you need the Perl graphic library \fIGD.pm\fR. .PP At least one non-empty log file to parse should be given at the end of the command line invoking \fBinnreport\fR. .SH OPTIONS .IX Header "OPTIONS" Only one option is mandatory: .IP "\fB\-f\fR \fIconfig-file\fR" 4 .IX Item "-f config-file" Full path to the configuration file. It is usually \fIinnreport.conf\fR in \&\fIpathetc\fR, but there is no default value. This file lists the options to use for the report. The options given in command line when calling \&\fBinnreport\fR take precedence over the ones in the configuration file. .PP The other options are optional. Prepending \f(CW\*(C`no\*(C'\fR in front of boolean options permits unsetting them. For example, use \fB\-nograph\fR to remove the feature \fB\-graph\fR enables. .IP "\fB\-archive\fR or \fB\-a\fR" 4 .IX Item "-archive or -a" Sets whether HTML pages and graphs should be archived if HTML reports are enabled. When this option is set, which is the default, a date will be added in the file name of each report and each graph. Otherwise, only the latest HTML report is kept. .IP \fB\-casesensitive\fR 4 .IX Item "-casesensitive" Whether to do case sensitive searches in news log files for predetermined patterns. This option is enabled by default. .IP \fB\-config\fR 4 .IX Item "-config" Prints to standard output configuration information for \fBinnreport\fR, and exits. .IP "\fB\-cycle\fR or \fB\-c\fR \fInum-cycle\fR" 4 .IX Item "-cycle or -c num-cycle" Sets how many report files should be kept if HTML reports are enabled and archived. The default is \f(CW\*(C`0\*(C'\fR, meaning all archives are kept. .IP "\fB\-dir\fR or \fB\-d\fR \fIhttp-dir\fR" 4 .IX Item "-dir or -d http-dir" Sets the directory for web pages if HTML reports are enabled. The default is the value of \fIpathhttp\fR as set in \fIinn.conf\fR. .IP "\fB\-graph\fR or \fB\-g\fR" 4 .IX Item "-graph or -g" If the Perl graphic library \fIGD.pm\fR is installed and HTML reports are enabled, graphs are also generated in PNG if supported by \f(CW\*(C`GD\*(C'\fR, which is the case in modern versions (GIF will otherwise be generated). The default is to enable graph generation. .IP "\fB\-help\fR or \fB\-h\fR" 4 .IX Item "-help or -h" Prints to standard output a help message with all the options recognized by \fBinnreport\fR, and exits. .IP \fB\-html\fR 4 .IX Item "-html" Besides the plain text report printed to standard output, \fBinnreport\fR generates HTML reports if this option is enabled. This option is disabled by default (that is to say \fB\-nohtml\fR is the default). .IP \fB\-html\-unknown\fR 4 .IX Item "-html-unknown" Whether to report unknown entries from news log files in HTML reports, when enabled. This option takes by default the same value as the one for text plain reports (as set with the \fIunknown\fR option). .IP "\fB\-index\fR or \fB\-i\fR" 4 .IX Item "-index or -i" Sets the name of the index web page if HTML reports are enabled. The default is \f(CW\*(C`index.html\*(C'\fR. .IP "\fB\-maxunrec\fR \fInum-lines\fR" 4 .IX Item "-maxunrec num-lines" How many unrecognized entries from news log files to report, when the \&\fB\-unknown\fR or \fB\-html\-unknown\fR options are set. The default is \f(CW\*(C`50\*(C'\fR. Using \f(CW\*(C`\-1\*(C'\fR means there is no limit. .IP \fB\-notdaily\fR 4 .IX Item "-notdaily" Whether to defer daily actions for this run of \fBinnreport\fR. Some actions should be performed only once a day for a log file (notably \fIunwanted.log\fR). This option is disabled by default, meaning that all actions are always done, as we assume a default setup of running \fBscanlogs\fR daily. .IP "\fB\-path\fR or \fB\-p\fR \fIpictures-dir\fR" 4 .IX Item "-path or -p pictures-dir" Sets the directory for pictures if HTML reports are enabled, and graphs are wanted. The default is \fIpathhttp\fR/\fIpics\fR. .Sp If both \fB\-dir\fR and \fB\-webpath\fR are used, and \fB\-path\fR isn't, the directory used for pictures defaults to \fIhttp-dir as set with \fR\f(BI\-dir\fR/\fIpictures-path as set with \fR\f(BI\-webpath\fR\fI\fR. .IP "\fB\-separator\fR or \fB\-s\fR \fIchar\fR" 4 .IX Item "-separator or -s char" Sets the separator between hours, minutes and seconds in file names if HTML reports are enabled and archived. The default is \f(CW\*(C`.\*(C'\fR as \f(CW\*(C`:\*(C'\fR may not be properly read by all web browsers. Be careful \fInot\fR to use \f(CW\*(C`/\*(C'\fR as a separator, and to use only a valid file name character. .IP \fB\-unknown\fR 4 .IX Item "-unknown" Whether to report unknown entries from news log files in plain text reports. This option is enabled by default. .IP \fB\-v\fR 4 .IX Item "-v" Prints to standard output the version number of \fBinnreport\fR, and exits. .IP "\fB\-webpath\fR or \fB\-w\fR \fIpictures-path\fR" 4 .IX Item "-webpath or -w pictures-path" Sets the web path for pictures in HTML pages if HTML reports are enabled, and graphs are wanted. The default is \f(CW\*(C`pics\*(C'\fR. It can be a relative path or an absolute path. If an absolute path is used, you have to set \fB\-path\fR appropriately; otherwise it will not be computed right. .SH HISTORY .IX Header "HISTORY" Written by Fabien Tassin for InterNetNews. Rewritten into POD by Julien Elie. .SH "SEE ALSO" .IX Header "SEE ALSO" innreport.conf(5), news.daily(8), newslog(5), scanlogs(8).