Imported Upstream version 2.6.0
This commit is contained in:
arnaud.quette@free.fr
parent
26fb71b504
commit
459aaf9392
510 changed files with 40508 additions and 18859 deletions
153
docs/man/upslog.8
Normal file
153
docs/man/upslog.8
Normal file
|
|
@ -0,0 +1,153 @@
|
|||
'\" t
|
||||
.\" Title: upslog
|
||||
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
||||
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
||||
.\" Date: 12/24/2010
|
||||
.\" Manual: NUT Manual
|
||||
.\" Source: Network UPS Tools
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "UPSLOG" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * Define some portability stuff
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.\" http://bugs.debian.org/507673
|
||||
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||||
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.ie \n(.g .ds Aq \(aq
|
||||
.el .ds Aq '
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * set default formatting
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" disable hyphenation
|
||||
.nh
|
||||
.\" disable justification (adjust text to left margin only)
|
||||
.ad l
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * MAIN CONTENT STARTS HERE *
|
||||
.\" -----------------------------------------------------------------
|
||||
.SH "NAME"
|
||||
upslog \- UPS status logger
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBupslog \-h\fR
|
||||
.sp
|
||||
\fBupslog\fR [\fIOPTIONS\fR]
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
\fBupslog\fR 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\&.
|
||||
.sp
|
||||
The default format string includes variables that are supported by many common UPS models\&. See the description below to make your own\&.
|
||||
.SH "OPTIONS"
|
||||
.PP
|
||||
\fB\-h\fR
|
||||
.RS 4
|
||||
Display the help message\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-f\fR \fIformat\fR
|
||||
.RS 4
|
||||
Monitor the UPS using this format string\&. Be sure to enclose
|
||||
\fIformat\fR
|
||||
in quotes so your shell doesn\(cqt split it up\&. Valid escapes within this string are:
|
||||
.PP
|
||||
%%
|
||||
.RS 4
|
||||
Insert a single "%"
|
||||
.RE
|
||||
.PP
|
||||
%TIME format%
|
||||
.RS 4
|
||||
Insert the time with strftime formatting
|
||||
.RE
|
||||
.PP
|
||||
%ETIME%
|
||||
.RS 4
|
||||
Insert the number of seconds, ala time_t\&. This is now a 10 digit number\&.
|
||||
.RE
|
||||
.PP
|
||||
%HOST%
|
||||
.RS 4
|
||||
insert the local hostname
|
||||
.RE
|
||||
.PP
|
||||
%UPSHOST%
|
||||
.RS 4
|
||||
insert the host of the UPS being monitored
|
||||
.RE
|
||||
.PP
|
||||
%PID%
|
||||
.RS 4
|
||||
insert the pid of upslog
|
||||
.RE
|
||||
.PP
|
||||
%VAR varname%
|
||||
.RS 4
|
||||
insert the value of variable varname
|
||||
.RE
|
||||
.RE
|
||||
.sp
|
||||
The default format string is:
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
%TIME @Y@m@d @H@M@S% %VAR battery\&.charge% %VAR input\&.voltage%
|
||||
%VAR ups\&.load% [%VAR ups\&.status%] %VAR ups\&.temperature%
|
||||
%VAR input\&.frequency%
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.PP
|
||||
\fB\-i\fR \fIinterval\fR
|
||||
.RS 4
|
||||
Wait this many seconds between polls\&. This defaults to 30 seconds\&.
|
||||
.sp
|
||||
If you require tighter timing, you should write your own logger using the
|
||||
\fBupsclient\fR(3)
|
||||
library\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-l\fR \fIlogfile\fR
|
||||
.RS 4
|
||||
Store the results in this file\&.
|
||||
.sp
|
||||
You can use "\-" for stdout, but upslog will remain in the foreground\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-s\fR \fIups\fR
|
||||
.RS 4
|
||||
Monitor this UPS\&. The format for this option is
|
||||
upsname[@hostname[:port]]\&. The default hostname is "localhost"\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-u\fR \fIusername\fR
|
||||
.RS 4
|
||||
If started as root, upsmon will
|
||||
\fBsetuid\fR(2) to the user id associated with
|
||||
\fIusername\fR
|
||||
for security\&.
|
||||
.sp
|
||||
If
|
||||
\fIusername\fR
|
||||
is not defined, it will use the value that was compiled into the program\&. This defaults to "nobody", which is less than ideal\&.
|
||||
.RE
|
||||
.SH "SERVICE DELAYS"
|
||||
.sp
|
||||
The interval value is merely the number given to \fBsleep\fR(3) 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"
|
||||
.sp
|
||||
\fBupslog\fR 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:"
|
||||
.sp
|
||||
\fBupsd\fR(8)
|
||||
.SS "Clients:"
|
||||
.sp
|
||||
\fBupsc\fR(8), \fBupscmd\fR(8), \fBupsrw\fR(8), \fBupsmon\fR(8)
|
||||
.SS "Internet resources:"
|
||||
.sp
|
||||
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/
|
||||
Loading…
Add table
Add a link
Reference in a new issue