~ubuntu-branches/ubuntu/saucy/nut/saucy

« back to all changes in this revision

Viewing changes to man/belkinunv.8

  • Committer: Chuck Short
  • Date: 2013-05-13 12:57:25 UTC
  • Revision ID: zulcss@ubuntu.com-20130513125725-llq8wsohyhq9idsy
* Merge from Debian.  Remaining changes:
  - debian/control:
    + remove Build-Depends on libpowerman0-dev
    + remove nut-powerman-pdu
  - debian/nut-powerman-pdu.{install,manpages}: dropped for now
  - debian/{nut-cgi,nut-server}.postinst: add nut to the dialout and nut
    groups unconditonally to handle the upgrade from hardy release.
  - debian/source_nut.py, debian/{nut,nut-server,nut-client}.install,
    debian/rules: Install apport hooks for all top-level nut packages.
  - debian/rules: Use udev version for Ubuntu
  - debian/series, debian/patches/backport-fix-lp753661.patch: re-enabled
* Non-maintainer upload with fixes for wheezy.
* debian/nut-client.preinst: also revert /etc/nut/nut.conf mangling done
  by postinst during upgrade from lenny to squeeze (Really closes: #677054)
  Thanks to Andreas Beckmann for the review.
* Merge from Debian.  Remaining changes:
  - debian/control:
    + remove Build-Depends on libpowerman0-dev
    + remove nut-powerman-pdu
  - debian/nut-powerman-pdu.{install,manpages}: dropped for now
  - debian/{nut-cgi,nut-server}.postinst: add nut to the dialout and nut
    groups unconditonally to handle the upgrade from hardy release.
  - debian/source_nut.py, debian/{nut,nut-server,nut-client}.install,
    debian/rules: Install apport hooks for all top-level nut packages.
  - debian/rules: Use udev version for Ubuntu
  - debian/series, debian/patches/backport-fix-lp753661.patch: re-enabled
* Dropped the following patches, no longer required:
  - debian/patches/CVE-2012-2944.patch (included upstream)
* Non-maintainer upload with fixes for wheezy.
* Only remove /etc/init.d/nut from previous versions of nut in nut-server
  postinst if there are no local changes.
* Also remove /etc/init.d/nut in nut-client postinst. Thanks to 
  Laurent Bigonville for the hint.
* Only fix permissions of configfiles on first install.
* debian/control: Fix typo in package description. Thanks to Julien Cristau
  for spotting this.
* Non-maintainer upload.
* debian/nut-client.preinst: revert /etc/nut/nut.conf mangling done by older
  versions of the postinst (Closes: #677054)
* debian/rules: Stop the nut-client before nut-server on systems using
  static
  boot ordering (Closes: #679451)
* debian/nut-server.postinst: Remove /etc/init.d/nut on upgrade
  (Closes: #677822)
* Rename nut-server.lintian-overrides to nut-client.lintian-overrides and
  adjust overrides now that ups-monitor is shipped in nut-client package
  (Closes: #677947)
* Add debian/patches/0001-fix-upsmon-regression.patch: Fix upsmon/upssched
  regression (Taken from upstream) (Closes: #679513)
* Move nut metapackage to Section: metapackages
* Also create nut user when installing nut-client package and do not delete
  it on purge anymore (Closes: #682000)
* Drop /etc/default/nut → /etc/nut/nut.conf migration code, migration
  happends before squeeze release and this was against policy to have a
  maintainer script modifying a conffile in the first place (Closes: #684392)
* Add dependency against adduser and lsb-base on nut-client package
* Be sure that client is stopped before the server also when using
  dependencies based boot
* Fix package descriptions (Closes: #678068)
* Also install /bin/upssched-cmd in nut-client package as this script is
  referenced in default upssched.conf config file
* debian/watch: Update watch file
* Be sure that all maintainer scripts are returning 0 at their end
* New upstream release (Closes: #671444)
* acknowledges NMU (Closes: #613643)
* debian/nut-client.init: fix action "start" and use of log_*_*msg
  LSB log functions (Closes: #675619)
* debian/nut-server.preinst: remove obsolete file(s) left in
  /etc/udev/rules.d and related processing: udev files are now located
  in /lib/udev/rules, and there is no reason to modify the dedicated
  USB UPS rules (52-nut-usbups.rules) (Closes: #660072)
* debian/nut-server.init: rewrite to match upsd / drivers startup scope
* debian/nut-client.init: created to match upsmon startup scope
  (Closes: #634858)
* debian/nut.TODO.Debian, debian/Makefile.am: updated to reflect the above
* debian/rules: install nut-client.init, and update to reflect the above
* debian/control, debian/Makefile.am: updated to reflect the above
* debian/control:
  - add Breaks on nut-server (<< 2.6.3-1~)
  - bump Standards-Version to 3.9.3
* debian/nut-client.links: renamed from debian/nut-server.links, since
  ups-monitor is now provided by nut-client initscript
* debian/nut.README.Debian: renamed from nut-server.README.Debian,
  to provide it with both client and server packages
* debian/nut-server.install: add missing drivers (clone-outlet,
  liebert-esp2 and microdowell)
* debian/nut-server.manpages: add missing manual pages (apcsmart-old,
  ivtscd, liebert-esp2 and microdowell)
* SECURITY UPDATE: remote denial of service
 - debian/CVE-2012-2944.patch: limit the set of parsed characters to ' '
   through '~'
 - CVE-2012-2944
* Merge from Debian testing.  Remaining changes:
  - debian/control: Drop Build-Depends on libpowerman0-dev (currently in 
    universe)
  - debian/{nut-cgi,nut-server}.postinst: add nut to the dialout and nut 
    groups unconditonally to handle the upgrade from hardy release.
  - debian/nut-powerman-pdu.{install,manpages}: dropped for now.
  - debian/source_nut.py, debian/{nut,nut-server,nut-client}.install, 
    debian/rules: Install apport hooks for all top-level nut packages.
  - debian/rules: Use udev version for Ubuntu.
  - debian/series, debian/patches/backport-fix-lp753661.patch: re-enabled.
* New upstream release (Closes: #635186, #598741, #633756, #638221)
* debian/nut-server.{install,manpages}: add richcomm_usb
* debian/nut-server.install, debian/rules: install Avahi service file
* debian/rules, nut-client.install: install Augeas lenses
* debian/nut-server.README.Debian: clarify udev explanation (Closes: #529664)
* debian/patches/0001-fix_spelling_and_typo.patch,
  debian/patches/0003-libupsclient-version.patch: removed since these are now
  fixed upstream
* debian/patches/series: updated
* Merge from debian unstable.  Remaining changes:
  - debian/control: Drop Build-Depends on libpowerman0-dev (currently in 
    universe)
  - debian/{nut-cgi,nut-server}.postinst: add nut to the dialout and nut 
    groups unconditonally to handle the upgrade from hardy release.
  - debian/nut-powerman-pdu.{install,manpages}: dropped for now.
  - debian/source_nut.py, debian/{nut,nut-server,nut-client}.install, 
    debian/rules: Install apport hooks for all top-level nut packages.
  - debian/rules: Use udev version for Ubuntu.
  - debian/series, debian/patches/backport-fix-lp753661.patch: re-enabled.
* New upstream release (Closes: #594989)
* debian/control:
  - remove legacy Build-Depends for nut-hal-drivers on libdbus and libglib
  - Build-Depends-Indep on docbook-xsl for offline document
    generation (Closes: #635347)
* debian/nut-server.install: add apcsmart-old
* debian/nut-server.init:
  - add udev as Required-Start/Stop (Closes: #642412)
  - remove legacy support for /etc/default/nut (Closes: #638021)
* debian/patches/0003-libupsclient-version.patch: added to fix the missing
  libupsclient version info bump
* debian/libupsclient1-dev.links: update link name
* debian/libupsclient1.symbols: add with upscli_tryconnect
* debian/nut.TODO.Debian: update and complete the TODO list
* Fix FTBFS for Ubuntu (LP: #815760):
  - debian/control: Build-Depends-Indep on docbook-xsl for offline 
    document generation.
* Merge from Debian unstable (LP: #811976). Remaining changes:
  - debian/control: Drop Build-Depends on libpowerman0-dev (currently in 
    universe)
  - debian/{nut-cgi,nut-server}.postinst: add nut to the dialout and nut 
    groups unconditonally to handle the upgrade from hardy release.
  - debian/nut-powerman-pdu.{install,manpages}: dropped for now.
  - debian/source_nut.py, debian/{nut,nut-server,nut-client}.install, 
    debian/rules: Install apport hooks for all top-level nut packages.
  - debian/rules: Use udev version for Ubuntu.
  - debian/series, debian/patches/backport-fix-lp753661.patch: re-enabled.
* debian/nut.README.Debian: Adjust udev rules naming for permissions override
  (Closes: #529664)
* Re-add and refresh debian/patches/0001-fix_spelling_and_typo.patch:
  Some typos and spelling errors remain.
* Split nut package into nut-client and nut-server, keep nut package as
  metapackage
* Generate PDF and html doc and install it in nut-doc package
* debian/rules:
  - List non-installed files
  - Includes python-module.mk
  - Add flags to build documentation and install it
* debian/control:
  - Add python-nut package and add python build-dependency
  - Set nut-powerman-pdu priority to extras
  - Add nut-monitor package
  - Add nut-doc package and add required C/R/P
  - Add libups-nut-perl package
* debian/nut-server.prerm: Remove /var/run/nut during removal
* Merge from debian unstable.  Remaining changes:
  - debian/control:
    + Drop Build-Depends on libpowerman0-dev (currently in universe)
  - debian/{nut-cgi,nut}.postinst: add nut to the dialout and nut groups
    unconditonally to handle the upgrade from hardy release.
  - debian/nut-powerman-pdu.{install,manpages}: dropped for now.
  - debian/source_nut.py, debian/nut.install, debian/rules: Install apport hook.
  - debian/rules: Use udev version for Ubuntu.
* debian/patches/backport-fix-lp753661.patch: Refreshed.
* Drop changes due to .pc being not clean.
* New upstream release (Closes: #595953, #614842, #595773)
* debian/patches/*.patch: removed since these are now fixed upstream
* Drop HAL package and build-dependencies (Closes: #613197)
* debian/control:
  - Bump Standards-Version to 3.9.2 (no further changes)
  - Drop autotools build-dependencies (not needed anymore)
  - Drop non-existing build-dependencies
* debian/rules:
  - Correctly pass flags to configure
* Merge from debian unstable (LP: #789323).  Remaining changes:
  + debian/control:
    - Update maintainer as per spec.
    - Add Breaks on nut-hal-drivers to ensure we have correct udev version.
    - Drop libpowerman0-dev from the Build-Depends (currently in universe)
  + debian/{nut-cgi,nut}.postinst: add nut to the dialout and nut groups
    unconditonally to handle the upgrade from hardy release.
  + debian/nut-powerman-pdu.install, debian/nut-powerman-pdu.manpages: dropped for now.
  + debian/nul-hal-drivers.{docs,install,postinst,preinst}: Dropped since hal is in universe now
  + debian/nut.links: must create the init script link, used if the upse needs to be powered down
    (LP: #357583)
  + debian/source_nut.py, debian/nut.install, debian/rules: Install apport hook.
  + debian/patches/backport-fix-lp753661.patch
  + Dropped:
    - debian/patches/fix_pc_file.patch: replaced by debian's 0002-fix_libupsclient_pc.patch
* debian/patches/fix_pc_file.patch: add DEP3 patch header
* debian/patches/debian-changes-2.6.0-1: remove that accidental file
* debian/nut-snmp.docs: Distribute snmp.txt doc file (Closes: #548295)
* d/p/0001-fix_spelling_and_typo.patch: Update and refresh
* debian/nut.lintian-overrides: Fix typo
* debian/patch/0002-fix_libupsclient_pc.patch: Fix libupsclient.pc (Closes:
  #624255)
* debian/rules:
  - Switch to cdbs
  - Remove not existing configure options (Closes: #611813)
  - Drop Phony rules (Closes: #613699)
* debian/control:
  - Add cdbs build-dependency
* debian/patches/backport-fix-lp753661.patch: Backport fix 
  to trim extraneous end-of-line, in buggy HID string tables, 
  which results in upsc breaking the communication pipe.
  (LP: #753661)
* fix_pc_file.patch: fix .pc source files by using LIBSSL_LIBS instead of
  LIBSSL_LDFLAGS to avoid a FTBFS in packages that uses libupsclient.pc
  (LP: #743484)
* Merge from Debian unstable, remaining changes:
  + debian/control:
    - Update maintainer as per spec.
    - Add Breaks on nut-hal-drivers to ensure we have correct udev version.
    - Drop libpowerman0-dev from the Build-Depends (currently in universe)
  + debian/{nut-cgi,nut}.postinst: add nut to the dialout and nut groups
    unconditonally to hanle the upgrade from hardy release.
  + debian/nut-powerman-pdu.install, debian/nut-powerman-pdu.manpages: dropped for now.
  + debian/nul-hal-drivers.{docs,install,postinst,preinst}: Dropped since hal is in universe now
  + debian/nut.links: must create the init script link, used if the upse needs to be powered down
    (LP: #357583)
  + debian/source_nut.py, debian/nut.install, debian/rules: Install apport hook.
  + Dropped:
    - debian/patches/0002-fix_udev_action.patch: Accepted upstream.
    - debian/patches/0004-netvision-improvements-lp-600950: no longer needed.
    - debian/patches/0005-fix-nut-m4.patch: no longer needed.
    - debian/patches/9999-autoconf.patch: no longer needed.
* New upstream release (Closes: #575176, #588648, #609597, #687985)
* debian/patches/*.patch: removed since these are now fixed upstream
* debian/patches/0001-fix_spelling_and_typo.patch,
  debian/patches/series: reworked to match the new upstream release
* debian/nut.install, debian/nut.manpages: remove obsolete reference to
  megatec and megatec_usb, now respectively replaced by blazer_ser and
  blazer_usb
* debian/nut.docs: limit distributed documentation
* debian/control:
  - Wrap build-dependencies
  - Change nut-cgi Recommends to apache2 | httpd-cgi
* debian/nut.postinst: Only trigger USB subsystem, should Closes: #574769
* debian/patches/0002-fix_udev_action.patch: Use SUBSYSTEM instead of BUS
* debian/control, debian/rules, 
  debian/nut-hal-drivers.{docs,install,postinst,preinst}: Drop
  nut-hal-drivers since Nut doesnt go into universe.
* Split patches/debian-changes-2.4.3-2ubuntu1 into
  patches/0005-fix-nut-m4.patch and patches/9999-autoconf.patch
* Readd lost debian/patches0004-netvision-improvements-lp-600950.patch patch
  (LP: #707050)
* debian/patches/0002-fix_udev_action.patch:
  Change BUS to SUBSYSTEMS, since the former is deprecated. (LP: #692171)
* debian/nut.postinst: Uncomment missing call to adduser
* debian/control: Drop hal build dependency, we don't need the daemon to
  build the package. Add a hal dependency to nut-hal-drivers, which is the
  only thing that actually needs it.
* Merge from debian unstable.  Remaining changes:
  + debian/control:
    - Update maintainer as per spec.
    - Add Breaks on nut-hal-drivers to ensure we have correct udev version.
    - Drop libpowerman0-dev from the Build-Depends (currently in universe)
  + debian/{nut-cgi,nut}.postinst: add nut to the dialout and nut groups
    unconditonally to hanle the upgrade from hardy release.
  + debian/nut-powerman-pdu.install, debian/nut-powerman-pdu.manpages: dropped for now.
  + debian/nut.links: must create the init script link, used if the upse needs to be powered down
    (LP: #357583)
  + debian/nut.postinst: Update udevadm trigger.
    "libusb_get_report: error sending control message: 
     Operation not permitted" error on some UPS devices. (LP: #572262)
  + debian/source_nut.py, debian/nut.install, debian/rules: Install apport hook.
  + debian/patches/netvision-improvements-lp-600950.patch: Add improvements
    for netvision UPSes
  + Fix FTBFS with ld --as-needed.
  + Dropped:
    - debian/patches/03_udev_rules_change.dpatch: Use debian's instead.
    - debian/patches/04_nut_small-buffers.dpatch: Use debian's instead.
* debian/control:
  - Bump Standards-Version to 3.9.1
  - Update Vcs-* fields to new GIT repository
  - Add myself as Uploaders
* Switch to dpkg-source 3.0 (quilt) format (Closes: #573601)
* debian/patches/0001-low_speed_usb_ups.patch: Use patch system for changes
  that were applied directly in the source
* Add debian/gbp.conf file
* debian/watch: Bump version to 3
* Add debian/patches/0002-fix_udev_action.patch: Also set permission for
  "change" udev ACTION (Closes: #557178)
* debian/nut.postrm: Do not try to remove nut user is deluser is not
  installed anymore
* debian/nut.manpages: Install manpage nut.conf.5 (Closes: #528222)
* debian/copyright: Fix copyright-with-old-dh-make-debian-copyright
* Remove nut-snmp.lintian-overrides, not needed anymore
* debian/patches/0003-fix_spelling_and_typo.patch: Fix some spelling errors
* Add debian/libupsclient1.symbols file
* Add debian/nut.links: Re-add /etc/init.d/ups-monitor that was lost for
  some reasons (Closes: #592351)
* debian/nut.lintian-overrides: Add override for
  init.d-script-does-not-provide-itself /etc/init.d/ups-monitor
* Drop libupsclient1.post{inst,rm}: ldconfig call is added automatically by
  debhelper
* debian/libupsclient1-dev.install: Do not ship /lib/libupsclient.la anymore
* debian/rules: Remove dpatch logic as we are using package source version
  '3.0 (quilt)'
* debian/compat: Bump debhelper compatibility to 8
* Non-maintainer upload.
* drivers/libhid.c: Apply r2407 from upstream to fix bug with some
  low speed UPS devices. (Closes: #583371)
* Fix FTBFS with ld --as-needed.
* debian/patches/netvision-improvements-lp-600950.patch: Add improvements for netvision UPSes 
  (LP: #600950) 
* debian/source_nut.py, debian/nut.install, debian/rules: Install apport hook. 
* debian/patches/04_nut-small-buffers.dpatch: Fix "libusb_get_report: error sending control message: 
  Operation not permitted" error on some UPS devices. (LP: #572262)
* debian/nut.postinst: Revert dropping of --action=change. "add" events must
  not ever be triggered automatically.
* Add 03_udev_rules_change.dpatch: Run udev rules on change events, too.
* debian/control: grr...fix ftbfs. 
* Merge from debian testing.  Remaining changes (LP: #535152):
  + debian/control:
    - Update maintainer as per spec.
    - Add Breaks on nut-hal-drivers to ensure we have correct udev version.
    - Drop libpowerman0-dev from the Build-Depends (currently in universe)
  + debian/{nut-cgi,nut}.postinst: add nut to the dialout and nut groups
    unconditonally to hanle the upgrade from hardy release.
  + debian/nut-powerman-pdu.install, debian/nut-powerman-pdu.manpages: dropped for now.
  + debian/nut.links: must create the init script link, used if the upse needs to be powered down
    (LP: #357583)
  + debian/nut.postinst: Update udevadm trigger.
  + Dropped:
    - debian/patches/02-fix-trust-pw4130m.dpatch: No longer needed.
* New upstream release (Closes: #544390, #528222, #539747, #526811,
  #562064)
* debian/nut.install, debian/nut.manpages:
  - remove cyberpower driver and manpage
  - add bestfortress, clone and ivtscd drivers and manpages
* debian/rules:
  - change udev dir to /lib/udev (Closes: #522327)
  - replace deprecated calls to 'dh_clean -k' by dh_prep (Closes: #536599)
* debian/rules, debian/nut.install, debian/nut.install,
  debian/nut.README.Debian: install configuration files, without the
  sample suffix (Closes: #528641)
* debian/nut.links: restored (Closes: #522506)
* debian/nut.init:
  - source nut.conf instead of default/nut for POWEROFF_WAIT(Closes:
    #538173)
  - fix status checking (Closes: #538785)
  - improve detection of non configured system and beautify related
    output (Closes: #563112)
  - use 'invoke-rc.d' instead of calling the reboot script directly
  - add $remote_fs to Required-Start and Required-Stop
* debian/nut.postrm: remove udev files and simplify cleanup (Closes:
  #541629)
* debian/control:
  - remove Luca Filipozzi from the Uploaders list (Closes: #568987)
  - update Standards-Version to 3.8.4
  - remove the debconf dependency
  - bump debhelper version to (>= 7) in Build-Depends, for dh_prep
  - add Breaks on nut-hal-drivers to ensure we have correct udev version
* Remove debconf support since it was related to really old nut
  version (Closes: #518056):
  - remove nut-cgi.config, nut.config, nut-cgi.templates, nut.templates,
    and po/ directory
  - update nut-cgi.postinst
* debian/nut.dirs: remove /var/run/nut to conform to Debian Policy
* debian/nut.postint:
  - create /var/run/nut if needed
  - improve security checks
* debian/nut.README.Debian: add a security note for ups.conf
* debian/watch: URL update
* debian/patches/02-fix-trust-pw4130m.dpatch: Fix issues with Trust
  PW-4130M UPS. (LP: #447586) 

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH BELKINUNV 8 "Sun Dec 7 2003" "" "Network UPS Tools (NUT)" 
2
 
.SH NAME  
3
 
belkinunv \- Driver for Belkin "Universal UPS" and compatible
4
 
.SH NOTE
5
 
This man page only documents the hardware\(hyspecific features of the
6
 
belkin driver.  For information about the core driver, see  
7
 
\fBnutupsdrv\fP(8).
8
 
 
9
 
.SH SUPPORTED HARDWARE
10
 
The belkinunv driver is known to work with the Belkin Universal UPS
11
 
models F6C800\(hyUNV and F6C120\(hyUNV, and is expected to work with other
12
 
Belkin Universal UPS models. The driver only supports serial
13
 
communication, not USB.
14
 
 
15
 
The Trust UPS and older Belkin units are not supported by this driver,
16
 
and neither are the Belkin Home Office models (F6H500\(hySER and so
17
 
forth). However, some Belkin models, such as the Regulator Pro, are
18
 
supported by the \fBbelkin\fP(8) driver, and the Home Office models
19
 
are supported using the \fBgenericups\fP(8) driver with
20
 
\fIupstype=7\fP.
21
 
 
22
 
.SH SOFT SHUTDOWN WORKAROUND
23
 
One problem with the Belkin Universal UPS is that it cannot enter a
24
 
soft shutdown (shut down the load until AC power returns) unless the
25
 
batteries are completely depleted. Thus, one cannot just shut off the
26
 
UPS after operating system shutdown; it will not come back on when the
27
 
power comes back on. Therefore, the belkinunv driver should never be
28
 
used with the \fB\-k\fP option. Instead, the \fB\-x wait\fP option is
29
 
provided as a workaround.
30
 
 
31
 
When called with the \fB\-x wait\fP option, \fBbelkinunv\fP behaves as
32
 
a standalone program (i.e., it does not fork into the background). It
33
 
performs one simple task: it connects to the UPS, waits for AC power
34
 
to return, and then exits with status 0.
35
 
 
36
 
This is meant to be used in a shutdown script as follows: during a
37
 
shutdown, after all filesystems have been remounted read\(hyonly, and
38
 
just before the system would normally be halted: check /etc/killpower
39
 
(or similar) to see if this shutdown was caused by \fBupsmon\fP(8),
40
 
and if yes, call \fBbelkinunv \-x wait\fP. If AC power comes back on,
41
 
\fBbelkinunv\fP exits, and things should be arranged so that the
42
 
system reboots in this case. If AC power does not come back on, the
43
 
UPS will eventually run out of batteries, kill the computer's power
44
 
supply, and go into soft shutdown mode, which means everything will
45
 
reboot properly when the power returns. In either case, a deadlock is
46
 
avoided. 
47
 
 
48
 
In addition, if an optional integer argument is given to the \fB\-x
49
 
wait\fP option, this causes \fBbelkinunv\fP to wait not only for AC
50
 
power to be present, but also for the battery charge to reach the
51
 
given level. I use this as part of my startup scripts, to ensure that
52
 
the batteries are sufficiently charged before the computer continues
53
 
booting. This should be put very early in the startup script, before
54
 
any filesystems are mounted read/write, and before any filesystem
55
 
checks are performed.
56
 
 
57
 
Several other \fB\-x\fP options are provided to fine\(hytune this
58
 
behavior. See OPTIONS below for detailed descriptions.  See EXAMPLES
59
 
below for examples of how to use \fBbelkinunv\fP in shutdown and
60
 
startup scripts.
61
 
 
62
 
.SH OPTIONS
63
 
See also \fBnutupsdrv\fP(8) for generic options. Never use the
64
 
\fB\-k\fP option with this driver; it does not work properly.
65
 
.TP 12
66
 
.B \-x wait[=\fIlevel\fP]
67
 
When this option is used, \fBbelkinunv\fP does not fork into the
68
 
background, but behaves as a standalone program. It connects to the UPS and
69
 
waits until AC power is present. If \fIlevel\fP is specified, it also
70
 
waits until the battery charge reaches at least the given level in
71
 
percent. Then, and only then, \fBbelkinunv\fP exits. In addition,
72
 
while \fBbelkinunv\fP runs in this mode, it displays a status line
73
 
with information on the UPS status and battery level. This is intended
74
 
for use in the computer's shutdown and startup scripts, as described
75
 
under SOFT SHUTDOWN WORKAROUND above.
76
 
.TP
77
 
.B \-x nohang
78
 
This option only has an effect when used in conjunction with the \fB\-x
79
 
wait\fP option. It causes \fBbelkinunv\fP to exit if a connection with
80
 
the UPS cannot be established or is lost, instead of retrying forever,
81
 
which is the default behavior. The \fB\-x nohang\fP option should be
82
 
used in a startup
83
 
script, to ensure the computer remains bootable even if the UPS has
84
 
been disconnected during the power failure (for instance, you attached
85
 
your computer to a generator, carried it to a neighbor's house, or
86
 
whatever). 
87
 
.TP 
88
 
.B \-x flash
89
 
This option only has an effect when used in conjunction with the \fB\-x
90
 
wait\fP option. It causes the UPS load to be shut off for a short time
91
 
("flashed") just after the AC power has returned and the requested
92
 
battery level (if any) has been attained. This is useful if slaves are
93
 
attached to this UPS; the flash will cause all of them to reboot. Note
94
 
that, due to the design of the Belkin UPS hardware, the load shutdown lasts
95
 
ca. 1\(hy2 minutes; a shorter flash cannot be performed reliably.  Also,
96
 
the computers will reboot at the scheduled time, on battery power if
97
 
necessary, even if AC power fails again in the meantime. This should
98
 
not be a problem, as your startup scripts can catch this situation.
99
 
.TP
100
 
.B \-x silent
101
 
This option only has an effect when used in conjunction with the \fB\-x
102
 
wait\fP option. It suppresses the status line which \fBbelkinunv\fP
103
 
would normally print.
104
 
.TP
105
 
.B \-x dumbterm
106
 
This option only has an effect when used in conjunction with the \fB\-x
107
 
wait\fP option. It changes the way in which \fBbelkinunv\fP prints its
108
 
status line. Normally, terminal control sequences are used to
109
 
overwrite the same line with new status information, each time the
110
 
status is updated. This may not work on all terminals. If the \fB\-x
111
 
dumbterm\fP option is given, each status update is written on a new
112
 
line.
113
 
.PD
114
 
 
115
 
.SH VARIABLES:
116
 
.TP 12
117
 
.B battery.charge
118
 
.TP
119
 
.B battery.runtime
120
 
not supported by all hardware.
121
 
.TP
122
 
.B battery.voltage
123
 
.TP
124
 
.B battery.voltage.nominal
125
 
.TP
126
 
.B driver.version.internal
127
 
.TP
128
 
.B input.frequency
129
 
.TP
130
 
.B input.frequency.nominal
131
 
e.g. 60 for 60Hz
132
 
.TP
133
 
.B input.sensitivity             
134
 
writable: normal/medium/low
135
 
.TP
136
 
.B input.transfer.high
137
 
writable: high transfer voltage point in V
138
 
.TP
139
 
.B input.transfer.low
140
 
writable: low transfer voltage point in V
141
 
.TP
142
 
.B input.voltage
143
 
.TP
144
 
.B input.voltage.maximum
145
 
.TP
146
 
.B input.voltage.minimum
147
 
.TP
148
 
.B input.voltage.nominal
149
 
.TP
150
 
.B output.frequency
151
 
.TP
152
 
.B output.voltage
153
 
.TP
154
 
.B ups.beeper.status
155
 
writable. Values: enabled/disabled/muted. This variable controls the
156
 
state of the panel beeper. Enabled means sound when the alarm is
157
 
present, disabled means never sound, and muted means the sound is
158
 
temporarily disabled until the alarm would normally stop sounding. In
159
 
the muted state, the beeper is automatically turned back on at the
160
 
next event (AC failure, battery test, etc). Also, the beeper can't be
161
 
turned off during a critical event (low battery). Note that not all
162
 
UPS models support the "disabled" state.
163
 
.TP
164
 
.B ups.firmware
165
 
.TP
166
 
.B ups.load
167
 
.TP
168
 
.B ups.model
169
 
.TP
170
 
.B ups.power.nominal
171
 
e.g. 800 for an 800VA system
172
 
.TP
173
 
.B ups.status
174
 
a list of flags; see STATUS FLAGS below.
175
 
.TP
176
 
.B ups.temperature
177
 
not supported by all hardware.
178
 
.TP
179
 
.B ups.test.result
180
 
.TP
181
 
.B ups.delay.restart
182
 
time to restart (read only)
183
 
.TP
184
 
.B ups.delay.shutdown
185
 
time to shutdown (read only). This is always a multiple of 60 seconds.
186
 
.TP
187
 
.B ups.type
188
 
ONLINE/OFFLINE/LINEINT. This describes the basic layout of this UPS
189
 
(for GUI clients which want to draw an animated picture of power
190
 
flow). An offline UPS has a direct connection from AC input to AC
191
 
output, and also a connection from AC input to the battery, and from
192
 
the battery to AC output. An online UPS lacks the direct connection
193
 
from AC input to AC output, whereas a line interactive UPS lacks the
194
 
connection from AC input to the battery.
195
 
.PD
196
 
 
197
 
.SH COMMANDS:
198
 
.TP 12
199
 
.B beeper.enable, beeper.disable, beeper.mute
200
 
enable, disable or mute the panel beeper. Note that if the beeper is
201
 
muted, it is automatically turned back on at the next event (AC failure,
202
 
battery test, etc). Also, the beeper can't be turned muted during a
203
 
critical event (low battery).
204
 
.TP
205
 
.B reset.input.minmax
206
 
reset the variables \fBinput.voltage.minimum\fP and
207
 
\fBinput.voltage.maximum\fP. 
208
 
.TP
209
 
.B shutdown.reboot
210
 
shut down load immediately for ca. 1\(hy2 minutes
211
 
.TP
212
 
.B shutdown.reboot.graceful
213
 
after 40 second delay, shut down load for ca. 1\(hy2 minutes
214
 
.TP
215
 
.B shutdown.stayoff
216
 
shut down load immediately and stay off. The only way it can be turned
217
 
back on is by manually pressing the front panel button.
218
 
.TP
219
 
.B test.battery.start, test.battery.stop
220
 
start/stop 10 second battery test
221
 
.TP
222
 
.B test.failure.start, test.failure.stop
223
 
start/stop "deep" battery test
224
 
.PD
225
 
 
226
 
.SH STATUS FLAGS:
227
 
.TP 12
228
 
.B OB
229
 
load is on battery, including during tests
230
 
.TP
231
 
.B OFF
232
 
load is off
233
 
.TP
234
 
.B OL
235
 
load is online
236
 
.TP
237
 
.B ACFAIL
238
 
AC failure. Note that this refers to the AC input, and thus it is not
239
 
the same as "OB". An AC failure can occur at any time, for instance,
240
 
during a battery test, or when the UPS load is off. 
241
 
.TP
242
 
.B OVER
243
 
overload
244
 
.TP
245
 
.B OVERHEAT
246
 
overheat
247
 
.TP
248
 
.B COMMFAULT
249
 
UPS fault
250
 
.TP
251
 
.B LB
252
 
low battery
253
 
.TP
254
 
.B CHRG
255
 
charging
256
 
.TP
257
 
.B DEPLETED
258
 
the battery is depleted. When the UPS raises this flag, it
259
 
simultaneously switches off the load. 
260
 
.TP
261
 
.B RB
262
 
replace battery
263
 
.PD
264
 
.SH EXAMPLES
265
 
 
266
 
Here is an example for how \fBbelkinunv\fP should be used in a
267
 
computer's shutdown script. These commands should go in the very last
268
 
part of the shutdown script, after all file systems have been mounted
269
 
read\(hyonly, and just before the computer halts. Note that
270
 
\fBbelkinunv\fP must be installed in a directory which is still
271
 
readable at that point.
272
 
 
273
 
.nf
274
 
# NEAR END OF SHUTDOWN SCRIPT:
275
 
# if shutdown was caused by UPS, perform Belkin UPS workaround.
276
 
if [ \-f /etc/killpower ] ; then
277
 
    echo "Waiting for AC power, or for UPS batteries to run out..."
278
 
    /usr/bin/belkinunv \-x wait /dev/ttyS1
279
 
 
280
 
    # we get here if the power came back on. Reboot.
281
 
    echo "Power is back. Rebooting..."
282
 
    reboot
283
 
fi
284
 
.fi
285
 
 
286
 
And here is an example of how to use \fBbelkinunv\fP in the startup
287
 
script. These commands should go near the beginning of the startup
288
 
script, before any file systems are mounted read/write, and before any
289
 
file system integrity checks are done.
290
 
 
291
 
.nf
292
 
# NEAR BEGINNING OF STARTUP SCRIPT:
293
 
# if we are recovering from a power failure, wait for the UPS to
294
 
# charge to a comfortable level before writing anything to disk
295
 
if [ \-f /etc/killpower ] ; then
296
 
    echo "Waiting for UPS battery charge to reach 60%..."
297
 
    /usr/bin/belkinunv \-x wait=60 \-x nohang /dev/ttyS1
298
 
fi
299
 
.fi
300
 
.SH EXIT STATUS
301
 
 
302
 
When used normally, \fBbelkinunv\fP forks into the background and its
303
 
diagnostics are the same as for all NUT drivers, see
304
 
\fBnutupsdrv\fP(8).
305
 
 
306
 
When used with the \fB\-x wait\fP option, the exit status is normally
307
 
0. If the \fB\-x nohang\fP option has also been specified, an exit
308
 
status of 1 indicates that communication with the UPS was lost. If the
309
 
\fB\-x flash\fP option has been specified, an exit status of 2
310
 
indicates that the timed shutdown has failed.
311
 
.SH EXTRA ARGUMENTS
312
 
 
313
 
This driver does not support any extra settings in \fBups.conf\fP(5).
314
 
.SH SEE ALSO
315
 
 
316
 
.SS The documentation for the protocol used by this UPS:
317
 
belkin\(hyuniversal\(hyups.html
318
 
 
319
 
.SS The core driver:
320
 
\fBnutupsdrv\fP(8)
321
 
 
322
 
.SS Internet resources:
323
 
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
324
 
 
325
 
.SH AUTHOR
326
 
 
327
 
Peter Selinger <selinger@users.sourceforge.net>