~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): Reinhard Tartler
  • Date: 2005-07-20 19:48:50 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20050720194850-oo61wjr33rrx2mre
Tags: upstream-2.0.2
ImportĀ upstreamĀ versionĀ 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
.SH NAME
3
3
upslog \- UPS status logger
4
4
.SH SYNOPSIS
5
 
.B upslog -h
 
5
.B upslog \-h
6
6
 
7
7
.B upslog [OPTIONS]
8
8
 
17
17
 
18
18
.SH OPTIONS
19
19
 
20
 
.IP -h
 
20
.IP \-h
21
21
Display the help message.
22
22
 
23
 
.IP "-f \fIformat\fR"
 
23
.IP "\-f \fIformat\fR"
24
24
Monitor the UPS using this format string.  Be sure to enclose
25
25
\fIformat\fR in quotes so your shell doesn't split it up. Valid escapes
26
26
within this string are:
27
27
 
28
 
%% - insert a single %
29
 
 
30
 
%TIME format% - insert the time with strftime formatting
31
 
 
32
 
%ETIME% - insert the number of seconds, ala time_t.  This is now a 
 
28
%% \(hy insert a single %
 
29
 
 
30
%TIME format% \(hy insert the time with strftime formatting
 
31
 
 
32
%ETIME% \(hy insert the number of seconds, ala time_t.  This is now a 
33
33
10 digit number.
34
34
 
35
 
%HOST% - insert the local hostname
36
 
 
37
 
%UPSHOST% - insert the host of the UPS being monitored
38
 
 
39
 
%PID% - insert the pid of upslog
40
 
 
41
 
%VAR varname% - insert the value of variable varname
 
35
%HOST% \(hy insert the local hostname
 
36
 
 
37
%UPSHOST% \(hy insert the host of the UPS being monitored
 
38
 
 
39
%PID% \(hy insert the pid of upslog
 
40
 
 
41
%VAR varname% \(hy insert the value of variable varname
42
42
 
43
43
The default format string is:
44
44
 
46
46
%VAR ups.load% [%VAR ups.status%] %VAR ups.temperature% 
47
47
%VAR input.frequency%
48
48
 
49
 
.IP "-i \fIinterval\fR"
 
49
.IP "\-i \fIinterval\fR"
50
50
 
51
51
Wait this many seconds between polls.  This defaults to 30 seconds.
52
52
 
54
54
If you require tighter timing, you should write your own logger using
55
55
the upsclient library.
56
56
 
57
 
.IP "-l \fIlogfile\fR"
 
57
.IP "\-l \fIlogfile\fR"
58
58
 
59
59
Store the results in this file.
60
60
 
61
 
You can use - for stdout, but upslog will remain in the foreground.
 
61
You can use \(hy for stdout, but upslog will remain in the foreground.
62
62
 
63
 
.IP "-s \fIups\fR"
 
63
.IP "\-s \fIups\fR"
64
64
Monitor this UPS.  The format for this option is  
65
65
upsname@hostname[:port].  
66
66
 
67
 
.IP "-u \fIusername\fR"
 
67
.IP "\-u \fIusername\fR"
68
68
 
69
69
If started as root, upsmon will \fBsetuid\fR(2) to the user id
70
70
associated with \fIusername\fR for security.