← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nut/saucy

« back to all changes in this revision

Viewing changes to man/upslog.8

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Quette
  • Date: 2004-05-28 13:10:01 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040528131001-yj2m9qcez4ya2w14
Tags: upstream-1.4.2
Import upstream version 1.4.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/upslog.8
1
 
.TH UPSLOG 8 "Sat Mar 16 2002" "" "Network UPS Tools (NUT)" 
 
1
.TH UPSLOG 8 "Sat May 10 2003" "" "Network UPS Tools (NUT)" 
2
2
.SH NAME
3
3
upslog \- UPS status logger
4
4
.SH SYNOPSIS
5
5
.B upslog -h
6
6
 
7
 
.B upslog \fIups\fB \fIlogfile\fB \fIinterval\fB [\fIformat\fB]
 
7
.B upslog [OPTIONS]
8
8
 
9
9
.SH DESCRIPTION
10
10
 
20
20
.IP -h
21
21
Display the help message.
22
22
 
23
 
.IP \fIups\fR
24
 
Monitor this UPS.  The format for this option is 
25
 
[upsname@]hostname[:port].  
26
 
 
27
 
.IP \fIlogfile\fR
28
 
Store the results in this file.
29
 
 
30
 
You can use - for stdout, but upslog will remain in the foreground.
31
 
 
32
 
.IP \fIinterval\fR
33
 
Wait this many seconds between polls.
34
 
 
35
 
Remember that a poll is not instantaneous, so it will slip back as the
36
 
program runs.  If you require tighter timing, you should write your
37
 
own logger using the upsfetch library.
38
 
 
39
 
.IP \fIformat\fR
40
 
The string to log, including variables from the UPS.  Valid escapes
 
23
.IP "-f \fIformat\fR"
 
24
Monitor the UPS using this format string.  Be sure to enclose
 
25
\fIformat\fR in quotes so your shell doesn't split it up. Valid escapes
41
26
within this string are:
42
27
 
43
28
%% - insert a single %
57
42
 
58
43
The default format string is:
59
44
 
60
 
%TIME @Y@m@d @H@M@S% %VAR battpct% %VAR utility% %VAR loadpct% [%VAR
61
 
status%] %VAR upstemp% %VAR acfreq%
 
45
%TIME @Y@m@d @H@M@S% %VAR battery.charge% %VAR input.voltage% 
 
46
%VAR ups.load% [%VAR ups.status%] %VAR ups.temperature% 
 
47
%VAR input.frequency%
 
48
 
 
49
.IP "-i \fIinterval\fR"
 
50
 
 
51
Wait this many seconds between polls.  This defaults to 30 seconds.
 
52
 
 
53
Polls are not instantaneous, so they will slip back as the program runs.
 
54
If you require tighter timing, you should write your own logger using
 
55
the upsclient library.
 
56
 
 
57
.IP "-l \fIlogfile\fR"
 
58
 
 
59
Store the results in this file.
 
60
 
 
61
You can use - for stdout, but upslog will remain in the foreground.
 
62
 
 
63
.IP "-s \fIups\fR"
 
64
Monitor this UPS.  The format for this option is  
 
65
upsname@hostname[:port].  
 
66
 
 
67
.IP "-u \fIusername\fR"
 
68
 
 
69
If started as root, upsmon will \fBsetuid\fR(2) to the user id
 
70
associated with \fIusername\fR for security.  
 
71
 
 
72
If it is not defined, it will use the value that was compiled into the
 
73
program.  This defaults to 'nobody', which is less than ideal.
 
74
 
 
75
.SH SERVICE DELAYS
 
76
 
 
77
The interval value is merely the number given to sleep() after running
 
78
through the format string.  Therefore, a query will actually take slightly
 
79
longer than the interval depending on the speed of your system.
62
80
 
63
81
.SH LOG ROTATION
64
82
 
72
90
\fBupsd\fR(8)
73
91
 
74
92
.SS Clients:
75
 
\fBupsc\fR(8), \fBupscmd\fR(8), \fBupsct\fR(8),  
76
 
\fBupsct2\fR(8), \fBupsmon\fR(8)
 
93
\fBupsc\fR(8), \fBupscmd\fR(8),
 
94
\fBupsrw\fR(8), \fBupsmon\fR(8)
77
95
 
78
96
.SS Internet resources:
79
 
The NUT (Network UPS Tools) home page: http://www.exploits.org/nut/
80
 
 
81
 
NUT mailing list archives and information: http://lists.exploits.org/
 
97
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/