Add documentation.
[usenet/newsstats.git] / doc / README
CommitLineData
610b5ef4
TH
1NewsStats 0.1 (c) 2010 Thomas Hochstein <thh@inter.net>
2
3NewsStats is a software package for gathering statistical data live
4from a Usenet feed and subsequent examination.
5
6This script package is free software; you can redistribute it and/or
7modify it under the terms of the GNU Public License as published by
8the Free Software Foundation.
9
10---------------------------------------------------------------------
11
12What's that?
13
14 There's a multitude of tools for the statistical examination of
15 newsgroups: number of postings month or per person, longest
16 threads, and so on (see <http://th-h.de/infos/usenet/stats.php>
17 [German language] for an incomplete list). Most of them use a per-
18 newsgroup approach while NewsStats is hierarchy oriented.
19
20 NewsStats will accumulate data from a live INN feed, allowing you
21 to process the saved information later on.
22
23Workflow
24
25 NewsStats saves overview data and complete headers of (all)
26 incoming postings to a (MySQL) database in real time.
27
28 That raw data will be regularly - e.g. monthly - processed to a
29 second set of database tables each dedicated to a certain
30 statistical aspect, e.g. number of postings per group per month.
31
32 Several kinds of reports can then be generated from those result
33 tables.
34
35Prerequisites
36
37 NewsStats is written in Perl (5.8.x and above) and makes use of a
38 MySQL database, so you'll need Perl, some modules, mysql and, of
39 course, an INN.
40
41 * Perl 5.8.x with standard modules
42 - Cwd
43 - File::Basename
44 - Sys::Syslog
45
46 * Perl modules form CPAN
47 - Cofing::Auto
48 - Date::Format
49 - DBI
50
51 * mysql 5.0.x
52
53 * working installation of INN
54
55Installation instructions
56
57 See INSTALL.
58
59Getting Started
60
61 'feedlog.pl' will continuously feed raw data to your raw data
62 table. See the feedlog.pl man page for more information.
63
64 You can process that data via 'gatherstats.pl'; currently only the
65 tabulation of postings per group per month is supported. More to
66 come. See the gatherstats.pl man page for more information.
67
68 Report generation is handled by specialised scripts for each
69 report type. Currently only reports on the number of postings per
70 group per month are supported; you can use 'groupstats.pl' for
71 that. See the groupstats.pl man page for more information.
72
73Reporting Bugs
74
75 You can report bugs or feature requests to the author by using the
76 bug tracker at <http://bugs.th-h.de/>.
77
78More Information
79
80 This program is maintained using the Git version control system.
81 You may clone <git://code.th-h.de/usenet/newsstats.git> to check
82 out the current development tree or browse it on the web via
83 <http://code.th-h.de/?p=usenet/newsstats.git>.
84
85Related projects
86
87 <http://usenet.dex.de/> is a site were data gathered via NewsStats
88 is used for a graphical presentation of activity in the de.*
89 Usenet hierarchy over the years.
90
91Author
92
93 Thomas Hochstein <thh@inter.net>
94 <http://th-h.de/>
This page took 0.012819 seconds and 4 git commands to generate.