906 lines
35 KiB
Groff
906 lines
35 KiB
Groff
.TH webalizer 1 "12-Jul-2008" "Version 2.20" "The Webalizer"
|
|
.SH NAME
|
|
webalizer - A web server log file analysis tool.
|
|
.SH SYNOPSIS
|
|
.B webalizer
|
|
[\fI option ... \fP] [\fI log-file \fP]
|
|
.PP
|
|
.B webazolver
|
|
[\fI option ... \fP] [\fI log-file \fP]
|
|
.PP
|
|
.SH DESCRIPTION
|
|
The \fIWebalizer\fP is a web server log file analysis program which produces
|
|
usage statistics in HTML format for viewing with a browser. The results
|
|
are presented in both columnar and graphical format, which facilitates
|
|
interpretation. Yearly, monthly, daily and hourly usage statistics are
|
|
presented, along with the ability to display usage by site, URL, referrer,
|
|
user agent (browser), username, search strings, entry/exit pages, and
|
|
country (some information may not be available if not present in the log
|
|
file being processed).
|
|
.PP
|
|
The \fIWebalizer\fP supports \fBCLF\fP (common log format) log files,
|
|
as well as \fBCombined\fP log formats as defined by NCSA and others,
|
|
and variations of these which it attempts to handle intelligently. In
|
|
addition, the \fIWebalizer\fP supports \fBxferlog\fP formatted (\fIFTP\fP)
|
|
log files, \fBsquid\fP proxy logs and \fBW3C\fP extended format logs.
|
|
Logs may also be compressed, via \fIgzip\fP (.gz) or, if enabled at compile
|
|
time, \fIbzip2\fP (.bz2). If a compressed log file is detected, it will be
|
|
automatically uncompressed while it is read. Compressed logs must have the
|
|
standard \fIgzip\fP extension of \fB.gz\fP or \fIbzip2\fP extension of
|
|
\fB.bz2\fP.
|
|
.PP
|
|
\fIwebazolver\fP is normally just a symbolic link to the \fIWebalizer\fP.
|
|
When run as \fIwebazolver\fP, only DNS file creation/updates are performed,
|
|
and the program will exit once complete. All normal options and
|
|
configuration directives are available, however many will not be used.
|
|
In addition, a DNS cache file must be specified. If the number of DNS
|
|
children processes to use are not specified, the \fIwebazolver\fP will
|
|
default to \fB5\fP.
|
|
.PP
|
|
This documentation applies to The Webalizer Version 2.20
|
|
.SH RUNNING THE WEBALIZER
|
|
The \fIWebalizer\fP was designed to be run from a Unix command line prompt or
|
|
as a \fBcrond(8)\fP job. Once executed, the general flow of the program is:
|
|
.TP 8
|
|
.B o
|
|
A default configuration file is scanned for. A file named
|
|
\fIwebalizer.conf\fP is searched for in the current directory, and if
|
|
found, it's configuration data is parsed. If the file is not
|
|
present in the current directory, the file \fI/etc/webalizer.conf\fP
|
|
is searched for and, if found, is used instead.
|
|
.TP 8
|
|
.B o
|
|
Any command line arguments given to the program are parsed. This
|
|
may include the specification of a configuration file, which is
|
|
processed at the time it is encountered.
|
|
.TP 8
|
|
.B o
|
|
If a log file was specified, it is opened and made ready for
|
|
processing. If no log file was given, \fISTDIN\fP is used for input.
|
|
If the log filename '\fB-\fP' is specified, \fISTDIN\fP will be forced.
|
|
.TP 8
|
|
.B o
|
|
If an output directory was specified, the program does a \fBchdir(2)\fP to
|
|
that directory in preparation for generating output. If no output
|
|
directory was given, the current directory is used.
|
|
.TP 8
|
|
.B o
|
|
If a non-zero number of DNS Children processes were specified, they will
|
|
be started, and the specified log file will be processed, creating or
|
|
updating the specified DNS cache file.
|
|
.TP 8
|
|
.B o
|
|
If no hostname was given, the program attempts to get the hostname
|
|
using a \fBuname(2)\fP system call. If that fails, \fIlocalhost\fP
|
|
is used.
|
|
.TP 8
|
|
.B o
|
|
A history file is searched for in the current directory (output
|
|
directory) and read if found. This file keeps totals for previous
|
|
months, which is used in the main \fIindex.html\fP HTML document.
|
|
.B Note:
|
|
The file location can now be specified with the \fIHistoryName\fP
|
|
configuration option.
|
|
.TP 8
|
|
.B o
|
|
If incremental processing was specified, a data file is searched for
|
|
and loaded if found, containing the 'internal state' data of the
|
|
program at the end of a previous run.
|
|
.B Note:
|
|
The file location can now be specified with the \fIIncrementalName\fP
|
|
configuration option.
|
|
.TP 8
|
|
.B o
|
|
Main processing begins on the log file. If the log spans multiple
|
|
months, a separate HTML document is created for each month.
|
|
.TP 8
|
|
.B o
|
|
After main processing, the main \fIindex.html\fP page is created, which
|
|
has totals by month and links to each months HTML document.
|
|
.TP 8
|
|
.B o
|
|
A new history file is saved to disk, which includes totals generated
|
|
by The \fIWebalizer\fP during the current run.
|
|
.TP 8
|
|
.B o
|
|
If incremental processing was specified, a data file is written that
|
|
contains the 'internal state' data at the end of this run.
|
|
.SH INCREMENTAL PROCESSING
|
|
The \fIWebalizer\fP supports incremental run capability. Simply
|
|
put, this allows processing large log files by breaking them up into
|
|
smaller pieces, and processing these pieces instead. What this means
|
|
in real terms is that you can now rotate your log files as often as you
|
|
want, and still be able to produce monthly usage statistics without the
|
|
loss of any detail. Basically, The \fIWebalizer\fP saves and restores all
|
|
internal data in a file named \fIwebalizer.current\fP. This allows the
|
|
program to 'start where it left off' so to speak, and allows the
|
|
preservation of detail from one run to the next. The data file is
|
|
placed in the current output directory, and is a plain ASCII text
|
|
file that can be viewed with any standard text editor. It's location
|
|
and name may be changed using the \fIIncrementalName\fP configuration
|
|
keyword.
|
|
.PP
|
|
Some special precautions need to be taken when using the incremental
|
|
run capability of The \fIWebalizer\fP. Configuration options should not be
|
|
changed between runs, as that could cause corruption of the internal
|
|
data stored. For example, changing the \fIMangleAgents\fP level will cause
|
|
different representations of user agents to be stored, producing invalid
|
|
results in the user agents section of the report. If you need to change
|
|
configuration options, do it at the end of the month after normal
|
|
processing of the previous month and before processing the current month.
|
|
You may also want to delete the \fIwebalizer.current\fP file as well.
|
|
.PP
|
|
The \fIWebalizer\fP also attempts to prevent data duplication by keeping
|
|
track of the timestamp of the last record processed. This timestamp
|
|
is then compared to current records being processed, and any records
|
|
that were logged previous to that timestamp are ignored. This, in
|
|
theory, should allow you to re-process logs that have already been
|
|
processed, or process logs that contain a mix of processed/not yet
|
|
processed records, and not produce duplication of statistics. The
|
|
only time this may break is if you have duplicate timestamps in two
|
|
separate log files... any records in the second log file that do have
|
|
the same timestamp as the last record in the previous log file processed,
|
|
will be discarded as if they had already been processed. There are
|
|
lots of ways to prevent this however, for example, stopping the web
|
|
server before rotating logs will prevent this situation. This setup
|
|
also necessitates that you always process logs in chronological order,
|
|
otherwise data loss will occur as a result of the timestamp compare.
|
|
.SH REVERSE DNS LOOKUPS
|
|
The \fIWebalizer\fP fully supports IPv4 and IPv6 DNS lookups, and
|
|
maintains a cache of those lookups to reduce processing the same
|
|
addresses in subsequent runs. The cache file can be created at
|
|
run-time, or may be created before running the webalizer using either
|
|
the stand alone '\fIwebazolver\fP' program, or The Webalizer (DNS)
|
|
Cache file manager program '\fIwcmgr\fP'. In order to perform reverse
|
|
lookups, a \fBDNSCache\fP file must be specified, either on the command
|
|
line or in a configuration file. In order to create/update the cache
|
|
file at run-time, the number of \fBDNSChildren\fP must also be specified,
|
|
and can be anything between 1 and 100. This specifies the number of
|
|
child processes to be forked, each of which will perform network DNS
|
|
queries in order to lookup up the addresses and update the cache.
|
|
Cached entries that are older than a specified TTL (time to live)
|
|
will be expired, and if encountered again in a log, will be looked
|
|
up at that time in order to 'freshen' them (verify the name is still
|
|
the same and update its timestamp). The default TTL is 7 days, however
|
|
may be set to anything between 1 and 100 days. Using the '\fIwcmgr\fP'
|
|
program, entries may also be marked as 'permanent', in which case
|
|
they will persist (with an infinite TTL) in the cache until manually
|
|
removed. See the file \fBDNS.README\fP for additional information
|
|
and examples.
|
|
.SH GEOLOCATION LOOKUPS
|
|
The \fIWebalizer\fP has the ability to perform geolocation lookups on
|
|
IP addresses using either it's own internal \fIGeoDB\fP database, or
|
|
optionally the \fIGeoIP\fP database from MaxMind, Inc. (www.maxmind.com).
|
|
If used, unresolved addresses will be searched for in the database and
|
|
its country of origin will be returned if found. This actually produces
|
|
more accurate \fICountry\fP information than DNS lookups, since the DNS
|
|
address space has additional \fIgcTLDs\fP that do not necessarily map
|
|
to a specific country (such as \fI.net\fP and \fI.com\fP). It is possible
|
|
to use both DNS lookups and geolocation lookups at the same time, which
|
|
will cause any addresses that could not be resolved using DNS lookups to
|
|
then be looked up in the database, greatly reducing the number of
|
|
\fIUnknown/Unresolved\fP entries in the generated reports. The native
|
|
\fIGeoDB\fP geolocation database provided by The \fIWebalizer\fP fully
|
|
supports both \fIIPv4\fP and \fIIPv6\fP lookups, is updated regularly and
|
|
is the preferred geolocation method for use with The \fIWebalizer\fP. The
|
|
most current version of the database can be obtained from our ftp site
|
|
(\fIftp://ftp.mrunix.net/\fP).
|
|
.SH COMMAND LINE OPTIONS
|
|
The \fIWebalizer\fP supports many different configuration options that will
|
|
alter the way the program behaves and generates output. Most of these
|
|
can be specified on the command line, while some can only be specified
|
|
in a configuration file. The command line options are listed below,
|
|
with references to the corresponding configuration file keywords.
|
|
.PP
|
|
.I General Options
|
|
.TP 8
|
|
.B \-h
|
|
Display all available command line options and exit program.
|
|
.TP 8
|
|
.B \-v
|
|
Be verbose. Will cause the program to output informational
|
|
and \fIDebug\fP messages at run-time.
|
|
.TP 8
|
|
.B \-V
|
|
Display the program version and exit. Additional program specific
|
|
information will be displayed if \fIverbose\fP mode is also used
|
|
(e.g. '\fI-vV\fP'), which can be useful when submitting bug reports.
|
|
.TP 8
|
|
.B \-d
|
|
\fBDebug\fP. Display debugging information for errors and warnings.
|
|
.TP 8
|
|
.B \-i
|
|
\fBIgnoreHist\fP. Ignore history. \fBUSE WITH CAUTION\fP. This
|
|
will cause The \fIWebalizer\fP to ignore any previous monthly history
|
|
file only. Incremental data (if present) is still processed.
|
|
.TP 8
|
|
.B \-b
|
|
\fBIgnoreState\fP. Ignore incremental data file. \fBUSE WITH CAUTION\fP.
|
|
This will cause The \fIWebalizer\fP to ignore any existing incremental
|
|
data file. By ignoring the incremental data file, all previous processing
|
|
for the current month will be lost and those logs must be re-processed.
|
|
.TP 8
|
|
.B \-p
|
|
\fBIncremental\fP. Preserve internal data between runs.
|
|
.TP 8
|
|
.B \-q
|
|
\fBQuiet\fP. Suppress informational messages. Does not suppress
|
|
warnings or errors.
|
|
.TP 8
|
|
.B \-Q
|
|
\fBReallyQuiet\fP. Suppress all messages including warnings and errors.
|
|
.TP 8
|
|
.B \-T
|
|
\fBTimeMe\fP. Force display of timing information at end of processing.
|
|
.TP 8
|
|
.B \-c \fIfile\fP
|
|
Use configuration file \fIfile\fP.
|
|
.TP 8
|
|
.B \-n \fIname\fP
|
|
\fBHostName\fP. Use the hostname \fIname\fP.
|
|
.TP 8
|
|
.B \-o \fIdir\fP
|
|
\fBOutputDir\fP. Use output directory \fIdir\fP.
|
|
.TP 8
|
|
.B \-t \fIname\fP
|
|
\fBReportTitle\fP. Use \fIname\fP for report title.
|
|
.TP 8
|
|
.B \-F \fP( \fBc\fPlf | \fBf\fPtp | \fBs\fPquid | \fBw\fP3c )
|
|
\fBLogType\fP. Specify log type to be processed. Value can be either
|
|
\fIc\fPlf, \fIf\fPtp, \fIs\fPquid or \fIw\fP3c format. If not specified,
|
|
will default to \fBCLF\fP format. \fIFTP\fP logs must be in standard
|
|
wu-ftpd \fIxferlog\fP format.
|
|
.TP 8
|
|
.B \-f
|
|
\fBFoldSeqErr\fP. Fold out of sequence log records back into analysis,
|
|
by treating as if they were the same date/time as the last good record.
|
|
Normally, out of sequence log records are simply ignored.
|
|
.TP 8
|
|
.B \-Y
|
|
\fBCountryGraph\fP. Suppress country graph.
|
|
.TP 8
|
|
.B \-G
|
|
\fBHourlyGraph\fP. Suppress hourly graph.
|
|
.TP 8
|
|
.B \-x \fIname\fP
|
|
\fBHTMLExtension\fP. Defines HTML file extension to use. If not
|
|
specified, defaults to \fIhtml\fP. Do not include the leading
|
|
period.
|
|
.TP 8
|
|
.B \-H
|
|
\fBHourlyStats\fP. Suppress hourly statistics.
|
|
.TP 8
|
|
.B \-K \fInum\fP
|
|
\fBIndexMonths\fP. Specify how many months should be displayed in the
|
|
main index (yearly summary) table. Default is 12 months. Can be set
|
|
to anything between 12 and 120 months (1 to 10 years).
|
|
.TP 8
|
|
.B \-k \fInum\fP
|
|
\fBGraphMonths\fP. Specify how many months should be displayed in the
|
|
main index (yearly summary) graph. Default is 12 months. Can be set
|
|
to anything between 12 and 72 months (1 to 6 years).
|
|
.TP 8
|
|
.B \-L
|
|
\fBGraphLegend\fP. Suppress color coded graph legends.
|
|
.TP 8
|
|
.B \-l \fInum\fP
|
|
\fBGraphLines\fP. Specify number of background lines. Default
|
|
is 2. Use zero ('0') to disable the lines.
|
|
.TP 8
|
|
.B \-P \fIname\fP
|
|
\fBPageType\fP. Specify file extensions that are considered \fIpages\fP.
|
|
Sometimes referred to as \fIpageviews\fP.
|
|
.TP 8
|
|
.B \-O \fIname\fP
|
|
\fBOmitPage\fP. Specify URLs to exclude from being counted as \fIpages\fP.
|
|
.TP 8
|
|
.B \-m \fInum\fP
|
|
\fBVisitTimeout\fP. Specify the Visit timeout period. Specified in
|
|
number of seconds. Default is 1800 seconds (30 minutes).
|
|
.TP 8
|
|
.B \-I \fIname\fP
|
|
\fBIndexAlias\fP. Use the filename \fIname\fP as an additional alias
|
|
for \fIindex.\fP.
|
|
.TP 8
|
|
.B \-M \fInum\fP
|
|
\fBMangleAgents\fP. Mangle user agent names according to the mangle
|
|
level specified by \fInum\fP. Mangle levels are:
|
|
.RS
|
|
.TP 12
|
|
.B 5
|
|
Browser name and major version.
|
|
.TP 12
|
|
.B 4
|
|
Browser name, major and minor version.
|
|
.TP 12
|
|
.B 3
|
|
Browser name, major version, minor version to two decimal places.
|
|
.TP 12
|
|
.B 2
|
|
Browser name, major and minor versions and sub-version.
|
|
.TP 12
|
|
.B 1
|
|
Browser name, version and machine type if possible.
|
|
.TP 12
|
|
.B 0
|
|
All information (left unchanged).
|
|
.RE
|
|
.TP 8
|
|
.B \-g \fInum\fP
|
|
\fBGroupDomains\fP. Automatically group sites by domain. The
|
|
grouping level specified by \fInum\fP can be thought of as 'the
|
|
number of dots' to display in the grouping. The default value
|
|
of \fB0\fP disables any domain grouping.
|
|
.TP 8
|
|
.B \-D \fIname\fP
|
|
\fBDNSCache\fP. Use the DNS cache file \fIname\fP.
|
|
.TP 8
|
|
.B \-N \fInum\fP
|
|
\fBDNSChildren\fP. Use \fInum\fP DNS children processes to perform DNS
|
|
lookups, either creating or updating the DNS cache file. Specify zero
|
|
(\fB0\fP) to disable cache file creation/updates. If given, a DNS cache
|
|
filename must be specified.
|
|
.TP 8
|
|
.B \-j
|
|
Enable \fIGeoDB\fP. This enables the internal GeoDB geolocation services
|
|
provided by The \fIWebalizer\fP.
|
|
.TP 8
|
|
.B \-J \fIname\fP
|
|
\fBGeoDBDatabase\fP. Use the alternate GeoDB database \fIname\fP.
|
|
.TP 8
|
|
.B \-w
|
|
Enable \fIGeoIP\fP. Enables GeoIP (by MaxMind Inc.) geolocation services.
|
|
If native \fIGeoDB\fP services are also enabled, then this option
|
|
will have no effect.
|
|
.TP 8
|
|
.B \-W \fIname\fP
|
|
\fBGeoIPDatabase\fP. Use the alternate GeoIP database \fIname\fP.
|
|
.TP 8
|
|
.B \-z \fIname\fP
|
|
\fBFlagDir\fP. Specify location of the country flag graphics and
|
|
enable their display in the top country table. The directory \fIname\fP
|
|
is relative to the output directory being used unless an absolute path
|
|
is given (ie: starts with a leading '/').
|
|
.PP
|
|
.I Hide Options
|
|
.TP 8
|
|
.B \-a \fIname\fP
|
|
\fBHideAgent\fP. Hide user agents matching \fIname\fP.
|
|
.TP 8
|
|
.B \-r \fIname\fP
|
|
\fBHideReferrer\fP. Hide referrer matching \fIname\fP.
|
|
.TP 8
|
|
.B \-s \fIname\fP
|
|
\fBHideSite\fP. Hide site matching \fIname\fP.
|
|
.TP 8
|
|
.B \-X
|
|
\fBHideAllSites\fP. Hide all individual sites (only display groups).
|
|
.TP 8
|
|
.B \-u \fIname\fP
|
|
\fBHideURL\fP. Hide URL matching \fIname\fP.
|
|
.PP
|
|
.I Table size options
|
|
.TP 8
|
|
.B \-A \fInum\fP
|
|
\fBTopAgents\fP. Display the top \fInum\fP user agents table.
|
|
.TP 8
|
|
.B \-R \fInum\fP
|
|
\fBTopReferrers\fP. Display the top \fInum\fP referrers table.
|
|
.TP 8
|
|
.B \-S \fInum\fP
|
|
\fBTopSites\fP. Display the top \fInum\fP sites table.
|
|
.TP 8
|
|
.B \-U \fInum\fP
|
|
\fBTopURLs\fP. Display the top \fInum\fP URLs table.
|
|
.TP 8
|
|
.B \-C \fInum\fP
|
|
\fBTopCountries\fP. Display the top \fInum\fP countries table.
|
|
.TP 8
|
|
.B \-e \fInum\fP
|
|
\fBTopEntry\fP. Display the top \fInum\fP entry pages table.
|
|
.TP 8
|
|
.B \-E \fInum\fP
|
|
\fBTopExit\fP. Display the top \fInum\fP exit pages table.
|
|
.SH CONFIGURATION FILES
|
|
Configuration files are standard \fBASCII(7)\fP text files that may be created
|
|
or edited using any standard editor. Blank lines and lines that begin
|
|
with a pound sign ('#') are ignored. Any other lines are considered to
|
|
be configuration lines, and have the form "Keyword Value", where the
|
|
\'Keyword\' is one of the currently available configuration keywords defined
|
|
below, and 'Value' is the value to assign to that particular option. Any
|
|
text found after the keyword up to the end of the line is considered the
|
|
keyword's value, so you should not include anything after the actual value
|
|
on the line that is not actually part of the value being assigned. The
|
|
file \fIsample.conf\fP provided with the distribution contains lots of useful
|
|
documentation and examples as well.
|
|
|
|
.I General Configuration Keywords
|
|
.TP 8
|
|
.B LogFile \fIname\fP
|
|
Use log file named \fIname\fP. If none specified, \fISTDIN\fP will be used.
|
|
.TP 8
|
|
.B LogType \fIname\fP
|
|
Specify log file type as \fIname\fP. Values can be either \fIclf\fP,
|
|
\fIsquid\fP, \fIftp\fP or \fIw3c\fP, with the default being \fBclf\fP.
|
|
.TP 8
|
|
.B OutputDir \fIdir\fP
|
|
Create output in the directory \fIdir\fP. If none specified, the current
|
|
directory will be used.
|
|
.TP 8
|
|
.B HistoryName \fIname\fP
|
|
Filename to use for history file. Relative to output directory unless
|
|
absolute name is given (ie: starts with '/'). Defaults to
|
|
\'\fBwebalizer.hist\fP' in the standard output directory.
|
|
.TP 8
|
|
.B ReportTitle \fIname\fP
|
|
Use the title string \fIname\fP for the report title. If none
|
|
specified, use the default of (in english) "\fIUsage Statistics for \fP".
|
|
.TP 8
|
|
.B HostName \fIname\fP
|
|
Set the hostname for the report as \fIname\fP. If none specified, an
|
|
attempt will be made to gather the hostname via a \fBuname(2)\fP system
|
|
call. If that fails, \fIlocalhost\fP will be used.
|
|
.TP 8
|
|
.B UseHTTPS \fP( yes | \fBno\fP )
|
|
Use \fIhttps://\fP on links to URLS, instead of the default \fIhttp://\fP,
|
|
in the '\fBTop URLs\fP' table.
|
|
.TP 8
|
|
.B HTAccess \fP( yes | \fBno\fP )
|
|
Enables the creation of a default .htaccess file in the output directory.
|
|
.TP 8
|
|
.B Quiet \fP( yes | \fBno\fP )
|
|
Suppress informational messages. Warning and Error messages will not be
|
|
suppressed.
|
|
.TP 8
|
|
.B ReallyQuiet \fP( yes | \fBno\fP )
|
|
Suppress all messages, including Warning and Error messages.
|
|
.TP 8
|
|
.B Debug \fP( yes | \fBno\fP )
|
|
Print extra debugging information on Warnings and Errors.
|
|
.TP 8
|
|
.B TimeMe \fP( yes | \fBno\fP )
|
|
Force timing information at end of processing.
|
|
.TP 8
|
|
.B GMTTime \fP( yes | \fBno\fP )
|
|
Use \fIGMT \fP(\fIUTC\fP) time instead of local timezone for reports.
|
|
.TP 8
|
|
.B IgnoreHist \fP( yes | \fBno\fP )
|
|
Ignore previous monthly history file. \fBUSE WITH CAUTION\fP. Does
|
|
not prevent \fIIncremental\fP file processing.
|
|
.TP 8
|
|
.B IgnoreState \fP( yes | \fBno\fP )
|
|
Ignore incremental data file. \fBUSE WITH CAUTION\fP. By ignoring
|
|
the incremental data file, all previous processing for the current
|
|
month will be lost and those logs must be re-processed.
|
|
.TP 8
|
|
.B FoldSeqErr \fP( yes | \fBno\fP )
|
|
Fold out of sequence log records back into analysis by treating them
|
|
as if they had the same date/time as the last good record. Normally,
|
|
out of sequence log records are ignored.
|
|
.TP 8
|
|
.B CountryGraph \fP( \fByes\fP | no )
|
|
Display Country Usage Graph in output report.
|
|
.TP 8
|
|
.B CountryFlags \fP( yes | \fBno\fP )
|
|
Enable or disable the display of flags in the top country table.
|
|
.TP 8
|
|
.B FlagDir \fIname\fP
|
|
Specifies the directory \fIname\fP where the flag graphics are located.
|
|
If not specified, the default is in the \fIflags\fP directory directly
|
|
under the output directory being used. If specified, the display of
|
|
country flags will be enabled by default. Using '\fIFlagDir flags\fP'
|
|
is identical to using '\fICountryFlags yes\fP'.
|
|
.TP 8
|
|
.B DailyGraph \fP( \fByes\fP | no )
|
|
Display Daily Graph in output report.
|
|
.TP 8
|
|
.B DailyStats \fP( \fByes\fP | no )
|
|
Display Daily Statistics in output report.
|
|
.TP 8
|
|
.B HourlyGraph \fP( \fByes\fP | no )
|
|
Display Hourly Graph in output report.
|
|
.TP 8
|
|
.B HourlyStats \fP( \fByes\fP | no )
|
|
Display Hourly Statistics in output report.
|
|
.TP 8
|
|
.B PageType \fIname\fP
|
|
Define the file extensions to consider as a \fIpage\fP. If a file
|
|
is found to have the same extension as \fIname\fP, it will be counted
|
|
as a \fIpage\fP (sometimes called a \fIpageview\fP).
|
|
.TP 8
|
|
.B PagePrefix \fIname\fP
|
|
Allows URLs with the prefix \fIname\fP to be counted as a \fIpage\fP
|
|
type regardless of actual file type. This allows you to treat contents
|
|
under specified directories as pages no matter what their extension is.
|
|
.TP 8
|
|
.B OmitPage \fIname\fP
|
|
Specifies URLs which should not be counted as pages, regardless of their
|
|
extension (or lack thereof).
|
|
.TP 8
|
|
.B GraphLegend \fP( \fByes\fP | no )
|
|
Allows the color coded graph legends to be enabled/disabled.
|
|
.TP 8
|
|
.B GraphLines \fInum\fP
|
|
Specify the number of background reference lines displayed on the
|
|
graphs produced. Disable by using zero ('\fB0\fP'), default is \fB2\fP.
|
|
.TP 8
|
|
.B IndexMonths \fInum\fP
|
|
Specify the number of months to display in the main index (yearly summary)
|
|
table. Default is 12 months. Can be set to anything between 12 and 120
|
|
months (1 to 10 years).
|
|
.TP 8
|
|
.B YearHeaders \fP( \fByes\fP | no )
|
|
Enable/disable the display of year headers in the main index (yearly
|
|
summary) table. If enabled, year headers will be shown when the table
|
|
is displaying more than 16 months worth of data. Values can be 'yes'
|
|
or 'no'. Default is 'yes'.
|
|
.TP 8
|
|
.B YearTotals \fP( \fByes\fP | no )
|
|
Enable/disable the display of year totals in the main index (yearly
|
|
summary) table. If enabled, year totals will be shown when the table
|
|
is displaying more than 16 months worth of data. Values can be 'yes'
|
|
or 'no'. Default is 'yes'.
|
|
.TP 8
|
|
.B GraphMonths \fInum\fP
|
|
Specify the number of months to display in the main index (yearly
|
|
summary) graph. Default is 12 months. Can be set to anything between
|
|
12 and 72 months (1 to 6 years).
|
|
.TP 8
|
|
.B VisitTimeout \fInum\fP
|
|
Specifies the visit timeout value. Default is \fI1800 seconds\fP (30
|
|
minutes). A visit is determined by looking at the difference in time
|
|
between the current and last request from a specific site. If the
|
|
difference is greater or equal to the timeout value, the request is
|
|
counted as a new visit. Specified in seconds.
|
|
.TP 8
|
|
.B IndexAlias \fIname\fP
|
|
Use \fIname\fP as an additional alias for \fIindex.*\fP.
|
|
.TP 8
|
|
.B DefaultIndex \fP( \fByes\fP | no )
|
|
Enables or disables the use of '\fBindex.\fP' as a default index name
|
|
to be stripped from the end of URLs. This does not effect any index
|
|
names that may be defined with the \fIIndexAlias\fP option.
|
|
.TP 8
|
|
.B MangleAgents \fInum\fP
|
|
Mangle user agent names based on mangle level \fInum\fP. See the
|
|
\fI-M\fP command line switch for mangle levels and their meaning.
|
|
The default is \fB0\fP, which doesn't mangle user agents at all.
|
|
.TP 8
|
|
.B StripCGI \fP( \fByes\fP | no )
|
|
Determines if URL CGI variables should be stripped from the end of
|
|
URLs. Values may be 'yes' or 'no', with the default being 'yes'.
|
|
.TP 8
|
|
.B TrimSquidURL \fInum\fP
|
|
Allows squid log URLs to be reduced in granularity by truncating
|
|
them after \fInum\fP slashes ('/') after the http:// prefix. A
|
|
setting of one (1) will cause all URLs to be summarized by domain
|
|
only. The default value is zero (0), which will disable any URL
|
|
modifications and leave them exactly as found in the log file.
|
|
.TP 8
|
|
.B SearchEngine\fP \fIname\fP \fIvariable\fP
|
|
Allows the specification of search engines and their query strings.
|
|
The \fIname\fP is the name to match against the referrer string for
|
|
a given search engine. The \fIvariable\fP is the cgi variable that
|
|
the search engine uses for queries. See the \fBsample.conf\fP file
|
|
for example usage with common search engines.
|
|
.TP 8
|
|
.B SearchCaseI\fP ( \fByes\fP | no )
|
|
Determines if search strings should be treated case insensitive or
|
|
not. The default is 'yes', which lowercases all search strings
|
|
(treat as case insensitive).
|
|
.TP 8
|
|
.B Incremental \fP( yes | \fBno\fP )
|
|
Enable Incremental mode processing.
|
|
.TP 8
|
|
.B IncrementalName \fIname\fP
|
|
Filename to use for incremental data. Relative to output directory unless
|
|
an absolute name is given (ie: starts with '/'). Defaults to
|
|
\'\fBwebalizer.current\fP' in the standard output directory.
|
|
.TP 8
|
|
.B DNSCache \fIname\fP
|
|
Filename to use for the DNS cache. Relative to output directory unless
|
|
an absolute name is given (ie: starts with '/').
|
|
.TP 8
|
|
.B DNSChildren \fInum\fP
|
|
Number of children DNS processes to run in order to create/update the
|
|
DNS cache file. Specify zero (\fB0\fP) to disable.
|
|
.TP 8
|
|
.B CacheIPs \fP( yes | \fBno\fP )
|
|
Cache unresolved IP addresses in the DNS database. Default is '\fBno\fP'.
|
|
.TP 8
|
|
.B CacheTTL \fInum\fP
|
|
DNS cache entry time to live (TTL) in days. Default is 7 days. May
|
|
be any value between 1 and 100.
|
|
.TP 8
|
|
.B GeoDB \fP( yes | \fBno\fP )
|
|
Allows native GeoDB geolocation services to be enabled or disabled.
|
|
Default value is '\fBno\fP'.
|
|
.TP 8
|
|
.B GeoDBDatabase \fIname\fP
|
|
Allows the use of an alternate GeoDB database \fIname\fP. If not
|
|
specified, the default database will be used.
|
|
.TP 8
|
|
.B GeoIP \fP( yes | \fBno\fP )
|
|
Allows GeoIP (by MaxMind Inc.) geolocation services to be enabled or
|
|
disabled. Default is '\fBno\fP'. If native \fIGeoDB\fP geolocation
|
|
services are also enabled, then this option will have no effect (and
|
|
the native \fIGeoDB\fP services will be used).
|
|
.TP 8
|
|
.B GeoIPDatabase \fIname\fP
|
|
Allows the use of an alternate GeoIP database \fIname\fP. If not
|
|
specified, the default database will be used.
|
|
.PP
|
|
.I Top Table Keywords
|
|
.TP 8
|
|
.B TopAgents \fInum\fP
|
|
Display the top \fInum\fP User Agents table. Use zero to disable.
|
|
.TP 8
|
|
.B AllAgents \fP( yes | \fBno\fP )
|
|
Create separate HTML page with \fBAll\fP User Agents.
|
|
.TP 8
|
|
.B TopReferrers \fInum\fP
|
|
Display the top \fInum\fP Referrers table. Use zero to disable.
|
|
.TP 8
|
|
.B AllReferrers \fP( yes | \fBno\fP )
|
|
Create separate HTML page with \fBAll\fP Referrers.
|
|
.TP 8
|
|
.B TopSites \fInum\fP
|
|
Display the top \fInum\fP Sites table. Use zero to disable.
|
|
.TP 8
|
|
.B TopKSites \fInum\fP
|
|
Display the top \fInum\fP Sites (by KByte) table. Use zero to disable.
|
|
.TP 8
|
|
.B AllSites \fP( yes | \fBno\fP )
|
|
Create separate HTML page with \fBAll\fP Sites.
|
|
.TP 8
|
|
.B TopURLs \fInum\fP
|
|
Display the top \fInum\fP URLs table. Use zero to disable.
|
|
.TP 8
|
|
.B TopKURLs \fInum\fP
|
|
Display the top \fInum\fP URLs (by KByte) table. Use zero to disable.
|
|
.TP 8
|
|
.B AllURLs \fP( yes | \fBno\fP )
|
|
Create separate HTML page with \fBAll\fP URLs.
|
|
.TP 8
|
|
.B TopCountries \fInum\fP
|
|
Display the top \fInum\fP Countries in the table. Use zero to disable.
|
|
.TP 8
|
|
.B TopEntry \fInum\fP
|
|
Display the top \fInum\fP Entry Pages in the table. Use zero to disable.
|
|
.TP 8
|
|
.B TopExit \fInum\fP
|
|
Display the top \fInum\fP Exit Pages in the table. Use zero to disable.
|
|
.TP 8
|
|
.B TopSearch \fInum\fP
|
|
Display the top \fInum\fP Search Strings in the table. Use zero to disable.
|
|
.TP 8
|
|
.B AllSearchStr \fP( yes | \fBno\fP )
|
|
Create separate HTML page with \fBAll\fP Search Strings.
|
|
.TP 8
|
|
.B TopUsers \fInum\fP
|
|
Display the top \fInum\fP Usernames in the table. Use zero to disable.
|
|
Usernames are only available if using http based authentication.
|
|
.TP 8
|
|
.B AllUsers \fP( yes | \fBno\fP )
|
|
Create separate HTML page with \fBAll\fP Usernames.
|
|
.PP
|
|
.I Hide/Ignore/Group/Include Keywords
|
|
.TP 8
|
|
.B HideAgent \fIname\fP
|
|
Hide User Agents that match \fIname\fP.
|
|
.TP 8
|
|
.B HideReferrer \fIname\fP
|
|
Hide Referrers that match \fIname\fP.
|
|
.TP 8
|
|
.B HideSite \fIname\fP
|
|
Hide Sites that match \fIname\fP.
|
|
.TP 8
|
|
.B HideAllSites \fP( yes | \fBno\fP )
|
|
Hide all individual sites. This causes only grouped sites to be displayed.
|
|
.TP 8
|
|
.B HideURL \fIname\fP
|
|
Hide URLs that match \fIname\fP.
|
|
.TP 8
|
|
.B HideUser \fIname\fP
|
|
Hide Usernames that match \fIname\fP.
|
|
.TP 8
|
|
.B IgnoreAgent \fIname\fP
|
|
Ignore User Agents that match \fIname\fP.
|
|
.TP 8
|
|
.B IgnoreReferrer \fIname\fP
|
|
Ignore Referrers that match \fIname\fP.
|
|
.TP 8
|
|
.B IgnoreSite \fIname\fP
|
|
Ignore Sites that match \fIname\fP.
|
|
.TP 8
|
|
.B IgnoreURL \fIname\fP
|
|
Ignore URLs that match \fIname\fP.
|
|
.TP 8
|
|
.B IgnoreUser \fIname\fP
|
|
Ignore Usernames that match \fIname\fP.
|
|
.TP 8
|
|
.B GroupAgent \fIname\fP [\fILabel\fP]
|
|
Group User Agents that match \fIname\fP. Display \fILabel\fP in 'Top Agent'
|
|
table if given (instead of \fIname\fP). \fIname\fP may be enclosed in quotes.
|
|
.TP 8
|
|
.B GroupReferrer \fIname\fP [\fILabel\fP]
|
|
Group Referrers that match \fIname\fP. Display \fILabel\fP in 'Top Referrer'
|
|
table if given (instead of \fIname\fP). \fIname\fP may be enclosed in quotes.
|
|
.TP 8
|
|
.B GroupSite \fIname\fP [\fILabel\fP]
|
|
Group Sites that match \fIname\fP. Display \fILabel\fP in 'Top Site'
|
|
table if given (instead of \fIname\fP). \fIname\fP may be enclosed in quotes.
|
|
.TP 8
|
|
.B GroupDomains \fInum\fP
|
|
Automatically group sites by domain. The value \fInum\fP specifies the
|
|
level of grouping, and can be thought of as the 'number of dots' to
|
|
be displayed. The default value of \fB0\fP disables domain grouping.
|
|
.TP 8
|
|
.B GroupURL \fIname\fP [\fILabel\fP]
|
|
Group URLs that match \fIname\fP. Display \fILabel\fP in 'Top URL'
|
|
table if given (instead of \fIname\fP). \fIname\fP may be enclosed in quotes.
|
|
.TP 8
|
|
.B GroupUser \fIname\fP [\fILabel\fP]
|
|
Group Usernames that match \fIname\fP. Display \fILabel\fP in 'Top
|
|
Usernames' table if given (instead of \fIname\fP). \fIname\fP may be
|
|
enclosed in quotes.
|
|
.TP 8
|
|
.B IncludeSite \fIname\fP
|
|
Force inclusion of sites that match \fIname\fP. Takes precedence
|
|
over \fBIgnore*\fP keywords.
|
|
.TP 8
|
|
.B IncludeURL \fIname\fP
|
|
Force inclusion of URLs that match \fIname\fP. Takes precedence
|
|
over \fBIgnore*\fP keywords.
|
|
.TP 8
|
|
.B IncludeReferrer \fIname\fP
|
|
Force inclusion of Referrers that match \fIname\fP. Takes precedence
|
|
over \fBIgnore*\fP keywords.
|
|
.TP 8
|
|
.B IncludeAgent \fIname\fP
|
|
Force inclusion of User Agents that match \fIname\fP. Takes precedence
|
|
over \fBIgnore*\fP keywords.
|
|
.TP 8
|
|
.B IncludeUser \fIname\fP
|
|
Force inclusion of Usernames that match \fIname\fP. Takes precedence
|
|
over \fBIgnore*\fP keywords.
|
|
.PP
|
|
.I HTML Generation Keywords
|
|
.TP 8
|
|
.B HTMLExtension \fItext\fP
|
|
Defines the HTML file extension to use. Default is \fIhtml\fP. Do not
|
|
include the leading period!
|
|
.TP 8
|
|
.B HTMLPre \fItext\fP
|
|
Insert \fItext\fP at the very beginning of the generated HTML file.
|
|
Defaults to a standard html 3.2 \fIDOCTYPE\fP record.
|
|
.TP 8
|
|
.B HTMLHead \fItext\fP
|
|
Insert \fItext\fP within the <HEAD></HEAD> block of the HTML file.
|
|
.TP 8
|
|
.B HTMLBody \fItext\fP
|
|
Insert \fItext\fP in HTML page, starting with the <BODY> tag. If used, the
|
|
first line must be a \fI<BODY ...>\fP tag. Multiple lines may be specified.
|
|
.TP 8
|
|
.B HTMLPost \fItext\fP
|
|
Insert \fItext\fP at top (before horiz. rule) of HTML pages. Multiple lines
|
|
may be specified.
|
|
.TP 8
|
|
.B HTMLTail \fItext\fP
|
|
Insert \fItext\fP at bottom of the HTML page. The \fItext\fP is top and
|
|
right aligned within a table column at the end of the report.
|
|
.TP 8
|
|
.B HTMLEnd \fItext\fP
|
|
Insert \fItext\fP at the very end of the HTML page. If not specified,
|
|
the default is to insert the ending </BODY> and </HTML> tags. If used,
|
|
you \fImust\fP supply these tags yourself.
|
|
.TP 8
|
|
.B LinkReferrer \fP( yes | \fBno\fP )
|
|
Determines if the referrers listed in the top referrers table should be
|
|
displayed as plain text, or as a link to the referrer URL.
|
|
.TP 8
|
|
.B ColorHit \fP( rrggbb | \fB00805c\fP )
|
|
Sets the graph's hit-color to the specified html color (no '#').
|
|
.TP 8
|
|
.B ColorFile \fP( rrggbb | \fB0040ff\fP )
|
|
Sets the graph's file-color to the specified html color (no '#').
|
|
.TP 8
|
|
.B ColorSite \fP( rrggbb | \fBff8000\fP )
|
|
Sets the graph's site-color to the specified html color (no '#').
|
|
.TP 8
|
|
.B ColorKbyte \fP( rrggbb | \fBff0000\fP )
|
|
Sets the graph's kilobyte-color to the specified html color (no '#').
|
|
.TP 8
|
|
.B ColorPage \fP( rrggbb | \fB00e0ff\fP )
|
|
Sets the graph's page-color to the specified html color (no '#').
|
|
.TP 8
|
|
.B ColorVisit \fP( rrggbb | \fBffff00\fP )
|
|
Sets the graph's visit-color to the specified html color (no '#').
|
|
.TP 8
|
|
.B ColorMisc \fP( rrggbb | \fB00e0ff\fP )
|
|
Sets the 'miscellaneous' color for table headers (not graphs) to
|
|
the specified html color (no '#').
|
|
.TP 8
|
|
.B PieColor1 \fP( rrggbb | \fB800080\fP )
|
|
Sets the pie's first optional color to the specified html color (no '#').
|
|
.TP 8
|
|
.B PieColor2 \fP( rrggbb | \fB80ffc0\fP )
|
|
Sets the pie's second optional color to the specified html color (no '#').
|
|
.TP 8
|
|
.B PieColor3 \fP( rrggbb | \fBff00ff\fP )
|
|
Sets the pie's third optional color to the specified html color (no '#').
|
|
.TP 8
|
|
.B PieColor4 \fP( rrggbb | \fBffc480\fP )
|
|
Sets the pie's fourth optional color to the specified html color (no '#').
|
|
.PP
|
|
.I Dump Object Keywords
|
|
.PP
|
|
The \fIWebalizer\fP allows you to export processed data to other programs by
|
|
using \fItab delimited\fP text files. The \fIDump*\fP commands specify
|
|
which files are to be written, and where.
|
|
.TP 8
|
|
.B DumpPath \fIname\fP
|
|
Save dump files in directory \fIname\fP. If not specified, the default
|
|
output directory will be used. Do not specify a trailing slash ('/').
|
|
.TP 8
|
|
.B DumpExtension \fIname\fP
|
|
Use \fIname\fP as the filename extension for dump files. If not given,
|
|
the default of \fBtab\fP will be used.
|
|
.TP 8
|
|
.B DumpHeader \fP( yes | \fBno\fP )
|
|
Print a column header as the first record of the file.
|
|
.TP 8
|
|
.B DumpSites \fP( yes | \fBno\fP )
|
|
Dump the sites data to a tab delimited file.
|
|
.TP 8
|
|
.B DumpURLs \fP( yes | \fBno\fP )
|
|
Dump the url data to a tab delimited file.
|
|
.TP 8
|
|
.B DumpReferrers \fP( yes | \fBno\fP )
|
|
Dump the referrer data to a tab delimited file. This data is only
|
|
available if using a log that contains referrer information
|
|
(ie: a combined format web log).
|
|
.TP 8
|
|
.B DumpAgents \fP( yes | \fBno\fP )
|
|
Dump the user agent data to a tab delimited file. This data is only
|
|
available if using a log that contains user agent information
|
|
(ie: a combined format web log).
|
|
.TP 8
|
|
.B DumpUsers \fP( yes | \fBno\fP )
|
|
Dump the username data to a tab delimited file. This data is only available
|
|
if processing a wu-ftpd xferlog or a web log that contains http authentication
|
|
information.
|
|
.TP 8
|
|
.B DumpSearchStr \fP( yes | \fBno\fP )
|
|
Dump the search string data to a tab delimited file. This data is only
|
|
available if processing a web log that contains referrer information and
|
|
had search string information present.
|
|
.SH FILES
|
|
.TP 20
|
|
.I webalizer.conf
|
|
Default configuration file. Is searched for in the current directory
|
|
and if not found, in the \fI/etc/\fP directory.
|
|
.TP 20
|
|
.I webalizer.hist
|
|
Monthly history file for previous months. (can be changed)
|
|
.TP 20
|
|
.I webalizer.current
|
|
Current state data file (Incremental processing). (can be changed)
|
|
.TP 20
|
|
.I xxxxx_YYYYMM.html
|
|
Various monthly \fIHTML\fP output files produced. (extension can be changed)
|
|
.TP 20
|
|
.I xxxxx_YYYYMM.png
|
|
Various monthly image files used in the reports.
|
|
.TP 20
|
|
.I xxxxx_YYYYMM.tab
|
|
Monthly tab delimited text files. (extension can be changed)
|
|
.SH BUGS
|
|
Please report bugs to the author.
|
|
.SH COPYRIGHT
|
|
Copyright (C) 1997-2011 by Bradford L. Barrett. Distributed under
|
|
the GNU GPL. See the files "\fICOPYING\fP" and "\fICopyright\fP",
|
|
supplied with all distributions for additional information.
|
|
.SH AUTHOR
|
|
Bradford L. Barrett <\fIbrad at mrunix dot net\fP>
|