1INNREPORT(8) InterNetNews Documentation INNREPORT(8)
2
6 innreport - Summarize INN log files
7
9 innreport -f config-file [-config] [-help] [-v] [-[no]archive]
10 [-[no]casesensitive] [-[no]graph] [-[no]html] [-[no]html-unknown]
11 [-[no]notdaily] [-[no]unknown] [-cycle num-cycle] [-dir http-dir]
12 [-index index-file] [-maxunrec num-lines] [-path pictures-dir]
13 [-separator char] [-webpath pictures-path] log-file [log-file ...]
14
16 innreport is a Perl script that summarizes INN log files, with optional
17 HTML output and graphs. It is normally invoked by scanlogs(8) which
18 includes the output of innreport in daily Usenet reports.
19 Supported programs are batcher, cnfsstat, controlchan, innd, innfeed,
21 innxbatch, innxmit, nnrpd, nntplink (an external program), overchan,
22 perl-nocem and rnews.
23 innreport also updates the count of newsgroups not locally carried by
25 the news server, and for which articles have been received, in the
26 unwanted.log log file. If that update should not be done, as it should
27 occur only once a day while parsing daily logs, the -notdaily flag
28 should be given to innreport.
29 If you want innreport to generate graphs in its HTML reports, you need
31 the Perl graphic library GD.pm.
32 At least one non-empty log file to parse should be given at the end of
34 the command line invoking innreport.
35
37 Only one option is mandatory:
38 -f config-file
40 Full path to the configuration file. It is usually innreport.conf
41 in pathetc, but there is no default value. This file lists the
42 options to use for the report. The options given in command line
43 when calling innreport take precedence over the ones in the
44 configuration file.
45 The other options are optional. Prepending "no" in front of boolean
47 options permits unsetting them. For example, use -nograph to remove
48 the feature -graph enables.
49 -archive or -a
51 Sets whether HTML pages and graphs should be archived if HTML
52 reports are enabled. When this option is set, which is the
53 default, a date will be added in the file name of each report and
54 each graph. Otherwise, only the latest HTML report is kept.
55 -casesensitive
57 Whether to do case sensitive searches in news log files for
58 predetermined patterns. This option is enabled by default.
59 -config
61 Prints to standard output configuration information for innreport,
62 and exits.
63 -cycle or -c num-cycle
65 Sets how many report files should be kept if HTML reports are
66 enabled and archived. The default is 0, meaning all archives are
67 kept.
68 -dir or -d http-dir
70 Sets the directory for web pages if HTML reports are enabled. The
71 default is the value of pathhttp as set in inn.conf.
72 -graph or -g
74 If the Perl graphic library GD.pm is installed and HTML reports are
75 enabled, graphs are also generated in PNG if supported by "GD",
76 which is the case in modern versions (GIF will otherwise be
77 generated). The default is to enable graph generation.
78 -help or -h
80 Prints to standard output a help message with all the options
81 recognized by innreport, and exits.
82 -html
84 Besides the plain text report printed to standard output, innreport
85 generates HTML reports if this option is enabled. This option is
86 disabled by default (that is to say -nohtml is the default).
87 -html-unknown
89 Whether to report unknown entries from news log files in HTML
90 reports, when enabled. This option takes by default the same value
91 as the one for text plain reports (as set with the unknown option).
92 -index or -i
94 Sets the name of the index web page if HTML reports are enabled.
95 The default is "index.html".
96 -maxunrec num-lines
98 How many unrecognized entries from news log files to report, when
99 the -unknown or -html-unknown options are set. The default is 50.
100 Using "-1" means there is no limit.
101 -notdaily
103 Whether to defer daily actions for this run of innreport. Some
104 actions should be performed only once a day for a log file (notably
105 unwanted.log). This option is disabled by default, meaning that
106 all actions are always done, as we assume a default setup of
107 running scanlogs daily.
108 -path or -p pictures-dir
110 Sets the directory for pictures if HTML reports are enabled, and
111 graphs are wanted. The default is pathhttp/pics.
112 If both -dir and -webpath are used, and -path isn't, the directory
114 used for pictures defaults to http-dir as set with -dir/pictures-
115 path as set with -webpath.
116 -separator or -s char
118 Sets the separator between hours, minutes and seconds in file names
119 if HTML reports are enabled and archived. The default is "." as
120 ":" may not be properly read by all web browsers. Be careful not
121 to use "/" as a separator, and to use only a valid file name
122 character.
123 -unknown
125 Whether to report unknown entries from news log files in plain text
126 reports. This option is enabled by default.
127 -v Prints to standard output the version number of innreport, and
129 exits.
130 -webpath or -w pictures-path
132 Sets the web path for pictures in HTML pages if HTML reports are
133 enabled, and graphs are wanted. The default is "pics". It can be
134 a relative path or an absolute path. If an absolute path is used,
135 you have to set -path appropriately; otherwise it will not be
136 computed right.
137
139 Written by Fabien Tassin <fta@sofaraway.org> for InterNetNews.
140 Rewritten into POD by Julien Elie.
141
143 innreport.conf(5), news.daily(8), newslog(5), scanlogs(8).
144INN 2.7.0 2022-07-10 INNREPORT(8)