From: Thomas Hochstein Date: Mon, 2 Sep 2013 10:55:59 +0000 (+0200) Subject: Merge branch 'language' into next X-Git-Url: https://code.th-h.de/?p=usenet%2Fnewsstats.git;a=commitdiff_plain;h=02bad3098834ed5b0fe13ad7ca5ab351f8bcb2aa;hp=fdb2a551fb3f077bd9ea9bf20084f4e0d85657d0 Merge branch 'language' into next * language: Some documentation fixes and enhancments. Improve INSTALL documentation. README: Update copyright notice. README: improve phrasing. --- diff --git a/doc/INSTALL b/doc/INSTALL index 225fdbf..3539ab2 100644 --- a/doc/INSTALL +++ b/doc/INSTALL @@ -1,7 +1,7 @@ -NewsStats 0.1 (c) 2010 Thomas Hochstein +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 @@ -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!' diff --git a/doc/README b/doc/README index 440cd11..4c88ef2 100644 --- a/doc/README +++ b/doc/README @@ -1,4 +1,4 @@ -NewsStats 0.1 (c) 2010 Thomas Hochstein +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. @@ -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 [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 + diff --git a/feedlog.pl b/feedlog.pl index 80dbbe0..8ff868d 100755 --- a/feedlog.pl +++ b/feedlog.pl @@ -201,7 +201,7 @@ Suppress logging to syslog. =head1 INSTALLATION -See L +See L. =head1 EXAMPLES diff --git a/gatherstats.pl b/gatherstats.pl index 160c115..6db137d 100755 --- a/gatherstats.pl +++ b/gatherstats.pl @@ -206,7 +206,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 @@ -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 Set processing type to one of I and I. 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, 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 067cffc..84105cf 100755 --- a/groupstats.pl +++ b/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, 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 @@ -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, 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 @@ -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 will show only those newsgroups - at all -that satisfy the boundaries on average. With the above list of newsgroups and