Simplify the code to create the report directory

[thirdparty/sarg.git] / sarg_manpage.xml

diff --git a/sarg_manpage.xml b/sarg_manpage.xml
index 590570aa8917122a0716233e8137f727a3b75773..cf91af5b600268537ab66d6191d86cce2c853afe 100644 (file)
--- a/sarg_manpage.xml
+++ b/sarg_manpage.xml
@@ -9,15 +9,15 @@
 
   <refentryinfo>
     <productname>sarg</productname>
-    <date>27 Nov 2010</date>
-    
+    <date>27 May 2012</date>
+
     <author>
-      <firstname>Luigi</firstname>
-      <surname>Gangitano</surname>
-      <contrib>Author of the first manual page</contrib>
-      <email>gangitano@lugroma3.org</email>
+      <firstname>Frédéric</firstname>
+      <surname>Marchal</surname>
+      <contrib>Docbook version of the manual page</contrib>
+      <email>fmarchal@users.sourceforge.net</email>
     </author>
-  
+
     <author>
       <firstname>Billy</firstname>
       <surname>Newsom</surname>
@@ -25,14 +25,14 @@
     </author>
 
     <author>
-      <firstname>Frédéric</firstname>
-      <surname>Marchal</surname>
-      <contrib>Docbook version of the manual page</contrib>
-      <email>fmarchal@users.sourceforge.net</email>
+      <firstname>Luigi</firstname>
+      <surname>Gangitano</surname>
+      <contrib>Author of the first manual page</contrib>
+      <email>gangitano@lugroma3.org</email>
     </author>
-    
+
     <copyright>
-      <year>2010</year>
+      <year>2012</year>
       <holder>Frédéric Marchal</holder>
     </copyright>
   </refentryinfo>
@@ -82,7 +82,7 @@ A summary of options is included below.
 
 <variablelist>
 
-<varlistentry><term><option>-h</option></term>
+<varlistentry><term><option>-h</option> <option>--help</option></term>
 <listitem>
 <para>
 Show summary of options.
@@ -143,7 +143,7 @@ exporting the css as explained above.
 <para>
 Use <replaceable>date</replaceable> to restrict the report to some date range during log file processing.
 Format for <replaceable>date</replaceable> is <userinput>dd/mm/yyyy-dd/mm/yyyy</userinput>
-or a single date <userinput>dd/mm/yyyy</userinput>. Date ranges can also be specified as 
+or a single date <userinput>dd/mm/yyyy</userinput>. Date ranges can also be specified as
 <parameter>day-<constant>n</constant></parameter>, <parameter>week-<constant>n</constant></parameter>,
 or <parameter>month-<constant>n</constant></parameter> where <constant>n</constant>
 is the number of days, weeks or months to jump backward. Note that there is no spaces around the hyphen.
@@ -193,6 +193,15 @@ option in config file to contain "users_sites".
 </listitem>
 </varlistentry>
 
+<varlistentry><term><option>--keeplogs</option></term>
+<listitem>
+<para>
+Don't delete any old report. It is equivalent to setting <option>--lastlog 0</option> but is
+provided for convenience.
+</para>
+</listitem>
+</varlistentry>
+
 <varlistentry><term><option>-l <replaceable>filename</replaceable></option></term>
 <listitem>
 <para>
@@ -209,6 +218,16 @@ option. It allows the use of wildcards on the command line. Make sure you don't
 </listitem>
 </varlistentry>
 
+<varlistentry><term><option>--lastlog <replaceable>n</replaceable></option></term>
+<listitem>
+<para>
+Limit the number of logs kept in the output directory to <replaceable>n</replaceable>. Any supernumerary report
+is deleted starting with the oldest report. The value of <replaceable>n</replaceable> must be positive or zero.
+A value of zero means no report should be deleted.
+</para>
+</listitem>
+</varlistentry>
+
 <varlistentry><term><option>-L <replaceable>filename</replaceable></option></term>
 <listitem>
 <para>
@@ -220,6 +239,14 @@ This option can be repeated up to 64 times to read multiple files.
 </listitem>
 </varlistentry>
 
+<varlistentry><term><option>-m</option></term>
+<listitem>
+<para>
+Enable advanced processing debug messages. This option produces an enourmous amount of output.
+</para>
+</listitem>
+</varlistentry>
+
 <varlistentry><term><option>-n</option></term>
 <listitem>
 <para>
@@ -244,6 +271,28 @@ Generates reports using ip address instead of userid.
 </listitem>
 </varlistentry>
 
+<varlistentry><term><option>-P <replaceable>prefix</replaceable></option> <option>--splitprefix <replaceable>prefix</replaceable></option></term>
+<listitem>
+<para>
+This option must be used with <option>--split</option>. If it is provided, the input log is split among
+several files each containing one day. The name of the output files is made of the <replaceable>prefix</replaceable>
+and the date formated as <literal>-YYYY-MM-DD</literal>.
+</para>
+<para>
+The output files are written in the output directory
+specified with <option>-o</option> or in the current directory.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry><term><option>-r</option></term>
+<listitem>
+<para>
+Output the realtime report on the standard output and exit.
+</para>
+</listitem>
+</varlistentry>
+
 <varlistentry><term><option>-s <replaceable>string</replaceable></option></term>
 <listitem>
 <para>
@@ -261,6 +310,21 @@ range specified by the <option>-d</option> parameter.
 If it is combined with <option>--convert</option>
 the dates are also converted to a human-readable format.
 </para>
+<para>
+Combined with <option>-P</option>, the log is written in several files each containing one day of the
+original log.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry><term><option>--statistics</option></term>
+<listitem>
+<para>
+Writes some statistics about the execution time. The statistics include the
+total execution time; the number of records read in the input log files and the
+time it took to read them; the number of records and users processed and the
+time it took to process them.
+</para>
 </listitem>
 </varlistentry>
 
@@ -283,6 +347,14 @@ Limits reports to <replaceable>user</replaceable> activities.
 </listitem>
 </varlistentry>
 
+<varlistentry><term><option>-v</option></term>
+<listitem>
+<para>
+Write sarg version and exit.
+</para>
+</listitem>
+</varlistentry>
+
 <varlistentry><term><option>-w <replaceable>dir</replaceable></option></term>
 <listitem>
 <para>