'\" t
.\"     Title: macosx-ups
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 08/08/2012
.\"    Manual: NUT Manual
.\"    Source: Network UPS Tools
.\"  Language: English
.\"
.TH "MACOSX\-UPS" "8" "08/08/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"
macosx-ups \- monitor for Mac OS X built\-in UPS and battery driver
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the \fBmacosx\-ups\fR driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
\fBmacosx\-ups\fR supports any USB HID Power Device Class (PDC) UPS which is matched by the Mac OS X built\-in drivers\&. It also can monitor a laptop internal battery as though it were an UPS\&.
.sp
If the UPS is visible in the Energy Saver preferences pane of System Preferences, this driver should be able to monitor it\&.
.SH "EXTRA ARGUMENTS"
.PP
\fBport\fR=\fIregex\fR
.RS 4
The
\fBport\fR
parameter in the configuration file can be a case\-insensitive extended regular expression (see
\fBregex\fR(3) for details) to match against specific UPS and battery names\&.
.sp
The traditional NUT auto\-detection value of "auto" will be changed to "/UPS"\&. To test this driver against the internal battery of a laptop, a value such as "battery" can be used\&.
.RE
.PP
\fBmodel\fR=\fIregex\fR
.RS 4
Likewise, if you have more than one UPS, it may be necessary to specify a
\fBmodel\fR
name to match against\&. This parameter is also a case\-insensitive extended regular expression\&.
.RE
.SH "DIAGNOSTICS"
.sp
If the driver cannot find an UPS, first open System Preferences and see if there is an "UPS" tab on the Energy Saver panel\&. If so, re\-run the driver with the \fB\-D\fR flag to list the names of the power sources found\&.
.SH "KNOWN ISSUES AND BUGS"
.sp
This driver is a monitoring\-only driver, and cannot shut down an UPS on its own\&. However, this should not be a problem in practice: it is monitoring the built\-in Mac OS X UPS driver, which has configuration options for several shutdown scenarios\&. Consult the Energy Saver control panel or \fBpmset\fR(8) for more information\&.
.sp
The default distribution of \fBapcupsd\fR installs a kernel extension which prevents Mac OS X from attaching to the UPS\&. In order to use this driver after installing apcupsd, you must first run the apcupsd\-uninstall script and reboot\&.
.sp
Note that other UPS monitoring solutions may show more detail than what is provided by the built\-in Mac OS X driver\&. In particular, voltages other than the battery voltage, as well as current and frequency, are typically not shown\&. It may be possible to monitor these values with \fBapcupsd\fR (for APC hardware only) or \fBusbhid-ups\fR(8)\&.
.SH "AUTHORS"
.sp
Charles Lepple <clepple+nut at gmail\&.com>
.SH "SEE ALSO"
.sp
\fBusbhid-ups\fR(8), \fBpmset\fR(8), \fBregex\fR(3)
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/
.sp
The apcupsd home page: http://www\&.apcupsd\&.org/