← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/nutupsdrv.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:
man/nutupsdrv.8
1
 
.TH NUTUPSDRV 8 "Fri Nov  7 2003" "" "Network UPS Tools (NUT)" 
 
1
.TH NUTUPSDRV 8 "Mon Oct 25 2004" "" "Network UPS Tools (NUT)" 
2
2
.SH NAME  
3
3
nutupsdrv \- generic manual for unified NUT drivers
4
4
.SH SYNOPSIS
5
 
.B nutupsdrv -h
 
5
.B nutupsdrv \-h
6
6
.br
7
7
.B nutupsdrv [OPTIONS]
8
8
 
13
13
 
14
14
For information on the specific drivers, see their individual man pages.
15
15
 
16
 
In general, all UPS drivers provide a communication channel between
17
 
the UPS attached on
18
 
.I device
19
 
and the upsd daemon. The driver's task is to pass to the upsd process 
20
 
information about the UPS state and parameters.  
 
16
UPS drivers provide a communication channel between the physical UPS
 
17
hardware and the \fBupsd\fR(8) server.  The driver is responsible for
 
18
translating the native protocol of the UPS to the common format used by
 
19
the rest of this package.
21
20
 
22
21
The core has two modes of operation which are determined by the
23
22
command line switches.  In the normal mode, the driver will periodically
37
36
options and parameters that generally are not needed by normal users.
38
37
 
39
38
.SH OPTIONS
40
 
.IP -h
 
39
.IP \-h
41
40
display an help message without doing anything else.  This will also list
42
 
possible values for \fB-x\fR in that driver, and other help text that the
 
41
possible values for \fB\-x\fR in that driver, and other help text that the
43
42
driver's author may have provided.
44
 
.IP "-a \fIid"
 
43
 
 
44
.IP "\-a \fIid"
45
45
autoconfigure this driver using the \fIid\fR section of \fBups.conf\fR(5).
46
46
 
47
 
.IP "-d \fInum"
48
 
wait additional 
49
 
.IR num
50
 
seconds after receiving the shutdown command in shutdown mode before
51
 
turning off power to the load.  Also configurable via "sddelay" in
52
 
\fBups.conf\fR(5).
53
 
 
54
 
.IP -D
 
47
.IP \-D
55
48
Raise the debugging level.  Use this multiple times to see more
56
49
details.
57
50
 
58
 
.IP -k
 
51
.IP "\-i \fIinterval\fR"
 
52
Set the poll interval for the device
 
53
 
 
54
.IP \-V
 
55
print only version information, then exit
 
56
 
 
57
.IP \-L
 
58
print parseable list of driver variables. Mostly useful for configuration
 
59
wizard and alike.
 
60
 
 
61
.IP \-k
59
62
("kill" power) Force shutdown mode.  The UPS will power off the
60
63
attached load if possible.
61
64
 
62
65
You should use \fBupsdrvctl shutdown\fR whenever possible instead of
63
66
calling this directly.
64
67
 
65
 
.IP "-r \fIdirectory\fR"
 
68
.IP "\-r \fIdirectory\fR"
66
69
The driver will \fBchroot\fR(2) to \fIdirectory\fR during initialization.
67
70
This can be useful when securing systems.
68
71
 
71
74
opened before the chroot call, so you do not need to create them inside
72
75
the jail.  In fact, it is somewhat safer if you do not.
73
76
 
74
 
.IP "-u \fIusername\fR"
 
77
.IP "\-u \fIusername\fR"
75
78
If started as root, the driver will \fBsetuid\fR(2) to the user id
76
79
associated with \fIusername\fR.  
77
80
 
79
82
switch to the default value that was compiled into the code.  This is
80
83
typically 'nobody', and is far from ideal.
81
84
 
82
 
.IP "-x \fIvar\fR=\fIval\fR"
 
85
.IP "\-x \fIvar\fR=\fIval\fR"
83
86
define a variable called \fIvar\fR with the value of \fIvar\fR in the
84
 
driver.  This varies from driver to driver - see the specific man pages
 
87
driver.  This varies from driver to driver \(hy see the specific man pages
85
88
for more information.  
86
89
 
87
90
This is like setting \fIvar\fR=\fIval\fR in the \fBups.conf\fR(5), but
88
 
-x overrides any settings from that file.
 
91
\-x overrides any settings from that file.
89
92
.IP device
90
93
The /dev entry corresponding to the TTY the UPS is connected to.  This
91
 
is optional if you are using the \fB-a\fR autoconfiguration option,
 
94
is optional if you are using the \fB\-a\fR autoconfiguration option,
92
95
since the "port" entry in the \fBups.conf\fR(5) will be used when available.
93
96
 
94
97
.SH DIAGNOSTICS
122
125
.SS CGI programs:
123
126
\fBupsset.cgi\fR(8), \fBupsstats.cgi\fR(8), \fBupsimage.cgi\fR(8)
124
127
 
125
 
.SS Driver controller:
 
128
.SS Driver control:
126
129
\fBupsdrvctl\fR(8)
127
130
 
128
 
.SS Drivers: 
129
 
 
130
 
\fBapcsmart\fR(8), \fBbcmxcp\fR(8), \fBbelkin\fR(8),
131
 
\fBbestfortress\fR(8), \fBbestuferrups\fR(8), \fBbestups\fR(8),
132
 
\fBcyberpower\fR(8), \fBdummycons\fR(8), \fBenergizerups\fR(8),
133
 
\fBetapro\fR(8), \fBeverups\fR(8), \fBfentonups\fR(8), \fBferrups\fR(8),
134
 
\fBgenericups\fR(8), \fBhidups\fR(8), \fBisbmex\fR(8), \fBliebert\fR(8),
135
 
\fBmasterguard\fR(8), \fBmge-shut\fR(8), \fBmge-utalk\fR(8),
136
 
\fBmicrodowell\fR(8), \fBnewapc\fR(8), \fBoneac\fR(8),
137
 
\fBpowercom\fR(8), \fBpowernet\fR(8), \fBsafenet\fR(8), \fBsec\fR(8),
138
 
\fBsms\fR(8), \fBsnmp-ups\fR(8), \fBtripplite\fR(8),
139
 
\fBtripplitesu\fR(8), \fBvictronups\fR(8)
 
131
.SS Drivers:
 
132
\fBapcsmart\fR(8), \fBbelkin\fR(8), \fBbelkinunv\fR(8),
 
133
\fBbestuferrups\fR(8), \fBbestups\fR(8), \fBcpsups\fR(8),
 
134
\fBcyberpower\fR(8), \fBenergizerups\fR(8), \fBetapro\fR(8),
 
135
\fBeverups\fR(8), \fBfentonups\fR(8), \fBgenericups\fR(8),
 
136
\fBippon\fR(8), \fBisbmex\fR(8), \fBliebert\fR(8), \fBmasterguard\fR(8),
 
137
\fBmge\(hyshut\fR(8), \fBmge\(hyutalk\fR(8), \fBoneac\fR(8),
 
138
\fBpowercom\fR(8), \fBsafenet\fR(8), \fBsms\fR(8), \fBsnmp\(hyups\fR(8),
 
139
\fBtripplite\fR(8), \fBtripplitesu\fR(8), \fBvictronups\fR(8), 
140
140
 
141
141
.SS Internet resources:
142
142
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/