sarg.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH SARG 1 "September 25, 2004"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 sarg \- Squid Analysis Report Generator
  20 .SH SYNOPSIS
  21 .B sarg
  22 .RI [ options ]
  23 .SH DESCRIPTION
  24 \fBsarg\fP is a logfile parser and anylizer for the \fBSquid Web Proxy Cache\fP,
  25 which can be found at \fBhttp://www.squid-cache.org/\fP.
  26 This manual page documents briefly the
  27 .B sarg
  28 command.  More information is available at \fBhttp://sarg.sourceforge.net/\fP.
  29 This manual page was originally written for the Debian distribution
  30 because the author didn't include one in favor of documentation
  31 in the GNU Info format; see below.
  32 .PP
  33 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  34 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  35 .\" respectively.
  36 \fBsarg\fP is a tool that allows you to view "where" your users are going to on
  37 the Internet. \fBsarg\fP generates reports in HTML, with fields such as: users,
  38 IP Addresses, bytes, sites, and times.  These HTML files can appear in your
  39 web server's directory for browsing by users or administrators.  You may also
  40 have \fBsarg\fP email the reports to the Squid Cache administrator.
  41 .PP
  42 \fBsarg\fP can take the \fBsquid\fP access log as its input, or optionally the
  43 \fBsquidGuard http://www.squidguard.org/\fP Squid filter/redirector logfile format.
  44 .SH OPTIONS
  45 A summary of options is included below.
  46 .TP
  47 .B \-h
  48 Show summary of options.
  49 .TP
  50 .B \-a [hostname|ip address]
  51 Limits report to records containing the specified hostname/ip address
  52 .TP
  53 .B \-b filename
  54 Enables UserAgent log and writes it to
  55 .IR "filename".
  56 .TP
  57 .B \-c filename
  58 Uses
  59 .IR "filename"
  60 as the exclude files to select records that are not counted.
  61 .TP
  62 .B \-d date
  63 Uses
  64 .IR "date"
  65 as the timelimit during logfile processing. Format for
  66 .IR "date"
  67 is
  68 .B dd/mm/yyyy-dd/mm/yyyy
  69 .TP
  70 .B \-e email
  71 Sends report to
  72 .IR "email"
  73 (stdout for console).
  74 .TP
  75 .B \-f filename
  76 Reads configuration from
  77 .IR "filename".
  78 .TP
  79 .B \-g e|u
  80 Sets date format in generated reports.
  81 .br
  82 \fBe\fP = Europe -> dd/mm/yy
  83 .br
  84 \fBu\fP = USA    -> mm/dd/yy
  85 .TP
  86 .B \-i
  87 Generates reports by user and ip address.
  88 .br
  89 \fBNOTE:\fP This requires the 'report_type'
  90 option in config file to contain "users_sites".
  91 .TP
  92 .B \-l filename
  93 Uses
  94 .IR "filename"
  95 as the input log.
  96 .TP
  97 .B \-n
  98 Enables ip address resolution.
  99 .TP
 100 .B \-o dir
 101 Writes report in
 102 .IR "dir".
 103 .TP
 104 .B \-p
 105 Generates reports using ip address instead of userid.
 106 .TP
 107 .B \-s string
 108 Limits report to the site specified by
 109 .IR "string
 110 [eg. www.debian.org]
 111 .TP
 112 .B \-t string
 113 Limits records counted in statistics based on time-of-day. Format for
 114 \fIstring\fP is \fBHH\fP or \fBHH:MM\fP or \fBHH:MM:SS\fP.
 115 .TP
 116 .B \-u user
 117 Limits reports to \fIuser\fP activities.
 118 .TP
 119 .B \-w dir
 120 Uses \fIdir\fP for temporary files.
 121 .TP
 122 .B \-x
 123 Writes messages on processes to \fBSTDOUT\fP
 124 .TP
 125 .B \-z
 126 Writes debug messages to \fBSTDOUT\fP
 127 .TP
 128 .B \-convert
 129 Convert the logfile's date/time field to human-readable.
 130 .TP
 131 .B \-split
 132 Split the log file by date in \fB-d\fP parameter.
 133 .SH FILES
 134 .BR /usr/local/sarg/sarg.conf
 135 .br
 136 .B /usr/local/squid/logs/access.log
 137 .br
 138 .B /usr/local/squidGuard/logs/squidGuard.log
 139 .SH SEE ALSO
 140 squid(8)
 141 .SH AUTHOR
 142 This manual page was written by Luigi Gangitano <gangitano@lugroma3.org>,
 143 for the Debian GNU/Linux system (but may be used by others).  Revised
 144 by Billy Newsom.