File: turqstat.doc

package info (click to toggle)
turqstat 1.2-1
  • links: PTS
  • area: main
  • in suites: potato
  • size: 212 kB
  • ctags: 463
  • sloc: cpp: 2,637; makefile: 68
file content (191 lines) | stat: -rw-r--r-- 6,836 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
Turquoise SuperStat 1.2 - An area statistics program for Fidonet
(c) Copyright 1998-1999 Peter Karlsson.
A Softwolves Software Release in 1999

http://www.softwolves.pp.se/wolves/


LICENSE

This software is distributed under the GNU General Public License version
2, as can be found in the accompanying file COPYING, with the following
addition:

This program may be linked against any Fidonet message base access sources
or binary libraries that does not comply with the GNU GPL, as long as their
inclusion does not compromise the free distribution of the main source
code. It must also be possible to compile the main source without using
these access sources or binary libraries (e.g with conditional
pre-processor directives) and still get a working binary.

Binaries created by linking against such message base access code must be
freely distributable and usable by anyone (i.e it is not enough to warrant
"non-commercial use only"). If this cannot be complied with, then no such
binaries must be distributed.

Even with this exception, licensing new message base access sources under
GNU GPL is encouraged.


OTHER COPYRIGHTS

JAM(mbp) - Copyright 1993 Joaquim Homrighausen, Andrew Milner, Mats Birch,
Mats Wallin. ALL RIGHTS RESERVED.

Squish, SquishMail and Maximus are trademarks of Scott J. Dudley.


USEAGE

Turquoise SuperStat reads the contents of a Fidonet message area in one of
its supported formats, and creates statistics about this:

 * Quoter blacklist.
 * Toplist of senders.
 * Toplist of receivers.
 * Toplist of subjects.
 * Toplist of used software.
 * Postings by weekday.
 * Postings by time of day.

Any of the statistic subjects may be turned off. The statistics is stored
in a text file.

Turquoise SuperStat is entirely command line driven, and the format is this:

  turqstat [options] areapath outputfile

where areapath is the path to the message area file or directory (depends
on the message base format selected), and outputfile is the path to the
text file that the statistics are to be written to.

These extra options are available:

-d <days>
   Selects the number of days back to count messages from. The default is
   0, which mean count all messages. The message arrival time is used, not
   the message creation date stamp.

-n <num>
   Selects the maximum number of entries in the toplists. The default is 15.
   0 indicates no limit.

-a <num>
   Selects the area number for the FDAPX/w and MyPoint message bases, which
   has all messages in the same files.

-s Selects Squish style message base (default). The areapath parameter should
   be the base name of the Squish files.

-m Selects FTSC *.MSG style message base. The areapath parameter should be the
   directory in which the messagebase resides. This message base type lacks
   arrival dates, so the -d parameter will work on write dates.

-o Selects Opus *.MSG style message base. The areapath parameter should be the
   directory in which the messagebase resides. Opus *.MSG does have arrival
   dates.

-j Select JAM style message base. The areapath parameter should be the base
   name of the JAM files.

-f Selects FDAPX/w style message base. Requires the use of the -a parameter
   to select the area number (1-1999). The areapath parameter should be the
   directory in which the message base files resides.

-p Selects MyPoint style message base. Requires the use of the -a parameter to
   select the area number. The areapath parameter should be the path to the
   MyPoint AREAS subdirectory.

-Q Turns the quoter blacklist off (default is on).

-W Turns the writer toplist off (default is on).

-R Turns the recipient toplist off (default is on).

-S Turns the subject toplist off (default is on).

-P Turns the program toplist off (default is on).

-H Turns the hourly posting statistics off (default is on).

-D Turns the daily posting statistics off (default is on).

-V Turns the display of versions in the program toplist off (default is
   on).

-N Display all numbers in toplists (default is off).

The options can be aggregated on the command line, for example:

  turqstat -mWRSPHD d:\msgbase\thisarea d:\text\output.txt

will create quoter blacklist (only) from the *.MSG message base in the
d:\msgbase\thisarea directory. The options are case sensitive.

  turqstat -?

will give you a quick help screen with an overview of the available
options.


HISTORY

1999-06-06 - v1.0 - First public release
1999-07-03 - v1.1 -
  Added support for revision 3 of MyPoint's message base.
  MyPoint uses area numbers, just like FDAPX/w.
  The version list is sorted.
  Bug fixes.
1999-07-21 - v1.2 -
  No longer uses SMAPI, but has its own routines for Squish/*.MSG.
  Supports both FTSC and Opus style *.MSG bases.
  Various bugfixes.
  Windows and Linux versions work (better) now.

INCLUDED FILES

turqstat.exe - Main executable file (OS/2)
turqstat.doc - This documentation
turqstat.dok - Documentation in Swedish
copying      - The GNU General Public License, version 2
source.rar   - Archive containing the source code:
  Makefile        - Makefile for EMX (nmake)
  Makefile.CygWin - Makefile for CygWin32 (GNU make) (unsupported)
  Makefile.linux  - Makefile for GNU C++ on Linux (GNU make)
  turqstat.cpp    - Main Turquoise source
  arearead.h      - Header defining the abstract superclass for the message
                    base readers
  fdapxread.cpp   - Access sources for FDAPX/w message bases
  fdapxread.h     - Header file for the above
  jamread.cpp     - Access sources for JAM message bases
  jamread.h       - Header file for the above
  mypointread.cpp - Access sources for MyPoint message bases
  mypointread.h   - Header file for the above
  squishread.cpp  - Access sources for Squish message bases
  squishread.h    - Header file for the above
  sdmread.cpp     - Access sources for *.MSG message bases
  sdmread.h       - Header file for the above
  statengine.cpp  - The statistics gathering engine
  statengine.h    - Header file for the above
  statview.cpp    - The "view", creates the output file
  statview.h      - Header file for the above
  utility.cpp     - Misc. utility functions
  utility.h       - Header file for the above
  datatypes.h     - Compiler-independent datatype declarations
  version.h       - Current version number


REQUIREMENTS FOR COMPILATION

The program was developed under OS/2 using EMX 0.9c/GNU C/C++ 2.7.2.1 and
Debian 2.1 with egcs 2.91.66, and has also been tested under CygWin b20. It
should compile using any standard C++ compiler. The program must probably be
rewritten to support "big endian" processors.


CONTACT

The author, Peter Karlsson, can be contacted via netmail at 2:206/221.0, or
via Internet e-mail at peter@softwolves.pp.se. Information about this
program is available on the world wide web at
http://www.softwolves.pp.se/wolves/