thh/newsstats
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Activity

Update documentation.

Browse source 
- Fix clientstats doc (copied from hoststats).
- Add some more examples ro README.

Signed-off-by: Thomas Hochstein <thh@thh.name>
This commit is contained in:
Thomas Hochstein 2025-06-01 16:39:25 +02:00
parent 0b87e81b08
commit 66890b68d8
11 changed files with 329 additions and 263 deletions
Download patch file Download diff file Expand all files Collapse all files

22
bin/gatherstats.pl
View file

@ -803,12 +803,12 @@ override that default through the B<--clientsdb> option.
=head2 Configuration
B<gatherstats> will read its configuration from F<newsstats.conf>
which should be present in etc/ via Config::Auto or from a configuration file
submitted by the B<--conffile> option.
which should be present in etc/ via Config::Auto or from a configuration
file submitted by the B<--conffile> option.
See L<doc/INSTALL> for an overview of possible configuration options.
You can override configuration options via the B<--hierarchy>,
You can override configuration options by using the B<--hierarchy>,
B<--rawdb>, B<--groupsdb>, B<--clientsdb> and B<--hostsdb> options,
respectively.
@ -818,15 +818,15 @@ respectively.
=item B<-V>, B<--version>
Print out version and copyright information and exit.
Display version and copyright information and exit.
=item B<-h>, B<--help>
Print this man page and exit.
Display this man page and exit.
=item B<-d>, B<--debug>
Output debugging information to STDOUT while processing (number of
Print debugging information to STDOUT while processing (number of
postings per group).
=item B<-t>, B<--test>
@ -838,15 +838,17 @@ conjunction with B<--test> ... everything else seems a bit pointless.
Set processing period to a single month in YYYY-MM format or to a time
period between two month in YYYY-MM:YYYY-MM format (two month, separated
by a colon).
by a colon). Defaults to last month.
=item B<-s>, B<--stats> I<type>
Set processing type to one of I<all>, I<groups> or I<hosts>. Defaults
to all.
Set processing type to one of I<all>, I<groups>, I<hosts> or I<clients>.
Defaults to I<all>.
=item B<-c>, B<--checkgroups> I<filename template>
Relevant only for newsgroup stats (I<groups>).
Check each group against a list of valid newsgroups read from a file,
one group on each line and ignoring everything after the first
whitespace (so you can use a file in checkgroups format or (part of)
@ -889,7 +891,7 @@ Override I<DBTableClnts> from F<newsstats.conf>.
=item B<--conffile> I<filename>
Load configuration from I<filename> instead of F<newsstats.conf>.
Read configuration from I<filename> instead of F<newsstats.conf>.
=back