lagertonne/nut
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Wiki Activity

Imported Upstream version 2.7.1

Browse source
This commit is contained in:
Laurent Bigonville 2013-11-24 16:00:12 +01:00
parent a1fa151fc7
commit 0121794af9
451 changed files with 41339 additions and 10887 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/FAQ.txt
View file

@ -90,7 +90,7 @@ There can be various reasons. To fix it, check:
- the LISTEN directive in upsd.conf. It should allow your local or remote
access method,
- your firewall rules. Port 3493/tcp must be opened to incoming connexions,
- your firewall rules. Port 3493/tcp must be opened to incoming connections,
- your tcp-wrappers configuration (hosts.allow and hosts.deny).
Refer to the upsd(8) and upsd.conf(5) manpages for more information.
@ -538,6 +538,24 @@ renamed to usbhid-ups.
usbhid-ups is built automatically if possible (libusb development files
need to be installed) and installed by the "make install" command.
== My USB UPS is supported but doesn't work!
On Linux, udev rules are provided to set the correct permissions on device file.
This allows the NUT driver to communicate with the UPS, through this device file.
However, the driver may still failed to start and support the device, with a
message like:
failed to claim USB device: could not claim interface 0: Operation not permitted
*Operation not permitted* is a message pointing a privilege issue.
The most frequent issue is that udev has not actually applied the rule:
- if NUT has been freshly installed,
- and if the device USB cord was already plugged when installing nut.
In this case, just unplug and plug back the USB cord, then restart nut.
== Why doesn't my package work?
Or a variation like...

44
docs/Makefile.am
View file

@ -20,8 +20,9 @@ USER_MANUAL_DEPS = acknowledgements.txt cables.txt config-notes.txt \
stable-hcl.txt
DEVELOPER_GUIDE_DEPS = contact-closure.txt design.txt developers.txt \
developer-guide.txt hid-subdrivers.txt macros.txt \
new-clients.txt new-drivers.txt net-protocol.txt sock-protocol.txt
developer-guide.txt hid-subdrivers.txt macros.txt new-clients.txt \
new-drivers.txt net-protocol.txt nutdrv_qx-subdrivers.txt \
snmp-subdrivers.txt sock-protocol.txt
CABLES_DEPS = cables/apc-rs500-serial.txt \
cables/apc.txt cables/ge-imv-victron.txt cables/imv.txt \
@ -34,9 +35,12 @@ CABLES_IMAGES = images/cables/73-0724.png images/cables/940-0024C.jpg \
images/cables/mge-db9-rj12.jpg images/cables/mge-db9-rj45.jpg \
images/cables/SOLA-330.png
EXTRA_DIST = $(SHARED_DEPS) $(USER_MANUAL_DEPS) $(DEVELOPER_GUIDE_DEPS) \
$(CABLES_DEPS) FAQ.txt nut-hal.txt nut-qa.txt packager-guide.txt snmp.txt \
$(IMAGE_FILES) $(CABLES_IMAGES) docinfo.xml
ALL_TXT_SRC = nut-names.txt $(USER_MANUAL_DEPS) $(DEVELOPER_GUIDE_DEPS) \
$(CABLES_DEPS) FAQ.txt nut-hal.txt nut-qa.txt packager-guide.txt snmp.txt
NUT_SPELL_DICT = nut.dict
EXTRA_DIST = $(ALL_TXT_SRC) $(SHARED_DEPS) $(IMAGE_FILES) \
$(CABLES_IMAGES) docinfo.xml $(NUT_SPELL_DICT)
ASCIIDOC_HTML_SINGLE = user-manual.html \
developer-guide.html \
@ -74,13 +78,14 @@ website:
endif !HAVE_ASCIIDOC
clean-local:
rm -rf *.pdf *.html *.chunked docbook-xsl.css
rm -rf *.pdf *.html *.chunked docbook-xsl.css *.bak
# Static HCL is generated automatically
# This is more of a harness, since this file should have already been
# generated, due to the top level Makefile SUBDIRS ordering (tools before docs)
ups-html.txt:
cd ../tools; $(MAKE) $(AM_MAKEFLAGS) website
ups-html.txt: ../data/driver.list.in
cd ../data && $(MAKE) $(AM_MAKEFLAGS) driver.list
cd ../tools && $(MAKE) $(AM_MAKEFLAGS) website
### TODO: automatic dependency generation
# Add other directory deps (not for local EXTRA_DIST) and generated contents
@ -116,4 +121,27 @@ A2X_COMMON_OPTS = $(ASCIIDOC_VERBOSE) --attribute icons \
.txt.pdf: docinfo.xml
$(A2X) $(A2X_COMMON_OPTS) --attribute=pdf_format --format=pdf -a docinfo1 $<
if HAVE_ASPELL
# FIXME: also check ../{NEWS,README,UPGRADING}+other dirs
# Non-interactively spell check all documentation source files.
# This is useful for Buildbot and automated QA processing
# FIXME: how to present output (std{out,err}, single file or per target)?
spellcheck:
@for docsrc in $(ALL_TXT_SRC); do \
echo "Spell checking on $$docsrc"; \
LANG=C $(ASPELL) -a -t -p $(NUT_SPELL_DICT) < $$docsrc | grep [^*]; \
done
# Interactively spell check all documentation source files
spellcheck-interactive:
@for docsrc in $(ALL_TXT_SRC); do\
echo "Spell checking on $$docsrc"; \
LANG=C $(ASPELL) check -p $(NUT_SPELL_DICT) $$docsrc; \
done
else !HAVE_ASPELL
spellcheck:
@echo "Documentation spell check not available since 'aspell' was not found."
spellcheck-interactive:
@echo "Documentation spell check not available since 'aspell' was not found."
endif !HAVE_ASPELL
.PHONY: html html-single pdf website

98
docs/Makefile.in
View file

@ -1,9 +1,9 @@
# Makefile.in generated by automake 1.11.1 from Makefile.am.
# Makefile.in generated by automake 1.11.6 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation,
# Inc.
# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software
# Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
@ -15,6 +15,23 @@
@SET_MAKE@
VPATH = @srcdir@
am__make_dryrun = \
{ \
am__dry=no; \
case $$MAKEFLAGS in \
*\\[\ \ ]*) \
echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \
| grep '^AM OK$$' >/dev/null || am__dry=yes;; \
*) \
for am__flg in $$MAKEFLAGS; do \
case $$am__flg in \
*=*|--*) ;; \
*n*) am__dry=yes; break;; \
esac; \
done;; \
esac; \
test $$am__dry = yes; \
}
pkgdatadir = $(datadir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
@ -50,8 +67,9 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/ax_compare_version.m4 \
$(top_srcdir)/m4/nut_check_libltdl.m4 \
$(top_srcdir)/m4/nut_check_libneon.m4 \
$(top_srcdir)/m4/nut_check_libnetsnmp.m4 \
$(top_srcdir)/m4/nut_check_libnss.m4 \
$(top_srcdir)/m4/nut_check_libopenssl.m4 \
$(top_srcdir)/m4/nut_check_libpowerman.m4 \
$(top_srcdir)/m4/nut_check_libssl.m4 \
$(top_srcdir)/m4/nut_check_libusb.m4 \
$(top_srcdir)/m4/nut_check_libwrap.m4 \
$(top_srcdir)/m4/nut_check_os.m4 \
@ -74,6 +92,11 @@ RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \
install-pdf-recursive install-ps-recursive install-recursive \
installcheck-recursive installdirs-recursive pdf-recursive \
ps-recursive uninstall-recursive
am__can_run_installinfo = \
case $$AM_UPDATE_INFO_DIR in \
n|no|NO) false;; \
*) (install-info --version) >/dev/null 2>&1;; \
esac
RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \
distclean-recursive maintainer-clean-recursive
AM_RECURSIVE_TARGETS = $(RECURSIVE_TARGETS:-recursive=) \
@ -113,6 +136,7 @@ ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AR = @AR@
ASCIIDOC = @ASCIIDOC@
ASPELL = @ASPELL@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
@ -139,6 +163,7 @@ DOC_BUILD_LIST = @DOC_BUILD_LIST@
DRIVER_BUILD_LIST = @DRIVER_BUILD_LIST@
DRIVER_INSTALL_TARGET = @DRIVER_INSTALL_TARGET@
DRIVER_MAN_LIST = @DRIVER_MAN_LIST@
DRVPATH = @DRVPATH@
DSYMUTIL = @DSYMUTIL@
DUMPBIN = @DUMPBIN@
ECHO_C = @ECHO_C@
@ -313,8 +338,9 @@ USER_MANUAL_DEPS = acknowledgements.txt cables.txt config-notes.txt \
stable-hcl.txt
DEVELOPER_GUIDE_DEPS = contact-closure.txt design.txt developers.txt \
developer-guide.txt hid-subdrivers.txt macros.txt \
new-clients.txt new-drivers.txt net-protocol.txt sock-protocol.txt
developer-guide.txt hid-subdrivers.txt macros.txt new-clients.txt \
new-drivers.txt net-protocol.txt nutdrv_qx-subdrivers.txt \
snmp-subdrivers.txt sock-protocol.txt
CABLES_DEPS = cables/apc-rs500-serial.txt \
cables/apc.txt cables/ge-imv-victron.txt cables/imv.txt \
@ -327,9 +353,12 @@ CABLES_IMAGES = images/cables/73-0724.png images/cables/940-0024C.jpg \
images/cables/mge-db9-rj12.jpg images/cables/mge-db9-rj45.jpg \
images/cables/SOLA-330.png
EXTRA_DIST = $(SHARED_DEPS) $(USER_MANUAL_DEPS) $(DEVELOPER_GUIDE_DEPS) \
$(CABLES_DEPS) FAQ.txt nut-hal.txt nut-qa.txt packager-guide.txt snmp.txt \
$(IMAGE_FILES) $(CABLES_IMAGES) docinfo.xml
ALL_TXT_SRC = nut-names.txt $(USER_MANUAL_DEPS) $(DEVELOPER_GUIDE_DEPS) \
$(CABLES_DEPS) FAQ.txt nut-hal.txt nut-qa.txt packager-guide.txt snmp.txt
NUT_SPELL_DICT = nut.dict
EXTRA_DIST = $(ALL_TXT_SRC) $(SHARED_DEPS) $(IMAGE_FILES) \
$(CABLES_IMAGES) docinfo.xml $(NUT_SPELL_DICT)
ASCIIDOC_HTML_SINGLE = user-manual.html \
developer-guide.html \
@ -582,13 +611,10 @@ distdir: $(DISTFILES)
done
@list='$(DIST_SUBDIRS)'; for subdir in $$list; do \
if test "$$subdir" = .; then :; else \
test -d "$(distdir)/$$subdir" \
|| $(MKDIR_P) "$(distdir)/$$subdir" \
|| exit 1; \
fi; \
done
@list='$(DIST_SUBDIRS)'; for subdir in $$list; do \
if test "$$subdir" = .; then :; else \
$(am__make_dryrun) \
|| test -d "$(distdir)/$$subdir" \
|| $(MKDIR_P) "$(distdir)/$$subdir" \
|| exit 1; \
dir1=$$subdir; dir2="$(distdir)/$$subdir"; \
$(am__relativize); \
new_distdir=$$reldir; \
@ -623,10 +649,15 @@ install-am: all-am
installcheck: installcheck-recursive
install-strip:
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
`test -z '$(STRIP)' || \
echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
if test -z '$(STRIP)'; then \
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
install; \
else \
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
"INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \
fi
mostlyclean-generic:
clean-generic:
@ -734,13 +765,14 @@ html-chunked: $(ASCIIDOC_HTML_CHUNKED)
@HAVE_ASCIIDOC_FALSE@ @echo "Not building website documentation since 'asciidoc' was not found."
clean-local:
rm -rf *.pdf *.html *.chunked docbook-xsl.css
rm -rf *.pdf *.html *.chunked docbook-xsl.css *.bak
# Static HCL is generated automatically
# This is more of a harness, since this file should have already been
# generated, due to the top level Makefile SUBDIRS ordering (tools before docs)
ups-html.txt:
cd ../tools; $(MAKE) $(AM_MAKEFLAGS) website
ups-html.txt: ../data/driver.list.in
cd ../data && $(MAKE) $(AM_MAKEFLAGS) driver.list
cd ../tools && $(MAKE) $(AM_MAKEFLAGS) website
user-manual.html user-manual.chunked user-manual.pdf: $(FULL_USER_MANUAL_DEPS)
developer-guide.html developer-guide.chunked developer-guide.pdf: $(FULL_DEVELOPER_GUIDE_DEPS)
@ -755,6 +787,26 @@ packager-guide.html packager-guide.chunked packager-guide.pdf: packager-guide.tx
.txt.pdf: docinfo.xml
$(A2X) $(A2X_COMMON_OPTS) --attribute=pdf_format --format=pdf -a docinfo1 $<
# FIXME: also check ../{NEWS,README,UPGRADING}+other dirs
# Non-interactively spell check all documentation source files.
# This is useful for Buildbot and automated QA processing
# FIXME: how to present output (std{out,err}, single file or per target)?
@HAVE_ASPELL_TRUE@spellcheck:
@HAVE_ASPELL_TRUE@ @for docsrc in $(ALL_TXT_SRC); do \
@HAVE_ASPELL_TRUE@ echo "Spell checking on $$docsrc"; \
@HAVE_ASPELL_TRUE@ LANG=C $(ASPELL) -a -t -p $(NUT_SPELL_DICT) < $$docsrc | grep [^*]; \
@HAVE_ASPELL_TRUE@ done
# Interactively spell check all documentation source files
@HAVE_ASPELL_TRUE@spellcheck-interactive:
@HAVE_ASPELL_TRUE@ @for docsrc in $(ALL_TXT_SRC); do\
@HAVE_ASPELL_TRUE@ echo "Spell checking on $$docsrc"; \
@HAVE_ASPELL_TRUE@ LANG=C $(ASPELL) check -p $(NUT_SPELL_DICT) $$docsrc; \
@HAVE_ASPELL_TRUE@ done
@HAVE_ASPELL_FALSE@spellcheck:
@HAVE_ASPELL_FALSE@ @echo "Documentation spell check not available since 'aspell' was not found."
@HAVE_ASPELL_FALSE@spellcheck-interactive:
@HAVE_ASPELL_FALSE@ @echo "Documentation spell check not available since 'aspell' was not found."
.PHONY: html html-single pdf website
# Tell versions [3.59,3.63) of GNU make to not export all variables.

22
docs/acknowledgements.txt
View file

@ -21,13 +21,22 @@ Active members
- Arnaud Quette: project leader (since 2005), Debian packager and jack of all trades
- Charles Lepple: senior lieutenant
- Frederic Bohe: senior developer
- Emilien Kia: senior developer
- Václav Krpec: junior developer
- Kjell Claesson: senior developer
- Alexander Gordeev: junior developer
- Michal Soltys: junior developer
- David Goncalves: Python developer
- Jean Perriault: web consultant
- Eric S. Raymond: Documentation consultant
- Oden Eriksson: Mandriva packager
- Stanislav Brabec: Novell / Suse packager
- Michal Hlavinka: Redhat packager
- Antoine Colombier: trainee
For an up to date list of NUT developers, refer to
link:https://alioth.debian.org/project/memberlist.php?group_id=30602[Alioth].
Retired members
~~~~~~~~~~~~~~~
@ -61,7 +70,7 @@ This support includes the following actions:
- providing extensive technical documents (Eaton protocols library),
- providing units to developers of NUT and related projects,
- hosting the networkupstools.org webserver,
- hosting the networkupstools.org webserver (from 2005 to August 2012),
- providing artwork,
- promoting NUT in general.
@ -90,6 +99,17 @@ link:http://www.microdowell.com/fra/download.html[Linux / Unix].
link:ups-protocols.html[extensive information] on its USB/HID devices, along
with development units.
- link:http://www.riello-ups.com[Riello UPS], through Massimo Zampieri, has
provided link:ups-protocols.html[all protocols information]. Elio Parisi has
also created riello_ser and riello_usb to support these protocols.
- link:http://www.tripplite.com[Tripp Lite], through Eric Cobb, has provided
test results from connecting their HID-compliant UPS hardware to NUT. Some of
this information has been incorporated into the NUT hardware compatibility
list, and the rest of the information is available via the
link:http://article.gmane.org/gmane.comp.monitoring.nut.user/8173[list
archives].
Appliances manufacturers
~~~~~~~~~~~~~~~~~~~~~~~~

9
docs/configure.txt
View file

@ -95,10 +95,13 @@ Build and install all of the above (the serial, USB, SNMP, XML/HTTP and
PowerMan drivers, the CGI programs and HTML files, and the upsclient
library).
--with-ssl (default: auto-detect)
--with-ssl (default: auto-detect)
--with-nss (default: auto-detect)
--with-openssl (default: auto-detect)
Enable SSL development code. Read the section "Configuring SSL" in
docs/security.txt for instructions on SSL support.
Enable SSL support, using either Mozilla NSS or OpenSSL.
If both are present, and nothing was specified, OpenSSL support will
be prefered. Read docs/security.txt for instructions on SSL support.
--with-wrap (default: auto-detect)

300
docs/developers.txt
View file

@ -2,7 +2,7 @@ Information for developers
==========================
This document is intended to explain some of the more useful things
within the tree and provide a standard for working on the code.
within the tree, and provide a standard for working on the code.
General stuff - common subdirectory
-----------------------------------
@ -10,16 +10,16 @@ General stuff - common subdirectory
String handling
~~~~~~~~~~~~~~~
Use snprintf. It's even provided with a compatibility module if the
target host doesn't have it natively.
Use snprintf(). It's even provided with a compatibility module if the
target system doesn't have it natively.
If you use snprintf to load some value into a buffer, make sure you
If you use snprintf() to load some value into a buffer, make sure you
provide the format string. Don't use user-provided format strings,
since that's an easy way to open yourself up to an exploit.
Don't use strcat. We have a neat wrapper for snprintf called snprintfcat
Don't use strcat(). We have a neat wrapper for snprintf() called snprintfcat()
that allows you to append to char * with a format string and all the usual
string length checking of snprintf.
string length checking of snprintf().
Error reporting
~~~~~~~~~~~~~~~
@ -38,9 +38,9 @@ exit(EXIT_FAILURE) afterwards. Don't call exit() directly.
Debugging information
~~~~~~~~~~~~~~~~~~~~~
upsdebug_with_errno(), upsdebugx() and upsdebug_hex() use the
global nut_debug_level so you don't have to mess around with
printfs yourself. Use them.
upsdebug_with_errno(), upsdebugx(), upsdebug_hex() and upsdebug_ascii()
use the global `nut_debug_level` so you don't have to mess around with
printf()s yourself. Use them.
Memory allocation
~~~~~~~~~~~~~~~~~
@ -312,20 +312,19 @@ and many people have put a lot of time and energy to improve it.
Submitting patches
------------------
Patches that arrive in unified format (diff -u) as plain text attachments with
no HTML and a brief summary at the top are the easiest to handle.
Small patches that arrive in unified format (diff -u) as plain text attachments
with no HTML and a brief summary at the top are the easiest to handle.
If a patch is sent to the nut-upsdev mailing list, it stands a better chance of
being seen immediately. However, it is likely to be dropped if any issues
cannot be resolved quickly. If your code might not work for others, or if it is
a large change, your best bet is to submit a
link:https://alioth.debian.org/tracker/?atid=411544&group_id=30602&func=browse[ticket on Alioth].
This allows us to track the patches over a longer period of time, and it is
less likely that a patch will fall through the cracks. Posting a reminder to
the developers (via the nut-upsdev list) about a patch on the tracker is fair
game.
a large change, your best bet is to submit a pull request or create an
link:https://github.com/networkupstools/nut/issues[issue on GitHub].
The issue tracker allows us to track the patches over a longer period of time,
and it is less likely that a patch will fall through the cracks. Posting a
reminder to the developers (via the nut-upsdev list) about a patch on GitHub is
fair game.
Patch cohesion
--------------
@ -343,8 +342,8 @@ instead of just dropping it.
If you have to make big changes in lots of places, send multiple
patches - one per item.
The completion touch: manual pages and device entry in HCL
----------------------------------------------------------
The finishing touches: manual pages and device entry in HCL
-----------------------------------------------------------
If you change something that involves an argument to a program or
configuration file parsing, the man page is probably now out of date.
@ -363,96 +362,181 @@ HTML and dynamic searchable HTML for the website.
Source code management
----------------------
We currently use a Subversion (SVN) repository hosted at Alioth to track
changes to the NUT source code. To obtain permission to commit to the SVN
repository, you must be prepared to spend a fair amount of time contributing to
the NUT codebase. For occasional contributions over time, you may wish to
investigate one of the <<_distributed_scm_systems,distributed SCM tools>>
listed below.
We currently use a Git repository hosted at GitHub (with a mirror at Alioth) to track
changes to the NUT source code. This allows you to clone the repository (or
fork, in GitHub parlance), make changes, and post them online for review prior
to integration.
Anonymous SVN checkouts are possible:
To obtain permission to commit directly to the master NUT repository, you must
be prepared to spend a fair amount of time contributing to the NUT codebase.
Most developers will be well served by committing to their own Git repository,
and having the NUT team merge their changes.
svn co svn://svn.debian.org/nut/trunk nut-svn-readonly
Git offers a little more flexibility than the +svn update+ command. You may
fetch other developers' changes from SVN into your repository, but hold off on
actually combining them with your branch until you have compared the two
branches (for instance, with `gitk --all`). Git also allows you to accumulate
more than one commit worth of changes before pushing to another repository.
If you change a file in the SVN working copy, you can use `svn diff` to
generate a patch to send to the nut-upsdev mailing list.
For a quick change to a file in the Git working copy, you can use `git diff` to
generate a patch to send to the nut-upsdev mailing list. If you have more
extensive changes, you can use `git format-patch` on a complete commit or
branch, and send the resulting series of patches to the list.
The link:https://git.wiki.kernel.org/index.php/GitSvnCrashCourse[GitSvnCrashCourse]
wiki page has some useful information for long-time users of Subversion.
Git access
~~~~~~~~~~
Anonymous Git checkouts are possible:
git clone git://github.com/networkupstools/nut.git
or
git clone https://github.com/networkupstools/nut.git
if it is necessary to get around a pesky firewall that blocks the native Git
protocol.
For a quicker checkout (when you don't need the entire repository history),
you can limit the depth of the clone:
git clone --depth 1 git://github.com/networkupstools/nut.git
In case the GitHub repository is temporarily unavailable for any reason, we
also plan to push to Alioth's
link:https://alioth.debian.org/scm/?group_id=30602[Git server] as well. You can
add a remote reference to your local repository:
cd path/to/nut
git remote add -f alioth git://anonscm.debian.org/nut/nut.git
Mercurial (hg) access
~~~~~~~~~~~~~~~~~~~~~
There are those who prefer the simplicity and self-consistency of the Mercurial
SCM client over the hodgepodge of unique commands which make up Git. Rather
than debate the merits of each system, we will gently guide you towards the
link:http://hg-git.github.com/[hg-git project] which would theoretically be a
transparent bridge between the central Git repository, and your local Mercurial
working copy.
Other tools for hg/git interoperability are sure to exist. We would welcome any
feedback about this process on the nut-upsdev mailing list.
Subversion (SVN) access
~~~~~~~~~~~~~~~~~~~~~~~
If you prefer to check out the NUT source code using an SVN client, GitHub
has a link:https://github.com/blog/966-improved-subversion-client-support[SVN
interface to Git repositories] hosted on their servers. You can fork a copy of
the NUT repository and commit to your fork with SVN.
Be aware that the examples in the GitHub blog post might result in a checkout
that includes all of the current branches, as well as the trunk. You are most
likely interested in a command line similar to the following:
svn co https://github.com/networkupstools/nut/trunk nut-trunk-svn
Ignoring generated files
------------------------
The NUT repository generally only holds files which are not generated from
other files. This prevents spurious differences from being recorded in the
repository history.
If you add a driver, it is recommended that you add the driver executable name
to the .gitignore file in that directory. Similarly, files generated from *.in
and *.am sources should be ignored as well. We try to include a number of
generated files in the tarball releases with `make dist` hooks in order to
minimize the number of dependencies for end users, but the assumption is that
a developer can install the packages needed to regenerate those files.
Commit message formatting
-------------------------
From the `git commit` man page:
[quote]
Though not required, it’s a good idea to begin the commit message with a single
short (less than 50 character) line summarizing the change, followed by a blank
line and then a more thorough description. The text up to the first blank line
in a commit message is treated as the commit title, and that title is used
throughout git.
If your commit is just a change to one component, such as the HCL, upsd or a
specific driver, prefix your commit message in a way that matches similar
commits. This helps when searching the repository or tracking down a
regression.
Referring to previous commits can be tricky. If you are referring to the
immediate parent of a given commit, it suffices to say "the previous commit".
(Are you correcting a typo in the previous commit? If you haven't pushed yet,
consider using the `git commit --amend` command instead of creating a new
commit.) For other commits, even though tools like gitk and GitHub's
repository viewers recognize Git hashes and create links automatically, it is
best to add some context such as the commit title or a date.
You may notice that some older commits have `[[SVN:####]]` tags and Fossil-ID
footers. These were lifted from the old SVN commit messages using reposurgeon,
and should not be used as a guide for future commits.
Repository etiquette and quality assurance
------------------------------------------
Please keep the SVN trunk in working condition at all times. The trunk
may be used to generate daily tarballs, and should not contain broken
code if possible. If you need to commit incremental changes that leave
the system in a broken state, please do so in a separate branch and
merge the changes back to the trunk once they are complete.
Please keep the Git master branch in working condition at all times. The
master branch may be used to generate daily tarballs, and should not contain
broken code. If you need to commit incremental changes that leave the system
in a broken state, please do so in a separate branch and merge the changes
back into master once they are complete.
Before committing, please remember to run "make distcheck-light". This checks
that the Makefiles are not broken, that all the relevant files are distributed,
and that there are no compilation or installation errors.
You are encouraged to use `git rebase -i` on your private Git branches to
separate your changes into <<_patch_cohesion,logical changes>>.
Running "make distcheck-light" is especially important if you have added or
From there, you can generate patches for the issue tracker, or the nut-upsdev list.
Note that once you rebase a branch, anyone else who has a copy of this branch
will need to rebase on top of your rebased branch. Obviously, this hinders
collaboration. In this case, we recommend that you rebase only in your private
repository, and push when things are ready for discussion. Merging instead of
rebasing will help with collaboration, but please do not turn the repository
history into a pile of spaghetti by merging unnecessarily. Be sure that your
commit messages are descriptive when merging.
Before pushing your commits upstream, please remember to run +make
distcheck-light+. This checks that the Makefiles are not broken, that all the
relevant files are distributed, and that there are no compilation or
installation errors.
Running +make distcheck-light+ is especially important if you have added or
removed files, or updated configure.in or some Makefile.am. Remember: simply
adding a file to SVN does not mean it will be distributed. To distribute a
adding a file to Git does not mean it will be distributed. To distribute a
file, you must update the corresponding Makefile.am.
There is also "make distcheck", which runs an even stricter set of
tests, but will not work unless you have all the optional libraries
and features installed.
Distributed SCM systems
-----------------------
Git and Mercurial (Hg) are two popular distributed SCM tools which provide a
bridge to a SVN repository. This makes it possible for a new developer to stay
synchronized with the latest changes to NUT, while keeping a local version
history of their changes before they are merged by the core NUT developers.
A complete introduction to either Git or Mercurial is beyond the scope of this
document, but many others have written excellent tutorials on both the DSCM
tools, and their SVN interfaces.
Git and SVN
~~~~~~~~~~~
The `git svn` tool synchronizes a Git repository with a
link:http://www.kernel.org/pub/software/scm/git/docs/git-svn.html[SVN repository].
In many cases, NUT developers will not need access to the entire repository
history - a snapshot starting at the most recent revision will work nicely:
git svn clone --revision HEAD svn://svn.debian.org/nut/trunk nut-git
From the resulting nut-git directory, you may use all of the Git commands to
record your changes, and even create new branches for working on different
aspects of the code.
Git offers a little more flexibility than the `svn update` command. You may
fetch other developers' changes from SVN into your repository, but hold off on
actually combining them with your branch until you have compared the two
branches (for instance, with `gitk --all`).
To import the new SVN revisions, simply run the following command from any
directory under your Git checkout (`nut-git` in the example above). Note that
this only changes the history stored in your repository - it does not touch
your checked-out files.
git svn fetch
Initially, the Git `master` branch tracks the SVN `trunk`. The `git svn`
command updates the `remotes/trunk` reference every time you run `git svn
fetch`, but it does not adjust the `master` branch automatically. To update
your master branch with new SVN revisions, you can run the following commands:
git checkout master
git svn fetch # (optional; this gets commits other than on your current branch)
git svn rebase
There is also +make distcheck+, which runs an even stricter set of
tests than +make distcheck-light+, but will not work unless you have all the
optional libraries and features installed.
You may create as many branches as you like in your local Git repository. When
using `git svn`, the preferred way to combine your changes with SVN changes is
to use `git rebase` on your local branch. This re-applies your branch's changes
to the new SVN changes, much as though your branch were a series of patches.
using Git, our preferred way to combine small changes with the upstream
upstream repository is to use `git rebase` on your local branch. This is
equivalent to treating your branch as a series of patches, and re-applying your
patches on top of the upstream changes.
If you haven't created a commit out of your local changes yet, and you want to
fetch the latest code, you can also use +git stash+ before pulling, then +git
stash pop+ to apply your saved changes.
Here is an example workflow:
--------------------------------------------------------------------------------
git clone -o central git://github.com/networkupstools/nut.git
cd nut
git remote add -f username git://github.com/username/nut.git
git checkout master
git branch my-new-feature
git checkout my-new-feature
@ -462,27 +546,21 @@ to the new SVN changes, much as though your branch were a series of patches.
git add changed-file.c
git commit
# Someone committed something to SVN. Fetch it.
# Fix a typo in a file or commit message:
git svn fetch
git rebase remotes/trunk
git commit -a --amend
# Someone committed something to the central repository. Fetch it.
git fetch central
git rebase central/master
# Publish your branch to your GitHub repository:
git push username my-new-feature
--------------------------------------------------------------------------------
You are encouraged to use `git rebase -i` on your private Git branches to
separate your changes into <<_patch_cohesion,logical changes>>.
From there, you can generate patches for the Tracker, or the nut-upsdev list.
If you are new to Git, but are familiar with SVN, the
link:http://git-scm.com/course/svn.html[following link] may be of use.
Mercurial and SVN
~~~~~~~~~~~~~~~~~
Synchronizing a Mercurial repository against the NUT SVN repository should be
similar in spirit to the Git method discussed above.
link:http://mercurial.selenic.com/wiki/WorkingWithSubversion[This wiki page]
discusses your options.
We would welcome any feedback about this process on the nut-upsdev mailing list.

54
docs/download.txt
View file

@ -32,27 +32,22 @@ Stable tree: {tree_version}
You can also browse the link:http://www.networkupstools.org/source/{tree_version}/[stable source directory].
Testing tree: {tree_version}.x-pre
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There is currently no testing release.
Development tree:
~~~~~~~~~~~~~~~~~
Code repository
^^^^^^^^^^^^^^^
The development tree is available through a Subversion repository hosted on the
link:http://alioth.debian.org/[Debian Alioth server].
The development tree is available through a Git repository hosted at
link:https://github.com/[GitHub].
To retrieve the current development tree, use the following command:
$ svn co svn://anonscm.debian.org/nut/trunk
$ git clone git://github.com/networkupstools/nut.git
To generate the build scripts, you must call, from the 'trunk' directory:
The configure script and its dependencies are not stored in Git. To generate
them, ensure that autoconf, automake and libtool are installed, then run the
following script in the directory you just checked out:
$ ./autogen.sh
@ -65,22 +60,34 @@ linkdoc:user-manual[NUT user manual]
endif::website[]
for more information.
//////////////////////////
NOTE: Users that need the latest developments to support new devices *must*
use <<Snapshots,snapshots>>.
use Git or <<Snapshots,snapshots>>.
//////////////////////////
Browse code
^^^^^^^^^^^
You can also browse the code with link:http://alioth.debian.org/scm/?group_id=30602[WebSvn],
or through the link:http://trac.networkupstools.org/projects/nut[Trac mirror],
kindly hosted and maintained by Charles Lepple.
You can also browse the code at
link:https://github.com/networkupstools/nut[GitHub], or at the
link:http://alioth.debian.org/scm/?group_id=30602[Alioth mirror]. The code was
originally kept in Subversion, and the old
link:http://trac.networkupstools.org/projects/nut[Trac site] will be kept
around for a bit so as not to break the URLs in the mailing list archives.
[[Snapshots]]
Snapshots
^^^^^^^^^
The latest Subversion developments are available through link:http://buildbot.networkupstools.org/public/nut/waterfall?branch=trunk&builder=Debian-etch-x86&reload=none[snapshots on the Buildbot].
Look for the latest *[tarball]* link on the top of the page.
GitHub has several download links for repository snapshots (for particular tags
or branches), but you will need a number of tools such as autoconf, automake
and libtool to use these snapshots.
If our Buildbot instance is behaving, you can download a snapshot which does
not require auto* tools from this
link:http://buildbot.networkupstools.org/snapshots[builder]. Look for the
latest *[tarball]* link towards the top of the page, and be sure to check the
'Build ##' link to verify the branch name.
Older versions
~~~~~~~~~~~~~~
@ -101,26 +108,29 @@ link:http://packages.debian.org/nut[Debian],
link:http://packages.gentoo.org/package/sys-power/nut[Gentoo Linux],
Mandriva,
link:https://admin.fedoraproject.org/pkgdb/acls/name/nut[Red Hat / Fedora],
link:http://software.opensuse.org/search[Novell Suse / openSUSE],
link:http://software.opensuse.org/package/nut[Novell Suse / openSUSE],
link:https://forum.openwrt.org/viewtopic.php?id=26269[OpenWrt],
link:http://packages.ubuntu.com/nut[Ubuntu].
- BSD systems:
link:http://www.FreeBSD.org/cgi/ports.cgi?query=^nut-&amp;stype=name[FreeBSD],
link:ftp://ftp.netbsd.org/pub/NetBSD/packages/pkgsrc/sysutils/ups-nut/README.html[NetBSD],
link:http://www.openbsd.org/cgi-bin/cvsweb/ports/sysutils/nut/[OpenBSD].
link:http://www.openbsd.org/cgi-bin/cvsweb/ports/sysutils/nut/[OpenBSD],
link:http://doc.freenas.org/index.php/UPS[FreeNAS].
- Mac OS X:
link:http://pdb.finkproject.org/pdb/package.php/nut[Fink],
link:http://trac.macports.org/browser/trunk/dports/sysutils/nut/Portfile[MacPorts]
- Windows (complete port, Beta):
link:http://www.networkupstools.org/source/2.6/NUT-Installer-2.6.4-1.msi[Windows MSI installer 2.6.4-1]
link:http://www.networkupstools.org/package/windows/NUT-Installer-2.6.5-3.msi[Windows MSI installer 2.6.5-3]
Java packages
-------------
The jNut package has been split into its own link:https://github.com/networkupstools/jNut[GitHub repository].
- NUT Java support (client side, Beta)
link:http://www.networkupstools.org/package/java/jNut-0.2-SNAPSHOT.tar.gz[jNUT 0.2-SNAPSHOT]
@ -133,7 +143,7 @@ Virtualization packages
VMware
~~~~~~
- NUT client for ESXI 5.0 (offsite, René Garcia)
- NUT client for ESXi 5.0 (offsite, René Garcia)
* link:http://rene.margar.fr/2012/05/client-nut-pour-esxi-5-0/[blog entry (French)]
* link:http://rene.margar.fr/downloads/NutClient-ESXi500-1.0.2.tar.gz[VIB package]
* link:http://rene.margar.fr/downloads/NutClient-ESXi500-1.2.0.tar.gz[VIB package (v1.2.0)]

4
docs/hid-subdrivers.txt
View file

@ -143,13 +143,13 @@ You should save this information to a file, e.g.
drivers/usbhid-ups -DD -u root -x explore -x vendorid=XXXX auto >& /tmp/info
You can create an initial "stub" subdriver for your device by using
script scripts/subdriver/path-to-subdriver.sh. Note: this only creates
script scripts/subdriver/gen-usbhid-subdriver.sh. Note: this only creates
a "stub" and needs to be futher customized to be useful (see
CUSTOMIZATION below).
Use the script as follows:
scripts/subdriver/path-to-subdriver.sh < /tmp/info
scripts/subdriver/gen-usbhid-subdriver.sh < /tmp/info
where /tmp/info is the file where you previously saved the debugging
information.

3
docs/macros.txt
View file

@ -16,7 +16,8 @@ directory.
- NUT_CHECK_LIBNEON
- NUT_CHECK_LIBNETSNMP
- NUT_CHECK_LIBPOWERMAN
- NUT_CHECK_LIBSSL
- NUT_CHECK_LIBOPENSSL
- NUT_CHECK_LIBNSS
- NUT_CHECK_LIBUSB
- NUT_CHECK_LIBWRAP

120
docs/man/Makefile.am
View file

@ -119,10 +119,13 @@ HTML_CGI_MANS = \
# Development (--with-dev) related manpages
SRC_DEV_PAGES = \
upsclient.txt \
upscli_add_host_cert.txt \
upscli_cleanup.txt \
upscli_connect.txt \
upscli_disconnect.txt \
upscli_fd.txt \
upscli_get.txt \
upscli_init.txt \
upscli_list_next.txt \
upscli_list_start.txt \
upscli_readline.txt \
@ -132,6 +135,13 @@ SRC_DEV_PAGES = \
upscli_ssl.txt \
upscli_strerror.txt \
upscli_upserror.txt \
libnutclient.txt \
libnutclient_commands.txt \
libnutclient_devices.txt \
libnutclient_general.txt \
libnutclient_misc.txt \
libnutclient_tcp.txt \
libnutclient_variables.txt \
nutscan.txt \
nutscan_scan_snmp.txt \
nutscan_scan_usb.txt \
@ -139,6 +149,7 @@ SRC_DEV_PAGES = \
nutscan_scan_nut.txt \
nutscan_scan_avahi.txt \
nutscan_scan_ipmi.txt \
nutscan_scan_eaton_serial.txt \
nutscan_display_ups_conf.txt \
nutscan_display_parsable.txt \
nutscan_cidr_to_ip.txt \
@ -147,15 +158,20 @@ SRC_DEV_PAGES = \
nutscan_add_option_to_device.txt \
nutscan_add_device_to_device.txt \
nutscan_init.txt \
nutscan_get_serial_ports_list.txt \
libupsclient-config.txt \
skel.txt
# NOTE: nutclient_*.3 has no source counterpart (libnutclient_*.txt)
MAN3_DEV_PAGES = \
upsclient.3 \
upscli_add_host_cert.3 \
upscli_cleanup.3 \
upscli_connect.3 \
upscli_disconnect.3 \
upscli_fd.3 \
upscli_get.3 \
upscli_init.3 \
upscli_list_next.3 \
upscli_list_start.3 \
upscli_readline.3 \
@ -165,6 +181,40 @@ MAN3_DEV_PAGES = \
upscli_ssl.3 \
upscli_strerror.3 \
upscli_upserror.3 \
libnutclient.3 \
libnutclient_commands.3 \
libnutclient_devices.3 \
libnutclient_general.3 \
libnutclient_misc.3 \
libnutclient_tcp.3 \
libnutclient_variables.3 \
nutclient_authenticate.3 \
nutclient_destroy.3 \
nutclient_device_forced_shutdown.3 \
nutclient_device_login.3 \
nutclient_device_master.3 \
nutclient_execute_device_command.3 \
nutclient_get_device_command_description.3 \
nutclient_get_device_commands.3 \
nutclient_get_device_description.3 \
nutclient_get_device_num_logins.3 \
nutclient_get_device_rw_variables.3 \
nutclient_get_devices.3 \
nutclient_get_device_variable_description.3 \
nutclient_get_device_variables.3 \
nutclient_get_device_variable_values.3 \
nutclient_has_device.3 \
nutclient_has_device_command.3 \
nutclient_has_device_variable.3 \
nutclient_logout.3 \
nutclient_set_device_variable_value.3 \
nutclient_set_device_variable_values.3 \
nutclient_tcp_create_client.3 \
nutclient_tcp_disconnect.3 \
nutclient_tcp_get_timeout.3 \
nutclient_tcp_is_connected.3 \
nutclient_tcp_reconnect.3 \
nutclient_tcp_set_timeout.3 \
nutscan.3 \
nutscan_scan_snmp.3 \
nutscan_scan_usb.3 \
@ -172,6 +222,7 @@ MAN3_DEV_PAGES = \
nutscan_scan_nut.3 \
nutscan_scan_avahi.3 \
nutscan_scan_ipmi.3 \
nutscan_scan_eaton_serial.3 \
nutscan_display_ups_conf.3 \
nutscan_display_parsable.3 \
nutscan_cidr_to_ip.3 \
@ -179,6 +230,7 @@ MAN3_DEV_PAGES = \
nutscan_free_device.3 \
nutscan_add_option_to_device.3 \
nutscan_add_device_to_device.3 \
nutscan_get_serial_ports_list.3 \
nutscan_init.3
MAN1_DEV_PAGES = \
@ -195,10 +247,13 @@ endif
HTML_DEV_MANS = \
upsclient.html \
upscli_add_host_cert.html \
upscli_cleanup.html \
upscli_connect.html \
upscli_disconnect.html \
upscli_fd.html \
upscli_get.html \
upscli_init.html \
upscli_list_next.html \
upscli_list_start.html \
upscli_readline.html \
@ -208,6 +263,13 @@ HTML_DEV_MANS = \
upscli_ssl.html \
upscli_strerror.html \
upscli_upserror.html \
libnutclient.html \
libnutclient_commands.html \
libnutclient_devices.html \
libnutclient_general.html \
libnutclient_misc.html \
libnutclient_tcp.html \
libnutclient_variables.html \
nutscan.html \
nutscan_scan_snmp.html \
nutscan_scan_usb.html \
@ -215,6 +277,7 @@ HTML_DEV_MANS = \
nutscan_scan_nut.html \
nutscan_scan_avahi.html \
nutscan_scan_ipmi.html \
nutscan_scan_eaton_serial.html \
nutscan_display_ups_conf.html \
nutscan_display_parsable.html \
nutscan_cidr_to_ip.html \
@ -222,6 +285,7 @@ HTML_DEV_MANS = \
nutscan_free_device.html \
nutscan_add_option_to_device.html \
nutscan_add_device_to_device.html \
nutscan_get_serial_ports_list.html \
nutscan_init.html \
libupsclient-config.html \
skel.html
@ -237,6 +301,7 @@ else
# (--with-serial)
SRC_SERIAL_PAGES = \
al175.txt \
apcsmart.txt \
apcsmart-old.txt \
bcmxcp.txt \
@ -246,7 +311,8 @@ SRC_SERIAL_PAGES = \
bestuferrups.txt \
bestups.txt \
bestfcom.txt \
blazer.txt \
blazer-common.txt \
blazer_ser.txt \
clone.txt \
dummy-ups.txt \
etapro.txt \
@ -263,18 +329,22 @@ SRC_SERIAL_PAGES = \
mge-utalk.txt \
oneac.txt \
microdowell.txt \
nutdrv_qx.txt \
optiups.txt \
powercom.txt \
powerpanel.txt \
rhino.txt \
riello_ser.txt \
safenet.txt \
solis.txt \
tripplite.txt \
tripplitesu.txt \
upscode2.txt \
victronups.txt
victronups.txt \
apcupsd-ups.txt
MAN_SERIAL_PAGES = \
al175.8 \
apcsmart.8 \
apcsmart-old.8 \
bcmxcp.8 \
@ -284,7 +354,7 @@ MAN_SERIAL_PAGES = \
bestuferrups.8 \
bestups.8 \
bestfcom.8 \
blazer.8 \
blazer_ser.8 \
clone.8 \
dummy-ups.8 \
etapro.8 \
@ -299,24 +369,28 @@ MAN_SERIAL_PAGES = \
metasys.8 \
mge-shut.8 \
mge-utalk.8 \
nutdrv_qx.8 \
oneac.8 \
microdowell.8 \
optiups.8 \
powercom.8 \
powerpanel.8 \
rhino.8 \
riello_ser.8 \
safenet.8 \
solis.8 \
tripplite.8 \
tripplitesu.8 \
upscode2.8 \
victronups.8
victronups.8 \
apcupsd-ups.8
if WITH_SERIAL
man8_MANS += $(MAN_SERIAL_PAGES)
endif
HTML_SERIAL_MANS = \
al175.html \
apcsmart.html \
apcsmart-old.html \
bcmxcp.html \
@ -326,7 +400,7 @@ HTML_SERIAL_MANS = \
bestuferrups.html \
bestups.html \
bestfcom.html \
blazer.html \
blazer_ser.html \
clone.html \
dummy-ups.html \
etapro.html \
@ -341,18 +415,21 @@ HTML_SERIAL_MANS = \
metasys.html \
mge-shut.html \
mge-utalk.html \
nutdrv_qx.html \
oneac.html \
microdowell.html \
optiups.html \
powercom.html \
powerpanel.html \
rhino.html \
riello_ser.html \
safenet.html \
solis.html \
tripplite.html \
tripplitesu.html \
upscode2.html \
victronups.html
victronups.html \
apcupsd-ups.html
# (--with-snmp)
SRC_SNMP_PAGES = snmp-ups.txt
@ -367,13 +444,20 @@ HTML_SNMP_MANS = snmp-ups.html
# (--with-usb)
SRC_USB_LIBUSB_PAGES = \
bcmxcp_usb.txt \
blazer-common.txt \
blazer_usb.txt \
nutdrv_qx.txt \
richcomm_usb.txt \
riello_usb.txt \
tripplite_usb.txt \
usbhid-ups.txt
MAN_USB_LIBUSB_PAGES = \
bcmxcp_usb.8 \
blazer_usb.8 \
nutdrv_qx.8 \
richcomm_usb.8 \
riello_usb.8 \
tripplite_usb.8 \
usbhid-ups.8
@ -383,7 +467,10 @@ endif
HTML_USB_LIBUSB_MANS = \
bcmxcp_usb.html \
blazer_usb.html \
nutdrv_qx.html \
richcomm_usb.html \
riello_usb.html \
tripplite_usb.html \
usbhid-ups.html
@ -496,25 +583,24 @@ if HAVE_ASCIIDOC
--attribute localtime=`TZ=UTC date +%H:%M:%S` \
-o $@ $<
### The --destination-dir flag doesn't seem to affect the intermediate .xml file.
### Hence, the copying dance below.
A2X_MANPAGE_OPTS = -f manpage --attribute nutversion="@PACKAGE_VERSION@"
### Prior to Asciidoc ~8.6.8, the --destination-dir flag didn't seem to affect the location of the intermediate .xml file.
A2X_MANPAGE_OPTS = --doctype manpage --format manpage \
--attribute mansource="Network UPS Tools" \
--attribute manversion="@PACKAGE_VERSION@" \
--attribute manmanual="NUT Manual" \
--destination-dir=.
.txt.1:
test -f `basename $<` || cp -p $< .
$(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
$(A2X) $(A2X_MANPAGE_OPTS) $<
.txt.3:
test -f `basename $<` || cp -p $< .
$(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
$(A2X) $(A2X_MANPAGE_OPTS) $<
.txt.5:
test -f `basename $<` || cp -p $< .
$(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
$(A2X) $(A2X_MANPAGE_OPTS) $<
.txt.8:
test -f `basename $<` || cp -p $< .
$(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
$(A2X) $(A2X_MANPAGE_OPTS) $<
else !HAVE_ASCIIDOC

250
docs/man/Makefile.in
View file

@ -1,9 +1,9 @@
# Makefile.in generated by automake 1.11.1 from Makefile.am.
# Makefile.in generated by automake 1.11.6 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation,
# Inc.
# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software
# Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
@ -29,6 +29,23 @@
# FIXME: investigate an autogen.sh hook
# - Ref: http://www.gnu.org/software/hello/manual/automake/Man-pages.html
VPATH = @srcdir@
am__make_dryrun = \
{ \
am__dry=no; \
case $$MAKEFLAGS in \
*\\[\ \ ]*) \
echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \
| grep '^AM OK$$' >/dev/null || am__dry=yes;; \
*) \
for am__flg in $$MAKEFLAGS; do \
case $$am__flg in \
*=*|--*) ;; \
*n*) am__dry=yes; break;; \
esac; \
done;; \
esac; \
test $$am__dry = yes; \
}
pkgdatadir = $(datadir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
@ -78,8 +95,9 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/ax_compare_version.m4 \
$(top_srcdir)/m4/nut_check_libltdl.m4 \
$(top_srcdir)/m4/nut_check_libneon.m4 \
$(top_srcdir)/m4/nut_check_libnetsnmp.m4 \
$(top_srcdir)/m4/nut_check_libnss.m4 \
$(top_srcdir)/m4/nut_check_libopenssl.m4 \
$(top_srcdir)/m4/nut_check_libpowerman.m4 \
$(top_srcdir)/m4/nut_check_libssl.m4 \
$(top_srcdir)/m4/nut_check_libusb.m4 \
$(top_srcdir)/m4/nut_check_libwrap.m4 \
$(top_srcdir)/m4/nut_check_os.m4 \
@ -95,6 +113,11 @@ CONFIG_CLEAN_FILES =
CONFIG_CLEAN_VPATH_FILES =
SOURCES =
DIST_SOURCES =
am__can_run_installinfo = \
case $$AM_UPDATE_INFO_DIR in \
n|no|NO) false;; \
*) (install-info --version) >/dev/null 2>&1;; \
esac
am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`;
am__vpath_adj = case $$p in \
$(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \
@ -116,6 +139,12 @@ am__nobase_list = $(am__nobase_strip_setup); \
am__base_list = \
sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \
sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g'
am__uninstall_files_from_dir = { \
test -z "$$files" \
|| { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \
|| { echo " ( cd '$$dir' && rm -f" $$files ")"; \
$(am__cd) "$$dir" && rm -f $$files; }; \
}
man1dir = $(mandir)/man1
am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man3dir)" \
"$(DESTDIR)$(man5dir)" "$(DESTDIR)$(man8dir)"
@ -130,6 +159,7 @@ ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AR = @AR@
ASCIIDOC = @ASCIIDOC@
ASPELL = @ASPELL@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
@ -156,6 +186,7 @@ DOC_BUILD_LIST = @DOC_BUILD_LIST@
DRIVER_BUILD_LIST = @DRIVER_BUILD_LIST@
DRIVER_INSTALL_TARGET = @DRIVER_INSTALL_TARGET@
DRIVER_MAN_LIST = @DRIVER_MAN_LIST@
DRVPATH = @DRVPATH@
DSYMUTIL = @DSYMUTIL@
DUMPBIN = @DUMPBIN@
ECHO_C = @ECHO_C@
@ -407,10 +438,13 @@ HTML_CGI_MANS = \
# Development (--with-dev) related manpages
SRC_DEV_PAGES = \
upsclient.txt \
upscli_add_host_cert.txt \
upscli_cleanup.txt \
upscli_connect.txt \
upscli_disconnect.txt \
upscli_fd.txt \
upscli_get.txt \
upscli_init.txt \
upscli_list_next.txt \
upscli_list_start.txt \
upscli_readline.txt \
@ -420,6 +454,13 @@ SRC_DEV_PAGES = \
upscli_ssl.txt \
upscli_strerror.txt \
upscli_upserror.txt \
libnutclient.txt \
libnutclient_commands.txt \
libnutclient_devices.txt \
libnutclient_general.txt \
libnutclient_misc.txt \
libnutclient_tcp.txt \
libnutclient_variables.txt \
nutscan.txt \
nutscan_scan_snmp.txt \
nutscan_scan_usb.txt \
@ -427,6 +468,7 @@ SRC_DEV_PAGES = \
nutscan_scan_nut.txt \
nutscan_scan_avahi.txt \
nutscan_scan_ipmi.txt \
nutscan_scan_eaton_serial.txt \
nutscan_display_ups_conf.txt \
nutscan_display_parsable.txt \
nutscan_cidr_to_ip.txt \
@ -435,15 +477,21 @@ SRC_DEV_PAGES = \
nutscan_add_option_to_device.txt \
nutscan_add_device_to_device.txt \
nutscan_init.txt \
nutscan_get_serial_ports_list.txt \
libupsclient-config.txt \
skel.txt
# NOTE: nutclient_*.3 has no source counterpart (libnutclient_*.txt)
MAN3_DEV_PAGES = \
upsclient.3 \
upscli_add_host_cert.3 \
upscli_cleanup.3 \
upscli_connect.3 \
upscli_disconnect.3 \
upscli_fd.3 \
upscli_get.3 \
upscli_init.3 \
upscli_list_next.3 \
upscli_list_start.3 \
upscli_readline.3 \
@ -453,6 +501,40 @@ MAN3_DEV_PAGES = \
upscli_ssl.3 \
upscli_strerror.3 \
upscli_upserror.3 \
libnutclient.3 \
libnutclient_commands.3 \
libnutclient_devices.3 \
libnutclient_general.3 \
libnutclient_misc.3 \
libnutclient_tcp.3 \
libnutclient_variables.3 \
nutclient_authenticate.3 \
nutclient_destroy.3 \
nutclient_device_forced_shutdown.3 \
nutclient_device_login.3 \
nutclient_device_master.3 \
nutclient_execute_device_command.3 \
nutclient_get_device_command_description.3 \
nutclient_get_device_commands.3 \
nutclient_get_device_description.3 \
nutclient_get_device_num_logins.3 \
nutclient_get_device_rw_variables.3 \
nutclient_get_devices.3 \
nutclient_get_device_variable_description.3 \
nutclient_get_device_variables.3 \
nutclient_get_device_variable_values.3 \
nutclient_has_device.3 \
nutclient_has_device_command.3 \
nutclient_has_device_variable.3 \
nutclient_logout.3 \
nutclient_set_device_variable_value.3 \
nutclient_set_device_variable_values.3 \
nutclient_tcp_create_client.3 \
nutclient_tcp_disconnect.3 \
nutclient_tcp_get_timeout.3 \
nutclient_tcp_is_connected.3 \
nutclient_tcp_reconnect.3 \
nutclient_tcp_set_timeout.3 \
nutscan.3 \
nutscan_scan_snmp.3 \
nutscan_scan_usb.3 \
@ -460,6 +542,7 @@ MAN3_DEV_PAGES = \
nutscan_scan_nut.3 \
nutscan_scan_avahi.3 \
nutscan_scan_ipmi.3 \
nutscan_scan_eaton_serial.3 \
nutscan_display_ups_conf.3 \
nutscan_display_parsable.3 \
nutscan_cidr_to_ip.3 \
@ -467,6 +550,7 @@ MAN3_DEV_PAGES = \
nutscan_free_device.3 \
nutscan_add_option_to_device.3 \
nutscan_add_device_to_device.3 \
nutscan_get_serial_ports_list.3 \
nutscan_init.3
MAN1_DEV_PAGES = \
@ -477,10 +561,13 @@ MAN1_DEV_PAGES = \
# WITH_DEV
HTML_DEV_MANS = \
upsclient.html \
upscli_add_host_cert.html \
upscli_cleanup.html \
upscli_connect.html \
upscli_disconnect.html \
upscli_fd.html \
upscli_get.html \
upscli_init.html \
upscli_list_next.html \
upscli_list_start.html \
upscli_readline.html \
@ -490,6 +577,13 @@ HTML_DEV_MANS = \
upscli_ssl.html \
upscli_strerror.html \
upscli_upserror.html \
libnutclient.html \
libnutclient_commands.html \
libnutclient_devices.html \
libnutclient_general.html \
libnutclient_misc.html \
libnutclient_tcp.html \
libnutclient_variables.html \
nutscan.html \
nutscan_scan_snmp.html \
nutscan_scan_usb.html \
@ -497,6 +591,7 @@ HTML_DEV_MANS = \
nutscan_scan_nut.html \
nutscan_scan_avahi.html \
nutscan_scan_ipmi.html \
nutscan_scan_eaton_serial.html \
nutscan_display_ups_conf.html \
nutscan_display_parsable.html \
nutscan_cidr_to_ip.html \
@ -504,6 +599,7 @@ HTML_DEV_MANS = \
nutscan_free_device.html \
nutscan_add_option_to_device.html \
nutscan_add_device_to_device.html \
nutscan_get_serial_ports_list.html \
nutscan_init.html \
libupsclient-config.html \
skel.html
@ -511,6 +607,7 @@ HTML_DEV_MANS = \
# (--with-serial)
@SOME_DRIVERS_FALSE@SRC_SERIAL_PAGES = \
@SOME_DRIVERS_FALSE@ al175.txt \
@SOME_DRIVERS_FALSE@ apcsmart.txt \
@SOME_DRIVERS_FALSE@ apcsmart-old.txt \
@SOME_DRIVERS_FALSE@ bcmxcp.txt \
@ -520,7 +617,8 @@ HTML_DEV_MANS = \
@SOME_DRIVERS_FALSE@ bestuferrups.txt \
@SOME_DRIVERS_FALSE@ bestups.txt \
@SOME_DRIVERS_FALSE@ bestfcom.txt \
@SOME_DRIVERS_FALSE@ blazer.txt \
@SOME_DRIVERS_FALSE@ blazer-common.txt \
@SOME_DRIVERS_FALSE@ blazer_ser.txt \
@SOME_DRIVERS_FALSE@ clone.txt \
@SOME_DRIVERS_FALSE@ dummy-ups.txt \
@SOME_DRIVERS_FALSE@ etapro.txt \
@ -537,18 +635,22 @@ HTML_DEV_MANS = \
@SOME_DRIVERS_FALSE@ mge-utalk.txt \
@SOME_DRIVERS_FALSE@ oneac.txt \
@SOME_DRIVERS_FALSE@ microdowell.txt \
@SOME_DRIVERS_FALSE@ nutdrv_qx.txt \
@SOME_DRIVERS_FALSE@ optiups.txt \
@SOME_DRIVERS_FALSE@ powercom.txt \
@SOME_DRIVERS_FALSE@ powerpanel.txt \
@SOME_DRIVERS_FALSE@ rhino.txt \
@SOME_DRIVERS_FALSE@ riello_ser.txt \
@SOME_DRIVERS_FALSE@ safenet.txt \
@SOME_DRIVERS_FALSE@ solis.txt \
@SOME_DRIVERS_FALSE@ tripplite.txt \
@SOME_DRIVERS_FALSE@ tripplitesu.txt \
@SOME_DRIVERS_FALSE@ upscode2.txt \
@SOME_DRIVERS_FALSE@ victronups.txt
@SOME_DRIVERS_FALSE@ victronups.txt \
@SOME_DRIVERS_FALSE@ apcupsd-ups.txt
@SOME_DRIVERS_FALSE@MAN_SERIAL_PAGES = \
@SOME_DRIVERS_FALSE@ al175.8 \
@SOME_DRIVERS_FALSE@ apcsmart.8 \
@SOME_DRIVERS_FALSE@ apcsmart-old.8 \
@SOME_DRIVERS_FALSE@ bcmxcp.8 \
@ -558,7 +660,7 @@ HTML_DEV_MANS = \
@SOME_DRIVERS_FALSE@ bestuferrups.8 \
@SOME_DRIVERS_FALSE@ bestups.8 \
@SOME_DRIVERS_FALSE@ bestfcom.8 \
@SOME_DRIVERS_FALSE@ blazer.8 \
@SOME_DRIVERS_FALSE@ blazer_ser.8 \
@SOME_DRIVERS_FALSE@ clone.8 \
@SOME_DRIVERS_FALSE@ dummy-ups.8 \
@SOME_DRIVERS_FALSE@ etapro.8 \
@ -573,20 +675,24 @@ HTML_DEV_MANS = \
@SOME_DRIVERS_FALSE@ metasys.8 \
@SOME_DRIVERS_FALSE@ mge-shut.8 \
@SOME_DRIVERS_FALSE@ mge-utalk.8 \
@SOME_DRIVERS_FALSE@ nutdrv_qx.8 \
@SOME_DRIVERS_FALSE@ oneac.8 \
@SOME_DRIVERS_FALSE@ microdowell.8 \
@SOME_DRIVERS_FALSE@ optiups.8 \
@SOME_DRIVERS_FALSE@ powercom.8 \
@SOME_DRIVERS_FALSE@ powerpanel.8 \
@SOME_DRIVERS_FALSE@ rhino.8 \
@SOME_DRIVERS_FALSE@ riello_ser.8 \
@SOME_DRIVERS_FALSE@ safenet.8 \
@SOME_DRIVERS_FALSE@ solis.8 \
@SOME_DRIVERS_FALSE@ tripplite.8 \
@SOME_DRIVERS_FALSE@ tripplitesu.8 \
@SOME_DRIVERS_FALSE@ upscode2.8 \
@SOME_DRIVERS_FALSE@ victronups.8
@SOME_DRIVERS_FALSE@ victronups.8 \
@SOME_DRIVERS_FALSE@ apcupsd-ups.8
@SOME_DRIVERS_FALSE@HTML_SERIAL_MANS = \
@SOME_DRIVERS_FALSE@ al175.html \
@SOME_DRIVERS_FALSE@ apcsmart.html \
@SOME_DRIVERS_FALSE@ apcsmart-old.html \
@SOME_DRIVERS_FALSE@ bcmxcp.html \
@ -596,7 +702,7 @@ HTML_DEV_MANS = \
@SOME_DRIVERS_FALSE@ bestuferrups.html \
@SOME_DRIVERS_FALSE@ bestups.html \
@SOME_DRIVERS_FALSE@ bestfcom.html \
@SOME_DRIVERS_FALSE@ blazer.html \
@SOME_DRIVERS_FALSE@ blazer_ser.html \
@SOME_DRIVERS_FALSE@ clone.html \
@SOME_DRIVERS_FALSE@ dummy-ups.html \
@SOME_DRIVERS_FALSE@ etapro.html \
@ -611,18 +717,21 @@ HTML_DEV_MANS = \
@SOME_DRIVERS_FALSE@ metasys.html \
@SOME_DRIVERS_FALSE@ mge-shut.html \
@SOME_DRIVERS_FALSE@ mge-utalk.html \
@SOME_DRIVERS_FALSE@ nutdrv_qx.html \
@SOME_DRIVERS_FALSE@ oneac.html \
@SOME_DRIVERS_FALSE@ microdowell.html \
@SOME_DRIVERS_FALSE@ optiups.html \
@SOME_DRIVERS_FALSE@ powercom.html \
@SOME_DRIVERS_FALSE@ powerpanel.html \
@SOME_DRIVERS_FALSE@ rhino.html \
@SOME_DRIVERS_FALSE@ riello_ser.html \
@SOME_DRIVERS_FALSE@ safenet.html \
@SOME_DRIVERS_FALSE@ solis.html \
@SOME_DRIVERS_FALSE@ tripplite.html \
@SOME_DRIVERS_FALSE@ tripplitesu.html \
@SOME_DRIVERS_FALSE@ upscode2.html \
@SOME_DRIVERS_FALSE@ victronups.html
@SOME_DRIVERS_FALSE@ victronups.html \
@SOME_DRIVERS_FALSE@ apcupsd-ups.html
# (--with-snmp)
@ -633,19 +742,29 @@ HTML_DEV_MANS = \
# (--with-usb)
@SOME_DRIVERS_FALSE@SRC_USB_LIBUSB_PAGES = \
@SOME_DRIVERS_FALSE@ bcmxcp_usb.txt \
@SOME_DRIVERS_FALSE@ blazer-common.txt \
@SOME_DRIVERS_FALSE@ blazer_usb.txt \
@SOME_DRIVERS_FALSE@ nutdrv_qx.txt \
@SOME_DRIVERS_FALSE@ richcomm_usb.txt \
@SOME_DRIVERS_FALSE@ riello_usb.txt \
@SOME_DRIVERS_FALSE@ tripplite_usb.txt \
@SOME_DRIVERS_FALSE@ usbhid-ups.txt
@SOME_DRIVERS_FALSE@MAN_USB_LIBUSB_PAGES = \
@SOME_DRIVERS_FALSE@ bcmxcp_usb.8 \
@SOME_DRIVERS_FALSE@ blazer_usb.8 \
@SOME_DRIVERS_FALSE@ nutdrv_qx.8 \
@SOME_DRIVERS_FALSE@ richcomm_usb.8 \
@SOME_DRIVERS_FALSE@ riello_usb.8 \
@SOME_DRIVERS_FALSE@ tripplite_usb.8 \
@SOME_DRIVERS_FALSE@ usbhid-ups.8
@SOME_DRIVERS_FALSE@HTML_USB_LIBUSB_MANS = \
@SOME_DRIVERS_FALSE@ bcmxcp_usb.html \
@SOME_DRIVERS_FALSE@ blazer_usb.html \
@SOME_DRIVERS_FALSE@ nutdrv_qx.html \
@SOME_DRIVERS_FALSE@ richcomm_usb.html \
@SOME_DRIVERS_FALSE@ riello_usb.html \
@SOME_DRIVERS_FALSE@ tripplite_usb.html \
@SOME_DRIVERS_FALSE@ usbhid-ups.html
@ -721,9 +840,13 @@ HTML_MANS = \
CLEANFILES = *.xml *.html
SUFFIXES = .txt .html .1 .3 .5 .8
### The --destination-dir flag doesn't seem to affect the intermediate .xml file.
### Hence, the copying dance below.
@HAVE_ASCIIDOC_TRUE@A2X_MANPAGE_OPTS = -f manpage --attribute nutversion="@PACKAGE_VERSION@"
### Prior to Asciidoc ~8.6.8, the --destination-dir flag didn't seem to affect the location of the intermediate .xml file.
@HAVE_ASCIIDOC_TRUE@A2X_MANPAGE_OPTS = --doctype manpage --format manpage \
@HAVE_ASCIIDOC_TRUE@ --attribute mansource="Network UPS Tools" \
@HAVE_ASCIIDOC_TRUE@ --attribute manversion="@PACKAGE_VERSION@" \
@HAVE_ASCIIDOC_TRUE@ --attribute manmanual="NUT Manual" \
@HAVE_ASCIIDOC_TRUE@ --destination-dir=.
all: all-am
.SUFFIXES:
@ -766,9 +889,18 @@ clean-libtool:
-rm -rf .libs _libs
install-man1: $(man1_MANS)
@$(NORMAL_INSTALL)
test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)"
@list='$(man1_MANS)'; test -n "$(man1dir)" || exit 0; \
{ for i in $$list; do echo "$$i"; done; \
@list1='$(man1_MANS)'; \
list2=''; \
test -n "$(man1dir)" \
&& test -n "`echo $$list1$$list2`" \
|| exit 0; \
echo " $(MKDIR_P) '$(DESTDIR)$(man1dir)'"; \
$(MKDIR_P) "$(DESTDIR)$(man1dir)" || exit 1; \
{ for i in $$list1; do echo "$$i"; done; \
if test -n "$$list2"; then \
for i in $$list2; do echo "$$i"; done \
| sed -n '/\.1[a-z]*$$/p'; \
fi; \
} | while read p; do \
if test -f $$p; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; echo "$$p"; \
@ -795,14 +927,21 @@ uninstall-man1:
files=`{ for i in $$list; do echo "$$i"; done; \
} | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
test -z "$$files" || { \
echo " ( cd '$(DESTDIR)$(man1dir)' && rm -f" $$files ")"; \
cd "$(DESTDIR)$(man1dir)" && rm -f $$files; }
dir='$(DESTDIR)$(man1dir)'; $(am__uninstall_files_from_dir)
install-man3: $(man3_MANS)
@$(NORMAL_INSTALL)
test -z "$(man3dir)" || $(MKDIR_P) "$(DESTDIR)$(man3dir)"
@list='$(man3_MANS)'; test -n "$(man3dir)" || exit 0; \
{ for i in $$list; do echo "$$i"; done; \
@list1='$(man3_MANS)'; \
list2=''; \
test -n "$(man3dir)" \
&& test -n "`echo $$list1$$list2`" \
|| exit 0; \
echo " $(MKDIR_P) '$(DESTDIR)$(man3dir)'"; \
$(MKDIR_P) "$(DESTDIR)$(man3dir)" || exit 1; \
{ for i in $$list1; do echo "$$i"; done; \
if test -n "$$list2"; then \
for i in $$list2; do echo "$$i"; done \
| sed -n '/\.3[a-z]*$$/p'; \
fi; \
} | while read p; do \
if test -f $$p; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; echo "$$p"; \
@ -829,14 +968,21 @@ uninstall-man3:
files=`{ for i in $$list; do echo "$$i"; done; \
} | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^3][0-9a-z]*$$,3,;x' \
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
test -z "$$files" || { \
echo " ( cd '$(DESTDIR)$(man3dir)' && rm -f" $$files ")"; \
cd "$(DESTDIR)$(man3dir)" && rm -f $$files; }
dir='$(DESTDIR)$(man3dir)'; $(am__uninstall_files_from_dir)
install-man5: $(man5_MANS)
@$(NORMAL_INSTALL)
test -z "$(man5dir)" || $(MKDIR_P) "$(DESTDIR)$(man5dir)"
@list='$(man5_MANS)'; test -n "$(man5dir)" || exit 0; \
{ for i in $$list; do echo "$$i"; done; \
@list1='$(man5_MANS)'; \
list2=''; \
test -n "$(man5dir)" \
&& test -n "`echo $$list1$$list2`" \
|| exit 0; \
echo " $(MKDIR_P) '$(DESTDIR)$(man5dir)'"; \
$(MKDIR_P) "$(DESTDIR)$(man5dir)" || exit 1; \
{ for i in $$list1; do echo "$$i"; done; \
if test -n "$$list2"; then \
for i in $$list2; do echo "$$i"; done \
| sed -n '/\.5[a-z]*$$/p'; \
fi; \
} | while read p; do \
if test -f $$p; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; echo "$$p"; \
@ -863,14 +1009,21 @@ uninstall-man5:
files=`{ for i in $$list; do echo "$$i"; done; \
} | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
test -z "$$files" || { \
echo " ( cd '$(DESTDIR)$(man5dir)' && rm -f" $$files ")"; \
cd "$(DESTDIR)$(man5dir)" && rm -f $$files; }
dir='$(DESTDIR)$(man5dir)'; $(am__uninstall_files_from_dir)
install-man8: $(man8_MANS)
@$(NORMAL_INSTALL)
test -z "$(man8dir)" || $(MKDIR_P) "$(DESTDIR)$(man8dir)"
@list='$(man8_MANS)'; test -n "$(man8dir)" || exit 0; \
{ for i in $$list; do echo "$$i"; done; \
@list1='$(man8_MANS)'; \
list2=''; \
test -n "$(man8dir)" \
&& test -n "`echo $$list1$$list2`" \
|| exit 0; \
echo " $(MKDIR_P) '$(DESTDIR)$(man8dir)'"; \
$(MKDIR_P) "$(DESTDIR)$(man8dir)" || exit 1; \
{ for i in $$list1; do echo "$$i"; done; \
if test -n "$$list2"; then \
for i in $$list2; do echo "$$i"; done \
| sed -n '/\.8[a-z]*$$/p'; \
fi; \
} | while read p; do \
if test -f $$p; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; echo "$$p"; \
@ -897,9 +1050,7 @@ uninstall-man8:
files=`{ for i in $$list; do echo "$$i"; done; \
} | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^8][0-9a-z]*$$,8,;x' \
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
test -z "$$files" || { \
echo " ( cd '$(DESTDIR)$(man8dir)' && rm -f" $$files ")"; \
cd "$(DESTDIR)$(man8dir)" && rm -f $$files; }
dir='$(DESTDIR)$(man8dir)'; $(am__uninstall_files_from_dir)
tags: TAGS
TAGS:
@ -967,10 +1118,15 @@ install-am: all-am
installcheck: installcheck-am
install-strip:
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
`test -z '$(STRIP)' || \
echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
if test -z '$(STRIP)'; then \
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
install; \
else \
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
"INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \
fi
mostlyclean-generic:
clean-generic:
@ -1083,20 +1239,16 @@ html-man: $(HTML_MANS) man-index.html
@HAVE_ASCIIDOC_TRUE@ -o $@ $<
@HAVE_ASCIIDOC_TRUE@.txt.1:
@HAVE_ASCIIDOC_TRUE@ test -f `basename $<` || cp -p $< .
@HAVE_ASCIIDOC_TRUE@ $(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
@HAVE_ASCIIDOC_TRUE@ $(A2X) $(A2X_MANPAGE_OPTS) $<
@HAVE_ASCIIDOC_TRUE@.txt.3:
@HAVE_ASCIIDOC_TRUE@ test -f `basename $<` || cp -p $< .
@HAVE_ASCIIDOC_TRUE@ $(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
@HAVE_ASCIIDOC_TRUE@ $(A2X) $(A2X_MANPAGE_OPTS) $<
@HAVE_ASCIIDOC_TRUE@.txt.5:
@HAVE_ASCIIDOC_TRUE@ test -f `basename $<` || cp -p $< .
@HAVE_ASCIIDOC_TRUE@ $(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
@HAVE_ASCIIDOC_TRUE@ $(A2X) $(A2X_MANPAGE_OPTS) $<
@HAVE_ASCIIDOC_TRUE@.txt.8:
@HAVE_ASCIIDOC_TRUE@ test -f `basename $<` || cp -p $< .
@HAVE_ASCIIDOC_TRUE@ $(A2X) $(A2X_MANPAGE_OPTS) `basename $<`
@HAVE_ASCIIDOC_TRUE@ $(A2X) $(A2X_MANPAGE_OPTS) $<
@HAVE_ASCIIDOC_FALSE@.txt.html:
@HAVE_ASCIIDOC_FALSE@ @echo "Not (re)building $@ manual page, since 'asciidoc' was not found."

187
docs/man/al175.8 Normal file
View file

@ -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/

73
docs/man/al175.txt Normal file
View file

@ -0,0 +1,73 @@
AL175(8)
========
NAME
----
al175 - Driver for Eltek UPS models with AL175 alarm module
NOTE
----
This man page only documents the hardware-specific features of the
*al175* driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
The *al175* driver is known to work with the following UPSes:
Eltek MPSU4000 with AL175 alarm module
It may also work with other UPSes equiped with AL175 alarm module,
but they have not been tested.
AL175 have to be configured to operate in COMLI mode.
See documentation supplied with your hardware on how to do it.
EXTRA ARGUMENTS
---------------
This driver does not support any extra settings in the
linkman:ups.conf[5].
INSTANT COMMANDS
----------------
This driver supports some extra commands (see linkman:upscmd[8]):
*test.battery.start*::
Start a battery test.
*test.battery.stop*::
Stop a battery test.
VARIABLES
---------
Besides status, this driver reads UPS state into following variables:
- *ups.test.result*
- *output.voltage.nominal*
- *output.current*
- *battery.voltage.nominal*
- *battery.current*
- *battery.temperature*
- *input.transfer.boost.low*
KNOWN ISSUES AND BUGS
---------------------
* Shutdown is not supported. FIXME
* The driver was reworked to meet the project code quality criteria, without
testing on real hardware. Some bugs may have crept in.
AUTHOR
------
Kirill Smelkov <kirr@mns.spb.ru>
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
Internet resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

8
docs/man/apcsmart-old.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: apcsmart-old
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "APCSMART\-OLD" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "APCSMART\-OLD" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

36
docs/man/apcsmart.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: apcsmart
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 10/30/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "APCSMART" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "APCSMART" "8" "10/30/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -133,6 +133,31 @@ You can specify alternate cable in \fBups.conf\fR(5):
Alternatively, you can also provide it on the command line using:
.sp
\-x \fBcable\fR=940\-0095B
.SH "TTY MODES"
.sp
By default the driver works in canonical mode, but it showed to be a problem in windows systems\&. Furthermore there\(cqs a possibility of some obscure serial cards or serial\-usb convertes that could cause problems as well\&. You can use \*(Aqttymode=\*(Aq option to force non\-canonical discipline in \fBups.conf\fR(5):
.sp
\fBttymode\fR=raw
.sp
Alternatively, you can also provide it on the command line using:
.sp
\-x \fBttymode\fR=raw
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
Any other value will make the driver work in the canonical mode\&.
.sp .5v
.RE
.SH "EXPLANATION OF SHUTDOWN METHODS SUPPORTED BY APC UPSES"
.sp
APC hardware supports a lot of shutdown methods, that themselves can differ in behaviour quite a bit, depending on the model\&.
@ -508,6 +533,9 @@ calibrate\&.start
.\}
calibrate\&.stop
.RE
.SH "PREVIOUS DRIVER VERSION"
.sp
Previous driver is still available as apcsmart\-old \- should there be any need to use earlier version (bugs, incompatiblities with new functionality, etc\&.)\&. In due time apcsmart\-old will be phased out completely, but this won\(cqt happen until the new version gets solid exposure with no pending issues\&.
.SH "BUGS"
.sp
Some older APC UPS models return bogus data in the status register during a front panel test\&. This is usually detected and discarded, but some other unexpected values have occasionally slipped through\&.

24
docs/man/apcsmart.txt
View file

@ -89,6 +89,22 @@ Alternatively, you can also provide it on the command line using:
-x *cable*=940-0095B
TTY MODES
---------
By default the driver works in canonical mode, but it showed to be a problem in
windows systems. Furthermore there's a possibility of some obscure serial cards
or serial-usb convertes that could cause problems as well. You can use
\'ttymode=' option to force non-canonical discipline in linkman:ups.conf[5]:
*ttymode*=raw
Alternatively, you can also provide it on the command line using:
-x *ttymode*=raw
NOTE: Any other value will make the driver work in the canonical mode.
EXPLANATION OF SHUTDOWN METHODS SUPPORTED BY APC UPSES
------------------------------------------------------
@ -316,6 +332,14 @@ Other supported commands:
- calibrate.start
- calibrate.stop
PREVIOUS DRIVER VERSION
-----------------------
Previous driver is still available as apcsmart-old - should there be any need to
use earlier version (bugs, incompatiblities with new functionality, etc.). In
due time apcsmart-old will be phased out completely, but this won't happen until
the new version gets solid exposure with no pending issues.
BUGS
----

357
docs/man/apcupsd-ups.8 Normal file
View file

@ -0,0 +1,357 @@
'\" t
.\" Title: apcupsd-ups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/18/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre2
.\" Language: English
.\"
.TH "APCUPSD\-UPS" "8" "11/18/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
apcupsd-ups \- Driver for apcupsd client access
.SH "NOTE"
.sp
This man page only documents the specific features of the \fBapcupsd\-ups\fR driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "DESCRIPTION"
.sp
This driver is a client to \fBapcupsd\fR\&.
.sp
\fBapcupsd\-ups\fR acts as an \fBapcupsd\fR client, simply forwarding data\&. This can be useful in cases where both protocols are required in a network, or in case apcupsd has a required UPS access mode missing from NUT\&.
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional settings in \fBnut.conf\fR(5):
.PP
\fBport\fR=<hostname>[:<port>]
.RS 4
This is the name of a remote host running apcupsd (plus an optional port)\&.
.RE
.sp
For instance:
.sp
.if n \{\
.RS 4
.\}
.nf
[apcupsd]
driver = apcupsd\-ups
port = localhost
desc = "apcupsd client"
.fi
.if n \{\
.RE
.\}
.SH "BACKGROUND"
.sp
This driver was originally written in one evening to allow interworking with \fBapcupsd\fR\&.
.SH "SUPPORTED VARIABLES"
.sp
The following variables are translated from \fBapcupsd\fR to NUT\&. All times should be converted to seconds (please file a bug if you notice a mismatch in units)\&.
.TS
allbox tab(:);
ltB ltB.
T{
apcupsd variable
T}:T{
NUT variable(s)
T}
.T&
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt.
T{
.sp
BCHARGE
T}:T{
.sp
battery\&.charge
T}
T{
.sp
MBATTCHG
T}:T{
.sp
battery\&.charge\&.low
T}
T{
.sp
RETPCT
T}:T{
.sp
battery\&.charge\&.restart
T}
T{
.sp
BATTDATE
T}:T{
.sp
battery\&.date
T}
T{
.sp
TIMELEFT
T}:T{
.sp
battery\&.runtime
T}
T{
.sp
MINTIMEL
T}:T{
.sp
battery\&.runtime\&.low
T}
T{
.sp
BATTV
T}:T{
.sp
battery\&.voltage
T}
T{
.sp
NOMBATTV
T}:T{
.sp
battery\&.voltage\&.nominal
T}
T{
.sp
LINEFREQ
T}:T{
.sp
input\&.frequency
T}
T{
.sp
SENSE
T}:T{
.sp
input\&.sensitivity
T}
T{
.sp
HITRANS
T}:T{
.sp
input\&.transfer\&.high
T}
T{
.sp
LOTRANS
T}:T{
.sp
input\&.transfer\&.low
T}
T{
.sp
LASTXFER
T}:T{
.sp
input\&.transfer\&.reason
T}
T{
.sp
LINEV
T}:T{
.sp
input\&.voltage
T}
T{
.sp
MAXLINEV
T}:T{
.sp
input\&.voltage\&.maximum
T}
T{
.sp
MINLINEV
T}:T{
.sp
input\&.voltage\&.minimum
T}
T{
.sp
NOMINV
T}:T{
.sp
input\&.voltage\&.nominal
T}
T{
.sp
LINEFREQ
T}:T{
.sp
output\&.frequency
T}
T{
.sp
OUTPUTV
T}:T{
.sp
output\&.voltage
T}
T{
.sp
NOMOUTV
T}:T{
.sp
output\&.voltage\&.nominal
T}
T{
.sp
DATE
T}:T{
.sp
ups\&.date, ups\&.time
T}
T{
.sp
DSHUTD
T}:T{
.sp
ups\&.delay\&.shutdown
T}
T{
.sp
DWAKE
T}:T{
.sp
ups\&.delay\&.start
T}
T{
.sp
FIRMWARE
T}:T{
.sp
ups\&.firmware, ups\&.firmware\&.aux
T}
T{
.sp
UPSNAME
T}:T{
.sp
ups\&.id
T}
T{
.sp
LOADPCT
T}:T{
.sp
ups\&.load
T}
T{
.sp
MANDATE
T}:T{
.sp
ups\&.mfr\&.date
T}
T{
.sp
NOMPOWER
T}:T{
.sp
ups\&.realpower\&.nominal
T}
T{
.sp
SERIALNO
T}:T{
.sp
ups\&.serial
T}
T{
.sp
STATUS
T}:T{
.sp
ups\&.status
T}
T{
.sp
ITEMP
T}:T{
.sp
ups\&.temperature
T}
T{
.sp
STESTI
T}:T{
.sp
ups\&.test\&.interval
T}
T{
.sp
SELFTEST
T}:T{
.sp
ups\&.test\&.result
T}
.TE
.sp 1
.SH "LIMITATIONS"
.sp
Access to \fBapcupsd\fR is strictly read only: no commands can be issued\&. This stems from the design of \fBapcupsd\fR, where the settings are changed in \fBapctest\fR\&. In order to run \fBapctest\fR, \fBapcupsd\fR must be stopped (and \fBapcupsd\fR exposes the UPS to the network)\&.
.SH "AUTHOR"
.sp
Andreas Steinmetz
.SH "SEE ALSO"
.sp
\fBups.conf\fR(5), \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/

107
docs/man/apcupsd-ups.txt Normal file
View file

@ -0,0 +1,107 @@
APCUPSD-UPS(8)
==============
NAME
----
apcupsd-ups - Driver for apcupsd client access
NOTE
----
This man page only documents the specific features of the
*apcupsd-ups* driver. For information about the core driver, see
linkman:nutupsdrv[8].
DESCRIPTION
-----------
This driver is a client to *apcupsd*.
*apcupsd-ups* acts as an *apcupsd* client, simply forwarding data.
This can be useful in cases where both protocols are required in a network,
or in case apcupsd has a required UPS access mode missing from NUT.
EXTRA ARGUMENTS
---------------
This driver supports the following optional settings in linkman:nut.conf[5]:
*port*=<hostname>[:<port>]::
This is the name of a remote host running apcupsd (plus an optional port).
For instance:
[apcupsd]
driver = apcupsd-ups
port = localhost
desc = "apcupsd client"
BACKGROUND
----------
This driver was originally written in one evening to allow interworking with *apcupsd*.
SUPPORTED VARIABLES
-------------------
The following variables are translated from *apcupsd* to NUT. All times should be
converted to seconds (please file a bug if you notice a mismatch in units).
[width="50%",cols="m,m",options="header"]
|===============================
| apcupsd variable | NUT variable(s)
| BCHARGE | battery.charge
| MBATTCHG | battery.charge.low
| RETPCT | battery.charge.restart
| BATTDATE | battery.date
| TIMELEFT | battery.runtime
| MINTIMEL | battery.runtime.low
| BATTV | battery.voltage
| NOMBATTV | battery.voltage.nominal
| LINEFREQ | input.frequency
| SENSE | input.sensitivity
| HITRANS | input.transfer.high
| LOTRANS | input.transfer.low
| LASTXFER | input.transfer.reason
| LINEV | input.voltage
| MAXLINEV | input.voltage.maximum
| MINLINEV | input.voltage.minimum
| NOMINV | input.voltage.nominal
| LINEFREQ | output.frequency
| OUTPUTV | output.voltage
| NOMOUTV | output.voltage.nominal
| DATE | ups.date, ups.time
| DSHUTD | ups.delay.shutdown
| DWAKE | ups.delay.start
| FIRMWARE | ups.firmware, ups.firmware.aux
| UPSNAME | ups.id
| LOADPCT | ups.load
| MANDATE | ups.mfr.date
| NOMPOWER | ups.realpower.nominal
| SERIALNO | ups.serial
| STATUS | ups.status
| ITEMP | ups.temperature
| STESTI | ups.test.interval
| SELFTEST | ups.test.result
|===============================
LIMITATIONS
-----------
Access to *apcupsd* is strictly read only: no commands can be issued. This
stems from the design of *apcupsd*, where the settings are changed in
*apctest*. In order to run *apctest*, *apcupsd* must be stopped (and *apcupsd*
exposes the UPS to the network).
AUTHOR
------
Andreas Steinmetz
SEE ALSO
--------
linkman:ups.conf[5],
linkman:nutupsdrv[8]
Internet Resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
The apcupsd home page: http://www.apcupsd.org/

21
docs/man/asciidoc.conf
View file

@ -23,24 +23,3 @@ ifdef::backend-xhtml11[]
[linkman-inlinemacro]
<a href="{target}.html">{target}{0?({0})}</a>
endif::backend-xhtml11[]
# Meta info for a2x manpage conversion:
ifdef::doctype-manpage[]
ifdef::backend-docbook[]
[header]
template::[header-declarations]
<refentry>
<refmeta>
<refentrytitle>{mantitle}</refentrytitle>
<manvolnum>{manvolnum}</manvolnum>
<refmiscinfo class="source">Network UPS Tools</refmiscinfo>
<refmiscinfo class="version">{nut_version}</refmiscinfo>
<refmiscinfo class="manual">NUT Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>{manname}</refname>
<refpurpose>{manpurpose}</refpurpose>
</refnamediv>
endif::backend-docbook[]
endif::doctype-manpage[]

8
docs/man/bcmxcp.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: bcmxcp
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "BCMXCP" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BCMXCP" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/bcmxcp_usb.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: bcmxcp_usb
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "BCMXCP_USB" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BCMXCP_USB" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/belkin.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: belkin
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "BELKIN" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BELKIN" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/belkinunv.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: belkinunv
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "BELKINUNV" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BELKINUNV" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/bestfcom.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: bestfcom
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "BESTFCOM" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BESTFCOM" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/bestfortress.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: bestfortress
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "BESTFORTRESS" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BESTFORTRESS" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/bestuferrups.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: bestuferrups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "BESTUFERRUPS" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BESTUFERRUPS" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/bestups.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: bestups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "BESTUPS" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BESTUPS" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

55
docs/man/blazer.txt → docs/man/blazer-common.txt
View file

@ -1,17 +1,10 @@
BLAZER(8)
=========
NAME
----
blazer - Driver for Megatec/Q1 protocol serial (blazer_ser) and USB (blazer_usb) based UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
blazer driver. For information about the core driver, see
linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
@ -24,6 +17,7 @@ but haven't been tested.
All devices with a serial interface (use the *blazer_ser* driver) and
many with a USB interface (use the *blazer_usb* driver) are supported.
EXTRA ARGUMENTS
---------------
@ -61,13 +55,13 @@ somehow, you may want to override this value.
Time to wait before switching on the UPS (minutes). Note that a value below 3
minutes, may cause earlier firmware versions to not switch on automatically,
so it defaults to 3 minutes.
so it defaults to 3 minutes. The acceptable range is +0..9999+ minutes.
*offdelay =* 'value'::
Time to wait before shutting down the UPS (seconds). This value is truncated
to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60
seconds). Defaults to 30 seconds.
seconds). Defaults to 30 seconds. The acceptable range is +12..600+ seconds.
*norating*::
@ -111,8 +105,10 @@ Minimum battery load used by the driver to estimate the runtime. If not
specified, the driver defaults to 10%. Only used if *runtimecal* is also
specified.
ifndef::blazer_usb[]
SERIAL INTERFACE ONLY
---------------------
~~~~~~~~~~~~~~~~~~~~~
*cablepower =* 'string'::
@ -120,9 +116,12 @@ By default the driver will set DTR and clear RTS ('normal'). If you find that
your UPS isn't detected or the communication with the UPS is unreliable, you may
try if clear DTR and set RTS ('reverse'), set DTR and RTS ('both') or
clear DTR and RTS ('none') improves this situation.
endif::blazer_usb[]
ifdef::blazer_usb[]
USB INTERFACE ONLY
------------------
~~~~~~~~~~~~~~~~~~
*vendorid =* 'regex'::
*productid =* 'regex'::
@ -136,14 +135,12 @@ USB. Each option specifies an extended regular expression (see
string (minus any surrounding whitespace), or the whole 4-digit
hexadecimal code for vendorid and productid. Try *-DD* for
finding out the strings to match.
+
Examples:
-x vendor="Foo.Corporation.*"
-x vendorid=051d # (APC)
-x product=".*(Smart|Back)-?UPS.*"
- `-x vendor="Foo.Corporation.*"`
- `-x vendorid=051d*` (APC)
- `-x product=".*(Smart|Back)-?UPS.*"`
*bus =* 'regex'::
@ -163,6 +160,7 @@ Apply the language ID workaround to the krauler subdriver. This is mandatory
for some devices to work (LDLC, Dynamix and others). You must to provide
*value* (0x409 or 0x4095), according to your device entry in NUT hardware
compatibility list (HCL).
endif::blazer_usb[]
UPS COMMANDS
@ -182,12 +180,12 @@ Turn on the load immediately.
Turn off the load immediately (see <<_known_problems,KNOWN PROBLEMS>>).
*shutdown.return* ['value']::
*shutdown.return*::
Turn off the load and return when power is back. Uses the timers defined by
*ondelay* and *offdelay*.
*shutdown.stayoff* ['value']::
*shutdown.stayoff*::
Turn off the load and remain off (see <<_known_problems,KNOWN PROBLEMS>>). Uses
the timer defined by *offdelay*.
@ -206,13 +204,13 @@ Perform a (10 second) battery test.
*test.battery.start* 'value'::
Perform a battery test for the duration of 'value' seconds (truncated to units of
60 seconds).
Perform a battery test for the duration of 'value' minutes.
*test.battery.stop*::
Stop a running battery test (not available on some hardware.)
BATTERY CHARGE
--------------
@ -253,6 +251,7 @@ linkman:ups.conf[5], so don't complain with the author. If you need something be
buy a UPS that reports *battery.charge* and *battery.runtime* all by itself
without the help of a NUT driver.
NOTES FOR THE PREVIOUS USER OF MEGATEC DRIVERS
----------------------------------------------
@ -274,6 +273,7 @@ You need to use 'cablepower'
This parameter can simply be discarded, since it was a wrong understanding
of the specification.
KNOWN PROBLEMS
--------------
@ -292,19 +292,30 @@ in the status reported by the driver when, in fact, it is working fine.
The temperature and load value is known to be bogus in some models.
AUTHORS
-------
Arjen de Korte <adkorte-guest at alioth.debian.org>,
Alexander Gordeev <lasaine at lvk.cs.msu.su>
SEE ALSO
--------
ifdef::blazer_usb[]
linkman:blazer_ser[8],
endif::blazer_usb[]
ifndef::blazer_usb[]
linkman:blazer_usb[8],
endif::blazer_usb[]
linkman:nutupsdrv[8], linkman:upsc[8], linkman:upscmd[8], linkman:upsrw[8]
Internet Resources:
~~~~~~~~~~~~~~~~~~~
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
The NUT HCL: http://www.networkupstools.org/stable-hcl.html

271
docs/man/blazer_ser.8 Normal file
View file

@ -0,0 +1,271 @@
'\" t
.\" Title: blazer_ser
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/17/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "BLAZER_SER" "8" "11/17/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
blazer_ser \- Driver for Megatec/Q1 protocol serial based UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the blazer driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
The blazer driver is known to work with various UPSes from Blazer, Energy Sistem, Fenton Technologies, General Electric, 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\(cqt been tested\&.
.sp
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\&.
.SH "EXTRA ARGUMENTS"
.sp
You may need to override or provide defaults for some values, depending on the make and model of your UPS\&. The following are the ones that most likely will need changing (see \fBups.conf\fR(5)):
.PP
\fBdefault\&.battery\&.voltage\&.high =\fR \fIvalue\fR
.RS 4
Maximum battery voltage that is reached after about 12 to 24 hours charging\&. If you want the driver to report a guesstimated
\fBbattery\&.charge\fR, you need to specify this (see
BATTERY CHARGE)\&.
.RE
.PP
\fBdefault\&.battery\&.voltage\&.low =\fR \fIvalue\fR
.RS 4
Minimum battery voltage just before the UPS automatically shuts down\&. If you want the driver to report a guesstimated
\fBbattery\&.charge\fR, you need to specify this (see
BATTERY CHARGE)\&.
.RE
.PP
\fBdefault\&.battery\&.voltage\&.nominal =\fR \fIvalue\fR, \fBoverride\&.battery\&.voltage\&.nominal =\fR \fIvalue\fR
.RS 4
Some devices show a wrong nominal battery voltage (or none at all), so you may need to override or set a default value\&.
.RE
.PP
\fBoverride\&.battery\&.packs =\fR \fIvalue\fR
.RS 4
Some devices report a part of the total battery voltage\&. For instance, if
\fBbattery\&.voltage\&.nominal\fR
is 24 V, but it reports a
\fBbattery\&.voltage\fR
of around 2 V, the number of
\fBbattery\&.packs\fR
to correct this reading would be 12\&. The driver will attempt to detect this automatically, but if this fails somehow, you may want to override this value\&.
.RE
.PP
\fBondelay =\fR \fIvalue\fR
.RS 4
Time to wait before switching on the UPS (minutes)\&. Note that a value below 3 minutes, may cause earlier firmware versions to not switch on automatically, so it defaults to 3 minutes\&. The acceptable range is
0\&.\&.9999
minutes\&.
.RE
.PP
\fBoffdelay =\fR \fIvalue\fR
.RS 4
Time to wait before shutting down the UPS (seconds)\&. This value is truncated to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60 seconds)\&. Defaults to 30 seconds\&. The acceptable range is
12\&.\&.600
seconds\&.
.RE
.PP
\fBnorating\fR
.RS 4
Some UPSes will lock up if you attempt to read rating information from them\&. Setting this flag will make the driver skip this step\&.
.RE
.PP
\fBnovendor\fR
.RS 4
Some UPSes will lock up if you attempt to read vendor information from them\&. Setting this flag will make the driver skip this step\&.
.RE
.PP
\fBprotocol =\fR \fIstring\fR
.RS 4
Skip autodetection of the protocol to use and only use the one specified\&. Supported values
\fImegatec\fR,
\fImegatec/old\fR,
\fImustek\fR
and
\fIzinto\fR\&.
.RE
.PP
\fBruntimecal =\fR \fIvalue,value,value,value\fR
.RS 4
Parameter used in the (optional) runtime estimation\&. This takes two runtimes at different loads\&. Typically, this uses the runtime at full load and the runtime at half load\&. For instance, if your UPS has a rated runtime of 240 seconds at full load and 720 seconds at half load, you would enter
.sp
.if n \{\
.RS 4
.\}
.nf
runtimecal = 240,100,720,50
.fi
.if n \{\
.RE
.\}
.sp
The first load should always be higher than the second\&. If you have values available for loads other than 100 and 50 % respectively, you can use those too, but keep them spaced apart as far as reasonably possible\&. Just don\(cqt get too close to no load (prediction of runtime depends more on idle load for the battery then)\&.
.RE
.PP
\fBchargetime =\fR \fIvalue\fR
.RS 4
The time needed to fully recharge the battery after being fully discharged\&. If not specified, the driver defaults to 43200 seconds (12 hours)\&. Only used if
\fBruntimecal\fR
is also specified\&.
.RE
.PP
\fBidleload =\fR \fIvalue\fR
.RS 4
Minimum battery load used by the driver to estimate the runtime\&. If not specified, the driver defaults to 10%\&. Only used if
\fBruntimecal\fR
is also specified\&.
.RE
.SS "SERIAL INTERFACE ONLY"
.PP
\fBcablepower =\fR \fIstring\fR
.RS 4
By default the driver will set DTR and clear RTS (\fInormal\fR)\&. If you find that your UPS isn\(cqt detected or the communication with the UPS is unreliable, you may try if clear DTR and set RTS (\fIreverse\fR), set DTR and RTS (\fIboth\fR) or clear DTR and RTS (\fInone\fR) improves this situation\&.
.RE
.SH "UPS COMMANDS"
.sp
This driver supports some instant commands (see \fBupscmd\fR(8)):
.PP
\fBbeeper\&.toggle\fR
.RS 4
Toggle the UPS beeper\&. (Not available on some hardware\&.)
.RE
.PP
\fBload\&.on\fR
.RS 4
Turn on the load immediately\&.
.RE
.PP
\fBload\&.off\fR
.RS 4
Turn off the load immediately (see
KNOWN PROBLEMS)\&.
.RE
.PP
\fBshutdown\&.return\fR
.RS 4
Turn off the load and return when power is back\&. Uses the timers defined by
\fBondelay\fR
and
\fBoffdelay\fR\&.
.RE
.PP
\fBshutdown\&.stayoff\fR
.RS 4
Turn off the load and remain off (see
KNOWN PROBLEMS)\&. Uses the timer defined by
\fBoffdelay\fR\&.
.RE
.PP
\fBshutdown\&.stop\fR
.RS 4
Stop a shutdown in progress\&.
.RE
.PP
\fBtest\&.battery\&.start\&.deep\fR
.RS 4
Perform a long battery test (Not available on some hardware\&.)
.RE
.PP
\fBtest\&.battery\&.start\&.quick\fR
.RS 4
Perform a (10 second) battery test\&.
.RE
.PP
\fBtest\&.battery\&.start\fR \fIvalue\fR
.RS 4
Perform a battery test for the duration of
\fIvalue\fR
minutes\&.
.RE
.PP
\fBtest\&.battery\&.stop\fR
.RS 4
Stop a running battery test (not available on some hardware\&.)
.RE
.SH "BATTERY CHARGE"
.sp
Due to popular demand, this driver will report a guesstimated \fBbattery\&.charge\fR and optionally \fBbattery\&.runtime\fR, provided you specified a couple of the EXTRA ARGUMENTS listed above\&.
.sp
If you specify both \fBbattery\&.voltage\&.high\fR and \fBbattery\&.voltage\&.low\fR in \fBups.conf\fR(5), but don\(cqt enter \fBruntimecal\fR, it will guesstimate the state of charge by looking at the battery voltage alone\&. This is not reliable under load, as this only gives reasonably accurate readings if you disconnect the load, let the battery rest for a couple of minutes and then measure the open cell voltage\&. This just isn\(cqt practical if the power went out and the UPS is providing power for your systems\&.
.sp
.if n \{\
.RS 4
.\}
.nf
battery\&.voltage \- battery\&.voltage\&.low
battery\&.charge = \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- x 100 %
battery\&.voltage\&.high \- battery\&.voltage\&.low
.fi
.if n \{\
.RE
.\}
.sp
There is a way to get better readings without disconnecting the load but this requires one to keep track on how much (and how fast) current is going in\- and out of the battery\&. If you specified the \fBruntimecal\fR, the driver will attempt to do this\&. Note however, that this heavily relies on the values you enter and that the UPS must be able to report the load as well\&. There are quite a couple of devices that report 0 % (or any other fixed value) at all times, in which case this obviously doesn\(cqt work\&.
.sp
The driver also has no way of determining the degradation of the battery capacity over time, so you\(cqll have to deal with this yourself (by adjusting the values in \fBruntimecal\fR)\&. Also note that the driver guesses the initial state of charge based on the battery voltage, so this may be less than 100 %, even when you are certain that they are full\&. There is just no way to reliably measure this between 0 and 100 % full charge\&.
.sp
This is better than nothing (but not by much)\&. If any of the above calculations is giving you incorrect readings, you are the one that put in the values in \fBups.conf\fR(5), so don\(cqt complain with the author\&. If you need something better, buy a UPS that reports \fBbattery\&.charge\fR and \fBbattery\&.runtime\fR all by itself without the help of a NUT driver\&.
.SH "NOTES FOR THE PREVIOUS USER OF MEGATEC DRIVERS"
.sp
The blazer drivers having replaced the megatec ones, some configuration changes may be required by users switching to blazer\&.
.sp
Part of this, the following megatec options, in ups\&.conf, have to be changed:
.PP
\fBbattvolts\fR
.RS 4
You need to use
\fIdefault\&.battery\&.voltage\&.high\fR
and
\fIdefault\&.battery\&.voltage\&.low\fR
.RE
.PP
\fBdtr and rts\fR
.RS 4
You need to use
\fIcablepower\fR
.RE
.PP
\fBignoreoff\fR
.RS 4
This parameter can simply be discarded, since it was a wrong understanding of the specification\&.
.RE
.SH "KNOWN PROBLEMS"
.sp
Some UPS commands aren\(cqt supported by all models\&. In most cases, the driver will send a message to the system log when the user tries to execute an unsupported command\&. Unfortunately, some models don\(cqt even provide a way for the driver to check for this, so the unsupported commands will silently fail\&.
.sp
Both the \fBload\&.off\fR and \fBshutdown\&.stayoff\fR instant commands are meant to turn the load off indefinitely\&. However, some UPS models don\(cqt allow this\&.
.sp
Some models report a bogus value for the beeper status (will always be \fIenabled\fR or \fIdisabled\fR)\&. So, the \fBbeeper\&.toggle\fR command may appear to have no effect in the status reported by the driver when, in fact, it is working fine\&.
.sp
The temperature and load value is known to be bogus in some models\&.
.SH "AUTHORS"
.sp
Arjen de Korte <adkorte\-guest at alioth\&.debian\&.org>, Alexander Gordeev <lasaine at lvk\&.cs\&.msu\&.su>
.SH "SEE ALSO"
.sp
\fBblazer_usb\fR(8), \fBnutupsdrv\fR(8), \fBupsc\fR(8), \fBupscmd\fR(8), \fBupsrw\fR(8)
.SS "Internet Resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/
.sp
The NUT HCL: http://www\&.networkupstools\&.org/stable\-hcl\&.html

10
docs/man/blazer_ser.txt Normal file
View file

@ -0,0 +1,10 @@
BLAZER_SER(8)
=============
:blazer_usb!:
NAME
----
blazer_ser - Driver for Megatec/Q1 protocol serial based UPS equipment
include::blazer-common.txt[]

81
docs/man/blazer.8 → docs/man/blazer_usb.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: blazer
.\" Title: blazer_usb
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/18/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.7.1-pre2
.\" Language: English
.\"
.TH "BLAZER" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "BLAZER_USB" "8" "11/18/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
blazer \- Driver for Megatec/Q1 protocol serial (blazer_ser) and USB (blazer_usb) based UPS equipment
blazer_usb \- Driver for Megatec/Q1 protocol USB based UPS equipment
.SH "NOTE"
.sp
This man page only documents the hardware\-specific features of the blazer driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
@ -73,12 +73,16 @@ to correct this reading would be 12\&. The driver will attempt to detect this au
.PP
\fBondelay =\fR \fIvalue\fR
.RS 4
Time to wait before switching on the UPS (minutes)\&. Note that a value below 3 minutes, may cause earlier firmware versions to not switch on automatically, so it defaults to 3 minutes\&.
Time to wait before switching on the UPS (minutes)\&. Note that a value below 3 minutes, may cause earlier firmware versions to not switch on automatically, so it defaults to 3 minutes\&. The acceptable range is
0\&.\&.9999
minutes\&.
.RE
.PP
\fBoffdelay =\fR \fIvalue\fR
.RS 4
Time to wait before shutting down the UPS (seconds)\&. This value is truncated to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60 seconds)\&. Defaults to 30 seconds\&.
Time to wait before shutting down the UPS (seconds)\&. This value is truncated to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60 seconds)\&. Defaults to 30 seconds\&. The acceptable range is
12\&.\&.600
seconds\&.
.RE
.PP
\fBnorating\fR
@ -131,13 +135,7 @@ Minimum battery load used by the driver to estimate the runtime\&. If not specif
\fBruntimecal\fR
is also specified\&.
.RE
.SH "SERIAL INTERFACE ONLY"
.PP
\fBcablepower =\fR \fIstring\fR
.RS 4
By default the driver will set DTR and clear RTS (\fInormal\fR)\&. If you find that your UPS isn\(cqt detected or the communication with the UPS is unreliable, you may try if clear DTR and set RTS (\fIreverse\fR), set DTR and RTS (\fIboth\fR) or clear DTR and RTS (\fInone\fR) improves this situation\&.
.RE
.SH "USB INTERFACE ONLY"
.SS "USB INTERFACE ONLY"
.PP
\fBvendorid =\fR \fIregex\fR, \fBproductid =\fR \fIregex\fR, \fBvendor =\fR \fIregex\fR, \fBproduct =\fR \fIregex\fR, \fBserial =\fR \fIregex\fR
.RS 4
@ -145,39 +143,46 @@ Select a specific UPS, in case there is more than one connected via USB\&. Each
\fBregex(7)\fR) that must match the UPS\(cqs entire vendor/product/serial string (minus any surrounding whitespace), or the whole 4\-digit hexadecimal code for vendorid and productid\&. Try
\fB\-DD\fR
for finding out the strings to match\&.
.RE
.sp
Examples:
.sp
.if n \{\
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.nf
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-x vendor="Foo\&.Corporation\&.*"
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.nf
\-x vendorid=051d # (APC)
.fi
.if n \{\
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-x vendorid=051d*
(APC)
.RE
.\}
.sp
.if n \{\
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.nf
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-x product="\&.*(Smart|Back)\-?UPS\&.*"
.fi
.if n \{\
.RE
.\}
.RE
.PP
\fBbus =\fR \fIregex\fR
.RS 4
@ -222,7 +227,7 @@ Turn off the load immediately (see
KNOWN PROBLEMS)\&.
.RE
.PP
\fBshutdown\&.return\fR [\fIvalue\fR]
\fBshutdown\&.return\fR
.RS 4
Turn off the load and return when power is back\&. Uses the timers defined by
\fBondelay\fR
@ -230,7 +235,7 @@ and
\fBoffdelay\fR\&.
.RE
.PP
\fBshutdown\&.stayoff\fR [\fIvalue\fR]
\fBshutdown\&.stayoff\fR
.RS 4
Turn off the load and remain off (see
KNOWN PROBLEMS)\&. Uses the timer defined by
@ -256,7 +261,7 @@ Perform a (10 second) battery test\&.
.RS 4
Perform a battery test for the duration of
\fIvalue\fR
seconds (truncated to units of 60 seconds)\&.
minutes\&.
.RE
.PP
\fBtest\&.battery\&.stop\fR
@ -324,7 +329,9 @@ The temperature and load value is known to be bogus in some models\&.
Arjen de Korte <adkorte\-guest at alioth\&.debian\&.org>, Alexander Gordeev <lasaine at lvk\&.cs\&.msu\&.su>
.SH "SEE ALSO"
.sp
\fBnutupsdrv\fR(8), \fBupsc\fR(8), \fBupscmd\fR(8), \fBupsrw\fR(8)
\fBblazer_ser\fR(8), \fBnutupsdrv\fR(8), \fBupsc\fR(8), \fBupscmd\fR(8), \fBupsrw\fR(8)
.SS "Internet Resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/ The NUT HCL: http://www\&.networkupstools\&.org/stable\-hcl\&.html
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/
.sp
The NUT HCL: http://www\&.networkupstools\&.org/stable\-hcl\&.html

11
docs/man/blazer_usb.txt Normal file
View file

@ -0,0 +1,11 @@
BLAZER_USB(8)
=============
:blazer_usb:
NAME
----
blazer_usb - Driver for Megatec/Q1 protocol USB based UPS equipment
include::blazer-common.txt[]

8
docs/man/clone.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: clone
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "CLONE" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "CLONE" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/dummy-ups.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: dummy-ups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "DUMMY\-UPS" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "DUMMY\-UPS" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/etapro.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: etapro
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "ETAPRO" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "ETAPRO" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/everups.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: everups
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "EVERUPS" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "EVERUPS" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/gamatronic.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: gamatronic
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "GAMATRONIC" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "GAMATRONIC" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

10
docs/man/genericups.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: genericups
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "GENERICUPS" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "GENERICUPS" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -274,7 +274,7 @@ Type 2 has also been reported to work with the 940\-0020C cable\&.
.RE
.\}
.sp
7 = CyberPower Power99 Also Upsonic Power Guardian PG\-500, Belkin Belkin Home Office, F6H350\-SER, F6H500\-SER, F6H650\-SER
7 = CyberPower Power99 Also Upsonic Power Guardian PG\-500, Belkin Belkin Home Office, F6H350\-SER, F6H500\-SER, F6H650\-SER, Eaton Management Card Contact \- Config3 with cable 66033 (shutdown does not work)
.sp
.if n \{\
.RS 4

3
docs/man/genericups.txt
View file

@ -151,7 +151,8 @@ UPS TYPES
7 = CyberPower Power99
Also Upsonic Power Guardian PG-500, Belkin Belkin Home Office,
F6H350-SER, F6H500-SER, F6H650-SER
F6H350-SER, F6H500-SER, F6H650-SER, Eaton Management Card Contact - Config3
with cable 66033 (shutdown does not work)
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]

8
docs/man/hosts.conf.5
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: hosts.conf
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/08/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "HOSTS\&.CONF" "5" "08/08/2012" "Network UPS Tools" "NUT Manual"
.TH "HOSTS\&.CONF" "5" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/isbmex.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: isbmex
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "ISBMEX" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "ISBMEX" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/ivtscd.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: ivtscd
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "IVTSCD" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "IVTSCD" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

55
docs/man/libnutclient.3 Normal file
View file

@ -0,0 +1,55 @@
'\" t
.\" Title: libnutclient
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/18/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre2
.\" Language: English
.\"
.TH "LIBNUTCLIENT" "3" "11/18/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
libnutclient \- Network UPS Tools high\-level client access library
.SH "SYNOPSIS"
.sp
.nf
#include <nutclient\&.h>
.fi
.sp
.nf
Refer to this file for more information\&.
.fi
.SH "DESCRIPTION"
.sp
The Network UPS Tools (NUT) \fBnutclient\fR library provides a number of useful functions for programs to use when communicating with \fBupsd\fR(8)\&. It provides high\-level representation of NUT data through client connection, devices, variables and commands\&. Unlike \fBupsclient\fR(3), all low\-level protocol details are hidden\&.
.sp
State is maintained across calls in an opaque structure called NUTCLIENT_t\&. Callers are expected to create one per client connection\&. These will be provided to most of the \fBnutclient\fR functions\&. The format of this structure is subject to change, and client programs must not reference elements within it directly\&.
.sp
NUTCLIENT_t represents the common connection information\&. Derived versions exist for each connection type (NUTCLIENT_TCP_t for TCP connection; actually the unique connection type, NUTCLIENT_TCP_t can be passed as NUTCLIENT_t parameter)\&.
.sp
See the nutclient\&.h header for more information\&.
.SH "ERROR HANDLING"
.sp
There is currently no specific mechanism around error handling\&.
.SH "SEE ALSO"
.sp
\fBlibnutclient_devices\fR(3) \fBlibnutclient_commands\fR(3) \fBlibnutclient_general\fR(3) \fBlibnutclient_misc\fR(3) \fBlibnutclient_tcp\fR(3) \fBlibnutclient_variables\fR(3)

52
docs/man/libnutclient.txt Normal file
View file

@ -0,0 +1,52 @@
LIBNUTCLIENT(3)
===============
NAME
----
libnutclient - Network UPS Tools high-level client access library
SYNOPSIS
--------
#include <nutclient.h>
Refer to this file for more information.
DESCRIPTION
-----------
The Network UPS Tools (NUT) *nutclient* library provides a number of
useful functions for programs to use when communicating with
linkman:upsd[8]. It provides high-level representation of NUT data
through client connection, devices, variables and commands.
Unlike linkman:upsclient[3], all low-level protocol details are
hidden.
State is maintained across calls in an opaque structure called `NUTCLIENT_t`.
Callers are expected to create one per client connection. These will be
provided to most of the *nutclient* functions. The format of this
structure is subject to change, and client programs must not reference
elements within it directly.
`NUTCLIENT_t` represents the common connection information.
Derived versions exist for each connection type (`NUTCLIENT_TCP_t` for
TCP connection; actually the unique connection type, `NUTCLIENT_TCP_t`
can be passed as `NUTCLIENT_t` parameter).
See the `nutclient.h` header for more information.
ERROR HANDLING
--------------
There is currently no specific mechanism around error handling.
SEE ALSO
--------
linkman:libnutclient_devices[3]
linkman:libnutclient_commands[3]
linkman:libnutclient_general[3]
linkman:libnutclient_misc[3]
linkman:libnutclient_tcp[3]
linkman:libnutclient_variables[3]

65
docs/man/libnutclient_commands.3 Normal file
View file

@ -0,0 +1,65 @@
'\" t
.\" Title: libnutclient_commands
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "LIBNUTCLIENT_COMMAND" "3" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
libnutclient_commands, nutclient_get_device_commands, nutclient_has_device_command, nutclient_get_device_command_description, nutclient_execute_device_command \- Instant command related functions in Network UPS Tools high\-level client access library
.SH "SYNOPSIS"
.sp
.nf
#include <nutclient\&.h>
.fi
.sp
.nf
typedef void* NUTCLIENT_t;
.fi
.sp
.nf
strarr nutclient_get_device_commands(NUTCLIENT_t client, const char* dev);
int nutclient_has_device_command(NUTCLIENT_t client, const char* dev, const char* cmd);
char* nutclient_get_device_command_description(NUTCLIENT_t client, const char* dev, const char* cmd);
void nutclient_execute_device_command(NUTCLIENT_t client, const char* dev, const char* cmd);
.fi
.SH "DESCRIPTION"
.sp
These functions allow to manage instant commands of devices\&.
.sp
The \fBnutclient_get_device_commands()\fR function retrieve the list of command names for a device\&. The returned strarr must be freed by \fIstrarr_free\fR\&.
.sp
The \fBnutclient_has_device_command\fR function test if the specified command is supported by the device\&. Return 1 is supported and 0 if not\&.
.sp
The \fBnutclient_get_device_command_description\fR function retrieve the command description, if any\&. The resturned string must be freed\&.
.sp
The \fBnutclient_execute_device_command\fR intend to execute the instant command\&.
.sp
\fIdev\fR is the device name\&.
.sp
\fIcmd\fR is the instant command name\&.
.SH "SEE ALSO"
.sp
\fBlibnutclient\fR(3) \fBlibnutclient_devices\fR(3) \fBlibnutclient_general\fR(3)

47
docs/man/libnutclient_commands.txt Normal file
View file

@ -0,0 +1,47 @@
LIBNUTCLIENT_COMMANDS(3)
========================
NAME
----
libnutclient_commands, nutclient_get_device_commands, nutclient_has_device_command,
nutclient_get_device_command_description, nutclient_execute_device_command -
Instant command related functions in Network UPS Tools high-level client access library
SYNOPSIS
--------
#include <nutclient.h>
typedef void* NUTCLIENT_t;
strarr nutclient_get_device_commands(NUTCLIENT_t client, const char* dev);
int nutclient_has_device_command(NUTCLIENT_t client, const char* dev, const char* cmd);
char* nutclient_get_device_command_description(NUTCLIENT_t client, const char* dev, const char* cmd);
void nutclient_execute_device_command(NUTCLIENT_t client, const char* dev, const char* cmd);
DESCRIPTION
-----------
These functions allow to manage instant commands of devices.
The *nutclient_get_device_commands()* function retrieve the list of command names for a device.
The returned strarr must be freed by 'strarr_free'.
The *nutclient_has_device_command* function test if the specified command is supported by the device.
Return 1 is supported and 0 if not.
The *nutclient_get_device_command_description* function retrieve the command description, if any.
The resturned string must be freed.
The *nutclient_execute_device_command* intend to execute the instant command.
'dev' is the device name.
'cmd' is the instant command name.
SEE ALSO
--------
linkman:libnutclient[3]
linkman:libnutclient_devices[3]
linkman:libnutclient_general[3]

60
docs/man/libnutclient_devices.3 Normal file
View file

@ -0,0 +1,60 @@
'\" t
.\" Title: libnutclient_devices
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "LIBNUTCLIENT_DEVICES" "3" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
libnutclient_devices, nutclient_get_devices, nutclient_has_device, nutclient_get_device_description \- Device related functions in Network UPS Tools high\-level client access library
.SH "SYNOPSIS"
.sp
.nf
#include <nutclient\&.h>
.fi
.sp
.nf
typedef void* NUTCLIENT_t;
.fi
.sp
.nf
strarr nutclient_get_devices(NUTCLIENT_t client);
int nutclient_has_device(NUTCLIENT_t client, const char* dev);
char* nutclient_get_device_description(NUTCLIENT_t client, const char* dev);
.fi
.SH "DESCRIPTION"
.sp
These functions allow to manage devices\&.
.sp
The \fBnutclient_get_devices()\fR function retrieve the list of devices monitored by a client\&. The returned strarr must be freed by \fIstrarr_free\fR\&.
.sp
The \fBnutclient_has_device()\fR function test if a device is monitored by a client\&.
.sp
The \fBnutclient_get_device_description()\fR function retrieve the device description\&. The returned description string must be freed\&.
.sp
\fIdev\fR is the device name\&.
.SH "SEE ALSO"
.sp
\fBlibnutclient\fR(3) \fBlibnutclient_commands\fR(3) \fBlibnutclient_devices\fR(3) \fBlibnutclient_general\fR(3) \fBlibnutclient_variables\fR(3)

43
docs/man/libnutclient_devices.txt Normal file
View file

@ -0,0 +1,43 @@
LIBNUTCLIENT_DEVICES(3)
=======================
NAME
----
libnutclient_devices, nutclient_get_devices, nutclient_has_device, nutclient_get_device_description -
Device related functions in Network UPS Tools high-level client access library
SYNOPSIS
--------
#include <nutclient.h>
typedef void* NUTCLIENT_t;
strarr nutclient_get_devices(NUTCLIENT_t client);
int nutclient_has_device(NUTCLIENT_t client, const char* dev);
char* nutclient_get_device_description(NUTCLIENT_t client, const char* dev);
DESCRIPTION
-----------
These functions allow to manage devices.
The *nutclient_get_devices()* function retrieve the list of devices monitored by a client.
The returned strarr must be freed by 'strarr_free'.
The *nutclient_has_device()* function test if a device is monitored by a client.
The *nutclient_get_device_description()* function retrieve the device description.
The returned description string must be freed.
'dev' is the device name.
SEE ALSO
--------
linkman:libnutclient[3]
linkman:libnutclient_commands[3]
linkman:libnutclient_devices[3]
linkman:libnutclient_general[3]
linkman:libnutclient_variables[3]

67
docs/man/libnutclient_general.3 Normal file
View file

@ -0,0 +1,67 @@
'\" t
.\" Title: libnutclient_general
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/18/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre2
.\" Language: English
.\"
.TH "LIBNUTCLIENT_GENERAL" "3" "11/18/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
libnutclient_general, nutclient_destroy, strarr_alloc, strarr_free \- General and utility functions in Network UPS Tools high\-level client access library
.SH "SYNOPSIS"
.sp
.nf
#include <nutclient\&.h>
.fi
.sp
.nf
typedef void* NUTCLIENT_t;
.fi
.sp
.nf
void nutclient_destroy(NUTCLIENT_t client);
.fi
.sp
.nf
typedef char** strarr;
.fi
.sp
.nf
strarr strarr_alloc(unsigned short count);
void strarr_free(strarr arr);
.fi
.SH "DESCRIPTION"
.sp
The \fBnutclient_destroy()\fR function destroys a \fINUTCLIENT_t\fR or derived (like \fINUTCLIENT_TCP_t\fR) connection object, and frees allocated memory\&.
.sp
The \fBstrarr\fR type represents an array of C strings (array of char pointer)\&. The array must always be terminated by a NULL pointer\&. Pointed strings must be allocated by (x)calloc or (x)strdup\&.
.sp
The \fBstrarr_alloc()\fR function allocates a \fIstrarr\fR array with the specified number of (non\-initialized) string pointers\&. Another additional pointer set to 0 is added at the end of the array\&.
.sp
The \fBstrarr_free\fR function frees a \fIstrarr\fR array\&. It also frees all pointed strings\&.
.sp
\fIdev\fR is the device name\&.
.SH "SEE ALSO"
.sp
\fBlibnutclient\fR(3)

45
docs/man/libnutclient_general.txt Normal file
View file

@ -0,0 +1,45 @@
LIBNUTCLIENT_GENERAL(3)
=======================
NAME
----
libnutclient_general, nutclient_destroy, strarr_alloc, strarr_free -
General and utility functions in Network UPS Tools high-level client access library
SYNOPSIS
--------
#include <nutclient.h>
typedef void* NUTCLIENT_t;
void nutclient_destroy(NUTCLIENT_t client);
typedef char** strarr;
strarr strarr_alloc(unsigned short count);
void strarr_free(strarr arr);
DESCRIPTION
-----------
The *nutclient_destroy()* function destroys a 'NUTCLIENT_t' or derived
(like 'NUTCLIENT_TCP_t') connection object, and frees allocated memory.
The *strarr* type represents an array of C strings (array of char pointer).
The array must always be terminated by a NULL pointer.
Pointed strings must be allocated by (x)calloc or (x)strdup.
The *strarr_alloc()* function allocates a 'strarr' array with the specified
number of (non-initialized) string pointers.
Another additional pointer set to 0 is added at the end of the array.
The *strarr_free* function frees a 'strarr' array.
It also frees all pointed strings.
'dev' is the device name.
SEE ALSO
--------
linkman:libnutclient[3]

71
docs/man/libnutclient_misc.3 Normal file
View file

@ -0,0 +1,71 @@
'\" t
.\" Title: libnutclient_misc
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "LIBNUTCLIENT_MISC" "3" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
libnutclient_misc, nutclient_authenticate, nutclient_logout, nutclient_device_login, nutclient_get_device_num_logins, nutclient_device_master, nutclient_device_forced_shutdown \- Miscelaneous functions in Network UPS Tools high\-level client access library
.SH "SYNOPSIS"
.sp
.nf
#include <nutclient\&.h>
.fi
.sp
.nf
typedef void* NUTCLIENT_t;
.fi
.sp
.nf
void nutclient_authenticate(NUTCLIENT_t client, const char* login, const char* passwd);
void nutclient_logout(NUTCLIENT_t client);
void nutclient_device_login(NUTCLIENT_t client, const char* dev);
int nutclient_get_device_num_logins(NUTCLIENT_t client, const char* dev);
void nutclient_device_master(NUTCLIENT_t client, const char* dev);
void nutclient_device_forced_shutdown(NUTCLIENT_t client, const char* dev);
.fi
.SH "DESCRIPTION"
.sp
The \fBnutclient_authenticate()\fR function authenticate the user\&.
.sp
\fIlogin\fR is the user name\&.
.sp
\fIpasswd\fR is the user password\&.
.sp
The \fBnutclient_logout()\fR function disconnect gracefully from the server\&.
.sp
The \fBnutclient_device_login()\fR function log the fact that a system is drawing power from this UPS\&.
.sp
The \fBnutclient_get_device_num_logins()\fR function retrieve the number of clients which have been logged for this device\&.
.sp
The \fBnutclient_device_master()\fR function make sure that master\-level functions like FSD are available if necessary\&.
.sp
The \fBnutclient_device_forced_shutdown()\fR function sets the "forced shutdown" flag on the device\&.
.sp
\fIdev\fR is the device name\&.
.SH "SEE ALSO"
.sp
\fBlibnutclient\fR(3)

52
docs/man/libnutclient_misc.txt Normal file
View file

@ -0,0 +1,52 @@
LIBNUTCLIENT_MISC(3)
====================
NAME
----
libnutclient_misc, nutclient_authenticate, nutclient_logout,
nutclient_device_login, nutclient_get_device_num_logins,
nutclient_device_master, nutclient_device_forced_shutdown -
Miscelaneous functions in Network UPS Tools high-level client access library
SYNOPSIS
--------
#include <nutclient.h>
typedef void* NUTCLIENT_t;
void nutclient_authenticate(NUTCLIENT_t client, const char* login, const char* passwd);
void nutclient_logout(NUTCLIENT_t client);
void nutclient_device_login(NUTCLIENT_t client, const char* dev);
int nutclient_get_device_num_logins(NUTCLIENT_t client, const char* dev);
void nutclient_device_master(NUTCLIENT_t client, const char* dev);
void nutclient_device_forced_shutdown(NUTCLIENT_t client, const char* dev);
DESCRIPTION
-----------
The *nutclient_authenticate()* function authenticate the user.
'login' is the user name.
'passwd' is the user password.
The *nutclient_logout()* function disconnect gracefully from the server.
The *nutclient_device_login()* function log the fact that a system
is drawing power from this UPS.
The *nutclient_get_device_num_logins()* function retrieve the number of clients
which have been logged for this device.
The *nutclient_device_master()* function make sure that master-level
functions like FSD are available if necessary.
The *nutclient_device_forced_shutdown()* function sets the "forced shutdown" flag on the device.
'dev' is the device name.
SEE ALSO
--------
linkman:libnutclient[3]

73
docs/man/libnutclient_tcp.3 Normal file
View file

@ -0,0 +1,73 @@
'\" t
.\" Title: libnutclient_tcp
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "LIBNUTCLIENT_TCP" "3" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
libnutclient_tcp, nutclient_tcp_create_client, nutclient_tcp_is_connected, nutclient_tcp_disconnect, nutclient_tcp_reconnect, nutclient_tcp_set_timeout, nutclient_tcp_get_timeout \- TCP protocol related function for Network UPS Tools high\-level client access library
.SH "SYNOPSIS"
.sp
.nf
#include <nutclient\&.h>
.fi
.sp
.nf
typedef NUTCLIENT_t NUTCLIENT_TCP_t;
.fi
.sp
.nf
NUTCLIENT_TCP_t nutclient_tcp_create_client(const char* host, unsigned short port);
int nutclient_tcp_is_connected(NUTCLIENT_TCP_t client);
void nutclient_tcp_disconnect(NUTCLIENT_TCP_t client);
int nutclient_tcp_reconnect(NUTCLIENT_TCP_t client);
void nutclient_tcp_set_timeout(NUTCLIENT_TCP_t client, long timeout);
long nutclient_tcp_get_timeout(NUTCLIENT_TCP_t client);
.fi
.SH "DESCRIPTION"
.sp
These functions allow to manage connections to \fBupsd\fR(8) using NUT TCP protocol\&.
.sp
The \fBnutclient_tcp_create_client()\fR function create the \fINUTCLIENT_TCP_t\fR context and intend to connect to upsd at \fIhost\fR and \fIport\fR\&. The context must be freed by \fInutclient_destroy()\fR
.sp
\fIhost\fR can be a sever name or a valid IPv4 or IPv6 adress like "localhost", "127\&.0\&.0\&.1" or "::1"\&.
.sp
\fIport\fR is a valid TCP port, genrally 3493\&.
.sp
The \fBnutclient_tcp_is_connected()\fR function test if the connection is valid\&.
.sp
The \fBnutclient_tcp_disconnect()\fR function force to disconnect the specified connection\&.
.sp
The \fBnutclient_tcp_reconnect()\fR function force to reconnect a connection, disconnecting it if needed\&.
.sp
The \fBnutclient_tcp_set_timeout()\fR function set the timeout duration for I/O operations\&.
.sp
The \fBnutclient_tcp_get_timeout()\fR function retrieve the timeout duration for I/O operations\&.
.sp
\fItimeout\fR values are specified in seconds, negatives values for blocking\&.
.SH "SEE ALSO"
.sp
\fBlibnutclient\fR(3) \fBlibnutclient_general\fR(3)

54
docs/man/libnutclient_tcp.txt Normal file
View file

@ -0,0 +1,54 @@
LIBNUTCLIENT_TCP(3)
===================
NAME
----
libnutclient_tcp, nutclient_tcp_create_client, nutclient_tcp_is_connected,
nutclient_tcp_disconnect, nutclient_tcp_reconnect,
nutclient_tcp_set_timeout, nutclient_tcp_get_timeout -
TCP protocol related function for Network UPS Tools high-level client access library
SYNOPSIS
--------
#include <nutclient.h>
typedef NUTCLIENT_t NUTCLIENT_TCP_t;
NUTCLIENT_TCP_t nutclient_tcp_create_client(const char* host, unsigned short port);
int nutclient_tcp_is_connected(NUTCLIENT_TCP_t client);
void nutclient_tcp_disconnect(NUTCLIENT_TCP_t client);
int nutclient_tcp_reconnect(NUTCLIENT_TCP_t client);
void nutclient_tcp_set_timeout(NUTCLIENT_TCP_t client, long timeout);
long nutclient_tcp_get_timeout(NUTCLIENT_TCP_t client);
DESCRIPTION
-----------
These functions allow to manage connections to linkman:upsd[8] using NUT TCP protocol.
The *nutclient_tcp_create_client()* function create the 'NUTCLIENT_TCP_t' context and
intend to connect to upsd at 'host' and 'port'. The context must be freed by 'nutclient_destroy()'
'host' can be a sever name or a valid IPv4 or IPv6 adress like "localhost", "127.0.0.1" or "::1".
'port' is a valid TCP port, genrally 3493.
The *nutclient_tcp_is_connected()* function test if the connection is valid.
The *nutclient_tcp_disconnect()* function force to disconnect the specified connection.
The *nutclient_tcp_reconnect()* function force to reconnect a connection,
disconnecting it if needed.
The *nutclient_tcp_set_timeout()* function set the timeout duration for I/O operations.
The *nutclient_tcp_get_timeout()* function retrieve the timeout duration for I/O operations.
'timeout' values are specified in seconds, negatives values for blocking.
SEE ALSO
--------
linkman:libnutclient[3]
linkman:libnutclient_general[3]

78
docs/man/libnutclient_variables.3 Normal file
View file

@ -0,0 +1,78 @@
'\" t
.\" Title: libnutclient_variables
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "LIBNUTCLIENT_VARIABL" "3" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "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"
libnutclient_variables, nutclient_get_device_variables, nutclient_get_device_rw_variables, nutclient_has_device_variable, nutclient_get_device_variable_description, nutclient_get_device_variable_values, nutclient_set_device_variable_value, nutclient_set_device_variable_values \- Variable related functions in Network UPS Tools high\-level client access library
.SH "SYNOPSIS"
.sp
.nf
#include <nutclient\&.h>
.fi
.sp
.nf
typedef void* NUTCLIENT_t;
.fi
.sp
.nf
strarr nutclient_get_device_variables(NUTCLIENT_t client, const char* dev);
strarr nutclient_get_device_rw_variables(NUTCLIENT_t client, const char* dev);
int nutclient_has_device_variable(NUTCLIENT_t client, const char* dev, const char* var);
char* nutclient_get_device_variable_description(NUTCLIENT_t client, const char* dev, const char* var);
strarr nutclient_get_device_variable_values(NUTCLIENT_t client, const char* dev, const char* var);
void nutclient_set_device_variable_value(NUTCLIENT_t client, const char* dev, const char* var, const char* value);
void nutclient_set_device_variable_values(NUTCLIENT_t client, const char* dev, const char* var, const strarr values);
.fi
.SH "DESCRIPTION"
.sp
These functions allow to manage variables of devices\&.
.sp
The \fBnutclient_get_device_variables()\fR function retrieve the list of variables names for a device\&. The returned strarr must be freed by \fIstrarr_free\fR\&.
.sp
The \fBnutclient_get_device_rw_variables\fR function retrieve the list of read\-write variables names for a device\&. The returned strarr must be freed by \fIstrarr_free\fR\&.
.sp
The \fBnutclient_has_device_variable\fR function test if the specified variable is supported by the device\&. Return 1 is supported and 0 if not\&.
.sp
The \fBnutclient_get_device_variable_description\fR function retrieve the variable description, if any\&. The resturned string must be freed\&.
.sp
The \fBnutclient_get_device_variable_values\fR returns variable values (generally only one)\&. The returned strarr must be freed by \fIstrarr_free\fR\&.
.sp
The \fBnutclient_set_device_variable_value\fR intend to set the value of the specified variable\&.
.sp
The \fBnutclient_set_device_variable_values\fR intend to set multiple values of the specified variable\&.
.sp
\fIdev\fR is the device name\&.
.sp
\fIvar\fR is the variable name\&.
.sp
\fIvalue\fR is the variable value\&.
.sp
\fIvalues\fR is the variable array of values\&.
.SH "SEE ALSO"
.sp
\fBlibnutclient\fR(3) \fBlibnutclient_devices\fR(3) \fBlibnutclient_general\fR(3)

64
docs/man/libnutclient_variables.txt Normal file
View file

@ -0,0 +1,64 @@
LIBNUTCLIENT_VARIABLES(3)
=========================
NAME
----
libnutclient_variables, nutclient_get_device_variables,
nutclient_get_device_rw_variables, nutclient_has_device_variable,
nutclient_get_device_variable_description, nutclient_get_device_variable_values,
nutclient_set_device_variable_value, nutclient_set_device_variable_values -
Variable related functions in Network UPS Tools high-level client access library
SYNOPSIS
--------
#include <nutclient.h>
typedef void* NUTCLIENT_t;
strarr nutclient_get_device_variables(NUTCLIENT_t client, const char* dev);
strarr nutclient_get_device_rw_variables(NUTCLIENT_t client, const char* dev);
int nutclient_has_device_variable(NUTCLIENT_t client, const char* dev, const char* var);
char* nutclient_get_device_variable_description(NUTCLIENT_t client, const char* dev, const char* var);
strarr nutclient_get_device_variable_values(NUTCLIENT_t client, const char* dev, const char* var);
void nutclient_set_device_variable_value(NUTCLIENT_t client, const char* dev, const char* var, const char* value);
void nutclient_set_device_variable_values(NUTCLIENT_t client, const char* dev, const char* var, const strarr values);
DESCRIPTION
-----------
These functions allow to manage variables of devices.
The *nutclient_get_device_variables()* function retrieve the list of variables names for a device.
The returned strarr must be freed by 'strarr_free'.
The *nutclient_get_device_rw_variables* function retrieve the list of read-write variables names for a device.
The returned strarr must be freed by 'strarr_free'.
The *nutclient_has_device_variable* function test if the specified variable is supported by the device.
Return 1 is supported and 0 if not.
The *nutclient_get_device_variable_description* function retrieve the variable description, if any.
The resturned string must be freed.
The *nutclient_get_device_variable_values* returns variable values (generally only one).
The returned strarr must be freed by 'strarr_free'.
The *nutclient_set_device_variable_value* intend to set the value of the specified variable.
The *nutclient_set_device_variable_values* intend to set multiple values of the specified variable.
'dev' is the device name.
'var' is the variable name.
'value' is the variable value.
'values' is the variable array of values.
SEE ALSO
--------
linkman:libnutclient[3]
linkman:libnutclient_devices[3]
linkman:libnutclient_general[3]

8
docs/man/libupsclient-config.1
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: libupsclient-config
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/08/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "LIBUPSCLIENT\-CONFIG" "1" "08/08/2012" "Network UPS Tools" "NUT Manual"
.TH "LIBUPSCLIENT\-CONFIG" "1" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/liebert-esp2.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: liebert-esp2
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "LIEBERT\-ESP2" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "LIEBERT\-ESP2" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/liebert.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: liebert
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "LIEBERT" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "LIEBERT" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/macosx-ups.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: macosx-ups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/08/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "MACOSX\-UPS" "8" "08/08/2012" "Network UPS Tools" "NUT Manual"
.TH "MACOSX\-UPS" "8" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/masterguard.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: masterguard
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "MASTERGUARD" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "MASTERGUARD" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/metasys.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: metasys
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "METASYS" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "METASYS" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/mge-shut.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: mge-shut
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "MGE\-SHUT" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "MGE\-SHUT" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/mge-utalk.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: mge-utalk
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "MGE\-UTALK" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "MGE\-UTALK" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

8
docs/man/microdowell.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: microdowell
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "MICRODOWELL" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "MICRODOWELL" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

25
docs/man/netxml-ups.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: netxml-ups
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 10/30/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "NETXML\-UPS" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "NETXML\-UPS" "8" "10/30/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -114,6 +114,11 @@ The timeout for connecting to and reading from the UPS\&. Defaults to 5 seconds\
.sp
This value \fBmust never\fR be higher than half the MAXAGE value specified in \fBupsd.conf\fR(5), otherwise you run the risk that \fBupsd\fR(8) declares the driver stale while it is waiting for a connection to timeout\&.
.PP
\fBsubscribe\fR
.RS 4
Connect to the NMC in subscribed mode\&. This allows to receive notifications and alarms more quickly, beside from the standard polling requests\&.
.RE
.PP
\fBlogin\fR=\fIvalue\fR
.RS 4
Set the login value for authenticated mode\&. This feature also needs the
@ -125,6 +130,18 @@ argument, and allows value settings in the card\&. This feature is not used yet\
.RS 4
Set the password value, needed with the login for authenticated mode\&. This feature is not used yet\&.
.RE
.PP
\fBshutdown_duration\fR=\fIvalue\fR
.RS 4
Set the shutdown duration of the operating system, in seconds\&. This represents the amount of time needed by the system to operate a clean shutdown\&. Defaults to 120 seconds\&.
.RE
.PP
\fBshutdown_timer\fR=\fIvalue\fR
.RS 4
Set the shutdown timer, in seconds\&. After
\fIvalue\fR
seconds running on battery, the local system will receive a notification to shutdown\&. Defaults to "none" (disabled)\&.
.RE
.SH "IMPLEMENTATION"
.sp
The hostname of the UPS is specified with the "port" value in \fBups\&.conf\fR, i\&.e\&.:

14
docs/man/netxml-ups.txt
View file

@ -43,6 +43,10 @@ This value *must never* be higher than half the MAXAGE value specified in
linkman:upsd.conf[5], otherwise you run the risk that linkman:upsd[8] declares
the driver stale while it is waiting for a connection to timeout.
*subscribe*::
Connect to the NMC in subscribed mode. This allows to receive notifications
and alarms more quickly, beside from the standard polling requests.
*login*='value'::
Set the login value for authenticated mode. This feature also needs the
*password* argument, and allows value settings in the card.
@ -52,6 +56,16 @@ This feature is not used yet.
Set the password value, needed with the login for authenticated mode.
This feature is not used yet.
*shutdown_duration*='value'::
Set the shutdown duration of the operating system, in seconds. This
represents the amount of time needed by the system to operate a clean
shutdown. Defaults to 120 seconds.
*shutdown_timer*='value'::
Set the shutdown timer, in seconds. After 'value' seconds running on battery,
the local system will receive a notification to shutdown.
Defaults to "none" (disabled).
IMPLEMENTATION
--------------
The hostname of the UPS is specified with the "port" value in

8
docs/man/nut-ipmipsu.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: nut-ipmipsu
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 09/13/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.7.1-pre1
.\" Language: English
.\"
.TH "NUT\-IPMIPSU" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "NUT\-IPMIPSU" "8" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

12
docs/man/nut-recorder.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: nut-recorder
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/18/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.7.1-pre2
.\" Language: English
.\"
.TH "NUT\-RECORDER" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "NUT\-RECORDER" "8" "11/18/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -34,14 +34,14 @@ nut-recorder \- utility to record device status and values changes
\fBnut\-recorder\fR \fIdevice\-name\fR [output\-file] [interval]
.SH "DESCRIPTION"
.sp
\fBnut\-recorder\fR is an utility to record device running sequence (Ie power failures or any other change) through a NUT data server, and dump it in a \&.seq format\&.
\fBnut\-recorder\fR is an utility to record sequences from running devices (such as power failures, or any other value changes) from upsd, and dump it in a \&.seq format\&.
.sp
The \&.seq file can then be used by the \fBdummy-ups\fR(8) driver to replay the sequence\&.
.SH "OPTIONS"
.PP
\fIdevice\-name\fR
.RS 4
Record the changes of that device\&. The format for this option is
Record the changes of this device\&. The format for this option is
\fIdevname[@hostname[:port]]\fR\&. The default hostname is "localhost"\&.
.RE
.PP

8
docs/man/nut-recorder.txt
View file

@ -12,9 +12,9 @@ SYNOPSIS
DESCRIPTION
-----------
*nut-recorder* is an utility to record device running sequence (Ie
power failures or any other change) through a NUT data server, and
dump it in a .seq format.
*nut-recorder* is an utility to record sequences from running devices (such as
power failures, or any other value changes) from upsd, and dump it in a .seq
format.
The .seq file can then be used by the linkman:dummy-ups[8] driver
to replay the sequence.
@ -23,7 +23,7 @@ OPTIONS
-------
'device-name'::
Record the changes of that device. The format for this option is
Record the changes of this device. The format for this option is
'devname[@hostname[:port]]'. The default hostname is "localhost".
'output-file'::

262
docs/man/nut-scanner.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: nut-scanner
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "NUT\-SCANNER" "8" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "NUT\-SCANNER" "8" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -98,7 +98,78 @@ Scan NUT servers using Avahi request on the current network interfaces\&. No IP
.PP
\fB\-I\fR | \fB\-\-ipmi_scan\fR
.RS 4
Scan NUT compatible devices available via IPMI on the current host\&.
Scan NUT compatible power supplies available via IPMI on the current host, or over the network\&.
.RE
.PP
\fB\-E\fR | \fB\-\-eaton_serial\fR \fIserial ports\fR
.RS 4
Scan Eaton devices (XCP and SHUT) available via serial bus on the current host\&. This option must be requested explicitely, even for a complete scan\&.
\fIserial ports\fR
can be expressed in various forms:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIauto\fR
to scan all serial ports\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a single charcater indicating a port number (\fI0\fR
(zero) for /dev/ttyS0 and /dev/ttyUSB0 on Linux,
\fI1\fR
for COM1 on Windows,
\fIa\fR
for /dev/ttya on Solaris\&...)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a range of N characters, hyphen separated, describing the range of ports using
\fIX\-Y\fR, where X and Y are characters refering to the port number\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a single port name\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a list of ports name, coma separated, like
\fI/dev/ttyS1,/dev/ttyS4\fR\&.
.RE
.RE
.SH "NETWORK OPTIONS"
.PP
@ -186,6 +257,175 @@ used for encrypted SNMPv3 messages\&. This parameter is mandatory if you set
\fIsecurity level\fR
to authPriv\&.
.RE
.SH "IPMI OPTIONS"
.PP
\fB\-b\fR | \fB\-\-username\fR \fIusername\fR
.RS 4
Set the username used for authenticating IPMI over LAN connections (mandatory for IPMI over LAN\&. No default)\&.
.RE
.PP
\fB\-B\fR | \fB\-\-password\fR \fIpassword\fR
.RS 4
Specify the password to use when authenticationg with the remote host (mandatory for IPMI over LAN\&. No default)\&.
.RE
.PP
\fB\-d\fR | \fB\-\-authType\fR \fIauthentication type\fR
.RS 4
Specify the IPMI 1\&.5 authentication type to use (NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5) with the remote host (default=MD5)\&. This forces connection through the
\fIlan\fR
IPMI interface , thus in IPMI 1\&.5 mode\&.
.RE
.PP
\fB\-D\fR | \fB\-\-cipher_suite_id\fR \fIcipher suite identifier\fR
.RS 4
Specify the IPMI 2\&.0 cipher suite ID to use\&. The Cipher Suite ID identifies a set of authentication, integrity, and confidentiality algorithms to use for IPMI 2\&.0 communication\&. The authentication algorithm identifies the algorithm to use for session setup, the integrity algorithm identifies the algorithm to use for session packet signatures, and the confidentiality algorithm identifies the algorithm to use for payload encryption (default=3)\&.
.sp
The following cipher suite ids are currently supported (Authentication; Integrity; Confidentiality):
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB0\fR: None; None; None
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB1\fR: HMAC\-SHA1; None; None
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB2\fR: HMAC\-SHA1; HMAC\-SHA1\-96; None
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB3\fR: HMAC\-SHA1; HMAC\-SHA1\-96; AES\-CBC\-128
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB6\fR: HMAC\-MD5; None; None
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB7\fR: HMAC\-MD5; HMAC\-MD5\-128; None
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB8\fR: HMAC\-MD5; HMAC\-MD5\-128; AES\-CBC\-128
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB11\fR: HMAC\-MD5; MD5\-128; None
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB12\fR: HMAC\-MD5; MD5\-128; AES\-CBC\-128
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB15\fR: HMAC\-SHA256; None; None
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB16\fR: HMAC\-SHA256; HMAC_SHA256_128; None
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB17\fR: HMAC\-SHA256; HMAC_SHA256_128; AES\-CBC\-128
.RE
.RE
.SH "MISCELLANEOUS OPTIONS"
.PP
\fB\-V\fR | \fB\-\-version\fR
@ -219,6 +459,18 @@ The same using CIDR notation:
To scan NUT servers with a timeout of 10 seconds on IP range 192\&.168\&.0\&.0 to 192\&.168\&.0\&.128 using CIDR notation:
.sp
\fBnut\-scanner \-O \-t 10 \-m 192\&.168\&.0\&.0/25\fR
.sp
To scan for power supplies, through IPMI (1\&.5 mode) over the network, on address range 192\&.168\&.0\&.0 to 192\&.168\&.0\&.255:
.sp
\fBnut\-scanner \-I \-m 192\&.168\&.0\&.0/24 \-b username \-B password\fR
.sp
To scan for Eaton serial devices on ports 0 and 1 (/dev/ttyS0, /dev/ttyUSB0, /dev/ttyS1 and /dev/ttyUSB1 on Linux):
.sp
\fBnut\-scanner \-\-eaton_serial 0\-1\fR
.sp
To scan for Eaton serial devices on ports 1 and 2 (COM1 and COM2 on Windows):
.sp
\fBnut\-scanner \-\-eaton_serial 1\-2\fR
.SH "SEE ALSO"
.sp
\fBups.conf\fR(5)

129
docs/man/nut-scanner.txt
View file

@ -36,118 +36,142 @@ DISPLAY OPTIONS
---------------
*-N* | *--disp_nut_conf*::
Display result in the 'ups.conf' format.
Display result in the 'ups.conf' format.
*-P* | *--disp_parsable*::
Display result in a parsable format.
Display result in a parsable format.
BUS OPTIONS
-----------
*-C* | *--complete_scan*::
Scan all available communication buses (default behavior)
Scan all available communication buses (default behavior)
*-U* | *--usb_scan*::
List all NUT-compatible USB devices currently plugged in.
List all NUT-compatible USB devices currently plugged in.
*-S* | *--snmp_scan*::
Scan SNMP devices. Requires at least a 'start IP', and optionally, an 'end IP'. See specific SNMP OPTIONS for community and security settings.
Scan SNMP devices. Requires at least a 'start IP', and optionally, an 'end IP'. See specific SNMP OPTIONS for community and security settings.
*-M* | *--xml_scan*::
Scan XML/HTTP devices. Broadcast a network message on the current network interfaces to retrieve XML/HTTP capable devices. No IP required.
Scan XML/HTTP devices. Broadcast a network message on the current network interfaces to retrieve XML/HTTP capable devices. No IP required.
*-O* | *--oldnut_scan*::
Scan NUT devices (i.e. upsd daemon) on IP ranging from 'start IP' to 'end IP'.
Scan NUT devices (i.e. upsd daemon) on IP ranging from 'start IP' to 'end IP'.
*-A* | *--avahi_scan*::
Scan NUT servers using Avahi request on the current network interfaces. No IP required.
Scan NUT servers using Avahi request on the current network interfaces. No IP required.
*-I* | *--ipmi_scan*::
Scan NUT compatible power supplies available via IPMI on the current host, or over the network.
*-E* | *--eaton_serial* 'serial ports'::
Scan Eaton devices (XCP and SHUT) available via serial bus on the current host.
This option must be requested explicitely, even for a complete scan.
'serial ports' can be expressed in various forms:
- 'auto' to scan all serial ports.
- a single charcater indicating a port number ('0' (zero) for /dev/ttyS0 and
/dev/ttyUSB0 on Linux, '1' for COM1 on Windows, 'a' for /dev/ttya on Solaris...)
- a range of N characters, hyphen separated, describing the range of
ports using 'X-Y', where X and Y are characters refering to the port number.
- a single port name.
- a list of ports name, coma separated, like '/dev/ttyS1,/dev/ttyS4'.
Scan NUT compatible devices available via IPMI on the current host.
NETWORK OPTIONS
---------------
*-t* | *--timeout* 'timeout'::
Set the network timeout in seconds. Default timeout is 5 seconds.
Set the network timeout in seconds. Default timeout is 5 seconds.
*-s* | *--start_ip* 'start IP'::
Set the first IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut).
Set the first IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut).
*-e* | *--end_ip* 'end IP'::
Set the last IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut). If this parameter is omitted, only the 'start IP' is scanned. If 'end IP' is less than 'start IP', both parameters are internally permuted.
Set the last IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut). If this parameter is omitted, only the 'start IP' is scanned. If 'end IP' is less than 'start IP', both parameters are internally permuted.
*-m* | *--mask_cidr* 'IP address/mask'::
Set a range of IP using CIDR notation.
Set a range of IP using CIDR notation.
NUT DEVICE OPTION
-----------------
*-p* | *--port* 'port number'::
Set the port number of scanned NUT devices (default 3493).
Set the port number of scanned NUT devices (default 3493).
SNMP V1 OPTION
--------------
*-c* | *--community* 'community'::
Set SNMP v1 community name (default = public).
Set SNMP v1 community name (default = public).
SNMP V3 OPTIONS
---------------
*-l* | *--secLevel* 'security level'::
Set the 'security level' used for SNMPv3 messages. Allowed values are: noAuthNoPriv, authNoPriv and authPriv.
Set the 'security level' used for SNMPv3 messages. Allowed values are: noAuthNoPriv, authNoPriv and authPriv.
*-u* | *--secName* 'security name'::
Set the 'security name' used for authenticated SNMPv3 messages. This parameter is mandatory if you set 'security level'.
Set the 'security name' used for authenticated SNMPv3 messages. This parameter is mandatory if you set 'security level'.
*-w* | *--authProtocol* 'authentication protocol'::
Set the 'authentication protocol' used for authenticated SNMPv3 messages. Allowed values are MD5 or SHA. Default value is MD5.
Set the 'authentication protocol' used for authenticated SNMPv3 messages. Allowed values are MD5 or SHA. Default value is MD5.
*-W* | *--authPassword* 'authentication pass phrase'::
Set the 'authentication pass phrase' used for authenticated SNMPv3 messages. This parameter is mandatory if you set 'security level' to authNoPriv or authPriv.
Set the 'authentication pass phrase' used for authenticated SNMPv3 messages. This parameter is mandatory if you set 'security level' to authNoPriv or authPriv.
*-x* | *--privProtocol* 'privacy protocol'::
Set the 'privacy protocol' used for encrypted SNMPv3 messages. Allowed values are DES or AES. Default value is DES.
Set the 'privacy protocol' used for encrypted SNMPv3 messages. Allowed values are DES or AES. Default value is DES.
*-X* | *--privPassword* 'privacy pass phrase'::
Set the 'privacy pass phrase' used for encrypted SNMPv3 messages. This parameter is mandatory if you set 'security level' to authPriv.
Set the 'privacy pass phrase' used for encrypted SNMPv3 messages. This parameter is mandatory if you set 'security level' to authPriv.
IPMI OPTIONS
------------
*-b* | *--username* 'username'::
Set the username used for authenticating IPMI over LAN connections (mandatory for IPMI over LAN. No default).
*-B* | *--password* 'password'::
Specify the password to use when authenticationg with the remote host (mandatory for IPMI over LAN. No default).
*-d* | *--authType* 'authentication type'::
Specify the IPMI 1.5 authentication type to use (NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5) with the remote host (default=MD5).
This forces connection through the 'lan' IPMI interface , thus in IPMI 1.5 mode.
*-D* | *--cipher_suite_id* 'cipher suite identifier'::
Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID identifies a set of authentication, integrity, and
confidentiality algorithms to use for IPMI 2.0 communication. The authentication algorithm identifies the algorithm
to use for session setup, the integrity algorithm identifies the algorithm to use for session packet signatures, and the
confidentiality algorithm identifies the algorithm to use for payload encryption (default=3).
+
The following cipher suite ids are currently supported (Authentication; Integrity; Confidentiality):
- *0*: None; None; None
- *1*: HMAC-SHA1; None; None
- *2*: HMAC-SHA1; HMAC-SHA1-96; None
- *3*: HMAC-SHA1; HMAC-SHA1-96; AES-CBC-128
- *6*: HMAC-MD5; None; None
- *7*: HMAC-MD5; HMAC-MD5-128; None
- *8*: HMAC-MD5; HMAC-MD5-128; AES-CBC-128
- *11*: HMAC-MD5; MD5-128; None
- *12*: HMAC-MD5; MD5-128; AES-CBC-128
- *15*: HMAC-SHA256; None; None
- *16*: HMAC-SHA256; HMAC_SHA256_128; None
- *17*: HMAC-SHA256; HMAC_SHA256_128; AES-CBC-128
MISCELLANEOUS OPTIONS
---------------------
*-V* | *--version*::
Display NUT version.
Display NUT version.
*-a* | *--available*::
Display available bus that can be scanned , depending on how the binary has been compiled. (OLDNUT, USB, SNMP, XML, AVAHI, IPMI).
Display available bus that can be scanned , depending on how the binary has been compiled. (OLDNUT, USB, SNMP, XML, AVAHI, IPMI).
*-q* | *--quiet*::
Display only scan result. No information on currently scanned bus is displayed.
Display only scan result. No information on currently scanned bus is displayed.
EXAMPLES
--------
@ -168,6 +192,19 @@ To scan NUT servers with a timeout of 10 seconds on IP range 192.168.0.0 to 192.
*nut-scanner -O -t 10 -m 192.168.0.0/25*
To scan for power supplies, through IPMI (1.5 mode) over the network, on address range 192.168.0.0 to 192.168.0.255:
*nut-scanner -I -m 192.168.0.0/24 -b username -B password*
To scan for Eaton serial devices on ports 0 and 1 (/dev/ttyS0,
/dev/ttyUSB0, /dev/ttyS1 and /dev/ttyUSB1 on Linux):
*nut-scanner --eaton_serial 0-1*
To scan for Eaton serial devices on ports 1 and 2 (COM1 and COM2 on Windows):
*nut-scanner --eaton_serial 1-2*
SEE ALSO
--------

8
docs/man/nut.conf.5
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: nut.conf
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/07/2012
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/26/2013
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Source: Network UPS Tools 2.6.5
.\" Language: English
.\"
.TH "NUT\&.CONF" "5" "08/07/2012" "Network UPS Tools" "NUT Manual"
.TH "NUT\&.CONF" "5" "07/26/2013" "Network UPS Tools 2\&.6\&.5" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

1
docs/man/nutclient_authenticate.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_misc.3

1
docs/man/nutclient_destroy.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_general.3

1
docs/man/nutclient_device_forced_shutdown.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_misc.3

1
docs/man/nutclient_device_login.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_misc.3

1
docs/man/nutclient_device_master.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_misc.3

1
docs/man/nutclient_execute_device_command.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_commands.3

1
docs/man/nutclient_get_device_command_description.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_commands.3

1
docs/man/nutclient_get_device_commands.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_commands.3

1
docs/man/nutclient_get_device_description.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_devices.3

1
docs/man/nutclient_get_device_num_logins.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_misc.3

1
docs/man/nutclient_get_device_rw_variables.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_variables.3

1
docs/man/nutclient_get_device_variable_description.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_variables.3

1
docs/man/nutclient_get_device_variable_values.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_variables.3

1
docs/man/nutclient_get_device_variables.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_variables.3

1
docs/man/nutclient_get_devices.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_devices.3

1
docs/man/nutclient_has_device.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_devices.3

1
docs/man/nutclient_has_device_command.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_commands.3

1
docs/man/nutclient_has_device_variable.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_variables.3

1
docs/man/nutclient_logout.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_misc.3

1
docs/man/nutclient_set_device_variable_value.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_variables.3

1
docs/man/nutclient_set_device_variable_values.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_variables.3

1
docs/man/nutclient_tcp_create_client.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_tcp.3

1
docs/man/nutclient_tcp_disconnect.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_tcp.3

1
docs/man/nutclient_tcp_get_timeout.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_tcp.3

1
docs/man/nutclient_tcp_is_connected.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_tcp.3

1
docs/man/nutclient_tcp_reconnect.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_tcp.3

1
docs/man/nutclient_tcp_set_timeout.3 Normal file
View file

@ -0,0 +1 @@
.so libnutclient_tcp.3

Some files were not shown because too many files have changed in this diff Show more