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

Imported Upstream version 2.6.4

Browse source
This commit is contained in:
Arnaud Quette 2012-06-01 15:55:19 +02:00
parent fad6ced6f6
commit fefe62b2bd
257 changed files with 6020 additions and 1394 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/Makefile.am
View file

@ -85,7 +85,7 @@ ups-html.txt:
### TODO: automatic dependency generation
# Add other directory deps (not for local EXTRA_DIST) and generated contents
FULL_USER_MANUAL_DEPS = $(USER_MANUAL_DEPS) $(SHARED_DEPS) ../README \
../INSTALL ../UPGRADING ../TODO
../INSTALL ../UPGRADING ../TODO ../scripts/ufw/README
FULL_DEVELOPER_GUIDE_DEPS = $(DEVELOPER_GUIDE_DEPS) $(SHARED_DEPS) \
../scripts/augeas/README ../TODO ../lib/README \
../tools/nut-scanner/README

5
docs/Makefile.in
View file

@ -188,6 +188,7 @@ MKDIR_P = @MKDIR_P@
NETLIBS = @NETLIBS@
NM = @NM@
NMEDIT = @NMEDIT@
NUT_NETVERSION = @NUT_NETVERSION@
OBJDUMP = @OBJDUMP@
OBJEXT = @OBJEXT@
OS_NAME = @OS_NAME@
@ -201,6 +202,7 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@
PACKAGE_URL = @PACKAGE_URL@
PACKAGE_VERSION = @PACKAGE_VERSION@
PATH_SEPARATOR = @PATH_SEPARATOR@
PIDPATH = @PIDPATH@
PKG_CONFIG = @PKG_CONFIG@
PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@
PKG_CONFIG_PATH = @PKG_CONFIG_PATH@
@ -208,6 +210,7 @@ PORT = @PORT@
RANLIB = @RANLIB@
RUN_AS_GROUP = @RUN_AS_GROUP@
RUN_AS_USER = @RUN_AS_USER@
SBINDIR = @SBINDIR@
SED = @SED@
SERLIBS = @SERLIBS@
SET_MAKE = @SET_MAKE@
@ -344,7 +347,7 @@ SUFFIXES = .txt .html .pdf
### TODO: automatic dependency generation
# Add other directory deps (not for local EXTRA_DIST) and generated contents
FULL_USER_MANUAL_DEPS = $(USER_MANUAL_DEPS) $(SHARED_DEPS) ../README \
../INSTALL ../UPGRADING ../TODO
../INSTALL ../UPGRADING ../TODO ../scripts/ufw/README
FULL_DEVELOPER_GUIDE_DEPS = $(DEVELOPER_GUIDE_DEPS) $(SHARED_DEPS) \
../scripts/augeas/README ../TODO ../lib/README \

30
docs/cables/apc.txt
View file

@ -1,10 +1,37 @@
Desc: APC UPS cables
File: apc.txt
Date: 12 Februari 2010
Date: 12 February 2010
Auth: Arjen de Korte <adkorte-guest@alioth.debian.org
http://lists.alioth.debian.org/pipermail/nut-upsuser/2005-August/000118.html
Note that APC UPS serial cable part numbers follow a numbering scheme
where the "940-" prefix identifies them as cables.
940-1000 straight through cable
940-0103 null modem cable
940-0020 Basic Signaling Cable (OB and kill power)
940-0023 Simple Signaling Cable (OB only)
940-LL24 Smart Signaling Cable
940-0095 PnP Cable (see Apcupsd manual for diagram)
940-0119 Simple Signaling Cable (OB and kill power)
940-0127 RJ45-10P10C to USB Cable
940-0128 Simple Signaling Cable for Back-UPS CS
"LL" represents the length:
00 six feet
NN NN feet
The suffix letter represents a minor revision in physical design, or a
change of OEM, _not_ a change of wiring or pin-out, and all cables
differing only in this suffix letter are electrically interchangeable.
Note though the following quote from the APC Discussion Forums: "At one
point there were a small number of revision D cables [940-0024D] that
had some shielding issues from the manufacturer that could maybe cause
[...] [spontaneous] self-tests)."
+-----------------------------------------------------------------+
| |
| Black APC 940-0024C Smart Signalling UPS Cable Wiring Diagram |
@ -183,6 +210,7 @@ http://lists.alioth.debian.org/pipermail/nut-upsuser/2005-August/000118.html
+-----------------------------------------------------------------+
| |
| APC 940-1000 Straight Through cable |
| Universal APC serial extension cable for use in conjunction |
| with an APC UPS cable. This cable is verified to work. |
| |

34
docs/config-notes.txt
View file

@ -45,35 +45,49 @@ configuration directive for some reason. You can do that too.
NOTIFYCMD "/bin/notifyme -foo -bar \"hi there\" -baz"
In other words, \ can be used to escape the ".
In other words, *\* can be used to escape the *"*.
Finally, for the situation where you need to put the \ character into your
Finally, for the situation where you need to put the *\* character into your
string, you just escape it.
NOTIFYCMD "/bin/notifyme c:\\dos\\style\\path"
The \ can actually be used to escape any character, but you only really
need it for \, ", and # as they have special meanings to the parser.
The *\* can actually be used to escape any character, but you only really
need it for *\*, *"*, and *#* as they have special meanings to the parser.
When using file names with space characters, you may end up having tricky
things since you need to write them inside "" which must be escaped:
things since you need to write them inside *""* which must be escaped:
NOTIFYCMD "\"c:\\path with space\\notifyme\" \"c:\\path with space\\name\""
# is the comment character. Anything after an unescaped # is ignored.
*#* is the comment character. Anything after an unescaped *#* is ignored.
Something like this...
identity = my#1ups
... will actually turn into "identity = my", since the # stops the
parsing. If you really need to have a # in your configuration, then
... will actually turn into "identity = my", since the *#* stops the
parsing. If you really need to have a *#* in your configuration, then
escape it.
identity = my\#1ups
Much better.
The *=* character should be used with care too. There should be only one
"simple" *=* character in a line: between the parameter name and its value.
All other *=* characters should be either escaped or whithin "quotes".
password = 123=123
... is incorrect. You should use:
password = 123\=123
... or :
password = "123=123"
Line spanning
~~~~~~~~~~~~~
@ -81,7 +95,7 @@ You can put a backslash at the end of the line to join it to the next
one. This creates one virtual line that is composed of more than one
physical line.
Also, if you leave the "" quote container open before a newline, it will
Also, if you leave the *""* quote container open before a newline, it will
keep scanning until it reaches another one. If you see bizarre behavior
in your configuration files, check for an unintentional instance of
quotes spanning multiple lines.
@ -250,7 +264,7 @@ You should see just one line in response:
OL
OL means your system is running on line power. If it says something
else (like OB - on battery, or LB - low battery), your driver was
else (like OB - on battery, or LB - low battery), your driver was
probably misconfigured during the <<Driver_configuration, Driver configuration>>
step. If you reconfigure the driver, use 'upsdrvctl stop' to stop it, then
start it again as shown in the <<Starting_drivers, Starting driver(s)>> step.

2
docs/design.txt
View file

@ -128,7 +128,7 @@ This scenario requires some configuration, obviously:
2. upsd has a valid UPS entry in ups.conf for this UPS.
[myups]
driver = upsdriver
driver = nutupsdrv
port = /dev/ttySx
3. upsd has a valid user for upsmon in upsd.users.

4
docs/developer-guide.txt
View file

@ -119,7 +119,7 @@ Device recording
----------------
To complete dummy-ups, NUT provides a device recorder script called
'device-recorder.sh' and located in the 'tools/' directory of the
'nut-recorder.sh' and located in the 'tools/' directory of the
NUT source tree.
This script uses 'upsc' to record device information, and stores
@ -131,7 +131,7 @@ Its usage is the following:
For example, to record information from the device 'myups' every 10 seconds:
tools/device-recorder.sh myups@localhost myups.seq 10
nut-recorder.sh myups@localhost myups.seq 10
During the recording, you will want to generate power events, such as power
failure and restoration. These will be tracked in the simulation files, and be

13
docs/developers.txt
View file

@ -145,15 +145,15 @@ int open_subspace(char *ship, int privacy)
}
--------------------------------------------------------------------------------
The basic idea is that I try to group things into functions, and then
The basic idea is that we try to group things into functions, and then
find ways to drop out of them when we can't go any further. There's
another way to program this involving a big else chunk and a bunch of
braces, and it can be hard to follow. You can read this from top to
bottom and have a pretty good idea of what's going on without having to
track too much { } nesting and indenting.
I don't really care for pretentiousVariableNamingSchemes, but you can
probably get away with it in your own driver that I will never have to
We don't really care for pretentiousVariableNamingSchemes, but you can
probably get away with it in your own driver that we will never have to
touch. If your function or variable names start pushing important code
off the right margin of the screen, expect them to meet the byte
chainsaw sooner or later.
@ -171,8 +171,13 @@ without inflicting much pain on other developers. If you use a space,
then you've fixed the spacing in stone and have really annoyed half of
the people out there.
Note that tabs apply only to *indenting*. Alignment of text after any
non-tab character has appeared on the line must be done by spaces in
order for it to remain at the same alignment when someone views tabs at
a different widths.
If you write something that uses spaces, you may get away with it in a
driver that's relatively secluded. However, if I have to work on that
driver that's relatively secluded. However, if we have to work on that
code, expect it to get reformatted according to the above.
Patches to existing code that don't conform to the coding style being

5
docs/download.txt
View file

@ -25,7 +25,8 @@ Stable tree: {tree_version}
- link:http://www.networkupstools.org/source/{tree_version}/nut-{revision}.tar.gz[nut-{revision}.tar.gz]
- link:http://www.networkupstools.org/source/{tree_version}/nut-{revision}.tar.gz.sig[PGP/GPG signature]
- SHA-256 sum: 343554add0713348f8b09bca8d83eee2eb2ae8bad9cdad9a39e0f0e2d0f5d375
- link:http://www.networkupstools.org/source/{tree_version}/nut-{revision}.tar.gz.sha256[SHA-256 sum]
- link:http://www.networkupstools.org/source/{tree_version}/nut-{revision}.tar.gz.md5[MD5 sum]
- link:http://www.networkupstools.org/source/{tree_version}/new-{revision}.txt[Release notes]
- link:http://www.networkupstools.org/source/{tree_version}/ChangeLog[ChangeLog]
@ -114,7 +115,7 @@ link:http://pdb.finkproject.org/pdb/package.php/nut[Fink],
link:http://trac.macports.org/browser/trunk/dports/sysutils/nut/Portfile[MacPorts]
- Windows (complete port, Beta):
link:http://www.networkupstools.org/source/2.6/NUT-Installer-2.6.1-1.msi[Windows MSI installer 2.6.1-1]
link:http://www.networkupstools.org/source/2.6/NUT-Installer-2.6.3-3.msi[Windows MSI installer 2.6.3-3]
Java packages

6
docs/man/Makefile.am
View file

@ -74,13 +74,13 @@ HTML_CLIENT_MANS = \
upsrw.html \
upssched.html
SRC_TOOL_PAGES = nut-scanner.txt
SRC_TOOL_PAGES = nut-scanner.txt nut-recorder.txt
MAN_TOOL_PAGES = nut-scanner.8
MAN_TOOL_PAGES = nut-scanner.8 nut-recorder.8
man8_MANS += $(MAN_TOOL_PAGES)
HTML_TOOL_MANS = nut-scanner.html
HTML_TOOL_MANS = nut-scanner.html nut-recorder.html
# CGI (--with-cgi) related manpages
SRC_CGI_PAGES = \

9
docs/man/Makefile.in
View file

@ -204,6 +204,7 @@ MKDIR_P = @MKDIR_P@
NETLIBS = @NETLIBS@
NM = @NM@
NMEDIT = @NMEDIT@
NUT_NETVERSION = @NUT_NETVERSION@
OBJDUMP = @OBJDUMP@
OBJEXT = @OBJEXT@
OS_NAME = @OS_NAME@
@ -217,6 +218,7 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@
PACKAGE_URL = @PACKAGE_URL@
PACKAGE_VERSION = @PACKAGE_VERSION@
PATH_SEPARATOR = @PATH_SEPARATOR@
PIDPATH = @PIDPATH@
PKG_CONFIG = @PKG_CONFIG@
PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@
PKG_CONFIG_PATH = @PKG_CONFIG_PATH@
@ -224,6 +226,7 @@ PORT = @PORT@
RANLIB = @RANLIB@
RUN_AS_GROUP = @RUN_AS_GROUP@
RUN_AS_USER = @RUN_AS_USER@
SBINDIR = @SBINDIR@
SED = @SED@
SERLIBS = @SERLIBS@
SET_MAKE = @SET_MAKE@
@ -361,9 +364,9 @@ HTML_CLIENT_MANS = \
upsrw.html \
upssched.html
SRC_TOOL_PAGES = nut-scanner.txt
MAN_TOOL_PAGES = nut-scanner.8
HTML_TOOL_MANS = nut-scanner.html
SRC_TOOL_PAGES = nut-scanner.txt nut-recorder.txt
MAN_TOOL_PAGES = nut-scanner.8 nut-recorder.8
HTML_TOOL_MANS = nut-scanner.html nut-recorder.html
# CGI (--with-cgi) related manpages
SRC_CGI_PAGES = \

4
docs/man/apcsmart-old.8
View file

@ -2,12 +2,12 @@
.\" Title: apcsmart-old
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "APCSMART\-OLD" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "APCSMART\-OLD" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

38
docs/man/apcsmart.8
View file

@ -2,12 +2,12 @@
.\" Title: apcsmart
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 11/17/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "APCSMART" "8" "11/17/2011" "Network UPS Tools" "NUT Manual"
.TH "APCSMART" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -96,17 +96,17 @@ These models usually come from late 1990s / pre\-2009 times\&. They are often re
.RS 4
WARNING: these are not
\fInatively\fR
supported by apcsmart (or apcupsd for that matter, if you\(cqre wondering)\&. Around 2007 APC (now APC Schneider) decided to go back to its proprietry roots and all the new models (SMT, SMX, SURTD) use completely different protocol and cables\&. If you purchased a new APC ups, that uses cable with rj45 on the one end, and db\-9 on the other \- then you have such model\&. Your only option to support it through
supported by apcsmart (or apcupsd for that matter, if you\(cqre wondering)\&. Around 2007 APC (now APC Schneider) decided to go back to its proprietry roots and all the new models (SMT, SMX, SURTD) use completely different protocol and cables\&. If you purchased a new APC UPS, that uses cable with rj45 on the one end, and db\-9 on the other \- then you have such model\&. Your only option to support it through
\fBNUT\fR
is to purchase "legacy communications card" \- part #AP9620 (google \*(AqAP9620\*(Aq for more details)\&. Or if that\*(Aqs not an option, rely on official software\&.
.RE
.sp
Another thing to remember is that Smart protocol is not USB protocol\&. If you have ups with both USB and serial ports, then depending on how you connect it, you will need either apcsmart or usbhid\-ups driver\&.
Another thing to remember is that Smart protocol is not USB protocol\&. If you have UPS with both USB and serial ports, then depending on how you connect it, you will need either apcsmart or usbhid\-ups driver\&.
.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 \*(Aqcable=\*(Aq definition described below\&.
.sp
If your 940\-0024C cable is broken or missing, use this diagram to build a clone:
If your 940\-xx24X cable is broken or missing, use this diagram to build a clone:
.sp
http://www\&.networkupstools\&.org/cables\&.html#_940_0024c_clone
.if n \{\
@ -122,7 +122,7 @@ http://www\&.networkupstools\&.org/cables\&.html#_940_0024c_clone
.ps -1
.br
.sp
It was reported, that the 940\-0024E cable uses the same wiring as the 940\-0024C one\&.
The "xx" is either "00" for a short cable, or the number of feet of a longer cable\&. The "X" is a letter representing the minor revision of the physical cable and its connectors ("C" and "E" are commonly found revisions)\&. All minor revisions should use the same pin\-outs and wiring\&.
.sp .5v
.RE
.sp
@ -144,12 +144,12 @@ This is most basic command present in probably all APC models\&. It will hiberna
.PP
"old" models
.RS 4
The behaviour here is unfortunately pretty primitive \- when the power returns, the ups just wakes up\&. No grace periods, no min\&. battery charge condition, etc\&. This is probably not what you want\&.
The behaviour here is unfortunately pretty primitive \- when the power returns, the UPS just wakes up\&. No grace periods, no min\&. battery charge condition, etc\&. This is probably not what you want\&.
.RE
.PP
"new" models
.RS 4
The behaviour here is as expected \- the power is cut off after the eeprom defined grace period\&. The ups will wake up when the power returns, after the eeprom defined delay AND if the eeprom defined min\&. battery charge level is met\&. The delay is counted from the power\*(Aqs return\&.
The behaviour here is as expected \- the power is cut off after the eeprom defined grace period\&. The UPS will wake up when the power returns, after the eeprom defined delay AND if the eeprom defined min\&. battery charge level is met\&. The delay is counted from the power\*(Aqs return\&.
.RE
.RE
.PP
@ -173,9 +173,9 @@ This is basic command used to hibernate UPS regardless if it\*(Aqs running on ba
"old" models
.RS 4
The behaviour is \- unfortunately \- similary primitive to
\fBS\fR\&. The ups unconditionally wakes up after nnn*6 minutes \-
\fBS\fR\&. The UPS unconditionally wakes up after nnn*6 minutes \-
\fBit doesn\*(Aqt care if the power returned !\fR
If nnn = 000, then UPS will do precisely nothing\&. On those models you\*(Aqre better specifying nnn > 0, if you can estimate the kind of power problems that might be happening in your environment\&. Another thing to consider with "old" models \- you might lose the connection with the ups, until it wakes up (with
If nnn = 000, then UPS will do precisely nothing\&. On those models you\*(Aqre better specifying nnn > 0, if you can estimate the kind of power problems that might be happening in your environment\&. Another thing to consider with "old" models \- you might lose the connection with the UPS, until it wakes up (with
\fBS\fR, the serial connection is kept alive)\&.
.RE
.PP
@ -191,16 +191,16 @@ option, or argument to one of the supported instant commands)\&.
.PP
\fBK\fR (delayed poweroff)
.RS 4
This is permanent poweroff \- the ups will not wake up automatically\&. On newer units, it will respect applicable eeprom variables\&.
This is permanent poweroff \- the UPS will not wake up automatically\&. On newer units, it will respect applicable eeprom variables\&.
.RE
.PP
\fBZ\fR (instant poweroff)
.RS 4
This is also permanent poweroff \- the ups will not wake up automatically\&. The poweroff is executed immediately\&.
This is also permanent poweroff \- the UPS will not wake up automatically\&. The poweroff is executed immediately\&.
.RE
.SH "SHUTDOWN CONTROL BY NUT"
.sp
There\*(Aqre 3 options used to control shutdown behaviour\&.
There are three options used to control the shutdown behaviour\&.
.PP
\fBsdtype\fR=[0\-5]
.RS 4
@ -229,7 +229,7 @@ The values permitted are from 0 to 5\&. Only one can be specified\&. Anything el
.PP
0
.RS 4
issue soft hibernate (\fBS\fR) if the ups is running on batteries, otherwise issue hard hibernate (\fB@\fR)
issue soft hibernate (\fBS\fR) if the UPS is running on batteries, otherwise issue hard hibernate (\fB@\fR)
.RE
.PP
1
@ -274,7 +274,7 @@ Hard hibernate\*(Aqs additional wakeup delay can be provided by \fBawd\fR\&.
.RE
.SS "ADVORDER"
.sp
The argument is either a word \*(Aqno\*(Aq, or a string of 1 \- 5 digits in [0 \- 4] range\&. Each digit maps to the one of shutdown methods supported by APC upses\&. Methods listed in this way are tried in order, until one of them succedes\&.
The argument is either a word \*(Aqno\*(Aq, or a string of 1 \- 5 digits in [0 \- 4] range\&. Each digit maps to the one of shutdown methods supported by APC UPSes\&. Methods listed in this way are tried in order, until one of them succedes\&.
.sp
If \fBadvorder\fR is undefined or set to \*(Aqno\*(Aq, \fBsdtype\fR is used instead\&.
.sp
@ -351,9 +351,9 @@ battery\&.runtime < battery\&.runtime\&.low
.sp
Of course \- if any of the variables are not available, the appropriate condition is not checked\&. If you want to explicitly disable one of the conditions, simply override the right hand variable causing the condition to always evaluate to false (you can even provide negative numbers)\&.
.sp
APC upses don\*(Aqt have battery\&.charge\&.low \- you will have to define it if you want to use such condition (prefix the variable with override\&. or default\&.)\&.
APC UPSes don\*(Aqt have battery\&.charge\&.low \- you will have to define it if you want to use such condition (prefix the variable with override\&. or default\&.)\&.
.sp
"New" units have battery\&.runtime\&.low, but depending on battery quality, firmware version, calibration and ups load \- this variable can be underestimated quite a bit \- especially right after going into OB state\&. This in turn can cause LB to be asserted, which under normal conditions will cause \fBNUT\fR to initiate the shutdown\&. You might want to disable this condition entirely, when relying on \fBignorelb\fR option (this was actually the main motivation behind introduction of such feature)\&.
"New" units have battery\&.runtime\&.low, but depending on battery quality, firmware version, calibration and UPS load \- this variable can be underestimated quite a bit \- especially right after going into OB state\&. This in turn can cause LB to be asserted, which under normal conditions will cause \fBNUT\fR to initiate the shutdown\&. You might want to disable this condition entirely, when relying on \fBignorelb\fR option (this was actually the main motivation behind introduction of such feature)\&.
.sp
Simple example:
.sp
@ -372,7 +372,7 @@ Simple example:
.sp
This would cause apcsmart to go into shutdown \fIonly\fR if detected battery charge < 15%\&. Runtime condition is always false in this example\&.
.sp
You could ask \- why bother ? Well, the reason is already hinted above\&. APC units can be very picky about the batteries, and their firmware can underestimate the remaining runtime (especially right after going into OB state)\&. \fBignorelb\fR option and \fBoverride\&.*\fR let you remain in control of the ups, not ups in control of you\&.
You could ask \- why bother ? Well, the reason is already hinted above\&. APC units can be very picky about the batteries, and their firmware can underestimate the remaining runtime (especially right after going into OB state)\&. \fBignorelb\fR option and \fBoverride\&.*\fR let you remain in control of the UPS, not UPS in control of you\&.
.sp
Furthermore, this allows to specify conditions similary to how it\(cqs done in apcupsd daemon, so it should be welcome by people used to that software\&.
.SH "SUPPORTED INSTANT COMMANDS"
@ -406,7 +406,7 @@ load\&.off
executes "instant poweroff"
.RE
.sp
All the above commands must be issued 2nd time to have any effect (no less than 3 seconds, and no more than 15 seconds after the initial call)\&. Those commands are mostly useful for manual testing, when your machine is not powered by the ups you\*(Aqre testing\&.
All the above commands must be issued 2nd time to have any effect (no less than 3 seconds, and no more than 15 seconds after the initial call)\&. Those commands are mostly useful for manual testing, when your machine is not powered by the UPS you\*(Aqre testing\&.
.sp
Other supported commands:
.sp

41
docs/man/apcsmart.txt
View file

@ -53,14 +53,14 @@ division isn\'t strict by any means, and the borders between those are pretty fu
WARNING: these are not _natively_ supported by apcsmart (or apcupsd for that
matter, if you\'re wondering). Around 2007 APC (now APC Schneider) decided to
go back to its proprietry roots and all the new models (SMT, SMX, SURTD) use
completely different protocol and cables. If you purchased a new APC ups,
completely different protocol and cables. If you purchased a new APC UPS,
that uses cable with rj45 on the one end, and db-9 on the other - then you
have such model. Your only option to support it through *NUT* is to
purchase "legacy communications card" - part #AP9620 (google \'AP9620' for
more details). Or if that\'s not an option, rely on official software.
Another thing to remember is that Smart protocol is not USB protocol. If you
have ups with both USB and serial ports, then depending on how you connect it,
have UPS with both USB and serial ports, then depending on how you connect it,
you will need either apcsmart or usbhid-ups driver.
CABLING
@ -70,13 +70,16 @@ 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
If your 940-xx24X cable is broken or missing, use this diagram to build
a clone:
http://www.networkupstools.org/cables.html#_940_0024c_clone
NOTE: It was reported, that the 940-0024E cable uses the same wiring as the
940-0024C one.
NOTE: The "xx" is either "00" for a short cable, or the number of feet
of a longer cable. The "X" is a letter representing the minor revision
of the physical cable and its connectors ("C" and "E" are commonly found
revisions). All minor revisions should use the same pin-outs and
wiring.
You can specify alternate cable in linkman:ups.conf[5]:
@ -99,12 +102,12 @@ behaviour quite a bit, depending on the model.
"old" models:::
The behaviour here is unfortunately pretty primitive - when the power
returns, the ups just wakes up. No grace periods, no min. battery
returns, the UPS just wakes up. No grace periods, no min. battery
charge condition, etc. This is probably not what you want.
"new" models:::
The behaviour here is as expected - the power is cut off after the
eeprom defined grace period. The ups will wake up when the power
eeprom defined grace period. The UPS will wake up when the power
returns, after the eeprom defined delay AND if the eeprom defined min.
battery charge level is met. The delay is counted from the power\'s
return.
@ -125,13 +128,13 @@ command if your UPS supports it (and is not too old, see below).
+
--
"old" models:::
The behaviour is - unfortunately - similary primitive to *S*. The ups
The behaviour is - unfortunately - similary primitive to *S*. The UPS
unconditionally wakes up after $$nnn*6$$ minutes - *it doesn\'t care if the
power returned !* If nnn = 000, then UPS will do precisely nothing. On
those models you\'re better specifying nnn > 0, if you can estimate
the kind of power problems that might be happening in your environment.
Another thing to consider with "old" models - you might lose the
connection with the ups, until it wakes up (with *S*, the serial
connection with the UPS, until it wakes up (with *S*, the serial
connection is kept alive).
"new" models:::
@ -147,17 +150,17 @@ NUT also supports such variation. You have to provide exactly 2 digits to
trigger it (*awd* option, or argument to one of the supported instant commands).
*K* (delayed poweroff)::
This is permanent poweroff - the ups will not wake up automatically. On
This is permanent poweroff - the UPS will not wake up automatically. On
newer units, it will respect applicable eeprom variables.
*Z* (instant poweroff)::
This is also permanent poweroff - the ups will not wake up automatically. The
poweroff is executed immediately.
This is also permanent poweroff - the UPS will not wake up automatically.
The poweroff is executed immediately.
SHUTDOWN CONTROL BY NUT
-----------------------
There\'re 3 options used to control shutdown behaviour.
There are three options used to control the shutdown behaviour.
*sdtype*=[0-5]::
This option takes a single digit (0-5) as an argument. See below for
@ -188,7 +191,7 @@ The values permitted are from 0 to 5. Only one can be specified. Anything else
will cause apcsmart to exit.
0::
issue soft hibernate (*S*) if the ups is running on batteries, otherwise issue
issue soft hibernate (*S*) if the UPS is running on batteries, otherwise issue
hard hibernate (*@*)
1::
issue soft hibernate (*S*) (if on batteries), and if it fails (or on mains) -
@ -208,7 +211,7 @@ ADVORDER
~~~~~~~~
The argument is either a word \'no', or a string of 1 - 5 digits in [0 - 4]
range. Each digit maps to the one of shutdown methods supported by APC upses.
range. Each digit maps to the one of shutdown methods supported by APC UPSes.
Methods listed in this way are tried in order, until one of them succedes.
If *advorder* is undefined or set to \'no', *sdtype* is used instead.
@ -245,11 +248,11 @@ is not checked. If you want to explicitly disable one of the conditions, simply
override the right hand variable causing the condition to always evaluate to
false (you can even provide negative numbers).
APC upses don\'t have battery.charge.low - you will have to define it if you want
APC UPSes don\'t have battery.charge.low - you will have to define it if you want
to use such condition (prefix the variable with override. or default.).
"New" units have battery.runtime.low, but depending on battery quality, firmware
version, calibration and ups load - this variable can be underestimated quite a bit -
version, calibration and UPS load - this variable can be underestimated quite a bit -
especially right after going into OB state. This in turn can cause LB to be
asserted, which under normal conditions will cause *NUT* to initiate the
shutdown. You might want to disable this condition entirely, when relying on
@ -272,7 +275,7 @@ This would cause apcsmart to go into shutdown _only_ if detected battery charge
You could ask - why bother ? Well, the reason is already hinted above. APC units
can be very picky about the batteries, and their firmware can underestimate the
remaining runtime (especially right after going into OB state). *ignorelb*
option and *$$override.*$$* let you remain in control of the ups, not ups in control
option and *$$override.*$$* let you remain in control of the UPS, not UPS in control
of you.
Furthermore, this allows to specify conditions similary to how it's done in
@ -298,7 +301,7 @@ executes "instant poweroff"
All the above commands must be issued 2nd time to have any effect (no less than 3
seconds, and no more than 15 seconds after the initial call). Those commands are
mostly useful for manual testing, when your machine is not powered by the ups
mostly useful for manual testing, when your machine is not powered by the UPS
you\'re testing.
Other supported commands:

4
docs/man/bcmxcp.8
View file

@ -2,12 +2,12 @@
.\" Title: bcmxcp
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BCMXCP" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "BCMXCP" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/bcmxcp_usb.8
View file

@ -2,12 +2,12 @@
.\" Title: bcmxcp_usb
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BCMXCP_USB" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "BCMXCP_USB" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/belkin.8
View file

@ -2,12 +2,12 @@
.\" Title: belkin
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BELKIN" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "BELKIN" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/belkinunv.8
View file

@ -2,12 +2,12 @@
.\" Title: belkinunv
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BELKINUNV" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "BELKINUNV" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/bestfcom.8
View file

@ -2,12 +2,12 @@
.\" Title: bestfcom
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BESTFCOM" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "BESTFCOM" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/bestfortress.8
View file

@ -2,12 +2,12 @@
.\" Title: bestfortress
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BESTFORTRESS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "BESTFORTRESS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/bestuferrups.8
View file

@ -2,12 +2,12 @@
.\" Title: bestuferrups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BESTUFERRUPS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "BESTUFERRUPS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/bestups.8
View file

@ -2,12 +2,12 @@
.\" Title: bestups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BESTUPS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "BESTUPS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/blazer.8
View file

@ -2,12 +2,12 @@
.\" Title: blazer
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/17/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "BLAZER" "8" "12/17/2011" "Network UPS Tools" "NUT Manual"
.TH "BLAZER" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -34,7 +34,7 @@ blazer \- Driver for Megatec/Q1 protocol serial (blazer_ser) and USB (blazer_usb
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\&.
The blazer driver is known to work with various UPSes from Blazer, Energy Sistem, Fenton Technologies, General Electric, 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"
@ -109,7 +109,7 @@ Parameter used in the (optional) runtime estimation\&. This takes two runtimes a
.RS 4
.\}
.nf
runtimecal = 270,100,720,50
runtimecal = 240,100,720,50
.fi
.if n \{\
.RE

9
docs/man/blazer.txt
View file

@ -16,9 +16,10 @@ 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.
Sistem, Fenton Technologies, General Electric, 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.
@ -90,7 +91,7 @@ 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
runtimecal = 240,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

4
docs/man/clone.8
View file

@ -2,12 +2,12 @@
.\" Title: clone
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "CLONE" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "CLONE" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/dummy-ups.8
View file

@ -2,12 +2,12 @@
.\" Title: dummy-ups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "DUMMY\-UPS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "DUMMY\-UPS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/etapro.8
View file

@ -2,12 +2,12 @@
.\" Title: etapro
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "ETAPRO" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "ETAPRO" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/everups.8
View file

@ -2,12 +2,12 @@
.\" Title: everups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "EVERUPS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "EVERUPS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/gamatronic.8
View file

@ -2,12 +2,12 @@
.\" Title: gamatronic
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "GAMATRONIC" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "GAMATRONIC" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/genericups.8
View file

@ -2,12 +2,12 @@
.\" Title: genericups
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "GENERICUPS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "GENERICUPS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/hosts.conf.5
View file

@ -2,12 +2,12 @@
.\" 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: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "HOSTS\&.CONF" "5" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "HOSTS\&.CONF" "5" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/isbmex.8
View file

@ -2,12 +2,12 @@
.\" Title: isbmex
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "ISBMEX" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "ISBMEX" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/ivtscd.8
View file

@ -2,12 +2,12 @@
.\" Title: ivtscd
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "IVTSCD" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "IVTSCD" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/libupsclient-config.1
View file

@ -2,12 +2,12 @@
.\" Title: libupsclient-config
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "LIBUPSCLIENT\-CONFIG" "1" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "LIBUPSCLIENT\-CONFIG" "1" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/liebert-esp2.8
View file

@ -2,12 +2,12 @@
.\" Title: liebert-esp2
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "LIEBERT\-ESP2" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "LIEBERT\-ESP2" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/liebert.8
View file

@ -2,12 +2,12 @@
.\" Title: liebert
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "LIEBERT" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "LIEBERT" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/masterguard.8
View file

@ -2,12 +2,12 @@
.\" Title: masterguard
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "MASTERGUARD" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "MASTERGUARD" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/metasys.8
View file

@ -2,12 +2,12 @@
.\" Title: metasys
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "METASYS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "METASYS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/mge-shut.8
View file

@ -2,12 +2,12 @@
.\" Title: mge-shut
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "MGE\-SHUT" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "MGE\-SHUT" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/mge-utalk.8
View file

@ -2,12 +2,12 @@
.\" Title: mge-utalk
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "MGE\-UTALK" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "MGE\-UTALK" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/microdowell.8
View file

@ -2,12 +2,12 @@
.\" Title: microdowell
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "MICRODOWELL" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "MICRODOWELL" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/netxml-ups.8
View file

@ -2,12 +2,12 @@
.\" Title: netxml-ups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NETXML\-UPS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NETXML\-UPS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nut-ipmipsu.8
View file

@ -2,12 +2,12 @@
.\" Title: nut-ipmipsu
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUT\-IPMIPSU" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUT\-IPMIPSU" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

103
docs/man/nut-recorder.8 Normal file
View file

@ -0,0 +1,103 @@
'\" t
.\" Title: nut-recorder
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUT\-RECORDER" "8" "05/21/2012" "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-recorder \- utility to record device status and values changes
.SH "SYNOPSIS"
.sp
\fBnut\-recorder\fR \fIdevice\-name\fR [output\-file] [interval]
.SH "DESCRIPTION"
.sp
\fBnut\-recorder\fR is an utility to record device running sequence (Ie power failures or any other change) through a NUT data server, and dump it in a \&.seq format\&.
.sp
The \&.seq file can then be used by the \fBdummy-ups\fR(8) driver to replay the sequence\&.
.SH "OPTIONS"
.PP
\fIdevice\-name\fR
.RS 4
Record the changes of that device\&. The format for this option is
\fIdevname[@hostname[:port]]\fR\&. The default hostname is "localhost"\&.
.RE
.PP
\fIoutput\-file\fR
.RS 4
Optional\&. Data will be saved to this file\&. The default is
\fIdummy\-device\&.seq\fR\&.
.RE
.PP
\fIinterval\fR
.RS 4
Optional\&. The status of the device will be checked every
\fIinterval\fR\&. The default is 5 seconds\&.
.RE
.SH "EXAMPLES"
.sp
To record data from \fIups1@host1\fR every 10 seconds:
.sp
.if n \{\
.RS 4
.\}
.nf
$ nut\-recorder ups1@host1\*(Aq ups1\-output\&.seq 10
\&. \&. \&.
battery\&.charge: 100\&.0
battery\&.voltage: 13\&.9
battery\&.voltage\&.nominal: 13\&.6
ups\&.status: OL
\&. \&. \&.
battery\&.charge: 90\&.0
ups\&.status: OB
\&. \&. \&.
.fi
.if n \{\
.RE
.\}
.sp
You can then define a dummy device in \fBups.conf\fR(5):
.sp
.if n \{\
.RS 4
.\}
.nf
[ups\-test]
driver = dummy\-ups
port = ups1\-output\&.seq
.fi
.if n \{\
.RE
.\}
.SH "AUTHOR"
.sp
Arnaud Quette
.SH "SEE ALSO"
.sp
\fBdummy-ups\fR(8)
.SH "INTERNET RESOURCES"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/

73
docs/man/nut-recorder.txt Normal file
View file

@ -0,0 +1,73 @@
NUT-RECORDER(8)
===============
NAME
----
nut-recorder - utility to record device status and values changes
SYNOPSIS
--------
*nut-recorder* 'device-name' [output-file] [interval]
DESCRIPTION
-----------
*nut-recorder* is an utility to record device running sequence (Ie
power failures or any other change) through a NUT data server, and
dump it in a .seq format.
The .seq file can then be used by the linkman:dummy-ups[8] driver
to replay the sequence.
OPTIONS
-------
'device-name'::
Record the changes of that device. The format for this option is
'devname[@hostname[:port]]'. The default hostname is "localhost".
'output-file'::
Optional. Data will be saved to this file. The default is
'dummy-device.seq'.
'interval'::
Optional. The status of the device will be checked every 'interval'.
The default is 5 seconds.
EXAMPLES
--------
To record data from 'ups1@host1' every 10 seconds:
$ nut-recorder ups1@host1' ups1-output.seq 10
. . .
battery.charge: 100.0
battery.voltage: 13.9
battery.voltage.nominal: 13.6
ups.status: OL
. . .
battery.charge: 90.0
ups.status: OB
. . .
You can then define a dummy device in linkman:ups.conf[5]:
[ups-test]
driver = dummy-ups
port = ups1-output.seq
AUTHOR
------
Arnaud Quette
SEE ALSO
--------
linkman:dummy-ups[8]
INTERNET RESOURCES
------------------
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

7
docs/man/nut-scanner.8
View file

@ -2,12 +2,12 @@
.\" Title: nut-scanner
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 01/03/2012
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUT\-SCANNER" "8" "01/03/2012" "Network UPS Tools" "NUT Manual"
.TH "NUT\-SCANNER" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -37,6 +37,9 @@ nut-scanner \- scan communication buses for NUT devices
.SH "DESCRIPTION"
.sp
\fBnut\-scanner\fR scans available communication buses and displays any NUT\-compatible devices it has found\&.
.SH "INSTALLATION"
.sp
\fBnut\-scanner\fR is always built by default\&. However, available options (USB, SNMP, IPMI, \&...) will vary according to the available compile time and runtime dependencies\&. For example, if Net\-SNMP is installed, thus providing libsnmp (\&.so or \&.dll) and headers, both during compilation and runtime, then SNMP discovery will be available\&.
.SH "OPTIONS"
.PP
\fB\-h\fR

10
docs/man/nut-scanner.txt
View file

@ -18,6 +18,15 @@ DESCRIPTION
*nut-scanner* scans available communication buses and displays any
NUT-compatible devices it has found.
INSTALLATION
------------
*nut-scanner* is always built by default. However, available options
(USB, SNMP, IPMI, ...) will vary according to the available compile time
and runtime dependencies. For example, if Net-SNMP is installed, thus
providing libsnmp (.so or .dll) and headers, both during compilation
and runtime, then SNMP discovery will be available.
OPTIONS
-------
*-h*::
@ -159,7 +168,6 @@ To scan NUT servers with a timeout of 10 seconds on IP range 192.168.0.0 to 192.
*nut-scanner -O -t 10 -m 192.168.0.0/25*
SEE ALSO
--------

17
docs/man/nut.conf.5
View file

@ -2,12 +2,12 @@
.\" 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: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUT\&.CONF" "5" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUT\&.CONF" "5" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -36,6 +36,11 @@ This file attempts to standardize the various files being found in different ins
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 "IMPORTANT NOTE"
.sp
This file is intended to be sourced by shell scripts\&. You MUST NOT use spaces around the equal sign!
.sp
Refer to the EXAMPLE section for illustrations\&.
.SH "DIRECTIVES"
.PP
\fBMODE\fR
@ -123,7 +128,7 @@ this workaround might be dangerous under some circumstances\&. Please read http:
.RS 4
.\}
.nf
MODE = none
MODE=none
.fi
.if n \{\
.RE
@ -133,7 +138,7 @@ MODE = none
.RS 4
.\}
.nf
UPSD_OPTIONS = ""
UPSD_OPTIONS=""
.fi
.if n \{\
.RE
@ -143,7 +148,7 @@ UPSD_OPTIONS = ""
.RS 4
.\}
.nf
UPSMON_OPTIONS = ""
UPSMON_OPTIONS=""
.fi
.if n \{\
.RE
@ -153,7 +158,7 @@ UPSMON_OPTIONS = ""
.RS 4
.\}
.nf
# POWEROFF_WAIT = 15m
# POWEROFF_WAIT=15m
.fi
.if n \{\
.RE

16
docs/man/nut.conf.txt
View file

@ -19,6 +19,14 @@ 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.
IMPORTANT NOTE
--------------
This file is intended to be sourced by shell scripts.
You MUST NOT use spaces around the equal sign!
Refer to the EXAMPLE section for illustrations.
DIRECTIVES
----------
@ -76,13 +84,13 @@ EXAMPLE
# /etc/nut/nut.conf. See nut.conf(5)
MODE = none
MODE=none
UPSD_OPTIONS = ""
UPSD_OPTIONS=""
UPSMON_OPTIONS = ""
UPSMON_OPTIONS=""
# POWEROFF_WAIT = 15m
# POWEROFF_WAIT=15m
INTEGRATION
-----------

4
docs/man/nutscan.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 11/03/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN" "3" "11/03/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_add_device_to_device.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_add_device_to_device
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_ADD_DEVICE_T" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_ADD_DEVICE_T" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_add_option_to_device.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_add_option_to_device
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_ADD_OPTION_T" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_ADD_OPTION_T" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_cidr_to_ip.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_cidr_to_ip
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_CIDR_TO_IP" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_CIDR_TO_IP" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_display_parsable.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_display_parsable
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_DISPLAY_PARS" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_DISPLAY_PARS" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_display_ups_conf.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_display_ups_conf
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_DISPLAY_UPS_" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_DISPLAY_UPS_" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_free_device.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_free_device
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_FREE_DEVICE" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_FREE_DEVICE" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_init.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_init
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/15/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_INIT" "3" "12/15/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_INIT" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_new_device.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_new_device
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_NEW_DEVICE" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_NEW_DEVICE" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_scan_avahi.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_scan_avahi
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/15/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_SCAN_AVAHI" "3" "12/15/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_SCAN_AVAHI" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_scan_ipmi.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_scan_ipmi
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/15/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_SCAN_IPMI" "3" "12/15/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_SCAN_IPMI" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_scan_nut.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_scan_nut
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/15/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_SCAN_NUT" "3" "12/15/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_SCAN_NUT" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_scan_snmp.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_scan_snmp
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/15/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_SCAN_SNMP" "3" "12/15/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_SCAN_SNMP" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_scan_usb.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_scan_usb
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/15/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_SCAN_USB" "3" "12/15/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_SCAN_USB" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutscan_scan_xml_http.3
View file

@ -2,12 +2,12 @@
.\" Title: nutscan_scan_xml_http
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/15/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTSCAN_SCAN_XML_HTT" "3" "12/15/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTSCAN_SCAN_XML_HTT" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/nutupsdrv.8
View file

@ -2,12 +2,12 @@
.\" Title: nutupsdrv
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUTUPSDRV" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "NUTUPSDRV" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

156
docs/man/oneac.8
View file

@ -2,12 +2,12 @@
.\" Title: oneac
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "ONEAC" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "ONEAC" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -34,7 +34,53 @@ oneac \- Driver for Oneac UPS equipment
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\&.
This driver supports various Oneac UPS families:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
EG (late 80s, early 90s, plug\-in serial interface card)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ON (early and mid\-90s, plug\-in serial interface card)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OZ (mid\-90s on, DB\-25 std\&., interface slot)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OB (early 2000\(cqs on, big cabinet, DB\-25 std\&., interface slot)
.RE
.sp
If your UPS is equipped with the Basic Interface card, use the \fBgenericups\fR(8) driver\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in the \fBups.conf\fR(5) file:
@ -43,18 +89,39 @@ This driver supports the following optional settings in the \fBups.conf\fR(5) fi
.RS 4
Change battery test time from the 2 minute default\&.
.RE
.PP
\fBoffdelay\fR=\fInum\fR
.RS 4
Change shutdown delay time from 0 second default\&.
.RE
.SH "INSTANT COMMANDS"
.sp
This driver supports the following Instant Commands\&.
This driver supports the following Instant Commands\&. (See \fBupscmd\fR(8))
.SS "All UPS units"
.PP
\fBreset\&.input\&.minmax\fR
\fBshutdown\&.return\fR
.RS 4
Reset the minimum and maximum input line voltage values seen since the last reset or power on\&.
Turn off the load possibly after a delay and return when power is back\&.
.RE
.PP
\fBtest\&.battery\&.start\fR
\fBshutdown\&.stop\fR
.RS 4
Start a battery test\&. The default time is 2 minutes\&. This time can be set in the
Stop a shutdown in progress\&.
.RE
.PP
\fBshutdown\&.reboot\fR
.RS 4
Shut down the load briefly while rebooting the UPS\&.
.RE
.PP
\fBtest\&.failure\&.start\fR
.RS 4
Starts a 15 second long simulation of an input power failure\&.
.RE
.PP
\fBtest\&.battery\&.start\&.quick\fR
.RS 4
Start a "quick" battery test\&. The default time is 2 minutes\&. This time can be set in the
\fBups\&.conf\fR
file\&. See
\fBtestime\fR
@ -65,14 +132,81 @@ above\&.
.RS 4
Stops a battery test that is in progress\&.
.RE
.SS "All ON UPS units"
.PP
\fBtest\&.failure\&.start\fR
\fBreset\&.input\&.minmax\fR
.RS 4
Starts a 15 second long simulation of an input power failure\&.
Reset the minimum and maximum input line voltage values seen since the last reset or power on\&.
.RE
.SS "Newer ON UPS units"
.PP
\fBtest\&.panel\&.start\fR
.RS 4
Start testing the UPS panel\&.
.RE
.PP
\fBtest\&.battery\&.start\&.deep\fR
.RS 4
Start a "deep" battery test\&. This test runs the UPS until the low battery point and then returns to the AC line\&.
.RE
.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
\fBbeeper\&.enable\fR
.RS 4
Enable UPS beeper/buzzer\&.
.RE
.PP
\fBbeeper\&.disable\fR
.RS 4
Disable UPS beeper/buzzer\&.
.RE
.PP
\fBbeeper\&.mute\fR
.RS 4
Mutes the UPS beeper/buzzer for the current alarm condition(s)\&.
.RE
.SH "WRITABLE VARIABLES"
.sp
See \fBupsrw\fR(8) to see what variables are writable for the UPS\&.
.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
If your UPS supports writing battery\&.runtime\&.low, the new set value is to be entered in minutes (up to 99) but the reported value is reported in seconds (set value * 60)\&.
.sp .5v
.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
If your UPS supports input\&.transfer\&.low and input\&.transfer\&.high, those values are used to create an allowable output range\&. The UPS will do what it can to keep the output voltage value within the defined range (for example: tap change or switch to inverter)\&.
.sp .5v
.RE
.SH "AUTHOR"
.sp
Eric Lawson <elawson@inficad\&.com>
Bill Elliot <bill@wreassoc\&.com>, Eric Lawson <elawson@inficad\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp

85
docs/man/oneac.txt
View file

@ -15,9 +15,16 @@ 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.
This driver supports various Oneac UPS families:
- EG (late 80s, early 90s, plug-in serial interface card)
- ON (early and mid-90s, plug-in serial interface card)
- OZ (mid-90s on, DB-25 std., interface slot)
- OB (early 2000's on, big cabinet, DB-25 std., interface slot)
If your UPS is equipped with the Basic Interface card, use the
linkman:genericups[8] driver.
EXTRA ARGUMENTS
---------------
@ -27,27 +34,83 @@ linkman:ups.conf[5] file:
*testtime*='num'::
Change battery test time from the 2 minute default.
*offdelay*='num'::
Change shutdown delay time from 0 second default.
INSTANT COMMANDS
----------------
This driver supports the following Instant Commands.
(See linkman:upscmd[8])
*reset.input.minmax*::
Reset the minimum and maximum input line voltage values
seen since the last reset or power on.
All UPS units
~~~~~~~~~~~~~
*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.
*shutdown.return*::
Turn off the load possibly after a delay and return when power is back.
*test.battery.stop*::
Stops a battery test that is in progress.
*shutdown.stop*::
Stop a shutdown in progress.
*shutdown.reboot*::
Shut down the load briefly while rebooting the UPS.
*test.failure.start*::
Starts a 15 second long simulation of an input power
failure.
*test.battery.start.quick*::
Start a "quick" 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.
All ON UPS units
~~~~~~~~~~~~~~~~
*reset.input.minmax*::
Reset the minimum and maximum input line voltage values
seen since the last reset or power on.
Newer ON UPS units
~~~~~~~~~~~~~~~~~~
*test.panel.start*::
Start testing the UPS panel.
*test.battery.start.deep*::
Start a "deep" battery test. This test runs the UPS until the low
battery point and then returns to the AC line.
*reset.input.minmax*::
Reset the minimum and maximum input line voltage values
seen since the last reset or power on.
*beeper.enable*::
Enable UPS beeper/buzzer.
*beeper.disable*::
Disable UPS beeper/buzzer.
*beeper.mute*::
Mutes the UPS beeper/buzzer for the current alarm condition(s).
Writable Variables
------------------
See linkman:upsrw[8] to see what variables are writable for the UPS.
NOTE: If your UPS supports writing battery.runtime.low, the new set value
is to be entered in minutes (up to 99) but the reported value is reported
in seconds (set value * 60).
NOTE: If your UPS supports input.transfer.low and input.transfer.high,
those values are used to create an allowable output range. The UPS
will do what it can to keep the output voltage value within the
defined range (for example: tap change or switch to inverter).
AUTHOR
------
Bill Elliot <bill@wreassoc.com>,
Eric Lawson <elawson@inficad.com>
SEE ALSO

4
docs/man/optiups.8
View file

@ -2,12 +2,12 @@
.\" Title: optiups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "OPTIUPS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "OPTIUPS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/powercom.8
View file

@ -2,12 +2,12 @@
.\" Title: powercom
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "POWERCOM" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "POWERCOM" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/powerman-pdu.8
View file

@ -2,12 +2,12 @@
.\" Title: powerman-pdu
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "POWERMAN\-PDU" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "POWERMAN\-PDU" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/powerpanel.8
View file

@ -2,12 +2,12 @@
.\" Title: powerpanel
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "POWERPANEL" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "POWERPANEL" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/rhino.8
View file

@ -2,12 +2,12 @@
.\" Title: rhino
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "RHINO" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "RHINO" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/richcomm_usb.8
View file

@ -2,12 +2,12 @@
.\" Title: richcomm_usb
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "RICHCOMM_USB" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "RICHCOMM_USB" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/safenet.8
View file

@ -2,12 +2,12 @@
.\" Title: safenet
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "SAFENET" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "SAFENET" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
docs/man/snmp-ups.8
View file

@ -2,12 +2,12 @@
.\" Title: snmp-ups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/05/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "SNMP\-UPS" "8" "12/05/2011" "Network UPS Tools" "NUT Manual"
.TH "SNMP\-UPS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -43,7 +43,7 @@ MGE UPS SYSTEMS and MGE Office Protection Systems devices with SNMP cards (ref 6
.PP
\fBapcc\fR
.RS 4
APC AP9606 APC Web/SNMP management card, perhaps others
APC AP9605, AP9606, AP9617, and AP9618 APC network management cards, as well as any others supporting the APC POWERNET MIB
.RE
.PP
\fBnetvision\fR

2
docs/man/snmp-ups.txt
View file

@ -23,7 +23,7 @@ UPS that is RFC 1628 (UPS MIB) compliant, e.g. MGE UPS SYSTEMS, Liebert, perhaps
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
APC AP9605, AP9606, AP9617, and AP9618 APC network management cards, as well as any others supporting the APC POWERNET MIB
*netvision*::
Socomec Sicon UPS with Netvision Web/SNMP management card/external box

4
docs/man/solis.8
View file

@ -2,12 +2,12 @@
.\" Title: solis
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "SOLIS" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "SOLIS" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/tripplite.8
View file

@ -2,12 +2,12 @@
.\" Title: tripplite
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "TRIPPLITE" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "TRIPPLITE" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/tripplite_usb.8
View file

@ -2,12 +2,12 @@
.\" Title: tripplite_usb
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "TRIPPLITE_USB" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "TRIPPLITE_USB" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/tripplitesu.8
View file

@ -2,12 +2,12 @@
.\" Title: tripplitesu
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "TRIPPLITESU" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "TRIPPLITESU" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/ups.conf.5
View file

@ -2,12 +2,12 @@
.\" 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: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPS\&.CONF" "5" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPS\&.CONF" "5" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

27
docs/man/upsc.8
View file

@ -2,12 +2,12 @@
.\" Title: upsc
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSC" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSC" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -34,6 +34,8 @@ upsc \- example lightweight UPS client
\fBupsc\fR \-l | \-L [\fIhost\fR]
.sp
\fBupsc\fR \fIups\fR [\fIvariable\fR]
.sp
\fBupsc\fR \-c \fIups\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\&.
@ -51,6 +53,12 @@ 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
\fB\-c\fR \fIups\fR
.RS 4
Lists each client connected on
\fIups\fR, one name per line\&.
.RE
.PP
\fIups\fR
.RS 4
Display the status of that UPS\&. The format for this option is
@ -106,6 +114,21 @@ done
.if n \{\
.RE
.\}
.sp
To list clients connected on "myups":
.sp
.if n \{\
.RS 4
.\}
.nf
$ upsc \-c myups
127\&.0\&.0\&.1
::1
192\&.168\&.1\&.2
.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\&.

15
docs/man/upsc.txt
View file

@ -12,6 +12,8 @@ SYNOPSIS
*upsc* 'ups' ['variable']
*upsc* -c 'ups'
DESCRIPTION
-----------
@ -33,6 +35,10 @@ OPTIONS
"localhost". You may optionally add a colon and a port number to override the
default port.
*-c* 'ups'::
Lists each client connected on 'ups', one name per line.
'ups'::
Display the status of that UPS. The format for this option is
@ -69,6 +75,15 @@ syntax:
upsc $UPS ups.status
done
To list clients connected on "myups":
$ upsc -c myups
127.0.0.1
::1
192.168.1.2
DIAGNOSTICS
-----------

4
docs/man/upscli_connect.3
View file

@ -2,12 +2,12 @@
.\" 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: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_CONNECT" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_CONNECT" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_disconnect.3
View file

@ -2,12 +2,12 @@
.\" 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: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_DISCONNECT" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_DISCONNECT" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_fd.3
View file

@ -2,12 +2,12 @@
.\" 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: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_FD" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_FD" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_get.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_get
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_GET" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_GET" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_list_next.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_list_next
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_LIST_NEXT" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_LIST_NEXT" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

15
docs/man/upscli_list_start.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_list_start
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/31/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_LIST_START" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_LIST_START" "3" "05/31/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -98,6 +98,17 @@ LIST CMD <ups>
.\}
LIST ENUM <ups> <var>
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
LIST RANGE <ups> <var>
.RE
.SH "QUERY FORMATTING"
.sp
To see the list of variables on a UPS called \fIsu700\fR, the protocol command would be LIST VAR su700\&. To start that list with this function, you would populate query and numq as follows:

1
docs/man/upscli_list_start.txt
View file

@ -37,6 +37,7 @@ Some examples are:
- LIST RW <ups>
- LIST CMD <ups>
- LIST ENUM <ups> <var>
- LIST RANGE <ups> <var>
QUERY FORMATTING
----------------

4
docs/man/upscli_readline.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_readline
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_READLINE" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_READLINE" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_sendline.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_sendline
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_SENDLINE" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_SENDLINE" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_splitaddr.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_splitaddr
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_SPLITADDR" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_SPLITADDR" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_splitname.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_splitname
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_SPLITNAME" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_SPLITNAME" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_ssl.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_ssl
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_SSL" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_SSL" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_strerror.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_strerror
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_STRERROR" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_STRERROR" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscli_upserror.3
View file

@ -2,12 +2,12 @@
.\" Title: upscli_upserror
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLI_UPSERROR" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLI_UPSERROR" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upsclient.3
View file

@ -2,12 +2,12 @@
.\" Title: upsclient
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/22/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCLIENT" "3" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCLIENT" "3" "05/22/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscmd.8
View file

@ -2,12 +2,12 @@
.\" Title: upscmd
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCMD" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCMD" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upscode2.8
View file

@ -2,12 +2,12 @@
.\" Title: upscode2
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSCODE2" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSCODE2" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

4
docs/man/upsd.8
View file

@ -2,12 +2,12 @@
.\" Title: upsd
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 10/09/2011
.\" Date: 05/21/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "UPSD" "8" "10/09/2011" "Network UPS Tools" "NUT Manual"
.TH "UPSD" "8" "05/21/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

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