Penguin
Recent Changes
Blame: nutupsdrv(8)
EditPageHistoryDiffInfoLikePages
Annotated edit history of nutupsdrv(8) version 2, including all changes. View license author blame.
Rev Author # Line
1 perry 1 NUTUPSDRV
2 !!!NUTUPSDRV
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 DIAGNOSTICS
8 INSTALLATION
9 FILES
10 BUGS
11 SEE ALSO
12 ----
13 !!NAME
14
15
16 nutupsdrv - generic manual for unified NUT model drivers
17 !!SYNOPSIS
18
19
20 __nutupsdrv -h
21 nutupsdrv [[-a__ ''id''__] [[-d__ ''num''__]
22 [[-x__ ''var''=''val''__] -k__
23 ''device''__
24 nutupsdrv [[-a__ ''id''__] [[-x__
25 ''var''=''val''__]__ device
26 !!DESCRIPTION
27
28
29 __nutupsdrv__ is not actually a driver. This is a
30 combined man page for the shared code that is the core of
31 many drivers within the Network UPS Tools
32 package.
33
34
35 For information on the specific drivers, see their
36 individual man pages.
37
38
39 In general, all UPS model drivers provide a communication
40 channel between the UPS attached on ''device'' and the
41 upsd daemon. The driver's task is to pass to the upsd
42 process information about the UPS state and
43 parameters.
44
45
46 The core has two modes of operation which are determined by
47 the command line switches. In the normal mode, the driver
48 will periodically poll the UPS for its state and parameters.
49 The results of this command is presented to upsd. The driver
50 will also handle setting variables and instant commands if
51 available.
52
53
54 The driver can also instruct the UPS to shut down the load,
55 possibly after some delay. This mode of operation is
56 intended for cases when it is known that the UPS is running
57 out of battery power and the systems attached must be turned
58 off to ensure a proper reboot when power
59 returns.
60 !!OPTIONS
61
62
63 -h
64
65
66 display an help message without doing anything else. This
67 will also list possible values for __-x__ in that driver,
68 and other help text that the driver's author may have
69 provided.
70
71
72 -a ''id''
73
74
75 autoconfigure this driver using the ''id'' section of
2 perry 76 ups.conf(5).
1 perry 77
78
79 -d ''num''
80
81
82 wait additional ''num'' after receiving the shutdown
83 commandseconds in shutdown mode before turning off power to
84 the load. Also configurable via
85 ''ups.conf__(5).
86
87
88 -k
89
90
91 (
92
93
94 -x ''var''=''val''
95
96
97 define a variable called ''var'' with the value of
98 ''var'' in the driver. This varies from driver to driver
99 - see the specific man pages for more
100 information.
101
102
103 device
104
105
106 The /dev entry corresponding to the TTY the UPS is connected
107 to. This is optional if you are using the __-a__
108 autoconfiguration option, since the
2 perry 109 ups.conf(5) will be used when
1 perry 110 available.
111 !!DIAGNOSTICS
112
113
114 Information about the startup process is printed to stdout.
115 Additional messages after that point are available in the
116 syslog. The ups clients such as upsc(8) can be used
117 to query the status of a UPS.
118 !!INSTALLATION
119
120
121 In normal operation, the drivers will be started from the
122 system init scripts. Once you have established that the
123 driver(s) are configured properly, it is recommended that
2 perry 124 you use ups.conf(5) and upsdrvctl(8) to start
1 perry 125 the drivers.
126 !!FILES
127
128
2 perry 129 ups.conf(5)
1 perry 130
131
132 Optional configuration file. This file is not currently
133 required, but eventually you will need to use this instead
134 of upsd.conf. This file keeps all of your driver
135 configuration information in one place.
136 !!BUGS
137
138
139 Some of the individual drivers may have bugs. See their
140 documentation for more information.
141 !!SEE ALSO
142
143
144 Warning: this section is not yet complete, and may refer to
145 a number of man pages that have not been written
146 yet.
147
148
149 __Server:__
150
151
152 upsd(8)
153
154
155 __Clients:__
156
157
158 upsc(8), upscmd(8), upsct(8),
2 perry 159 upsct2(8), upslog(8),
1 perry 160 upsmon(8)
161
162
163 __CGI programs:__
164
165
166 upsset.cgi, multimon.cgi, upsstats.cgi,
167 upsimage.cgi
168
169
170 __Drivers using this common core are:__
171
172
173 apcsmart(8), belkin(8), bestferrups801-807,
174 bestups(8), cyberpower, everups, fentonups(8),
175 hidups, masterguard, mge-ellipse, newapc,
176 newvictron(8), newpowercom, sec,
177 tripplite.
178
179
180 __Internet resources:__
181
182
183 The NUT (Network UPS Tools) home page:
184 http://www.exploits.org/nut/
185
186
187 NUT mailing list archives and information:
188 http://lists.exploits.org/
189 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.