Merge branch 'language' into next

* language:
  Some documentation fixes and enhancments.
  Improve INSTALL documentation.
  README: Update copyright notice.
  README: improve phrasing.

doc/INSTALL

@@ -1,7 +1,7 @@
-NewsStats 0.1  (c) 2010 Thomas Hochstein <thh@inter.net>
+NewsStats 0.1  (c) 2010-2012 Thomas Hochstein <thh@inter.net>
 
-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
@@ -20,7 +20,8 @@ INSTALLATION INSTRUCTIONS
 
      # tar -xzf newsstats-nn.tar.gz
 
-     Scripts in this path should be executable by the news user.
+     Scripts in this path - at least feedlog.pl - should be executable by the
+     news user.
 
 2) Configuration
 
@@ -80,8 +81,8 @@ INSTALLATION INSTRUCTIONS
    * Edit your 'newsfeeds' file and insert something like
 
      ## gather statistics for NewsStats
-     newsstats!
-             :!*,de.*
+     newsstats!\
+             :!*,de.*\
              :Tc,WmtfbsPNH,Ac:/path/to/feedlog.pl
 
    * You should only feed that hierarchy (those hierarchies ...) to
@@ -109,7 +110,7 @@ INSTALLATION INSTRUCTIONS
    Everything should be going smoothly now.
 
    * If INN is spewing error messages to 'errlog' or reporting
-     continous respaws of feedlog.pl to 'news.notice', stop your feed:
+     continous respawns of feedlog.pl to 'news.notice', stop your feed:
 
      # ctlinnd drop 'newsstats!'
 

doc/README

@@ -1,4 +1,4 @@
-NewsStats 0.1  (c) 2010 Thomas Hochstein <thh@inter.net>
+NewsStats 0.1  (c) 2010-2012 Thomas Hochstein <thh@inter.net>
 
 NewsStats is a software package for gathering statistical data live
 from a Usenet feed and subsequent examination.
@@ -12,7 +12,7 @@ the Free Software Foundation.
 What's that?
 
     There's a multitude of tools for the statistical examination of
-    newsgroups: number of postings month or per person, longest
+    newsgroups: number of postings per month or per person, longest
     threads, and so on (see <http://th-h.de/infos/usenet/stats.php>
     [German language] for an incomplete list). Most of them use a per-
     newsgroup approach while NewsStats is hierarchy oriented.
@@ -27,7 +27,7 @@ Workflow
 
     That raw data will be regularly - e.g. monthly - processed to a
     second set of database tables each dedicated to a certain
-    statistical aspect, e.g. number of postings per group per month.
+    statistical aspect, e.g. number of postings per group and month.
 
     Several kinds of reports can then be generated from those result
     tables.
@@ -35,8 +35,8 @@ Workflow
 Prerequisites
 
     NewsStats is written in Perl (5.8.x and above) and makes use of a
-    MySQL database, so you'll need Perl, some modules, mysql and, of
-    course, an INN.
+    MySQL database, so you will need Perl, some modules, mysql and, of
+    course, INN.
 
     * Perl 5.8.x with standard modules
       - Cwd
@@ -62,12 +62,12 @@ Getting Started
     table. See the feedlog.pl man page for more information.
 
     You can process that data via 'gatherstats.pl'; currently only the
-    tabulation of postings per group per month is supported. More to
+    tabulation of postings per group and month is supported. More to
     come. See the gatherstats.pl man page for more information.
 
     Report generation is handled by specialised scripts for each
     report type. Currently only reports on the number of postings per
-    group per month are supported; you can use 'groupstats.pl' for
+    group and month are supported; you can use 'groupstats.pl' for
     this. See the groupstats.pl man page for more information.
 
 Reporting Bugs
@@ -95,3 +95,4 @@ Author
 
     Thomas Hochstein <thh@inter.net>
     <http://th-h.de/>
+

feedlog.pl

@@ -201,7 +201,7 @@ Suppress logging to syslog.
 
 =head1 INSTALLATION
 
-See L<doc/INSTALL.>
+See L<doc/INSTALL>.
 
 =head1 EXAMPLES
 

gatherstats.pl

@@ -206,7 +206,7 @@ gatherstats - process statistical data from a raw source
 
 =head1 SYNOPSIS
 
-B<gatherstats> [B<-Vhdt>] [B<-m> I<YYYY-MM> | I<YYYY-MM:YYYY-MM>] [B<-s> I<stats] [B<-c> I<filename template>]] [B<--hierarchy> I<TLH>] [B<--rawdb> I<database table>] [B<-groupsdb> I<database table>] [B<--clientsdb> I<database table>] [B<--hostsdb> I<database table>]
+B<gatherstats> [B<-Vhdt>] [B<-m> I<YYYY-MM> | I<YYYY-MM:YYYY-MM>] [B<-s> I<stats>] [B<-c> I<filename template>]] [B<--hierarchy> I<TLH>] [B<--rawdb> I<database table>] [B<-groupsdb> I<database table>] [B<--clientsdb> I<database table>] [B<--hostsdb> I<database table>]
 
 =head1 REQUIREMENTS
 
@@ -293,7 +293,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<type>
 
 Set processing type to one of I<all> and I<groups>. Defaults to all
@@ -307,8 +306,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<filename template>, amended by each B<--
-month> B<gatherstats> is processing, so that
+The filename is taken from I<filename template>, amended by each
+B<--month> B<gatherstats> is processing in the form of I<template-YYYY-MM>,
+so that
 
     gatherstats -m 2010-01:2010-12 -c checkgroups
 

groupstats.pl

@@ -379,6 +379,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<gatherstats>, I<filename> is not a template, but refers to
+a single file in checkgroups format.
+
 =item B<-r>, B<--report> I<default|average|sums>
 
 Choose the report type: I<default>, I<average> or I<sums>
@@ -436,8 +439,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<in
-total>, you'll have to set the boundary type to I<sum>, see below.
+month. If you want to list all newsgroups with more than 25 postings
+I<in total>, you'll have to set the boundary type to I<sum>, see below.
 
 A boundary type of I<level> will show only those newsgroups - at all -
 that satisfy the boundaries in each and every single month. With the above
@@ -449,10 +452,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<average> will show only those newsgroups - at all -that
 satisfy the boundaries on average. With the above list of newsgroups and