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 display_conf_file "innreport-display.conf";
19 unwanted_log "unwanted.log";
20 text true;
21 html true; # Enable HTML reports.
22 # Other options to set.
23 };
24 Only this default section needs being configured. It begins with
26 "section default {" and ends with "};". Each line in the section
27 consists of an option name followed with one or more spaces or
28 tabulations, its value and a semi-colon ";".
29 The display_conf_file option defines the name of the display
31 configuration file to use. This file, located in libpath, has the same
32 syntax as innreport.conf. If you want to use a custom display
33 configuration, just rename the default innreport-display.conf file to
34 another name, and set it in display_conf_file (otherwise,
35 innreport-display.conf will be overwritten each time you update INN).
36 Sections defined in the display configuration file are used to
38 parameterize the display, how and what to report, but should not
39 normally be changed (unless you precisely know what you are doing).
40 These sections are written in a domain-specific language not intended
41 to be modified (you may break the reports, especially if changing data,
42 double, format, primary, sort, total or value parameters). The easiest
43 parameters to change, if needed, would be:
44 • title (the titles of sections in innreport),
46 • name (the names of the columns),
48 • color (the color of curves in the graphs),
50 • numbering (a boolean value to configure whether each row of HTML
52 reports is prefixed with a rank number),
53 • text, html, and skip (boolean values to configure whether a given
55 section should be present in respectively text, HTML or both
56 reports),
57 • top (the maximum number of values to display); you can specify
59 different values for text and HTML reports with top_text and
60 top_html.
61
63 The following options can be set in the default section of the general
64 configuration file innreport.conf:
65 archive
67 Sets whether HTML pages and graphs should be archived if HTML
68 reports are enabled. When this option is set to "true", which is
69 the default, a date will be added in the file name of each report
70 and each graph. Otherwise, only the latest HTML report is kept.
71 Use of the -[no]archive flag with innreport(8) takes precedence
73 over the configuration file.
74 casesensitive
76 When this option is set to "true", which is the default, case
77 sensitive searches are done in news log files for predetermined
78 patterns.
79 Use of the -[no]casesensitive flag with innreport(8) takes
81 precedence over the configuration file.
82 cycle
84 Sets how many report files should be kept if HTML reports are
85 enabled and archived. The default is 0, meaning all archives are
86 kept. The value "none" also means 0.
87 Use of the -cycle flag with innreport(8) takes precedence over the
89 configuration file.
90 display_conf_file
92 Defines the display configuration file to use, located in the
93 directory set with the libpath option. The default is
94 "innreport-display.conf".
95 encoding
97 Specifies the character set to use in XML and Content-Type
98 declarations of HTML reports. The default is "ISO-8859-1".
99 footer
101 Specifies a text to append to the end of the latest "<div>" tag of
102 each HTML report, where the version of innreport is displayed.
103 This option is unset by default.
104 graph
106 If the Perl graphic library GD.pm is installed and HTML reports are
107 enabled, graphs are also generated in PNG if supported by "GD",
108 which is the case in modern versions (GIF will otherwise be
109 generated). This option is set to "true" by default, meaning to
110 enable graph generation.
111 Use of the -[no]graph flag with innreport(8) takes precedence over
113 the configuration file.
114 graph_bg
116 Specifies the background colour of graphs in HTML reports as an
117 HTML hexadecimal colour value. The default is "#FFFFFF" (white).
118 graph_fg
120 Specifies the foreground colour of graphs in HTML reports as an
121 HTML hexadecimal colour value. The default is "#000000" (black).
122 graph_width
124 Sets the width in pixels of graphs in HTML reports. The default is
125 550.
126 html
128 This is a mandatory option with no default value. It serves two
129 purposes: generating HTML reports besides the plain text report
130 printed to standard output, and configuring in the sections other
131 than default (in the display configuration file) whether a section
132 of the report should be present in the HTML output.
133 If set to "true", and the -nohtml flag not given when calling
135 innreport, HTML reports will be generated. These reports will not
136 contain sections individually having html set to "false" in the
137 display configuration file (by default, everything is present in
138 the HTML reports). Otherwise, if the -nohtml flag is given, no
139 HTML reports will be generated.
140 If set to "false", and the -html flag not given when calling
142 innreport, no HTML reports will be generated. Otherwise, if the
143 -html flag is given, HTML reports will be generated but only the
144 sections individually having html set to "true" in the display
145 configuration file will be present in the reports.
146 html_body
148 Specifies additional elements to append to the "<body>" tag of HTML
149 reports. This option is unset by default.
150 Note that using this option leads to invalid XHTML. You should
152 provide a custom CSS file with the html_css_url option instead.
153 html_css_url
155 Specifies the name of a CSS file to use to apply a custom style to
156 HTML reports. The file is located in the directory set with the
157 html_dir option. It may also be a URL, in which case the file may
158 be in another location.
159 If unset, which is the default, innreport creates a default
161 innreport.css custom style sheet in html_dir and uses it for HTML
162 reports.
163 In case you wish to supply your own style, take a look at what is
165 defined in the default CSS and the HTML reports, and adapt it for
166 your needs. Across several innreport releases that may change
167 classes, make sure to keep old class definitions for backward
168 compatibility with previously generated HTML reports still
169 referring to that custom file.
170 html_dir
172 Sets the directory for web pages if HTML reports are enabled. The
173 default is the value of pathhttp as set in inn.conf.
174 Use of the -dir flag with innreport(8) takes precedence over the
176 configuration file.
177 html_file_extension
179 Defines the file extension of generated HTML reports, if enabled.
180 A dot (".") should begin the extension. The default is ".html".
181 You may want to use ".xhtml" instead to let the web server serve
183 correct MIME type, as innreport generates XHTML 1.1 pages.
184 html_footer_file
186 Specifies the name of a file in html_dir whose contents will be
187 appended just before the "</body>" tag of each HTML report. This
188 option is unset by default.
189 html_header_file
191 Specifies the name of a file in html_dir whose contents will be
192 appended just after the "<body>" tag of each HTML report. This
193 option is unset by default.
194 html-unknown
196 Whether to report unknown entries from news log files in HTML
197 reports, when set to "true". This option takes by default the same
198 value as the one for text plain reports (as set with the unknown
199 option).
200 Use of the -[no]html-unknown flag with innreport(8) takes
202 precedence over the configuration file.
203 html_xsl_url
205 Specifies the name of an XSL file to use to apply styling
206 operations to HTML reports. The file is located in the directory
207 set with the html_dir option. It may also be a URL, in which case
208 the file may be in another location.
209 This option is unset by default. When set, a corresponding XML
211 style sheet declaration is added to HTML reports. It may be useful
212 for XHTML compliance with older browsers (see
213 <https://www.w3.org/MarkUp/2004/xhtml-faq#ie>).
214 More generally, if you are interested in XSL transformation, you
216 may want to have a look at innreport-filter.xslt provided in the
217 contrib directory.
218 img_dir
220 Sets the web path for pictures in HTML pages if HTML reports are
221 enabled, and graphs are wanted. The path is relative to the
222 directory set with the html_dir option. The default is "pics".
223 Use of the -webpath flag with innreport(8) takes precedence over
225 the configuration file.
226 index
228 Sets the name of the index web page if HTML reports are enabled.
229 The default is "index.html".
230 You may want to use "index.xhtml" instead to let the web server
232 serve correct MIME type, as innreport generates XHTML 1.1 pages.
233 Use of the -index flag with innreport(8) takes precedence over the
235 configuration file.
236 libpath
238 Defines the directory in which the Perl module set with the module
239 option is located. This option is mandatory, and usually set to
240 the same value as pathlib in inn.conf.
241 logpath
243 Defines the directory in which the log file for newsgroups not
244 locally carried by the news server, as set with the unwanted_log
245 option, is located. This option is mandatory, and usually set to
246 the same value as pathlog in inn.conf.
247 max_unknown
249 How many unrecognized entries from news log files to report, when
250 the unknown or html-unknown options are set. The default is 50.
251 Using "-1" means there is no limit.
252 Use of the -maxunrec flag with innreport(8) takes precedence over
254 the configuration file.
255 module
257 Defines the Perl module used by innreport to parse and summarize
258 log files. This option is mandatory, and usually set to
259 "innreport_inn". This value should not normally be changed unless
260 you know exactly what you are doing. The Perl module that will be
261 loaded is module.pm located in the directory set with the libpath
262 option.
263 separator
265 Sets the separator between hours, minutes and seconds in file names
266 if HTML reports are enabled and archived. The default is "." as
267 ":" may not be properly read by all web browsers. Be careful not
268 to use "/" as a separator, and to use only a valid file name
269 character.
270 Use of the -separator flag with innreport(8) takes precedence over
272 the configuration file.
273 text
275 This is a mandatory option with no default value.
276 If set to "true", innreport will print its text report to standard
278 output. This report will not contain sections individually having
279 text set to "false" in the display configuration file (by default,
280 everything is present in the text report).
281 If set to "false", innreport will only print to standard output the
283 sections individually having text set to "true" in the display
284 configuration file (by default, the text report will be empty).
285 title
287 Specifies the text to use as first words of text and HTML reports
288 as well as in the title of HTML reports. By default, "Daily Usenet
289 report" is used.
290 transparent
292 If set to "true", the background of generated graphs in HTML
293 reports will be transparent. The default is "false".
294 unknown
296 Whether to report unknown entries from news log files in plain text
297 reports, when set to "true". This option is enabled by default.
298 Use of the -[no]unknown flag with innreport(8) takes precedence
300 over the configuration file.
301 unwanted_log
303 Defines the name of the file used by innreport to maintain a count
304 of the number of articles that were rejected because they were
305 posted to newsgroups that do not exist in the active file of the
306 news server. This file is updated by innreport while processing
307 the news.notice log file and it is maintained in reverse numeric
308 order (the most popular rejected group first).
309 This option is mandatory, and usually set to "unwanted.log". This
311 value should not normally be changed unless you know exactly what
312 you are doing. The file is located in the directory set with the
313 logpath option.
314 Note that logtrash has to be set to true in inn.conf for this file
316 to be generated.
317
319 Written by Julien Elie for InterNetNews.
320
322 innreport(8).
323INN 2.7.1 2023-03-07 INNREPORT.CONF(5)