Wusage 8.0 Manual
Command Line Options
The wusage program supports the following command
line options:
-bps XXXXX
- The -b option should be followed by the rated speed of your
Internet connection, in bits per second. For instance, for a 56K modem,
this value is 56000. Specify the incoming or outgoing speed, whichever
is LEAST. This option ensures that Wusage can take best advantage of
its new fast DNS query capabilities.
-c config_file_name
- The -c option should be followed by the name of the
configuration file (typically wusage.conf or wusage.con under Windows).
If you prefer not to use the user interface, this option is required.
-compressed
- The -compressed option forces Wusage to produce
compressed reports. See the Optimization
section of the manual for more information.
-d
- The -d option MUST be preceded by the -c option and a configuration
file name. When the -d option is present, Wusage removes all existing
reports and work-in-progress information, except for the DNS cache.
This option must follow, not precede, the -c option
and its configuration filename argument.
-n
- The -n option prevents Wusage 6.0 and later from
attempting to resume log file analysis where it "left off"
on the previous run. Instead the program assumes it must
begin at the beginning of the appropriate day, week, or month.
This matches the behavior of Wusage 5.0 and earlier. The use
of this feature is not recommended.
-ac
- The -ac option is used to specify that wusage
should analyze a stand-alone Apache cookie log.
These logs are produced by the Apache web server, versions
prior to 1.2, if and only if the server was compiled with the "mod_cookies"
module. See also the
CookieLog directive in the
Apache server documentation. This option produces
useful reports of user activity as determined by cookies. You
should use a SEPARATE report directory to avoid conflict
with your regular statistics! For better reports, use
Apache 1.2 or better and the Server Configuration Tips
section to log cookies as
part of the regular access log.
This is greatly superior because the users
report is generated side by side with the regular reports.
-u (always used with -l )
- The -u option is used to specify that Wusage should
analyze a stand-alone user agent log.
This option is always used in conjunction with the
-l filename option, which indicates where
the user agent log file is located. This option produces
a report in a subdirectory called agents in the
report directory. This special filename is used to avoid
overwriting the normal output of wusage. It is better
to configure your web server to
log this information in the regular server log so it
can be analyzed as part of your normal reports.
-r (always used with -l )
- The -r option is used to specify that wusage should
analyze a stand-alone referrer log.
This option is always used in conjunction with the
-l filename option, which indicates where
the referrer log file is located. This option produces
a report in a subdirectory called referrers (note
the spelling) in the report directory. This special filename is used
to avoid overwriting the normal output of wusage. It is better
to configure your web server to log this information in the regular
server log so it can be analyzed as part of your normal reports.
See the Server Configuration Tips
section for more information.
-b MM/DD or MM/DD/YY or MM/DD/YYYY
- The -b option is used to specify the date from
which Wusage should begin producing reports. If the
-b option is not specified, Wusage picks up exactly
where it left off the last time it was run without
-b. If the -b option is specified,
wusage will produce reports from that date
forward to the present day, or another ending date
specified by the -e option. In Wusage 7.0 and above,
only those reporting time periods which are completely within
the time range specified by -b and -e will be updated. The
cumulative summary report cannot be updated in this manner.
Three date formats are supported:
MM/DD (example: 9/29), MM/DD/YY (example: 9/29/1980),
and MM/DD/YYYY (example: 9/29/1980). This option
is useful if you have accidentally run wusage on
a partial log file and wish to run it again to
re-generate the reports for the missing days using
data in another log file.
-e MM/DD or MM/DD/YY or MM/DD/YYYY
- The -e option is used to specify the date on
which wusage should stop producing reports. If
the -e option is specified, wusage will produce
reports up to and including that date.
Otherwise, wusage will produce reports through the
most recent complete day or week. In Wusage 7.0 and above,
only those reporting time periods which are completely within
the time range specified by -b and -e will be updated. The
cumulative summary report cannot be updated in this manner.
Three date formats are
supported: MM/DD (example: 9/29), MM/DD/YY (example: 9/29/1980),
and MM/DD/YYYY (example: 9/29/1980). This option
is useful if you wish to run wusage on only a
certain time period found in a large log file,
especially if you are generating a summary report.
-s
- The -s option specifies that wusage should
only update the cumulative summary report. The use
of this option is not recommended
in Wusage 7.0 and above. This option overrides the
Daily Reports (daily), Weekly Reports (weekly), Monthly Reports (monthly),
Quarterly Reports (quarterly), Annual Reports (annual), Summary Reports (summary),
and frequency (frequency) options.
-v
- The -v option displays the version number
of wusage. Please send the output of this option,
along with a description of your operating system
and web server software, when writing to Boutell.Com, Inc.
-p portnumber
- The -p option causes the web interface of Wusage to listen on an
alternate port instead of the standard Wusage port number, which is 2396.
-ps proxyserverhost
- The -ps option is used to specify a proxy server host name to
be used for HTTP and FTP log file fetches. See also -pp.
-pp proxyserverport
- The -pp option is used to specify a proxy server port number to
be used for HTTP and FTP log file fetches. See also -ps.
-l log_file_or_directory or -
- The -l option is used to override the
(logfiles) option, specifying a single
log file to be analyzed.
If the special log file name - (a single dash) is given,
Wusage will expect to read its input from
standard input. This is particularly useful
when working with pipelines
of several commands such as the Unix cat and
zcat commands. See the Analyzing Many Log Files
section
for more information.
-memory
- The
-memory option forces Wusage to optimize
for lowest memory use, at the potential expense of longer
total analysis time.
-speed
- The
-speed option forces Wusage to optimize
for fastest analysis, at the potential expense of higher
memory use.
-t minutes
- The
-t option is used to specify an idle timeout for
the Wusage web-based user interface. Under Unix, Wusage will "time out"
and shut down after 20 minutes, if it has not been used during that time.
However, the Macintosh and Windows 95/98/NT versions
do not time out by default, unless the
program is running in a CGI environment. This change
was made to accommodate the built-in scheduling feature.
See the Running Wusage Automatically
section for more information.
-t should be followed by the number of idle minutes
after which the web interface should automatically shut down.
To shut off the idle timeout under Unix, use
the value 0 .
-remote
- The
-remote option is present for backwards
compatibility only. Recent releases of Wusage for Windows
95/98/2000/NT provide two binaries: wusageg.exe
and wusage.exe . wusageg.exe is the
version with a built-in graphical user interface; wusage.exe
behaves exactly like the Unix version. In earlier releases
the -remote option was used to turn off the
graphical interface, as in the Unix version. This is no
longer necessary and wusage.exe should be used
instead when such behavior is desired.
-uncompressed
- The -uncompressed option forces Wusage NOT to
produce compressed reports. See the
Optimization section of the manual
for more information.
-update-all-accounts
- The
-update-all-accounts option
causes a complete update of all Wusage accounts, including
log rotation and archiving if they have been turned on,
regardless of the schedule settings.
This option is useful for testing purposes.
See Configuring the Program in ISP Mode for
more information.
-wusage-scheduled-update
- The
-wusage-scheduled-update option
causes a complete update of all Wusage accounts, including
log rotation and archiving if they have been turned on,
if it is time to do so according to the current
built-in scheduler settings. Beginning in Wusage 7.0,
the Unix versions of Wusage automatically request that
the Unix cron service run the program at the
top of the hour with this option. An actual update takes place
only at the top of the appropriate hour on appropriate days,
as indicated through the Schedule Updates button on the
Account Administration Page. See Configuring the Program in ISP Mode
for
more information.
-wusage-check-server
- The
-wusage-check-server option causes Wusage to
check to see whether it is currently installed on port 2396 to talk
to web-based clients. If the program is not already running, it is
launched in the background to accept such connections. This is very
similar to the behavior of the program with no command line arguments,
except that no error message is produced if the port is already in use;
the program assumes that it is already running properly in
another process. Wusage 8.0 P8 and above for Unix automatically install
a scheduled cron job which causes the program to be launched with this
option every 5 minutes (terminating instantly if it has no work to do,
of course). This removes the need for manual installation in
Unix startup scripts and provides a "watchdog" in case the program
shuts down for any reason.
-uninstall
- Unix users: the
-uninstall option removes any crontab entries
made to automatically start Wusage for scheduled updates and/or automatic
startup of the program. This option does not delete any other
files and can be safely used.
-noinstall
- Unix users: the
-noinstall option allows Wusage to be
started without the automatic installation of crontab entries for scheduled
updates and automatic restart of the program. This option can be combined
with other options. the -c option implies noinstall .
-server
- The
-server option instructed earlier versions
of Wusage to run permanently in the background and accept
connections from one or more Wusage accounts. This option is
still accepted; however, this behavior is also automatically
invoked by running the NT service or Unix version of Wusage with
no command line options, as of 8.0 P8.
Note: because wusage has so
many useful options, it is primarily
controlled by configuration
editor options rather than command line options.
Copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, Boutell.Com, Inc.
wusage@boutell.com
Boutell.Com, Inc - PO Box 16716, Seattle WA, 98116, USA
Phone/Fax +1 206 658-8176
|