Add usage information into documentation.

README

@@ -127,6 +127,37 @@ INSTALLATION
     See the file squidanalyzer.conf to customized your output statistics and
     match your network and file system configuration.
 
+USAGE
+    SquidAnalyzer can be run manually or by cron job using the
+    squid-analyzer Perl script. Here are authorized usage:
+
+      squid-analyzer [ -c squidanalyzer.conf ] [-l logfile]
+
+        -c | --configfile filename : path to the SquidAnalyzer configuration file.
+                                     By default: /etc/squidanalyzer.conf
+        -d | --debug               : show debug informations.
+        -h | --help                : show this message and exit.
+        -l | --logfile filename    : path to the Squid logfile to parse.
+                                     By default: /var/log/squid/access.log
+        -p | --preserve number     : used to set the statistic obsolescence in
+                                     number of month. Older stats will be removed.
+        -r | --rebuild             : use this option to rebuild all html and graphs
+                                     output from all data files.
+        -v | version               : show version and exit.
+
+    There is special options like --rebuild that force SquidAnalyzer to
+    rebuild all HTML reports, useful after an new feature or a bug fix.
+
+    The --preserve option should be used if you want to rotate your
+    statistics and data. The value is the number of months to keep, older
+    reports and data will be removed from the filesystem. Useful to preserve
+    space, for example:
+
+            squid-analyzer -p 6 -c /etc/squidanalyzer/squidanalyzer.conf
+
+    will only preserve six month of statistics from the last run of
+    squidanalyzer.
+
 CONFIGURATION
     Unless previous version customization of SquidAnalyzer is now done by a
     single configuration file squidanalyzer.conf.

doc/SquidAnalyzer.pod

@@ -131,6 +131,36 @@ can use the user-aliases file to do so.
 See the file squidanalyzer.conf to customized your output statistics and
 match your network and file system configuration.
 
+=head1 USAGE
+
+SquidAnalyzer can be run manually or by cron job using the squid-analyzer Perl
+script. Here are authorized usage:
+
+  squid-analyzer [ -c squidanalyzer.conf ] [-l logfile]
+
+    -c | --configfile filename : path to the SquidAnalyzer configuration file.
+                                 By default: /etc/squidanalyzer.conf
+    -d | --debug               : show debug informations.
+    -h | --help                : show this message and exit.
+    -l | --logfile filename    : path to the Squid logfile to parse.
+                                 By default: /var/log/squid/access.log
+    -p | --preserve number     : used to set the statistic obsolescence in
+                                 number of month. Older stats will be removed.
+    -r | --rebuild             : use this option to rebuild all html and graphs
+                                 output from all data files.
+    -v | version               : show version and exit.
+
+There is special options like --rebuild that force SquidAnalyzer to rebuild all
+HTML reports, useful after an new feature or a bug fix.
+
+The --preserve option should be used if you want to rotate your statistics and
+data. The value is the number of months to keep, older reports and data will be
+removed from the filesystem. Useful to preserve space, for example:
+
+	squid-analyzer -p 6 -c /etc/squidanalyzer/squidanalyzer.conf
+
+will only preserve six month of statistics from the last run of squidanalyzer.
+
 =head1 CONFIGURATION
 
 Unless previous version customization of SquidAnalyzer is now

doc/squidanalyzer.3

@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.26 (Pod::Simple 3.07)
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -38,8 +38,6 @@
 .    ds PI \(*p
 .    ds L" ``
 .    ds R" ''
-.    ds C`
-.    ds C'
 'br\}
 .\"
 .\" Escape single quotes in literal strings from groff's Unicode transform.
@@ -50,24 +48,17 @@
 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.\"
+.ie \nF \{\
-.\" Avoid warning from groff about undefined register 'F'.
+.    de IX
-.de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.el \{\
+.    de IX
 ..
-.nr rF 0
-.if \n(.g .if rF .nr rF 1
-.if (\n(rF:(\n(.g==0)) \{
-.    if \nF \{
-.        de IX
-.        tm Index:\\$1\t\\n%\t"\\$2"
-..
-.        if !\nF==2 \{
-.            nr % 0
-.            nr F 2
-.        \}
-.    \}
 .\}
-.rr rF
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
@@ -133,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "SQUIDANALYZER 1"
-.TH SQUIDANALYZER 1 "2013-01-29" "perl v5.10.1" "User Contributed Perl Documentation"
+.TH SQUIDANALYZER 1 "2013-01-30" "perl v5.14.2" "User Contributed Perl Documentation"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -276,6 +267,39 @@ can use the user-aliases file to do so.
 .PP
 See the file squidanalyzer.conf to customized your output statistics and
 match your network and file system configuration.
+.SH "USAGE"
+.IX Header "USAGE"
+SquidAnalyzer can be run manually or by cron job using the squid-analyzer Perl
+script. Here are authorized usage:
+.PP
+.Vb 1
+\&  squid\-analyzer [ \-c squidanalyzer.conf ] [\-l logfile]
+\&
+\&    \-c | \-\-configfile filename : path to the SquidAnalyzer configuration file.
+\&                                 By default: /etc/squidanalyzer.conf
+\&    \-d | \-\-debug               : show debug informations.
+\&    \-h | \-\-help                : show this message and exit.
+\&    \-l | \-\-logfile filename    : path to the Squid logfile to parse.
+\&                                 By default: /var/log/squid/access.log
+\&    \-p | \-\-preserve number     : used to set the statistic obsolescence in
+\&                                 number of month. Older stats will be removed.
+\&    \-r | \-\-rebuild             : use this option to rebuild all html and graphs
+\&                                 output from all data files.
+\&    \-v | version               : show version and exit.
+.Ve
+.PP
+There is special options like \-\-rebuild that force SquidAnalyzer to rebuild all
+\&\s-1HTML\s0 reports, useful after an new feature or a bug fix.
+.PP
+The \-\-preserve option should be used if you want to rotate your statistics and
+data. The value is the number of months to keep, older reports and data will be
+removed from the filesystem. Useful to preserve space, for example:
+.PP
+.Vb 1
+\&        squid\-analyzer \-p 6 \-c /etc/squidanalyzer/squidanalyzer.conf
+.Ve
+.PP
+will only preserve six month of statistics from the last run of squidanalyzer.
 .SH "CONFIGURATION"
 .IX Header "CONFIGURATION"
 Unless previous version customization of SquidAnalyzer is now