From 1fd96de29f7cb3adb578e1166b87b29880fa0070 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Fr=C3=A9d=C3=A9ric=20Marchal?= Date: Thu, 30 Aug 2012 07:40:17 +0200 Subject: [PATCH] Add the documentation for the --statistics parameter Documentation added to the man page and the usage page displayed by sarg. --- sarg.1 | 5 +++++ sarg_manpage.xml | 11 +++++++++++ usage.c | 1 + 3 files changed, 17 insertions(+) diff --git a/sarg.1 b/sarg.1 index 7dd6ce3..234530e 100644 --- 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 diff --git a/sarg_manpage.xml b/sarg_manpage.xml index 5283f0c..2e513c2 100644 --- a/sarg_manpage.xml +++ b/sarg_manpage.xml @@ -325,6 +325,17 @@ containing one day worth of the original log. + + + +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. + + + + diff --git a/usage.c b/usage.c index 2d0763d..c6585fa 100644 --- 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")); -- 2.47.2