diff --git a/waccess.1 b/waccess.1 index c507711..7b3a5e5 100644 --- a/waccess.1 +++ b/waccess.1 @@ -2,26 +2,53 @@ .SH NAME waccess \- Quick And Dirty Web Log Analysis .SH SYNOPSIS -waccess [-irs -f logfile] string string ... +waccess [-achilqrsv -f logfile] search-key search-key ... .SH DESCRIPTION \'waccess\' is a quick way to check a web access log for particular -"hits" or accesses. \'waccess\' will search the log looking for, -displaying, and counting all the accesses which contain any of the -strings you name on the command line. +"hits" or accesses. \'waccess\' will search the log looking for +and displaying all the access records which contain any of the +search keys you name on the command line. By default, a summary +of its findings - including total number of records processed, +number of accesses per search key, and number of unique IPs accessing +each search key - is printed. \'waccess\' is not a replacement for a serious web log analysis tool, -but is useful for "quickie" lookups. +but is surprisingly useful for "quickie" lookups. .SH OPTIONS .TP +.B -a +Sort the summary output by search key. + +.TP +.B -c +Ignore case when looking for search keys in access records + +.TP .B -f logfile Allows you to specify the name of the access log to process, thereby overriding the default (/var/log/httpd-access.log). .TP +.B -h +Display help information and exit. + +.TP .B -i -Do not ignore addresses in the IGNORED table. +Do not ignore addresses found in +.B .waccessignored. + +.TP +.B -l +List the ignored addresses in the summary output. Canceled by the +presence of the -i command. + + +.TP +.B -q +Quiet mode - suppresses output of final summary information. + .TP .B -r Try to determine the hostname of each access by doing a reverse lookup @@ -34,20 +61,46 @@ totals. This forces the suppression of reverse lookups since they wouldn't be displayed anyway (the opposite of the -r option). +.TP +.B -v +Display detailed program version information and exit. + + .SH IGNORING ADDRESSES You typically do not want your own addresses to appear in a web log -analysis. \'waccess\' has some limited ability to ignore records -containing any one of a set of addresses (partial or complete IP -quads) you specify. You do this by editing the \'IGNORED\' table in -the program. Any address found in this table will be ignored by -'\waccess\' and never appear in the output. (However, records -containing one of these addresses do count toward the total records -processed count.) By default, \'waccess\' ignores addresses in the -127.0.*.* and 192.168.0.* address spaces. +analysis. \'waccess\' has the ability to ignore records containing +any one of a set of addresses (partial or complete IP quads) you +specify. You do this by editing the +.B .waccessignored +file in your home directory. Each line of this file should contain a +full or partial IP quad. No comments, whitespace, blank lines or other +information should appear in this file. Addresses found in this file +will be ignored by \'waccess\' and never appear in the +output. (However, records matching these addresses do count toward the +total records processed count.) + +Suppose you are running an internet-facing machine with address +1.2.3.4 and an internal network on 192.168.3.*. Then your +.B .waccessignored +file might look like this: + +127.0 +.br +192.168.3 +.br +1.2.3.4 + +Accesses from any of these address spaces to your web server would then be +ignored by \'waccess\'. This feature is disabled with the \'-i\' option. +You can see which addresses are being ignored with the \'-l\' option. +This will cause a list of ignored addresses to be included in the +summary output. + + .SH EXAMPLES .B waccess myreport.pdf @@ -73,6 +126,14 @@ You must have a reasonably current copy of 'python' installed for \'waccess\' to operate. +\'waccess\' is set up to process \'apache\' access logs, but the field +definitions are symbolic within the program and should be easy to +modify for other log layouts. + +.SH FILES +~./waccessignored - optional file which contains complete or partial IP quads to +ignore during processing. + .SH BUGS AND MISFEATURES None known as of this release.