README.md
1# AreaStat
2[![Build Status](https://travis-ci.org/huskyproject/areastat.svg?branch=master)](https://travis-ci.org/huskyproject/areastat)
3[![Build status](https://ci.appveyor.com/api/projects/status/9pq58llqhw5ijh46/branch/master?svg=true)](https://ci.appveyor.com/project/dukelsky/areastat/branch/master)
4[![Codacy Badge](https://api.codacy.com/project/badge/Grade/18d9bd4220e6491096a040c9cd810508)](https://www.codacy.com/app/huskyproject/areastat?utm_source=github.com&utm_medium=referral&utm_content=huskyproject/areastat&utm_campaign=Badge_Grade)
5
6## 1. Introduction.
7
8 This programm can be used to create statistics for msg, squish and
9 jam message areas.
10
11 The echostat can generate 12 types of statistics (by name, by from, by to,
12 by from -> to, by size (in bytes), by quote percent, by subjects, by date,
13 by week day, by time and summary statistics for any area).
14 Allows to create statistics for any days, weeks or months.
15
16 Areastat is part of the Husky Fidonet software project. At January 2004
17 it's branched from Echostat version 1.06
18
19## 2. Using areastat.
20
21 First, You should create config file for areastat. Look th areastat.cfg
22 for example configuration. If you uses POSIX-compatible operation system
23 (e.g. FreeBSD, GNU/Linux) You may run following command to generate area
24 list for areastat config file:
25
26 grep -i echoarea $FIDOCONFIG | \
27 awk '{print "Area " $2 " " $5 " " $3 " " $2 ".stt";}' >> areastat.conf
28
29 Syntax to run areastat:
30
31 areastat cfg_name
32
33 where
34 cfg_name - confuguration file
35
36## 3. License.
37
38 This program is free software; you can redistribute it and/or modify
39 it under the terms of the GNU General Public License as published by
40 the Free Software Foundation; either version 2 of the License, or
41 (at your option) any later version.
42
43 This program is distributed in the hope that it will be useful,
44 but WITHOUT ANY WARRANTY; without even the implied warranty of
45 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
46 GNU General Public License for more details.
47
48 You should have received a copy of the GNU General Public License
49 along with this program (look a file COPYING), or you may download
50 it from http://gnu.org.
51
52## 4. Authors and contributors
53
54 Author or the Echostat is Dmitry Rusov
55 E-Mail: rusov94@main.ru
56 Fido: Dmitry Rusov, 2:5090/94
57
58 Thanks by Dmitry Rusov to:
59 Oleg Parshin, 2:5090/29
60 Serge Leontiev, 2:5090/64.101
61
62 Areastat (after Jan 8, 2004) is modified by:
63 Dmitry Sergienko, Michael Chernogor, Andry Lukyanov, Stas Degteff and
64 other members of [Husky](https://github.com/huskyproject) development team.
65