From: Frédéric Marchal Date: Sun, 27 May 2012 07:46:17 +0000 (+0200) Subject: Update help X-Git-Tag: v2.3.3-pre1~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d6f085992bb0a5ff763a26e8b27640c542734cb5;p=thirdparty%2Fsarg.git Update help The manpage is up to date. So is the help displayed by sarg with command line options -h or --help. --- diff --git a/log.c b/log.c index d7c5925..bcc1aed 100644 --- a/log.c +++ b/log.c @@ -376,7 +376,7 @@ int main(int argc,char *argv[]) case 'a': safe_strcpy(addr,optarg,sizeof(addr)); break; - case 'b': + case 'b': //unused option safe_strcpy(uagent,optarg,sizeof(uagent)); break; case 'c': @@ -483,7 +483,7 @@ int main(int argc,char *argv[]) case 'x': debug++; break; - case 'y': + case 'y': //unused option langcode++; break; case 'z': diff --git a/sarg.1 b/sarg.1 index bef63b7..905ee6c 100644 --- a/sarg.1 +++ b/sarg.1 @@ -1,7 +1,7 @@ '\" t .\" Title: sarg .\" Author: Frédéric Marchal -.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" Generator: DocBook XSL Stylesheets v1.76.1 .\" Date: 25 Jan 2011 .\" Manual: SARG .\" Source: sarg @@ -9,6 +9,15 @@ .\" .TH "SARG" "1" "25 Jan 2011" "sarg" "SARG" .\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation @@ -32,7 +41,7 @@ is a log file parser and analyzer for the .PP \fBsarg\fR -generates reports in HTML with fields such as: users, IP Addresses, bytes, sites, and times\&. These HTML files can appear in your web server\'s directory for browsing by users or administrators\&. You may also have +generates reports in HTML with fields such as: users, IP Addresses, bytes, sites, and times\&. These HTML files can appear in your web server\*(Aqs directory for browsing by users or administrators\&. You may also have \fBsarg\fR email the reports to the Squid Cache administrator\&. .PP @@ -48,7 +57,7 @@ access logs\&. Optionally, it can complement the reports with the log of a Squid .PP A summary of options is included below\&. .PP -\fB\-h\fR +\fB\-h\fR \fB\-\-help\fR .RS 4 Show summary of options\&. .RE @@ -172,7 +181,7 @@ option in config file to contain "users_sites"\&. .PP \fB\-\-keeplogs\fR .RS 4 -Don\'t delete any old report\&. It is equivalent to setting +Don\*(Aqt delete any old report\&. It is equivalent to setting \fB\-\-lastlog 0\fR but is provided for convenience\&. .RE @@ -192,7 +201,7 @@ they are decompressed\&. If the file name is just This option is kept for compatibility with older versions of sarg but, starting with sarg 2\&.3, the log files may be named on the command line without the \fB\-l\fR -option\&. It allows the use of wildcards on the command line\&. Make sure you don\'t exceed the limit of 255 files\&. +option\&. It allows the use of wildcards on the command line\&. Make sure you don\*(Aqt exceed the limit of 255 files\&. .RE .PP \fB\-\-lastlog \fR\fB\fIn\fR\fR @@ -215,6 +224,11 @@ sarg\&.conf to match the output format of your web content filtering program\&. This option can be repeated up to 64 times to read multiple files\&. .RE .PP +\fB\-m\fR +.RS 4 +Enable advanced processing debug messages\&. This option produces an enourmous amount of output\&. +.RE +.PP \fB\-n\fR .RS 4 Enables ip address resolution\&. @@ -244,6 +258,11 @@ The output files are written in the output directory specified with or in the current directory\&. .RE .PP +\fB\-r\fR +.RS 4 +Output the realtime report on the standard output and exit\&. +.RE +.PP \fB\-s \fR\fB\fIstring\fR\fR .RS 4 Limits report to the site specified by diff --git a/sarg_manpage.xml b/sarg_manpage.xml index 6d4efba..62ace9d 100644 --- a/sarg_manpage.xml +++ b/sarg_manpage.xml @@ -82,7 +82,7 @@ A summary of options is included below. - + Show summary of options. @@ -239,6 +239,14 @@ This option can be repeated up to 64 times to read multiple files. + + + +Enable advanced processing debug messages. This option produces an enourmous amount of output. + + + + @@ -277,6 +285,14 @@ specified with or in the current directory. + + + +Output the realtime report on the standard output and exit. + + + + @@ -320,6 +336,14 @@ Limits reports to user activities. + + + +Write sarg version and exit. + + + + diff --git a/usage.c b/usage.c index 8d4b5eb..4e6ca73 100644 --- a/usage.c +++ b/usage.c @@ -30,27 +30,34 @@ void usage(const char *prog) { printf(_("Usage: %s [options...]\n"), prog); - puts (_(" -a Hostname or IP address")); - puts (_(" -b Useragent log")); - puts (_(" -c Exclude file")); - puts (_(" -d Date from-until dd/mm/yyyy-dd/mm/yyyy")); - puts (_(" -e Email address to send reports (stdout for console)")); - printf(_(" -f Config file (%s/sarg.conf)\n"),SYSCONFDIR); - puts (_(" -g Date format [e=Europe -> dd/mm/yyyy, u=USA -> mm/dd/yyyy]")); - puts (_(" -h This help")); - puts (_(" -i Reports by user and IP address")); - puts (_(" -l Input log")); - puts (_(" -n Resolve IP Address")); - puts (_(" -o Output dir")); - puts (_(" -p Use Ip Address instead of userid (reports)")); - puts (_(" -s Accessed site [Eg. www.microsoft.com, www.netscape.com]")); - puts (_(" -t Time [HH, HH:MM]")); - puts (_(" -u User")); - puts (_(" -w Temporary dir")); - puts (_(" -x Debug messages")); - puts (_(" -z Process messages")); - puts (_(" -convert Convert the access.log file to a legible date")); - puts (_(" -split Split the log file by date in -d parameter")); + puts (_(" -a NAME|IP Create report for host name or IP address")); + //puts (_(" -b Useragent log")); + puts (_(" -c FILE Exclude connected hosts from the report")); + puts (_(" --convert Convert the access.log file to a legible date")); + puts (_(" --css Output the internal CSS")); + puts (_(" -d DATE Date range to include in the report: from-until dd/mm/yyyy-dd/mm/yyyy")); + puts (_(" -e MAIL Email address to send reports to (stdout for console)")); + printf(_(" -f FILE Config file to read (default is %s/sarg.conf)\n"),SYSCONFDIR); + puts (_(" -g FMT Date format [e=Europe -> dd/mm/yyyy, u=USA -> mm/dd/yyyy]")); + puts (_(" -h This help")); + puts (_(" --help This help")); + puts (_(" -i Reports by user and IP address")); + puts (_(" --keeplogs Keep every previously generated report")); + puts (_(" -l FILE Input log")); + puts (_(" --lastlog Set the number of previous reports to keep")); + puts (_(" -m Advanced process messages")); + puts (_(" -n Resolve IP addresses using RDNS")); + puts (_(" -o DIR Report output directory")); + puts (_(" -p Use Ip Address instead of userid (reports)")); + puts (_(" -P PREFIX Prepend a prefix to the splitted file names")); + puts (_(" -s SITE Limit report to accessed site [eg. www.microsoft.com]")); + puts (_(" --split Split the log file by date in -d parameter")); + puts (_(" --splitprefix PREFIX Prepend a prefix to the splitted file names")); + 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")); + puts (_(" -x Debug messages")); + puts (_(" -z Process messages")); printf("\n\t%s-%s\n",PGM,VERSION); puts ("\thttp://sarg.sourceforge.net"); puts (_("\n\tPlease donate to the sarg project:"));