nut/docs/man/nut.conf.5

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