]> git.ipfire.org Git - thirdparty/sarg.git/commitdiff
Add the documentation for the --statistics parameter
authorFrédéric Marchal <fmarchal@users.sourceforge.net>
Thu, 30 Aug 2012 05:40:17 +0000 (07:40 +0200)
committerFrédéric Marchal <fmarchal@users.sourceforge.net>
Thu, 30 Aug 2012 05:56:23 +0000 (07:56 +0200)
Documentation added to the man page and the usage page displayed by sarg.

sarg.1
sarg_manpage.xml
usage.c

diff --git a/sarg.1 b/sarg.1
index 7dd6ce3dde062c5f13b90252d4bba39e34d6e2b1..234530e1c8ea945d6c09ff70f51ba2c5dbb80d9e 100644 (file)
--- a/sarg.1
+++ b/sarg.1
@@ -288,6 +288,11 @@ Combined with
 \fB\-P\fR, the log is written in several files each containing one day worth of the original log\&.
 .RE
 .PP
+\fB\-\-statistics\fR
+.RS 4
+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\&.
+.RE
+.PP
 \fB\-t \fR\fB\fIstring\fR\fR
 .RS 4
 Limits the records included in the report based on time\-of\-day\&. Format for
index 5283f0cd920a012e732ede70cef44e99d19c4abf..2e513c230ef4f7063c6cae586230d61cafbb79dd 100644 (file)
@@ -325,6 +325,17 @@ containing one day worth of the original log.
 </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>
+
 <varlistentry><term><option>-t <replaceable>string</replaceable></option></term>
 <listitem>
 <para>
diff --git a/usage.c b/usage.c
index 2d0763dcb4223cc559c803c426bf943f303c9583..c6585fabb9985b957006a64f1cdd4ce2604933bc 100644 (file)
--- a/usage.c
+++ b/usage.c
@@ -54,6 +54,7 @@ void usage(const char *prog)
        puts  (_("     --split        Split the log file by date in -d parameter"));
        puts  (_("     --splitprefix PREFIX\n"
                 "                    Prepend a prefix to the splitted file names"));
+       puts  (_("     --statistics   Print run time statistics"));
        puts  (_("     -t TIME        Limit report to time range [HH:MM or HH:MM-HH:MM]"));
        puts  (_("     -u USER        Report only that user's activity"));
        puts  (_("     -w DIR         Temporary directory"));