.TH UPSLOG 8 "Wed Oct 16 2002" "" "Network UPS Tools (NUT)" 
.SH NAME
upslog \- UPS status logger
.SH SYNOPSIS
.B upslog -h

.B upslog \fIups\fB \fIlogfile\fB \fIinterval\fB [\fIformat\fB]

.SH DESCRIPTION

.B upslog
is a daemon that will poll a UPS at periodic intervals, fetch the
variables that interest you, format them, and write them to a file.

The default format string includes variables that are supported by many
common UPS models.  See the description below to make your own.

.SH OPTIONS

.IP -h
Display the help message.

.IP \fIups\fR
Monitor this UPS.  The format for this option is 
[upsname@]hostname[:port].  

.IP \fIlogfile\fR
Store the results in this file.

You can use - for stdout, but upslog will remain in the foreground.

.IP \fIinterval\fR
Wait this many seconds between polls.

Remember that a poll is not instantaneous, so it will slip back as the
program runs.  If you require tighter timing, you should write your
own logger using the upsclient library.

.IP \fIformat\fR
The string to log, including variables from the UPS.  Valid escapes
within this string are:

%% - insert a single %

%TIME format% - insert the time with strftime formatting

%ETIME% - insert the number of seconds, ala time_t.  This is now a 
10 digit number.

%HOST% - insert the local hostname

%UPSHOST% - insert the host of the UPS being monitored

%PID% - insert the pid of upslog

%VAR varname% - insert the value of variable varname

The default format string is:

%TIME @Y@m@d @H@M@S% %VAR battpct% %VAR utility% %VAR loadpct% [%VAR
status%] %VAR upstemp% %VAR acfreq%

.SH SERVICE DELAYS

The interval value is merely the number given to sleep() after running
through the format string.  Therefore, a query will actually take slightly
longer than the interval depending on the speed of your system.

.SH LOG ROTATION

upslog writes its pid to upslog.pid, and will reopen the log file if you
send it a SIGHUP.  This allows it to keep running when the log is rotated
by an external program.

.SH SEE ALSO

.SS Server:
\fBupsd\fR(8)

.SS Clients:
\fBupsc\fR(8), \fBupscmd\fR(8),
\fBupsrw\fR(8), \fBupsmon\fR(8)

.SS Internet resources:
The NUT (Network UPS Tools) home page: http://www.exploits.org/nut/

NUT mailing list archives and information: http://lists.exploits.org/