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/postingstats.pl
View file

@ -268,7 +268,7 @@ postingstats - format and post reports
=head1 SYNOPSIS
B<postingstats> B<-t> I<groups|hosts|clients> [B<-Vh> [B<-m> I<YYYY-MM>]
B<postingstats> [B<-Vh>] [B<-t> I<groups|hosts|clients>] [B<-m> I<YYYY-MM>]
=head1 REQUIREMENTS
@ -285,11 +285,13 @@ message that can be posted to Usenet.
B<postingstats> will create a table with entries numbered from most
to least and percentages calculated from the sum total of all values.
It depends on a sorted list on STDIN in I<dump> format with I<sums>.
It depends on a sorted list on STDIN in I<dump> format with I<sums>;
I<versions> from B<clientstas.pl> are optional.
B<postingstats> needs a B<--type> and a B<--month> to create a caption
and select matching lead-ins and lead-outs. B<--type> is also needed
to catch the correct sum total from input.
to catch the correct sum total from input which differs between I<groups>
on one hand and I<hosts> or I<clients> on the other hand.
It will default to posting statistics (number of postings per group)
and last month.
@ -308,7 +310,7 @@ C<----- configuration -----> section.
=item C<$TLH>
Top level hierarchy the report was created for. Used for display and
sum total.
sum total (only for I<groups>).
=item C<%Heading>
@ -327,13 +329,13 @@ Output will be truncated otherwise.
=item C<%LeadIn>
Hash with keys for I<GroupStats>, I<HostStats> and I<ClientStats>.
Used to create the headers for our posting. Can contain other text
Used to create the headers for the postings. Can contain other text
that will be shown before C<%Heading>.
=item C<%LeadOut>
Hash with keys for I<GroupStats>, I<HostStats> and I<ClientStats>.
Will be shown at the end of our posting.
Will be shown at the end of the posting.
=back
@ -343,11 +345,11 @@ Will be shown at the end of our posting.
=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<-t>, B<--type> I<groups|hosts|clients>
@ -356,7 +358,7 @@ statistics accordingly.
=item B<-m>, B<--month> I<YYYY-MM>
Set month for display.
Set month (for display only).
=back
@ -372,7 +374,7 @@ Create a posting from a posting statistics report for last month:
Create a posting from a posting statistics report for 2012-01:
groupstats.pl --nocomments --sums --format dump | postingstats.pl -t groups -m 2012-01
groupstats.pl --nocomments --sums --format dump -m 2012-01 | postingstats.pl -t groups -m 2012-01
Create a posting from a host statistics report for last month: