View Source: nutupsdrv(8) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages
NUTUPSDRV
!!!NUTUPSDRV
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
DIAGNOSTICS
INSTALLATION
FILES
BUGS
SEE ALSO
----
!!NAME


nutupsdrv - generic manual for unified NUT model drivers
!!SYNOPSIS


__nutupsdrv -h
nutupsdrv [[-a__ ''id''__] [[-d__ ''num''__]
[[-x__ ''var''=''val''__] -k__
''device''__
nutupsdrv [[-a__ ''id''__] [[-x__
''var''=''val''__]__ device
!!DESCRIPTION


__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.


-a ''id''


autoconfigure this driver using the ''id'' section of
ups.conf(5).


-d ''num''


wait additional ''num'' after receiving the shutdown
commandseconds in shutdown mode before turning off power to
the load. Also configurable via
''ups.conf__(5).


-k


(


-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
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.
!!FILES


ups.conf(5)


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.


__Server:__


upsd(8)


__Clients:__


upsc(8), upscmd(8), upsct(8),
upsct2(8), upslog(8),
upsmon(8)


__CGI programs:__


upsset.cgi, multimon.cgi, upsstats.cgi,
upsimage.cgi


__Drivers using this common core are:__


apcsmart(8), belkin(8), bestferrups801-807,
bestups(8), cyberpower, everups, fentonups(8),
hidups, masterguard, mge-ellipse, newapc,
newvictron(8), newpowercom, sec,
tripplite.


__Internet resources:__


The NUT (Network UPS Tools) home page:
http://www.exploits.org/nut/


NUT mailing list archives and information:
http://lists.exploits.org/
----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
Last edited on Tuesday, June 4, 2002 12:31:16 am by "perry"
Edit PageHistory Diff Info LikePages