nutupsdrv
is not actually a driver. This is a combined man page for the shared code
that is the core of many drivers within the Network UPS Tools package.
For information on the specific drivers, see their individual man pages.
In general, all UPS model drivers provide a communication channel between
the UPS attached on
device
and the upsd daemon. The driver's task is to pass to the upsd process
information about the UPS state and parameters.
The core has two modes of operation which are determined by the
command line switches. In the normal mode, the driver will periodically
poll the UPS for its state and parameters. The results of this command
is presented to upsd. The driver will also handle setting variables and
instant commands if available.
The driver can also instruct the UPS to shut down the load, possibly
after some delay. This mode of operation is intended for cases when it is
known that the UPS is running out of battery power and the systems
attached must be turned off to ensure a proper reboot when power returns.
OPTIONS
-h
display an help message without doing anything else. This will also list
possible values for -x in that driver, and other help text that the
driver's author may have provided.
after receiving the shutdown commandseconds in shutdown mode before
turning off power to the load. Also configurable via "sddelay" in
ups.conf(5).
-k
("kill" power) Force shutdown mode. The UPS will power off the
attached load if possible.
-x var=val
define a variable called var with the value of var in the
driver. This varies from driver to driver - see the specific man pages
for more information.
device
The /dev entry corresponding to the TTY the UPS is connected to. This
is optional if you are using the -a autoconfiguration option,
since the "port" entry in the ups.conf(5) will be used when available.
DIAGNOSTICS
Information about the startup process is printed to stdout. Additional
messages after that point are available in the syslog. The ups clients
such as upsc(8) can be used to query the status of a UPS.
INSTALLATION
In normal operation, the drivers will be started from the system init
scripts. Once you have established that the driver(s) are configured
properly, it is recommended that you use ups.conf(5) and
upsdrvctl(8) to start the drivers.
Optional configuration file. This file is not currently required, but
eventually you will need to use this instead of upsd.conf. This file
keeps all of your driver configuration information in one place.
BUGS
Some of the individual drivers may have bugs. See their documentation
for more information.
SEE ALSO
Warning: this section is not yet complete, and may refer to a
number of man pages that have not been written yet.
