root/alternc-stats/tags/debian_version_0_1/debian/manpage.8

Revision 1370, 2.2 kB (checked in by anarcat, 4 years ago)

add manpage

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH ALTERNC-STATS SECTION "may 1st, 2005"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 alternc-stats-web \- extract per-user web bandwidth statistics
20 .SH SYNOPSIS
21 .B alternc-stats-web
22 .RI " files" ...
23 .SH DESCRIPTION
24 .PP
25 This manual page documents briefly the
26 .B alternc-stats-web
27 command.
28 .PP
29 .B alternc-stats-web
30 is a program that parses apache access logs and fills an SQL table
31 with (day,user) => (hits,size) relation. This table can in turn be
32 quickly analyzed for usage patterns.
33
34 It is expected that (1) each logfile is treated and only once and (2)
35 logfiles are treated in chronological order
36
37 A proper way to do this is to treat logfiles right after rotation,
38 once. On Linux, this would be hooking into the "postrotate" hook of
39 the
40 .BR logrotate
41 conf file or running a cron job right after the
42 .BR logrotate
43 cron job. The Debian package of
44 .B alternc-stats
45 usually installs a job right after the logrotate in cron.daily.
46 .SH FILES
47 The SQL schema is provided with the original source.
48 .TP
49 .I /var/log/apache/access.log.1
50 common location for the logfile to parse. apache access logs are expected to be in the special vhost format:
51 .RS
52 LogFormat "%h %l %u %t \\"%r\\" %>s %b \\"%{Referer}i\\" \\"%{User-Agent}i\\" %T %V" full
53 .RE
54 .TP
55 .I /var/alternc/bureau/class/config_nochk.php
56 expected location of the AlternC PHP configuration file.
57 .SH AUTHOR
58 alternc-stats was originally written by Benjamin Soontag
59 <benjamin@alternc.org>. Antoine Beaupré <anarcat@anarcat.ath.cx
60 proceeded with cleanups and debianization.
61 .PP.Dl "buildit -l trace.log povray +iscene +oscene.out"
62 This manual page was written by Antoine Beaupré
63 <anarcat@anarcat.ath.cx>.
Note: See TracBrowser for help on using the browser.