nutupsdrv(8)

1NUTUPSDRV(8)                Network UPS Tools (NUT)               NUTUPSDRV(8)
2
3
4

NAME

6       nutupsdrv - generic manual for unified NUT drivers
7

SYNOPSIS

9       nutupsdrv -h
10       nutupsdrv [OPTIONS]
11
12

DESCRIPTION

14       nutupsdrv  is  not  actually a driver.  This is a combined man page for
15       the shared code that is the core of many drivers within the Network UPS
16       Tools package.
17
18       For  information  on  the  specific  drivers,  see their individual man
19       pages.
20
21       UPS drivers provide a communication channel between  the  physical  UPS
22       hardware  and the upsd(8) server.  The driver is responsible for trans‐
23       lating the native protocol of the UPS to the common format used by  the
24       rest of this package.
25
26       The core has two modes of operation which are determined by the command
27       line switches.  In the normal mode, the driver will  periodically  poll
28       the  UPS  for its state and parameters.  The results of this command is
29       presented to upsd.  The driver will also handle setting  variables  and
30       instant commands if available.
31
32       The  driver  can  also instruct the UPS to shut down the load, possibly
33       after some delay.  This mode of operation is intended for cases when it
34       is  known  that the UPS is running out of battery power and the systems
35       attached must be turned off  to  ensure  a  proper  reboot  when  power
36       returns.
37
38

NOTE

40       You  probably  don't  want  to  use any of these options directly.  You
41       should use upsdrvctl(8) to control your  drivers,  and  ups.conf(5)  to
42       configure  them.  The rest of this manual describes options and parame‐
43       ters that generally are not needed by normal users.
44
45

OPTIONS

47       -h     display an help message without doing anything else.  This  will
48              also  list possible values for -x in that driver, and other help
49              text that the driver's author may have provided.
50
51
52       -a id  autoconfigure this driver using the id section of ups.conf(5).
53
54
55       -D     Raise the debugging level.  Use this multiple times to see  more
56              details.
57
58
59       -i interval
60              Set the poll interval for the device
61
62
63       -V     print only version information, then exit
64
65
66       -L     print parseable list of driver variables. Mostly useful for con‐
67              figuration wizard and alike.
68
69
70       -k     ("kill" power) Force shutdown mode.  The UPS will power off  the
71              attached load if possible.
72
73              You  should  use upsdrvctl shutdown whenever possible instead of
74              calling this directly.
75
76
77       -r directory
78              The driver will chroot(2) to  directory  during  initialization.
79              This can be useful when securing systems.
80
81              In  addition  to  the  state  path,  many  systems  will require
82              /dev/null to exist within  directory  for  this  to  work.   The
83              serial  ports  are  opened before the chroot call, so you do not
84              need to create them inside the jail.  In fact,  it  is  somewhat
85              safer if you do not.
86
87
88       -u username
89              If  started  as  root,  the driver will setuid(2) to the user id
90              associated with username.
91
92              If you do not specify this value  and  start  it  as  root,  the
93              driver  will  switch to the default value that was compiled into
94              the code.  This is typically 'nobody', and is far from ideal.
95
96
97       -x var=val
98              define a variable called var  with  the  value  of  var  in  the
99              driver.   This  varies  from driver to driver ‐ see the specific
100              man pages for more information.
101
102              This is like setting var=val in the ups.conf(5),  but  -x  over‐
103              rides any settings from that file.
104
105       device The /dev entry corresponding to the TTY the UPS is connected to.
106              This is optional if  you  are  using  the  -a  autoconfiguration
107              option,  since  the "port" entry in the ups.conf(5) will be used
108              when available.
109
110

DIAGNOSTICS

112       Information about the startup process is printed to stdout.  Additional
113       messages after that point are available in the syslog.  The ups clients
114       such as upsc(8) can be used to query the status of a UPS.
115
116

PROGRAM CONTROL

118       You should always use upsdrvctl(8) to control the drivers.  While driv‐
119       ers  can be started by hand for testing purposes, it is not recommended
120       for production use.
121
122

FILES

124       ups.conf(5)
125              Required configuration file.  This contains all details on which
126              drivers to start and where the hardware is attached.
127
128

BUGS

130       Some of the drivers may have bugs.  See their manuals for more informa‐
131       tion.
132
133