[or-cvs] [metrics-utils/master 2/2] Make some minor changes to the HOWTO.

[karsten@xxxxxxxxxxxxxx]

Author: Karsten Loesing <karsten.loesing@xxxxxxx>
Date: Tue, 26 Oct 2010 19:50:04 +0200
Subject: Make some minor changes to the HOWTO.
Commit: 0cf1773c1ff60407a3c7e95df278faa16b56704e

---
 visitor/ChangeLog |    1 +
 visitor/HOWTO     |   67 ++++++++++++++++++++++++++---------------------------
 2 files changed, 34 insertions(+), 34 deletions(-)

diff --git a/visitor/ChangeLog b/visitor/ChangeLog
index aef34db..56af606 100644
--- a/visitor/ChangeLog
+++ b/visitor/ChangeLog
@@ -3,6 +3,7 @@ VisiTor change log:
 Changes in version 0.0.4 - 2010-1?-??
   - Don't omit the stats for the last date in the output. Found by Kiyoto
     Tamura.
+  - Add a Python version of the parsing script written by Kiyoto Tamura.
 
 Changes in version 0.0.3 - 2010-09-24
   - Support parsing .gz-compressed web server logs. Suggested by murb.
diff --git a/visitor/HOWTO b/visitor/HOWTO
index d9957ff..1564078 100644
--- a/visitor/HOWTO
+++ b/visitor/HOWTO
@@ -26,11 +26,12 @@ you should look at:
 
   https://metrics.torproject.org/exonerator.html
 
-This script consists of a Java part and an R part. The Java part parses a
-web server log and the downloaded exit list archives and writes daily
-statistics on requests by Tor users to disk. It further detects user-agent
-strings used by different Torbutton versions to count potential Torbutton
-users over Tor. The optional R part can be used to visualize the results.
+This script consists of a Java or Python part and an R part. The Java or
+Python part parses a web server log and the downloaded exit list archives
+and writes daily statistics on requests by Tor users to disk. It further
+detects user-agent strings used by different Torbutton versions to count
+potential Torbutton users over Tor. The optional R part can be used to
+visualize the results.
 
 ---------------------------------------------------------------------------
 
@@ -85,33 +86,15 @@ for Linux and Mac OS X; commands for Windows may vary):
 
 ---------------------------------------------------------------------------
 
-R Quick Start
-
-- Install R 2.8 and ggplot2 0.8.8 or higher. (See Section 2.4 in
-  https://gitweb.torproject.org/metrics-db.git/blob_plain/HEAD:/doc/manual.pdf
-  for instructions to install R 2.8 and ggplot2 0.8.8 on Debian Lenny.)
-
-- If you chose another filename than out.csv above, edit plot.R to read
-  the correct file.
-
-- Run the script with this command:
-
-  $ R --slave < plot.R
-
-- Find the generated graph in /home/you/visitor/visitors.png .
-
-
----------------------------------------------------------------------------
-
 Python Quick Start
 
-- This is a port of the original implementation in Java to Python. In order
-to run this, you need a decently up-to-date version of Python interpreter 
-(I have tried it with Python 2.4 and 2.7), which you can check if you have
-by typeing `which python` in the terminal.
+The Python script is a port of the original implementation in Java to
+Python. In order to run this, you need a decently up-to-date version of
+Python (tested with Python 2.4 and 2.7), which you can check by typing
+`which python` in the terminal.
 
 - Just as the Java version, you need to download the exit list from
-  https://metrics.torproject.org/data.html#exitlist 
+  https://metrics.torproject.org/data.html#exitlist
 
 - Once you have uncompressed the folder, you can run the script by typing
 
@@ -126,14 +109,30 @@ by typeing `which python` in the terminal.
   Unlike the Java version, currently <access log> needs to be *uncompressed*
   (The Java version allows you to pass in a gzipped access log).
 
-  example
-  -------
-  Suppose you have an Apache log named "access_log" and an exit list called
-  "exit_list", and wish to publish the statistics to a file named "stats.csv".
+  Suppose you have an Apache log named access_log and an exit list called
+  exit_list, and wish to publish the statistics to a file named out.csv.
   Then, type
 
-  python visitor.py access_log exit_list stats.csv
+  $ python visitor.py access_log exit_list out.csv
 
   or
 
-  python visitor.py access_log exit_list > stats.csv
+  $ python visitor.py access_log exit_list > out.csv
+
+---------------------------------------------------------------------------
+
+R Quick Start
+
+- Install R 2.8 and ggplot2 0.8.8 or higher. (See Section 2.4 in
+  https://gitweb.torproject.org/metrics-db.git/blob_plain/HEAD:/doc/manual.pdf
+  for instructions to install R 2.8 and ggplot2 0.8.8 on Debian Lenny.)
+
+- If you chose another filename than out.csv above, edit plot.R to read
+  the correct file.
+
+- Run the script with this command:
+
+  $ R --slave < plot.R
+
+- Find the generated graph in /home/you/visitor/visitors.png .
+
-- 
1.7.1