.\" Automatically generated by Pod::Man 4.14 (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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "INNREPORT.CONF 5" .TH INNREPORT.CONF 5 "2023-09-06" "INN 2.7.1" "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.conf \- Configuration file for innreport .SH "DESCRIPTION" .IX Header "DESCRIPTION" The file \fIpathetc\fR/innreport.conf permits configuring the behaviour of \&\fBinnreport\fR. It consists of a series of lines; blank lines and what follows a number sign (\f(CW\*(C`#\*(C'\fR) in a line are ignored. The structure of this file is: .PP .Vb 10 \& section default { \& libpath "/path/to/libraries"; \& logpath "/path/to/logs"; \& module "innreport_inn"; \& display_conf_file "innreport\-display.conf"; \& unwanted_log "unwanted.log"; \& text true; \& html true; # Enable HTML reports. \& # Other options to set. \& }; .Ve .PP Only this \fIdefault\fR section needs being configured. It begins with \f(CW\*(C`section default {\*(C'\fR and ends with \f(CW\*(C`};\*(C'\fR. Each line in the section consists of an option name followed with one or more spaces or tabulations, its value and a semi-colon \f(CW\*(C`;\*(C'\fR. .PP The \fIdisplay_conf_file\fR option defines the name of the display configuration file to use. This file, located in \fIlibpath\fR, has the same syntax as \&\fIinnreport.conf\fR. If you want to use a custom display configuration, just rename the default \fIinnreport\-display.conf\fR file to another name, and set it in \fIdisplay_conf_file\fR (otherwise, \fIinnreport\-display.conf\fR will be overwritten each time you update \s-1INN\s0). .PP Sections defined in the display configuration file are used to parameterize the display, how and what to report, but should not normally be changed (unless you precisely know what you are doing). These sections are written in a domain-specific language not intended to be modified (you may break the reports, especially if changing \fIdata\fR, \fIdouble\fR, \fIformat\fR, \fIprimary\fR, \&\fIsort\fR, \fItotal\fR or \fIvalue\fR parameters). The easiest parameters to change, if needed, would be: .IP "\(bu" 4 \&\fItitle\fR (the titles of sections in \fBinnreport\fR), .IP "\(bu" 4 \&\fIname\fR (the names of the columns), .IP "\(bu" 4 \&\fIcolor\fR (the color of curves in the graphs), .IP "\(bu" 4 \&\fInumbering\fR (a boolean value to configure whether each row of \s-1HTML\s0 reports is prefixed with a rank number), .IP "\(bu" 4 \&\fItext\fR, \fIhtml\fR, and \fIskip\fR (boolean values to configure whether a given section should be present in respectively text, \s-1HTML\s0 or both reports), .IP "\(bu" 4 \&\fItop\fR (the maximum number of values to display); you can specify different values for text and \s-1HTML\s0 reports with \fItop_text\fR and \fItop_html\fR. .SH "OPTIONS" .IX Header "OPTIONS" The following options can be set in the \fIdefault\fR section of the general configuration file \fIinnreport.conf\fR: .IP "\fIarchive\fR" 4 .IX Item "archive" Sets whether \s-1HTML\s0 pages and graphs should be archived if \s-1HTML\s0 reports are enabled. When this option is set to \f(CW\*(C`true\*(C'\fR, which is the default, a date will be added in the file name of each report and each graph. Otherwise, only the latest \s-1HTML\s0 report is kept. .Sp Use of the \fB\-\fR[\fBno\fR]\fBarchive\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIcasesensitive\fR" 4 .IX Item "casesensitive" When this option is set to \f(CW\*(C`true\*(C'\fR, which is the default, case sensitive searches are done in news log files for predetermined patterns. .Sp Use of the \fB\-\fR[\fBno\fR]\fBcasesensitive\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIcycle\fR" 4 .IX Item "cycle" Sets how many report files should be kept if \s-1HTML\s0 reports are enabled and archived. The default is \f(CW0\fR, meaning all archives are kept. The value \&\f(CW\*(C`none\*(C'\fR also means \f(CW0\fR. .Sp Use of the \fB\-cycle\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIdisplay_conf_file\fR" 4 .IX Item "display_conf_file" Defines the display configuration file to use, located in the directory set with the \fIlibpath\fR option. The default is \f(CW\*(C`innreport\-display.conf\*(C'\fR. .IP "\fIencoding\fR" 4 .IX Item "encoding" Specifies the character set to use in \s-1XML\s0 and Content-Type declarations of \&\s-1HTML\s0 reports. The default is \f(CW\*(C`ISO\-8859\-1\*(C'\fR. .IP "\fIfooter\fR" 4 .IX Item "footer" Specifies a text to append to the end of the latest \f(CW\*(C`
\*(C'\fR tag of each \&\s-1HTML\s0 report, where the version of \fBinnreport\fR is displayed. This option is unset by default. .IP "\fIgraph\fR" 4 .IX Item "graph" If the Perl graphic library \fI\s-1GD\s0.pm\fR is installed and \s-1HTML\s0 reports are enabled, graphs are also generated in \s-1PNG\s0 if supported by \f(CW\*(C`GD\*(C'\fR, which is the case in modern versions (\s-1GIF\s0 will otherwise be generated). This option is set to \f(CW\*(C`true\*(C'\fR by default, meaning to enable graph generation. .Sp Use of the \fB\-\fR[\fBno\fR]\fBgraph\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIgraph_bg\fR" 4 .IX Item "graph_bg" Specifies the background colour of graphs in \s-1HTML\s0 reports as an \s-1HTML\s0 hexadecimal colour value. The default is \f(CW\*(C`#FFFFFF\*(C'\fR (white). .IP "\fIgraph_fg\fR" 4 .IX Item "graph_fg" Specifies the foreground colour of graphs in \s-1HTML\s0 reports as an \s-1HTML\s0 hexadecimal colour value. The default is \f(CW\*(C`#000000\*(C'\fR (black). .IP "\fIgraph_width\fR" 4 .IX Item "graph_width" Sets the width in pixels of graphs in \s-1HTML\s0 reports. The default is \f(CW550\fR. .IP "\fIhtml\fR" 4 .IX Item "html" This is a mandatory option with no default value. It serves two purposes: generating \s-1HTML\s0 reports besides the plain text report printed to standard output, and configuring in the sections other than \fIdefault\fR (in the display configuration file) whether a section of the report should be present in the \&\s-1HTML\s0 output. .Sp If set to \f(CW\*(C`true\*(C'\fR, and the \fB\-nohtml\fR flag not given when calling \&\fBinnreport\fR, \s-1HTML\s0 reports will be generated. These reports will not contain sections individually having \fIhtml\fR set to \f(CW\*(C`false\*(C'\fR in the display configuration file (by default, everything is present in the \s-1HTML\s0 reports). Otherwise, if the \fB\-nohtml\fR flag is given, no \s-1HTML\s0 reports will be generated. .Sp If set to \f(CW\*(C`false\*(C'\fR, and the \fB\-html\fR flag not given when calling \fBinnreport\fR, no \s-1HTML\s0 reports will be generated. Otherwise, if the \fB\-html\fR flag is given, \&\s-1HTML\s0 reports will be generated but only the sections individually having \&\fIhtml\fR set to \f(CW\*(C`true\*(C'\fR in the display configuration file will be present in the reports. .IP "\fIhtml_body\fR" 4 .IX Item "html_body" Specifies additional elements to append to the \f(CW\*(C`\*(C'\fR tag of \s-1HTML\s0 reports. This option is unset by default. .Sp Note that using this option leads to invalid \s-1XHTML.\s0 You should provide a custom \s-1CSS\s0 file with the \fIhtml_css_url\fR option instead. .IP "\fIhtml_css_url\fR" 4 .IX Item "html_css_url" Specifies the name of a \s-1CSS\s0 file to use to apply a custom style to \s-1HTML\s0 reports. The file is located in the directory set with the \fIhtml_dir\fR option. It may also be a \s-1URL,\s0 in which case the file may be in another location. .Sp If unset, which is the default, \fBinnreport\fR creates a default \&\fIinnreport.css\fR custom style sheet in \fIhtml_dir\fR and uses it for \s-1HTML\s0 reports. .Sp In case you wish to supply your own style, take a look at what is defined in the default \s-1CSS\s0 and the \s-1HTML\s0 reports, and adapt it for your needs. Across several \fBinnreport\fR releases that may change classes, make sure to keep old class definitions for backward compatibility with previously generated \s-1HTML\s0 reports still referring to that custom file. .IP "\fIhtml_dir\fR" 4 .IX Item "html_dir" Sets the directory for web pages if \s-1HTML\s0 reports are enabled. The default is the value of \fIpathhttp\fR as set in \fIinn.conf\fR. .Sp Use of the \fB\-dir\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIhtml_file_extension\fR" 4 .IX Item "html_file_extension" Defines the file extension of generated \s-1HTML\s0 reports, if enabled. A dot (\f(CW\*(C`.\*(C'\fR) should begin the extension. The default is \f(CW\*(C`.html\*(C'\fR. .Sp You may want to use \f(CW\*(C`.xhtml\*(C'\fR instead to let the web server serve correct \&\s-1MIME\s0 type, as \fBinnreport\fR generates \s-1XHTML\s0\ 1.1 pages. .IP "\fIhtml_footer_file\fR" 4 .IX Item "html_footer_file" Specifies the name of a file in \fIhtml_dir\fR whose contents will be appended just before the \f(CW\*(C`\*(C'\fR tag of each \s-1HTML\s0 report. This option is unset by default. .IP "\fIhtml_header_file\fR" 4 .IX Item "html_header_file" Specifies the name of a file in \fIhtml_dir\fR whose contents will be appended just after the \f(CW\*(C`\*(C'\fR tag of each \s-1HTML\s0 report. This option is unset by default. .IP "\fIhtml-unknown\fR" 4 .IX Item "html-unknown" Whether to report unknown entries from news log files in \s-1HTML\s0 reports, when set to \f(CW\*(C`true\*(C'\fR. This option takes by default the same value as the one for text plain reports (as set with the \fIunknown\fR option). .Sp Use of the \fB\-\fR[\fBno\fR]\fBhtml-unknown\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIhtml_xsl_url\fR" 4 .IX Item "html_xsl_url" Specifies the name of an \s-1XSL\s0 file to use to apply styling operations to \&\s-1HTML\s0 reports. The file is located in the directory set with the \fIhtml_dir\fR option. It may also be a \s-1URL,\s0 in which case the file may be in another location. .Sp This option is unset by default. When set, a corresponding \s-1XML\s0 style sheet declaration is added to \s-1HTML\s0 reports. It may be useful for \s-1XHTML\s0 compliance with older browsers (see ). .Sp More generally, if you are interested in \s-1XSL\s0 transformation, you may want to have a look at \fIinnreport\-filter.xslt\fR provided in the \fIcontrib\fR directory. .IP "\fIimg_dir\fR" 4 .IX Item "img_dir" Sets the web path for pictures in \s-1HTML\s0 pages if \s-1HTML\s0 reports are enabled, and graphs are wanted. The path is relative to the directory set with the \&\fIhtml_dir\fR option. The default is \f(CW\*(C`pics\*(C'\fR. .Sp Use of the \fB\-webpath\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIindex\fR" 4 .IX Item "index" Sets the name of the index web page if \s-1HTML\s0 reports are enabled. The default is \f(CW\*(C`index.html\*(C'\fR. .Sp You may want to use \f(CW\*(C`index.xhtml\*(C'\fR instead to let the web server serve correct \s-1MIME\s0 type, as \fBinnreport\fR generates \s-1XHTML\s0\ 1.1 pages. .Sp Use of the \fB\-index\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIlibpath\fR" 4 .IX Item "libpath" Defines the directory in which the Perl module set with the \fImodule\fR option is located. This option is mandatory, and usually set to the same value as \fIpathlib\fR in \fIinn.conf\fR. .IP "\fIlogpath\fR" 4 .IX Item "logpath" Defines the directory in which the log file for newsgroups not locally carried by the news server, as set with the \fIunwanted_log\fR option, is located. This option is mandatory, and usually set to the same value as \fIpathlog\fR in \fIinn.conf\fR. .IP "\fImax_unknown\fR" 4 .IX Item "max_unknown" How many unrecognized entries from news log files to report, when the \&\fIunknown\fR or \fIhtml-unknown\fR options are set. The default is \f(CW50\fR. Using \f(CW\*(C`\-1\*(C'\fR means there is no limit. .Sp Use of the \fB\-maxunrec\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fImodule\fR" 4 .IX Item "module" Defines the Perl module used by \fBinnreport\fR to parse and summarize log files. This option is mandatory, and usually set to \f(CW\*(C`innreport_inn\*(C'\fR. This value should not normally be changed unless you know exactly what you are doing. The Perl module that will be loaded is \fI\fImodule\fI.pm\fR located in the directory set with the \fIlibpath\fR option. .IP "\fIseparator\fR" 4 .IX Item "separator" Sets the separator between hours, minutes and seconds in file names if \&\s-1HTML\s0 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. .Sp Use of the \fB\-separator\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fItext\fR" 4 .IX Item "text" This is a mandatory option with no default value. .Sp If set to \f(CW\*(C`true\*(C'\fR, \fBinnreport\fR will print its text report to standard output. This report will not contain sections individually having \fItext\fR set to \&\f(CW\*(C`false\*(C'\fR in the display configuration file (by default, everything is present in the text report). .Sp If set to \f(CW\*(C`false\*(C'\fR, \fBinnreport\fR will only print to standard output the sections individually having \fItext\fR set to \f(CW\*(C`true\*(C'\fR in the display configuration file (by default, the text report will be empty). .IP "\fItitle\fR" 4 .IX Item "title" Specifies the text to use as first words of text and \s-1HTML\s0 reports as well as in the title of \s-1HTML\s0 reports. By default, \f(CW\*(C`Daily Usenet report\*(C'\fR is used. .IP "\fItransparent\fR" 4 .IX Item "transparent" If set to \f(CW\*(C`true\*(C'\fR, the background of generated graphs in \s-1HTML\s0 reports will be transparent. The default is \f(CW\*(C`false\*(C'\fR. .IP "\fIunknown\fR" 4 .IX Item "unknown" Whether to report unknown entries from news log files in plain text reports, when set to \f(CW\*(C`true\*(C'\fR. This option is enabled by default. .Sp Use of the \fB\-\fR[\fBno\fR]\fBunknown\fR flag with \fBinnreport\fR\|(8) takes precedence over the configuration file. .IP "\fIunwanted_log\fR" 4 .IX Item "unwanted_log" Defines the name of the file used by \fBinnreport\fR to maintain a count of the number of articles that were rejected because they were posted to newsgroups that do not exist in the \fIactive\fR file of the news server. This file is updated by \fBinnreport\fR while processing the \fInews.notice\fR log file and it is maintained in reverse numeric order (the most popular rejected group first). .Sp This option is mandatory, and usually set to \f(CW\*(C`unwanted.log\*(C'\fR. This value should not normally be changed unless you know exactly what you are doing. The file is located in the directory set with the \fIlogpath\fR option. .Sp Note that \fIlogtrash\fR has to be set to true in \fIinn.conf\fR for this file to be generated. .SH "HISTORY" .IX Header "HISTORY" Written by Julien Elie for InterNetNews. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBinnreport\fR\|(8).