1INNREPORT.CONF(5) InterNetNews Documentation INNREPORT.CONF(5)
2
6 innreport.conf - Configuration file for innreport
7
9 The file pathetc/innreport.conf permits configuring the behaviour of
10 innreport. It consists of a series of lines; blank lines and what
11 follows a number sign ("#") in a line are ignored. The structure of
12 this file is:
13 section default {
15 libpath "/path/to/libraries";
16 logpath "/path/to/logs";
17 module "innreport_inn";
18 unwanted_log "unwanted.log";
19 text true;
20 html true; # Enable HTML reports.
21 # Other options to set.
22 };
23 Only this very section needs being configured. It begins with "section
25 default {" and ends with "};". Each line in the section consists of an
26 option name followed with one or more spaces or tabulations, its value
27 and a semi-colon ";".
28 Other sections are present in the configuration file to parameter the
30 display, how and what to report, but should not be changed (unless you
31 precisely know what you are doing).
32
34 The following options can be set in the "default" section of the
35 configuration file:
36 archive
38 Sets whether HTML pages and graphs should be archived if HTML
39 reports are enabled. When this option is set to "true", which is
40 the default, a date will be added in the file name of each report
41 and each graph. Otherwise, only the latest HTML report is kept.
42 Use of the -[no]archive flag with innreport(8) takes precedence
44 over the configuration file.
45 casesensitive
47 When this option is set to "true", which is the default, case
48 sensitive searches are done in news log files for predetermined
49 patterns.
50 Use of the -[no]casesensitive flag with innreport(8) takes
52 precedence over the configuration file.
53 cycle
55 Sets how many report files should be kept if HTML reports are
56 enabled and archived. The default is 0, meaning all archives are
57 kept. The value "none" also means 0.
58 Use of the -cycle flag with innreport(8) takes precedence over the
60 configuration file.
61 encoding
63 Specifies the character set to use in XML and Content-Type
64 declarations of HTML reports. The default is "ISO-8859-1".
65 footer
67 Specifies a text to append to the end of the latest "<div>" tag of
68 each HTML report, where the version of innreport is displayed.
69 This option is unset by default.
70 graph
72 If the Perl graphic library GD.pm is installed and HTML reports are
73 enabled, graphs are also generated in PNG if supported by "GD",
74 which is the case in modern versions (GIF will otherwise be
75 generated). This option is set to "true" by default, meaning to
76 enable graph generation.
77 Use of the -[no]graph flag with innreport(8) takes precedence over
79 the configuration file.
80 graph_bg
82 Specifies the background colour of graphs in HTML reports as an
83 HTML hexadecimal colour value. The default is "#FFFFFF" (white).
84 graph_fg
86 Specifies the foreground colour of graphs in HTML reports as an
87 HTML hexadecimal colour value. The default is "#000000" (black).
88 graph_width
90 Sets the width in pixels of graphs in HTML reports. The default is
91 550.
92 html
94 This is a mandatory option with no default value. It serves two
95 purposes: generating HTML reports besides the plain text report
96 printed to standard output, and configuring in the sections other
97 than "default" in the configuration file whether a section of the
98 report should be present in the HTML output.
99 If set to "true", and the -nohtml flag not given when calling
101 innreport, HTML reports will be generated. These reports will not
102 contain sections individually having html set to "false" in the
103 configuration file (by default, everything is present in the HTML
104 reports). Otherwise, if the -nohtml flag is given, no HTML reports
105 will be generated.
106 If set to "false", and the -html flag not given when calling
108 innreport, no HTML reports will be generated. Otherwise, if the
109 -html flag is given, HTML reports will be generated but only the
110 sections individually having html set to "true" in the
111 configuration file will be present in the reports.
112 html_body
114 Specifies additional elements to append to the "<body>" tag of HTML
115 reports. This option is unset by default.
116 Note that using this option leads to invalid XHTML. You should
118 provide a custom CSS file with the html_css_url option instead.
119 html_css_url
121 Specifies the name of a CSS file to use to apply a custom style to
122 HTML reports. The file is located in the directory set with the
123 html_dir option. It may also be a URL, in which case the file may
124 be in another location.
125 If unset, which is the default, innreport creates a default
127 innreport.css custom style sheet in html_dir and uses it for HTML
128 reports.
129 In case you wish to supply your own style, take a look at what is
131 defined in the default CSS and the HTML reports, and adapt it for
132 your needs. Across several innreport releases that may change
133 classes, make sure to keep old class definitions for backward
134 compatibility with previously generated HTML reports still
135 referring to that custom file.
136 html_dir
138 Sets the directory for web pages if HTML reports are enabled. The
139 default is the value of pathhttp as set in inn.conf.
140 Use of the -dir flag with innreport(8) takes precedence over the
142 configuration file.
143 html_file_extension
145 Defines the file extension of generated HTML reports, if enabled.
146 A dot (".") should begin the extension. The default is ".html".
147 You may want to use ".xhtml" instead to let the web server serve
149 correct MIME type, as innreport generates XHTML 1.1 pages.
150 html_footer_file
152 Specifies the name of a file in html_dir whose contents will be
153 appended just before the "</body>" tag of each HTML report. This
154 option is unset by default.
155 html_header_file
157 Specifies the name of a file in html_dir whose contents will be
158 appended just after the "<body>" tag of each HTML report. This
159 option is unset by default.
160 html-unknown
162 Whether to report unknown entries from news log files in HTML
163 reports, when set to "true". This option takes by default the same
164 value as the one for text plain reports (as set with the unknown
165 option).
166 Use of the -[no]html-unknown flag with innreport(8) takes
168 precedence over the configuration file.
169 html_xsl_url
171 Specifies the name of an XSL file to use to apply styling
172 operations to HTML reports. The file is located in the directory
173 set with the html_dir option. It may also be a URL, in which case
174 the file may be in another location.
175 This option is unset by default. When set, a corresponding XML
177 style sheet declaration is added to HTML reports. It may be useful
178 for XHTML compliance with older browsers (see
179 <https://www.w3.org/MarkUp/2004/xhtml-faq#ie>).
180 More generally, if you are interested in XSL transformation, you
182 may want to have a look at innreport-filter.xslt provided in the
183 contrib directory.
184 img_dir
186 Sets the web path for pictures in HTML pages if HTML reports are
187 enabled, and graphs are wanted. The path is relative to the
188 directory set with the html_dir option. The default is "pics".
189 Use of the -webpath flag with innreport(8) takes precedence over
191 the configuration file.
192 index
194 Sets the name of the index web page if HTML reports are enabled.
195 The default is "index.html".
196 You may want to use "index.xhtml" instead to let the web server
198 serve correct MIME type, as innreport generates XHTML 1.1 pages.
199 Use of the -index flag with innreport(8) takes precedence over the
201 configuration file.
202 libpath
204 Defines the directory in which the Perl module set with the module
205 option is located. This option is mandatory, and usually set to
206 the same value as pathlib in inn.conf.
207 logpath
209 Defines the directory in which the log file for newsgroups not
210 locally carried by the news server, as set with the unwanted_log
211 option, is located. This option is mandatory, and usually set to
212 the same value as pathlog in inn.conf.
213 max_unknown
215 How many unrecognized entries from news log files to report, when
216 the unknown or html-unknown options are set. The default is 50.
217 Using "-1" means there is no limit.
218 Use of the -maxunrec flag with innreport(8) takes precedence over
220 the configuration file.
221 module
223 Defines the Perl module used by innreport to parse and summarize
224 log files. This option is mandatory, and usually set to
225 "innreport_inn". This value should not normally be changed unless
226 you know exactly what you are doing. The Perl module that will be
227 loaded is module.pm located in the directory set with the libpath
228 option.
229 separator
231 Sets the separator between hours, minutes and seconds in file names
232 if HTML reports are enabled and archived. The default is "." as
233 ":" may not be properly read by all web browsers. Be careful not
234 to use "/" as a separator, and to use only a valid file name
235 character.
236 Use of the -separator flag with innreport(8) takes precedence over
238 the configuration file.
239 text
241 This is a mandatory option with no default value.
242 If set to "true", innreport will print its text report to standard
244 output. This report will not contain sections individually having
245 text set to "false" in the configuration file (by default,
246 everything is present in the text report).
247 If set to "false", innreport will only print to standard output the
249 sections individually having text set to "true" in the
250 configuration file (by default, the text report will be empty).
251 title
253 Specifies the text to use as first words of text and HTML reports
254 as well as in the title of HTML reports. By default, "Daily Usenet
255 report" is used.
256 transparent
258 If set to "true", the background of generated graphs in HTML
259 reports will be transparent. The default is "false".
260 unknown
262 Whether to report unknown entries from news log files in plain text
263 reports, when set to "true". This option is enabled by default.
264 Use of the -[no]unknown flag with innreport(8) takes precedence
266 over the configuration file.
267 unwanted_log
269 Defines the name of the file used by innreport to maintain a count
270 of the number of articles that were rejected because they were
271 posted to newsgroups that do not exist in the active file of the
272 news server. This file is updated by innreport while processing
273 the news.notice log file and it is maintained in reverse numeric
274 order (the most popular rejected group first).
275 This option is mandatory, and usually set to "unwanted.log". This
277 value should not normally be changed unless you know exactly what
278 you are doing. The file is located in the directory set with the
279 logpath option.
280 Note that logtrash has to be set to true in inn.conf for this file
282 to be generated.
283
285 Written by Julien Elie for InterNetNews.
286
288 innreport(8).
289INN 2.6.5 2022-01-23 INNREPORT.CONF(5)