1webalizer(1) The Webalizer webalizer(1)
2
6 webalizer - A web server log file analysis tool.
7
9 webalizer [ option ... ] [ log-file ]
10 webazolver [ option ... ] [ log-file ]
12
14 The Webalizer is a web server log file analysis program which produces
15 usage statistics in HTML format for viewing with a browser. The
16 results are presented in both columnar and graphical format, which
17 facilitates interpretation. Yearly, monthly, daily and hourly usage
18 statistics are presented, along with the ability to display usage by
19 site, URL, referrer, user agent (browser), username, search strings,
20 entry/exit pages, and country (some information may not be available
21 if not present in the log file being processed).
22 The Webalizer supports CLF (common log format) log files, as well as
24 Combined log formats as defined by NCSA and others, and variations of
25 these which it attempts to handle intelligently. In addition, the
26 Webalizer supports xferlog formatted (FTP) log files, squid proxy logs
27 and W3C extended format logs. Logs may also be compressed, via gzip
28 (.gz) or, if enabled at compile time, bzip2 (.bz2). If a compressed
29 log file is detected, it will be automatically uncompressed while it is
30 read. Compressed logs must have the standard gzip extension of .gz or
31 bzip2 extension of .bz2.
32 webazolver is normally just a symbolic link to the Webalizer. When run
34 as webazolver, only DNS file creation/updates are performed, and the
35 program will exit once complete. All normal options and configuration
36 directives are available, however many will not be used. In addition,
37 a DNS cache file must be specified. If the number of DNS children pro‐
38 cesses to use are not specified, the webazolver will default to 5.
39 This documentation applies to The Webalizer Version 2.23
41
43 The Webalizer was designed to be run from a Unix command line prompt or
44 as a crond(8) job. Once executed, the general flow of the program is:
45 o A default configuration file is scanned for. A file named
47 webalizer.conf is searched for in the current directory, and if
48 found, and is owned by the invoking user, then its configura‐
49 tion data is parsed. If the file is not present in the current
50 directory, the file /etc/webalizer.conf is searched for and,
51 if found, is used instead.
52 o Any command line arguments given to the program are parsed.
54 This may include the specification of a configuration file,
55 which is processed at the time it is encountered.
56 o If a log file was specified, it is opened and made ready for
58 processing. If no log file was given, STDIN is used for input.
59 If the log filename '-' is specified, STDIN will be forced.
60 o If an output directory was specified, the program does a
62 chdir(2) to that directory in preparation for generating out‐
63 put. If no output directory was given, the current directory
64 is used.
65 o If a non-zero number of DNS Children processes were specified,
67 they will be started, and the specified log file will be pro‐
68 cessed, creating or updating the specified DNS cache file.
69 o If no hostname was given, the program attempts to get the host‐
71 name using a uname(2) system call. If that fails, localhost is
72 used.
73 o A history file is searched for in the current directory (output
75 directory) and read if found. This file keeps totals for pre‐
76 vious months, which is used in the main index.html HTML docu‐
77 ment. Note: The file location can now be specified with the
78 HistoryName configuration option.
79 o If incremental processing was specified, a data file is
81 searched for and loaded if found, containing the 'internal
82 state' data of the program at the end of a previous run. Note:
83 The file location can now be specified with the IncrementalName
84 configuration option.
85 o Main processing begins on the log file. If the log spans mul‐
87 tiple months, a separate HTML document is created for each
88 month.
89 o After main processing, the main index.html page is created,
91 which has totals by month and links to each months HTML docu‐
92 ment.
93 o A new history file is saved to disk, which includes totals gen‐
95 erated by The Webalizer during the current run.
96 o If incremental processing was specified, a data file is written
98 that contains the 'internal state' data at the end of this run.
99
101 The Webalizer supports incremental run capability. Simply put, this
102 allows processing large log files by breaking them up into smaller
103 pieces, and processing these pieces instead. What this means in real
104 terms is that you can now rotate your log files as often as you want,
105 and still be able to produce monthly usage statistics without the loss
106 of any detail. Basically, The Webalizer saves and restores all inter‐
107 nal data in a file named webalizer.current. This allows the program to
108 'start where it left off' so to speak, and allows the preservation of
109 detail from one run to the next. The data file is placed in the cur‐
110 rent output directory, and is a plain ASCII text file that can be
111 viewed with any standard text editor. It's location and name may be
112 changed using the IncrementalName configuration keyword.
113 Some special precautions need to be taken when using the incremental
115 run capability of The Webalizer. Configuration options should not be
116 changed between runs, as that could cause corruption of the internal
117 data stored. For example, changing the MangleAgents level will cause
118 different representations of user agents to be stored, producing
119 invalid results in the user agents section of the report. If you need
120 to change configuration options, do it at the end of the month after
121 normal processing of the previous month and before processing the cur‐
122 rent month. You may also want to delete the webalizer.current file as
123 well.
124 The Webalizer also attempts to prevent data duplication by keeping
126 track of the timestamp of the last record processed. This timestamp is
127 then compared to current records being processed, and any records that
128 were logged previous to that timestamp are ignored. This, in theory,
129 should allow you to re-process logs that have already been processed,
130 or process logs that contain a mix of processed/not yet processed
131 records, and not produce duplication of statistics. The only time this
132 may break is if you have duplicate timestamps in two separate log
133 files... any records in the second log file that do have the same time‐
134 stamp as the last record in the previous log file processed, will be
135 discarded as if they had already been processed. There are lots of
136 ways to prevent this however, for example, stopping the web server
137 before rotating logs will prevent this situation. This setup also
138 necessitates that you always process logs in chronological order, oth‐
139 erwise data loss will occur as a result of the timestamp compare.
140
142 The Webalizer fully supports IPv4 and IPv6 DNS lookups, and maintains a
143 cache of those lookups to reduce processing the same addresses in sub‐
144 sequent runs. The cache file can be created at run-time, or may be
145 created before running the webalizer using either the stand alone
146 'webazolver' program, or The Webalizer (DNS) Cache file manager program
147 'wcmgr'. In order to perform reverse lookups, a DNSCache file must be
148 specified, either on the command line or in a configuration file. In
149 order to create/update the cache file at run-time, the number of
150 DNSChildren must also be specified, and can be anything between 1 and
151 100. This specifies the number of child processes to be forked, each
152 of which will perform network DNS queries in order to lookup up the
153 addresses and update the cache. Cached entries that are older than a
154 specified TTL (time to live) will be expired, and if encountered again
155 in a log, will be looked up at that time in order to 'freshen' them
156 (verify the name is still the same and update its timestamp). The
157 default TTL is 7 days, however may be set to anything between 1 and 100
158 days. Using the 'wcmgr' program, entries may also be marked as 'perma‐
159 nent', in which case they will persist (with an infinite TTL) in the
160 cache until manually removed. See the file DNS.README for additional
161 information and examples.
162
164 The Webalizer has the ability to perform geolocation lookups on IP
165 addresses using either it's own internal GeoDB database, or optionally
166 the GeoIP database from MaxMind, Inc. (www.maxmind.com). If used,
167 unresolved addresses will be searched for in the database and its coun‐
168 try of origin will be returned if found. This actually produces more
169 accurate Country information than DNS lookups, since the DNS address
170 space has additional gcTLDs that do not necessarily map to a specific
171 country (such as .net and .com). It is possible to use both DNS
172 lookups and geolocation lookups at the same time, which will cause any
173 addresses that could not be resolved using DNS lookups to then be
174 looked up in the database, greatly reducing the number of Unknown/Unre‐
175 solved entries in the generated reports. The native GeoDB geolocation
176 database provided by The Webalizer fully supports both IPv4 and IPv6
177 lookups, is updated regularly and is the preferred geolocation method
178 for use with The Webalizer. The most current version of the database
179 can be obtained from our ftp site (ftp://ftp.mrunix.net/).
180
182 The Webalizer supports many different configuration options that will
183 alter the way the program behaves and generates output. Most of these
184 can be specified on the command line, while some can only be specified
185 in a configuration file. The command line options are listed below,
186 with references to the corresponding configuration file keywords.
187 General Options
189 -h Display all available command line options and exit program.
191 -v Be verbose. Will cause the program to output informational and
193 Debug messages at run-time.
194 -V Display the program version and exit. Additional program spe‐
196 cific information will be displayed if verbose mode is also
197 used (e.g. '-vV'), which can be useful when submitting bug
198 reports.
199 -d Debug. Display debugging information for errors and warnings.
201 -i IgnoreHist. Ignore history. USE WITH CAUTION. This will cause
203 The Webalizer to ignore any previous monthly history file only.
204 Incremental data (if present) is still processed.
205 -b IgnoreState. Ignore incremental data file. USE WITH CAUTION.
207 This will cause The Webalizer to ignore any existing incremen‐
208 tal data file. By ignoring the incremental data file, all pre‐
209 vious processing for the current month will be lost and those
210 logs must be re-processed.
211 -p Incremental. Preserve internal data between runs.
213 -q Quiet. Suppress informational messages. Does not suppress
215 warnings or errors.
216 -Q ReallyQuiet. Suppress all messages including warnings and
218 errors.
219 -T TimeMe. Force display of timing information at end of process‐
221 ing.
222 -c file Use configuration file file.
224 -n name HostName. Use the hostname name.
226 -o dir OutputDir. Use output directory dir.
228 -t name ReportTitle. Use name for report title.
230 -F ( clf | ftp | squid | w3c )
232 LogType. Specify log type to be processed. Value can be
233 either clf, ftp, squid or w3c format. If not specified, will
234 default to CLF format. FTP logs must be in standard wu-ftpd
235 xferlog format.
236 -f FoldSeqErr. Fold out of sequence log records back into analy‐
238 sis, by treating as if they were the same date/time as the last
239 good record. Normally, out of sequence log records are simply
240 ignored.
241 -Y CountryGraph. Suppress country graph.
243 -G HourlyGraph. Suppress hourly graph.
245 -x name HTMLExtension. Defines HTML file extension to use. If not
247 specified, defaults to html. Do not include the leading
248 period.
249 -H HourlyStats. Suppress hourly statistics.
251 -K num IndexMonths. Specify how many months should be displayed in
253 the main index (yearly summary) table. Default is 12 months.
254 Can be set to anything between 12 and 120 months (1 to 10
255 years).
256 -k num GraphMonths. Specify how many months should be displayed in
258 the main index (yearly summary) graph. Default is 12 months.
259 Can be set to anything between 12 and 72 months (1 to 6 years).
260 -L GraphLegend. Suppress color coded graph legends.
262 -l num GraphLines. Specify number of background lines. Default is 2.
264 Use zero ('0') to disable the lines.
265 -P name PageType. Specify file extensions that are considered pages.
267 Sometimes referred to as pageviews.
268 -O name OmitPage. Specify URLs to exclude from being counted as pages.
270 -m num VisitTimeout. Specify the Visit timeout period. Specified in
272 number of seconds. Default is 1800 seconds (30 minutes).
273 -I name IndexAlias. Use the filename name as an additional alias for
275 index..
276 -M num MangleAgents. Mangle user agent names according to the mangle
278 level specified by num. Mangle levels are:
279 5 Browser name and major version.
281 4 Browser name, major and minor version.
283 3 Browser name, major version, minor version to two
285 decimal places.
286 2 Browser name, major and minor versions and sub-ver‐
288 sion.
289 1 Browser name, version and machine type if possible.
291 0 All information (left unchanged).
293 -g num GroupDomains. Automatically group sites by domain. The group‐
295 ing level specified by num can be thought of as 'the number of
296 dots' to display in the grouping. The default value of 0 dis‐
297 ables any domain grouping.
298 -D name DNSCache. Use the DNS cache file name.
300 -N num DNSChildren. Use num DNS children processes to perform DNS
302 lookups, either creating or updating the DNS cache file. Spec‐
303 ify zero (0) to disable cache file creation/updates. If given,
304 a DNS cache filename must be specified.
305 -j Enable GeoDB. This enables the internal GeoDB geolocation ser‐
307 vices provided by The Webalizer.
308 -J name GeoDBDatabase. Use the alternate GeoDB database name.
310 -w Enable GeoIP. Enables GeoIP (by MaxMind Inc.) geolocation ser‐
312 vices. If native GeoDB services are also enabled, then this
313 option will have no effect.
314 -W name GeoIPDatabase. Use the alternate GeoIP database name.
316 -z name FlagDir. Specify location of the country flag graphics and
318 enable their display in the top country table. The directory
319 name is relative to the output directory being used unless an
320 absolute path is given (ie: starts with a leading '/').
321 Hide Options
323 -a name HideAgent. Hide user agents matching name.
325 -r name HideReferrer. Hide referrer matching name.
327 -s name HideSite. Hide site matching name.
329 -X HideAllSites. Hide all individual sites (only display groups).
331 -u name HideURL. Hide URL matching name.
333 Table size options
335 -A num TopAgents. Display the top num user agents table.
337 -R num TopReferrers. Display the top num referrers table.
339 -S num TopSites. Display the top num sites table.
341 -U num TopURLs. Display the top num URLs table.
343 -C num TopCountries. Display the top num countries table.
345 -e num TopEntry. Display the top num entry pages table.
347 -E num TopExit. Display the top num exit pages table.
349
351 Configuration files are standard ASCII(7) text files that may be cre‐
352 ated or edited using any standard editor. Blank lines and lines that
353 begin with a pound sign ('#') are ignored. Any other lines are consid‐
354 ered to be configuration lines, and have the form "Keyword Value",
355 where the ´Keyword´ is one of the currently available configuration
356 keywords defined below, and 'Value' is the value to assign to that par‐
357 ticular option. Any text found after the keyword up to the end of the
358 line is considered the keyword's value, so you should not include any‐
359 thing after the actual value on the line that is not actually part of
360 the value being assigned. The file sample.conf provided with the dis‐
361 tribution contains lots of useful documentation and examples as well.
362 General Configuration Keywords
364 LogFile name
366 Use log file named name. If none specified, STDIN will be
367 used.
368 LogType name
370 Specify log file type as name. Values can be either clf, squid,
371 ftp or w3c, with the default being clf.
372 OutputDir dir
374 Create output in the directory dir. If none specified, the
375 current directory will be used.
376 HistoryName name
378 Filename to use for history file. Relative to output directory
379 unless absolute name is given (ie: starts with '/'). Defaults
380 to ´webalizer.hist' in the standard output directory.
381 ReportTitle name
383 Use the title string name for the report title. If none speci‐
384 fied, use the default of (in english) "Usage Statistics for ".
385 HostName name
387 Set the hostname for the report as name. If none specified, an
388 attempt will be made to gather the hostname via a uname(2) sys‐
389 tem call. If that fails, localhost will be used.
390 UseHTTPS ( yes | no )
392 Use https:// on links to URLS, instead of the default http://,
393 in the 'Top URLs' table.
394 HTAccess ( yes | no )
396 Enables the creation of a default .htaccess file in the output
397 directory.
398 Quiet ( yes | no )
400 Suppress informational messages. Warning and Error messages
401 will not be suppressed.
402 ReallyQuiet ( yes | no )
404 Suppress all messages, including Warning and Error messages.
405 Debug ( yes | no )
407 Print extra debugging information on Warnings and Errors.
408 TimeMe ( yes | no )
410 Force timing information at end of processing.
411 GMTTime ( yes | no )
413 Use GMT (UTC) time instead of local timezone for reports.
414 IgnoreHist ( yes | no )
416 Ignore previous monthly history file. USE WITH CAUTION. Does
417 not prevent Incremental file processing.
418 IgnoreState ( yes | no )
420 Ignore incremental data file. USE WITH CAUTION. By ignoring
421 the incremental data file, all previous processing for the cur‐
422 rent month will be lost and those logs must be re-processed.
423 FoldSeqErr ( yes | no )
425 Fold out of sequence log records back into analysis by treating
426 them as if they had the same date/time as the last good record.
427 Normally, out of sequence log records are ignored.
428 CountryGraph ( yes | no )
430 Display Country Usage Graph in output report.
431 CountryFlags ( yes | no )
433 Enable or disable the display of flags in the top country ta‐
434 ble.
435 FlagDir name
437 Specifies the directory name where the flag graphics are
438 located. If not specified, the default is in the flags direc‐
439 tory directly under the output directory being used. If speci‐
440 fied, the display of country flags will be enabled by default.
441 Using 'FlagDir flags' is identical to using 'CountryFlags yes'.
442 DailyGraph ( yes | no )
444 Display Daily Graph in output report.
445 DailyStats ( yes | no )
447 Display Daily Statistics in output report.
448 HourlyGraph ( yes | no )
450 Display Hourly Graph in output report.
451 HourlyStats ( yes | no )
453 Display Hourly Statistics in output report.
454 PageType name
456 Define the file extensions to consider as a page. If a file is
457 found to have the same extension as name, it will be counted as
458 a page (sometimes called a pageview).
459 PagePrefix name
461 Allows URLs with the prefix name to be counted as a page type
462 regardless of actual file type. This allows you to treat con‐
463 tents under specified directories as pages no matter what their
464 extension is.
465 OmitPage name
467 Specifies URLs which should not be counted as pages, regardless
468 of their extension (or lack thereof).
469 GraphLegend ( yes | no )
471 Allows the color coded graph legends to be enabled/disabled.
472 GraphLines num
474 Specify the number of background reference lines displayed on
475 the graphs produced. Disable by using zero ('0'), default is
476 2.
477 IndexMonths num
479 Specify the number of months to display in the main index
480 (yearly summary) table. Default is 12 months. Can be set to
481 anything between 12 and 120 months (1 to 10 years).
482 YearHeaders ( yes | no )
484 Enable/disable the display of year headers in the main index
485 (yearly summary) table. If enabled, year headers will be shown
486 when the table is displaying more than 16 months worth of data.
487 Values can be 'yes' or 'no'. Default is 'yes'.
488 YearTotals ( yes | no )
490 Enable/disable the display of year totals in the main index
491 (yearly summary) table. If enabled, year totals will be shown
492 when the table is displaying more than 16 months worth of data.
493 Values can be 'yes' or 'no'. Default is 'yes'.
494 GraphMonths num
496 Specify the number of months to display in the main index
497 (yearly summary) graph. Default is 12 months. Can be set to
498 anything between 12 and 72 months (1 to 6 years).
499 VisitTimeout num
501 Specifies the visit timeout value. Default is 1800 seconds (30
502 minutes). A visit is determined by looking at the difference
503 in time between the current and last request from a specific
504 site. If the difference is greater or equal to the timeout
505 value, the request is counted as a new visit. Specified in
506 seconds.
507 IndexAlias name
509 Use name as an additional alias for index.*.
510 DefaultIndex ( yes | no )
512 Enables or disables the use of 'index.' as a default index name
513 to be stripped from the end of URLs. This does not effect any
514 index names that may be defined with the IndexAlias option.
515 MangleAgents num
517 Mangle user agent names based on mangle level num. See the -M
518 command line switch for mangle levels and their meaning. The
519 default is 0, which doesn't mangle user agents at all.
520 StripCGI ( yes | no )
522 Determines if URL CGI variables should be stripped from the end
523 of URLs. Values may be 'yes' or 'no', with the default being
524 'yes'.
525 TrimSquidURL num
527 Allows squid log URLs to be reduced in granularity by truncat‐
528 ing them after num slashes ('/') after the http:// prefix. A
529 setting of one (1) will cause all URLs to be summarized by
530 domain only. The default value is zero (0), which will disable
531 any URL modifications and leave them exactly as found in the
532 log file.
533 SearchEngine name variable
535 Allows the specification of search engines and their query
536 strings. The name is the name to match against the referrer
537 string for a given search engine. The variable is the cgi
538 variable that the search engine uses for queries. See the sam‐
539 ple.conf file for example usage with common search engines.
540 SearchCaseI ( yes | no )
542 Determines if search strings should be treated case insensitive
543 or not. The default is 'yes', which lowercases all search
544 strings (treat as case insensitive).
545 Incremental ( yes | no )
547 Enable Incremental mode processing.
548 IncrementalName name
550 Filename to use for incremental data. Relative to output
551 directory unless an absolute name is given (ie: starts with
552 '/'). Defaults to ´webalizer.current' in the standard output
553 directory.
554 DNSCache name
556 Filename to use for the DNS cache. Relative to output direc‐
557 tory unless an absolute name is given (ie: starts with '/').
558 DNSChildren num
560 Number of children DNS processes to run in order to cre‐
561 ate/update the DNS cache file. Specify zero (0) to disable.
562 CacheIPs ( yes | no )
564 Cache unresolved IP addresses in the DNS database. Default is
565 'no'.
566 CacheTTL num
568 DNS cache entry time to live (TTL) in days. Default is 7 days.
569 May be any value between 1 and 100.
570 GeoDB ( yes | no )
572 Allows native GeoDB geolocation services to be enabled or dis‐
573 abled. Default value is 'no'.
574 GeoDBDatabase name
576 Allows the use of an alternate GeoDB database name. If not
577 specified, the default database will be used.
578 GeoIP ( yes | no )
580 Allows GeoIP (by MaxMind Inc.) geolocation services to be
581 enabled or disabled. Default is 'no'. If native GeoDB geolo‐
582 cation services are also enabled, then this option will have no
583 effect (and the native GeoDB services will be used).
584 GeoIPDatabase name
586 Allows the use of an alternate GeoIP database name. If not
587 specified, the default database will be used.
588 Top Table Keywords
590 TopAgents num
592 Display the top num User Agents table. Use zero to disable.
593 AllAgents ( yes | no )
595 Create separate HTML page with All User Agents.
596 TopReferrers num
598 Display the top num Referrers table. Use zero to disable.
599 AllReferrers ( yes | no )
601 Create separate HTML page with All Referrers.
602 TopSites num
604 Display the top num Sites table. Use zero to disable.
605 TopKSites num
607 Display the top num Sites (by KByte) table. Use zero to dis‐
608 able.
609 AllSites ( yes | no )
611 Create separate HTML page with All Sites.
612 TopURLs num
614 Display the top num URLs table. Use zero to disable.
615 TopKURLs num
617 Display the top num URLs (by KByte) table. Use zero to dis‐
618 able.
619 AllURLs ( yes | no )
621 Create separate HTML page with All URLs.
622 TopCountries num
624 Display the top num Countries in the table. Use zero to dis‐
625 able.
626 TopEntry num
628 Display the top num Entry Pages in the table. Use zero to dis‐
629 able.
630 TopExit num
632 Display the top num Exit Pages in the table. Use zero to dis‐
633 able.
634 TopSearch num
636 Display the top num Search Strings in the table. Use zero to
637 disable.
638 AllSearchStr ( yes | no )
640 Create separate HTML page with All Search Strings.
641 TopUsers num
643 Display the top num Usernames in the table. Use zero to dis‐
644 able. Usernames are only available if using http based authen‐
645 tication.
646 AllUsers ( yes | no )
648 Create separate HTML page with All Usernames.
649 Hide/Ignore/Group/Include Keywords
651 HideAgent name
653 Hide User Agents that match name.
654 HideReferrer name
656 Hide Referrers that match name.
657 HideSite name
659 Hide Sites that match name.
660 HideAllSites ( yes | no )
662 Hide all individual sites. This causes only grouped sites to
663 be displayed.
664 HideURL name
666 Hide URLs that match name.
667 HideUser name
669 Hide Usernames that match name.
670 IgnoreAgent name
672 Ignore User Agents that match name.
673 IgnoreReferrer name
675 Ignore Referrers that match name.
676 IgnoreSite name
678 Ignore Sites that match name.
679 IgnoreURL name
681 Ignore URLs that match name.
682 IgnoreUser name
684 Ignore Usernames that match name.
685 GroupAgent name [Label]
687 Group User Agents that match name. Display Label in 'Top
688 Agent' table if given (instead of name). name may be enclosed
689 in quotes.
690 GroupReferrer name [Label]
692 Group Referrers that match name. Display Label in 'Top Refer‐
693 rer' table if given (instead of name). name may be enclosed in
694 quotes.
695 GroupSite name [Label]
697 Group Sites that match name. Display Label in 'Top Site' table
698 if given (instead of name). name may be enclosed in quotes.
699 GroupDomains num
701 Automatically group sites by domain. The value num specifies
702 the level of grouping, and can be thought of as the 'number of
703 dots' to be displayed. The default value of 0 disables domain
704 grouping.
705 GroupURL name [Label]
707 Group URLs that match name. Display Label in 'Top URL' table
708 if given (instead of name). name may be enclosed in quotes.
709 GroupUser name [Label]
711 Group Usernames that match name. Display Label in 'Top User‐
712 names' table if given (instead of name). name may be enclosed
713 in quotes.
714 IncludeSite name
716 Force inclusion of sites that match name. Takes precedence
717 over Ignore* keywords.
718 IncludeURL name
720 Force inclusion of URLs that match name. Takes precedence over
721 Ignore* keywords.
722 IncludeReferrer name
724 Force inclusion of Referrers that match name. Takes precedence
725 over Ignore* keywords.
726 IncludeAgent name
728 Force inclusion of User Agents that match name. Takes prece‐
729 dence over Ignore* keywords.
730 IncludeUser name
732 Force inclusion of Usernames that match name. Takes precedence
733 over Ignore* keywords.
734 HTML Generation Keywords
736 HTMLExtension text
738 Defines the HTML file extension to use. Default is html. Do
739 not include the leading period!
740 HTMLPre text
742 Insert text at the very beginning of the generated HTML file.
743 Defaults to a standard html 3.2 DOCTYPE record.
744 HTMLHead text
746 Insert text within the <HEAD></HEAD> block of the HTML file.
747 HTMLBody text
749 Insert text in HTML page, starting with the <BODY> tag. If
750 used, the first line must be a <BODY ...> tag. Multiple lines
751 may be specified.
752 HTMLPost text
754 Insert text at top (before horiz. rule) of HTML pages. Multi‐
755 ple lines may be specified.
756 HTMLTail text
758 Insert text at bottom of the HTML page. The text is top and
759 right aligned within a table column at the end of the report.
760 HTMLEnd text
762 Insert text at the very end of the HTML page. If not speci‐
763 fied, the default is to insert the ending </BODY> and </HTML>
764 tags. If used, you must supply these tags yourself.
765 LinkReferrer ( yes | no )
767 Determines if the referrers listed in the top referrers table
768 should be displayed as plain text, or as a link to the referrer
769 URL.
770 ColorHit ( rrggbb | 00805c )
772 Sets the graph's hit-color to the specified html color (no
773 '#').
774 ColorFile ( rrggbb | 0040ff )
776 Sets the graph's file-color to the specified html color (no
777 '#').
778 ColorSite ( rrggbb | ff8000 )
780 Sets the graph's site-color to the specified html color (no
781 '#').
782 ColorKbyte ( rrggbb | ff0000 )
784 Sets the graph's kilobyte-color to the specified html color (no
785 '#').
786 ColorPage ( rrggbb | 00e0ff )
788 Sets the graph's page-color to the specified html color (no
789 '#').
790 ColorVisit ( rrggbb | ffff00 )
792 Sets the graph's visit-color to the specified html color (no
793 '#').
794 ColorMisc ( rrggbb | 00e0ff )
796 Sets the 'miscellaneous' color for table headers (not graphs)
797 to the specified html color (no '#').
798 PieColor1 ( rrggbb | 800080 )
800 Sets the pie's first optional color to the specified html color
801 (no '#').
802 PieColor2 ( rrggbb | 80ffc0 )
804 Sets the pie's second optional color to the specified html
805 color (no '#').
806 PieColor3 ( rrggbb | ff00ff )
808 Sets the pie's third optional color to the specified html color
809 (no '#').
810 PieColor4 ( rrggbb | ffc480 )
812 Sets the pie's fourth optional color to the specified html
813 color (no '#').
814 Dump Object Keywords
816 The Webalizer allows you to export processed data to other programs by
818 using tab delimited text files. The Dump* commands specify which files
819 are to be written, and where.
820 DumpPath name
822 Save dump files in directory name. If not specified, the
823 default output directory will be used. Do not specify a trail‐
824 ing slash ('/').
825 DumpExtension name
827 Use name as the filename extension for dump files. If not
828 given, the default of tab will be used.
829 DumpHeader ( yes | no )
831 Print a column header as the first record of the file.
832 DumpSites ( yes | no )
834 Dump the sites data to a tab delimited file.
835 DumpURLs ( yes | no )
837 Dump the url data to a tab delimited file.
838 DumpReferrers ( yes | no )
840 Dump the referrer data to a tab delimited file. This data is
841 only available if using a log that contains referrer informa‐
842 tion (ie: a combined format web log).
843 DumpAgents ( yes | no )
845 Dump the user agent data to a tab delimited file. This data is
846 only available if using a log that contains user agent informa‐
847 tion (ie: a combined format web log).
848 DumpUsers ( yes | no )
850 Dump the username data to a tab delimited file. This data is
851 only available if processing a wu-ftpd xferlog or a web log
852 that contains http authentication information.
853 DumpSearchStr ( yes | no )
855 Dump the search string data to a tab delimited file. This data
856 is only available if processing a web log that contains refer‐
857 rer information and had search string information present.
858
860 webalizer.conf Default configuration file. Is searched for in the
861 current directory and if not found, in the /etc/
862 directory.
863 webalizer.hist Monthly history file for previous months. (can be
865 changed)
866 webalizer.current Current state data file (Incremental processing).
868 (can be changed)
869 xxxxx_YYYYMM.html Various monthly HTML output files produced. (exten‐
871 sion can be changed)
872 xxxxx_YYYYMM.png Various monthly image files used in the reports.
874 xxxxx_YYYYMM.tab Monthly tab delimited text files. (extension can
876 be changed)
877
879 Please report bugs to the author.
880
882 Copyright (C) 1997-2013 by Bradford L. Barrett. Distributed under the
883 GNU GPL. See the files "COPYING" and "Copyright", supplied with all
884 distributions for additional information.
885
887 Bradford L. Barrett <brad at mrunix dot net>
888Version 2.23 26-Feb-2013 webalizer(1)