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 "May 9, 2010"
   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 .I date
  65 as the time limit during log file processing. Format for
  66 .I date
  67 is
  68 .B dd/mm/yyyy-dd/mm/yyyy
  69 or a single date
  70 .BR "dd/mm/yyyy" ". Date ranges can also be specified as " "day-\fIn\fP" ", " "week-\fIn\fP" ", or " "month-\fIn\fP"
  71 where
  72 .I n
  73 is the number of days, weeks or months to jump backward. Note that there is no spaces around the hyphen.
  74 .TP
  75 .B \-e email
  76 Sends report to
  77 .IR "email"
  78 (stdout for console).
  79 .TP
  80 .B \-f filename
  81 Reads configuration from
  82 .IR "filename".
  83 .TP
  84 .B \-g e|u
  85 Sets date format in generated reports.
  86 .br
  87 \fBe\fP = Europe -> dd/mm/yy
  88 .br
  89 \fBu\fP = USA    -> mm/dd/yy
  90 .TP
  91 .B \-i
  92 Generates reports by user and ip address.
  93 .br
  94 \fBNOTE:\fP This requires the 'report_type'
  95 option in config file to contain "users_sites".
  96 .TP
  97 .B \-l filename
  98 Uses
  99 .IR "filename"
 100 as the input log. This option can be repeated up to 255 times to read multiple files. The files must be listed in chronological order from newest to eldest. If the files end with the extension
 101 .IR ".gz" ", " ".bz2" " or " ".Z"
 102 they are decompressed.
 103 If the file name is just
 104 .I -
 105 , the log file is read from standard input. In that case, it cannot be compressed.
 106 .TP
 107 .B \-L filename
 108 Reads a proxy redirector log file such as one created by squidGuard or Rejik. If you use this option, you may want to configure
 109 .B redirector_log_format
 110 in 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.
 111 .TP
 112 .B \-n
 113 Enables ip address resolution.
 114 .TP
 115 .B \-o dir
 116 Writes report in
 117 .IR "dir".
 118 .TP
 119 .B \-p
 120 Generates reports using ip address instead of userid.
 121 .TP
 122 .B \-s string
 123 Limits report to the site specified by
 124 .IR "string
 125 [eg. www.debian.org]
 126 .TP
 127 .B \-t string
 128 Limits records counted in statistics based on time-of-day. Format for
 129 \fIstring\fP is \fBHH\fP or \fBHH:MM\fP or \fBHH:MM:SS\fP.
 130 .TP
 131 .B \-u user
 132 Limits reports to \fIuser\fP activities.
 133 .TP
 134 .B \-w dir
 135 Uses \fIdir\fP for temporary files.
 136 .TP
 137 .B \-x
 138 Writes debug messages to \fBSTDOUT\fP
 139 .TP
 140 .B \-z
 141 Writes messages on processes to \fBSTDOUT\fP
 142 .TP
 143 .B \-convert
 144 Convert the logfile's date/time field to human-readable.
 145 .TP
 146 .B \-split
 147 Split the log file by date in \fB-d\fP parameter.
 148 .SH FILES
 149 .BR /usr/local/sarg/sarg.conf
 150 .br
 151 .B /var/log/squid/access.log
 152 .br
 153 .B /usr/local/squidGuard/logs/squidGuard.log
 154 .SH SEE ALSO
 155 squid(8)
 156 .SH AUTHOR
 157 This manual page was written by Luigi Gangitano <gangitano@lugroma3.org>,
 158 for the Debian GNU/Linux system (but may be used by others).  Revised
 159 by Billy Newsom.