Imported Upstream version 2.7.1

docs/man/al175.8

@@ -0,0 +1,187 @@
+'\" t
+.\"     Title: al175
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 11/20/2013
+.\"    Manual: NUT Manual
+.\"    Source: Network UPS Tools 2.7.1
+.\"  Language: English
+.\"
+.TH "AL175" "8" "11/20/2013" "Network UPS Tools 2\&.7\&.1" "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"
+al175 \- Driver for Eltek UPS models with AL175 alarm module
+.SH "NOTE"
+.sp
+This man page only documents the hardware\-specific features of the \fBal175\fR driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
+.SH "SUPPORTED HARDWARE"
+.sp
+The \fBal175\fR driver is known to work with the following UPSes:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Eltek MPSU4000 with AL175 alarm module
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+It may also work with other UPSes equiped with AL175 alarm module, but they have not been tested\&.
+.sp
+AL175 have to be configured to operate in COMLI mode\&. See documentation supplied with your hardware on how to do it\&.
+.SH "EXTRA ARGUMENTS"
+.sp
+This driver does not support any extra settings in the \fBups.conf\fR(5)\&.
+.SH "INSTANT COMMANDS"
+.sp
+This driver supports some extra commands (see \fBupscmd\fR(8)):
+.PP
+\fBtest\&.battery\&.start\fR
+.RS 4
+Start a battery test\&.
+.RE
+.PP
+\fBtest\&.battery\&.stop\fR
+.RS 4
+Stop a battery test\&.
+.RE
+.SH "VARIABLES"
+.sp
+Besides status, this driver reads UPS state into following variables:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+
+\fBups\&.test\&.result\fR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+
+\fBoutput\&.voltage\&.nominal\fR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+
+\fBoutput\&.current\fR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+
+\fBbattery\&.voltage\&.nominal\fR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+
+\fBbattery\&.current\fR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+
+\fBbattery\&.temperature\fR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+
+\fBinput\&.transfer\&.boost\&.low\fR
+.RE
+.SH "KNOWN ISSUES AND BUGS"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Shutdown is not supported\&. FIXME
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+The driver was reworked to meet the project code quality criteria, without testing on real hardware\&. Some bugs may have crept in\&.
+.RE
+.SH "AUTHOR"
+.sp
+Kirill Smelkov <kirr@mns\&.spb\&.ru>
+.SH "SEE ALSO"
+.SS "The core driver:"
+.sp
+\fBnutupsdrv\fR(8)
+.SS "Internet resources:"
+.sp
+The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/