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

« back to all changes in this revision

Viewing changes to docs/configure.txt

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Desc: Configure options
2
 
File: configure.txt
3
 
Date: 24 December 2008
4
 
Auth: Russell Kroll <rkroll@exploits.org>
5
 
Auth: Peter Selinger <selinger@sourceforge.net>
6
 
Auth: Arnaud Quette <aquette.dev@gmail.com>
 
1
ifdef::website[]
 
2
Configure options
 
3
=================
 
4
endif::website[]
7
5
 
8
6
There are a few options that can be given to configure to tweak compiles. 
9
7
See also "./configure --help" for a current and complete listing.
10
8
 
11
 
Contents:
12
 
=========
13
 
 
14
 
1. Driver selection
15
 
2. Optional features
16
 
3. Other configuration options
17
 
4. Installation directories
18
 
5. Directories used by NUT at run-time
19
 
6. Things the compiler might need to find
20
 
 
21
 
1. Driver selection:
22
 
====================
23
 
 
24
 
 --with-serial
25
 
 
26
 
   Build and install the serial drivers (default: yes)
27
 
 
28
 
 --with-usb
29
 
 
30
 
   Build and install the USB drivers (default: auto-detect)
31
 
   Note that you need to install the libusb development package or files.
32
 
 
33
 
 --with-snmp
34
 
 
35
 
   Build and install the SNMP drivers (default: auto-detect)
36
 
   Note that you need to install libsnmp development package or files.
37
 
 
38
 
 --with-drivers=<driver>,<driver>,...
39
 
 
40
 
   Specify exactly which driver or drivers to build and install (this
41
 
   works for serial, usb, and snmp drivers, and overrides the
42
 
   preceding three options).
43
 
 
44
 
   As of the time of this writing (2006), there are 47 UPS drivers
45
 
   available.  Most users will only need one, a few will need two or
46
 
   three, and very few people will need all of them.
47
 
 
48
 
   To save time during the compile and disk space later on, you can
49
 
   use this option to just build and install a subset of the drivers.
50
 
   To select apcsmart and usbhid-ups, you'd do this:
 
9
Driver selection
 
10
----------------
 
11
 
 
12
        --with-serial
 
13
 
 
14
Build and install the serial drivers (default: yes)
 
15
 
 
16
        --with-usb
 
17
 
 
18
Build and install the USB drivers (default: auto-detect)
 
19
Note that you need to install the libusb development package or files.
 
20
 
 
21
        --with-snmp
 
22
 
 
23
Build and install the SNMP drivers (default: auto-detect)
 
24
Note that you need to install libsnmp development package or files.
 
25
 
 
26
        --with-neon
 
27
 
 
28
Build and install the XML drivers (default: auto-detect)
 
29
Note that you need to install neon development package or files.
 
30
 
 
31
        --with-powerman
 
32
 
 
33
Build and install Powerman PDU client driver (default: auto-detect)
 
34
This allows to interact with the Powerman daemon, and the numerous
 
35
Power Distribution Units (PDU) supported by the project.
 
36
Note that you need to install powerman development package or files.
 
37
 
 
38
        --with-ipmi
 
39
        --with-freeipmi
 
40
 
 
41
Build and install IPMI PSU driver (default: auto-detect)
 
42
This allows to monitor numerous Power Supply Units (PSU) found
 
43
on servers.
 
44
Note that you need to install freeipmi (0.8.5 or higher) development package or
 
45
files.
 
46
 
 
47
        --with-drivers=<driver>,<driver>,...
 
48
 
 
49
Specify exactly which driver or drivers to build and install (this
 
50
works for serial, usb, and snmp drivers, and overrides the
 
51
preceding three options).
 
52
 
 
53
As of the time of this writing (2010), there are 46 UPS drivers
 
54
available.  Most users will only need one, a few will need two or
 
55
three, and very few people will need all of them.
 
56
 
 
57
To save time during the compile and disk space later on, you can
 
58
use this option to just build and install a subset of the drivers.
 
59
To select mge-shut and usbhid-ups, you'd do this:
51
60
 
52
61
        --with-drivers=apcsmart,usbhid-ups
53
62
 
54
 
   If you need to build more drivers later on, you will need to rerun
55
 
   configure with a different list. To make it build all of the
56
 
   drivers from scratch again, run 'make clean' before starting.
57
 
 
58
 
2. Optional features:
59
 
=====================
60
 
 
61
 
 --with-cgi (default: no)
62
 
 
63
 
   Build and install the optional CGI programs, HTML files, and sample
64
 
   CGI configuration files. This is not enabled by default, as they
65
 
   are only useful on web servers. See data/html/README for additional
66
 
   information on how to set up CGI programs.
67
 
 
68
 
 --with-lib (default: no)
69
 
 
70
 
   Build and install the upsclient library and header files. 
71
 
 
72
 
 --with-all (no default)
73
 
 
74
 
   Build and install all of the above (the serial, USB, and SNMP
75
 
   drivers, the CGI programs and HTML files, and the upsclient
76
 
   library).
77
 
 
78
 
  --with-ssl
79
 
 
80
 
   Enable SSL development code (default: auto-detect)
81
 
 
82
 
  --with-ipv6
83
 
 
84
 
   Enable IPv6 support (default: auto-detect)
85
 
 
86
 
  --with-hal (default: no)
87
 
 
88
 
    Build and install Hardware Abstraction Layer support.
89
 
    If you own a USB unit, only protect your local system and run the
90
 
    Gnome or KDE desktop, this will enable a full Plug & Play usage.
91
 
    See docs/nut-hal.txt for additional information on how to set up
92
 
    and use HAL support.
93
 
 
94
 
  --with-powerman  (default: auto-detect)
95
 
 
96
 
    Build and install Powerman PDU client driver.
97
 
    This allows to interact with the Powerman daemon, and the numerous
98
 
    Power Distribution Units (PDU) supported by the project.
99
 
 
100
 
3. Other configuration options:
101
 
===============================
102
 
 
103
 
 --with-port=PORT
104
 
 
105
 
   Change the TCP port used by the network code.  Default is 3493.
106
 
 
107
 
   Ancient versions of upsd used port 3305.  NUT 2.0 and up use a
108
 
   substantially different network protocol and are not able to  
109
 
   communicate with anything older than the 1.4 series.
110
 
 
111
 
   If you have to monitor a mixed environment, use the last 1.4 version,
112
 
   as it contains compatibility code for both the old "REQ" and the new
113
 
   "GET" versions of the protocol.
114
 
 
115
 
 --with-user=<username>
116
 
 --with-group=<groupname>
117
 
 
118
 
   Programs started as root will setuid() to <username> for somewhat
119
 
   safer operation.  You can override this with -u <user> in several
120
 
   programs, including upsdrvctl (and all drivers by extension), upsd,
121
 
   and upsmon.  The "user" directive in ups.conf overrides this at run
122
 
   time for the drivers.
123
 
 
124
 
   Note: upsmon does not totally drop root because it may need to
125
 
   initiate a shutdown.  There is always at least a stub process
126
 
   remaining with root powers.  The network code runs in another
127
 
   (separate) process as the new user.
128
 
 
129
 
   The <groupname> is used for the permissions of some files,
130
 
   particularly the hotplugging rules for USB. The idea is that the
131
 
   device files for any UPS devices should be readable and writable by
132
 
   members of that group.
133
 
 
134
 
   The default value for both the username and groupname is "nobody".
135
 
   This was done since it's slightly better than staying around as
136
 
   root.  Running things as nobody is not a good idea, since it's a
137
 
   hack for NFS access.  You should create at least one separate user
138
 
   for this software.
139
 
 
140
 
   If you use one of the --with-user and --with-group options, then
141
 
   you have to use the other one too. 
142
 
 
143
 
   See the INSTALL document and the FAQ for more on this topic.
144
 
 
145
 
 --with-logfacility=FACILITY
146
 
 
147
 
   Change the facility used when writing to the log file.  Read the man
148
 
   page for openlog to get some idea of what's available on your system.
149
 
   Default is LOG_DAEMON.
150
 
 
151
 
4. Installation directories:
152
 
============================
153
 
 
154
 
 --prefix=PATH
155
 
 
156
 
   This is a fairly standard option with GNU autoconf, and it sets the
157
 
   base path for most of the other install directories.  The default
158
 
   is /usr/local/ups, which puts everything but the state sockets in one
159
 
   easy place.
160
 
 
161
 
   If you like having things to be at more of a "system" level, setting
162
 
   the prefix to /usr/local or even /usr might be better.
163
 
 
164
 
 --exec_prefix=PATH
165
 
 
166
 
   This sets the base path for architecture dependent files. By
167
 
   default, it is the same as <prefix>.
168
 
 
169
 
 --sysconfdir=PATH
170
 
 
171
 
   Changes the location where NUT's configuration files are stored.
172
 
   By default this path is <prefix>/etc.  Setting this to /etc or
173
 
   /etc/ups might be useful.
174
 
 
175
 
   The NUT_CONFPATH environment variable overrides this at run time.
176
 
 
177
 
 --bindir=PATH
178
 
 --sbindir=PATH
179
 
 
180
 
   Where executable files will be installed. Files that are normally
181
 
   executed by root (upsd, upsmon, upssched) go to sbindir, all others
182
 
   to bindir. The defaults are <exec_prefix>/bin and <exec_prefix>/sbin.
183
 
 
184
 
 --datadir=PATH
185
 
 
186
 
   Change the data directory, i.e., where architecture independent
187
 
   read-only data is installed.  By default this is <prefix>/share,
188
 
   i.e., /usr/local/ups/share.  At the moment, this directory only
189
 
   holds two files - the optional cmdvartab and driver.list.
190
 
 
191
 
 --mandir=PATH
192
 
 
193
 
   Sets the base directories for the man pages.  The default is
194
 
   <prefix>/man, i.e., /usr/local/ups/man.
195
 
 
196
 
 --includedir=PATH
197
 
 
198
 
   Sets the path for include files to be installed when --with-lib is
199
 
   selected. For example, upsclient.h is installed here. The default
200
 
   is <prefix>/include.
201
 
 
202
 
 --libdir=PATH
203
 
 
204
 
   Sets the installation path for libraries.  This is just the
205
 
   upsclient library for now.  The default is <exec_prefix>/lib.
206
 
 
207
 
 --with-drvpath=PATH
208
 
 
209
 
   The UPS drivers will be installed to this path.  By default they
210
 
   install to "<exec_prefix>/bin", i.e., /usr/local/ups/bin.
211
 
 
212
 
   The "driverpath" global directive in the ups.conf file overrides this
213
 
   at run time.
214
 
 
215
 
 --with-cgipath=PATH
216
 
 
217
 
   The CGI programs will be installed to this path.  By default, they
218
 
   install to "<exec_prefix>/cgi-bin", which is usually /usr/local/ups/cgi-bin.
219
 
 
220
 
   If you set the prefix to something like /usr, you should set the 
221
 
   cgipath to something else, because /usr/cgi-bin is pretty ugly and 
222
 
   non-standard.
223
 
 
224
 
   The CGI programs are not built or installed by default.  Use
225
 
   "./configure --with-cgi" to request that they are built and
226
 
   installed.
227
 
 
228
 
 --with-htmlpath=PATH
229
 
 
230
 
   HTML files will be installed to this path. By default, this is
231
 
   "<prefix>/html". Note that HTML files are only installed if
232
 
   --with-cgi is selected.
233
 
 
234
 
 --with-pkgconfig-dir=PATH
235
 
 
236
 
   Where to install pkg-config *.pc files. This option only has an
237
 
   effect if --with-lib is selected, and causes a pkg-config file to
238
 
   be installed in the named location. The default is
239
 
   <exec_prefix>/pkgconfig.
240
 
 
241
 
   Use --without-pkgconfig-dir to disable this feature altogether. 
242
 
 
243
 
 --with-hotplug-dir=PATH
244
 
 
245
 
   Where to install Linux 2.4 hotplugging rules. The default is
246
 
   /etc/hotplug, if that directory exists, and not to install it
247
 
   otherwise. Note that this installation directory is not a
248
 
   subdirectory of <prefix> by default. When installing NUT as a
249
 
   non-root user, you may have to override this option.
250
 
 
251
 
   Use --without-hotplug-dir to disable this feature altogether. 
252
 
 
253
 
 --with-udev-dir=PATH
254
 
 
255
 
   Where to install Linux 2.6 hotplugging rules, for kernels that have
256
 
   the "udev" mechanism. The default is /etc/udev, if that directory
257
 
   exists, and not to install it otherwise. Note that this
258
 
   installation directory is not a subdirectory of <prefix> by
259
 
   default. When installing NUT as a non-root user, you may have to
260
 
   override this option.
261
 
 
262
 
   Use --without-udev-dir to disable this feature altogether. 
263
 
 
264
 
5. Directories used by NUT at run-time:
265
 
=======================================
266
 
 
267
 
 --with-pidpath=PATH
268
 
 
269
 
   Changes the directory where pid files are stored.  By default this is
270
 
   /var/run.  Certain programs like upsmon will leave files here.
271
 
 
272
 
 --with-altpidpath=PATH
273
 
 
274
 
   Programs that normally don't have root powers, like the drivers and
275
 
   upsd, write their pid files here.  By default this is whatever the
276
 
   statepath is, as those programs should be able to write there.
277
 
 
278
 
 --with-statepath=PATH
279
 
 
280
 
   Change the default location of the state sockets created by the
281
 
   drivers.
282
 
 
283
 
   The NUT_STATEPATH environment variable overrides this at run time.
284
 
 
285
 
   Default is /var/state/ups.
286
 
 
287
 
6. Things the compiler might need to find:
288
 
==========================================
289
 
 
290
 
 --with-gd-includes="-I/foo/bar"
291
 
 
292
 
   If you installed gd in some place where your C preprocessor can't
293
 
   find the header files, use this switch to add additional -I flags.
294
 
 
295
 
 --with-gd-libs="-L/foo/bar -labcd -lxyz"
296
 
 
297
 
   If your copy of gd isn't linking properly, use this to give the
298
 
   proper -L and -l flags to make it work.  See LIBS= in gd's Makefile.
299
 
 
300
 
   Note: the --with-gd switches are not necessary if you have gd 2.0.8
301
 
   or higher installed properly.  The gdlib-config script will be 
302
 
   detected and used by default in that situation.
303
 
 
 
63
If you need to build more drivers later on, you will need to rerun
 
64
configure with a different list. To make it build all of the
 
65
drivers from scratch again, run 'make clean' before starting.
 
66
 
 
67
 
 
68
Optional features
 
69
-----------------
 
70
 
 
71
        --with-cgi (default: no)
 
72
 
 
73
Build and install the optional CGI programs, HTML files, and sample
 
74
CGI configuration files. This is not enabled by default, as they
 
75
are only useful on web servers. See data/html/README for additional
 
76
information on how to set up CGI programs.
 
77
 
 
78
        --with-doc=<output-format(s)>  (default: no)
 
79
 
 
80
Build and install NUT documentation file(s).
 
81
The possible values are "html-single" for single page HTML, "html-chunked"
 
82
for multi pages HTML, "pdf" for a PDF file or "auto" to build all the
 
83
possible previous documentation formats.
 
84
Verbose output can be enabled using: ASCIIDOC_VERBOSE=-v make
 
85
 
 
86
This feature requires AsciiDoc 8.6.3 (http://www.methods.co.nz/asciidoc).
 
87
 
 
88
        --with-lib (default: no)
 
89
 
 
90
Build and install the upsclient library and header files. 
 
91
 
 
92
        --with-all (no default)
 
93
 
 
94
Build and install all of the above (the serial, USB, SNMP, XML/HTTP and
 
95
PowerMan drivers, the CGI programs and HTML files, and the upsclient
 
96
library).
 
97
 
 
98
        --with-ssl (default: auto-detect)
 
99
 
 
100
Enable SSL development code. Read the section "Configuring SSL" in
 
101
docs/security.txt for instructions on SSL support.
 
102
 
 
103
        --with-wrap (default: auto-detect)
 
104
 
 
105
Enable libwrap (tcp-wrappers) support. Refer to upsd man page for
 
106
more information.
 
107
 
 
108
        --with-ipv6 (default: auto-detect)
 
109
 
 
110
Enable IPv6 support.
 
111
 
 
112
        --with-hal (default: no)
 
113
 
 
114
Build and install Hardware Abstraction Layer support.
 
115
If you own a USB unit, only protect your local system and run the
 
116
Gnome or KDE desktop, this will enable a full Plug & Play usage.
 
117
See docs/nut-hal.txt for additional information on how to set up
 
118
and use HAL support.
 
119
 
 
120
        --with-avahi (default: auto-detect)
 
121
 
 
122
Build and install Avahi support, to publish NUT server availability
 
123
using mDNS protocol.
 
124
 
 
125
 
 
126
Other configuration options
 
127
---------------------------
 
128
 
 
129
        --with-port=PORT
 
130
 
 
131
Change the TCP port used by the network code.  Default is 3493.
 
132
 
 
133
Ancient versions of upsd used port 3305.  NUT 2.0 and up use a
 
134
substantially different network protocol and are not able to  
 
135
communicate with anything older than the 1.4 series.
 
136
 
 
137
If you have to monitor a mixed environment, use the last 1.4 version,
 
138
as it contains compatibility code for both the old "REQ" and the new
 
139
"GET" versions of the protocol.
 
140
 
 
141
        --with-user=<username>
 
142
        --with-group=<groupname>
 
143
 
 
144
Programs started as root will setuid() to <username> for somewhat
 
145
safer operation.  You can override this with -u <user> in several
 
146
programs, including upsdrvctl (and all drivers by extension), upsd,
 
147
and upsmon.  The "user" directive in ups.conf overrides this at run
 
148
time for the drivers.
 
149
 
 
150
NOTE: upsmon does not totally drop root because it may need to
 
151
initiate a shutdown.  There is always at least a stub process
 
152
remaining with root powers.  The network code runs in another
 
153
(separate) process as the new user.
 
154
 
 
155
The <groupname> is used for the permissions of some files,
 
156
particularly the hotplugging rules for USB. The idea is that the
 
157
device files for any UPS devices should be readable and writable by
 
158
members of that group.
 
159
 
 
160
The default value for both the username and groupname is "nobody".
 
161
This was done since it's slightly better than staying around as
 
162
root.  Running things as nobody is not a good idea, since it's a
 
163
hack for NFS access.  You should create at least one separate user
 
164
for this software.
 
165
 
 
166
If you use one of the --with-user and --with-group options, then
 
167
you have to use the other one too. 
 
168
 
 
169
See the INSTALL document and the FAQ for more on this topic.
 
170
 
 
171
        --with-logfacility=FACILITY
 
172
 
 
173
Change the facility used when writing to the log file.  Read the man
 
174
page for openlog to get some idea of what's available on your system.
 
175
Default is LOG_DAEMON.
 
176
 
 
177
 
 
178
Installation directories
 
179
------------------------
 
180
 
 
181
        --prefix=PATH
 
182
 
 
183
This is a fairly standard option with GNU autoconf, and it sets the
 
184
base path for most of the other install directories.  The default
 
185
is /usr/local/ups, which puts everything but the state sockets in one
 
186
easy place.
 
187
 
 
188
If you like having things to be at more of a "system" level, setting
 
189
the prefix to /usr/local or even /usr might be better.
 
190
 
 
191
        --exec_prefix=PATH
 
192
 
 
193
This sets the base path for architecture dependent files. By
 
194
default, it is the same as <prefix>.
 
195
 
 
196
        --sysconfdir=PATH
 
197
 
 
198
Changes the location where NUT's configuration files are stored.
 
199
By default this path is <prefix>/etc.  Setting this to /etc or
 
200
/etc/ups might be useful.
 
201
 
 
202
The NUT_CONFPATH environment variable overrides this at run time.
 
203
 
 
204
        --bindir=PATH
 
205
        --sbindir=PATH
 
206
 
 
207
Where executable files will be installed. Files that are normally
 
208
executed by root (upsd, upsmon, upssched) go to sbindir, all others
 
209
to bindir. The defaults are <exec_prefix>/bin and <exec_prefix>/sbin.
 
210
 
 
211
        --datadir=PATH
 
212
 
 
213
Change the data directory, i.e., where architecture independent
 
214
read-only data is installed.  By default this is <prefix>/share,
 
215
i.e., /usr/local/ups/share.  At the moment, this directory only
 
216
holds two files - the optional cmdvartab and driver.list.
 
217
 
 
218
        --mandir=PATH
 
219
 
 
220
Sets the base directories for the man pages.  The default is
 
221
<prefix>/man, i.e., /usr/local/ups/man.
 
222
 
 
223
        --includedir=PATH
 
224
 
 
225
Sets the path for include files to be installed when --with-lib is
 
226
selected. For example, upsclient.h is installed here. The default
 
227
is <prefix>/include.
 
228
 
 
229
        --libdir=PATH
 
230
 
 
231
Sets the installation path for libraries.  This is just the
 
232
upsclient library for now.  The default is <exec_prefix>/lib.
 
233
 
 
234
        --with-drvpath=PATH
 
235
 
 
236
The UPS drivers will be installed to this path.  By default they
 
237
install to "<exec_prefix>/bin", i.e., /usr/local/ups/bin.
 
238
 
 
239
The "driverpath" global directive in the ups.conf file overrides this
 
240
at run time.
 
241
 
 
242
        --with-cgipath=PATH
 
243
 
 
244
The CGI programs will be installed to this path.  By default, they
 
245
install to "<exec_prefix>/cgi-bin", which is usually /usr/local/ups/cgi-bin.
 
246
 
 
247
If you set the prefix to something like /usr, you should set the 
 
248
cgipath to something else, because /usr/cgi-bin is pretty ugly and 
 
249
non-standard.
 
250
 
 
251
The CGI programs are not built or installed by default.  Use
 
252
"./configure --with-cgi" to request that they are built and
 
253
installed.
 
254
 
 
255
        --with-htmlpath=PATH
 
256
 
 
257
HTML files will be installed to this path. By default, this is
 
258
"<prefix>/html". Note that HTML files are only installed if
 
259
--with-cgi is selected.
 
260
 
 
261
        --with-pkgconfig-dir=PATH
 
262
 
 
263
Where to install pkg-config *.pc files. This option only has an
 
264
effect if --with-lib is selected, and causes a pkg-config file to
 
265
be installed in the named location. The default is
 
266
<exec_prefix>/pkgconfig.
 
267
 
 
268
Use --without-pkgconfig-dir to disable this feature altogether. 
 
269
 
 
270
        --with-hotplug-dir=PATH
 
271
 
 
272
Where to install Linux 2.4 hotplugging rules. The default is
 
273
/etc/hotplug, if that directory exists, and not to install it
 
274
otherwise. Note that this installation directory is not a
 
275
subdirectory of <prefix> by default. When installing NUT as a
 
276
non-root user, you may have to override this option.
 
277
 
 
278
Use --without-hotplug-dir to disable this feature altogether. 
 
279
 
 
280
        --with-udev-dir=PATH
 
281
 
 
282
Where to install Linux 2.6 hotplugging rules, for kernels that have
 
283
the "udev" mechanism. The default is /etc/udev, if that directory
 
284
exists, and not to install it otherwise. Note that this
 
285
installation directory is not a subdirectory of <prefix> by
 
286
default. When installing NUT as a non-root user, you may have to
 
287
override this option.
 
288
 
 
289
Use --without-udev-dir to disable this feature altogether. 
 
290
 
 
291
 
 
292
Directories used by NUT at run-time
 
293
-----------------------------------
 
294
 
 
295
        --with-pidpath=PATH
 
296
 
 
297
Changes the directory where pid files are stored.  By default this is
 
298
/var/run.  Certain programs like upsmon will leave files here.
 
299
 
 
300
        --with-altpidpath=PATH
 
301
 
 
302
Programs that normally don't have root powers, like the drivers and
 
303
upsd, write their pid files here.  By default this is whatever the
 
304
statepath is, as those programs should be able to write there.
 
305
 
 
306
        --with-statepath=PATH
 
307
 
 
308
Change the default location of the state sockets created by the
 
309
drivers.
 
310
 
 
311
The NUT_STATEPATH environment variable overrides this at run time.
 
312
 
 
313
Default is /var/state/ups.
 
314
 
 
315
 
 
316
Things the compiler might need to find
 
317
--------------------------------------
 
318
 
 
319
        --with-gd-includes="-I/foo/bar"
 
320
 
 
321
If you installed gd in some place where your C preprocessor can't
 
322
find the header files, use this switch to add additional -I flags.
 
323
 
 
324
        --with-gd-libs="-L/foo/bar -labcd -lxyz"
 
325
 
 
326
If your copy of gd isn't linking properly, use this to give the
 
327
proper -L and -l flags to make it work.  See LIBS= in gd's Makefile.
 
328
 
 
329
NOTE: the --with-gd switches are not necessary if you have gd 2.0.8
 
330
or higher installed properly.  The gdlib-config script will be 
 
331
detected and used by default in that situation.
 
332
 
 
333
        --with-ssl-includes, --with-usb-includes, --with-snmp-includes,
 
334
        --with-neon-includes, --with-powerman-includes="-I/foo/bar"
 
335
 
 
336
If your system doesn't have pkg-config and support for any of the above
 
337
libraries isn't found (but you know it is installed), you must specify the
 
338
compiler flags that are needed.
 
339
 
 
340
        --with-ssl-libs, --with-usb-libs, --with-snmp-libs,
 
341
        --with-neon-libs, --with-powerman-libs="-L/foo/bar -labcd -lxyz"
 
342
 
 
343
If your system doesn't have pkg-config and support for any of the above
 
344
libraries isn't found (but you know it is installed), you must specify the
 
345
linker flags that are needed.
 
346
 
 
347
HAL addons (deprecated)
 
348
-----------------------
 
349
 
 
350
        --with-hal-includes="-DDBUS_API_SUBJECT_TO_CHANGE -I/usr/include/hal \
 
351
                -I/usr/include/dbus-1.0 -I/usr/lib/dbus-1.0/include"
 
352
        --with-hal-libs="-lhal -ldbus-1 -lpthread"
 
353
        --with-hal-user="haldaemon"
 
354
        --with-hal-device-match-key="info.bus"
 
355
        --with-hal-callouts-path="${libdir}/hal"
 
356
        --with-hal-fdi-path="${datarootdir}/hal/fdi/information/20thirdparty"
 
357
 
 
358
If system doesn't have pkg-config or it fails to provides hints for some of the
 
359
settings that are needed to set it up properly and the build in defaults are
 
360
not right, you can specify the right variables here.