~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): Arnaud Quette
  • Date: 2004-05-28 13:10:01 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040528131001-yj2m9qcez4ya2w14
Tags: upstream-1.4.2
ImportĀ upstreamĀ versionĀ 1.4.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
Desc: Configure options
2
2
File: configure.txt
3
 
Date: 25 February 2002
 
3
Date: 19 May 2003
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:
9
9
 
10
10
   This is a fairly standard option with GNU autoconf, and it sets the
11
11
   base path for most of the other install directories.  The default
12
 
   is /usr/local/ups, which puts everything but the state files in one
 
12
   is /usr/local/ups, which puts everything but the state sockets in one
13
13
   easy place.
14
14
 
15
15
   If you like having things to be at more of a "system" level, setting
17
17
 
18
18
 --with-statepath=PATH
19
19
 
20
 
   Change the location of the state files created by the model programs.
 
20
   Change the default location of the state sockets created by the
 
21
   drivers.
 
22
 
 
23
   The NUT_STATEPATH environment variable overrides this at run time.
 
24
 
21
25
   Default is /var/state/ups.
22
26
 
23
27
 --with-port=PORT
24
28
 
25
 
   Change the UDP and TCP ports used by the network code.  Default is 3305.
 
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).
26
34
 
27
35
 --with-user=<username>
28
36
 
29
37
   Programs started as root will setuid() to this user for somewhat 
30
 
   safer operation.  The default user is nobody.  
31
 
 
32
 
   Warning: Running lots of daemons as 'nobody' on your system isn't
33
 
   such a good idea.  You should create different users.  See the FAQ.
 
38
   safer operation.  You can override this with -u <user> in several
 
39
   programs, including upsdrvctl (and all drivers by extension), upsd,
 
40
   and upsmon. 
 
41
 
 
42
   The default value is "nobody".  This was done since it's slightly
 
43
   better than staying around as root.  Running things as nobody is not
 
44
   a good idea, since it's a hack for NFS access.  You should create at 
 
45
   least one separate user for this software.
 
46
 
 
47
   See the INSTALL document and the FAQ for more on this topic.
34
48
 
35
49
   Note: upsmon does not totally drop root as it needs to invoke a 
36
50
   shutdown.  There is always at least a stub process remaining with
37
 
   root powers.
38
 
 
39
 
 --with-group=<groupname>
40
 
 
41
 
   Programs started as root will setgid() to this group for safety.
42
 
   The default group is nogroup.
 
51
   root powers.  The network code will run as the new user, though.
43
52
 
44
53
 --with-logfacility=FACILITY
45
54
 
47
56
   page for openlog to get some idea of what's available on your system.
48
57
   Default is LOG_DAEMON.
49
58
 
50
 
 --without-shared-memory
51
 
 
52
 
   Disables shared memory on the model drivers and upsd.  This is useful
53
 
   on systems where the automatic detection fails, or for debugging.
54
 
 
55
59
 --sysconfdir=PATH
56
60
 
57
61
   Changes the configuration path for the suite.  By default this path
58
62
   is $(prefix)/etc.  Setting this to /etc or /etc/ups might be useful.
59
63
 
 
64
   The NUT_CONFPATH environment variable overrides this at run time.
 
65
 
 
66
 --datadir=PATH
 
67
 
 
68
   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.
 
71
 
60
72
 --mandir=PATH
61
73
 
62
74
   Sets the base directories for the man pages.  The default is
63
75
   $(prefix)/man, i.e. /usr/local/ups/man.
64
76
 
 
77
 --includedir=PATH
 
78
 
 
79
   Sets the path for include files.  Right now this is just upsclient.h.
 
80
   The default is $(prefix)/include.
 
81
 
 
82
 --libdir=PATH
 
83
 
 
84
   Sets the path for libraries.  This is just upsclient.o for now.
 
85
   The default is $(prefix)/lib.
 
86
 
65
87
 --with-pidpath=PATH
66
88
 
67
89
   Changes the directory where pid files are stored.  By default this is
69
91
 
70
92
 --with-altpidpath=PATH
71
93
 
72
 
   Programs that normally don't have root powers like the model drivers
73
 
   and upsd write their pid files here.  By default this is whatever
 
94
   Programs that normally don't have root powers like the drivers and
 
95
   upsd write their pid files here.  By default this is whatever
74
96
   the statepath is, as those programs should be able to write there.
75
97
 
76
98
 --with-linux-hiddev=PATH
79
101
   This defaults to /usr/include/linux/hiddev.h, and is only used when
80
102
   building the experimental "hidups" driver.
81
103
 
82
 
 --with-modelpath=PATH
 
104
 --with-drvpath=PATH
83
105
 
84
 
   The UPS model drivers will be installed to this path.  By default they
 
106
   The UPS drivers will be installed to this path.  By default they 
85
107
   install to "bin" under the prefix, giving a default path of
86
108
   /usr/local/ups/bin.
87
109
 
 
110
   The "driverpath" global directive in the ups.conf file overrides this
 
111
   at run time.
 
112
 
 
113
 --with-gd-includes="-I/foo/bar"
 
114
 
 
115
   If you installed gd in some place where your C preprocessor can't
 
116
   find the header files, use this switch to add additional -I flags.
 
117
 
 
118
 --with-gd-libs="-L/foo/bar -labcd -lxyz"
 
119
 
 
120
   If your copy of gd isn't linking properly, use this to give the
 
121
   proper -L and -l flags to make it work.  See LIBS= in gd's Makefile.
 
122
 
 
123
   Note: the --with-gd switches are not necessary if you have gd 2.0.8
 
124
   or higher installed properly.  The gdlib-config script will be 
 
125
   detected and used by default in that situation.
 
126
 
 
127
 --with-cgi
 
128
 
 
129
   This switch tells configure to look for the libraries and headers
 
130
   that are used in the CGI programs.  This is not enabled by default,
 
131
   as they are only useful on web servers.  You need to use this before
 
132
   'make cgi' will work.
 
133
 
88
134
 --with-cgipath=PATH
89
135
 
90
136
   The CGI programs will be installed to this path.  By default, they
99
145
 
100
146
 --with-drivers=<driver>,<driver>,...
101
147
 
102
 
   As of the time of this writing, there are 30 UPS drivers available.
 
148
   As of the time of this writing, there are 31 UPS drivers available.
103
149
   Most users will only need one, a few will need two or three, and
104
150
   very few people will need all of them.
105
151
 
106
 
   To save time during the compile, and disk space later on, you can
 
152
   To save time during the compile and disk space later on, you can
107
153
   use this option to just build and install a subset of the drivers.
108
 
   To select apcsmart and hidups, do something like this:
 
154
   To select apcsmart and hidups, you'd do this:
109
155
 
110
 
   --with-drivers=apcsmart,hidups
 
156
        --with-drivers=apcsmart,hidups
111
157
 
112
158
   If you need to build more drivers later on, you will need to rerun
113
159
   configure with a different list.  To make it build all of the drivers