← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/configure.txt

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler
  • Date: 2005-07-20 19:48:50 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20050720194850-oo61wjr33rrx2mre
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/configure.txt
1
1
Desc: Configure options
2
2
File: configure.txt
3
 
Date: 19 May 2003
 
3
Date: 14 March 2004
4
4
Auth: Russell Kroll <rkroll@exploits.org>
5
5
 
6
6
There are a few options that can be given to configure to tweak compiles:
26
26
 
27
27
 --with-port=PORT
28
28
 
29
 
   Change the UDP and TCP ports used by the network code.  Default is 3493.
30
 
 
31
 
   Note: this used to be 3305.  If you have to interoperate with ancient
32
 
   versions of upsd in a mixed environment, be sure to specify the port
33
 
   number when defining a UPS (myups@myhost:3305).
 
29
   Change the TCP port used by the network code.  Default is 3493.
 
30
 
 
31
   Ancient versions of upsd used port 3305.  NUT 2.0 and up use a
 
32
   substantially different network protocol and are not able to  
 
33
   communicate with anything older than the 1.4 series.
 
34
 
 
35
   If you have to monitor a mixed environment, use the last 1.4 version,
 
36
   as it contains compatibility code for both the old "REQ" and the new
 
37
   "GET" versions of the protocol.
34
38
 
35
39
 --with-user=<username>
36
40
 
37
41
   Programs started as root will setuid() to this user for somewhat 
38
42
   safer operation.  You can override this with -u <user> in several
39
43
   programs, including upsdrvctl (and all drivers by extension), upsd,
40
 
   and upsmon. 
 
44
   and upsmon.  
 
45
 
 
46
   The "user" directive in ups.conf overrides this at run time for
 
47
   the drivers.
41
48
 
42
49
   The default value is "nobody".  This was done since it's slightly
43
50
   better than staying around as root.  Running things as nobody is not
46
53
 
47
54
   See the INSTALL document and the FAQ for more on this topic.
48
55
 
49
 
   Note: upsmon does not totally drop root as it needs to invoke a 
50
 
   shutdown.  There is always at least a stub process remaining with
51
 
   root powers.  The network code will run as the new user, though.
 
56
   Note: upsmon does not totally drop root because it may need to
 
57
   initiate a shutdown.  There is always at least a stub process
 
58
   remaining with root powers.  The network code runs in another
 
59
   (separate) process as the new user.
52
60
 
53
61
 --with-logfacility=FACILITY
54
62
 
66
74
 --datadir=PATH
67
75
 
68
76
   Change the data directory.  By default this is $(prefix)/share, or
69
 
   /usr/local/ups/share.  At the moment, this directory only holds one
70
 
   file - the optional cmdvartab.
 
77
   /usr/local/ups/share.  At the moment, this directory only holds two
 
78
   files - the optional cmdvartab and driver.list.
71
79
 
72
80
 --mandir=PATH
73
81
 
95
103
   upsd write their pid files here.  By default this is whatever
96
104
   the statepath is, as those programs should be able to write there.
97
105
 
98
 
 --with-linux-hiddev=PATH
 
106
 --with-linux-hiddev=FILE
99
107
 
100
 
   Sets the directory to the hiddev.h for USB UPS support on Linux.
 
108
   Sets the location of the hiddev.h for USB UPS support on Linux. 
101
109
   This defaults to /usr/include/linux/hiddev.h, and is only used when
102
 
   building the experimental "hidups" driver.
 
110
   building the experimental "hidups" driver.  If your kernel header
 
111
   files live somewhere else, you will need to use this.
103
112
 
104
113
 --with-drvpath=PATH
105
114
 
145
154
 
146
155
 --with-drivers=<driver>,<driver>,...
147
156
 
148
 
   As of the time of this writing, there are 31 UPS drivers available.
 
157
   As of the time of this writing, there are 25 UPS drivers available.
149
158
   Most users will only need one, a few will need two or three, and
150
159
   very few people will need all of them.
151
160