Some documentation fixes and enhancments.
Signed-off-by: Thomas Hochstein <thh@inter.net>
This commit is contained in:
		
							parent
							
								
									b31f785064
								
							
						
					
					
						commit
						95d9fe2cfd
					
				
					 4 changed files with 14 additions and 11 deletions
				
			
		| 
						 | 
				
			
			@ -1,7 +1,7 @@
 | 
			
		|||
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
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -200,7 +200,7 @@ Suppress logging to syslog.
 | 
			
		|||
 | 
			
		||||
=head1 INSTALLATION
 | 
			
		||||
 | 
			
		||||
See L<doc/INSTALL.>
 | 
			
		||||
See L<doc/INSTALL>.
 | 
			
		||||
 | 
			
		||||
=head1 EXAMPLES
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -205,7 +205,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
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -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<type>
 | 
			
		||||
 | 
			
		||||
Set processing type to one of I<all> and I<groups>. 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<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
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -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<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>
 | 
			
		||||
| 
						 | 
				
			
			@ -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<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
 | 
			
		||||
| 
						 | 
				
			
			@ -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<average> will show only those newsgroups - at all -that
 | 
			
		||||
satisfy the boundaries on average. With the above list of newsgroups and
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue