From: Thomas Hochstein Date: Sun, 11 Aug 2013 20:44:08 +0000 (+0200) Subject: Some documentation fixes and enhancments. X-Git-Tag: 0.01~1^2^2 X-Git-Url: https://code.th-h.de/?p=usenet%2Fnewsstats.git;a=commitdiff_plain;h=95d9fe2cfd944f93036d3c584328a91d952c5c7c Some documentation fixes and enhancments. Signed-off-by: Thomas Hochstein --- diff --git a/doc/INSTALL b/doc/INSTALL index 0c2790c..3539ab2 100644 --- a/doc/INSTALL +++ b/doc/INSTALL @@ -1,7 +1,7 @@ NewsStats 0.1 (c) 2010-2012 Thomas Hochstein -NewsStats is a software package for gathering statistical data live -from a Usenet feed and subsequent examination. +NewsStats is a software package used to gather statistical information +from a live Usenet feed and for its subsequent examination. This script package is free software; you can redistribute it and/or modify it under the terms of the GNU Public License as published by diff --git a/feedlog.pl b/feedlog.pl index 636de83..0814f2c 100755 --- a/feedlog.pl +++ b/feedlog.pl @@ -200,7 +200,7 @@ Suppress logging to syslog. =head1 INSTALLATION -See L +See L. =head1 EXAMPLES diff --git a/gatherstats.pl b/gatherstats.pl index 4c539f1..64ea87b 100755 --- a/gatherstats.pl +++ b/gatherstats.pl @@ -205,7 +205,7 @@ gatherstats - process statistical data from a raw source =head1 SYNOPSIS -B [B<-Vhdt>] [B<-m> I | I] [B<-s> I I]] [B<--hierarchy> I] [B<--rawdb> I] [B<-groupsdb> I] [B<--clientsdb> I] [B<--hostsdb> I] +B [B<-Vhdt>] [B<-m> I | I] [B<-s> I] [B<-c> I]] [B<--hierarchy> I] [B<--rawdb> I] [B<-groupsdb> I] [B<--clientsdb> I] [B<--hostsdb> I] =head1 REQUIREMENTS @@ -292,7 +292,6 @@ 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). - =item B<-s>, B<--stats> I Set processing type to one of I and I. Defaults to all @@ -306,8 +305,9 @@ one group on each line and ignoring everything after the first whitespace (so you can use a file in checkgroups format or (part of) your INN active file). -The filename is taken from I, amended by each B<-- -month> B is processing, so that +The filename is taken from I, amended by each +B<--month> B is processing in the form of I, +so that gatherstats -m 2010-01:2010-12 -c checkgroups diff --git a/groupstats.pl b/groupstats.pl index 14d19c6..efd34ef 100755 --- a/groupstats.pl +++ b/groupstats.pl @@ -372,6 +372,9 @@ Restrict output to those newgroups present in a file in checkgroups format (one newgroup name per line; everything after the first whitespace on each line is ignored). All other newsgroups will be removed from output. +Contrary to B, I is not a template, but refers to +a single file in checkgroups format. + =item B<-r>, B<--report> I Choose the report type: I, I or I @@ -429,8 +432,8 @@ you'll get the following result: de.comp.datenbanken.misc has not been considered even though it has 38 postings in total, because it has less than 25 postings in every single -month. If you want to list all newsgroups with more than 25 postings U, you'll have to set the boundary type to I, see below. +month. If you want to list all newsgroups with more than 25 postings +I, you'll have to set the boundary type to I, see below. A boundary type of I will show only those newsgroups - at all - that satisfy the boundaries in each and every single month. With the above @@ -442,10 +445,10 @@ you'll get this result: de.comp.datenbanken.ms-access 293 de.comp.datenbanken.mysql has not been considered because it had less than -25 postings in 2012-02. +25 postings in 2012-02 (only). You can use that to get a list of newsgroups that have more (or less) then -x postings during the whole reporting period. +x postings in every month during the whole reporting period. A boundary type of I will show only those newsgroups - at all -that satisfy the boundaries on average. With the above list of newsgroups and