diff --git a/man/bcmxcp.8 b/man/bcmxcp.8 index 7e2562b..e3cfd49 100644 --- a/man/bcmxcp.8 +++ b/man/bcmxcp.8 @@ -1,14 +1,16 @@ -.TH "BCMXCP" "8" "Thu Sep 29 2005" "" "Network UPS Tools (NUT)" +.TH "BCMXCP" "8" "Wed Dec 31 2008" "" "Network UPS Tools (NUT)" .SH "NAME" -bcmxcp \- Driver for UPS'es supporting the BCM/XCP protocol +bcmxcp \- Driver for UPS'es supporting the serial BCM/XCP protocol .SH "NOTE" This man page only documents the hardware\(hyspecific features of the bcmxcp driver. For information about the core driver, see \fBnutupsdrv\fR(8). .SH "SUPPORTED HARDWARE" -This driver should recognize all BCM/XCP\-compatible UPS'es. It has -been developed and tested on Powerware PW5115 and PW9120 hardware. +This driver should recognize all serial BCM/XCP\-compatible UPS'es. It has +been developed and tested on Powerware PW5115 and PW9120 hardware. If your UPS +has a USB connection, you may also consult the \fBbcmxcp_usb\fR(8) driver +documentation. .SH "EXTRA ARGUMENTS" This driver supports the following optional settings in the @@ -56,5 +58,8 @@ Tore \[/O]rpetveit .SS The core driver: \fBnutupsdrv\fR(8) +.SS The USB BCM/XCP driver: +\fBbcmxcp_usb\fR(8) + .SS Internet resources: The NUT (Network UPS Tools) home page: http://www.networkupstools.org/ diff --git a/man/bcmxcp_usb.8 b/man/bcmxcp_usb.8 index 95ed9cc..de238d3 100644 --- a/man/bcmxcp_usb.8 +++ b/man/bcmxcp_usb.8 @@ -78,7 +78,7 @@ in the INSTALLATION section above. Don't forget to restart hotplug so that it applies these changes. .SH AUTHOR -Tore \[/O]rpetveit +Tore \[/O]rpetveit , Wolfgang Ocker .SH SEE ALSO diff --git a/man/blazer.8 b/man/blazer.8 old mode 100755 new mode 100644 index ead3756..8bccc0e --- a/man/blazer.8 +++ b/man/blazer.8 @@ -1,6 +1,6 @@ .TH BLAZER 8 "Fri Nov 14 2008" "" "Network UPS Tools (NUT)" .SH NAME -blazer \- Driver for Megatec/Q1 protocol serial/USB based UPS equipment +blazer_ser, blazer_usb \- Driver for Megatec/Q1 protocol serial/USB based UPS equipment .SH NOTE This man page only documents the hardware\(hyspecific features of the blazer driver. For information about the core driver, see @@ -11,7 +11,7 @@ blazer driver. For information about the core driver, see 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. +other models not listed there may also be supported, but haven't been tested. 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. @@ -154,7 +154,7 @@ Perform a (10 second) battery test. .IP "test.battery.start \fIvalue\fR" -Perform a battery test for the duration of num seconds (truncated to units of +Perform a battery test for the duration of \fInum\fR seconds (truncated to units of 60 seconds). .IP "test.battery.stop" @@ -176,9 +176,9 @@ systems. There are ways to get a fairly accurate reading without disconnecting the load but these invariably don't use the battery voltage, but instead keep track on how much (and how fast) current is going in- and out of the battery. By putting these in a -formula known as the Peukert equation you'll be able to get a fairly accurate measure +formula known as the Peukert equation, you'll be able to get a fairly accurate measure on the state of charge. Unfortunately, your UPS doesn't report all the parameters that -go into this equation, so we're stuck with the below (unreliable) guesstimate. +go into this equation, so we're stuck with the following (unreliable) guesstimate: .nf battery.voltage - battery.voltage.low @@ -186,7 +186,7 @@ battery.charge = ------------------------------------------ x 100 % battery.voltage.high - battery.voltage.low .fi -This is better than nothing (but not much). If this calculation is giving you incorrect +This is better than nothing (but not by much). If this calculation is giving you incorrect readings, you are the one that put in the values in \fBups.conf\fR(5), so don't complain with the author. If you need something better, buy a UPS that reports \fBbattery.charge\fR all by itself without the help of a NUT driver. diff --git a/man/dummy-ups.8 b/man/dummy-ups.8 index 3567cdb..b86cad4 100644 --- a/man/dummy-ups.8 +++ b/man/dummy-ups.8 @@ -15,15 +15,15 @@ Its behavior depends on the running mode: looks like a standard UPS driver to \fBupsd\fR(8) and allows you to set any value for testing purposes. It is interactive, -through upsrw and upscmd commands or equivalent graphical tool. It -can be configured, launched and used as any other real driver. -This mode is mostly useful for testing purposes. +controllable through the \fBupsrw\fR(1) and \fBupscmd\fR(1) commands, or an +equivalent graphical tool. It can be configured, launched and used as any other +real driver. This mode is mostly useful for testing purposes. .IP "Repeater mode" acts as a NUT client, simply forwarding data. This can be useful for supervision purposes. This can also allow some load sharing between several UPS instances, -using a point to point communication with the UPS. +using a point\(hyto\(hypoint communication with the UPS. .SH ARGUMENTS The port specification depends on the running mode, and allows the automatic @@ -89,15 +89,17 @@ which allows to build a virtual device, composed of several other devices (either UPS, PDUs). .SH BUGS -Instant commands are not yet supported, and data need name / value checking -enforcement, as well as boundaries or enumeration definition. +Instant commands are not yet supported in Dummy Mode, and data need name / +value checking enforcement, as well as boundaries or enumeration definition. .SH AUTHOR Arnaud Quette .SH SEE ALSO -\fBups.conf\fR(5) +\fBupscmd\fR(1), +\fBupsrw\fR(1), +\fBups.conf\fR(5), \fBnutupsdrv\fR(8) .SS Internet resources: diff --git a/man/nutupsdrv.8 b/man/nutupsdrv.8 index 2b540b1..e57dc93 100644 --- a/man/nutupsdrv.8 +++ b/man/nutupsdrv.8 @@ -1,4 +1,4 @@ -.TH NUTUPSDRV 8 "Fri Feb 01 2008" "" "Network UPS Tools (NUT)" +.TH NUTUPSDRV 8 "Wed Dec 31 2008" "" "Network UPS Tools (NUT)" .SH NAME nutupsdrv \- generic manual for unified NUT drivers .SH SYNOPSIS @@ -49,9 +49,9 @@ autoconfigure this driver using the \fIid\fR section of \fBups.conf\fR(5). Raise the debugging level. Use this multiple times to see more details. Running a driver in debug mode will prevent it from backgrounding after startup. It will keep on logging information to the console until it -receives a SIGTERM signal. +receives a SIGINT (usually Ctrl-C) or SIGTERM signal. -Which level of debugging is needed depends both on the driver and the +The level of debugging needed depends both on the driver and the problem you're trying to diagnose. Therefore, first explain the problem you have with a driver to a developer/maintainer, before sending them debugging output. More often than not, if you just pick a level, the output may be @@ -65,11 +65,11 @@ print only version information, then exit .IP \-L print parseable list of driver variables. Mostly useful for configuration -wizard and alike. +wizard programs. .IP \-k ("kill" power) Force shutdown mode. The UPS will power off the -attached load if possible. +attached load, if possible. You should use \fBupsdrvctl shutdown\fR whenever possible instead of calling this directly. @@ -134,17 +134,47 @@ information. \fBupsdrvctl\fR(8) .SS Drivers: -\fBapcsmart\fR(8), \fBbcmxcp\fR(8), \fBbcmxcp_usb\fR(8), -\fBbelkin\fR(8), \fBbelkinunv\fR(8), \fBbestfcom\fR(8), -\fBbestuferrups\fR(8), \fBbestups\fR(8), -\fBcyberpower\fR(8), \fBdummy-ups\fR(8), \fBetapro\fR(8), -\fBeverups\fR(8), \fBgamatronic\fR(8), \fBgenericups\fR(8), -\fBisbmex\fR(8), \fBliebert\fR(8), \fBmasterguard\fR(8), -\fBmegatec\fR(8), \fBmegatec_usb\fR(8), \fBmetasys\fR(8), \fBmge\(hyshut\fR(8), -\fBmge\(hyutalk\fR(8), \fBmge-xml\fR(8), \fBnitram\fR(8), \fBoneac\fR(8), -\fBoptiups\fR(8), \fBpowercom\fR(8), \fBpowerman-pdu\fR(8), \fBpowerpanel\fR(8), \fBrhino\fR(8), -\fBsafenet\fR(8), \fBsnmp\(hyups\fR(8), \fBsolis\fR(8), \fBtripplite\fR(8), -\fBtripplitesu\fR(8), \fBtripplite_usb\fR(8), \fBusbhid-ups\fR(8), \fBupscode2\fR(8), +\fBapcsmart\fR(8), +\fBbcmxcp\fR(8), +\fBbcmxcp_usb\fR(8), +\fBbelkin\fR(8), +\fBbelkinunv\fR(8), +\fBbestfcom\fR(8), +\fBbestuferrups\fR(8), +\fBbestups\fR(8), +\fBblazer\fR(8), +\fBcyberpower\fR(8), +\fBdummy\(hyups\fR(8), +\fBetapro\fR(8), +\fBeverups\fR(8), +\fBgamatronic\fR(8), +\fBgenericups\fR(8), +\fBisbmex\fR(8), +\fBliebert\fR(8), +\fBmasterguard\fR(8), +\fBmegatec\fR(8), +\fBmegatec_usb\fR(8), +\fBmetasys\fR(8), +\fBmge\(hyshut\fR(8), +\fBmge\(hyutalk\fR(8), +\fBmge\(hyxml\fR(8), +\fBnewmge\(hyshut\fR(8), +\fBnitram\fR(8), +\fBoneac\fR(8), +\fBoptiups\fR(8), +\fBpowercom\fR(8), +\fBpowerman\(hypdu\fR(8), +\fBpowerpanel\fR(8), +\fBrhino\fR(8), +\fBrichcomm_usb\fR(8), +\fBsafenet\fR(8), +\fBsnmp\(hyups\fR(8), +\fBsolis\fR(8), +\fBtripplite\fR(8), +\fBtripplitesu\fR(8), +\fBtripplite_usb\fR(8), +\fBusbhid\(hyups\fR(8), +\fBupscode2\fR(8), \fBvictronups\fR(8) .SS Internet resources: