lagertonne/nut
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Wiki Activity

Imported Upstream version 2.6.0

Browse source
This commit is contained in:
arnaud.quette@free.fr 2011-01-26 10:35:08 +01:00
parent 26fb71b504
commit 459aaf9392
510 changed files with 40508 additions and 18859 deletions
Download patch file Download diff file Expand all files Collapse all files

452
docs/man/Makefile.am Normal file
View file

@ -0,0 +1,452 @@
# Network UPS Tools: man
#
# Notes:
# - sources (.txt) and groff formats are both distributed,
# - only sources are versioned ; groff files are generated at worst
# during 'make dist'
# - HTML files are built upon request, if AsciiDoc is available,
# - groff update will only happen if AsciiDoc is available too,
# - all this can probably (and hopefully) by improved, but I've not
# found a way to do pattern replacement on the fly for target deps!
# - Ref: http://www.gnu.org/software/hello/manual/automake/Man-pages.html
# Base configuration and client manpages, always installed
SRC_CONF_PAGES = \
nut.conf.txt \
ups.conf.txt \
upsd.conf.txt \
upsd.users.txt \
upsmon.conf.txt \
upssched.conf.txt
MAN_CONF_PAGES = \
nut.conf.5 \
ups.conf.5 \
upsd.conf.5 \
upsd.users.5 \
upsmon.conf.5 \
upssched.conf.5
man5_MANS = $(MAN_CONF_PAGES)
HTML_CONF_MANS = \
nut.conf.html \
ups.conf.html \
upsd.conf.html \
upsd.users.html \
upsmon.conf.html \
upssched.conf.html
SRC_CLIENT_PAGES = \
nutupsdrv.txt \
upsc.txt \
upscmd.txt \
upsd.txt \
upsdrvctl.txt \
upslog.txt \
upsmon.txt \
upsrw.txt \
upssched.txt
MAN_CLIENT_PAGES = \
nutupsdrv.8 \
upsc.8 \
upscmd.8 \
upsd.8 \
upsdrvctl.8 \
upslog.8 \
upsmon.8 \
upsrw.8 \
upssched.8
man8_MANS = $(MAN_CLIENT_PAGES)
HTML_CLIENT_MANS = \
nutupsdrv.html \
upsc.html \
upscmd.html \
upsd.html \
upsdrvctl.html \
upslog.html \
upsmon.html \
upsrw.html \
upssched.html
# CGI (--with-cgi) related manpages
SRC_CGI_PAGES = \
hosts.conf.txt \
upsset.conf.txt \
upsstats.html.txt \
upsset.cgi.txt \
upsstats.cgi.txt \
upsimage.cgi.txt
MAN5_CGI_PAGES = \
hosts.conf.5 \
upsset.conf.5 \
upsstats.html.5
MAN8_CGI_PAGES = \
upsset.cgi.8 \
upsstats.cgi.8 \
upsimage.cgi.8
if WITH_CGI
man5_MANS += $(MAN5_CGI_PAGES)
man8_MANS += $(MAN8_CGI_PAGES)
endif
HTML_CGI_MANS = \
hosts.conf.html \
upsset.conf.html \
upsstats.html.html \
upsset.cgi.html \
upsstats.cgi.html \
upsimage.cgi.html
# Development (--with-dev) related manpages
SRC_DEV_PAGES = \
upsclient.txt \
upscli_connect.txt \
upscli_disconnect.txt \
upscli_fd.txt \
upscli_get.txt \
upscli_list_next.txt \
upscli_list_start.txt \
upscli_readline.txt \
upscli_sendline.txt \
upscli_splitaddr.txt \
upscli_splitname.txt \
upscli_ssl.txt \
upscli_strerror.txt \
upscli_upserror.txt \
libupsclient-config.txt \
skel.txt
MAN3_DEV_PAGES = \
upsclient.3 \
upscli_connect.3 \
upscli_disconnect.3 \
upscli_fd.3 \
upscli_get.3 \
upscli_list_next.3 \
upscli_list_start.3 \
upscli_readline.3 \
upscli_sendline.3 \
upscli_splitaddr.3 \
upscli_splitname.3 \
upscli_ssl.3 \
upscli_strerror.3 \
upscli_upserror.3
MAN1_DEV_PAGES = \
libupsclient-config.1
if WITH_DEV
man3_MANS = $(MAN3_DEV_PAGES)
if !WITH_PKG_CONFIG
man1_MANS = $(MAN1_DEV_PAGES)
endif
# WITH_DEV
endif
HTML_DEV_MANS = \
upsclient.html \
upscli_connect.html \
upscli_disconnect.html \
upscli_fd.html \
upscli_get.html \
upscli_list_next.html \
upscli_list_start.html \
upscli_readline.html \
upscli_sendline.html \
upscli_splitaddr.html \
upscli_splitname.html \
upscli_ssl.html \
upscli_strerror.html \
upscli_upserror.html \
libupsclient-config.html \
skel.html
# Drivers related manpages
# (--with-drivers=...)
if SOME_DRIVERS
man8_MANS += $(DRIVER_MAN_LIST)
else
# (--with-serial)
SRC_SERIAL_PAGES = \
apcsmart.txt \
bcmxcp.txt \
belkin.txt \
belkinunv.txt \
bestfortress.txt \
bestuferrups.txt \
bestups.txt \
bestfcom.txt \
blazer.txt \
clone.txt \
dummy-ups.txt \
etapro.txt \
everups.txt \
gamatronic.txt \
genericups.txt \
isbmex.txt \
ivtscd.txt \
liebert.txt \
liebert-esp2.txt \
masterguard.txt \
metasys.txt \
mge-shut.txt \
mge-utalk.txt \
oneac.txt \
microdowell.txt \
optiups.txt \
powercom.txt \
powerpanel.txt \
rhino.txt \
safenet.txt \
solis.txt \
tripplite.txt \
tripplitesu.txt \
upscode2.txt \
victronups.txt
MAN_SERIAL_PAGES = \
apcsmart.8 \
bcmxcp.8 \
belkin.8 \
belkinunv.8 \
bestfortress.8 \
bestuferrups.8 \
bestups.8 \
bestfcom.8 \
blazer.8 \
clone.8 \
dummy-ups.8 \
etapro.8 \
everups.8 \
gamatronic.8 \
genericups.8 \
isbmex.8 \
ivtscd.8 \
liebert.8 \
liebert-esp2.8 \
masterguard.8 \
metasys.8 \
mge-shut.8 \
mge-utalk.8 \
oneac.8 \
microdowell.8 \
optiups.8 \
powercom.8 \
powerpanel.8 \
rhino.8 \
safenet.8 \
solis.8 \
tripplite.8 \
tripplitesu.8 \
upscode2.8 \
victronups.8
if WITH_SERIAL
man8_MANS += $(MAN_SERIAL_PAGES)
endif
HTML_SERIAL_MANS = \
apcsmart.html \
bcmxcp.html \
belkin.html \
belkinunv.html \
bestfortress.html \
bestuferrups.html \
bestups.html \
bestfcom.html \
blazer.html \
clone.html \
dummy-ups.html \
etapro.html \
everups.html \
gamatronic.html \
genericups.html \
isbmex.html \
ivtscd.html \
liebert.html \
liebert-esp2.html \
masterguard.html \
metasys.html \
mge-shut.html \
mge-utalk.html \
oneac.html \
microdowell.html \
optiups.html \
powercom.html \
powerpanel.html \
rhino.html \
safenet.html \
solis.html \
tripplite.html \
tripplitesu.html \
upscode2.html \
victronups.html
# (--with-snmp)
SRC_SNMP_PAGES = snmp-ups.txt
MAN_SNMP_PAGES = snmp-ups.8
if WITH_SNMP
man8_MANS += $(MAN_SNMP_PAGES)
endif
HTML_SNMP_MANS = snmp-ups.html
# (--with-usb)
SRC_USB_LIBUSB_PAGES = \
bcmxcp_usb.txt \
richcomm_usb.txt \
tripplite_usb.txt \
usbhid-ups.txt
MAN_USB_LIBUSB_PAGES = \
bcmxcp_usb.8 \
richcomm_usb.8 \
tripplite_usb.8 \
usbhid-ups.8
if WITH_USB
man8_MANS += $(MAN_USB_LIBUSB_PAGES)
endif
HTML_USB_LIBUSB_MANS = \
bcmxcp_usb.html \
richcomm_usb.html \
tripplite_usb.html \
usbhid-ups.html
# (--with-neon)
SRC_NETXML_PAGES = netxml-ups.txt
MAN_NETXML_PAGES = netxml-ups.8
if WITH_NEONXML
man8_MANS += $(MAN_NETXML_PAGES)
endif
HTML_NETXML_MANS = netxml-ups.html
# (--with-powerman)
SRC_POWERMAN_PAGES = powerman-pdu.txt
MAN_POWERMAN_PAGES = powerman-pdu.8
if WITH_LIBPOWERMAN
man8_MANS += $(MAN_POWERMAN_PAGES)
endif
HTML_POWERMAN_MANS = powerman-pdu.html
# SOME_DRIVERS
endif
MAN_MANS = \
$(MAN_CONF_PAGES) \
$(MAN_CLIENT_PAGES) \
$(MAN5_CGI_PAGES) \
$(MAN8_CGI_PAGES) \
$(MAN1_DEV_PAGES) \
$(MAN3_DEV_PAGES) \
$(MAN_SERIAL_PAGES) \
$(MAN_SNMP_PAGES) \
$(MAN_USB_LIBUSB_PAGES) \
$(MAN_NETXML_PAGES) \
$(MAN_POWERMAN_PAGES)
# distribute everything, even those not installed by default
# Note that 'dist' target requires AsciiDoc!
EXTRA_DIST = \
$(SRC_CONF_PAGES) \
$(SRC_CLIENT_PAGES) \
$(SRC_CGI_PAGES) \
$(SRC_DEV_PAGES) \
$(SRC_SERIAL_PAGES) \
$(SRC_SNMP_PAGES) \
$(SRC_USB_LIBUSB_PAGES) \
$(SRC_NETXML_PAGES) \
$(SRC_POWERMAN_PAGES) \
$(MAN_MANS) \
asciidoc.conf
HTML_MANS = \
$(HTML_CONF_MANS) \
$(HTML_CLIENT_MANS) \
$(HTML_CGI_MANS) \
$(HTML_DEV_MANS) \
$(HTML_SERIAL_MANS) \
$(HTML_SNMP_MANS) \
$(HTML_USB_LIBUSB_MANS) \
$(HTML_NETXML_MANS) \
$(HTML_POWERMAN_MANS)
all:
man-index.html: index.html
cp -f $< $@
html-man: $(HTML_MANS) man-index.html
CLEANFILES = *.xml *.html
SUFFIXES = .txt .html .1 .3 .5 .8
if HAVE_ASCIIDOC
.txt.html:
$(ASCIIDOC) --backend=xhtml11 \
--attribute localdate=`TZ=UTC date +%Y-%m-%d` \
--attribute localtime=`TZ=UTC date +%H:%M:%S` \
-o $@ $<
### The --destination-dir flag doesn't seem to affect the intermediate .xml file.
### Hence, the copying dance below.
A2X_MANPAGE_OPTS = -f manpage --attribute nutversion="@PACKAGE_VERSION@"
.txt.1:
test -f `basename $<` || cp -p $< .
$(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
.txt.3:
test -f `basename $<` || cp -p $< .
$(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
.txt.5:
test -f `basename $<` || cp -p $< .
$(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
.txt.8:
test -f `basename $<` || cp -p $< .
$(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
else !HAVE_ASCIIDOC
.txt.html:
@echo "Not (re)building $@ manual page, since 'asciidoc' was not found."
.txt.1:
@echo "Using existing $@ manual page, since 'asciidoc' was not found."
.txt.3:
@echo "Using existing $@ manual page, since 'asciidoc' was not found."
.txt.5:
@echo "Using existing $@ manual page, since 'asciidoc' was not found."
.txt.8:
@echo "Using existing $@ manual page, since 'asciidoc' was not found."
endif !HAVE_ASCIIDOC

1019
docs/man/Makefile.in Normal file
View file

File diff suppressed because it is too large Load diff

124
docs/man/apcsmart.8 Normal file
View file

@ -0,0 +1,124 @@
'\" t
.\" Title: apcsmart
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "APCSMART" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
apcsmart \- Driver for American Power Conversion Smart Protocol UPS equipment
.SH "SYNOPSIS"
.sp
\fBapcsmart\fR \-h
.sp
\fBapcsmart\fR \-a \fIUPS_NAME\fR [\fIOPTIONS\fR]
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
This man page only documents the hardware\-specific features of the apcsmart driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.sp .5v
.RE
.SH "SUPPORTED HARDWARE"
.sp
apcsmart should recognize all recent APC models that use a serial protocol at 2400 bps\&. This is primarily the Smart\-UPS, Matrix\-UPS and Back\-UPS Pro lines\&.
.sp
The driver attempts to support every bell and whistle of the APC reporting interface, whether or not this is strictly sensible\&.
.sp
Some older hardware may only report a handful of variables\&. This is usually not a bug\(emthey just don\(cqt support anything else\&.
.SH "CABLING"
.sp
This driver expects to see a 940\-0024C cable or a clone by default\&. You can switch to the 940\-0095B dual\-mode cable support with the cable= definition described below\&.
.sp
If your 940\-0024C cable is broken or missing, use this diagram to build a clone:
.sp
http://www\&.networkupstools\&.org/cables/940\-0024C\&.jpg
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5):
.PP
\fBcable=940\-0095B\fR
.RS 4
Configure the serial port for the APC 940\-0095B dual\-mode cable\&.
.RE
.PP
\fBsdtype=\fR\fInum\fR
.RS 4
Use shutdown type
\fInum\fR, according to this table:
.PP
0
.RS 4
soft shutdown or powerdown, depending on battery status
.RE
.PP
1
.RS 4
soft shutdown followed by powerdown
.RE
.PP
2
.RS 4
instant power off
.RE
.PP
3
.RS 4
power off with grace period
.RE
.PP
4
.RS 4
"force OB" hack method for CS 350
.RE
.RE
.sp
Modes 0 and 1 will power up the load when power returns\&. Modes 2 and 3 will keep the load turned off when the power returns\&.
.sp
Mode 4 exploits an oddity in the CS 350 models since they only seem to support the S command, but then only when running on battery\&. As a result, the driver will force the UPS to go on battery if necessary before sending the shutdown command\&. This ensures that the load gets reset\&.
.SH "BUGS"
.sp
Some older APC UPS models return bogus data in the status register during a front panel test\&. This is usually detected and discarded, but some other unexpected values have occasionally slipped through\&.
.sp
APC UPS models with both USB and serial ports require a power cycle when switching from USB communication to serial, and perhaps vice versa\&.
.SH "AUTHOR"
.sp
Nigel Metheringham <Nigel\&.Metheringham@Intechnology\&.co\&.uk> (drawing heavily on the original apcsmart driver by Russell Kroll)\&. This driver was called newapc for a time and was renamed in the 1\&.5 series\&.
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

101
docs/man/apcsmart.txt Normal file
View file

@ -0,0 +1,101 @@
APCSMART(8)
===========
NAME
----
apcsmart - Driver for American Power Conversion Smart Protocol UPS equipment
SYNOPSIS
--------
*apcsmart* -h
*apcsmart* -a 'UPS_NAME' ['OPTIONS']
NOTE: This man page only documents the hardware-specific features of the
apcsmart driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
apcsmart should recognize all recent APC models that use a serial
protocol at 2400 bps. This is primarily the Smart-UPS, Matrix-UPS and
Back-UPS Pro lines.
The driver attempts to support every bell and whistle of the APC
reporting interface, whether or not this is strictly sensible.
Some older hardware may only report a handful of variables. This is
usually not a bug--they just don't support anything else.
CABLING
-------
This driver expects to see a 940-0024C cable or a clone by default. You
can switch to the 940-0095B dual-mode cable support with the `cable=`
definition described below.
If your 940-0024C cable is broken or missing, use this diagram to build
a clone:
http://www.networkupstools.org/cables/940-0024C.jpg
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5]:
*cable=940-0095B*::
Configure the serial port for the APC 940-0095B dual-mode cable.
*sdtype=*'num'::
Use shutdown type 'num', according to this table:
0;; soft shutdown or powerdown, depending on battery status
1;; soft shutdown followed by powerdown
2;; instant power off
3;; power off with grace period
4;; "force OB" hack method for CS 350
Modes 0 and 1 will power up the load when power returns. Modes 2 and 3
will keep the load turned off when the power returns.
Mode 4 exploits an oddity in the CS 350 models since they only seem to
support the S command, but then only when running on battery. As a
result, the driver will force the UPS to go on battery if necessary
before sending the shutdown command. This ensures that the load gets
reset.
BUGS
----
Some older APC UPS models return bogus data in the status register during
a front panel test. This is usually detected and discarded, but some
other unexpected values have occasionally slipped through.
APC UPS models with both USB and serial ports require a power cycle when
switching from USB communication to serial, and perhaps vice versa.
AUTHOR
------
Nigel Metheringham <Nigel.Metheringham@Intechnology.co.uk> (drawing
heavily on the original apcsmart driver by Russell Kroll). This driver
was called newapc for a time and was renamed in the 1.5 series.
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

46
docs/man/asciidoc.conf Normal file
View file

@ -0,0 +1,46 @@
## Borrowed from 'linkgit' in the Git distribution.
## linkman: macro
#
# Usage: linkman:command[manpage-section]
#
# Note, {0} is the manpage section, while {target} is the command.
#
# Show NUT link as: <command>(<section>); if section is defined, else just show
# the command.
[macros]
(?su)[\\]?(?P<name>linkman):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
ifdef::backend-docbook[]
[linkman-inlinemacro]
{0%{target}}
{0#<citerefentry>}
{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
{0#</citerefentry>}
endif::backend-docbook[]
ifdef::backend-xhtml11[]
[linkman-inlinemacro]
<a href="{target}.html">{target}{0?({0})}</a>
endif::backend-xhtml11[]
# Meta info for a2x manpage conversion:
ifdef::doctype-manpage[]
ifdef::backend-docbook[]
[header]
template::[header-declarations]
<refentry>
<refmeta>
<refentrytitle>{mantitle}</refentrytitle>
<manvolnum>{manvolnum}</manvolnum>
<refmiscinfo class="source">Network UPS Tools</refmiscinfo>
<refmiscinfo class="version">{nut_version}</refmiscinfo>
<refmiscinfo class="manual">NUT Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>{manname}</refname>
<refpurpose>{manpurpose}</refpurpose>
</refnamediv>
endif::backend-docbook[]
endif::doctype-manpage[]

130
docs/man/bcmxcp.8 Normal file
View file

@ -0,0 +1,130 @@
'\" t
.\" Title: bcmxcp
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BCMXCP" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bcmxcp \- Driver for UPSes supporting the serial BCM/XCP protocol
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the bcmxcp driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver should recognize all serial BCM/XCP\-compatible UPSes\&. It has been developed and tested on Powerware PW5115 and PW9120 hardware\&. If your UPS has a USB connection, you may also consult the \fBbcmxcp_usb\fR(8) driver documentation\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5)\&.
.PP
\fBshutdown_delay=\fR\fIdelay\fR
.RS 4
The number of seconds that the UPS should wait between receiving the shutdown command (upsdrvctl shutdown) and actually shutting off\&.
.RE
.PP
\fBbaud_rate=\fR\fIrate\fR
.RS 4
Communication speed for the UPS\&. If this is set to 9600, it tries to connect to the UPS at 9600bps\&. If it fails to communicate, it will go into baud\-hunting\&. It starts at 1200 and goes up to 19200\&. If it succeeds, it tell you the speed it connected with\&. If not included in the config, it defaults to baud\-hunting\&.
.RE
.SH "DEFAULT VALUES FOR THE EXTRA ARGUMENTS"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBshutdown_delay =\fR
\fI120\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBbaud_rate =\fR
\fInone\fR
.RE
.SH "INSTANT COMMANDS"
.sp
This driver supports the following Instant Commands:
.PP
\fBshutdown\&.return\fR
.RS 4
Turn off the load and return when power is back\&.
.RE
.PP
\fBshutdown\&.stayoff\fR
.RS 4
Turn off the load and remain off\&.
.RE
.PP
\fBtest\&.battery\&.start\fR
.RS 4
Start a battery test\&.
.RE
.PP
\fBoutlet\&.n\&.shutdown\&.return\fR
.RS 4
Turn off the load on outlet
\fIn\fR
and return when power is back\&. (\fIn\fR
is the outlet number reported by the upsc command)
.RE
.SH "TODO LIST"
.PP
Report UPS statistics informations
.RS 4
BCM/XCP supports reporting of UPS statistics data\&.
.RE
.PP
Change settings
.RS 4
Access the config register to change settings\&.
.RE
.SH "BUGS"
.sp
None known\&.
.SH "AUTHOR"
.sp
Tore Ørpetveit <tore@orpetveit\&.net>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "The USB BCM/XCP driver:"
.sp
\fBbcmxcp_usb\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

88
docs/man/bcmxcp.txt Normal file
View file

@ -0,0 +1,88 @@
BCMXCP(8)
=========
NAME
----
bcmxcp - Driver for UPSes supporting the serial BCM/XCP protocol
NOTE
----
This man page only documents the hardware-specific features of the
bcmxcp driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver should recognize all serial BCM/XCP-compatible UPSes. It has
been developed and tested on Powerware PW5115 and PW9120 hardware. If your UPS
has a USB connection, you may also consult the linkman:bcmxcp_usb[8] driver
documentation.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5].
*shutdown_delay=*'delay'::
The number of seconds that the UPS should wait between receiving the
shutdown command (`upsdrvctl shutdown`) and actually shutting off.
*baud_rate=*'rate'::
Communication speed for the UPS. If this is set to 9600, it tries to connect
to the UPS at 9600bps. If it fails to communicate, it will go into baud-hunting.
It starts at 1200 and goes up to 19200. If it succeeds, it tell you the speed it
connected with. If not included in the config, it defaults to baud-hunting.
DEFAULT VALUES FOR THE EXTRA ARGUMENTS
--------------------------------------
- *shutdown_delay =* '120'
- *baud_rate =* 'none'
INSTANT COMMANDS
----------------
This driver supports the following Instant Commands:
*shutdown.return*::
Turn off the load and return when power is back.
*shutdown.stayoff*::
Turn off the load and remain off.
*test.battery.start*::
Start a battery test.
*outlet.n.shutdown.return*::
Turn off the load on outlet 'n' and return when power is back.
('n' is the outlet number reported by the upsc command)
TODO LIST
---------
Report UPS statistics informations::
BCM/XCP supports reporting of UPS statistics data.
Change settings::
Access the config register to change settings.
BUGS
----
None known.
AUTHOR
------
Tore Ørpetveit <tore@orpetveit.net>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
The USB BCM/XCP driver:
~~~~~~~~~~~~~~~~~~~~~~~
linkman:bcmxcp_usb[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

114
docs/man/bcmxcp_usb.8 Normal file
View file

@ -0,0 +1,114 @@
'\" t
.\" Title: bcmxcp_usb
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BCMXCP_USB" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bcmxcp_usb \- Experimental driver for UPSes supporting the BCM/XCP protocol over USB
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the bcmxcp_usb driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&. This driver is a variant of the serial driver bcmxcp and uses the same core code\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver should recognize all BCM/XCP\-compatible UPSes that are connected via USB\&. It has been developed and tested on Powerware PW3501 hardware\&. It also has been tested on PW5110 hardware\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5)\&.
.PP
\fBshutdown_delay=\fR\fIdelay\fR
.RS 4
The number of seconds that the UPS should wait between receiving the shutdown command and actually shutting off\&.
.RE
.SH "DEFAULT VALUES FOR THE EXTRA ARGUMENTS"
.sp
\fBshutdown_delay =\fR\fI120\fR
.SH "INSTANT COMMANDS"
.sp
This driver supports the following Instant Commands:
.PP
\fBshutdown\&.return\fR
.RS 4
Turn off the load and return when power is back\&.
.RE
.PP
\fBshutdown\&.stayoff\fR
.RS 4
Turn off the load and remain off\&.
.RE
.PP
\fBtest\&.battery\&.start\fR
.RS 4
Start a battery test\&.
.RE
.SH "TODO LIST"
.PP
\fBReport UPS alarm status\fR
.RS 4
BCM/XCP supports reporting a wide range of UPS alarm conditions\&.
.RE
.PP
\fBReport UPS statistics informations\fR
.RS 4
BCM/XCP supports reporting of UPS statistics data\&.
.RE
.SH "EXPERIMENTAL DRIVER"
.sp
This driver has been tagged experimental, even if it has been reported to be stable\&. Thus it is not suitable for production systems and it is not built by default\&. This is mainly due to the fact that it is a new driver\&.
.SH "INSTALLATION"
.sp
This driver is not built by default\&. You can build it by using "configure \-\-with\-usb=yes"\&. Note that it will also install other USB drivers\&.
.sp
You also need to install manually the hotplug files (libhidups and libhid\&.usermap), generally in etc/hotplug/usb/, to address the permission settings problem\&. Lastly note that the libhidups file must have execution flag set (ie using chmod +x \&...)\&.
.SH "IMPLEMENTATION"
.sp
bcmxcp_usb only supports 1 UPS at this time\&. You can put the "auto" value for port in ups\&.conf, i\&.e\&.:
.sp
.if n \{\
.RS 4
.\}
.nf
[pw3105]
driver = bcmxcp_usb
port = auto
.fi
.if n \{\
.RE
.\}
.SH "KNOWN ISSUES AND BUGS"
.SS ""Got EPERM: Operation not permitted upon driver startup""
.sp
You have forgotten to install the hotplug files, as explained in the INSTALLATION section above\&. Don\(cqt forget to restart hotplug so that it applies these changes\&.
.SH "AUTHOR"
.sp
Tore Ørpetveit <tore@orpetveit\&.net>, Wolfgang Ocker <weo@weo1\&.de>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

107
docs/man/bcmxcp_usb.txt Normal file
View file

@ -0,0 +1,107 @@
BCMXCP_USB(8)
=============
NAME
----
bcmxcp_usb - Experimental driver for UPSes supporting the BCM/XCP protocol over USB
NOTE
----
This man page only documents the hardware-specific features of the
bcmxcp_usb driver. For information about the core driver, see
linkman:nutupsdrv[8].
This driver is a variant of the serial driver bcmxcp and uses the same core code.
SUPPORTED HARDWARE
------------------
This driver should recognize all BCM/XCP-compatible UPSes that are connected
via USB. It has been developed and tested on Powerware PW3501 hardware. It also has
been tested on PW5110 hardware.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5].
*shutdown_delay=*'delay'::
The number of seconds that the UPS should wait between receiving the
shutdown command and actually shutting off.
DEFAULT VALUES FOR THE EXTRA ARGUMENTS
--------------------------------------
*shutdown_delay =*'120'
INSTANT COMMANDS
----------------
This driver supports the following Instant Commands:
*shutdown.return*::
Turn off the load and return when power is back.
*shutdown.stayoff*::
Turn off the load and remain off.
*test.battery.start*::
Start a battery test.
TODO LIST
---------
*Report UPS alarm status*::
BCM/XCP supports reporting a wide range of UPS alarm conditions.
*Report UPS statistics informations*::
BCM/XCP supports reporting of UPS statistics data.
EXPERIMENTAL DRIVER
-------------------
This driver has been tagged experimental, even if it has been reported
to be stable. Thus it is not suitable for production systems and it is
not built by default. This is mainly due to the fact that it is a
new driver.
INSTALLATION
------------
This driver is not built by default. You can build it by using
"configure --with-usb=yes". Note that it will also install other USB
drivers.
You also need to install manually the hotplug files (libhidups and
libhid.usermap), generally in etc/hotplug/usb/, to address the
permission settings problem. Lastly note that the libhidups file
must have execution flag set (ie using chmod +x ...).
IMPLEMENTATION
--------------
bcmxcp_usb only supports 1 UPS at this time. You can put the
"auto" value for port in `ups.conf`, i.e.:
[pw3105]
driver = bcmxcp_usb
port = auto
KNOWN ISSUES AND BUGS
---------------------
"Got EPERM: Operation not permitted upon driver startup"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You have forgotten to install the hotplug files, as explained
in the INSTALLATION section above. Don't forget to restart
hotplug so that it applies these changes.
AUTHOR
------
Tore Ørpetveit <tore@orpetveit.net>,
Wolfgang Ocker <weo@weo1.de>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

68
docs/man/belkin.8 Normal file
View file

@ -0,0 +1,68 @@
'\" t
.\" Title: belkin
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BELKIN" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
belkin \- Driver for Belkin serial UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the belkin driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
The \fBbelkin\fR driver is known to support the Regulator Pro 525 (F6C525\-SER)\&. Other similar models such as the 425 and 625 should also work\&.
.sp
The Trust UPS and older Belkin units are not supported\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "BUGS"
.sp
There are dragons lurking within the protocol to this UPS\&. I have one that essentially behaves like a glorified power strip due to some invasive probing on my part\&. Don\(cqt mess with it directly\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
the driver doesn\(cqt go anywhere near these character sequences, so it won\(cqt zap your UPS\&. I only mention this here as yet another reminder of the perils of closed hardware\&.
.sp .5v
.RE
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

49
docs/man/belkin.txt Normal file
View file

@ -0,0 +1,49 @@
BELKIN(8)
=========
NAME
----
belkin - Driver for Belkin serial UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
belkin driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
The *belkin* driver is known to support the Regulator Pro 525 (F6C525-SER).
Other similar models such as the 425 and 625 should also work.
The Trust UPS and older Belkin units are not supported.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
BUGS
----
There are dragons lurking within the protocol to this UPS. I have one
that essentially behaves like a glorified power strip due to some
invasive probing on my part. Don't mess with it directly.
NOTE: the driver doesn't go anywhere near these character sequences,
so it won't zap your UPS. I only mention this here as yet another
reminder of the perils of closed hardware.
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

352
docs/man/belkinunv.8 Normal file
View file

@ -0,0 +1,352 @@
'\" t
.\" Title: belkinunv
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BELKINUNV" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
belkinunv \- Driver for Belkin "Universal UPS" and compatible
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the belkin driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
The belkinunv driver is known to work with the Belkin Universal UPS models F6C800\-UNV and F6C120\-UNV, and is expected to work with other Belkin Universal UPS models\&. The driver only supports serial communication, not USB\&.
.sp
The Trust UPS and older Belkin units are not supported by this driver, and neither are the Belkin Home Office models (F6H500\-SER and so forth)\&. However, some Belkin models, such as the Regulator Pro, are supported by the \fBbelkin\fR(8) driver, and the Home Office models are supported using the \fBgenericups\fR(8) driver with upstype=7\&.
.SH "SOFT SHUTDOWN WORKAROUND"
.sp
One problem with the Belkin Universal UPS is that it cannot enter a soft shutdown (shut down the load until AC power returns) unless the batteries are completely depleted\&. Thus, one cannot just shut off the UPS after operating system shutdown; it will not come back on when the power comes back on\&. Therefore, the belkinunv driver should never be used with the \fB\-k\fR option\&. Instead, the \fB\-x wait\fR option is provided as a workaround\&.
.sp
When called with the \fB\-x wait\fR option, \fBbelkinunv\fR behaves as a standalone program (i\&.e\&., it does not fork into the background)\&. It performs one simple task: it connects to the UPS, waits for AC power to return, and then exits with status 0\&.
.sp
This is meant to be used in a shutdown script as follows: during a shutdown, after all filesystems have been remounted read\-only, and just before the system would normally be halted: check /etc/killpower (or similar) to see if this shutdown was caused by \fBupsmon\fR(8), and if yes, call \fBbelkinunv \-x wait\fR\&. If AC power comes back on, \fBbelkinunv\fR exits, and things should be arranged so that the system reboots in this case\&. If AC power does not come back on, the UPS will eventually run out of batteries, kill the computer\(cqs power supply, and go into soft shutdown mode, which means everything will reboot properly when the power returns\&. In either case, a deadlock is avoided\&.
.sp
In addition, if an optional integer argument is given to the \fB\-x wait\fR option, this causes \fBbelkinunv\fR to wait not only for AC power to be present, but also for the battery charge to reach the given level\&. I use this as part of my startup scripts, to ensure that the batteries are sufficiently charged before the computer continues booting\&. This should be put very early in the startup script, before any filesystems are mounted read/write, and before any filesystem checks are performed\&.
.sp
Several other \fB\-x\fR options are provided to fine\-tune this behavior\&. See the options below for detailed descriptions\&. See the examples below for examples of how to use \fBbelkinunv\fR in shutdown and startup scripts\&.
.SH "OPTIONS"
.sp
See also \fBnutupsdrv\fR(8) for generic options\&. Never use the \fB\-k\fR option with this driver; it does not work properly\&.
.PP
\fB\-x wait\fR[=\fIlevel\fR]
.RS 4
When this option is used,
\fBbelkinunv\fR
does not fork into the background, but behaves as a standalone program\&. It connects to the UPS and waits until AC power is present\&. If
\fIlevel\fR
is specified, it also waits until the battery charge reaches at least the given level in percent\&. Then, and only then,
\fBbelkinunv\fR
exits\&. In addition, while
\fBbelkinunv\fR
runs in this mode, it displays a status line with information on the UPS status and battery level\&. This is intended for use in the computer\(cqs shutdown and startup scripts, as described under
Soft Shutdown Workaround
above\&.
.RE
.PP
\fB\-x nohang\fR
.RS 4
This option only has an effect when used in conjunction with the
\fB\-x wait\fR
option\&. It causes
\fBbelkinunv\fR
to exit if a connection with the UPS cannot be established or is lost, instead of retrying forever, which is the default behavior\&. The
\fB\-x nohang\fR
option should be used in a startup script, to ensure the computer remains bootable even if the UPS has been disconnected during the power failure (for instance, you attached your computer to a generator, carried it to a neighbor\(cqs house, or whatever)\&.
.RE
.PP
\fB\-x flash\fR
.RS 4
This option only has an effect when used in conjunction with the
\fB\-x wait\fR
option\&. It causes the UPS load to be shut off for a short time ("flashed") just after the AC power has returned and the requested battery level (if any) has been attained\&. This is useful if slaves are attached to this UPS; the flash will cause all of them to reboot\&. Note that, due to the design of the Belkin UPS hardware, the load shutdown lasts ca\&. 1\(em2 minutes; a shorter flash cannot be performed reliably\&. Also, the computers will reboot at the scheduled time, on battery power if necessary, even if AC power fails again in the meantime\&. This should not be a problem, as your startup scripts can catch this situation\&.
.RE
.PP
\fB\-x silent\fR
.RS 4
This option only has an effect when used in conjunction with the
\fB\-x wait\fR
option\&. It suppresses the status line which
\fBbelkinunv\fR
would normally print\&.
.RE
.PP
\fB\-x dumbterm\fR
.RS 4
This option only has an effect when used in conjunction with the
\fB\-x wait\fR
option\&. It changes the way in which
\fBbelkinunv\fR
prints its status line\&. Normally, terminal control sequences are used to overwrite the same line with new status information, each time the status is updated\&. This may not work on all terminals\&. If the
\fB\-x dumbterm\fR
option is given, each status update is written on a new line\&.
.RE
.SH "VARIABLES"
.PP
\fBbattery\&.charge\fR, \fBbattery\&.runtime\fR
.RS 4
not supported by all hardware\&.
.RE
.PP
\fBbattery\&.voltage\fR, \fBbattery\&.voltage\&.nominal\fR, \fBdriver\&.version\&.internal\fR, \fBinput\&.frequency\fR, \fBinput\&.frequency\&.nominal\fR
.RS 4
e\&.g\&. 60 for 60Hz
.RE
.PP
\fBinput\&.sensitivity\fR
.RS 4
writable: normal/medium/low
.RE
.PP
\fBinput\&.transfer\&.high\fR
.RS 4
writable: high transfer voltage point in V
.RE
.PP
\fBinput\&.transfer\&.low\fR
.RS 4
writable: low transfer voltage point in V
.RE
.PP
\fBinput\&.voltage\fR, \fBinput\&.voltage\&.maximum\fR, \fBinput\&.voltage\&.minimum\fR, \fBinput\&.voltage\&.nominal\fR, \fBoutput\&.frequency\fR, \fBoutput\&.voltage\fR, \fBups\&.beeper\&.status\fR
.RS 4
writable\&. Values: enabled/disabled/muted\&. This variable controls the state of the panel beeper\&. Enabled means sound when the alarm is present, disabled means never sound, and muted means the sound is temporarily disabled until the alarm would normally stop sounding\&. In the muted state, the beeper is automatically turned back on at the next event (AC failure, battery test, etc)\&. Also, the beeper can\(cqt be turned off during a critical event (low battery)\&. Note that not all UPS models support the "disabled" state\&.
.RE
.PP
\fBups\&.firmware\fR, \fBups\&.load\fR, \fBups\&.model\fR, \fBups\&.power\&.nominal\fR
.RS 4
e\&.g\&. 800 for an 800VA system
.RE
.PP
\fBups\&.status\fR
.RS 4
a list of flags; see the
status flags
below\&.
.RE
.PP
\fBups\&.temperature\fR
.RS 4
not supported by all hardware\&.
.RE
.PP
\fBups\&.test\&.result\fR, \fBups\&.delay\&.restart\fR
.RS 4
time to restart (read only)
.RE
.PP
\fBups\&.delay\&.shutdown\fR
.RS 4
time to shutdown (read only)\&. This is always a multiple of 60 seconds\&.
.RE
.PP
\fBups\&.type\fR
.RS 4
ONLINE/OFFLINE/LINEINT\&. This describes the basic layout of this UPS (for GUI clients which want to draw an animated picture of power flow)\&. An offline UPS has a direct connection from AC input to AC output, and also a connection from AC input to the battery, and from the battery to AC output\&. An online UPS lacks the direct connection from AC input to AC output, whereas a line interactive UPS lacks the connection from AC input to the battery\&.
.RE
.SH "COMMANDS"
.PP
\fBbeeper\&.enable, beeper\&.disable, beeper\&.mute\fR
.RS 4
Enable, disable or mute the panel beeper\&. Note that if the beeper is muted, it is automatically turned back on at the next event (AC failure, battery test, etc)\&. Also, the beeper can\(cqt be turned muted during a critical event (low battery)\&.
.RE
.PP
\fBreset\&.input\&.minmax\fR
.RS 4
Reset the variables
\fBinput\&.voltage\&.minimum\fR
and
\fBinput\&.voltage\&.maximum\fR\&.
.RE
.PP
\fBshutdown\&.reboot\fR
.RS 4
Shut down load immediately for about 1\(em2 minutes\&.
.RE
.PP
\fBshutdown\&.reboot\&.graceful\fR
.RS 4
After 40 second delay, shut down load for about 1\(em2 minutes\&.
.RE
.PP
\fBshutdown\&.stayoff\fR
.RS 4
Shut down load immediately and stay off\&. The only way it can be turned back on is by manually pressing the front panel button\&.
.RE
.PP
\fBtest\&.battery\&.start, test\&.battery\&.stop\fR
.RS 4
Start/stop 10 second battery test\&.
.RE
.PP
\fBtest\&.failure\&.start, test\&.failure\&.stop\fR
.RS 4
Start/stop "deep" battery test\&.
.RE
.SH "STATUS FLAGS"
.PP
\fBOB\fR
.RS 4
load is on battery, including during tests
.RE
.PP
\fBOFF\fR
.RS 4
load is off
.RE
.PP
\fBOL\fR
.RS 4
load is online
.RE
.PP
\fBACFAIL\fR
.RS 4
AC failure\&. Note that this refers to the AC input, and thus it is not the same as "OB"\&. An AC failure can occur at any time, for instance, during a battery test, or when the UPS load is off\&.
.RE
.PP
\fBOVER\fR
.RS 4
overload
.RE
.PP
\fBOVERHEAT\fR
.RS 4
overheat
.RE
.PP
\fBCOMMFAULT\fR
.RS 4
UPS fault
.RE
.PP
\fBLB\fR
.RS 4
low battery
.RE
.PP
\fBCHRG\fR
.RS 4
charging
.RE
.PP
\fBDEPLETED\fR
.RS 4
the battery is depleted\&. When the UPS raises this flag, it simultaneously switches off the load\&.
.RE
.PP
\fBRB\fR
.RS 4
replace battery
.RE
.SH "EXAMPLES"
.sp
Here is an example for how \fBbelkinunv\fR should be used in a computer\(cqs shutdown script\&. These commands should go in the very last part of the shutdown script, after all file systems have been mounted read\-only, and just before the computer halts\&. Note that \fBbelkinunv\fR must be installed in a directory which is still readable at that point\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# NEAR END OF SHUTDOWN SCRIPT:
# if shutdown was caused by UPS, perform Belkin UPS workaround\&.
if [ \-f /etc/killpower ] ; then
echo "Waiting for AC power, or for UPS batteries to run out\&.\&.\&."
/usr/bin/belkinunv \-x wait /dev/ttyS1
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
# we get here if the power came back on\&. Reboot\&.
echo "Power is back\&. Rebooting\&.\&.\&."
reboot
fi
.fi
.if n \{\
.RE
.\}
.sp
And here is an example of how to use \fBbelkinunv\fR in the startup script\&. These commands should go near the beginning of the startup script, before any file systems are mounted read/write, and before any file system integrity checks are done\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# NEAR BEGINNING OF STARTUP SCRIPT:
# if we are recovering from a power failure, wait for the UPS to
# charge to a comfortable level before writing anything to disk
if [ \-f /etc/killpower ] ; then
echo "Waiting for UPS battery charge to reach 60%\&.\&.\&."
/usr/bin/belkinunv \-x wait=60 \-x nohang /dev/ttyS1
fi
.fi
.if n \{\
.RE
.\}
.SH "EXIT STATUS"
.sp
When used normally, \fBbelkinunv\fR forks into the background and its diagnostics are the same as for all NUT drivers, see \fBnutupsdrv\fR(8)\&.
.sp
When used with the \fB\-x wait\fR option, the exit status is normally \fB0\fR\&. If the \fB\-x nohang\fR option has also been specified, an exit status of \fB1\fR indicates that communication with the UPS was lost\&. If the \fB\-x flash\fR option has been specified, an exit status of \fB2\fR indicates that the timed shutdown has failed\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in \fBups.conf\fR(5)\&.
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The NUT (Network UPS Tools) home page:
http://www\&.networkupstools\&.org/
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The documentation for the protocol used by this UPS:
belkin\-universal\-ups\&.html
.RE
.SH "AUTHOR"
.sp
Peter Selinger <selinger@users\&.sourceforge\&.net>

344
docs/man/belkinunv.txt Normal file
View file

@ -0,0 +1,344 @@
BELKINUNV(8)
============
NAME
----
belkinunv - Driver for Belkin "Universal UPS" and compatible
NOTE
----
This man page only documents the hardware-specific features of the
belkin driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
The belkinunv driver is known to work with the Belkin Universal UPS
models F6C800-UNV and F6C120-UNV, and is expected to work with other
Belkin Universal UPS models. The driver only supports serial
communication, not USB.
The Trust UPS and older Belkin units are not supported by this driver,
and neither are the Belkin Home Office models (F6H500-SER and so
forth). However, some Belkin models, such as the Regulator Pro, are
supported by the linkman:belkin[8] driver, and the Home Office models
are supported using the linkman:genericups[8] driver with
`upstype=7`.
SOFT SHUTDOWN WORKAROUND
------------------------
One problem with the Belkin Universal UPS is that it cannot enter a
soft shutdown (shut down the load until AC power returns) unless the
batteries are completely depleted. Thus, one cannot just shut off the
UPS after operating system shutdown; it will not come back on when the
power comes back on. Therefore, the belkinunv driver should never be
used with the *-k* option. Instead, the *-x wait* option is
provided as a workaround.
When called with the *-x wait* option, *belkinunv* behaves as
a standalone program (i.e., it does not fork into the background). It
performs one simple task: it connects to the UPS, waits for AC power
to return, and then exits with status 0.
This is meant to be used in a shutdown script as follows: during a
shutdown, after all filesystems have been remounted read-only, and
just before the system would normally be halted: check /etc/killpower
(or similar) to see if this shutdown was caused by linkman:upsmon[8],
and if yes, call *belkinunv -x wait*. If AC power comes back on,
*belkinunv* exits, and things should be arranged so that the
system reboots in this case. If AC power does not come back on, the
UPS will eventually run out of batteries, kill the computer's power
supply, and go into soft shutdown mode, which means everything will
reboot properly when the power returns. In either case, a deadlock is
avoided.
In addition, if an optional integer argument is given to the *-x wait*
option, this causes *belkinunv* to wait not only for AC power to be present,
but also for the battery charge to reach the given level. I use this as part of
my startup scripts, to ensure that the batteries are sufficiently charged
before the computer continues booting. This should be put very early in the
startup script, before any filesystems are mounted read/write, and before any
filesystem checks are performed.
Several other *-x* options are provided to fine-tune this
behavior. See the <<_options,options>> below for detailed descriptions. See the
<<_examples,examples>>
below for examples of how to use *belkinunv* in shutdown and
startup scripts.
OPTIONS
-------
See also linkman:nutupsdrv[8] for generic options. Never use the
*-k* option with this driver; it does not work properly.
*-x wait*[='level']::
When this option is used, *belkinunv* does not fork into the
background, but behaves as a standalone program. It connects to the UPS and
waits until AC power is present. If 'level' is specified, it also
waits until the battery charge reaches at least the given level in
percent. Then, and only then, *belkinunv* exits. In addition,
while *belkinunv* runs in this mode, it displays a status line
with information on the UPS status and battery level. This is intended
for use in the computer's shutdown and startup scripts, as described
under <<_soft_shutdown_workaround,Soft Shutdown Workaround>> above.
*-x nohang*::
This option only has an effect when used in conjunction with the *-x wait*
option. It causes *belkinunv* to exit if a connection with
the UPS cannot be established or is lost, instead of retrying forever,
which is the default behavior. The *-x nohang* option should be
used in a startup
script, to ensure the computer remains bootable even if the UPS has
been disconnected during the power failure (for instance, you attached
your computer to a generator, carried it to a neighbor's house, or
whatever).
*-x flash*::
This option only has an effect when used in conjunction with the *-x wait*
option. It causes the UPS load to be shut off for a short time
("flashed") just after the AC power has returned and the requested
battery level (if any) has been attained. This is useful if slaves are
attached to this UPS; the flash will cause all of them to reboot. Note
that, due to the design of the Belkin UPS hardware, the load shutdown lasts
ca. 1--2 minutes; a shorter flash cannot be performed reliably. Also,
the computers will reboot at the scheduled time, on battery power if
necessary, even if AC power fails again in the meantime. This should
not be a problem, as your startup scripts can catch this situation.
*-x silent*::
This option only has an effect when used in conjunction with the *-x wait*
option. It suppresses the status line which *belkinunv*
would normally print.
*-x dumbterm*::
This option only has an effect when used in conjunction with the *-x wait*
option. It changes the way in which *belkinunv* prints its
status line. Normally, terminal control sequences are used to
overwrite the same line with new status information, each time the
status is updated. This may not work on all terminals. If the *-x dumbterm*
option is given, each status update is written on a new
line.
VARIABLES
---------
*battery.charge*::
*battery.runtime*::
not supported by all hardware.
*battery.voltage*::
*battery.voltage.nominal*::
*driver.version.internal*::
*input.frequency*::
*input.frequency.nominal*::
e.g. 60 for 60Hz
*input.sensitivity*::
writable: normal/medium/low
*input.transfer.high*::
writable: high transfer voltage point in V
*input.transfer.low*::
writable: low transfer voltage point in V
*input.voltage*::
*input.voltage.maximum*::
*input.voltage.minimum*::
*input.voltage.nominal*::
*output.frequency*::
*output.voltage*::
*ups.beeper.status*::
writable. Values: enabled/disabled/muted. This variable controls the
state of the panel beeper. Enabled means sound when the alarm is
present, disabled means never sound, and muted means the sound is
temporarily disabled until the alarm would normally stop sounding. In
the muted state, the beeper is automatically turned back on at the
next event (AC failure, battery test, etc). Also, the beeper can't be
turned off during a critical event (low battery). Note that not all
UPS models support the "disabled" state.
*ups.firmware*::
*ups.load*::
*ups.model*::
*ups.power.nominal*::
e.g. 800 for an 800VA system
*ups.status*::
a list of flags; see the <<_status_flags,status flags>> below.
*ups.temperature*::
not supported by all hardware.
*ups.test.result*::
*ups.delay.restart*::
time to restart (read only)
*ups.delay.shutdown*::
time to shutdown (read only). This is always a multiple of 60 seconds.
*ups.type*::
ONLINE/OFFLINE/LINEINT. This describes the basic layout of this UPS
(for GUI clients which want to draw an animated picture of power
flow). An offline UPS has a direct connection from AC input to AC
output, and also a connection from AC input to the battery, and from
the battery to AC output. An online UPS lacks the direct connection
from AC input to AC output, whereas a line interactive UPS lacks the
connection from AC input to the battery.
COMMANDS
--------
*beeper.enable, beeper.disable, beeper.mute*::
Enable, disable or mute the panel beeper. Note that if the beeper is
muted, it is automatically turned back on at the next event (AC failure,
battery test, etc). Also, the beeper can't be turned muted during a
critical event (low battery).
*reset.input.minmax*::
Reset the variables *input.voltage.minimum* and
*input.voltage.maximum*.
*shutdown.reboot*::
Shut down load immediately for about 1--2 minutes.
*shutdown.reboot.graceful*::
After 40 second delay, shut down load for about 1--2 minutes.
*shutdown.stayoff*::
Shut down load immediately and stay off. The only way it can be turned
back on is by manually pressing the front panel button.
*test.battery.start, test.battery.stop*::
Start/stop 10 second battery test.
*test.failure.start, test.failure.stop*::
Start/stop "deep" battery test.
STATUS FLAGS
------------
*OB*::
load is on battery, including during tests
*OFF*::
load is off
*OL*::
load is online
*ACFAIL*::
AC failure. Note that this refers to the AC input, and thus it is not
the same as "OB". An AC failure can occur at any time, for instance,
during a battery test, or when the UPS load is off.
*OVER*::
overload
*OVERHEAT*::
overheat
*COMMFAULT*::
UPS fault
*LB*::
low battery
*CHRG*::
charging
*DEPLETED*::
the battery is depleted. When the UPS raises this flag, it
simultaneously switches off the load.
*RB*::
replace battery
EXAMPLES
--------
Here is an example for how *belkinunv* should be used in a
computer's shutdown script. These commands should go in the very last
part of the shutdown script, after all file systems have been mounted
read-only, and just before the computer halts. Note that
*belkinunv* must be installed in a directory which is still
readable at that point.
# NEAR END OF SHUTDOWN SCRIPT:
# if shutdown was caused by UPS, perform Belkin UPS workaround.
if [ -f /etc/killpower ] ; then
echo "Waiting for AC power, or for UPS batteries to run out..."
/usr/bin/belkinunv -x wait /dev/ttyS1
# we get here if the power came back on. Reboot.
echo "Power is back. Rebooting..."
reboot
fi
And here is an example of how to use *belkinunv* in the startup
script. These commands should go near the beginning of the startup
script, before any file systems are mounted read/write, and before any
file system integrity checks are done.
# NEAR BEGINNING OF STARTUP SCRIPT:
# if we are recovering from a power failure, wait for the UPS to
# charge to a comfortable level before writing anything to disk
if [ -f /etc/killpower ] ; then
echo "Waiting for UPS battery charge to reach 60%..."
/usr/bin/belkinunv -x wait=60 -x nohang /dev/ttyS1
fi
EXIT STATUS
-----------
When used normally, *belkinunv* forks into the background and its
diagnostics are the same as for all NUT drivers, see
linkman:nutupsdrv[8].
When used with the *-x wait* option, the exit status is normally
*0*. If the *-x nohang* option has also been specified, an exit
status of *1* indicates that communication with the UPS was lost. If the
*-x flash* option has been specified, an exit status of *2*
indicates that the timed shutdown has failed.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in linkman:ups.conf[5].
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
- The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
- The documentation for the protocol used by this UPS:
link:http://www.mscs.dal.ca/~selinger/ups/belkin-universal-ups.html[belkin-universal-ups.html]
AUTHOR
------
Peter Selinger <selinger@users.sourceforge.net>

56
docs/man/bestfcom.8 Normal file
View file

@ -0,0 +1,56 @@
'\" t
.\" Title: bestfcom
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BESTFCOM" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bestfcom \- Driver for Best Power Fortress/Ferrups
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the bestfcom driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
Best Power Fortress/Ferrups implementing the Fortress UPS Protocol (f\-command set)\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "AUTHORS"
.sp
Kent Polk (bestfcom)
.sp
Andreas Wrede, John Stone (bestuferrups)
.sp
Grant Taylor (bestfort)
.sp
Russell Kroll (bestups)
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

45
docs/man/bestfcom.txt Normal file
View file

@ -0,0 +1,45 @@
BESTFCOM(8)
===========
NAME
----
bestfcom - Driver for Best Power Fortress/Ferrups
NOTE
----
This man page only documents the hardware-specific features of the
bestfcom driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
Best Power Fortress/Ferrups implementing the Fortress UPS Protocol
(f-command set).
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
AUTHORS
-------
Kent Polk (bestfcom)
Andreas Wrede, John Stone (bestuferrups)
Grant Taylor (bestfort)
Russell Kroll (bestups)
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

65
docs/man/bestfortress.8 Normal file
View file

@ -0,0 +1,65 @@
'\" t
.\" Title: bestfortress
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BESTFORTRESS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bestfortress \- Driver for old Best Fortress UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the bestfortress driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports old Best Fortress UPS equipment using a serial connection\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5):
.PP
\fBbaudrate\fR=\fInum\fR
.RS 4
Set the speed of the serial connection \- 1200, 2400, 4800 or 9600\&.
.RE
.PP
\fBmax_load\fR=\fIVA\fR
.RS 4
Set the full\-scale value of the
\fBups\&.load\fR
variable\&.
.RE
.SH "AUTHOR"
.sp
Holger Dietze <holger\&.dietze@advis\&.de>, Stuart D\&. Gathman <stuart@bmsi\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "The newer Best Power drivers:"
.sp
\fBbestups\fR(8), \fBbestuferrups\fR(8), \fBbestfcom\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

49
docs/man/bestfortress.txt Normal file
View file

@ -0,0 +1,49 @@
BESTFORTRESS(8)
===============
NAME
----
bestfortress - Driver for old Best Fortress UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
bestfortress driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports old Best Fortress UPS equipment using a serial connection.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5]:
*baudrate*='num'::
Set the speed of the serial connection - 1200, 2400, 4800 or 9600.
*max_load*='VA'::
Set the full-scale value of the *ups.load* variable.
AUTHOR
------
Holger Dietze <holger.dietze@advis.de>,
Stuart D. Gathman <stuart@bmsi.com>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
The newer Best Power drivers:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
linkman:bestups[8], linkman:bestuferrups[8], linkman:bestfcom[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

54
docs/man/bestuferrups.8 Normal file
View file

@ -0,0 +1,54 @@
'\" t
.\" Title: bestuferrups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BESTUFERRUPS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bestuferrups \- Driver for Best Power Micro\-Ferrups
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the bestuferrups driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
Best Power Micro\-Ferrups ME3100, probably other similar models too\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "AUTHORS"
.sp
Andreas Wrede, John Stone (bestuferrups)
.sp
Grant Taylor (bestfort)
.sp
Russell Kroll (bestups)
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

42
docs/man/bestuferrups.txt Normal file
View file

@ -0,0 +1,42 @@
BESTUFERRUPS(8)
===============
NAME
----
bestuferrups - Driver for Best Power Micro-Ferrups
NOTE
----
This man page only documents the hardware-specific features of the
bestuferrups driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
Best Power Micro-Ferrups ME3100, probably other similar models too.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
AUTHORS
-------
Andreas Wrede, John Stone (bestuferrups)
Grant Taylor (bestfort)
Russell Kroll (bestups)
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

105
docs/man/bestups.8 Normal file
View file

@ -0,0 +1,105 @@
'\" t
.\" Title: bestups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BESTUPS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bestups \- Driver for Best Power / SOLA (Phoenixtec protocol) UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the bestups driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
\fBbestups\fR was designed to monitor Best Power UPS hardware like the Fortress, Fortress Telecom, Axxium Rackmount and Patriot Pro\&. It also recognizes and supports SOLA units such as the 325, 520 and 620\&. In addition, the Best 610 is supported using the \(oqID\(cq option\&.
.sp
Other UPS hardware using the Phoenixtec protocol should also work, but they will generate a warning since their battery information is not known\&.
.sp
This driver does not support some older Best/SOLA units\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5):
.PP
\fBnombattvolt=\fR\fInum\fR
.RS 4
Override the battery float voltage which is normally determined by asking the hardware\&. This is useful if your UPS constantly reports
battery\&.charge
values just below 100% even when it\(cqs completely charged\&.
.sp
If you have this problem, set this to whatever
battery\&.voltage
reports when the UPS is known to be completely charged with a good battery\&.
.sp
The author\(cqs Best Fortress 750 uses
nombattvolt=27\&.4\&.
.RE
.PP
\fBbattvoltmult=\fR\fInum\fR
.RS 4
Multiply the reported battery voltage by this number\&. Some devices report only a fraction of the total battery voltage\&.
.sp
For example, the SOLA 610 700VA UPS (with a 24V battery) reports the single cell voltage (about 2\&.27V when fully charged)\&. In this particular case you can set
battvoltmult = 12
in
\fBups.conf\fR(8)
to fix this\&.
.RE
.PP
\fBID=\fR\fIstring\fR
.RS 4
Set the Identification response string\&. This should only be used with hardware that supports the Phoenixtec protocol status inquiry commands, but not the "ID" command, such as the Best/SOLA 610\&. Format of the ID string is: AAA,BBBB,CCC,DDD,EE\&.E,FF\&.F
.sp
AAA is the three\-character identification for the UPS model\&.
.sp
BBBB is the output power in VA (volt amperes)\&. B is an integer number ranging from 0 to 9\&.
.sp
CCC is the Nominal Input Voltage\&. C is an integer number ranging from 0 to 9\&. The unit is Volts AC\&.
.sp
DDD is the Nominal Output Voltage\&. D is an integer number ranging from 0 to 9\&. The unit is Volts AC\&.
.sp
EE\&.E is the Battery Voltage that will cause the UPS to shut itself off\&. E is an integer number ranging from 0 to 9\&. Then unit is Volts DC and a decimal point is present\&.
.sp
FF\&.F or FFF\&.F is the Battery Voltage at full charge\&. F is an integer number ranging from 0 to 9\&. Then unit is Volts DC\&. Typically, for 700VA, 1KVA and 1\&.5KVA units, the format is FF\&.F\&. For 2KVA and 3KVA units, the format is FFF\&.F\&.
.sp
Example: a Best 610 1\&.5KVA unit would use the string "610,1500,120,120,10\&.0,48\&.0"\&.
.RE
.SH "BUGS"
.sp
The battery charge percentage value (in battery\&.charge) is derived from the voltage data that the UPS returns, since the UPS doesn\(cqt return that value directly\&. On some hardware, the charge will remain at 100% for a long time and then drops quickly shortly before the battery runs out\&. You can confirm from the battery\&.voltage readings that this is a problem with the UPS and not this driver\&.
.sp
Similarly, the float from the charger in some models forces the battery charge percentage back up to 100% immedately after the UPS goes back on\-line, so you can\(cqt tell when it is really recharged\&.
.sp
Finally, some models give one value for the battery\(cqs nominal voltage and yet actually have a nominal voltage slightly below that\&. This leads to things such as the perpetual 98\&.7% charge on the author\(cqs Fortress 750, even when it\(cqs been charging for weeks\&. You can use nombattvolt= in \fBups.conf\fR(8) to fix this\&.
.SH "AUTHOR"
.sp
Russell Kroll, Jason White
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

117
docs/man/bestups.txt Normal file
View file

@ -0,0 +1,117 @@
BESTUPS(8)
==========
NAME
----
bestups - Driver for Best Power / SOLA (Phoenixtec protocol) UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
bestups driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
*bestups* was designed to monitor Best Power UPS hardware like the Fortress,
Fortress Telecom, Axxium Rackmount and Patriot Pro. It also recognizes
and supports SOLA units such as the 325, 520 and 620. In addition, the
Best 610 is supported using the `ID' option.
Other UPS hardware using the Phoenixtec protocol should also work, but
they will generate a warning since their battery information is not known.
This driver does not support some older Best/SOLA units.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5]:
*nombattvolt=*'num'::
Override the battery float voltage which is normally determined by
asking the hardware. This is useful if your UPS constantly reports
`battery.charge` values just below 100% even when it's completely charged.
+
If you have this problem, set this to whatever `battery.voltage` reports
when the UPS is known to be completely charged with a good battery.
+
The author's Best Fortress 750 uses `nombattvolt=27.4`.
*battvoltmult=*'num'::
Multiply the reported battery voltage by this number. Some devices
report only a fraction of the total battery voltage.
+
For example, the SOLA 610 700VA UPS (with a 24V battery) reports the
single cell voltage (about 2.27V when fully charged). In this particular
case you can set `battvoltmult = 12` in linkman:ups.conf[8] to fix this.
*ID=*'string'::
Set the Identification response string. This should only be used
with hardware that supports the Phoenixtec protocol status inquiry
commands, but not the "ID" command, such as the Best/SOLA 610. Format
of the ID string is: AAA,BBBB,CCC,DDD,EE.E,FF.F
+
AAA is the three-character identification for the UPS model.
+
BBBB is the output power in VA (volt amperes). B is an integer number
ranging from 0 to 9.
+
CCC is the Nominal Input Voltage. C is an integer number ranging from 0
to 9. The unit is Volts AC.
+
DDD is the Nominal Output Voltage. D is an integer number ranging from 0
to 9. The unit is Volts AC.
+
EE.E is the Battery Voltage that will cause the UPS to shut itself off.
E is an integer number ranging from 0 to 9. Then unit is Volts DC and a
decimal point is present.
+
FF.F or FFF.F is the Battery Voltage at full charge. F is an integer
number ranging from 0 to 9. Then unit is Volts DC. Typically, for 700VA,
1KVA and 1.5KVA units, the format is FF.F. For 2KVA and 3KVA units, the
format is FFF.F.
+
Example: a Best 610 1.5KVA unit would use the string
"610,1500,120,120,10.0,48.0".
BUGS
----
The battery charge percentage value (in `battery.charge`) is derived from
the voltage data that the UPS returns, since the UPS doesn't return that
value directly. On some hardware, the charge will remain at 100% for a
long time and then drops quickly shortly before the battery runs out.
You can confirm from the `battery.voltage` readings that this is a problem
with the UPS and not this driver.
Similarly, the float from the charger in some models forces the battery
charge percentage back up to 100% immedately after the UPS goes back
on-line, so you can't tell when it is really recharged.
Finally, some models give one value for the battery's nominal voltage and
yet actually have a nominal voltage slightly below that. This leads to
things such as the perpetual 98.7% charge on the author's Fortress 750,
even when it's been charging for weeks. You can use `nombattvolt=` in
linkman:ups.conf[8] to fix this.
AUTHOR
------
Russell Kroll, Jason White
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

313
docs/man/blazer.8 Normal file
View file

@ -0,0 +1,313 @@
'\" t
.\" Title: blazer
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BLAZER" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
blazer \- Driver for Megatec/Q1 protocol serial (blazer_ser) and USB (blazer_usb) based UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the blazer driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
The blazer driver is known to work with various UPSes from Blazer, Energy Sistem, Fenton Technologies, Mustek and many others\&. The NUT compatibility table lists all the known supported models\&. Keep in mind, however, that other models not listed there may also be supported, but haven\(cqt been tested\&.
.sp
All devices with a serial interface (use the \fBblazer_ser\fR driver) and many with a USB interface (use the \fBblazer_usb\fR driver) are supported\&.
.SH "EXTRA ARGUMENTS"
.sp
You may need to override or provide defaults for some values, depending on the make and model of your UPS\&. The following are the ones that most likely will need changing (see \fBups.conf\fR(5)):
.PP
\fBdefault\&.battery\&.voltage\&.high =\fR \fIvalue\fR
.RS 4
Maximum battery voltage that is reached after about 12 to 24 hours charging\&. If you want the driver to report a guesstimated
\fBbattery\&.charge\fR, you need to specify this (see
BATTERY CHARGE)\&.
.RE
.PP
\fBdefault\&.battery\&.voltage\&.low =\fR \fIvalue\fR
.RS 4
Minimum battery voltage just before the UPS automatically shuts down\&. If you want the driver to report a guesstimated
\fBbattery\&.charge\fR, you need to specify this (see
BATTERY CHARGE)\&.
.RE
.PP
\fBdefault\&.battery\&.voltage\&.nominal =\fR \fIvalue\fR, \fBoverride\&.battery\&.voltage\&.nominal =\fR \fIvalue\fR
.RS 4
Some devices show a wrong nominal battery voltage (or none at all), so you may need to override or set a default value\&.
.RE
.PP
\fBoverride\&.battery\&.packs =\fR \fIvalue\fR
.RS 4
Some devices report a part of the total battery voltage\&. For instance, if
\fBbattery\&.voltage\&.nominal\fR
is 24 V, but it reports a
\fBbattery\&.voltage\fR
of around 2 V, the number of
\fBbattery\&.packs\fR
to correct this reading would be 12\&. The driver will attempt to detect this automatically, but if this fails somehow, you may want to override this value\&.
.RE
.PP
\fBondelay =\fR \fIvalue\fR
.RS 4
Time to wait before switching on the UPS (minutes)\&. Note that a value below 3 minutes, may cause earlier firmware versions to not switch on automatically, so it defaults to 3 minutes\&.
.RE
.PP
\fBoffdelay =\fR \fIvalue\fR
.RS 4
Time to wait before shutting down the UPS (seconds)\&. This value is truncated to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60 seconds)\&. Defaults to 30 seconds\&.
.RE
.PP
\fBnorating\fR
.RS 4
Some UPSes will lock up if you attempt to read rating information from them\&. Setting this flag will make the driver skip this step\&.
.RE
.PP
\fBnovendor\fR
.RS 4
Some UPSes will lock up if you attempt to read vendor information from them\&. Setting this flag will make the driver skip this step\&.
.RE
.PP
\fBruntimecal =\fR \fIvalue,value,value,value\fR
.RS 4
Parameter used in the (optional) runtime estimation\&. This takes two runtimes at different loads\&. Typically, this uses the runtime at full load and the runtime at half load\&. For instance, if your UPS has a rated runtime of 240 seconds at full load and 720 seconds at half load, you would enter
.sp
.if n \{\
.RS 4
.\}
.nf
runtimecal = 270,100,720,50
.fi
.if n \{\
.RE
.\}
.sp
The first load should always be higher than the second\&. If you have values available for loads other than 100 and 50 % respectively, you can use those too, but keep them spaced apart as far as reasonably possible\&. Just don\(cqt get too close to no load (prediction of runtime depends more on idle load for the battery then)\&.
.RE
.PP
\fBchargetime =\fR \fIvalue\fR
.RS 4
The time needed to fully recharge the battery after being fully discharged\&. If not specified, the driver defaults to 43200 seconds (12 hours)\&. Only used if
\fBruntimecal\fR
is also specified\&.
.RE
.PP
\fBidleload =\fR \fIvalue\fR
.RS 4
Minimum battery load used by the driver to estimate the runtime\&. If not specified, the driver defaults to 10%\&. Only used if
\fBruntimecal\fR
is also specified\&.
.RE
.SH "SERIAL INTERFACE ONLY"
.PP
\fBcablepower =\fR \fIstring\fR
.RS 4
By default the driver will set DTR and clear RTS (\fInormal\fR)\&. If you find that your UPS isn\(cqt detected or the communication with the UPS is unreliable, you may try if clear DTR and set RTS (\fIreverse\fR), set DTR and RTS (\fIboth\fR) or clear DTR and RTS (\fInone\fR) improves this situation\&.
.RE
.SH "USB INTERFACE ONLY"
.PP
\fBvendorid =\fR \fIregex\fR, \fBproductid =\fR \fIregex\fR, \fBvendor =\fR \fIregex\fR, \fBproduct =\fR \fIregex\fR, \fBserial =\fR \fIregex\fR
.RS 4
Select a specific UPS, in case there is more than one connected via USB\&. Each option specifies an extended regular expression (see
\fBregex(7)\fR) that must match the UPS\(cqs entire vendor/product/serial string (minus any surrounding whitespace), or the whole 4\-digit hexadecimal code for vendorid and productid\&. Try
\fB\-DD\fR
for finding out the strings to match\&.
.RE
.sp
Examples:
.sp
.if n \{\
.RS 4
.\}
.nf
\-x vendor="Foo\&.Corporation\&.*"
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
\-x vendorid=051d # (APC)
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
\-x product="\&.*(Smart|Back)\-?UPS\&.*"
.fi
.if n \{\
.RE
.\}
.PP
\fBbus =\fR \fIregex\fR
.RS 4
Select a UPS on a specific USB bus or group of busses\&. The argument is a regular expression that must match the bus name where the UPS is connected (e\&.g\&. bus="002", bus="00[2\-3]")\&.
.RE
.PP
\fBsubdriver =\fR \fIstring\fR
.RS 4
Select a serial\-over\-USB subdriver to use\&. You have a choice between
\fBphoenix\fR,
\fBippon\fR,
\fBcypress\fR, and
\fBkrauler\fR\&. When using this option, it is mandatory to also specify the
\fBvendorid\fR
and
\fBproductid\fR\&.
.RE
.SH "UPS COMMANDS"
.sp
This driver supports some instant commands (see \fBupscmd\fR(8)):
.PP
\fBbeeper\&.toggle\fR
.RS 4
Toggle the UPS beeper\&. (Not available on some hardware\&.)
.RE
.PP
\fBload\&.on\fR
.RS 4
Turn on the load immediately\&.
.RE
.PP
\fBload\&.off\fR
.RS 4
Turn off the load immediately (see
KNOWN PROBLEMS)\&.
.RE
.PP
\fBshutdown\&.return\fR [\fIvalue\fR]
.RS 4
Turn off the load and return when power is back\&. Uses the timers defined by
\fBondelay\fR
and
\fBoffdelay\fR\&.
.RE
.PP
\fBshutdown\&.stayoff\fR [\fIvalue\fR]
.RS 4
Turn off the load and remain off (see
KNOWN PROBLEMS)\&. Uses the timer defined by
\fBoffdelay\fR\&.
.RE
.PP
\fBshutdown\&.stop\fR
.RS 4
Stop a shutdown in progress\&.
.RE
.PP
\fBtest\&.battery\&.start\&.deep\fR
.RS 4
Perform a long battery test (Not available on some hardware\&.)
.RE
.PP
\fBtest\&.battery\&.start\&.quick\fR
.RS 4
Perform a (10 second) battery test\&.
.RE
.PP
\fBtest\&.battery\&.start\fR \fIvalue\fR
.RS 4
Perform a battery test for the duration of
\fIvalue\fR
seconds (truncated to units of 60 seconds)\&.
.RE
.PP
\fBtest\&.battery\&.stop\fR
.RS 4
Stop a running battery test (not available on some hardware\&.)
.RE
.SH "BATTERY CHARGE"
.sp
Due to popular demand, this driver will report a guesstimated \fBbattery\&.charge\fR and optionally \fBbattery\&.runtime\fR, provided you specified a couple of the EXTRA ARGUMENTS listed above\&.
.sp
If you specify both \fBbattery\&.voltage\&.high\fR and \fBbattery\&.voltage\&.low\fR in \fBups.conf\fR(5), but don\(cqt enter \fBruntimecal\fR, it will guesstimate the state of charge by looking at the battery voltage alone\&. This is not reliable under load, as this only gives reasonably accurate readings if you disconnect the load, let the battery rest for a couple of minutes and then measure the open cell voltage\&. This just isn\(cqt practical if the power went out and the UPS is providing power for your systems\&.
.sp
.if n \{\
.RS 4
.\}
.nf
battery\&.voltage \- battery\&.voltage\&.low
battery\&.charge = \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- x 100 %
battery\&.voltage\&.high \- battery\&.voltage\&.low
.fi
.if n \{\
.RE
.\}
.sp
There is a way to get better readings without disconnecting the load but this requires to keep track on how much (and how fast) current is going in\- and out of the battery\&. If you specified the \fBruntimecal\fR, the driver will attempt to do this\&. Note however, that this heavily relies on the values you enter and that the UPS must be able to report the load as well\&. There are quite a couple of devices that report 0 % (or any other fixed value) at all times, in which case this obviously doesn\(cqt work\&.
.sp
The driver also has no way of determining the degradation of the battery capacity over time, so you\(cqll have to deal with this yourself (by adjusting the values in \fBruntimecal\fR)\&. Also note that the driver guesses the initial state of charge based on the battery voltage, so this may be less than 100 %, even when you are certain that they are full\&. There is just no way to reliably measure this between 0 and 100 % full charge\&.
.sp
This is better than nothing (but not by much)\&. If any of the above calculations is giving you incorrect readings, you are the one that put in the values in \fBups.conf\fR(5), so don\(cqt complain with the author\&. If you need something better, buy a UPS that reports \fBbattery\&.charge\fR and \fBbattery\&.runtime\fR all by itself without the help of a NUT driver\&.
.SH "NOTES FOR THE PREVIOUS USER OF MEGATEC DRIVERS"
.sp
The blazer drivers having replaced the megatec ones, some configuration changes may be required by users switching to blazer\&.
.sp
Part of this, the following megatec options, in ups\&.conf, have to be changed:
.PP
\fBbattvolts\fR
.RS 4
You need to use
\fIdefault\&.battery\&.voltage\&.high\fR
and
\fIdefault\&.battery\&.voltage\&.low\fR
.RE
.PP
\fBdtr and rts\fR
.RS 4
You need to use
\fIcablepower\fR
.RE
.PP
\fBignoreoff\fR
.RS 4
This parameter can simply be discarded, since it was a wrong understanding of the specification\&.
.RE
.SH "KNOWN PROBLEMS"
.sp
Some UPS commands aren\(cqt supported by all models\&. In most cases, the driver will send a message to the system log when the user tries to execute an unsupported command\&. Unfortunately, some models don\(cqt even provide a way for the driver to check for this, so the unsupported commands will silently fail\&.
.sp
Both the \fBload\&.off\fR and \fBshutdown\&.stayoff\fR instant commands are meant to turn the load off indefinitely\&. However, some UPS models don\(cqt allow this\&.
.sp
Some models report a bogus value for the beeper status (will always be \fIenabled\fR or \fIdisabled\fR)\&. So, the \fBbeeper\&.toggle\fR command may appear to have no effect in the status reported by the driver when, in fact, it is working fine\&.
.sp
The temperature and load value is known to be bogus in some models\&.
.SH "AUTHORS"
.sp
Arjen de Korte <adkorte\-guest at alioth\&.debian\&.org>, Alexander Gordeev <lasaine at lvk\&.cs\&.msu\&.su>
.SH "SEE ALSO"
.sp
\fBnutupsdrv\fR(8), \fBupsc\fR(8), \fBupscmd\fR(8), \fBupsrw\fR(8)
.SS "Internet Resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

295
docs/man/blazer.txt Normal file
View file

@ -0,0 +1,295 @@
BLAZER(8)
=========
NAME
----
blazer - Driver for Megatec/Q1 protocol serial (blazer_ser) and USB (blazer_usb) based UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
blazer driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
The blazer driver is known to work with various UPSes from Blazer, Energy
Sistem, Fenton Technologies, Mustek and many others. The NUT compatibility
table lists all the known supported models. Keep in mind, however, that
other models not listed there may also be supported, but haven't been tested.
All devices with a serial interface (use the *blazer_ser* driver) and
many with a USB interface (use the *blazer_usb* driver) are supported.
EXTRA ARGUMENTS
---------------
You may need to override or provide defaults for some values, depending on
the make and model of your UPS. The following are the ones that most likely
will need changing (see linkman:ups.conf[5]):
*default.battery.voltage.high =* 'value'::
Maximum battery voltage that is reached after about 12 to 24 hours charging.
If you want the driver to report a guesstimated *battery.charge*, you need
to specify this (see <<_battery_charge,BATTERY CHARGE>>).
*default.battery.voltage.low =* 'value'::
Minimum battery voltage just before the UPS automatically shuts down.
If you want the driver to report a guesstimated *battery.charge*, you need
to specify this (see <<_battery_charge,BATTERY CHARGE>>).
*default.battery.voltage.nominal =* 'value'::
*override.battery.voltage.nominal =* 'value'::
Some devices show a wrong nominal battery voltage (or none at all), so you may
need to override or set a default value.
*override.battery.packs =* 'value'::
Some devices report a part of the total battery voltage. For instance, if
*battery.voltage.nominal* is 24 V, but it reports a *battery.voltage*
of around 2 V, the number of *battery.packs* to correct this reading would
be 12. The driver will attempt to detect this automatically, but if this fails
somehow, you may want to override this value.
*ondelay =* 'value'::
Time to wait before switching on the UPS (minutes). Note that a value below 3
minutes, may cause earlier firmware versions to not switch on automatically,
so it defaults to 3 minutes.
*offdelay =* 'value'::
Time to wait before shutting down the UPS (seconds). This value is truncated
to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60
seconds). Defaults to 30 seconds.
*norating*::
Some UPSes will lock up if you attempt to read rating information from them.
Setting this flag will make the driver skip this step.
*novendor*::
Some UPSes will lock up if you attempt to read vendor information from them.
Setting this flag will make the driver skip this step.
*runtimecal =* 'value,value,value,value'::
Parameter used in the (optional) runtime estimation. This takes two runtimes
at different loads. Typically, this uses the runtime at full load and the
runtime at half load. For instance, if your UPS has a rated runtime of 240
seconds at full load and 720 seconds at half load, you would enter
+
runtimecal = 270,100,720,50
+
The first load should always be higher than the second. If you have values
available for loads other than 100 and 50 % respectively, you can use those
too, but keep them spaced apart as far as reasonably possible. Just don't
get too close to no load (prediction of runtime depends more on idle load for
the battery then).
*chargetime =* 'value'::
The time needed to fully recharge the battery after being fully discharged. If
not specified, the driver defaults to 43200 seconds (12 hours). Only used if
*runtimecal* is also specified.
*idleload =* 'value'::
Minimum battery load used by the driver to estimate the runtime. If not
specified, the driver defaults to 10%. Only used if *runtimecal* is also
specified.
SERIAL INTERFACE ONLY
---------------------
*cablepower =* 'string'::
By default the driver will set DTR and clear RTS ('normal'). If you find that
your UPS isn't detected or the communication with the UPS is unreliable, you may
try if clear DTR and set RTS ('reverse'), set DTR and RTS ('both') or
clear DTR and RTS ('none') improves this situation.
USB INTERFACE ONLY
------------------
*vendorid =* 'regex'::
*productid =* 'regex'::
*vendor =* 'regex'::
*product =* 'regex'::
*serial =* 'regex'::
Select a specific UPS, in case there is more than one connected via
USB. Each option specifies an extended regular expression (see
*regex(7)*) that must match the UPS's entire vendor/product/serial
string (minus any surrounding whitespace), or the whole 4-digit
hexadecimal code for vendorid and productid. Try *-DD* for
finding out the strings to match.
Examples:
-x vendor="Foo.Corporation.*"
-x vendorid=051d # (APC)
-x product=".*(Smart|Back)-?UPS.*"
*bus =* 'regex'::
Select a UPS on a specific USB bus or group of busses. The argument is
a regular expression that must match the bus name where the UPS is
connected (e.g. bus="002", bus="00[2-3]").
*subdriver =* 'string'::
Select a serial-over-USB subdriver to use. You have a choice between *phoenix*,
*ippon*, *cypress*, and *krauler*. When using this option, it is mandatory to also
specify the *vendorid* and *productid*.
UPS COMMANDS
------------
This driver supports some instant commands (see linkman:upscmd[8]):
*beeper.toggle*::
Toggle the UPS beeper. (Not available on some hardware.)
*load.on*::
Turn on the load immediately.
*load.off*::
Turn off the load immediately (see <<_known_problems,KNOWN PROBLEMS>>).
*shutdown.return* ['value']::
Turn off the load and return when power is back. Uses the timers defined by
*ondelay* and *offdelay*.
*shutdown.stayoff* ['value']::
Turn off the load and remain off (see <<_known_problems,KNOWN PROBLEMS>>). Uses
the timer defined by *offdelay*.
*shutdown.stop*::
Stop a shutdown in progress.
*test.battery.start.deep*::
Perform a long battery test (Not available on some hardware.)
*test.battery.start.quick*::
Perform a (10 second) battery test.
*test.battery.start* 'value'::
Perform a battery test for the duration of 'value' seconds (truncated to units of
60 seconds).
*test.battery.stop*::
Stop a running battery test (not available on some hardware.)
BATTERY CHARGE
--------------
Due to popular demand, this driver will report a guesstimated *battery.charge*
and optionally *battery.runtime*, provided you specified a couple of the
<<_extra_arguments,EXTRA ARGUMENTS>> listed above.
If you specify both *battery.voltage.high* and *battery.voltage.low* in
linkman:ups.conf[5], but don't enter *runtimecal*, it will guesstimate the state
of charge by looking at the battery voltage alone. This is not reliable under load,
as this only gives reasonably accurate readings if you disconnect the load, let the
battery rest for a couple of minutes and then measure the open cell voltage. This
just isn't practical if the power went out and the UPS is providing power for your
systems.
battery.voltage - battery.voltage.low
battery.charge = ------------------------------------------ x 100 %
battery.voltage.high - battery.voltage.low
There is a way to get better readings without disconnecting the load but this
requires to keep track on how much (and how fast) current is going in- and out of
the battery. If you specified the *runtimecal*, the driver will attempt to do
this. Note however, that this heavily relies on the values you enter and that the
UPS must be able to report the load as well. There are quite a couple of devices
that report 0 % (or any other fixed value) at all times, in which case this
obviously doesn't work.
The driver also has no way of determining the degradation of the battery capacity
over time, so you'll have to deal with this yourself (by adjusting the values
in *runtimecal*). Also note that the driver guesses the initial state of charge
based on the battery voltage, so this may be less than 100 %, even when you are
certain that they are full. There is just no way to reliably measure this between
0 and 100 % full charge.
This is better than nothing (but not by much). If any of the above calculations is
giving you incorrect readings, you are the one that put in the values in
linkman:ups.conf[5], so don't complain with the author. If you need something better,
buy a UPS that reports *battery.charge* and *battery.runtime* all by itself
without the help of a NUT driver.
NOTES FOR THE PREVIOUS USER OF MEGATEC DRIVERS
----------------------------------------------
The blazer drivers having replaced the megatec ones, some configuration
changes may be required by users switching to blazer.
Part of this, the following megatec options, in ups.conf, have to be changed:
*battvolts*::
You need to use 'default.battery.voltage.high' and 'default.battery.voltage.low'
*dtr and rts*::
You need to use 'cablepower'
*ignoreoff*::
This parameter can simply be discarded, since it was a wrong understanding
of the specification.
KNOWN PROBLEMS
--------------
Some UPS commands aren't supported by all models. In most cases, the driver
will send a message to the system log when the user tries to execute an
unsupported command. Unfortunately, some models don't even provide a way for
the driver to check for this, so the unsupported commands will silently
fail.
Both the *load.off* and *shutdown.stayoff* instant commands are meant to
turn the load off indefinitely. However, some UPS models don't allow this.
Some models report a bogus value for the beeper status (will always be 'enabled'
or 'disabled'). So, the *beeper.toggle* command may appear to have no effect
in the status reported by the driver when, in fact, it is working fine.
The temperature and load value is known to be bogus in some models.
AUTHORS
-------
Arjen de Korte <adkorte-guest at alioth.debian.org>,
Alexander Gordeev <lasaine at lvk.cs.msu.su>
SEE ALSO
--------
linkman:nutupsdrv[8], linkman:upsc[8], linkman:upscmd[8], linkman:upsrw[8]
Internet Resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

135
docs/man/clone.8 Normal file
View file

@ -0,0 +1,135 @@
'\" t
.\" Title: clone
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "CLONE" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clone \- UPS driver clone
.SH "NOTE"
.sp
This man page only documents the specific features of the clone driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "DESCRIPTION"
.sp
This driver, which sits on top of another driver socket, allows users to group clients to a particular outlet of a device and deal with this output as if it was a normal UPS\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following settings:
.PP
\fBload\&.off\fR=\fIcommand\fR
.RS 4
Recommended\&. Set the command on the "real" UPS driver that will be used to switch off the outlet\&. You need both
\fBload\&.off\fR
and
\fBload\&.on\fR
in order to power cycle the outlet\&. Otherwise, shutting down the clients powered by an outlet is a one way street (see
IMPORTANT)\&.
.RE
.PP
\fBload\&.on\fR=\fIcommand\fR
.RS 4
Recommended\&. Set the command on the "real" UPS driver that will be used to switch on the outlet\&. You need both
\fBload\&.off\fR
and
\fBload\&.on\fR
in order to power cycle the outlet\&. Otherwise, shutting down the clients powered by an outlet is a one way street (see
IMPORTANT)\&.
.RE
.PP
\fBload\&.status\fR=\fIvalue\fR
.RS 4
Recommended\&. Set the variable on the "real" UPS driver that will be used to indicate the outlet status (i\&.e\&. on/off)\&. If not specified, the clone driver will attempt to keep track of the outlet status, but this is less reliable\&.
.RE
.PP
\fBoffdelay\fR=\fInum\fR
.RS 4
Set the timer (in seconds) before the outlet is turned off after the shutdown condition (OB LB) for this outlet is met or a command to shutdown was issued\&. Defaults to 120 seconds\&.
.RE
.PP
\fBondelay\fR=\fInum\fR
.RS 4
Set the timer (in seconds) for the outlet to switch on in case the power returns after the oulet has been switched off\&. Defaults to 30 seconds\&.
.RE
.PP
\fBmincharge\fR=\fIvalue\fR
.RS 4
Set the remaining battery level when the clone UPS switches to LB (percent)\&.
.RE
.PP
\fBminruntime\fR=\fIvalue\fR
.RS 4
Set the remaining battery runtime when the clone UPS switches to LB (seconds)\&.
.RE
.SH "IMPLEMENTATION"
.sp
The port specification in the \fBups.conf\fR(5) reference the driver socket that the "real" UPS driver is using\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
[realups]
driver = usbhid\-ups
port = auto
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
[clone\-outlet\-1]
driver = clone
port = usbhid\-ups\-realups
load\&.on = outlet\&.1\&.load\&.on
load\&.off = outlet\&.1\&.load\&.off
load\&.status = outlet\&.1\&.status
[\&.\&.\&.]
.fi
.if n \{\
.RE
.\}
.SH "IMPORTANT"
.sp
Unlike a real UPS, you should \fBnot\fR configure a upsmon master for this driver\&. When a upsmon master sees the OB LB flags and tells the upsd server it is OK to initiate the shutdown sequence, the server will latch the FSD status and it will not be possible to restart the systems connected without restarting the upsd server\&.
.sp
This will be a problem if the power returns after the clone UPS initiated the shutdown sequence on it\(cqs outlet, but returns before the real UPS begins shutting down\&. The solution is in the clone driver, that will insert the FSD flag if needed without the help of a upsmon master\&.
.SH "CAVEATS"
.sp
The clone UPS will follow the status on the real UPS driver\&. You can only make the clone UPS shutdown earlier than the real UPS driver, not later\&. If the real UPS driver initiates a shutdown, the clone UPS driver will immediately follow\&.
.sp
Be aware that the commands to shutdown/restart an outlet on the real UPS drivers are not affected, so if you tell the real UPS driver to shutdown the outlet of the clone UPS driver, your clients will lose power without warning\&.
.SH "AUTHOR"
.sp
Arjen de Korte <adkorte\-guest@alioth\&.debian\&.org>
.SH "SEE ALSO"
.sp
\fBupscmd\fR(1), \fBupsrw\fR(1), \fBups.conf\fR(5), \fBnutupsdrv\fR(8)
.SS "Internet Resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

115
docs/man/clone.txt Normal file
View file

@ -0,0 +1,115 @@
CLONE(8)
========
NAME
----
clone - UPS driver clone
NOTE
----
This man page only documents the specific features of the
clone driver. For information about the core driver, see
linkman:nutupsdrv[8].
DESCRIPTION
-----------
This driver, which sits on top of another driver socket, allows users to group
clients to a particular outlet of a device and deal with this output as if it
was a normal UPS.
EXTRA ARGUMENTS
---------------
This driver supports the following settings:
*load.off*='command'::
Recommended. Set the command on the "real" UPS driver that will be used to
switch off the outlet. You need both *load.off* and *load.on* in
order to power cycle the outlet. Otherwise, shutting down the clients
powered by an outlet is a one way street (see <<_important,IMPORTANT>>).
*load.on*='command'::
Recommended. Set the command on the "real" UPS driver that will be used to
switch on the outlet. You need both *load.off* and *load.on* in
order to power cycle the outlet. Otherwise, shutting down the clients
powered by an outlet is a one way street (see <<_important,IMPORTANT>>).
*load.status*='value'::
Recommended. Set the variable on the "real" UPS driver that will be used
to indicate the outlet status (i.e. on/off). If not specified, the clone
driver will attempt to keep track of the outlet status, but this is less
reliable.
*offdelay*='num'::
Set the timer (in seconds) before the outlet is turned off after the
shutdown condition (+OB LB+) for this outlet is met or a command to shutdown
was issued. Defaults to 120 seconds.
*ondelay*='num'::
Set the timer (in seconds) for the outlet to switch on in case the power
returns after the oulet has been switched off. Defaults to 30 seconds.
*mincharge*='value'::
Set the remaining battery level when the clone UPS switches to LB
(percent).
*minruntime*='value'::
Set the remaining battery runtime when the clone UPS switches to LB
(seconds).
IMPLEMENTATION
--------------
The port specification in the linkman:ups.conf[5] reference the driver
socket that the "real" UPS driver is using. For example:
[realups]
driver = usbhid-ups
port = auto
[clone-outlet-1]
driver = clone
port = usbhid-ups-realups
load.on = outlet.1.load.on
load.off = outlet.1.load.off
load.status = outlet.1.status
[...]
IMPORTANT
---------
Unlike a real UPS, you should *not* configure a upsmon master for this
driver. When a upsmon master sees the OB LB flags and tells the upsd server
it is OK to initiate the shutdown sequence, the server will latch the FSD
status and it will not be possible to restart the systems connected without
restarting the upsd server.
This will be a problem if the power returns after the clone UPS initiated
the shutdown sequence on it's outlet, but returns before the real UPS begins
shutting down. The solution is in the clone driver, that will insert the
FSD flag if needed without the help of a upsmon master.
CAVEATS
-------
The clone UPS will follow the status on the real UPS driver. You can only
make the clone UPS shutdown earlier than the real UPS driver, not later.
If the real UPS driver initiates a shutdown, the clone UPS driver will
immediately follow.
Be aware that the commands to shutdown/restart an outlet on the real UPS
drivers are not affected, so if you tell the real UPS driver to shutdown
the outlet of the clone UPS driver, your clients will lose power without
warning.
AUTHOR
------
Arjen de Korte <adkorte-guest@alioth.debian.org>
SEE ALSO
--------
linkman:upscmd[1],
linkman:upsrw[1],
linkman:ups.conf[5],
linkman:nutupsdrv[8]
Internet Resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

145
docs/man/dummy-ups.8 Normal file
View file

@ -0,0 +1,145 @@
'\" t
.\" Title: dummy-ups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "DUMMY\-UPS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dummy-ups \- Driver for multi\-purpose UPS emulation
.SH "NOTE"
.sp
This man page only documents the specific features of the dummy\-ups driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "DESCRIPTION"
.sp
This program is a multi\-purpose UPS emulation tool\&. Its behavior depends on the running mode:
.SS "Dummy Mode"
.sp
\fBdummy\-ups\fR looks like a standard device driver to \fBupsd\fR(8) and allows to change any value for testing purposes\&. It is both interactive, controllable through the \fBupsrw\fR(1) and \fBupscmd\fR(1) commands (or equivalent graphical tool), and batchable through script files\&. It can be configured, launched and used as any other real driver\&. This mode is mostly useful for development and testing purposes\&.
.SS "Repeater Mode"
.sp
\fBdummy\-ups\fR acts as a NUT client, simply forwarding data\&. This can be useful for supervision purposes\&. This can also allow some load sharing between several UPS instances, using a point\-to\-point communication with the UPS\&.
.SH "IMPLEMENTATION"
.sp
The port specification depends on the running mode, and allows the driver to select the right mode\&.
.SS "Dummy Mode"
.sp
Port is a definition file name for \fBdummy\-ups\fR\&. This can either be an absolute or a relative path name\&. In the latter case the NUT sysconfig directory (ie /etc/nut, /usr/local/ups/etc, \&...) is prepended\&.
.sp
For instance:
.sp
.if n \{\
.RS 4
.\}
.nf
[dummy]
driver = dummy\-ups
port = evolution500\&.dev
desc = "dummy\-ups in dummy mode"
.fi
.if n \{\
.RE
.\}
.sp
This file is generally named "something\&.dev"\&. It contains a list of all valid data and associated values, and has the same format as an \fBupsc\fR(8) dump (<varname>: <value>)\&. So you can easilly create definition files from an existing UPS using "upsc > file\&.dev"\&. It can also be empty, in which case only a basic set of data is available: device\&.\fB, driver\&.\fR, ups\&.mfr, ups\&.model, ups\&.status
.sp
Samples definition files are available in the "data" directory of the nut source tree, and generally in the sysconfig directory of your system distribution\&.
.sp
Since \fBdummy\-ups\fR will loop on reading this file, you can dynamically modify it to interact with the driver\&. This will avoid message spam into your system log files, if you are using NUT default configuration\&.
.sp
You can also use the "TIMER <seconds>" instruction to create scheduled events sequences\&. For example, the following sequence will loop on switching ups\&.status between "OL", "OB" and "OB LB" every minute:
.sp
.if n \{\
.RS 4
.\}
.nf
ups\&.status: OL
TIMER 60
ups\&.status: OB
TIMER 60
ups\&.status: LB
TIMER 60
.fi
.if n \{\
.RE
.\}
.sp
It is wise to end the script with a TIMER\&. Otherwise dummy\-ups will directly go back to the beginning of the file\&.
.SS "Repeater Mode"
.sp
Port is the name of a remote UPS, using the NUT form, ie:
.sp
.if n \{\
.RS 4
.\}
.nf
<upsname>[@<hostname>[:<port>]]
.fi
.if n \{\
.RE
.\}
.sp
For instance:
.sp
.if n \{\
.RS 4
.\}
.nf
[repeater]
driver = dummy\-ups
port = ups@hostname
desc = "dummy\-ups in repeater mode"
.fi
.if n \{\
.RE
.\}
.SH "INTERACTION"
.sp
Once the driver is loaded in dummy mode, you can change any variables, except those of the driver\&.* and server\&.* collections\&. You can do this by either editing the definition file, or use the \fBupsrw\fR(1) and \fBupscmd\fR(1) commands\&.
.sp
Note that in simulation mode, new variables can be added on the fly, by adding these to the definition file\&. Conversely, if you need to remove variable (such as transient ones, like ups\&.alarm), simply update these by setting an empty value\&. As a result, they will get removed from the data\&.
.sp
In repeater mode, the driver acts according to the capabilities of the UPS, and so support the same instant commands and settable values\&.
.SH "BACKGROUND"
.sp
This driver was written in one evening to replace the previous dummycons testing driver\&. It was too limited and required to work from a terminal to interact\&.
.sp
\fBdummy\-ups\fR is useful for NUT client development, and other testing purpose\&.
.sp
It also helps the NUT Quality Assurance effort, by automating some tests on the NUT framework\&.
.sp
It now offers a repeater mode\&. This will help in building the Meta UPS approach, which allows to build a virtual device, composed of several other devices (either UPS, PDUs)\&.
.SH "BUGS"
.sp
Instant commands are not yet supported in Dummy Mode, and data need name/value checking enforcement, as well as boundaries or enumeration definition\&.
.SH "AUTHOR"
.sp
Arnaud Quette
.SH "SEE ALSO"
.sp
\fBupscmd\fR(1), \fBupsrw\fR(1), \fBups.conf\fR(5), \fBnutupsdrv\fR(8)
.SS "Internet Resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

149
docs/man/dummy-ups.txt Normal file
View file

@ -0,0 +1,149 @@
DUMMY-UPS(8)
============
NAME
----
dummy-ups - Driver for multi-purpose UPS emulation
NOTE
----
This man page only documents the specific features of the
dummy-ups driver. For information about the core driver, see
linkman:nutupsdrv[8].
DESCRIPTION
-----------
This program is a multi-purpose UPS emulation tool.
Its behavior depends on the running mode:
Dummy Mode
~~~~~~~~~~
*dummy-ups* looks like a standard device driver to linkman:upsd[8] and
allows to change any value for testing purposes. It is both interactive,
controllable through the linkman:upsrw[1] and linkman:upscmd[1] commands (or
equivalent graphical tool), and batchable through script files. It can be
configured, launched and used as any other real driver. This mode is mostly
useful for development and testing purposes.
Repeater Mode
~~~~~~~~~~~~~
*dummy-ups* acts as a NUT client, simply forwarding data. This can be useful
for supervision purposes. This can also allow some load sharing between several
UPS instances, using a point-to-point communication with the UPS.
IMPLEMENTATION
--------------
The port specification depends on the running mode, and allows the driver to
select the right mode.
Dummy Mode
~~~~~~~~~~
Port is a definition file name for *dummy-ups*. This can either
be an absolute or a relative path name. In the latter case the NUT
sysconfig directory (ie /etc/nut, /usr/local/ups/etc, ...) is prepended.
For instance:
[dummy]
driver = dummy-ups
port = evolution500.dev
desc = "dummy-ups in dummy mode"
This file is generally named "something.dev". It contains a list of all
valid data and associated values, and has the same format as an linkman:upsc[8]
dump (<varname>: <value>). So you can easilly create definition
files from an existing UPS using "upsc > file.dev".
It can also be empty, in which case only a basic set of data is available:
device.*, driver.*, ups.mfr, ups.model, ups.status
Samples definition files are available in the "data" directory of the nut source
tree, and generally in the sysconfig directory of your system distribution.
Since *dummy-ups* will loop on reading this file, you can dynamically modify
it to interact with the driver. This will avoid message spam into your
system log files, if you are using NUT default configuration.
You can also use the "TIMER <seconds>" instruction to create scheduled events
sequences. For example, the following sequence will loop on switching ups.status
between "OL", "OB" and "OB LB" every minute:
ups.status: OL
TIMER 60
ups.status: OB
TIMER 60
ups.status: LB
TIMER 60
It is wise to end the script with a TIMER. Otherwise dummy-ups will directly
go back to the beginning of the file.
Repeater Mode
~~~~~~~~~~~~~
Port is the name of a remote UPS, using the NUT form, ie:
<upsname>[@<hostname>[:<port>]]
For instance:
[repeater]
driver = dummy-ups
port = ups@hostname
desc = "dummy-ups in repeater mode"
INTERACTION
-----------
Once the driver is loaded in dummy mode, you can change any variables, except
those of the driver.* and server.* collections.
You can do this by either editing the definition file, or use the
linkman:upsrw[1] and linkman:upscmd[1] commands.
Note that in simulation mode, new variables can be added on the fly, by
adding these to the definition file. Conversely, if you need to remove
variable (such as transient ones, like ups.alarm), simply update these
by setting an empty value. As a result, they will get removed from the data.
In repeater mode, the driver acts according to the capabilities of the UPS, and
so support the same instant commands and settable values.
BACKGROUND
----------
This driver was written in one evening to replace the previous dummycons
testing driver. It was too limited and required to work from a terminal to
interact.
*dummy-ups* is useful for NUT client development, and other testing purpose.
It also helps the NUT Quality Assurance effort, by automating some tests on the
NUT framework.
It now offers a repeater mode. This will help in building the Meta UPS approach,
which allows to build a virtual device, composed of several other devices
(either UPS, PDUs).
BUGS
----
Instant commands are not yet supported in Dummy Mode, and data need name/value
checking enforcement, as well as boundaries or enumeration definition.
AUTHOR
------
Arnaud Quette
SEE ALSO
--------
linkman:upscmd[1],
linkman:upsrw[1],
linkman:ups.conf[5],
linkman:nutupsdrv[8]
Internet Resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

50
docs/man/etapro.8 Normal file
View file

@ -0,0 +1,50 @@
'\" t
.\" Title: etapro
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "ETAPRO" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
etapro \- Driver for ETA UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the etapro driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports ETA UPS equipment with the "PRO" option for smart mode\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "AUTHOR"
.sp
Marek Michalkiewicz <marekm@amelek\&.gda\&.pl>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

35
docs/man/etapro.txt Normal file
View file

@ -0,0 +1,35 @@
ETAPRO(8)
=========
NAME
----
etapro - Driver for ETA UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
etapro driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports ETA UPS equipment with the "PRO" option for smart mode.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
AUTHOR
------
Marek Michalkiewicz <marekm@amelek.gda.pl>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

53
docs/man/everups.8 Normal file
View file

@ -0,0 +1,53 @@
'\" t
.\" Title: everups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "EVERUPS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
everups \- Driver for Ever UPS models
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the everups driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver should recognize the NET *\-DPC and AP *\-PRO models\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "BUGS"
.sp
This UPS can only switch off the load if it\(cqs running on battery\&. This means you may be vulnerable to power races if your shutdown scripts don\(cqt sleep and force a reboot\&.
.SH "AUTHOR"
.sp
Bartek Szady <bszx@bszxdomain\&.edu\&.eu\&.org>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

44
docs/man/everups.txt Normal file
View file

@ -0,0 +1,44 @@
EVERUPS(8)
==========
NAME
----
everups - Driver for Ever UPS models
NOTE
----
This man page only documents the hardware-specific features of the
everups driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver should recognize the NET *-DPC and AP *-PRO models.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
BUGS
----
This UPS can only switch off the load if it's running on battery. This
means you may be vulnerable to power races if your shutdown scripts
don't sleep and force a reboot.
AUTHOR
------
Bartek Szady <bszx@bszxdomain.edu.eu.org>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

50
docs/man/gamatronic.8 Normal file
View file

@ -0,0 +1,50 @@
'\" t
.\" Title: gamatronic
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "GAMATRONIC" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gamatronic \- Driver for Gamatronic UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the gamatronic driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
Various \- Rebuilt to work with Gamatronic UPS Units, but should recognize any UPS that speaks the SEC protocol at 1200\-19200 bps\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "AUTHOR"
.sp
Nadav Moskovitch <blutz@walla\&.com>
.SH "SEE ALSO"
.SS "The core driver"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

38
docs/man/gamatronic.txt Normal file
View file

@ -0,0 +1,38 @@
GAMATRONIC(8)
=============
NAME
----
gamatronic - Driver for Gamatronic UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
gamatronic driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
Various - Rebuilt to work with Gamatronic UPS Units, but should recognize any
UPS that speaks the SEC protocol at 1200-19200 bps.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
AUTHOR
------
Nadav Moskovitch <blutz@walla.com>
SEE ALSO
--------
The core driver
~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources
~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

593
docs/man/genericups.8 Normal file
View file

@ -0,0 +1,593 @@
'\" t
.\" Title: genericups
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "GENERICUPS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
genericups \- Driver for contact\-closure UPS equipment
.SH "NOTE"
.sp
This man page only documents the specific features of the genericups driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports hardware from many different manufacturers as it only uses the very simplest of signaling schemes\&. Contact closure refers to a kind of interface where basic high/low signals are provided to indicate status\&. This kind of UPS can only report line power and battery status\&.
.sp
This means that you will only get the essentials in ups\&.status: OL, OB, and LB\&. Anything else requires a smarter UPS\&.
.SH "CABLING"
.sp
Cabling is different for every kind of UPS\&. See the table below for information on what is known to work with a given UPS type\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following settings in the \fBups.conf\fR(5):
.PP
upstype=\fItype\fR
.RS 4
Required\&. Configures the driver for a specific kind of UPS\&. See the
UPS Types
section below for more information on which entries are available\&.
.RE
.PP
mfr=\fIstring\fR
.RS 4
Optional\&. The very nature of a generic UPS driver sometimes means that the stock manufacturer data has no relation to the actual hardware that is attached\&. With the
mfr
setting, you can change the value that is seen by clients that monitor this UPS\&.
.RE
.PP
model=\fIstring\fR
.RS 4
Optional\&. This is like
mfr
above, but it overrides the model string instead\&.
.RE
.PP
serial=\fIstring\fR
.RS 4
Optional\&. This is like
mfr
above and intended to record the identification string of the UPS\&. It is titled "serial" because usually this string is referred to as the serial number\&.
.RE
.PP
sdtime=\fIvalue\fR
.RS 4
Optional\&. The driver will sleep for this many seconds after setting the shutdown signal\&. This is necessary for some hardware which requires a sustained level to activate the shutdown sequence\&.
.sp
The default behavior of the driver is to exit immediately\&. If this doesn\(cqt reliably trigger a shutdown in your UPS hardware, use this setting to give it more time to react\&.
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
very large values for sdtime may create warnings from upsdrvctl if it gets tired of waiting for the driver to return\&.
.sp .5v
.RE
.SH "CUSTOM CONFIGURATIONS"
.sp
You may override the values for CP, OL, LB, and SD by defining them in the \fBups.conf\fR(5) after the upstype setting\&.
.sp
For example, to set the cable power to DTR and the low battery value to DCD, it would look like this:
.sp
.if n \{\
.RS 4
.\}
.nf
CP = DTR
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
LB = DCD
.fi
.if n \{\
.RE
.\}
.sp
Recognized values for input lines are CTS, DCD, and RNG\&. Recognized values for output lines are DTR, RTS, and ST\&. See below for more about what these signals mean\&.
.sp
These values may be negated for active low signals\&. That is, "LB=\-DCD" recognizes a low battery condition when DCD is not held high\&.
.SH "TYPE INFORMATION"
.sp
The essence of a UPS definition in this driver is how it uses the serial lines that are available\&. These are the abbreviations you will see below:
.PP
OL
.RS 4
On line (no power failure) (opposite of OB \- on battery)
.RE
.PP
LB
.RS 4
Low battery
.RE
.PP
SD
.RS 4
Shutdown load
.RE
.PP
CP
.RS 4
Cable power (must be present for cable to have valid reading)
.RE
.PP
CTS
.RS 4
Clear to Send\&. Received from the UPS\&.
.RE
.PP
RTS
.RS 4
Ready to Send\&. Sent by the PC\&.
.RE
.PP
DCD
.RS 4
Data Carrier Detect\&. Received from the UPS\&.
.RE
.PP
RNG
.RS 4
Ring indicate\&. Received from the UPS\&.
.RE
.PP
DTR
.RS 4
Data Terminal Ready\&. Sent by the PC\&.
.RE
.PP
ST
.RS 4
Send a BREAK on the transmit data line
.RE
.sp
A "\-" in front of a signal name (like \-RNG) means that the indicated condition is signaled with an active low signal\&. For example, [LB=\-RNG] means the battery is low when the ring indicate line goes low, and that the battery is OK when that line is held high\&.
.SH "UPS TYPES"
.sp
0 = UPSonic LAN Saver 600
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR+RTS] [OL=\-CTS] [LB=DCD] [SD=DTR]
.fi
.if n \{\
.RE
.\}
.sp
1 = APC Back\-UPS/Back\-UPS Pro/Smart\-UPS with 940\-0095A/C cable
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=\-RNG] [LB=DCD] [SD=RTS]
.fi
.if n \{\
.RE
.\}
.sp
2 = APC Back\-UPS/Back\-UPS Pro/Smart\-UPS with 940\-0020B cable
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=RTS] [OL=\-CTS] [LB=DCD] [SD=DTR+RTS]
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Type 2 has also been reported to work with the 940\-0020C cable\&.
.fi
.if n \{\
.RE
.\}
.sp
3 = PowerTech Comp1000 with DTR cable power
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=CTS] [LB=DCD] [SD=DTR+RTS]
.fi
.if n \{\
.RE
.\}
.sp
4 = Generic RUPS Model
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=RTS] [OL=CTS] [LB=\-DCD] [SD=\-RTS]
.fi
.if n \{\
.RE
.\}
.sp
5 = Tripp Lite UPS with Lan2\&.2 interface (black 73\-0844 cable)
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=CTS] [LB=\-DCD] [SD=DTR+RTS]
.fi
.if n \{\
.RE
.\}
.sp
6 = Best Patriot with INT51 cable
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=CTS] [LB=\-DCD] [SD=RTS]
.fi
.if n \{\
.RE
.\}
.sp
7 = CyberPower Power99 Also Upsonic Power Guardian PG\-500, Belkin Belkin Home Office, F6H350\-SER, F6H500\-SER, F6H650\-SER
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=RTS] [OL=CTS] [LB=\-DCD] [SD=DTR]
.fi
.if n \{\
.RE
.\}
.sp
8 = Nitram Elite 500
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=CTS] [LB=\-DCD] [SD=???]
.fi
.if n \{\
.RE
.\}
.sp
9 = APC Back\-UPS/Back\-UPS Pro/Smart\-UPS with 940\-0023A cable
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=none] [OL=\-DCD] [LB=CTS] [SD=RTS]
.fi
.if n \{\
.RE
.\}
.sp
10 = Victron Lite with crack cable
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=RTS] [OL=CTS] [LB=\-DCD] [SD=DTR]
.fi
.if n \{\
.RE
.\}
.sp
11 = Powerware 3115
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=\-CTS] [LB=\-DCD] [SD=ST]
.fi
.if n \{\
.RE
.\}
.sp
12 = APC Back\-UPS Office with 940\-0119A cable
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=RTS] [OL=\-CTS] [LB=DCD] [SD=DTR]
.fi
.if n \{\
.RE
.\}
.sp
13 = RPT Repoteck RPT\-800A/RPT\-162A
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR+RTS] [OL=DCD] [LB=\-CTS] [SD=ST]
.fi
.if n \{\
.RE
.\}
.sp
14 = Online P\-series
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=DCD] [LB=\-CTS] [SD=RTS]
.fi
.if n \{\
.RE
.\}
.sp
15 = Powerware 5119, 5125
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=CTS] [LB=\-DCD] [SD=ST]
.fi
.if n \{\
.RE
.\}
.sp
16 = Nitram Elite 2002
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR+RTS] [OL=CTS] [LB=\-DCD] [SD=???]
.fi
.if n \{\
.RE
.\}
.sp
17 = PowerKinetics 9001
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=CTS] [LB=\-DCD] [SD=???]
.fi
.if n \{\
.RE
.\}
.sp
18 = TrippLite Omni 450LAN with Martin\(cqs cabling
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=CTS] [LB=DCD] [SD=none]
.fi
.if n \{\
.RE
.\}
.sp
19 = Fideltronic Ares Series
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=CTS] [LB=\-DCD] [SD=RTS]
.fi
.if n \{\
.RE
.\}
.sp
20 = Powerware 5119 RM
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=DTR] [OL=\-CTS] [LB=DCD] [SD=ST]
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Check docs/cables/powerware\&.txt
.fi
.if n \{\
.RE
.\}
.sp
21 = Generic RUPS 2000 (Megatec M2501 cable)
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=RTS] [OL=CTS] [LB=\-DCD] [SD=RTS+DTR]
.fi
.if n \{\
.RE
.\}
.sp
22 = Gamatronic All models with alarm interface (also CyberPower SL series)
.sp
.if n \{\
.RS 4
.\}
.nf
[CP=RTS] [OL=CTS] [LB=\-DCD] [SD=DTR]
.fi
.if n \{\
.RE
.\}
.SH "SIMILAR MODELS"
.sp
Many different UPS companies make models with similar interfaces\&. The RUPS cable seems to be especially popular in the "power strip" variety of UPS found in office supply stores\&. If your UPS works with an entry in the table above, but the model or manufacturer information don\(cqt match, don\(cqt despair\&. You can fix that easily by using the mfr and model variables documented above in your \fBups.conf\fR(5)\&.
.SH "TESTING COMPATIBILITY"
.sp
If your UPS isn\(cqt listed above, you can try going through the list until you find one that works\&. There is a lot of cable and interface reuse in the UPS world, and you may find a match\&.
.sp
To do this, first make sure nothing important is plugged into the outlets on the UPS, as you may inadvertently switch it off\&. Definitely make sure that the computer you\(cqre using is not plugged into that UPS\&. Plug in something small like a lamp so you know when power is being supplied to the outlets\&.
.sp
Now, you can either attempt to make an educated guess based on the documentation your manufacturer has provided (if any), or just start going down the list\&.
.SS "Step 1"
.sp
Pick a driver to try from the list (genericups \-h) and go to step 2\&.
.SS "Step 2"
.sp
Start the driver with the type you want to try \-
.sp
.if n \{\
.RS 4
.\}
.nf
genericups \-x upstype=n /dev/port
.fi
.if n \{\
.RE
.\}
.sp
Let upsd sync up (watch the syslog), and then run upsc to see what it found\&. If the STATUS is right (should be OL for on line), continue to Step 3, otherwise go back to step 1\&.
.sp
Alternatively, you can run genericups in debug mode \-
.sp
.if n \{\
.RS 4
.\}
.nf
genericups \-DDDDD \-x upstype=n /dev/port
.fi
.if n \{\
.RE
.\}
.sp
In this mode it will be running in the foreground and continuously display the line and battery status of the UPS\&.
.SS "Step 3"
.sp
Disconnect the UPS from the wall/mains power\&. This is easiest if you have a switched outlet in between it and the wall, but you can also just pull the plug to test\&. The lamp should stay lit, and the status should switch to "OB"\&. If the lamp went out or the status didn\(cqt go to "OB" within about 15 seconds, go to Step 1\&. Otherwise, continue to Step 4\&.
.SS "Step 4"
.sp
At this point, we know that OL and OB work\&. If nothing else beyond this point works, you at least know what your OL/OB value should be\&.
.sp
Wait for the UPS to start complaining about a low battery\&. Depending on the size of your UPS battery and the lamp\(cqs bulb, this could take awhile\&. It should start complaining audibly at some point\&. When this happens, STATUS should show "OB LB" within 15 seconds\&. If not, go to Step 1, otherwise continue to Step 5\&.
.SS "Step 5"
.sp
So far: OL works, OB works, and LB works\&.
.sp
With the UPS running on battery, run the genericups driver with the \-k switch to shut it down\&.
.sp
.if n \{\
.RS 4
.\}
.nf
genericups \-x upstype=n \-k /dev/port
.fi
.if n \{\
.RE
.\}
.sp
If the UPS turns off the lamp, you\(cqre done\&. At this point, you have verified that the shutdown sequence actually does what you want\&. You can start using the genericups driver with this type number for normal operations\&.
.sp
You should use your findings to add a section to your ups\&.conf\&. Here is a quick example:
.sp
.if n \{\
.RS 4
.\}
.nf
[myups]
driver = genericups
port = /dev/ttyS0
upstype = 1
.fi
.if n \{\
.RE
.\}
.sp
Change the port and upstype values to match your system\&.
.SH "NEW SUPPORT"
.sp
If the above testing sequence fails, you will probably need to create a new entry to support your hardware\&. All UPS types are determined from the table in the genericups\&.h file in the source tree\&.
.sp
On a standard 9 pin serial port, there are 6 lines that are used as the standard "high/low" signal levels\&. 4 of them are incoming (to the PC, from the UPS), and the other 2 are outgoing (to the UPS, from the PC)\&. The other 3 are the receive/transmit lines and the ground\&.
.sp
Be aware that many manufacturers remap pins within the cable\&. If you have any doubts, a quick check with a multimeter should confirm whether the cable is straight\-through or not\&. Another thing to keep in mind is that some cables have electronics in them to do special things\&. Some have resistors and transistors on board to change behavior depending on what\(cqs being supplied by the PC\&.
.SH "SPECIFIC MODEL NOTES"
.sp
These have been contributed by users of this driver\&.
.sp
The Centralion CL series may power down the load if the driver starts up with the UPS running on battery as the default line settings contain the shutdown sequence\&. \- Neil Muller
.sp
The Tripp\-Lite Internet Office 700 must be used with the black 73\-0844 cable instead of the gray 73\-0743 cable\&. This entry should work with any of their models with the Lan 2\&.2 interface \- see the sticker by the DB9 connector on the UPS\&. \- Stephen Brown
.sp
Type 5 should work with the Tripp\-Lite Lan 2\&.1 interface and the 73\-0724 cable\&. This was tested with the OmniSmart 675 PNP on Red Hat 7\&.2\&. \- Q Giese
.sp
Types 7 and 10 should both work with the PhoenixTec A1000\&.
.SH "BUGS"
.sp
There is no way to reliably detect a contact\-closure UPS\&. This means the driver will start up happily even if no UPS is detected\&. It also means that if the connection between the UPS and computer is interrupted, you may not be able to sense this in software\&.
.sp
Most contact\-closure UPSes will not power down the load if the line power is present\&. This can create a race when using slave \fBupsmon\fR(8) systems\&. See the \fBupsmon\fR(8) man page for more information\&.
.sp
The solution to both of these problems is to upgrade to a smart protocol UPS of some kind that allows detection and proper load cycling on command\&.
.SH "SEE ALSO"
.SS "The core driver"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

381
docs/man/genericups.txt Normal file
View file

@ -0,0 +1,381 @@
GENERICUPS(8)
=============
NAME
----
genericups - Driver for contact-closure UPS equipment
NOTE
----
This man page only documents the specific features of the genericups
driver. For information about the core driver, see linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports hardware from many different manufacturers as it only
uses the very simplest of signaling schemes. Contact closure refers to a
kind of interface where basic high/low signals are provided to indicate
status. This kind of UPS can only report line power and battery status.
This means that you will only get the essentials in ups.status: OL, OB,
and LB. Anything else requires a smarter UPS.
CABLING
-------
Cabling is different for every kind of UPS. See the table below for
information on what is known to work with a given UPS type.
EXTRA ARGUMENTS
---------------
This driver supports the following settings in the linkman:ups.conf[5]:
upstype='type'::
Required. Configures the driver for a specific kind of UPS. See the
<<_ups_types,UPS Types>> section below for more information on which entries
are available.
mfr='string'::
Optional. The very nature of a generic UPS driver sometimes means that
the stock manufacturer data has no relation to the actual hardware that is
attached. With the `mfr` setting, you can change the value that is seen by
clients that monitor this UPS.
model='string'::
Optional. This is like `mfr` above, but it overrides the model string
instead.
serial='string'::
Optional. This is like `mfr` above and intended to record the identification
string of the UPS. It is titled "serial" because usually this string is
referred to as the serial number.
sdtime='value'::
Optional. The driver will sleep for this many seconds after setting the
shutdown signal. This is necessary for some hardware which requires a
sustained level to activate the shutdown sequence.
+
The default behavior of the driver is to exit immediately. If this
doesn't reliably trigger a shutdown in your UPS hardware, use this
setting to give it more time to react.
NOTE: very large values for +sdtime+ may create warnings from upsdrvctl if
it gets tired of waiting for the driver to return.
CUSTOM CONFIGURATIONS
---------------------
You may override the values for CP, OL, LB, and SD by defining them in
the linkman:ups.conf[5] after the upstype setting.
For example, to set the cable power to DTR and the low battery value to
DCD, it would look like this:
CP = DTR
LB = DCD
Recognized values for input lines are CTS, DCD, and RNG. Recognized
values for output lines are DTR, RTS, and ST. See below for more about
what these signals mean.
These values may be negated for active low signals. That is, "LB=-DCD"
recognizes a low battery condition when DCD is not held high.
TYPE INFORMATION
----------------
The essence of a UPS definition in this driver is how it uses the serial
lines that are available. These are the abbreviations you will see below:
OL:: On line (no power failure) (opposite of OB - on battery)
LB:: Low battery
SD:: Shutdown load
CP:: Cable power (must be present for cable to have valid reading)
CTS:: Clear to Send. Received from the UPS.
RTS:: Ready to Send. Sent by the PC.
DCD:: Data Carrier Detect. Received from the UPS.
RNG:: Ring indicate. Received from the UPS.
DTR:: Data Terminal Ready. Sent by the PC.
ST:: Send a BREAK on the transmit data line
A "-" in front of a signal name (like -RNG) means that the indicated
condition is signaled with an active low signal. For example, [LB=-RNG]
means the battery is low when the ring indicate line goes low, and that
the battery is OK when that line is held high.
UPS TYPES
---------
0 = UPSonic LAN Saver 600
[CP=DTR+RTS] [OL=-CTS] [LB=DCD] [SD=DTR]
1 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0095A/C cable
[CP=DTR] [OL=-RNG] [LB=DCD] [SD=RTS]
2 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0020B cable
[CP=RTS] [OL=-CTS] [LB=DCD] [SD=DTR+RTS]
Type 2 has also been reported to work with the 940-0020C cable.
3 = PowerTech Comp1000 with DTR cable power
[CP=DTR] [OL=CTS] [LB=DCD] [SD=DTR+RTS]
4 = Generic RUPS Model
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=-RTS]
5 = Tripp Lite UPS with Lan2.2 interface (black 73-0844 cable)
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=DTR+RTS]
6 = Best Patriot with INT51 cable
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=RTS]
7 = CyberPower Power99
Also Upsonic Power Guardian PG-500, Belkin Belkin Home Office,
F6H350-SER, F6H500-SER, F6H650-SER
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
8 = Nitram Elite 500
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=???]
9 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0023A cable
[CP=none] [OL=-DCD] [LB=CTS] [SD=RTS]
10 = Victron Lite with crack cable
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
11 = Powerware 3115
[CP=DTR] [OL=-CTS] [LB=-DCD] [SD=ST]
12 = APC Back-UPS Office with 940-0119A cable
[CP=RTS] [OL=-CTS] [LB=DCD] [SD=DTR]
13 = RPT Repoteck RPT-800A/RPT-162A
[CP=DTR+RTS] [OL=DCD] [LB=-CTS] [SD=ST]
14 = Online P-series
[CP=DTR] [OL=DCD] [LB=-CTS] [SD=RTS]
15 = Powerware 5119, 5125
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=ST]
16 = Nitram Elite 2002
[CP=DTR+RTS] [OL=CTS] [LB=-DCD] [SD=???]
17 = PowerKinetics 9001
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=???]
18 = TrippLite Omni 450LAN with Martin's cabling
[CP=DTR] [OL=CTS] [LB=DCD] [SD=none]
19 = Fideltronic Ares Series
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=RTS]
20 = Powerware 5119 RM
[CP=DTR] [OL=-CTS] [LB=DCD] [SD=ST]
Check docs/cables/powerware.txt
21 = Generic RUPS 2000 (Megatec M2501 cable)
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=RTS+DTR]
22 = Gamatronic All models with alarm interface
(also CyberPower SL series)
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
SIMILAR MODELS
--------------
Many different UPS companies make models with similar interfaces. The
RUPS cable seems to be especially popular in the "power strip" variety of
UPS found in office supply stores. If your UPS works with an entry in the
table above, but the model or manufacturer information don't match,
don't despair. You can fix that easily by using the mfr and model
variables documented above in your linkman:ups.conf[5].
TESTING COMPATIBILITY
---------------------
If your UPS isn't listed above, you can try going through the list until
you find one that works. There is a lot of cable and interface reuse in
the UPS world, and you may find a match.
To do this, first make sure nothing important is plugged into the
outlets on the UPS, as you may inadvertently switch it off. Definitely
make sure that the computer you're using is not plugged into that UPS.
Plug in something small like a lamp so you know when power is being
supplied to the outlets.
Now, you can either attempt to make an educated guess based on the
documentation your manufacturer has provided (if any), or just start
going down the list.
Step 1
~~~~~~
Pick a driver to try from the list (genericups -h) and go to step 2.
Step 2
~~~~~~
Start the driver with the type you want to try -
genericups -x upstype=n /dev/port
Let upsd sync up (watch the syslog), and then run upsc to see what it
found. If the STATUS is right (should be OL for on line), continue to
<<_step_3,Step 3>>, otherwise go back to step 1.
Alternatively, you can run genericups in debug mode -
genericups -DDDDD -x upstype=n /dev/port
In this mode it will be running in the foreground and continuously
display the line and battery status of the UPS.
Step 3
~~~~~~
Disconnect the UPS from the wall/mains power. This is easiest if you
have a switched outlet in between it and the wall, but you can also just
pull the plug to test. The lamp should stay lit, and the status should
switch to "OB". If the lamp went out or the status didn't go to "OB"
within about 15 seconds, go to <<_step_1,Step 1>>. Otherwise, continue
to <<_step_4,Step 4>>.
Step 4
~~~~~~
At this point, we know that OL and OB work. If nothing else beyond
this point works, you at least know what your OL/OB value should be.
Wait for the UPS to start complaining about a low battery. Depending on
the size of your UPS battery and the lamp's bulb, this could take
awhile. It should start complaining audibly at some point. When this
happens, STATUS should show "OB LB" within 15 seconds. If not, go to
<<_step_1,Step 1>>, otherwise continue to <<_step_5,Step 5>>.
Step 5
~~~~~~
So far: OL works, OB works, and LB works.
With the UPS running on battery, run the genericups driver with the -k
switch to shut it down.
genericups -x upstype=n -k /dev/port
If the UPS turns off the lamp, you're done. At this point, you have
verified that the shutdown sequence actually does what you want. You
can start using the genericups driver with this type number for normal
operations.
You should use your findings to add a section to your ups.conf.
Here is a quick example:
[myups]
driver = genericups
port = /dev/ttyS0
upstype = 1
Change the port and upstype values to match your system.
NEW SUPPORT
-----------
If the above testing sequence fails, you will probably need to create a
new entry to support your hardware. All UPS types are determined from the
table in the genericups.h file in the source tree.
On a standard 9 pin serial port, there are 6 lines that are used as the
standard "high/low" signal levels. 4 of them are incoming (to the PC,
from the UPS), and the other 2 are outgoing (to the UPS, from the PC).
The other 3 are the receive/transmit lines and the ground.
Be aware that many manufacturers remap pins within the cable. If you have
any doubts, a quick check with a multimeter should confirm whether the
cable is straight-through or not. Another thing to keep in mind is that
some cables have electronics in them to do special things. Some have
resistors and transistors on board to change behavior depending on what's
being supplied by the PC.
SPECIFIC MODEL NOTES
--------------------
These have been contributed by users of this driver.
The Centralion CL series may power down the load if the driver starts up
with the UPS running on battery as the default line settings contain the
shutdown sequence. - Neil Muller
The Tripp-Lite Internet Office 700 must be used with the black 73-0844
cable instead of the gray 73-0743 cable. This entry should work with any
of their models with the Lan 2.2 interface - see the sticker by the DB9
connector on the UPS. - Stephen Brown
Type 5 should work with the Tripp-Lite Lan 2.1 interface and the 73-0724
cable. This was tested with the OmniSmart 675 PNP on Red Hat 7.2. - Q
Giese
Types 7 and 10 should both work with the PhoenixTec A1000.
BUGS
----
There is no way to reliably detect a contact-closure UPS. This means the
driver will start up happily even if no UPS is detected. It also means
that if the connection between the UPS and computer is interrupted, you
may not be able to sense this in software.
Most contact-closure UPSes will not power down the load if the line power
is present. This can create a race when using slave linkman:upsmon[8]
systems. See the linkman:upsmon[8] man page for more information.
The solution to both of these problems is to upgrade to a smart protocol
UPS of some kind that allows detection and proper load cycling on command.
SEE ALSO
--------
The core driver
~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources
~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

61
docs/man/hosts.conf.5 Normal file
View file

@ -0,0 +1,61 @@
'\" t
.\" Title: hosts.conf
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "HOSTS\&.CONF" "5" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
hosts.conf \- Access control for Network UPS Tools CGI programs
.SH "DESCRIPTION"
.sp
The CGI programs (\fBupsset.cgi\fR(8), \fBupsstats.cgi\fR(8), \fBupsimage.cgi\fR(8)) use this file to determine if they are allowed to talk to a host\&. This keeps random visitors from using your web server to annoy others by creating outgoing connections\&.
.SH "DIRECTIVES"
.PP
\fBMONITOR\fR \fIups\fR \fIdescription\fR
.RS 4
The
\fIups\fR
element is in the form
upsname[@hostname[:port]]\&. To allow connections to a UPS called "snoopy" on a system called "doghouse" that runs upsd on port 7877, it would look like this:
.sp
.if n \{\
.RS 4
.\}
.nf
MONITOR snoopy@doghouse:7877 "Joe Cool"
.fi
.if n \{\
.RE
.\}
.sp
The description must be one element, so if it has spaces, then it must be wrapped with quotes as shown above\&. The default hostname is "localhost"\&.
.RE
.SH "SEE ALSO"
.sp
\fBupsset.cgi\fR(8), \fBupsstats.cgi\fR(8), \fBupsimage.cgi\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

39
docs/man/hosts.conf.txt Normal file
View file

@ -0,0 +1,39 @@
HOSTS.CONF(5)
=============
NAME
----
hosts.conf - Access control for Network UPS Tools CGI programs
DESCRIPTION
-----------
The CGI programs (linkman:upsset.cgi[8], linkman:upsstats.cgi[8],
linkman:upsimage.cgi[8]) use this file to determine if they are allowed to
talk to a host. This keeps random visitors from using your web server
to annoy others by creating outgoing connections.
DIRECTIVES
----------
*MONITOR* 'ups' 'description'::
The 'ups' element is in the form `upsname[@hostname[:port]]`.
To allow connections to a UPS called "snoopy" on a system called
"doghouse" that runs upsd on port 7877, it would look like this:
MONITOR snoopy@doghouse:7877 "Joe Cool"
+
The description must be one element, so if it has spaces, then it must
be wrapped with quotes as shown above. The default hostname is
"localhost".
SEE ALSO
--------
linkman:upsset.cgi[8], linkman:upsstats.cgi[8], linkman:upsimage.cgi[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

50
docs/man/isbmex.8 Normal file
View file

@ -0,0 +1,50 @@
'\" t
.\" Title: isbmex
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "ISBMEX" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
isbmex \- Driver for ISBMEX UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the isbmex driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports SOLA/BASIC Mexico ISBMEX protocol UPS equipment\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "AUTHOR"
.sp
Edscott Wilson Garcia <edscott@imp\&.mx>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

39
docs/man/isbmex.txt Normal file
View file

@ -0,0 +1,39 @@
ISBMEX(8)
=========
NAME
----
isbmex - Driver for ISBMEX UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
isbmex driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports SOLA/BASIC Mexico ISBMEX protocol UPS equipment.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
AUTHOR
------
Edscott Wilson Garcia <edscott@imp.mx>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

50
docs/man/ivtscd.8 Normal file
View file

@ -0,0 +1,50 @@
'\" t
.\" Title: ivtscd
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "IVTSCD" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ivtscd \- driver for the IVT Solar Controller Device
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the \fBivtscd\fR driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "DESCRIPTION"
.sp
This driver allows to access the IVT SCD\-series devices\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra argument\&.
.SH "AUTHOR"
.sp
Arjen de Korte <adkorte\-guest@alioth\&.debian\&.org>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

34
docs/man/ivtscd.txt Normal file
View file

@ -0,0 +1,34 @@
IVTSCD(8)
=========
NAME
----
ivtscd - driver for the IVT Solar Controller Device
NOTE
----
This man page only documents the hardware-specific features of the
*ivtscd* driver. For information about the core driver, see
linkman:nutupsdrv[8].
DESCRIPTION
-----------
This driver allows to access the IVT SCD-series devices.
EXTRA ARGUMENTS
---------------
This driver does not support any extra argument.
AUTHOR
------
Arjen de Korte <adkorte-guest@alioth.debian.org>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

70
docs/man/libupsclient-config.1 Normal file
View file

@ -0,0 +1,70 @@
'\" t
.\" Title: libupsclient-config
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "LIBUPSCLIENT\-CONFIG" "1" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
libupsclient-config \- script to get information about the installed version of libupsclient
.SH "SYNOPSIS"
.sp
\fBlibupsclient\-config\fR [\-\-version] [\-\-libs] [\-\-cflags]
.SH "DESCRIPTION"
.sp
\fBlibupsclient\-config\fR is a tool that is used to determine the compiler and linker flags that should be used to compile and link programs that use \fBlibupsclient\fR from the Network UPS Tools project\&.
.SH "OPTIONS"
.sp
\fBlibupsclient\-config\fR accepts the following options:
.PP
\fB\-\-version\fR
.RS 4
Print the currently installed version of
\fBlibupsclient\fR
on the standard output\&.
.RE
.PP
\fB\-\-libs\fR
.RS 4
Print the linker flags that are necessary to link a
\fBlibupsclient\fR
program\&.
.RE
.PP
\fB\-\-cflags\fR
.RS 4
Print the compiler flags that are necessary to compile a
\fBlibupsclient\fR
program\&.
.RE
.SH "AUTHORS"
.sp
This manual page was written by Arnaud Quette <aquette\&.dev@gmail\&.com>\&.
.SH "SEE ALSO"
.sp
\fBupsclient\fR(3)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

46
docs/man/libupsclient-config.txt Normal file
View file

@ -0,0 +1,46 @@
LIBUPSCLIENT-CONFIG(1)
======================
NAME
----
libupsclient-config - script to get information about the installed version of libupsclient
SYNOPSIS
--------
*libupsclient-config* [--version] [--libs] [--cflags]
DESCRIPTION
-----------
*libupsclient-config* is a tool that is used to determine the compiler and
linker flags that should be used to compile and link programs that use
*libupsclient* from the Network UPS Tools project.
OPTIONS
-------
*libupsclient-config* accepts the following options:
*--version*::
Print the currently installed version of *libupsclient* on the standard output.
*--libs*::
Print the linker flags that are necessary to link a *libupsclient* program.
*--cflags*::
Print the compiler flags that are necessary to compile a *libupsclient* program.
AUTHORS
-------
This manual page was written by Arnaud Quette <aquette.dev@gmail.com>.
SEE ALSO
--------
linkman:upsclient[3]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

55
docs/man/liebert-esp2.8 Normal file
View file

@ -0,0 +1,55 @@
'\" t
.\" Title: liebert-esp2
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "LIEBERT\-ESP2" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
liebert-esp2 \- Driver for Liebert UPS, using the ESP\-II serial protocol
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the liebert\-esp2 driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This is an experimental driver\&. You have been warned\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in \fBups.conf\fR(5):
.PP
\fBbaudrate=\fR\fInum\fR
.RS 4
Set the speed of the serial connection \- 1200, 2400 (default), 4800, 9600 or 19200\&.
.RE
.SH "AUTHOR"
.sp
Richard Gregory <R\&.Gregory at liverpool\&.ac\&.uk>, Arjen de Korte <adkorte\-guest at alioth\&.debian\&.org>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

40
docs/man/liebert-esp2.txt Normal file
View file

@ -0,0 +1,40 @@
LIEBERT-ESP2(8)
==============
NAME
----
liebert-esp2 - Driver for Liebert UPS, using the ESP-II serial protocol
NOTE
----
This man page only documents the hardware-specific features of the
liebert-esp2 driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This is an experimental driver. You have been warned.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in linkman:ups.conf[5]:
*baudrate=*'num'::
Set the speed of the serial connection - 1200, 2400 (default), 4800, 9600 or 19200.
AUTHOR
------
Richard Gregory <R.Gregory at liverpool.ac.uk>, Arjen de Korte <adkorte-guest at alioth.debian.org>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

52
docs/man/liebert.8 Normal file
View file

@ -0,0 +1,52 @@
'\" t
.\" Title: liebert
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "LIEBERT" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
liebert \- Driver for Liebert contact\-closure UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the liebert driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports some Liebert UPS equipment with a contact\-closure interface\&. This includes the UPStation GXT2 with their contact\-closure cable\&. The smart mode ("Multilink") cable is not supported by this driver\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "BUGS"
.sp
This driver does not yet support shutdowns by raising DTR\&. Be aware that shutdowns are not possible with the stock contact\-closure cable\&. You may have to build another cable with DTR connected through to the UPS for it to work\&.
.sp
There is no way for this driver to detect the hardware or cable\&. It will start up successfully even if no UPS is present\&. This is a fundamental limitation of any contact\-closure driver\&.
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

49
docs/man/liebert.txt Normal file
View file

@ -0,0 +1,49 @@
LIEBERT(8)
==========
NAME
----
liebert - Driver for Liebert contact-closure UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
liebert driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports some Liebert UPS equipment with a contact-closure
interface. This includes the UPStation GXT2 with their contact-closure
cable. The smart mode ("Multilink") cable is not supported by this
driver.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
BUGS
----
This driver does not yet support shutdowns by raising DTR. Be aware
that shutdowns are not possible with the stock contact-closure cable.
You may have to build another cable with DTR connected through to the
UPS for it to work.
There is no way for this driver to detect the hardware or cable. It
will start up successfully even if no UPS is present. This is a
fundamental limitation of any contact-closure driver.
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

53
docs/man/masterguard.8 Normal file
View file

@ -0,0 +1,53 @@
'\" t
.\" Title: masterguard
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "MASTERGUARD" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
masterguard \- Driver for Masterguard UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the masterguard driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports Masterguard UPS equipment\&.
.SH "EXTRA ARGUMENTS"
.PP
\fBCS\fR
.RS 4
Cancel the shutdown procedure\&.
.RE
.SH "AUTHOR"
.sp
Michael Spanier <mail@michael\-spanier\&.de>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

37
docs/man/masterguard.txt Normal file
View file

@ -0,0 +1,37 @@
MASTERGUARD(8)
==============
NAME
----
masterguard - Driver for Masterguard UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
masterguard driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports Masterguard UPS equipment.
EXTRA ARGUMENTS
---------------
*CS*::
Cancel the shutdown procedure.
AUTHOR
------
Michael Spanier <mail@michael-spanier.de>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

137
docs/man/metasys.8 Normal file
View file

@ -0,0 +1,137 @@
'\" t
.\" Title: metasys
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "METASYS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
metasys \- Driver for Meta System UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the metasys driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
The \fBmetasys\fR driver was written with the "Meta System UPS Protocol Rev\&.1\&.12" kindly supplied from Meta System\&.
.sp
The driver should support all the common features of the ups models:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
HF Line (/2) 1\-8 boards
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
HF Millennium (810, 820)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
HF TOP Line (910, 920, 930, 940, 950, 970, 980)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ECO Network (750, 1000, 1050, 1500, 1800, 2000, 2100, 2500, 3000)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ECO (305, 308, 311, 511, 516, 519, 522, SX, SXI)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ally HF (800, 1000, 1250, 1600, 2000, 2500)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Megaline (1250, 2500, 3750, 5000, 6250, 7500, 8750, 10000)
.RE
.SH "CABLING"
.sp
The needed cable is a standard pin\-to\-pin serial cable with at least pins 2, 3, and 5 (on DB9 connector) connected\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports no extra arguments from \fBups.conf\fR(5)\&.
.SH "BUGS"
.sp
This driver has been tested on Meta System HF Millennium 820 and ally HF 1000 only\&.
.sp
Any informations about the use of the driver with the other listed UPS are really welcome\&.
.SH "AUTHOR"
.sp
Fabio Di Niro <blaxwan@users\&.sourceforge\&.net>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

63
docs/man/metasys.txt Normal file
View file

@ -0,0 +1,63 @@
METASYS(8)
==========
NAME
----
metasys - Driver for Meta System UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
metasys driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
The *metasys* driver was written with the "Meta System UPS Protocol Rev.1.12"
kindly supplied from Meta System.
The driver should support all the common features of the ups models:
- HF Line (/2) 1-8 boards
- HF Millennium (810, 820)
- HF TOP Line (910, 920, 930, 940, 950, 970, 980)
- ECO Network (750, 1000, 1050, 1500, 1800, 2000, 2100, 2500, 3000)
- ECO (305, 308, 311, 511, 516, 519, 522, SX, SXI)
- ally HF (800, 1000, 1250, 1600, 2000, 2500)
- Megaline (1250, 2500, 3750, 5000, 6250, 7500, 8750, 10000)
CABLING
-------
The needed cable is a standard pin-to-pin serial cable with at least
pins 2, 3, and 5 (on DB9 connector) connected.
EXTRA ARGUMENTS
---------------
This driver supports no extra arguments from linkman:ups.conf[5].
BUGS
----
This driver has been tested on Meta System HF Millennium 820 and
ally HF 1000 only.
Any informations about the use of the driver with the other listed
UPS are really welcome.
AUTHOR
------
Fabio Di Niro <blaxwan@users.sourceforge.net>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

122
docs/man/mge-shut.8 Normal file
View file

@ -0,0 +1,122 @@
'\" t
.\" Title: mge-shut
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "MGE\-SHUT" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
mge-shut \- Driver for SHUT Protocol UPS equipment
.SH "SYNOPSIS"
.sp
\fBmge\-shut\fR \-h
.sp
\fBmge\-shut\fR \-a \fIUPS_NAME\fR [\fIOPTIONS\fR]
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
This man page only documents the hardware\-specific features of the mge\-shut driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.sp .5v
.RE
.SH "SUPPORTED HARDWARE"
.sp
mge\-shut supports all recent Eaton, MGE and Dell UPS models which use the SHUT (Serial HID UPS Transfer) protocol\&.
.sp
Older MGE models, such as Pulsar ESV+, Pulsar EX and Pulsar ES+, use the U\-Talk protocol and should use the mge\-utalk driver\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver also supports the following optional settings:
.PP
\fBlowbatt\fR=\fInum\fR
.RS 4
Set the low battery warning threshold at which shutdown is initiated by
\fBupsmon\fR(8)\&.
.sp
The factory default value is 30 (in percent), and can be settable depending on the exact model\&.
.RE
.PP
\fBoffdelay\fR=\fInum\fR
.RS 4
Set the timer before the UPS is turned off after the kill power command is sent (via the
\fB\-k\fR
switch)\&.
.sp
The default value is 20 (in seconds)\&. Usually this
\fBmust be lower\fR
than
\fIondelay\fR, but the driver will
\fBnot\fR
warn you upon startup if it isn\(cqt\&.
.RE
.PP
\fBondelay\fR=\fInum\fR
.RS 4
Set the timer for the UPS to switch on in case the power returns after the kill power command had been sent but before the actual switch off\&. This ensures the machines connected to the UPS are, in all cases, rebooted after a power failure\&.
.sp
The default value is 30 (in seconds)\&. Usually this
\fBmust be greater\fR
than offdelay, but the driver will
\fBnot\fR
warn you upon startup if it isn\(cqt\&. Some UPS\(cqes will restart no matter what, even if the power is (still) out at the moment this timer elapses\&. In that case, you could try if setting
\fIondelay = \-1\fR
in
\fBups\&.conf\fR
helps\&.
.RE
.PP
\fBnotification\fR=\fInum\fR
.RS 4
Set notification type to 1 (no), 2 (light) or 3 (yes)\&.
.sp
The default value is 3 (yes) because of some early Ellipse models which need it\&.
.RE
.SH "KNOWN ISSUES"
.SS "Repetitive timeout and staleness"
.sp
Some models tends to be unresponsive with the default polling frequency\&. The result is that you have some "data stale" errors in your system log\&.
.sp
In this case, simply modify the general parameter "pollinterval" to a higher value (like 10 for 10 seconds)\&. This should solve the issue\&.
.sp
Using \fInotification=3\fR might also help\&.
.SH "AUTHOR"
.sp
Arnaud Quette
.SH "SEE ALSO"
.SS "The core driver"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

94
docs/man/mge-shut.txt Normal file
View file

@ -0,0 +1,94 @@
MGE-SHUT(8)
===========
NAME
----
mge-shut - Driver for SHUT Protocol UPS equipment
SYNOPSIS
--------
*mge-shut* -h
*mge-shut* -a 'UPS_NAME' ['OPTIONS']
NOTE: This man page only documents the hardware-specific features of the
mge-shut driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
mge-shut supports all recent Eaton, MGE and Dell UPS models which use the SHUT
(Serial HID UPS Transfer) protocol.
Older MGE models, such as Pulsar ESV+, Pulsar EX and Pulsar ES+, use the U-Talk
protocol and should use the mge-utalk driver.
EXTRA ARGUMENTS
---------------
This driver also supports the following optional settings:
*lowbatt*='num'::
Set the low battery warning threshold at which shutdown is initiated by
linkman:upsmon[8].
+
The factory default value is 30 (in percent), and can be settable depending on
the exact model.
*offdelay*='num'::
Set the timer before the UPS is turned off after the kill power command is
sent (via the *-k* switch).
+
The default value is 20 (in seconds). Usually this *must be lower* than
'ondelay', but the driver will *not* warn you upon startup if it isn't.
*ondelay*='num'::
Set the timer for the UPS to switch on in case the power returns after the
kill power command had been sent but before the actual switch off. This
ensures the machines connected to the UPS are, in all cases, rebooted after
a power failure.
+
The default value is 30 (in seconds). Usually this *must be greater*
than offdelay, but the driver will *not* warn you upon startup if it
isn't. Some UPS'es will restart no matter what, even if the power is
(still) out at the moment this timer elapses. In that case, you could try
if setting 'ondelay = -1' in *ups.conf* helps.
*notification*='num'::
Set notification type to 1 (no), 2 (light) or 3 (yes).
+
The default value is 3 (yes) because of some early Ellipse models which
need it.
KNOWN ISSUES
------------
Repetitive timeout and staleness
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Some models tends to be unresponsive with the default polling frequency.
The result is that you have some "data stale" errors in your system log.
In this case, simply modify the general parameter "pollinterval" to a higher
value (like 10 for 10 seconds). This should solve the issue.
Using 'notification=3' might also help.
AUTHOR
------
Arnaud Quette
SEE ALSO
--------
The core driver
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources
~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

120
docs/man/mge-utalk.8 Normal file
View file

@ -0,0 +1,120 @@
'\" t
.\" Title: mge-utalk
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "MGE\-UTALK" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
mge-utalk \- Driver for MGE UPS SYSTEMS UTalk protocol equipment
.SH "SYNOPSIS"
.sp
\fBmge\-utalk\fR \-h
.sp
\fBmge\-utalk\fR \-a \fIUPS_NAME\fR [\fIOPTIONS\fR]
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
This man page only documents the hardware\-specific features of the mge\-utalk driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.sp .5v
.RE
.SH "SUPPORTED HARDWARE"
.sp
mge\-utalk supports the following legacy units, using the MGE UTalk protocol:
.sp
.if n \{\
.RS 4
.\}
.nf
Pulsar ESV+,
Pulsar ES+,
Pulsar EL,
Pulsar EX,
Pulsar EXtreme,
Comet EXtreme,
Comet (Utalk Serial Card, ref 66060),
Galaxy (Utalk Serial Card, ref 66060)\&.
.fi
.if n \{\
.RE
.\}
.sp
This driver also support some newer models with backward UTalk compatibility, such as Pulsar Evolution and Pulsar EXtreme C\&. As these models also support the SHUT protocol, prefer mge\-shut for serial communication, or use the USB port, if available, with the usbhid\-ups driver\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5):
.PP
\fBlowbatt\fR=\fInum\fR
.RS 4
Set the low battery warning threshold at which shutdown is initiated by
\fBupsmon\fR(8)\&.
.sp
The factory default value is 30 (in percent), and can be settable depending on the exact model\&.
.RE
.PP
\fBoffdelay\fR=\fInum\fR
.RS 4
Set the timer before the UPS is turned off after the kill power command is sent (via the
\fB\-k\fR
switch)\&.
.sp
The default value is 20 (in seconds)\&.
.RE
.PP
\fBondelay\fR=\fInum\fR
.RS 4
Set the delay before the UPS is turned on, after the power returns\&.
.sp
The default value is 1 (in minutes)\&.
.RE
.PP
\fBoldmac\fR
.RS 4
Set this flag if you are running Linux on an Oldworld Macintosh box (all beige Apple Macintosh)\&. This might also be needed for other OSs (like *BSD) running on PowerMac\&.
.RE
.SH "KNOWN ISSUES"
.SS "Repetitive timeout and staleness"
.sp
Older models, such as ES/ESV ones, might report repetitive "data stale" errors\&. This is due to the fact that these models don\(cqt support too much polling\&. To solve this problem, add "pollinterval=20" in ups\&.conf, and change the value of MAXAGE to 25 in upsd\&.conf, and DEADTIME to 25 in upsmon\&.conf\&.
.SH "AUTHOR"
.sp
Hans Ekkehard Plesser, Arnaud Quette, Martin Loyer, Patrick Agrain, Nicholas Reilly, Dave Abbott, Marek Kralewski
.SH "SEE ALSO"
.SS "The core driver"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

98
docs/man/mge-utalk.txt Normal file
View file

@ -0,0 +1,98 @@
MGE-UTALK(8)
============
NAME
----
mge-utalk - Driver for MGE UPS SYSTEMS UTalk protocol equipment
SYNOPSIS
--------
*mge-utalk* -h
*mge-utalk* -a 'UPS_NAME' ['OPTIONS']
NOTE: This man page only documents the hardware-specific features of the
mge-utalk driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
mge-utalk supports the following legacy units, using the MGE UTalk protocol:
Pulsar ESV+,
Pulsar ES+,
Pulsar EL,
Pulsar EX,
Pulsar EXtreme,
Comet EXtreme,
Comet (Utalk Serial Card, ref 66060),
Galaxy (Utalk Serial Card, ref 66060).
This driver also support some newer models with backward UTalk compatibility,
such as Pulsar Evolution and Pulsar EXtreme C. As these models also support
the SHUT protocol, prefer mge-shut for serial communication, or use the USB
port, if available, with the usbhid-ups driver.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the linkman:ups.conf[5]:
*lowbatt*='num'::
Set the low battery warning threshold at which shutdown is initiated by
linkman:upsmon[8].
+
The factory default value is 30 (in percent), and can be settable depending on
the exact model.
*offdelay*='num'::
Set the timer before the UPS is turned off after the kill power command is
sent (via the *-k* switch).
+
The default value is 20 (in seconds).
*ondelay*='num'::
Set the delay before the UPS is turned on, after the power returns.
+
The default value is 1 (in minutes).
*oldmac*::
Set this flag if you are running Linux on an Oldworld Macintosh box
(all beige Apple Macintosh). This might also be needed for other
OSs (like *BSD) running on PowerMac.
KNOWN ISSUES
------------
Repetitive timeout and staleness
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Older models, such as ES/ESV ones, might report repetitive "data stale" errors.
This is due to the fact that these models don't support too much polling.
To solve this problem, add "pollinterval=20" in ups.conf, and change the value
of MAXAGE to 25 in upsd.conf, and DEADTIME to 25 in upsmon.conf.
AUTHOR
------
Hans Ekkehard Plesser,
Arnaud Quette,
Martin Loyer,
Patrick Agrain,
Nicholas Reilly,
Dave Abbott,
Marek Kralewski
SEE ALSO
--------
The core driver
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources
~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

50
docs/man/microdowell.8 Normal file
View file

@ -0,0 +1,50 @@
'\" t
.\" Title: microdowell
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "MICRODOWELL" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
microdowell \- Driver for Microdowell Enterprise UPS series
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the Microdowell driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver was developed for the Enterprise Nxx and Bxx models\&. Other Microdowell models may work, too\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
.SH "AUTHOR"
.sp
Elio Corbolante <eliocor@microdowell\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

40
docs/man/microdowell.txt Normal file
View file

@ -0,0 +1,40 @@
MICRODOWELL(8)
==============
NAME
----
microdowell - Driver for Microdowell Enterprise UPS series
NOTE
----
This man page only documents the hardware-specific features of the
Microdowell driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver was developed for the Enterprise Nxx and Bxx models. Other
Microdowell models may work, too.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
AUTHOR
------
Elio Corbolante <eliocor@microdowell.com>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

159
docs/man/netxml-ups.8 Normal file
View file

@ -0,0 +1,159 @@
'\" t
.\" Title: netxml-ups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NETXML\-UPS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
netxml-ups \- Driver for Eaton / MGE Network Management Card / Proxy (XML/HTTP Protocol) equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the netxml\-ups driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
netxml\-ups support all recent Eaton / MGE models which use a Network Management Card or Proxy (MGE XML/HTTP protocol based)\&. This applies to both Eaton (previously MGE Office Protection Systems) and to MGE UPS SYSTEMS\&. Supported card and proxy models are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
NMC Minislot (Ref 66102, firmware EA or newer),
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SNMP/Web Minislot card (Ref 66244)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
NMC Transverse (Ref 66074),
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
NMC & Modbus/JBus (Ref 66103),
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Network Management Proxy,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ePDU Monitored (newer version)\&.
.RE
.sp
Older models, such as SNMP card (Ref 66062 and Ref 66045), use the SNMP protocol and should use the \fBsnmp-ups\fR(8) driver with the "mibs=mge" parameter\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5):
.PP
\fBtimeout\fR=\fIvalue\fR
.RS 4
The timeout for connecting to and reading from the UPS\&. Defaults to 5 seconds\&. Don\(cqt change this value unless you know exactly what you\(cqre doing\&.
.RE
.sp
This value \fBmust never\fR be higher than half the MAXAGE value specified in \fBupsd.conf\fR(5), otherwise you run the risk that \fBupsd\fR(8) declares the driver stale while it is waiting for a connection to timeout\&.
.PP
\fBlogin\fR=\fIvalue\fR
.RS 4
Set the login value for authenticated mode\&. This feature also needs the
\fBpassword\fR
argument, and allows value settings in the card\&. This feature is not used yet\&.
.RE
.PP
\fBpassword\fR=\fIvalue\fR
.RS 4
Set the password value, needed with the login for authenticated mode\&. This feature is not used yet\&.
.RE
.SH "IMPLEMENTATION"
.sp
The hostname of the UPS is specified with the "port" value in \fBups\&.conf\fR, i\&.e\&.:
.sp
.if n \{\
.RS 4
.\}
.nf
[mgexml]
driver = netxml\-ups
port = http://netxml\-ups\&.example\&.com:80
.fi
.if n \{\
.RE
.\}
.sp
Specifying the method to connect to the UPS (http, https) is mandatory\&. If the port is equal to the default for the method specified (80 for http, 443 for https) it may be omitted\&.
.sp
In order not to overload older NMCs by polling them too frequently, it is recommended to increase the "pollinterval" (see \fBnutupsdrv\fR(8)) and \fBups.conf\fR(5)) to at least 5 seconds\&.
.SH "KNOWN ISSUES"
.sp
Don\(cqt connect to the UPS through a proxy\&. Although it would be trivial to add support for proxies, this is not recommended and don\(cqt ask for it\&. Not only because it will prevent the driver to make a persistent connection to the UPS, but also it adds an additional failure mode\&. If the proxy goes down (for whatever reason), the driver will no longer be able to reach the UPS\&.
.SH "AUTHORS"
.sp
Arjen de Korte <adkorte\-guest@alioth\&.debian\&.org>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

93
docs/man/netxml-ups.txt Normal file
View file

@ -0,0 +1,93 @@
netxml-ups(8)
=============
NAME
----
netxml-ups - Driver for Eaton / MGE Network Management Card / Proxy
(XML/HTTP Protocol) equipment
NOTE
----
This man page only documents the hardware-specific features of the
netxml-ups driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
netxml-ups support all recent Eaton / MGE models which use a Network
Management Card or Proxy (MGE XML/HTTP protocol based). This applies to both
Eaton (previously MGE Office Protection Systems) and to MGE UPS SYSTEMS.
Supported card and proxy models are:
* NMC Minislot (Ref 66102, firmware EA or newer),
* SNMP/Web Minislot card (Ref 66244)
* NMC Transverse (Ref 66074),
* NMC & Modbus/JBus (Ref 66103),
* Network Management Proxy,
* ePDU Monitored (newer version).
Older models, such as SNMP card (Ref 66062 and Ref 66045), use the SNMP
protocol and should use the linkman:snmp-ups[8] driver with the "mibs=mge"
parameter.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5]:
*timeout*='value'::
The timeout for connecting to and reading from the UPS. Defaults to 5 seconds.
Don't change this value unless you know exactly what you're doing.
This value *must never* be higher than half the MAXAGE value specified in
linkman:upsd.conf[5], otherwise you run the risk that linkman:upsd[8] declares
the driver stale while it is waiting for a connection to timeout.
*login*='value'::
Set the login value for authenticated mode. This feature also needs the
*password* argument, and allows value settings in the card.
This feature is not used yet.
*password*='value'::
Set the password value, needed with the login for authenticated mode.
This feature is not used yet.
IMPLEMENTATION
--------------
The hostname of the UPS is specified with the "port" value in
*ups.conf*, i.e.:
[mgexml]
driver = netxml-ups
port = http://netxml-ups.example.com:80
Specifying the method to connect to the UPS (http, https) is mandatory.
If the port is equal to the default for the method specified (80 for http,
443 for https) it may be omitted.
In order not to overload older NMCs by polling them too frequently, it is
recommended to increase the "pollinterval" (see linkman:nutupsdrv[8]) and
linkman:ups.conf[5]) to at least 5 seconds.
KNOWN ISSUES
------------
Don't connect to the UPS through a proxy. Although it would be trivial to add
support for proxies, this is not recommended and don't ask for it. Not only
because it will prevent the driver to make a persistent connection to the UPS,
but also it adds an additional failure mode. If the proxy goes down (for
whatever reason), the driver will no longer be able to reach the UPS.
AUTHORS
-------
Arjen de Korte <adkorte-guest@alioth.debian.org>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

169
docs/man/nut.conf.5 Normal file
View file

@ -0,0 +1,169 @@
'\" t
.\" Title: nut.conf
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUT\&.CONF" "5" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nut.conf \- UPS definitions for Network UPS Tools
.SH "DESCRIPTION"
.sp
This file attempts to standardize the various files being found in different installations, like /etc/default/nut on Debian based systems and /etc/sysconfig/ups on RedHat based systems\&.
.sp
Distribution\(cqs init script should source this file in order to determine which components have to be started\&.
.sp
Blank lines are ignored\&. Lines with a hash (\fI#\fR) character at the 1st position of the line are ignored, too\&. They can be used to add comments\&.
.SH "DIRECTIVES"
.PP
\fBMODE\fR
.RS 4
Required\&. Recognized values are
\fInone\fR,
\fIstandalone\fR,
\fInetserver\fR
and
\fInetclient\fR\&. Defaults to
\fInone\fR\&.
.PP
none
.RS 4
Indicates that NUT should not get started automatically, possibly because it is not configured or that an Integrated Power Management or some external system, is used to startup the NUT components\&.
.RE
.PP
standalone
.RS 4
Addresses a local only configuration, with 1 UPS protecting the local system\&. This implies to start the 3 NUT layers (driver, upsd and upsmon), with the related configuration files\&. This mode can also address UPS redundancy\&.
.RE
.PP
netserver
.RS 4
Like the standalone configuration, but also possibly need one or more specific LISTEN directive(s) in upsd\&.conf\&. Since this MODE is open to the network, a special care should be applied to security concerns\&.
.RE
.PP
netclient
.RS 4
When only upsmon is required, possibly because there are other hosts that are more closely attached to the UPS, the MODE should be set to netclient\&.
.RE
.RE
.PP
\fBUPSD_OPTIONS\fR
.RS 4
Optional\&. Set upsd specific options\&. See
\fBupsd\fR(8)
for more details\&. It is ignored when
\fIMODE\fR
above indicates that no upsd should be running\&.
.RE
.PP
\fBUPSMON_OPTIONS\fR
.RS 4
Optional\&. Set upsmon specific options\&. See
\fBupsmon\fR(8)
for more details\&. It is ignored when
\fIMODE\fR
above indicates that no upsmon should be running\&.
.RE
.PP
\fBPOWEROFF_WAIT\fR
.RS 4
Optional\&. At the end of an emergency system halt, the upsmon master will signal the UPS to switch off\&. This may fail for a number of reasons\&. Most notably is the case that mains power returns during the shutdown process\&. See the section "Power races" in /usr/share/doc/nut/docs/shutdown\&.txt\&.gz\&. The system will wait this long for the UPS to cut power, and then reboot\&. It should be long enough to exhaust the batteries, in case line power continues to be unavailable\&. On the other hand, it should not be so long that the system remains offline for an unreasonable amount of time if line power has returned\&. See sleep(1) for compatible time syntax\&. If you specify the time in seconds, use the "s" suffix\&.
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBWarning\fR
.ps -1
.br
.sp
this workaround might be dangerous under some circumstances\&. Please read http://bugs\&.debian\&.org/358696 for more details\&.
.sp .5v
.RE
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf
# /etc/nut/nut\&.conf\&. See nut\&.conf(5)
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
MODE = none
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
UPSD_OPTIONS = ""
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
UPSMON_OPTIONS = ""
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
# POWEROFF_WAIT = 15m
.fi
.if n \{\
.RE
.\}
.SH "INTEGRATION"
.sp
An init script, such as /etc/init\&.d/nut, is expected to source this file in order to determine which component(s) has to be started\&.
.SH "SEE ALSO"
.sp
\fBups.conf\fR(5), \fBupsd.conf\fR(5), \fBupsd.users\fR(5), \fBupsmon.conf\fR(5)
.SH "INTERNET RESOURCES"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

101
docs/man/nut.conf.txt Normal file
View file

@ -0,0 +1,101 @@
NUT.CONF(5)
===========
NAME
----
nut.conf - UPS definitions for Network UPS Tools
DESCRIPTION
-----------
This file attempts to standardize the various files being found
in different installations, like /etc/default/nut on Debian based
systems and /etc/sysconfig/ups on RedHat based systems.
Distribution's init script should source this file in order to
determine which components have to be started.
Blank lines are ignored. Lines with a hash ('#') character at the
1st position of the line are ignored, too. They can be used to add
comments.
DIRECTIVES
----------
*MODE*::
Required. Recognized values are 'none', 'standalone', 'netserver' and
'netclient'. Defaults to 'none'.
none;; Indicates that NUT should not get started automatically,
possibly because it is not configured or that an Integrated Power
Management or some external system, is used to startup the NUT
components.
standalone;; Addresses a local only configuration, with 1 UPS
protecting the local system. This implies to start the 3 NUT
layers (driver, upsd and upsmon), with the related configuration
files. This mode can also address UPS redundancy.
netserver;; Like the standalone configuration, but also possibly
need one or more specific LISTEN directive(s) in upsd.conf.
Since this MODE is open to the network, a special care should be
applied to security concerns.
netclient;; When only upsmon is required, possibly because
there are other hosts that are more closely attached to the UPS,
the MODE should be set to netclient.
*UPSD_OPTIONS*::
Optional. Set upsd specific options. See linkman:upsd[8] for more
details. It is ignored when 'MODE' above indicates that no upsd
should be running.
*UPSMON_OPTIONS*::
Optional. Set upsmon specific options. See linkman:upsmon[8] for
more details. It is ignored when 'MODE' above indicates that no
upsmon should be running.
*POWEROFF_WAIT*::
Optional. At the end of an emergency system halt, the upsmon master
will signal the UPS to switch off. This may fail for a number of
reasons. Most notably is the case that mains power returns during
the shutdown process. See the section "Power races" in
/usr/share/doc/nut/docs/shutdown.txt.gz. The system will wait this
long for the UPS to cut power, and then reboot. It should be long
enough to exhaust the batteries, in case line power continues to be
unavailable. On the other hand, it should not be so long that the
system remains offline for an unreasonable amount of time if line
power has returned. See sleep(1) for compatible time syntax.
If you specify the time in seconds, use the "s" suffix.
WARNING: this workaround might be dangerous under some circumstances.
Please read http://bugs.debian.org/358696 for more details.
EXAMPLE
-------
# /etc/nut/nut.conf. See nut.conf(5)
MODE = none
UPSD_OPTIONS = ""
UPSMON_OPTIONS = ""
# POWEROFF_WAIT = 15m
INTEGRATION
-----------
An init script, such as /etc/init.d/nut, is expected to source this
file in order to determine which component(s) has to be started.
SEE ALSO
--------
linkman:ups.conf[5], linkman:upsd.conf[5], linkman:upsd.users[5],
linkman:upsmon.conf[5]
INTERNET RESOURCES
------------------
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

175
docs/man/nutupsdrv.8 Normal file
View file

@ -0,0 +1,175 @@
'\" t
.\" Title: nutupsdrv
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTUPSDRV" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nutupsdrv \- generic manual for unified NUT drivers
.SH "SYNOPSIS"
.sp
\fBnutupsdrv\fR \fI\-h\fR
.sp
\fBnutupsdrv\fR [OPTIONS]
.SH "DESCRIPTION"
.sp
\fBnutupsdrv\fR 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\&.
.sp
For information on the specific drivers, see their individual man pages\&.
.sp
UPS drivers provide a communication channel between the physical UPS hardware and the \fBupsd\fR(8) server\&. The driver is responsible for translating the native protocol of the UPS to the common format used by the rest of this package\&.
.sp
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\&.
.sp
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\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
You probably don\(cqt want to use any of these options directly\&. You should use \fBupsdrvctl\fR(8) to control your drivers, and \fBups.conf\fR(5) to configure them\&. The rest of this manual describes options and parameters that generally are not needed by normal users\&.
.sp .5v
.RE
.SH "OPTIONS"
.PP
\fB\-h\fR
.RS 4
Display a help message without doing anything else\&. This will also list possible values for
\fI\-x\fR
in that driver, and other help text that the driver\(cqs author may have provided\&.
.RE
.PP
\fB\-a\fR \fIid\fR
.RS 4
Autoconfigure this driver using the
\fIid\fR
section of
\fBups.conf\fR(5)\&.
\fBThis argument is mandatory when calling the driver directly\&.\fR
.RE
.PP
\fB\-D\fR
.RS 4
Raise the debugging level\&. Use this multiple times to see more details\&. Running a driver in debug mode will prevent it from backgrounding after startup\&. It will keep on logging information to the console until it receives a SIGINT (usually Ctrl\-C) or SIGTERM signal\&.
.sp
The level of debugging needed depends both on the driver and the problem you\(cqre trying to diagnose\&. Therefore, first explain the problem you have with a driver to a developer/maintainer, before sending them debugging output\&. More often than not, if you just pick a level, the output may be either too limited or too verbose to be of any use\&.
.RE
.PP
\fB\-i\fR \fIinterval\fR
.RS 4
Set the poll interval for the device\&.
.RE
.PP
\fB\-V\fR
.RS 4
Print only version information, then exit\&.
.RE
.PP
\fB\-L\fR
.RS 4
Print a parseable list of driver variables\&. Mostly useful for configuration wizard programs\&.
.RE
.PP
\fB\-k\fR
.RS 4
("Kill" power) Forced shutdown mode\&. The UPS will power off the attached load, if possible\&.
.sp
You should use
upsdrvctl shutdown
whenever possible instead of calling this directly\&.
.RE
.PP
\fB\-r\fR \fIdirectory\fR
.RS 4
The driver will chroot(2) to
\fIdirectory\fR
during initialization\&. This can be useful when securing systems\&.
.sp
In addition to the state path, many systems will require /dev/null to exist within
\fIdirectory\fR
for this to work\&. The serial ports are opened before the chroot call, so you do not need to create them inside the jail\&. In fact, it is somewhat safer if you do not\&.
.RE
.PP
\fB\-u\fR \fIusername\fR
.RS 4
If started as root, the driver will setuid(2) to the user id associated with
\fIusername\fR\&.
.sp
If you do not specify this value and start it as root, the driver will switch to the default value that was compiled into the code\&. This is typically
\fInobody\fR, and is far from ideal\&.
.RE
.PP
\fB\-x\fR \fIvar\fR=\fIval\fR
.RS 4
Define a variable called
\fIvar\fR
with the value of
\fIvar\fR
in the driver\&. This varies from driver to driver \- see the specific man pages for more information\&.
.sp
This is like setting
\fIvar\fR=\fIval\fR
in
\fBups.conf\fR(5), but
\fB\-x\fR
overrides any settings from that file\&.
.RE
.SH "DIAGNOSTICS"
.sp
Information about the startup process is printed to stdout\&. Additional messages after that point are available in the syslog\&. After \fBupsd\fR(8) starts, the UPS clients such as \fBupsc\fR(8) can be used to query the status of an UPS\&.
.SH "PROGRAM CONTROL"
.sp
You should always use \fBupsdrvctl\fR(8) to control the drivers\&. While drivers can be started by hand for testing purposes, it is not recommended for production use\&.
.SH "FILES"
.PP
ups\&.conf
.RS 4
Required configuration file\&. This contains all details on which drivers to start and where the hardware is attached\&.
.RE
.SH "BUGS"
.sp
Some of the drivers may have bugs\&. See their manuals for more information\&.
.SH "SEE ALSO"
.sp
Server: \fBupsd\fR(8)
.sp
Clients: \fBupsc\fR(8), \fBupscmd\fR(8), \fBupsrw\fR(8), \fBupslog\fR(8), \fBupsmon\fR(8)
.sp
CGI programs: \fBupsset.cgi\fR(8), \fBupsstats.cgi\fR(8), \fBupsimage.cgi\fR(8)
.sp
Driver control: \fBupsdrvctl\fR(8)
.sp
Drivers: \fBapcsmart\fR(8), \fBbcmxcp\fR(8), \fBbcmxcp_usb\fR(8), \fBbelkin\fR(8), \fBbelkinunv\fR(8), \fBbestfcom\fR(8), \fBbestuferrups\fR(8), \fBbestups\fR(8), \fBblazer\fR(8), \fBcyberpower\fR(8), \fBdummy-ups\fR(8), \fBetapro\fR(8), \fBeverups\fR(8), \fBgamatronic\fR(8), \fBgenericups\fR(8), \fBisbmex\fR(8), \fBliebert\fR(8), \fBmasterguard\fR(8), \fBmetasys\fR(8), \fBmge-shut\fR(8), \fBmge-utalk\fR(8), \fBmge-xml\fR(8), \fBnewmge-shut\fR(8), \fBnitram\fR(8), \fBoneac\fR(8), \fBoptiups\fR(8), \fBpowercom\fR(8), \fBpowerman-pdu\fR(8), \fBpowerpanel\fR(8), \fBrhino\fR(8), \fBrichcomm_usb\fR(8), \fBsafenet\fR(8), \fBsnmp-ups\fR(8), \fBsolis\fR(8), \fBtripplite\fR(8), \fBtripplitesu\fR(8), \fBtripplite_usb\fR(8), \fBusbhid-ups\fR(8), \fBupscode2\fR(8), \fBvictronups\fR(8)
.sp
Internet resources: The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

197
docs/man/nutupsdrv.txt Normal file
View file

@ -0,0 +1,197 @@
NUTUPSDRV(8)
============
NAME
----
nutupsdrv - generic manual for unified NUT drivers
SYNOPSIS
--------
*nutupsdrv* '-h'
*nutupsdrv* [OPTIONS]
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.
UPS drivers provide a communication channel between the physical UPS
hardware and the linkman:upsd[8] server. The driver is responsible for
translating the native protocol of the UPS to the common format used by
the rest of this package.
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.
NOTE: You probably don't want to use any of these options directly. You
should use linkman:upsdrvctl[8] to control your drivers, and
linkman:ups.conf[5] to configure them. The rest of this manual describes
options and parameters that generally are not needed by normal users.
OPTIONS
-------
*-h*::
Display a 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 linkman:ups.conf[5].
*This argument is mandatory when calling the driver directly.*
*-D*::
Raise the debugging level. Use this multiple times to see more details.
Running a driver in debug mode will prevent it from backgrounding after
startup. It will keep on logging information to the console until it
receives a SIGINT (usually Ctrl-C) or SIGTERM signal.
+
The level of debugging needed depends both on the driver and the
problem you're trying to diagnose. Therefore, first explain the problem you
have with a driver to a developer/maintainer, before sending them debugging
output. More often than not, if you just pick a level, the output may be
either too limited or too verbose to be of any use.
*-i* 'interval'::
Set the poll interval for the device.
*-V*::
Print only version information, then exit.
*-L*::
Print a parseable list of driver variables. Mostly useful for configuration
wizard programs.
*-k*::
("Kill" power) Forced shutdown mode. The UPS will power off the
attached load, if possible.
+
You should use +upsdrvctl shutdown+ whenever possible instead of
calling this directly.
*-r* 'directory'::
The driver will chroot(2) to 'directory' during initialization.
This can be useful when securing systems.
+
In addition to the state path, many systems will require /dev/null to
exist within 'directory' for this to work. The serial ports are
opened before the chroot call, so you do not need to create them inside
the jail. In fact, it is somewhat safer if you do not.
*-u* 'username'::
If started as root, the driver will setuid(2) to the user id
associated with 'username'.
+
If you do not specify this value and start it as root, the driver will
switch to the default value that was compiled into the code. This is
typically 'nobody', and is far from ideal.
*-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.
+
This is like setting 'var'='val' in linkman:ups.conf[5], but
*-x* overrides any settings from that file.
DIAGNOSTICS
-----------
Information about the startup process is printed to stdout. Additional
messages after that point are available in the syslog. After linkman:upsd[8]
starts, the UPS clients such as linkman:upsc[8] can be used to query the status
of an UPS.
PROGRAM CONTROL
---------------
You should always use linkman:upsdrvctl[8] to control the drivers. While
drivers can be started by hand for testing purposes, it is not recommended for
production use.
FILES
-----
ups.conf::
Required configuration file. This contains all details on which drivers
to start and where the hardware is attached.
BUGS
----
Some of the drivers may have bugs. See their manuals for more
information.
SEE ALSO
--------
Server:
linkman:upsd[8]
Clients:
linkman:upsc[8], linkman:upscmd[8],
linkman:upsrw[8], linkman:upslog[8], linkman:upsmon[8]
CGI programs:
linkman:upsset.cgi[8], linkman:upsstats.cgi[8], linkman:upsimage.cgi[8]
Driver control:
linkman:upsdrvctl[8]
Drivers:
linkman:apcsmart[8],
linkman:bcmxcp[8],
linkman:bcmxcp_usb[8],
linkman:belkin[8],
linkman:belkinunv[8],
linkman:bestfcom[8],
linkman:bestuferrups[8],
linkman:bestups[8],
linkman:blazer[8],
linkman:cyberpower[8],
linkman:dummy-ups[8],
linkman:etapro[8],
linkman:everups[8],
linkman:gamatronic[8],
linkman:genericups[8],
linkman:isbmex[8],
linkman:liebert[8],
linkman:masterguard[8],
linkman:metasys[8],
linkman:mge-shut[8],
linkman:mge-utalk[8],
linkman:mge-xml[8],
linkman:newmge-shut[8],
linkman:nitram[8],
linkman:oneac[8],
linkman:optiups[8],
linkman:powercom[8],
linkman:powerman-pdu[8],
linkman:powerpanel[8],
linkman:rhino[8],
linkman:richcomm_usb[8],
linkman:safenet[8],
linkman:snmp-ups[8],
linkman:solis[8],
linkman:tripplite[8],
linkman:tripplitesu[8],
linkman:tripplite_usb[8],
linkman:usbhid-ups[8],
linkman:upscode2[8],
linkman:victronups[8]
Internet resources:
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

82
docs/man/oneac.8 Normal file
View file

@ -0,0 +1,82 @@
'\" t
.\" Title: oneac
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "ONEAC" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
oneac \- Driver for Oneac UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the oneac driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports Oneac EG and ON UPS equipment with the Advanced Interface\&. If your UPS is equipped with the Basic Interface card, use the genericups driver\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5) file:
.PP
\fBtesttime\fR=\fInum\fR
.RS 4
Change battery test time from the 2 minute default\&.
.RE
.SH "INSTANT COMMANDS"
.sp
This driver supports the following Instant Commands\&.
.PP
\fBreset\&.input\&.minmax\fR
.RS 4
Reset the minimum and maximum input line voltage values seen since the last reset or power on\&.
.RE
.PP
\fBtest\&.battery\&.start\fR
.RS 4
Start a battery test\&. The default time is 2 minutes\&. This time can be set in the
\fBups\&.conf\fR
file\&. See
\fBtestime\fR
above\&.
.RE
.PP
\fBtest\&.battery\&.stop\fR
.RS 4
Stops a battery test that is in progress\&.
.RE
.PP
\fBtest\&.failure\&.start\fR
.RS 4
Starts a 15 second long simulation of an input power failure\&.
.RE
.SH "AUTHOR"
.sp
Eric Lawson <elawson@inficad\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

62
docs/man/oneac.txt Normal file
View file

@ -0,0 +1,62 @@
ONEAC(8)
========
NAME
----
oneac - Driver for Oneac UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
oneac driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports Oneac EG and ON UPS equipment with the
Advanced Interface. If your UPS is equipped with the Basic
Interface card, use the genericups driver.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5] file:
*testtime*='num'::
Change battery test time from the 2 minute default.
INSTANT COMMANDS
----------------
This driver supports the following Instant Commands.
*reset.input.minmax*::
Reset the minimum and maximum input line voltage values
seen since the last reset or power on.
*test.battery.start*::
Start a battery test. The default time is 2 minutes. This
time can be set in the *ups.conf* file. See *testime* above.
*test.battery.stop*::
Stops a battery test that is in progress.
*test.failure.start*::
Starts a 15 second long simulation of an input power
failure.
AUTHOR
------
Eric Lawson <elawson@inficad.com>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

98
docs/man/optiups.8 Normal file
View file

@ -0,0 +1,98 @@
'\" t
.\" Title: optiups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "OPTIUPS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
optiups \- Driver for Opti\-UPS (Viewsonic) UPS and Zinto D (ONLINE\-USV) equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the optiups driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
\fBoptiups\fR was originally written against a PowerES 280es in nut\-0\&.45\&. It was revised for nut\-2\&.0\&.1 and tested against a PowerES 420E\&. It is expected to work with at least the PowerES, PowerPS, and PowerVS models\&.
.sp
This driver additionally supports a Zinto D from ONLINE USV\-Systeme AG because of their very similar commands, but it is unknown if it also works with other UPS from them\&.
.sp
This driver will not work with the PowerES stock serial cable\&. You will need to construct your own three conductor cable:
.sp
.if n \{\
.RS 4
.\}
.nf
UPS 6 \-> PC 3
UPS 9 \-> PC 2
UPS 4 \-> PC 5
.fi
.if n \{\
.RE
.\}
.sp
The cable for Online\-USV uses pin UPS 7 (not UPS 4) → PC 5\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5) file:
.PP
\fBstatus_only\fR
.RS 4
Only poll for critical status information\&. Without this,
\fBoptiups\fR
(and all NUT drivers) poll all sorts of information from the UPS fairly often\&. It is probably not often enough to hurt anything, so this option probably is not very useful, unless you have a flaky serial connection or a highly loaded machine\&.
.RE
.PP
\fBnowarn_noimp\fR
.RS 4
Does not print warnings when the UPS reports that a variable is not implemented or not pollable\&. Without the option you will get a message sent to your system logs each time NUT polls the UPS\&. If you specify
\fBnowarn_noimp\fR, this message will only be logged once\&.
.RE
.PP
\fBfake_lowbatt\fR
.RS 4
This forces the low battery flag true\&. Without it, if you want to test your UPS, you will have to unplug it and wait until the battery drops to a low/critical voltage level before NUT will respond and power down your system\&. With the flag, NUT should power down the system soon after you pull the plug\&. When you are done testing, you should remove this flag\&.
.sp
For basic shutdown configuration testing, the command
\fIupsmon \-c fsd\fR
is preferred\&.
.RE
.PP
\fBpowerup\fR
.RS 4
Zinto D from ONLINE\-USV cannot be identified when switched to standby\&. Set this flag to allow the driver to power\-up your Zinto UPS\&. This will also power\-up your equipment connected to the UPS!
.RE
.SH "BUGS"
.sp
On the 420E, ups\&.serial and ups\&.temperature are unsupported features\&. This is not a bug in NUT or the NUT driver, just the way things are with this UPS\&.
.SH "AUTHOR"
.sp
Russell Kroll, Scott Heavner, Matthias Goebl
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

92
docs/man/optiups.txt Normal file
View file

@ -0,0 +1,92 @@
OPTIUPS(8)
==========
NAME
----
optiups - Driver for Opti-UPS (Viewsonic) UPS and Zinto D (ONLINE-USV) equipment
NOTE
----
This man page only documents the hardware-specific features of the
optiups driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
*optiups* was originally written against a PowerES 280es in nut-0.45. It was
revised for nut-2.0.1 and tested against a PowerES 420E. It is expected to
work with at least the PowerES, PowerPS, and PowerVS models.
This driver additionally supports a Zinto D from ONLINE USV-Systeme AG
because of their very similar commands, but it is unknown if it also works
with other UPS from them.
This driver will not work with the PowerES stock serial cable. You will need
to construct your own three conductor cable:
UPS 6 -> PC 3
UPS 9 -> PC 2
UPS 4 -> PC 5
The cable for Online-USV uses pin UPS 7 (not UPS 4) -> PC 5.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5] file:
*status_only*::
Only poll for critical status information. Without this, *optiups* (and
all NUT drivers) poll all sorts of information from the UPS fairly often.
It is probably not often enough to hurt anything, so this option probably
is not very useful, unless you have a flaky serial connection or a highly
loaded machine.
*nowarn_noimp*::
Does not print warnings when the UPS reports that a variable is not
implemented or not pollable. Without the option you will get a message
sent to your system logs each time NUT polls the UPS. If you specify
*nowarn_noimp*, this message will only be logged once.
*fake_lowbatt*::
This forces the low battery flag true. Without it, if you want to test your
UPS, you will have to unplug it and wait until the battery drops to a low/critical
voltage level before NUT will respond and power down your system. With the flag,
NUT should power down the system soon after you pull the plug. When you are done
testing, you should remove this flag.
+
For basic shutdown configuration testing, the command 'upsmon -c fsd' is preferred.
*powerup*::
Zinto D from ONLINE-USV cannot be identified when switched to standby.
Set this flag to allow the driver to power-up your Zinto UPS.
This will also power-up your equipment connected to the UPS!
BUGS
----
On the 420E, `ups.serial` and `ups.temperature` are unsupported features. This
is not a bug in NUT or the NUT driver, just the way things are with this UPS.
AUTHOR
------
Russell Kroll, Scott Heavner, Matthias Goebl
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

267
docs/man/powercom.8 Normal file
View file

@ -0,0 +1,267 @@
'\" t
.\" Title: powercom
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "POWERCOM" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
powercom \- UPS driver for Powercom/Trust/Advice UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the powercom driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports many similar kinds of UPS hardware\&. The most common ones are the Trust 425/625, Powercom, and Advice Partner/King PR750\&. Others using the same protocol may also work\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5) file:
.PP
\fBlinevoltage\fR=\fIvalue\fR
.RS 4
An integer specifying the mains voltage\&. It can\(cqt be auto detected\&. Acceptable values are in the range of 110\(em120 or 220\(em240\&. The default is
\fI230\fR\&.
.RE
.PP
\fBmanufacturer\fR=\fIname\fR
.RS 4
Specify the manufacturer name, which also can\(cqt be auto detected\&. This is a user defined string, so any name is acceptable\&. The default is
\fIPowerCom\fR\&.
.RE
.PP
\fBmodelname\fR=\fIname\fR
.RS 4
Specify the model name, which also can\(cqt be auto detected\&. This is a user defined string, so any name is acceptable\&. The default is
\fIUnknown\fR\&.
.RE
.PP
\fBserialnumber\fR=\fIvalue\fR
.RS 4
Like modelname above, but for the serial number\&. The default is
\fIUnknown\fR\&.
.RE
.PP
\fBtype\fR=\fIname\fR
.RS 4
The exact type of the communication protocol within the powercom family, that will be used to communicate with the UPS\&. The type is named after the first modelname that was coded with that protocol\&. The acceptable names are
\fIKP625AP\fR,
\fITrust\fR,
\fIEgys\fR,
\fIKIN\fR,
\fIBNT\fR,
\fIIMP\fR
and
\fIBNT\-other\fR\&. The default is
\fITrust\fR\&.
.sp
\fIBNT\-other\fR
is a special type for BNT 100\-120V models\&. For this type you can (I think must!) specify voltage, batteryPercentage, loadPercentage and validationSequence\&.
.RE
.PP
\fBnumOfBytesFromUPS\fR=\fIvalue\fR
.RS 4
The number of bytes in a UPS frame\&. The default is type\-dependent and is given below\&.
.RE
.PP
\fBmethodOfFlowControl\fR=\fIname\fR
.RS 4
The method of serial communication flow control that is engaged by the UPS\&. The default is type\-dependent and is given below\&. Acceptable names are
\fIdtr0rts1\fR,
\fIdtr1\fR
or
\fIno_flow_control\fR\&.
.RE
.PP
\fBshutdownArguments\fR={{\fIminutes\fR,\fIseconds\fR},\fIwhether_minutes_should_be_used\fR}
.RS 4
The minutes and seconds that the UPS should wait between receiving the shutdown command and actually shutting off\&. The other argument should be set to the character
\fIn\fR
only when the minutes value should be skipped and not sent to the UPS\&. The default is type\-dependent and is given below\&. The braces and commas are mandatory\&. Note that there should be no whitespace characters\&.
.RE
.PP
\fBvoltage\fR={\fIcoefficient1\fR,\fIcoefficient2\fR,\fIcoefficient3\fR,\fIcoefficient4\fR}
.RS 4
(Only for types KP625AP, Trust, Egys, BNT\-other\&.) A quad that is used convert the raw data to a human\-readable voltage reading\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as well as the lack of whitespace characters\&.
.RE
.PP
\fBfrequency\fR={\fIcoefficient1\fR,\fIcoefficient2\fR}
.RS 4
(Only for types KP625AP, Trust, Egys\&.) A pair to convert the raw data to a human\-readable frequency reading\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory as well, as the lack of whitespace characters\&.
.RE
.PP
\fBbatteryPercentage\fR={\fIcoefficient1\fR,\fIcoefficient2\fR,\fIcoefficient3\fR,\fIcoefficient4\fR,\fIcoefficient5\fR}
.RS 4
(Only for KP625AP, Trust, Egys, BNT\-other\&.) A 5 tuple to convert the raw data to a human\-readable battery percentage reading\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as the lack of white space characters\&.
.RE
.PP
\fBloadPercentage\fR={\fIcoefficient1\fR,\fIcoefficient2\fR,\fIcoefficient3\fR,\fIcoefficient4\fR}
.RS 4
(Only for types KP625AP, Trust, Egys, BNT\-other\&.) A quad to convert the raw data to human readable load percentage reading\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as the lack of white space characters\&.
.RE
.PP
\fBvalidationSequence\fR={{\fIindex1\fR,\fIvalue1\fR},{\fIindex2\fR,\fIvalue2\fR},{\fIindex3\fR,\fIvalue3\fR}}
.RS 4
(Only for types KP625AP, Trust, Egys, BNT\-other\&.) 3 pairs to be used for validating the UPS by comparing bytes of the raw data with constant values\&. The default is type\-dependent and is given below\&. The braces and commas are mandatory, as the lack of white space characters\&.
.RE
.SH "DEFAULT VALUES FOR THE EXTRA ARGUMENTS"
.sp
.if n \{\
.RS 4
.\}
.nf
linevoltage = 230
manufacturer = PowerCom
modelname = Unknown
serialnumber = Unknown
type = Trust
.fi
.if n \{\
.RE
.\}
.sp
The rest of the default values for the extra arguments are type\-dependent:
.SS "Trust"
.sp
.if n \{\
.RS 4
.\}
.nf
numOfBytesFromUPS = 11
methodOfFlowControl = dtr0rts1
validationSequence = {{5,0},{7,0},{8,0}}
shutdownArguments = {{0,10},n}
frequency = {0\&.00020997,0\&.00020928}
loadPercentage = {6\&.1343,\-0\&.3808,4\&.3110,0\&.1811}
batteryPercentage = {5\&.0000,0\&.3268,\-825\&.00,4\&.5639,\-835\&.82}
voltage = {1\&.9216,\-0\&.0977,0\&.9545,0\&.0000}
.fi
.if n \{\
.RE
.\}
.SS "KP625AP"
.sp
.if n \{\
.RS 4
.\}
.nf
numOfBytesFromUPS = 16
methodOfFlowControl = dtr0rts1
validationSequence = {{5,0x80},{7,0},{8,0}}
shutdownArguments = {{0,10},n}
frequency = {0\&.00020997,0\&.00020928}
loadPercentage = {6\&.1343,\-0\&.3808,4\&.3110,0\&.1811}
batteryPercentage = {5\&.0000,0\&.3268,\-825\&.00,4\&.5639,\-835\&.82}
voltage = {1\&.9216,\-0\&.0977,0\&.9545,0\&.0000}
.fi
.if n \{\
.RE
.\}
.SS "Egys"
.sp
.if n \{\
.RS 4
.\}
.nf
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{5,0x80},{7,0},{8,0}}
shutdownArguments = {{0,10},n}
frequency = {0\&.00020997,0\&.00020928}
loadPercentage = {6\&.1343,\-0\&.3808,1\&.3333,0\&.6667}
batteryPercentage = {5\&.0000,0\&.3268,\-825\&.00,2\&.2105,\-355\&.37}
voltage = {1\&.9216,\-0\&.0977,0\&.9545,0\&.0000}
.fi
.if n \{\
.RE
.\}
.SS "IMP"
.sp
.if n \{\
.RS 4
.\}
.nf
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{5,0xFF},{7,0},{8,0}}
shutdownArguments = {{1,30},y}
.fi
.if n \{\
.RE
.\}
.SS "KIN"
.sp
.if n \{\
.RS 4
.\}
.nf
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{11,0x4b},{8,0},{8,0}}
shutdownArguments = {{1,30},y}
.fi
.if n \{\
.RE
.\}
.SS "BNT"
.sp
.if n \{\
.RS 4
.\}
.nf
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{11,0x42},{8,0},{8,0}}
shutdownArguments = {{1,30},y}
.fi
.if n \{\
.RE
.\}
.SS "BNT\-other"
.sp
.if n \{\
.RS 4
.\}
.nf
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{8,0},{8,0},{8,0}}
shutdownArguments = {{1,30},y}
loadPercentage = {1\&.4474,0\&.0,0\&.8594,0\&.0}
batteryPercentage = {5\&.0000,0\&.3268,\-825\&.00,0\&.46511,0}
voltage = {1\&.9216,\-0\&.0977,0\&.82857,0\&.0000}
.fi
.if n \{\
.RE
.\}
.SH "AUTHOR"
.sp
Peter Bieringer <pb@bieringer\&.de>, Alexey Sidorov <alexsid@altlinux\&.org>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

205
docs/man/powercom.txt Normal file
View file

@ -0,0 +1,205 @@
POWERCOM(8)
===========
NAME
----
powercom - UPS driver for Powercom/Trust/Advice UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
powercom driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports many similar kinds of UPS hardware. The most common
ones are the Trust 425/625, Powercom, and Advice Partner/King PR750.
Others using the same protocol may also work.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5] file:
*linevoltage*='value'::
An integer specifying the mains voltage. It can't be auto detected.
Acceptable values are in the range of 110--120 or 220--240. The default
is '230'.
*manufacturer*='name'::
Specify the manufacturer name, which also can't be auto detected. This is
a user defined string, so any name is acceptable. The default is
'PowerCom'.
*modelname*='name'::
Specify the model name, which also can't be auto detected. This is a
user defined string, so any name is acceptable. The default is
'Unknown'.
*serialnumber*='value'::
Like modelname above, but for the serial number. The default is
'Unknown'.
*type*='name'::
The exact type of the communication protocol within the powercom family,
that will be used to communicate with the UPS. The type is named after
the first modelname that was coded with that protocol. The acceptable
names are 'KP625AP', 'Trust', 'Egys', 'KIN', 'BNT', 'IMP' and 'BNT-other'. The
default is 'Trust'.
+
'BNT-other' is a special type for BNT 100-120V models.
For this type you can (I think must!) specify voltage, batteryPercentage,
loadPercentage and validationSequence.
*numOfBytesFromUPS*='value'::
The number of bytes in a UPS frame. The default is type-dependent and
is given below.
*methodOfFlowControl*='name'::
The method of serial communication flow control that is engaged by the
UPS. The default is type-dependent and is given below. Acceptable names
are 'dtr0rts1', 'dtr1' or 'no_flow_control'.
*shutdownArguments*={{'minutes','seconds'},'whether_minutes_should_be_used'}::
The minutes and seconds that the UPS should wait between receiving the
shutdown command and actually shutting off. The other argument should
be set to the character 'n' only when the minutes value should be
skipped and not sent to the UPS. The default is type-dependent and is
given below. The braces and commas are mandatory. Note that there should
be no whitespace characters.
*voltage*={'coefficient1','coefficient2','coefficient3','coefficient4'}::
(Only for types KP625AP, Trust, Egys, BNT-other.)
A quad that is used convert the raw data to a human-readable voltage
reading. The default is type-dependent and is given below. Do note that
the braces and commas are mandatory, as well as the lack of whitespace
characters.
*frequency*={'coefficient1','coefficient2'}::
(Only for types KP625AP, Trust, Egys.)
A pair to convert the raw data to a human-readable frequency reading. The
default is type-dependent and is given below. Do note that the braces
and commas are mandatory as well, as the lack of whitespace characters.
*batteryPercentage*={'coefficient1','coefficient2','coefficient3','coefficient4','coefficient5'}::
(Only for KP625AP, Trust, Egys, BNT-other.)
A 5 tuple to convert the raw data to a human-readable battery percentage
reading. The default is type-dependent and is given below. Do note that
the braces and commas are mandatory, as the lack of white space
characters.
*loadPercentage*={'coefficient1','coefficient2','coefficient3','coefficient4'}::
(Only for types KP625AP, Trust, Egys, BNT-other.)
A quad to convert the raw data to human readable load percentage
reading. The default is type-dependent and is given below. Do note that
the braces and commas are mandatory, as the lack of white space
characters.
*validationSequence*={{'index1','value1'},{'index2','value2'},{'index3','value3'}}::
(Only for types KP625AP, Trust, Egys, BNT-other.)
3 pairs to be used for validating the UPS by comparing bytes of the raw
data with constant values. The default is type-dependent and is given
below. The braces and commas are mandatory, as the lack of white space
characters.
DEFAULT VALUES FOR THE EXTRA ARGUMENTS
--------------------------------------
linevoltage = 230
manufacturer = PowerCom
modelname = Unknown
serialnumber = Unknown
type = Trust
The rest of the default values for the extra arguments are type-dependent:
Trust
~~~~~
numOfBytesFromUPS = 11
methodOfFlowControl = dtr0rts1
validationSequence = {{5,0},{7,0},{8,0}}
shutdownArguments = {{0,10},n}
frequency = {0.00020997,0.00020928}
loadPercentage = {6.1343,-0.3808,4.3110,0.1811}
batteryPercentage = {5.0000,0.3268,-825.00,4.5639,-835.82}
voltage = {1.9216,-0.0977,0.9545,0.0000}
KP625AP
~~~~~~~
numOfBytesFromUPS = 16
methodOfFlowControl = dtr0rts1
validationSequence = {{5,0x80},{7,0},{8,0}}
shutdownArguments = {{0,10},n}
frequency = {0.00020997,0.00020928}
loadPercentage = {6.1343,-0.3808,4.3110,0.1811}
batteryPercentage = {5.0000,0.3268,-825.00,4.5639,-835.82}
voltage = {1.9216,-0.0977,0.9545,0.0000}
Egys
~~~~
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{5,0x80},{7,0},{8,0}}
shutdownArguments = {{0,10},n}
frequency = {0.00020997,0.00020928}
loadPercentage = {6.1343,-0.3808,1.3333,0.6667}
batteryPercentage = {5.0000,0.3268,-825.00,2.2105,-355.37}
voltage = {1.9216,-0.0977,0.9545,0.0000}
IMP
~~~
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{5,0xFF},{7,0},{8,0}}
shutdownArguments = {{1,30},y}
KIN
~~~
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{11,0x4b},{8,0},{8,0}}
shutdownArguments = {{1,30},y}
BNT
~~~
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{11,0x42},{8,0},{8,0}}
shutdownArguments = {{1,30},y}
BNT-other
~~~~~~~~~
numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{8,0},{8,0},{8,0}}
shutdownArguments = {{1,30},y}
loadPercentage = {1.4474,0.0,0.8594,0.0}
batteryPercentage = {5.0000,0.3268,-825.00,0.46511,0}
voltage = {1.9216,-0.0977,0.82857,0.0000}
AUTHOR
------
Peter Bieringer <pb@bieringer.de>,
Alexey Sidorov <alexsid@altlinux.org>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

113
docs/man/powerman-pdu.8 Normal file
View file

@ -0,0 +1,113 @@
'\" t
.\" Title: powerman-pdu
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "POWERMAN\-PDU" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
powerman-pdu \- Driver for Powerman PDU
.SH "SYNOPSIS"
.sp
\fBpowerman\-pdu\fR \-h
.sp
\fBpowerman\-pdu\fR \-a \fIPDU_NAME\fR [\fIOPTIONS\fR]
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
This man page only documents the hardware\-specific features of the powerman\-pdu driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.sp .5v
.RE
.SH "SUPPORTED HARDWARE"
.sp
This driver supports a wide range of PDUs through the Powerman project\&.
.sp
This includes various models from APC, Baytech, Cyclades, but also support IPMI and various blade management modules from HP, IBM and Sun\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver doesn\(cqt support any optional settings\&.
.SH "INSTALLATION"
.sp
This driver is not built by default\&. You can build it by using "configure \-\-with\-powerman=yes"\&.
.SH "UPS COMMANDS"
.sp
The following instant commands (see \fBupscmd\fR(8)) are available for each outlet of the PDU, with \fBX\fR standing for the outlet number:
.PP
\fBoutlet\&.X\&.load\&.on\fR
.RS 4
Power on the outlet\&.
.RE
.PP
\fBoutlet\&.X\&.load\&.off\fR
.RS 4
Power off the outlet\&.
.RE
.PP
\fBoutlet\&.X\&.load\&.cycle\fR
.RS 4
Cycle the outlet (power off then power on, possibly with a delay)\&.
.RE
.SH "IMPLEMENTATION"
.sp
The hostname of the Powerman server is specified using the "port" value in \fBups\&.conf\fR, i\&.e\&.:
.sp
.if n \{\
.RS 4
.\}
.nf
[pdu]
driver = powerman\-pdu
port = host\&.example\&.com:port
.fi
.if n \{\
.RE
.\}
.sp
The port used to reach \fIpowermand\fR is optional if the default port is used\&.
.SH "KNOWN ISSUES"
.sp
In the current NUT version (2\&.4\&.1), ups\&.status is still exposed, with the value "WAIT"\&. Some other values from the ups collection are also exposed\&.
.SH "AUTHOR"
.sp
Arnaud Quette <arnaud\&.quette@gmail\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/
.sp
The PowerMan home page: http://powerman\&.sourceforge\&.net/

87
docs/man/powerman-pdu.txt Normal file
View file

@ -0,0 +1,87 @@
POWERMAN-PDU(8)
===============
NAME
----
powerman-pdu - Driver for Powerman PDU
SYNOPSIS
--------
*powerman-pdu* -h
*powerman-pdu* -a 'PDU_NAME' ['OPTIONS']
NOTE: This man page only documents the hardware-specific features of the
powerman-pdu driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports a wide range of PDUs through the Powerman project.
This includes various models from APC, Baytech, Cyclades, but also support
IPMI and various blade management modules from HP, IBM and Sun.
EXTRA ARGUMENTS
---------------
This driver doesn't support any optional settings.
INSTALLATION
------------
This driver is not built by default. You can build it by using
"configure --with-powerman=yes".
UPS COMMANDS
------------
The following instant commands (see linkman:upscmd[8]) are available for each
outlet of the PDU, with *X* standing for the outlet number:
*outlet.X.load.on*::
Power on the outlet.
*outlet.X.load.off*::
Power off the outlet.
*outlet.X.load.cycle*::
Cycle the outlet (power off then power on, possibly with a delay).
IMPLEMENTATION
--------------
The hostname of the Powerman server is specified using the "port" value in
*ups.conf*, i.e.:
[pdu]
driver = powerman-pdu
port = host.example.com:port
The port used to reach 'powermand' is optional if the default port is used.
KNOWN ISSUES
------------
In the current NUT version (2.4.1), ups.status is still exposed, with the value
"WAIT". Some other values from the
ups collection are also exposed.
AUTHOR
------
Arnaud Quette <arnaud.quette@gmail.com>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
The PowerMan home page: http://powerman.sourceforge.net/

172
docs/man/powerpanel.8 Normal file
View file

@ -0,0 +1,172 @@
'\" t
.\" Title: powerpanel
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "POWERPANEL" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
powerpanel \- Driver for PowerPanel Plus compatible UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the powerpanel driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports CyberPower BC1200, PR2200 and many other similar devices, both for the text and binary protocols\&. The driver will autodetect which protocol is used\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in \fBups.conf\fR(5):
.PP
\fBprotocol=\fR[\fItext,binary\fR]
.RS 4
Override the default autodetection of the protocol\&.
.RE
.PP
\fBmanufacturer=\fR\fIvalue\fR
.RS 4
If you don\(cqt like the autodetected value, you can override this by setting it here\&.
.RE
.PP
\fBmodel=\fR\fIvalue\fR
.RS 4
Like manufacturer above\&.
.RE
.PP
\fBserial=\fR\fIvalue\fR
.RS 4
Like manufacturer above\&.
.RE
.PP
\fBondelay=\fR\fIvalue\fR
.RS 4
Time to wait before switching on the UPS (1 \- 9999 minutes, 0=indefinite)\&. Only available with the text protocol driver (see
Support Status)\&.
.RE
.PP
\fBoffdelay=\fR\fIvalue\fR
.RS 4
Time to wait before shutting down the UPS (6 \- 600 seconds)\&. Values below 60 seconds will be truncated to 6 seconds intervals, values above 60 seconds to 60 seconds intervals\&. Only available with the text protocol driver (see
Support Status)\&.
.RE
.SH "VARIABLES"
.sp
Depending on the type of your UPS unit, some of the following variables may be changed with \fBupsrw\fR(8)\&. If the driver can\(cqt read a variable from the UPS, it will not be made available\&.
.PP
\fBinput\&.transfer\&.high\fR
.RS 4
writable: high transfer voltage point in V
.RE
.PP
\fBinput\&.transfer\&.low\fR
.RS 4
writable: low transfer voltage point in V
.RE
.PP
\fBbattery\&.charge\&.low\fR
.RS 4
writable: remaining battery charge percentage for low battery warning
.RE
.PP
\fBoutput\&.voltage\&.nominal\fR
.RS 4
writable: nominal output voltage in V
.RE
.PP
\fBups\&.start\&.battery\fR
.RS 4
writable: allow cold start from battery
.RE
.SH "COMMANDS"
.sp
Depending on the type of your UPS unit, some of the following commands may be available\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
test\&.battery\&.start\&.quick, test\&.battery\&.stop
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
beeper\&.enable, beeper\&.disable, beeper\&.toggle
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
shutdown\&.return, shutdown\&.reboot, shutdown\&.stayoff
.RE
.sp
On many devices, these commands are unreliable, so before using them you must verify that these work as expected (see Shutdown Issues)\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
shutdown\&.stop
.RE
.SH "SUPPORT STATUS"
.sp
Vendor support is absent for this driver, so if you need some features that are currently not available, provide ample documentation on what the driver should sent to the UPS in order to make this work\&. If more information would be available on the binary protocol, it would probably be possible to make \fIondelay\fR and \fIoffdelay\fR configurable\&. So far, nobody has taken the time to investigate what we should tell the UPS to make this work, and CyberPower isn\(cqt willing to share this with us\&.
.SH "SHUTDOWN ISSUES"
.sp
If the \fBshutdown\&.return\fR command on your UPS doesn\(cqt seem to work, chances are that your UPS is an older model\&. Try a couple of different settings for \fIoffdelay\fR\&. If no value in the range 6\&.\&.600 works, your UPS likely doesn\(cqt support this\&. In order to get the expected behaviour, it requires \fBshutdown\&.stayoff\fR (when on battery) and \fBshutdown\&.reboot\fR (when on mains)\&. The driver will automatically fallback to these commands if \fBshutdown\&.return\fR fails, and tries to detect which one should be used when called with the \fI\-k\fR option (or through \fBupsdrvctl shutdown\fR)\&.
.sp
This isn\(cqt bullet\-proof, however, and you should be prepared that the power will either not be shutdown or that it doesn\(cqt return when the power comes back\&. All models supported by the binary protocol and many supported through the text protocol are affected by this\&.
.SH "KNOWN PROBLEMS"
.sp
The CyberPower OP series don\(cqt offer direct voltage, charge, frequency and temperature readings\&. Instead, they will return a binary value that needs conversion to the actual value\&.
.sp
The exact conversion needed is unknown at the time of this writing, hence an estimation was made based om readings from actual devices\&. This may (probably will) be off, possibly a lot\&. Unless you can tell us the exact mapping between values from the UPS and actual readings, don\(cqt bother to complain\&. We\(cqve done the best we can based on the limited information available\&. Remember, a UPS isn\(cqt a measuring instrument\&.
.SH "AUTHORS"
.sp
Arjen de Korte <arjen@de\-korte\&.org>, Doug Reynolds <mav@wastegate\&.net>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

138
docs/man/powerpanel.txt Normal file
View file

@ -0,0 +1,138 @@
POWERPANEL(8)
=============
NAME
----
powerpanel - Driver for PowerPanel Plus compatible UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
powerpanel driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports CyberPower BC1200, PR2200 and many other similar
devices, both for the text and binary protocols. The driver will
autodetect which protocol is used.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in linkman:ups.conf[5]:
*protocol=*['text,binary']::
Override the default autodetection of the protocol.
*manufacturer=*'value'::
If you don't like the autodetected value, you can override this by setting
it here.
*model=*'value'::
Like manufacturer above.
*serial=*'value'::
Like manufacturer above.
*ondelay=*'value'::
Time to wait before switching on the UPS (1 - 9999 minutes, 0=indefinite).
Only available with the text protocol driver (see <<_support_status,Support Status>>).
*offdelay=*'value'::
Time to wait before shutting down the UPS (6 - 600 seconds). Values below 60
seconds will be truncated to 6 seconds intervals, values above 60 seconds to
60 seconds intervals. Only available with the text protocol driver (see
<<_support_status,Support Status>>).
VARIABLES
---------
Depending on the type of your UPS unit, some of the following variables may
be changed with linkman:upsrw[8]. If the driver can't read a variable from the
UPS, it will not be made available.
*input.transfer.high*::
writable: high transfer voltage point in V
*input.transfer.low*::
writable: low transfer voltage point in V
*battery.charge.low*::
writable: remaining battery charge percentage for low battery warning
*output.voltage.nominal*::
writable: nominal output voltage in V
*ups.start.battery*::
writable: allow cold start from battery
COMMANDS
--------
Depending on the type of your UPS unit, some of the following commands may
be available.
* test.battery.start.quick, test.battery.stop
* beeper.enable, beeper.disable, beeper.toggle
* shutdown.return, shutdown.reboot, shutdown.stayoff
On many devices, these commands are unreliable, so before using them you
must verify that these work as expected (see <<_shutdown_issues,Shutdown Issues>>).
* shutdown.stop
SUPPORT STATUS
--------------
Vendor support is absent for this driver, so if you need some features that
are currently not available, provide ample documentation on what the driver
should sent to the UPS in order to make this work. If more information
would be available on the binary protocol, it would probably be possible to
make 'ondelay' and 'offdelay' configurable. So far, nobody has taken the time
to investigate what we should tell the UPS to make this work, and CyberPower
isn't willing to share this with us.
SHUTDOWN ISSUES
---------------
If the *shutdown.return* command on your UPS doesn't seem to work,
chances are that your UPS is an older model. Try a couple of different
settings for 'offdelay'. If no value in the range 6..600 works, your
UPS likely doesn't support this. In order to get the expected behaviour,
it requires *shutdown.stayoff* (when on battery) and *shutdown.reboot*
(when on mains). The driver will automatically fallback to these commands if
*shutdown.return* fails, and tries to detect which one should be used when
called with the '-k' option (or through *upsdrvctl shutdown*).
This isn't bullet-proof, however, and you should be prepared that the
power will either not be shutdown or that it doesn't return when the
power comes back. All models supported by the binary protocol and many
supported through the text protocol are affected by this.
KNOWN PROBLEMS
--------------
The CyberPower OP series don't offer direct voltage, charge, frequency
and temperature readings. Instead, they will return a binary value
that needs conversion to the actual value.
The exact conversion needed is unknown at the time of this writing,
hence an estimation was made based om readings from actual devices.
This may (probably will) be off, possibly a lot. Unless you can tell
us the exact mapping between values from the UPS and actual readings,
don't bother to complain. We've done the best we can based on the
limited information available. Remember, a UPS isn't a measuring
instrument.
AUTHORS
-------
Arjen de Korte <arjen@de-korte.org>, Doug Reynolds <mav@wastegate.net>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

154
docs/man/rhino.8 Normal file
View file

@ -0,0 +1,154 @@
'\" t
.\" Title: rhino
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "RHINO" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
rhino \- Driver for Brazilian Microsol RHINO UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the rhino driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver has been tested with :
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rhino 6000 VA
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rhino 7500 VA
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rhino 10000 VA
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rhino 20000 VA
.RE
.sp
All Rhino models are sinusoidal on\-line\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver support the following extra optional settings in \fBups.conf\fR(5):
.sp
\fBbattext = n\fR \- (default = 0, no extra battery, where n = Ampere*hour )
.SH "COMMANDS"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
load\&.on \- Turn on the load immediately
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
load\&.off \- Turn off the load immediately
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bypass\&.start \- Put the UPS in bypass mode
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bypass\&.stop \- Put the UPS out of bypass mode
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
shutdown\&.stayoff \- Shut down in 3 minutes and do not return
.RE
.SH "AUTHOR"
.sp
Silvino B\&. Magalhães <sbm2yk@gmail\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

59
docs/man/rhino.txt Normal file
View file

@ -0,0 +1,59 @@
RHINO(8)
========
NAME
----
rhino - Driver for Brazilian Microsol RHINO UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
rhino driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver has been tested with :
* Rhino 6000 VA
* Rhino 7500 VA
* Rhino 10000 VA
* Rhino 20000 VA
All Rhino models are sinusoidal on-line.
EXTRA ARGUMENTS
---------------
This driver support the following extra optional settings in
linkman:ups.conf[5]:
*battext = n* - (default = 0, no extra battery, where n = Ampere*hour )
COMMANDS
--------
* load.on - Turn on the load immediately
* load.off - Turn off the load immediately
* bypass.start - Put the UPS in bypass mode
* bypass.stop - Put the UPS out of bypass mode
* shutdown.stayoff - Shut down in 3 minutes and do not return
AUTHOR
------
Silvino B. Magalhães <sbm2yk@gmail.com>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

55
docs/man/richcomm_usb.8 Normal file
View file

@ -0,0 +1,55 @@
'\" t
.\" Title: richcomm_usb
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "RICHCOMM_USB" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
richcomm_usb \- Driver UPS equipment using Richcomm dry\-contact to USB solution
.SH "NOTE"
.sp
This man page only documents the specific features of the richcomm_usb driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
The Richcomm dry\-contact to USB solution is a generic interface that is used to upgrade an existing (RS\-232) contact closure UPS interface to USB\&. As such, all the limitations of the underlying contact closure interface apply\&. This means that you will only get the essentials in ups\&.status: OL, OB, and LB\&. See also \fBgenericups\fR(8)\&.
.SH "BUGS"
.sp
Most contact\-closure UPSes will not power down the load if the line power is present\&. This can create a race when using slave \fBupsmon\fR(8) systems\&. See the \fBupsmon\fR(8) man page for more information\&.
.sp
The solution to both of these problems is to upgrade to a smart protocol UPS of some kind that allows detection and proper load cycling on command\&.
.SH "AUTHORS"
.sp
Peter van Valderen <p\&.v\&.valderen at probu\&.nl>, Dirk Teurlings <dirk at upexia\&.nl>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "The generic serial driver:"
.sp
\fBgenericups\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

50
docs/man/richcomm_usb.txt Normal file
View file

@ -0,0 +1,50 @@
RICHCOMM_USB(8)
===============
NAME
----
richcomm_usb - Driver UPS equipment using Richcomm dry-contact to USB
solution
NOTE
----
This man page only documents the specific features of the richcomm_usb
driver. For information about the core driver, see linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
The Richcomm dry-contact to USB solution is a generic interface that is
used to upgrade an existing (RS-232) contact closure UPS interface to USB.
As such, all the limitations of the underlying contact closure interface
apply. This means that you will only get the essentials in ups.status: OL,
OB, and LB. See also linkman:genericups[8].
BUGS
----
Most contact-closure UPSes will not power down the load if the line power
is present. This can create a race when using slave linkman:upsmon[8]
systems. See the linkman:upsmon[8] man page for more information.
The solution to both of these problems is to upgrade to a smart protocol
UPS of some kind that allows detection and proper load cycling on command.
AUTHORS
-------
Peter van Valderen <p.v.valderen at probu.nl>,
Dirk Teurlings <dirk at upexia.nl>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
The generic serial driver:
~~~~~~~~~~~~~~~~~~~~~~~~~~
linkman:genericups[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

135
docs/man/safenet.8 Normal file
View file

@ -0,0 +1,135 @@
'\" t
.\" Title: safenet
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "SAFENET" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
safenet \- Driver for SafeNet compatible UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the safenet driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports UPS equipment which can be controlled via SafeNet v1\&.0 for Windows (serial interface only)\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5) file:
.PP
\fBmanufacturer=\fR\fIvalue\fR
.RS 4
Autodetection of this parameter is not possible yet (and it probably never will be)\&. Therefore, this user\-defined string accepts any name\&. The default is
\fIunknown\fR\&.
.RE
.PP
\fBmodelname=\fR\fIvalue\fR
.RS 4
Like manufacturer above\&. The default is
\fIunknown\fR\&.
.RE
.PP
\fBserialnumber=\fR\fIvalue\fR
.RS 4
Like manufacturer above\&. The default is
\fIunknown\fR\&.
.RE
.PP
\fBondelay=\fR\fIvalue\fR
.RS 4
Time to wait before switching on the UPS (minutes)\&. Defaults to 1 minute\&.
.RE
.PP
\fBoffdelay=\fR\fIvalue\fR
.RS 4
Time to wait before shutting down the UPS (seconds)\&. Defaults to 30 seconds\&.
.RE
.SH "UPSCMD"
.sp
This driver supports some instant commands (see \fBupscmd\fR(8)):
.PP
\fBtest\&.battery\&.start\fR
.RS 4
Start UPS self test
.RE
.PP
\fBtest\&.battery\&.stop\fR
.RS 4
Cancel UPS self test
.RE
.PP
\fBtest\&.failure\&.start\fR
.RS 4
Start simulated power failure
.RE
.PP
\fBtest\&.failure\&.stop\fR
.RS 4
Cancel simulated power failure
.RE
.PP
\fBbeeper\&.enable\fR
.RS 4
Enable the UPS beeper
.RE
.PP
\fBbeeper\&.mute\fR
.RS 4
Temporarily mute the UPS beeper
.RE
.PP
\fBbeeper\&.toggle\fR
.RS 4
Toggle the UPS beeper
.RE
.PP
\fBshutdown\&.return\fR
.RS 4
Turn off the load and wait for the power to return\&. Uses the timer defined by
\fBoffdelay\fR\&.
.RE
.PP
\fBshutdown\&.reboot\fR
.RS 4
Turn off the load and return\&. Uses the timers defined by
\fBoffdelay\fR
and
\fBondelay\fR\&.
.RE
.SH "KNOWN PROBLEMS"
.sp
If you run the \fBshutdown\&.return\fR command with mains present, the output may stay on or switch off and not back on again\&. The \fBshutdown\&.reboot\fR command will unconditionally switch on the load again (with or without mains present)\&.
.sp
If the driver is called with the \fI\-k\fR option (or through \fBupsdrvctl shutdown\fR) it tries to detect which command should be used in an attempt to stay off until mains is present again or to cycle the output if the power returned in the mean time\&. This isn\(cqt bullet\-proof, and you should be prepared that the power will either not be shutdown, or that it doesn\(cqt return when the power comes back\&.
.SH "AUTHOR"
.sp
Arjen de Korte <adkorte\-guest at alioth\&.debian\&.org>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

101
docs/man/safenet.txt Normal file
View file

@ -0,0 +1,101 @@
SAFENET(8)
==========
NAME
----
safenet - Driver for SafeNet compatible UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
safenet driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports UPS equipment which can be controlled via
SafeNet v1.0 for Windows (serial interface only).
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5] file:
*manufacturer=*'value'::
Autodetection of this parameter is not possible yet (and it probably
never will be). Therefore, this user-defined string accepts any name. The
default is 'unknown'.
*modelname=*'value'::
Like manufacturer above. The default is 'unknown'.
*serialnumber=*'value'::
Like manufacturer above. The default is 'unknown'.
*ondelay=*'value'::
Time to wait before switching on the UPS (minutes). Defaults to 1 minute.
*offdelay=*'value'::
Time to wait before shutting down the UPS (seconds). Defaults to 30 seconds.
UPSCMD
------
This driver supports some instant commands (see linkman:upscmd[8]):
*test.battery.start*::
Start UPS self test
*test.battery.stop*::
Cancel UPS self test
*test.failure.start*::
Start simulated power failure
*test.failure.stop*::
Cancel simulated power failure
*beeper.enable*::
Enable the UPS beeper
*beeper.mute*::
Temporarily mute the UPS beeper
*beeper.toggle*::
Toggle the UPS beeper
*shutdown.return*::
Turn off the load and wait for the power to return. Uses the timer
defined by *offdelay*.
*shutdown.reboot*::
Turn off the load and return. Uses the timers defined by *offdelay*
and *ondelay*.
KNOWN PROBLEMS
--------------
If you run the *shutdown.return* command with mains present, the output
may stay on or switch off and not back on again. The *shutdown.reboot*
command will unconditionally switch on the load again (with or without mains
present).
If the driver is called with the '-k' option (or through *upsdrvctl
shutdown*) it tries to detect which command should be used in an attempt
to stay off until mains is present again or to cycle the output if the
power returned in the mean time. This isn't bullet-proof, and you should be
prepared that the power will either not be shutdown, or that it doesn't
return when the power comes back.
AUTHOR
------
Arjen de Korte <adkorte-guest at alioth.debian.org>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

111
docs/man/skel.txt Normal file
View file

@ -0,0 +1,111 @@
SKEL(8)
=======
NAME
----
skel - skeleton driver man page
NOTE
----
This man page only documents the hardware-specific features of the
*skel* driver. For information about the core driver, see
linkman:nutupsdrv[8].
//////////////////////////////////////////
The following lines are comments.
When copying this man page for your new driver, be sure to replace all
occurrances of "skel" and "SKEL" by your actual driver name.
If you have AsciiDoc installed, you can test the formatting of your man page by
running:
asciidoc --backend=xhtml11 -o skel.html skel.txt
After writing a man page, be sure to add it to the appropriate variable in
Makefile.am in this directory.
In the "NAME" section, you must follow the format above, including separating
the driver name from its description by "-". This is to ensure that the
apropos(8) database is properly rebuilt.
//////////////////////////////////////////
SUPPORTED HARDWARE
------------------
*skel* supports ...
//////////////////////////////////////////
If the driver only works with certain cables, this is a good place to
mention it:
CABLING
-------
//////////////////////////////////////////
EXTRA ARGUMENTS
This driver also supports the following optional settings:
*option1*='num'::
Set the value of ... to 'num'. Contrast with *option2*.
*option2*='string'::
Some other option.
//////////////////////////////////////////
Optional: list supported instant commands here:
INSTANT COMMANDS
----------------
*instcmd1*::
Command 1.
//////////////////////////////////////////
//////////////////////////////////////////
Optional: use INSTALLATION if you need special parameters to the configure
script, or additional libraries as prerequisites.
INSTALLATION
------------
//////////////////////////////////////////
//////////////////////////////////////////
You may leave this as "none known at this time", or describe any trouble
encountered when implementing the protocol for your UPS.
KNOWN ISSUES AND BUGS
---------------------
*Got "EPERM: Operation not permitted" upon driver startup*::
You have forgotten to install the udev files, as explained
in the INSTALLATION section above. Don't forget to restart
udev so that it applies these changes.
//////////////////////////////////////////
//////////////////////////////////////////
An email address is not strictly necessary, but you may wish to provide
some form of contact information so that users can report bugs.
//////////////////////////////////////////
AUTHORS
-------
J Random User <user@example.org>
//////////////////////////////////////////
If this driver is ever made obsolete by another driver, mention the
replacement driver in the "SEE ALSO" section. You may also wish to point
the user to other drivers which may better support their hardware, if there
is ambiguity based on the driver name.
//////////////////////////////////////////
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

205
docs/man/snmp-ups.8 Normal file
View file

@ -0,0 +1,205 @@
'\" t
.\" Title: snmp-ups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "SNMP\-UPS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
snmp-ups \- Multi\-MIB Driver for SNMP UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the snmp\-ups driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
The snmp\-ups driver automatically detects and supports a wide range of devices by loading various MIBS: \fBietf\fR:: UPS that is RFC 1628 (UPS MIB) compliant, e\&.g\&. MGE UPS SYSTEMS, Liebert, perhaps others (default)
.PP
\fBmge\fR
.RS 4
MGE UPS SYSTEMS and MGE Office Protection Systems devices with SNMP cards (ref 66062, 66045, 66074 and 66244)
.RE
.PP
\fBapcc\fR
.RS 4
APC AP9606 APC Web/SNMP management card, perhaps others
.RE
.PP
\fBnetvision\fR
.RS 4
Socomec Sicon UPS with Netvision Web/SNMP management card/external box
.RE
.PP
\fBpw\fR
.RS 4
Powerware devices with ConnectUPS SNMP cards
.RE
.PP
\fBaphel_genesisII\fR
.RS 4
Eaton Powerware ePDU Monitored
.RE
.PP
\fBaphel_revelation\fR
.RS 4
Eaton Powerware ePDU Managed
.RE
.PP
\fBraritan\fR
.RS 4
Various Raritan PDUs
.RE
.PP
\fBbaytech\fR
.RS 4
Various BayTech PDUs
.RE
.PP
\fBcpqpower\fR
.RS 4
HP/Compaq AF401A management card, perhaps others
.RE
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5):
.PP
\fBmibs\fR=\fIname\fR
.RS 4
Set MIB compliance (default=auto, allowed entries: refer to the above SUPPORTED HARDWARE)\&. With "auto", the driver will try a select set of SNMP objects until it finds one that the device responds to\&.
.RE
.PP
\fBcommunity\fR=\fIname\fR
.RS 4
Set community name (default = public)\&. Note that you require a RW community name to change UPS settings (as for a powerdown)\&.
.RE
.PP
\fBsnmp_version\fR=\fIversion\fR
.RS 4
Set SNMP version (default = v1, the other allowed value is v2c)
.RE
.PP
\fBpollfreq\fR=\fIvalue\fR
.RS 4
Set polling frequency in seconds, to reduce network flow (default=30)
.RE
.PP
\fBnotransferoids\fR
.RS 4
Disable the monitoring of the low and high voltage transfer OIDs in the hardware\&. This will remove input\&.transfer\&.low and input\&.transfer\&.high from the list of variables\&. This should only be used on APCC Symmetra equipment which has strangeness in the three\-phase power reporting\&.
.RE
.PP
\fBsecLevel\fR=\fIvalue\fR
.RS 4
Set the securityLevel used for SNMPv3 messages (default=noAuthNoPriv, allowed: authNoPriv,authPriv)
.RE
.PP
\fBsecName\fR=\fIvalue\fR
.RS 4
Set the securityName used for authenticated SNMPv3 messages (no default)
.RE
.PP
\fBauthPassword\fR=\fIvalue\fR
.RS 4
Set the authentication pass phrase used for authenticated SNMPv3 messages (no default)
.RE
.PP
\fBprivPassword\fR=\fIvalue\fR
.RS 4
Set the privacy pass phrase used for encrypted SNMPv3 messages (no default)
.RE
.PP
\fBauthProtocol\fR=\fIvalue\fR
.RS 4
Set the authentication protocol (MD5 or SHA) used for authenticated SNMPv3 messages (default=MD5)
.RE
.PP
\fBprivProtocol\fR=\fIvalue\fR
.RS 4
Set the privacy protocol (DES or AES) used for encrypted SNMPv3 messages (default=DES)
.RE
.SH "REQUIREMENTS"
.sp
You will need to install the Net\-SNMP package from http://www\&.net\-snmp\&.org/ before building this driver\&.
.sp
SNMP v3 also requires OpenSSL support from http://www\&.openssl\&.org\&.
.SH "LIMITATION"
.SS "Shutdown"
.sp
This driver does not provide a proper upsdrv_shutdown() function\&. There probably never will be one, since at the time this script should run (near the end of the system halt script), there will be no network capabilities anymore\&. Probably the only way to shutdown an SNMP UPS is by sending it a shutdown with delay command through \fBupscmd\fR(8) and hope for the best that the system will have finished shutting down before the power is cut\&.
.SH "INSTALLATION"
.sp
This driver is only built if the Net\-SNMP development files are present on the system\&. You can also force it to be built by using "configure \-\-with\-snmp=yes" before calling make\&.
.SH "IMPLEMENTATION"
.sp
The hostname of the UPS is specified with the "port" value in ups\&.conf, i\&.e\&.:
.sp
.if n \{\
.RS 4
.\}
.nf
[snmpv1]
driver = snmp\-ups
port = snmp\-ups\&.example\&.com
community = public
snmp_version = v1
mibs = ietf
pollfreq = 15
desc = "Example SNMP v1 device"
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
[snmpv3]
driver = snmp\-ups
port = 166\&.99\&.224\&.132
mibs = mge
secLevel = authPriv
secName = mysecurityname
authPassword = myauthenticationpassphrase
privPassword = myprivatepassphrase
desc = "Example SNMP v3 device, with the highest security level"
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.sp
Arnaud Quette, Dmitry Frolov
.sp
Sponsored by Eaton http://www\&.eaton\&.com and originally by MGE UPS SYSTEMS http://www\&.mgeups\&.com/
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "NUT SNMP Protocols Library"
.sp
Available at: http://www\&.networkupstools\&.org/protocols/snmp/
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

167
docs/man/snmp-ups.txt Normal file
View file

@ -0,0 +1,167 @@
snmp-ups(8)
===========
NAME
----
snmp-ups - Multi-MIB Driver for SNMP UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
snmp-ups driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
The snmp-ups driver automatically detects and supports a wide range of devices by loading various MIBS:
*ietf*::
UPS that is RFC 1628 (UPS MIB) compliant, e.g. MGE UPS SYSTEMS, Liebert, perhaps others (default)
*mge*::
MGE UPS SYSTEMS and MGE Office Protection Systems devices with SNMP cards (ref 66062, 66045, 66074 and 66244)
*apcc*::
APC AP9606 APC Web/SNMP management card, perhaps others
*netvision*::
Socomec Sicon UPS with Netvision Web/SNMP management card/external box
*pw*::
Powerware devices with ConnectUPS SNMP cards
*aphel_genesisII*::
Eaton Powerware ePDU Monitored
*aphel_revelation*::
Eaton Powerware ePDU Managed
*raritan*::
Various Raritan PDUs
*baytech*::
Various BayTech PDUs
*cpqpower*::
HP/Compaq AF401A management card, perhaps others
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5]:
*mibs*='name'::
Set MIB compliance (default=auto, allowed entries: refer to the above SUPPORTED HARDWARE).
With "auto", the driver will try a select set of SNMP objects until it finds
one that the device responds to.
*community*='name'::
Set community name (default = public).
Note that you require a RW community name to change UPS settings (as for a powerdown).
*snmp_version*='version'::
Set SNMP version (default = v1, the other allowed value is v2c)
*pollfreq*='value'::
Set polling frequency in seconds, to reduce network flow (default=30)
*notransferoids*::
Disable the monitoring of the low and high voltage transfer OIDs in
the hardware. This will remove input.transfer.low and input.transfer.high
from the list of variables. This should only be used on APCC Symmetra
equipment which has strangeness in the three-phase power reporting.
*secLevel*='value'::
Set the securityLevel used for SNMPv3 messages (default=noAuthNoPriv,
allowed: authNoPriv,authPriv)
*secName*='value'::
Set the securityName used for authenticated SNMPv3 messages (no default)
*authPassword*='value'::
Set the authentication pass phrase used for authenticated SNMPv3 messages
(no default)
*privPassword*='value'::
Set the privacy pass phrase used for encrypted SNMPv3 messages (no default)
*authProtocol*='value'::
Set the authentication protocol (MD5 or SHA) used for authenticated SNMPv3
messages (default=MD5)
*privProtocol*='value'::
Set the privacy protocol (DES or AES) used for encrypted SNMPv3 messages
(default=DES)
REQUIREMENTS
------------
You will need to install the Net-SNMP package from
http://www.net-snmp.org/ before building this driver.
SNMP v3 also requires OpenSSL support from http://www.openssl.org.
LIMITATION
----------
Shutdown
~~~~~~~~
This driver does not provide a proper upsdrv_shutdown() function. There probably
never will be one, since at the time this script should run (near the end of
the system halt script), there will be no network capabilities anymore.
Probably the only way to shutdown an SNMP UPS is by sending it a shutdown
with delay command through linkman:upscmd[8] and hope for the best that the
system will have finished shutting down before the power is cut.
INSTALLATION
------------
This driver is only built if the Net-SNMP development files are present on the system.
You can also force it to be built by using "configure --with-snmp=yes" before calling make.
IMPLEMENTATION
--------------
The hostname of the UPS is specified with the "port" value in
`ups.conf`, i.e.:
[snmpv1]
driver = snmp-ups
port = snmp-ups.example.com
community = public
snmp_version = v1
mibs = ietf
pollfreq = 15
desc = "Example SNMP v1 device"
[snmpv3]
driver = snmp-ups
port = 166.99.224.132
mibs = mge
secLevel = authPriv
secName = mysecurityname
authPassword = myauthenticationpassphrase
privPassword = myprivatepassphrase
desc = "Example SNMP v3 device, with the highest security level"
AUTHORS
-------
Arnaud Quette, Dmitry Frolov
Sponsored by Eaton <http://www.eaton.com>
and originally by MGE UPS SYSTEMS <http://www.mgeups.com/>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
NUT SNMP Protocols Library
~~~~~~~~~~~~~~~~~~~~~~~~~~
Available at: http://www.networkupstools.org/protocols/snmp/
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

123
docs/man/solis.8 Normal file
View file

@ -0,0 +1,123 @@
'\" t
.\" Title: solis
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "SOLIS" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
solis \- Driver for Brazilian Microsol SOLIS UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the solis driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver has been tested with :
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Solis 1000 VA
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Solis 1500 VA
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Solis 2000 VA
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Solis 3000 VA
.RE
.sp
All Solis models are sinusoidal on\-line
.SH "EXTRA ARGUMENTS"
.sp
This driver support the following extra optional settings in the \fBups.conf\fR(5)\&.
.sp
\fBbattext = n\fR \- (default = 0, no extra battery, where n = Ampere*hour )
.sp
\fBprgshut = 1\fR \- (default = 0, no programable shutdown )
.SH "COMMANDS"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
shutdown\&.return \- Shut down in \&.3 minutes and restart in \&.3 minutes
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
shutdown\&.stayoff \- Shut down in \&.3 minutes and do not return
.RE
.SH "AUTHOR"
.sp
Silvino B\&. Magalhães <sbm2yk@gmail\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

57
docs/man/solis.txt Normal file
View file

@ -0,0 +1,57 @@
SOLIS(8)
========
NAME
----
solis - Driver for Brazilian Microsol SOLIS UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
solis driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver has been tested with :
* Solis 1000 VA
* Solis 1500 VA
* Solis 2000 VA
* Solis 3000 VA
All Solis models are sinusoidal on-line
EXTRA ARGUMENTS
---------------
This driver support the following extra optional settings in the
linkman:ups.conf[5].
*battext = n* - (default = 0, no extra battery, where n = Ampere*hour )
*prgshut = 1* - (default = 0, no programable shutdown )
COMMANDS
--------
* shutdown.return - Shut down in .3 minutes and restart in .3 minutes
* shutdown.stayoff - Shut down in .3 minutes and do not return
AUTHOR
------
Silvino B. Magalhães <sbm2yk@gmail.com>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

71
docs/man/tripplite.8 Normal file
View file

@ -0,0 +1,71 @@
'\" t
.\" Title: tripplite
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "TRIPPLITE" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tripplite \- Driver for Tripp\-Lite SmartPro UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the tripplite driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver should work on the SmartPro line, including the SMART700 and SMART700SER\&. It only supports SmartPro models that communicate using the serial port\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5):
.PP
\fBoffdelay\fR=\fInum\fR
.RS 4
Time to wait before the UPS is turned off after the kill power command is sent\&. The default value is 64 (in seconds)\&.
.RE
.PP
\fBrebootdelay\fR=\fInum\fR
.RS 4
Set the timer before the UPS is cycled after the reboot command is sent\&. The default value is 64 (in seconds)\&.
.RE
.PP
\fBstartdelay\fR=\fInum\fR
.RS 4
Set the time that the UPS waits before it turns itself back on after a reboot command\&. The default value is 60 (in seconds)\&.
.RE
.SH "KNOWN ISSUES AND BUGS"
.sp
Battery charge information may not be correct for all UPSes\&. It is tuned to be correct for a SMART700SER\&. Other models may not provide correct information\&. Information from the manufacturer would be helpful\&.
.SH "AUTHORS"
.sp
Rickard E\&. (Rik) Faith, Nicholas Kain
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Other drivers for Tripp\-Lite hardware:"
.sp
\fBtripplitesu\fR(8), \fBtripplite_usb\fR(8), \fBusbhid-ups\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

60
docs/man/tripplite.txt Normal file
View file

@ -0,0 +1,60 @@
TRIPPLITE(8)
============
NAME
----
tripplite - Driver for Tripp-Lite SmartPro UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
tripplite driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver should work on the SmartPro line, including the SMART700
and SMART700SER. It only supports SmartPro models that communicate
using the serial port.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5]:
*offdelay*='num'::
Time to wait before the UPS is turned off after the kill power command is
sent. The default value is 64 (in seconds).
*rebootdelay*='num'::
Set the timer before the UPS is cycled after the reboot command is sent.
The default value is 64 (in seconds).
*startdelay*='num'::
Set the time that the UPS waits before it turns itself back on after a
reboot command. The default value is 60 (in seconds).
KNOWN ISSUES AND BUGS
---------------------
Battery charge information may not be correct for all UPSes. It is tuned
to be correct for a SMART700SER. Other models may not provide correct
information. Information from the manufacturer would be helpful.
AUTHORS
-------
Rickard E. (Rik) Faith, Nicholas Kain
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Other drivers for Tripp-Lite hardware:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
linkman:tripplitesu[8], linkman:tripplite_usb[8], linkman:usbhid-ups[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

272
docs/man/tripplite_usb.8 Normal file
View file

@ -0,0 +1,272 @@
'\" t
.\" Title: tripplite_usb
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "TRIPPLITE_USB" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tripplite_usb \- Driver for older Tripp Lite USB UPSes (not PDC HID)
.SH "SYNOPSIS"
.sp
\fBtripplite_usb\fR \-h
.sp
\fBtripplite_usb\fR \-a \fIUPS_NAME\fR [\fIOPTIONS\fR]
.SH "SUPPORTED HARDWARE"
.sp
This driver should work with older Tripp Lite UPSes which are detected as USB HID\-class devices, but are not true HID Power\-Device Class devices\&. So far, the devices supported by tripplite_usb have product ID 0001, and the newer units (such as those with "LCD" in the model name) with product ID 2001 require the \fBusbhid-ups\fR(8) driver instead\&. Please report success or failure to the nut\-upsuser mailing list\&. A key piece of information is the protocol number, returned in ups\&.debug\&.0\&. Also, be sure to turn on debugging (\fI\-DDD\fR) for more informative log messages\&. If your Tripp Lite UPS uses a serial port, you may wish to investigate the \fBtripplite\fR(8) or \fBtripplite_su\fR(8) driver\&.
.sp
This driver has been tested with the following models:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
INTERNETOFFICE700
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OMNIVS1000
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OMNIVS1500XL (some warnings)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SMART700USB
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SMART1500RM2U
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SMART2200RMXL2U
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SMART3000RM2U
.RE
.sp
If you have used Tripp Lite\(cqs PowerAlert software to connect to your UPS, there is a good chance that \fItripplite_usb\fR will work if it uses one of the following protocols:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Protocol 0004
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Protocol 1001
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Protocol 2001
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Protocol 3003
.RE
.sp
On the other hand, if the web page for your UPS on the Tripp\-Lite website says "HID\-compliant USB port also enables direct integration with built\-in power management and auto\-shutdown features of Windows and MAC OS X", then you should use the \fBusbhid-ups\fR(8) driver instead\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5) file (or with \fI\-x\fR on the command line):
.PP
\fBoffdelay\fR
.RS 4
This setting controls the delay between receiving the "kill" command (\fI\-k\fR) and actually cutting power to the computer\&.
.RE
.PP
\fBbus\fR
.RS 4
This regular expression is used to match the USB bus (as seen in
/proc/bus/usb/devices
or lsusb(8); including leading zeroes)\&.
.RE
.PP
\fBproduct\fR
.RS 4
A regular expression to match the product string for the UPS\&. This would be useful if you have two different Tripp Lite UPS models connected to the system, and you want to be sure that you shut them down in the correct order\&.
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
This regex is matched against the full USB product string as seen in lsusb(8)\&. The ups\&.model in the \fBupsc\fR(1) output only lists the name after TRIPP LITE, so to match a SMART2200RMXL2U, you could use the regex \&.*SMART2200\&.*\&.
.sp .5v
.RE
.PP
\fBproductid\fR
.RS 4
The productid is a regular expression which matches the UPS PID as four hexadecimal digits\&. So far, the only devices that work with this driver have PID
0001\&.
.RE
.PP
\fBserial\fR
.RS 4
It does not appear that these particular Tripp Lite UPSes use the
iSerial
descriptor field to return a serial number\&. However, in case your unit does, you may specify it here\&.
.RE
.sp
For more information on regular expressions, see regex(7)
.SH "RUNTIME VARIABLES"
.PP
\fBups\&.delay\&.shutdown\fR
.RS 4
This variable is the same as the
\fIoffdelay\fR
setting, but it can be changed at runtime by
\fBupsrw\fR(8)\&.
.RE
.PP
\fBups\&.id\fR
.RS 4
Some SMARTPRO models feature an ID that can be set and retrieved\&. If your UPS supports this feature, this variable will be listed in the output of
\fBupsrw\fR(8)\&.
.RE
.PP
\fBoutlet\&.1\&.switch\fR
.RS 4
Some Tripp Lite units have a switchable outlet (usually outlet #1) which can be turned on and off by writing
\fI1\fR
or
\fI0\fR, respectively, to
outlet\&.1\&.switch
with
\fBupsrw\fR(8)\&. If your unit has multiple switchable outlets, substitute the outlet number for
\fI1\fR
in the variable name\&. Be sure to test this first \- there is no other way to be certain that the number used by the driver matches the label on the unit\&.
.RE
.SH "KNOWN ISSUES AND BUGS"
.sp
The driver was not developed with any official documentation from Tripp Lite, so certain events may confuse the driver\&. If you observe any strange behavior, please re\-run the driver with \-DDD to increase the verbosity\&.
.sp
So far, the Tripp Lite UPSes do not seem to have a serial number or other globally unique identifier accessible through USB\&. Thus, when monitoring several Tripp Lite USB UPSes, you should use either the \fIbus\fR or \fIproduct\fR configuration options to uniquely specify which UPS a given driver instance should control\&.
.sp
For instance, you can easily monitor an OMNIVS1000 and a SMART1500RM2U at the same time, since they have different USB Product ID strings\&. If you have two SMART1500RM2U units, you would have to find which USB bus number each unit is on (via lsusb(8)), which may result in ambiguities if the available USB ports are on the same bus\&.
.sp
Some of the SMART*2U models have an ID number, but because this ID is not exposed as a USB string descriptor, there is no easy way to use this ID to distinguish between multiple UPS units on a single machine\&. The UPS would need to be claimed by the driver in order to read this ID\&.
.SH "AUTHOR"
.sp
Written by Charles Lepple, based on the \fBtripplite\fR(8) driver by Rickard E\&. (Rik) Faith and Nicholas Kain\&. Please do not email the authors directly \- use the nut\-upsdev mailing list\&.
.sp
A Tripp Lite OMNIVS1000 was graciously donated to the NUT project by Bradley Feldman (http://www\&.bradleyloritheo\&.com)
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Other drivers for Tripp\-Lite hardware:"
.sp
\fBtripplite\fR(8), \fBtripplitesu\fR(8), \fBusbhid-ups\fR(8)
.SS "Other tools:"
.sp
regex(7), lsusb(8)
.SH "INTERNET RESOURCES"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

168
docs/man/tripplite_usb.txt Normal file
View file

@ -0,0 +1,168 @@
TRIPPLITE_USB(8)
================
NAME
----
tripplite_usb - Driver for older Tripp Lite USB UPSes (not PDC HID)
SYNOPSIS
--------
*tripplite_usb* -h
*tripplite_usb* -a 'UPS_NAME' ['OPTIONS']
SUPPORTED HARDWARE
------------------
This driver should work with older Tripp Lite UPSes which are detected as USB
HID-class devices, but are not true HID Power-Device Class devices. So far,
the devices supported by tripplite_usb have product ID 0001, and the newer
units (such as those with "LCD" in the model name) with product ID 2001 require
the linkman:usbhid-ups[8] driver instead. Please report success or failure to
the nut-upsuser mailing list. A key piece of information is the protocol
number, returned in `ups.debug.0`. Also, be sure to turn on debugging ('-DDD')
for more informative log messages. If your Tripp Lite UPS uses a serial port,
you may wish to investigate the linkman:tripplite[8] or linkman:tripplite_su[8]
driver.
This driver has been tested with the following models:
* INTERNETOFFICE700
* OMNIVS1000
* OMNIVS1500XL (some warnings)
* SMART700USB
* SMART1500RM2U
* SMART2200RMXL2U
* SMART3000RM2U
If you have used Tripp Lite's PowerAlert software to connect to your UPS, there
is a good chance that 'tripplite_usb' will work if it uses one of the
following protocols:
* Protocol 0004
* Protocol 1001
* Protocol 2001
* Protocol 3003
On the other hand, if the web page for your UPS on the Tripp-Lite website says
"HID-compliant USB port also enables direct integration with built-in power
management and auto-shutdown features of Windows and MAC OS X", then you should
use the linkman:usbhid-ups[8] driver instead.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the linkman:ups.conf[5]
file (or with '-x' on the command line):
*offdelay*::
This setting controls the delay between receiving the "kill" command ('-k')
and actually cutting power to the computer.
*bus*::
This regular expression is used to match the USB bus (as seen in
`/proc/bus/usb/devices` or lsusb(8); including leading zeroes).
*product*::
A regular expression to match the product string for the UPS. This would be
useful if you have two different Tripp Lite UPS models connected to the
system, and you want to be sure that you shut them down in the correct order.
NOTE: This regex is matched against the full USB product string as seen in
lsusb(8). The `ups.model` in the linkman:upsc[1] output only lists the name after
`TRIPP LITE`, so to match a SMART2200RMXL2U, you could use the regex
`.*SMART2200.*`.
*productid*::
The productid is a regular expression which matches the UPS PID as four
hexadecimal digits. So far, the only devices that work with this driver have
PID `0001`.
*serial*::
It does not appear that these particular Tripp Lite UPSes use the `iSerial`
descriptor field to return a serial number. However, in case your unit does,
you may specify it here.
For more information on regular expressions, see regex(7)
RUNTIME VARIABLES
-----------------
*ups.delay.shutdown*::
This variable is the same as the 'offdelay' setting, but it can be changed at
runtime by linkman:upsrw[8].
*ups.id*::
Some SMARTPRO models feature an ID that can be set and retrieved. If your UPS
supports this feature, this variable will be listed in the output of linkman:upsrw[8].
*outlet.1.switch*::
Some Tripp Lite units have a switchable outlet (usually outlet #1) which can be
turned on and off by writing '1' or '0', respectively, to `outlet.1.switch`
with linkman:upsrw[8].
If your unit has multiple switchable outlets, substitute the outlet number for
'1' in the variable name. Be sure to test this first - there is no other way to
be certain that the number used by the driver matches the label on the unit.
KNOWN ISSUES AND BUGS
---------------------
The driver was not developed with any official documentation from Tripp Lite,
so certain events may confuse the driver. If you observe any strange behavior,
please re-run the driver with `-DDD` to increase the verbosity.
So far, the Tripp Lite UPSes do not seem to have a serial number or other
globally unique identifier accessible through USB. Thus, when monitoring
several Tripp Lite USB UPSes, you should use either the 'bus' or 'product'
configuration options to uniquely specify which UPS a given driver instance
should control.
For instance, you can easily monitor an OMNIVS1000 and a SMART1500RM2U at the
same time, since they have different USB Product ID strings. If you have two
SMART1500RM2U units, you would have to find which USB bus number each unit is
on (via lsusb(8)), which may result in ambiguities if the available USB ports
are on the same bus.
Some of the SMART*2U models have an ID number, but because this ID is not
exposed as a USB string descriptor, there is no easy way to use this ID to
distinguish between multiple UPS units on a single machine. The UPS would need
to be claimed by the driver in order to read this ID.
AUTHOR
------
Written by Charles Lepple, based on the linkman:tripplite[8] driver by Rickard E. (Rik)
Faith and Nicholas Kain. Please do not email the authors directly - use the
nut-upsdev mailing list.
A Tripp Lite OMNIVS1000 was graciously donated to the NUT project by Bradley
Feldman (http://www.bradleyloritheo.com)
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Other drivers for Tripp-Lite hardware:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
linkman:tripplite[8], linkman:tripplitesu[8], linkman:usbhid-ups[8]
Other tools:
~~~~~~~~~~~~
regex(7), lsusb(8)
INTERNET RESOURCES
------------------
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

59
docs/man/tripplitesu.8 Normal file
View file

@ -0,0 +1,59 @@
'\" t
.\" Title: tripplitesu
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "TRIPPLITESU" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tripplitesu \- Driver for Tripp\-Lite SmartOnline (SU) UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the tripplitesu driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
This driver supports the Tripp Lite SmartOnline family (via the serial port)\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5):
.PP
\fBlowbatt\fR=\fInum\fR
.RS 4
Set the low battery warning threshold in percent at which shutdown is initiated by
\fBupsmon\fR(8)\&. By default, the UPS may not report low battery until there are only a few seconds left\&. Common values are around 25\(em30\&.
.RE
.SH "AUTHOR"
.sp
Allan N\&. Hessenflow <allanh@kallisti\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Other drivers for Tripp\-Lite hardware:"
.sp
\fBtripplite\fR(8), \fBtripplite_usb\fR(8), \fBusbhid-ups\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

45
docs/man/tripplitesu.txt Normal file
View file

@ -0,0 +1,45 @@
TRIPPLITESU(8)
==============
NAME
----
tripplitesu - Driver for Tripp-Lite SmartOnline (SU) UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
tripplitesu driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
This driver supports the Tripp Lite SmartOnline family (via the serial port).
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in the
linkman:ups.conf[5]:
*lowbatt*='num'::
Set the low battery warning threshold in percent at which shutdown is
initiated by linkman:upsmon[8]. By default, the UPS may not report low battery
until there are only a few seconds left. Common values are around 25--30.
AUTHOR
------
Allan N. Hessenflow <allanh@kallisti.com>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Other drivers for Tripp-Lite hardware:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
linkman:tripplite[8], linkman:tripplite_usb[8], linkman:usbhid-ups[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

155
docs/man/ups.conf.5 Normal file
View file

@ -0,0 +1,155 @@
'\" t
.\" Title: ups.conf
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPS\&.CONF" "5" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ups.conf \- UPS definitions for Network UPS Tools
.SH "DESCRIPTION"
.sp
This file is read by the driver controller \fBupsdrvctl\fR(8), the UPS drivers that use the common core (see \fBnutupsdrv\fR(8), and \fBupsd\fR(8))\&. The file begins with global directives, and then each UPS has a section which contains a number of directives that set parameters for that UPS\&.
.sp
A UPS section begins with the name of the UPS in brackets, and continues until the next UPS name in brackets or until EOF\&. The name "default" is used internally in upsd, so you can\(cqt use it in this file\&.
.sp
You must define the \fIdriver\fR and \fIport\fR elements for each entry\&. Anything after that in a section is optional\&. A simple example might look like this:
.sp
.if n \{\
.RS 4
.\}
.nf
[myups]
driver = blazer_ser
port = /dev/ttyS0
desc = "Web server UPS"
.fi
.if n \{\
.RE
.\}
.sp
A slightly more complicated version includes some extras for the hardware\-specific part of the driver:
.sp
.if n \{\
.RS 4
.\}
.nf
[bigups]
driver = apcsmart
port = /dev/cua00
cable = 940\-0095B
sdtype = 2
desc = "Database server UPS"
.fi
.if n \{\
.RE
.\}
.sp
In this case, the \fBapcsmart\fR(8) driver will receive variables called "cable" and "sdtype" which have special meanings\&. See the man pages of your driver(s) to learn which variables are supported and what they do\&.
.SH "GLOBAL DIRECTIVES"
.PP
\fBchroot\fR
.RS 4
Optional\&. The driver will chroot(2) to this directory during initialization\&. This can be useful when securing systems\&.
.RE
.PP
\fBdriverpath\fR
.RS 4
Optional\&. Path name of the directory in which the UPS driver executables reside\&. If you don\(cqt specify this, the programs look in a built\-in default directory, which is often /usr/local/ups/bin\&.
.RE
.PP
\fBmaxstartdelay\fR
.RS 4
Optional\&. Same as the UPS field of the same name, but this is the default for UPSes that don\(cqt have the field\&.
.RE
.PP
\fBpollinterval\fR
.RS 4
Optional\&. The status of the UPS will be refreshed after a maximum delay which is controlled by this setting\&. This is normally 2 seconds\&. This may be useful if the driver is creating too much of a load on your system or network\&.
.RE
.PP
\fBuser\fR
.RS 4
Optional\&. If started as root, the driver will setuid(2) to the user id associated with
\fIusername\fR\&.
.RE
.SH "UPS FIELDS"
.PP
\fBdriver\fR
.RS 4
Required\&. This specifies which program will be monitoring this UPS\&. You need to specify the one that is compatible with your hardware\&. See
\fBnutupsdrv\fR(8)
for more information on drivers in general and pointers to the man pages of specific drivers\&.
.RE
.PP
\fBport\fR
.RS 4
Required\&. This is the serial port where the UPS is connected\&. On a Linux system, the first serial port usually is
\fI/dev/ttyS0\fR\&. On FreeBSD and similar systems, it probably will be
\fI/dev/cuaa0\fR\&.
.RE
.PP
\fBsdorder\fR
.RS 4
Optional\&. When you have multiple UPSes on your system, you usually need to turn them off in a certain order\&. upsdrvctl shuts down all the 0s, then the 1s, 2s, and so on\&. To exclude a UPS from the shutdown sequence, set this to \-1\&.
.sp
The default value for this parameter is 0\&.
.RE
.PP
\fBdesc\fR
.RS 4
Optional\&. This allows you to set a brief description that upsd will provide to clients that ask for a list of connected equipment\&.
.RE
.PP
\fBnolock\fR
.RS 4
Optional\&. When you specify this, the driver skips the port locking routines every time it starts\&. This may allow other processes to seize the port if you start more than one accidentally\&.
.sp
You should only use this if your system won\(cqt work without it\&.
.sp
This may be needed on Mac OS X systems\&.
.RE
.PP
\fBmaxstartdelay\fR
.RS 4
Optional\&. This can be set as a global variable above your first UPS definition and it can also be set in a UPS section\&. This value controls how long upsdrvctl will wait for the driver to finish starting\&. This keeps your system from getting stuck due to a broken driver or UPS\&.
.sp
The default is 45 seconds\&.
.RE
.sp
All other fields are passed through to the hardware\-specific part of the driver\&. See those manuals for the list of what is allowed\&.
.SH "INTEGRATION"
.sp
\fBupsdrvctl\fR(8) uses this file to start and stop the drivers\&.
.sp
The drivers themselves also obtain configuration data from this file\&. Each driver looks up its section and uses that to configure itself\&.
.sp
\fBupsd\fR(8) learns about which UPSes are installed on this system by reading this file\&. If this system is called "doghouse" and you have defined a UPS in your \fBups\&.conf\fR called "snoopy", then you can monitor it from \fBupsc\fR(8) or similar as "snoopy@doghouse"\&.
.SH "SEE ALSO"
.sp
\fBupsd\fR(8), \fBnutupsdrv\fR(8), \fBupsdrvctl\fR(8)
.SS "Internet resources"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

143
docs/man/ups.conf.txt Normal file
View file

@ -0,0 +1,143 @@
UPS.CONF(5)
===========
NAME
----
ups.conf - UPS definitions for Network UPS Tools
DESCRIPTION
-----------
This file is read by the driver controller linkman:upsdrvctl[8], the UPS drivers
that use the common core (see linkman:nutupsdrv[8], and linkman:upsd[8]). The
file begins with global directives, and then each UPS has a section which
contains a number of directives that set parameters for that UPS.
A UPS section begins with the name of the UPS in brackets, and continues
until the next UPS name in brackets or until EOF. The name "default" is
used internally in upsd, so you can't use it in this file.
You must define the 'driver' and 'port' elements for each entry. Anything
after that in a section is optional. A simple example might look like this:
[myups]
driver = blazer_ser
port = /dev/ttyS0
desc = "Web server UPS"
A slightly more complicated version includes some extras for the
hardware-specific part of the driver:
[bigups]
driver = apcsmart
port = /dev/cua00
cable = 940-0095B
sdtype = 2
desc = "Database server UPS"
In this case, the linkman:apcsmart[8] driver will receive variables called
"cable" and "sdtype" which have special meanings. See the man pages of
your driver(s) to learn which variables are supported and what they do.
GLOBAL DIRECTIVES
-----------------
*chroot*::
Optional. The driver will chroot(2) to this directory during initialization.
This can be useful when securing systems.
*driverpath*::
Optional. Path name of the directory in which the UPS driver executables
reside. If you don't specify this, the programs look in a built-in default
directory, which is often /usr/local/ups/bin.
*maxstartdelay*::
Optional. Same as the UPS field of the same name, but this is the
default for UPSes that don't have the field.
*pollinterval*::
Optional. The status of the UPS will be refreshed after a maximum
delay which is controlled by this setting. This is normally 2 seconds. This
may be useful if the driver is creating too much of a load on your system or
network.
*user*::
Optional. If started as root, the driver will setuid(2) to the user id
associated with 'username'.
UPS FIELDS
----------
*driver*::
Required. This specifies which program will be monitoring this UPS. You
need to specify the one that is compatible with your hardware. See
linkman:nutupsdrv[8] for more information on drivers in general and pointers to the
man pages of specific drivers.
*port*::
Required. This is the serial port where the UPS is connected. On a Linux
system, the first serial port usually is '/dev/ttyS0'. On FreeBSD and
similar systems, it probably will be '/dev/cuaa0'.
*sdorder*::
Optional. When you have multiple UPSes on your system, you usually need to
turn them off in a certain order. upsdrvctl shuts down all the 0s,
then the 1s, 2s, and so on. To exclude a UPS from the shutdown sequence,
set this to -1.
+
The default value for this parameter is 0.
*desc*::
Optional. This allows you to set a brief description that upsd will provide
to clients that ask for a list of connected equipment.
*nolock*::
Optional. When you specify this, the driver skips the port locking routines
every time it starts. This may allow other processes to seize the port if
you start more than one accidentally.
+
You should only use this if your system won't work without it.
+
This may be needed on Mac OS X systems.
*maxstartdelay*::
Optional. This can be set as a global variable above your first UPS
definition and it can also be set in a UPS section. This value controls how
long upsdrvctl will wait for the driver to finish starting. This keeps your
system from getting stuck due to a broken driver or UPS.
+
The default is 45 seconds.
All other fields are passed through to the hardware-specific part of the
driver. See those manuals for the list of what is allowed.
INTEGRATION
-----------
linkman:upsdrvctl[8] uses this file to start and stop the drivers.
The drivers themselves also obtain configuration data from this file.
Each driver looks up its section and uses that to configure itself.
linkman:upsd[8] learns about which UPSes are installed on this system by
reading this file. If this system is called "doghouse" and you have
defined a UPS in your *ups.conf* called "snoopy", then you can monitor it
from linkman:upsc[8] or similar as "snoopy@doghouse".
SEE ALSO
--------
linkman:upsd[8], linkman:nutupsdrv[8], linkman:upsdrvctl[8]
Internet resources
~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

120
docs/man/upsc.8 Normal file
View file

@ -0,0 +1,120 @@
'\" t
.\" Title: upsc
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSC" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
upsc \- example lightweight UPS client
.SH "SYNOPSIS"
.sp
\fBupsc\fR \-l | \-L [\fIhost\fR]
.sp
\fBupsc\fR \fIups\fR [\fIvariable\fR]
.SH "DESCRIPTION"
.sp
\fBupsc\fR is provided as a quick way to poll the status of a UPS server\&. It can be used inside shell scripts and other programs that need UPS data but don\(cqt want to include the full interface\&.
.SH "OPTIONS"
.PP
\fB\-l\fR \fIhost\fR
.RS 4
List all UPS names configured at
\fIhost\fR, one name per line\&. The hostname defaults to "localhost"\&. You may optionally add a colon and a port number\&.
.RE
.PP
\fB\-L\fR \fIhost\fR
.RS 4
As above, list all UPS names configured at
\fIhost\fR, including their description provided by the remote upsd(8) from ups\&.conf(5)\&. The hostname defaults to "localhost"\&. You may optionally add a colon and a port number to override the default port\&.
.RE
.PP
\fIups\fR
.RS 4
Display the status of that UPS\&. The format for this option is
\fIupsname[@hostname[:port]]\fR\&. The default hostname is "localhost"\&.
.RE
.PP
\fIvariable\fR
.RS 4
Display the value of this variable only\&. By default, upsc retrieves the list of variables from the server and then displays the value for each\&. This may be useful in shell scripts to save an additional pipe into grep\&.
.RE
.SH "EXAMPLES"
.sp
To list all variables on an UPS named "myups" on a host called "mybox", with upsd(8) running on port 1234:
.sp
.if n \{\
.RS 4
.\}
.nf
$ upsc myups@mybox:1234
battery\&.charge: 100\&.0
battery\&.voltage: 13\&.9
battery\&.voltage\&.nominal: 13\&.6
\&. \&. \&.
.fi
.if n \{\
.RE
.\}
.sp
To list the UPSes configured on this system, along with their descriptions:
.sp
.if n \{\
.RS 4
.\}
.nf
$ upsc \-L
apc: Back\-UPS 500
ppro2: Patriot Pro II
.fi
.if n \{\
.RE
.\}
.sp
To retrieve the status for all UPSes connected to mybox, using Bourne\-shell syntax:
.sp
.if n \{\
.RS 4
.\}
.nf
$ for UPS in `upsc \-l mybox:1234`; do
upsc $UPS ups\&.status
done
.fi
.if n \{\
.RE
.\}
.SH "DIAGNOSTICS"
.sp
upsc will either print a list of UPS names, a list of all supported variables and their values on the UPS, or an error message\&. If you receive an error, make sure you have specified a valid UPS on the command line, that \fBupsd\fR(8) is really running on the other host and that no firewalls are blocking you\&.
.SH "HISTORY"
.sp
Earlier versions of this program used the \fIupsfetch\fR library and UDP sockets to talk to upsd\&. This version of upsc uses the new \fIupsclient\fR library, which only talks TCP\&. This is why \fIupsct\fR no longer exists\&.
.SH "SEE ALSO"
.sp
\fBupsd\fR(8)
.SH "INTERNET RESOURCES"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

96
docs/man/upsc.txt Normal file
View file

@ -0,0 +1,96 @@
UPSC(8)
=======
NAME
----
upsc - example lightweight UPS client
SYNOPSIS
--------
*upsc* -l | -L ['host']
*upsc* 'ups' ['variable']
DESCRIPTION
-----------
*upsc* is provided as a quick way to poll the status of a UPS server. It can
be used inside shell scripts and other programs that need UPS data but don't
want to include the full interface.
OPTIONS
-------
*-l* 'host'::
List all UPS names configured at 'host', one name per line. The hostname
defaults to "localhost". You may optionally add a colon and a port number.
*-L* 'host'::
As above, list all UPS names configured at 'host', including their description
provided by the remote upsd(8) from ups.conf(5). The hostname defaults to
"localhost". You may optionally add a colon and a port number to override the
default port.
'ups'::
Display the status of that UPS. The format for this option is
'upsname[@hostname[:port]]'. The default hostname is "localhost".
'variable'::
Display the value of this variable only. By default, upsc retrieves the list
of variables from the server and then displays the value for each. This may
be useful in shell scripts to save an additional pipe into grep.
EXAMPLES
--------
To list all variables on an UPS named "myups" on a host
called "mybox", with upsd(8) running on port 1234:
$ upsc myups@mybox:1234
battery.charge: 100.0
battery.voltage: 13.9
battery.voltage.nominal: 13.6
. . .
To list the UPSes configured on this system, along with their descriptions:
$ upsc -L
apc: Back-UPS 500
ppro2: Patriot Pro II
To retrieve the status for all UPSes connected to mybox, using Bourne-shell
syntax:
$ for UPS in `upsc -l mybox:1234`; do
upsc $UPS ups.status
done
DIAGNOSTICS
-----------
upsc will either print a list of UPS names, a list of all supported variables
and their values on the UPS, or an error message. If you receive an error,
make sure you have specified a valid UPS on the command line, that
linkman:upsd[8] is really running on the other host and that no firewalls are
blocking you.
HISTORY
-------
Earlier versions of this program used the 'upsfetch' library and UDP sockets to
talk to upsd. This version of upsc uses the new 'upsclient' library, which
only talks TCP. This is why 'upsct' no longer exists.
SEE ALSO
--------
linkman:upsd[8]
INTERNET RESOURCES
------------------
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

55
docs/man/upscli_connect.3 Normal file
View file

@ -0,0 +1,55 @@
'\" t
.\" Title: upscli_connect
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_CONNECT" "3" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
upscli_connect \- Open a connection to a NUT upsd
.SH "SYNOPSIS"
.sp
.nf
#include <upsclient\&.h>
.fi
.sp
.nf
int upscli_connect(UPSCONN_t *ups, const char *host, int port, int flags);
.fi
.SH "DESCRIPTION"
.sp
The \fBupscli_connect()\fR function takes the pointer \fIups\fR to a UPSCONN_t state structure and opens a TCP connection to the \fIhost\fR on the given \fIport\fR\&.
.sp
\fIflags\fR may be either UPSCLI_CONN_TRYSSL to try a SSL connection, or UPSCLI_CONN_REQSSL to require a SSL connection\&.
.sp
If SSL mode is required, this function will only return successfully if it is able to establish a SSL connection with the server\&. Possible reasons for failure include no SSL support on the server, and if \fBupsclient\fR itself hasn\(cqt been compiled with SSL support\&.
.sp
You must call \fBupscli_disconnect\fR(3) when finished with a connection, or your program will slowly leak memory and file descriptors\&.
.SH "RETURN VALUE"
.sp
The \fBupscli_connect()\fR function modifies the UPSCONN_t structure and returns 0 on success, or \-1 if an error occurs\&.
.SH "SEE ALSO"
.sp
\fBupscli_disconnect\fR(3), \fBupscli_fd\fR(3), \fBupscli_splitaddr\fR(3), \fBupscli_splitname\fR(3), \fBupscli_ssl\fR(3), \fBupscli_strerror\fR(3), \fBupscli_upserror\fR(3)

45
docs/man/upscli_connect.txt Normal file
View file

@ -0,0 +1,45 @@
UPSCLI_CONNECT(3)
=================
NAME
----
upscli_connect - Open a connection to a NUT upsd
SYNOPSIS
--------
#include <upsclient.h>
int upscli_connect(UPSCONN_t *ups, const char *host, int port, int flags);
DESCRIPTION
-----------
The *upscli_connect()* function takes the pointer 'ups' to a
`UPSCONN_t` state structure and opens a TCP connection to the 'host' on
the given 'port'.
'flags' may be either `UPSCLI_CONN_TRYSSL` to try a SSL
connection, or `UPSCLI_CONN_REQSSL` to require a SSL connection.
If SSL mode is required, this function will only return successfully if
it is able to establish a SSL connection with the server. Possible
reasons for failure include no SSL support on the server, and if
*upsclient* itself hasn't been compiled with SSL support.
You must call linkman:upscli_disconnect[3] when finished with a
connection, or your program will slowly leak memory and file
descriptors.
RETURN VALUE
------------
The *upscli_connect()* function modifies the `UPSCONN_t` structure and
returns 0 on success, or -1 if an error occurs.
SEE ALSO
--------
linkman:upscli_disconnect[3], linkman:upscli_fd[3],
linkman:upscli_splitaddr[3], linkman:upscli_splitname[3],
linkman:upscli_ssl[3], linkman:upscli_strerror[3],
linkman:upscli_upserror[3]

51
docs/man/upscli_disconnect.3 Normal file
View file

@ -0,0 +1,51 @@
'\" t
.\" Title: upscli_disconnect
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_DISCONNECT" "3" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
upscli_disconnect \- disconnect from a UPS server
.SH "SYNOPSIS"
.sp
.nf
#include <upsclient\&.h>
.fi
.sp
.nf
int upscli_disconnect(UPSCONN_t *ups);
.fi
.SH "DESCRIPTION"
.sp
The \fBupscli_disconnect()\fR function takes the pointer \fIups\fR to a UPSCONN_t state structure, shuts down the connection to the server, and frees dynamic memory used by the state structure\&. The UPSCONN_t structure is no longer valid after this function is called\&.
.sp
This function must be called, or your program will leak memory and file descriptors\&.
.SH "RETURN VALUE"
.sp
The \fBupscli_disconnect()\fR function returns 0 on success, or \-1 if an error occurs\&.
.SH "SEE ALSO"
.sp
\fBupscli_connect\fR(3), \fBupscli_fd\fR(3), \fBupscli_strerror\fR(3), \fBupscli_upserror\fR(3)

35
docs/man/upscli_disconnect.txt Normal file
View file

@ -0,0 +1,35 @@
UPSCLI_DISCONNECT(3)
====================
NAME
----
upscli_disconnect - disconnect from a UPS server
SYNOPSIS
--------
#include <upsclient.h>
int upscli_disconnect(UPSCONN_t *ups);
DESCRIPTION
-----------
The *upscli_disconnect()* function takes the pointer 'ups' to a
`UPSCONN_t` state structure, shuts down the connection to the server, and
frees dynamic memory used by the state structure. The `UPSCONN_t` structure
is no longer valid after this function is called.
This function must be called, or your program will leak memory and
file descriptors.
RETURN VALUE
------------
The *upscli_disconnect()* function returns 0 on success, or -1 if an
error occurs.
SEE ALSO
--------
linkman:upscli_connect[3], linkman:upscli_fd[3],
linkman:upscli_strerror[3], linkman:upscli_upserror[3]

51
docs/man/upscli_fd.3 Normal file
View file

@ -0,0 +1,51 @@
'\" t
.\" Title: upscli_fd
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_FD" "3" "12/24/2010" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
upscli_fd \- Get file descriptor for connection
.SH "SYNOPSIS"
.sp
.nf
#include <upsclient\&.h>
.fi
.sp
.nf
int upscli_fd(UPSCONN_t *ups);
.fi
.SH "DESCRIPTION"
.sp
The \fBupscli_fd()\fR function takes the pointer \fIups\fR to a UPSCONN_t state structure and returns the value of the file descriptor for that connection, if any\&.
.sp
This may be useful for determining if the connection to \fBupsd\fR(8) has been lost\&.
.SH "RETURN VALUE"
.sp
The \fBupscli_fd()\fR function returns the file descriptor, which may be any non\-negative number\&. It returns \-1 if an error occurs\&.
.SH "SEE ALSO"
.sp
\fBupscli_connect\fR(3), \fBupscli_strerror\fR(3), \fBupscli_upserror\fR(3)

35
docs/man/upscli_fd.txt Normal file
View file

@ -0,0 +1,35 @@
UPSCLI_FD(3)
============
NAME
----
upscli_fd - Get file descriptor for connection
SYNOPSIS
--------
#include <upsclient.h>
int upscli_fd(UPSCONN_t *ups);
DESCRIPTION
-----------
The *upscli_fd()* function takes the pointer 'ups' to a
`UPSCONN_t` state structure and returns the value of the file descriptor
for that connection, if any.
This may be useful for determining if the connection to linkman:upsd[8]
has been lost.
RETURN VALUE
------------
The *upscli_fd()* function returns the file descriptor, which
may be any non-negative number. It returns -1 if an error occurs.
SEE ALSO
--------
linkman:upscli_connect[3], linkman:upscli_strerror[3], linkman:upscli_upserror[3]

Some files were not shown because too many files have changed in this diff Show more