ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/INSTALL
(Generate patch)

Comparing rxvt-unicode/INSTALL (file contents):
Revision 1.3 by root, Fri Feb 18 12:15:06 2005 UTC vs.
Revision 1.4 by root, Tue Oct 25 20:22:39 2005 UTC

1-------------------------------------------------------------------------- 1Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
2Using GNU autoconfig 2Foundation, Inc.
3--------------------------------------------------------------------------
4 1. If you retrieved a CVS version of this package, you need the GNU
5 autoconf package to generate the configure script. This is done
6 by running ./genac in this directory which will automatically
7 run autoconf with the appropriate options.
8 3
9 2. Run ./configure to generate config.h and the various Makefiles. 4 This file is free documentation; the Free Software Foundation gives
10 ./configure --help gives a list of possible options with slightly 5unlimited permission to copy, distribute and modify it.
11 longer descriptions in README.configure
12 6
7Basic Installation
8==================
9
10 These are generic installation instructions.
11
12 The `configure' shell script attempts to guess correct values for
13various system-dependent variables used during compilation. It uses
14those values to create a `Makefile' in each directory of the package.
15It may also create one or more `.h' files containing system-dependent
16definitions. Finally, it creates a shell script `config.status' that
17you can run in the future to recreate the current configuration, and a
18file `config.log' containing compiler output (useful mainly for
19debugging `configure').
20
21 It can also use an optional file (typically called `config.cache'
22and enabled with `--cache-file=config.cache' or simply `-C') that saves
23the results of its tests to speed up reconfiguring. (Caching is
24disabled by default to prevent problems with accidental use of stale
25cache files.)
26
27 If you need to do unusual things to compile the package, please try
28to figure out how `configure' could check whether to do them, and mail
29diffs or instructions to the address given in the `README' so they can
30be considered for the next release. If you are using the cache, and at
31some point `config.cache' contains results you don't want to keep, you
32may remove or edit it.
33
34 The file `configure.ac' (or `configure.in') is used to create
35`configure' by a program called `autoconf'. You only need
36`configure.ac' if you want to change it or regenerate `configure' using
37a newer version of `autoconf'.
38
39The simplest way to compile this package is:
40
41 1. `cd' to the directory containing the package's source code and type
42 `./configure' to configure the package for your system. If you're
43 using `csh' on an old version of System V, you might need to type
44 `sh ./configure' instead to prevent `csh' from trying to execute
45 `configure' itself.
46
47 Running `configure' takes awhile. While running, it prints some
48 messages telling which features it is checking for.
49
50 2. Type `make' to compile the package.
51
52 3. Optionally, type `make check' to run any self-tests that come with
53 the package.
54
55 4. Type `make install' to install the programs and any data files and
56 documentation.
57
58 5. You can remove the program binaries and object files from the
59 source code directory by typing `make clean'. To also remove the
60 files that `configure' created (so you can compile the package for
61 a different kind of computer), type `make distclean'. There is
62 also a `make maintainer-clean' target, but that is intended mainly
63 for the package's developers. If you use it, you may have to get
64 all sorts of other programs in order to regenerate files that came
65 with the distribution.
66
67Compilers and Options
68=====================
69
13 Some systems require unusual options for compilation or linking that 70 Some systems require unusual options for compilation or linking that
14 the `configure' script does not know about. You can give `configure' 71the `configure' script does not know about. Run `./configure --help'
15 initial values for variables by setting them in the environment. Using 72for details on some of the pertinent environment variables.
16 a Bourne-compatible shell, you can do that on the command line like
17 this:
18 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
19 Or on systems that have the `env' program, you can do it like this:
20 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
21 Or if you're using a non Bourne-compatible shell, you can do:
22 sh -c 'CFLAGS="-O2 -g" ./configure
23 73
24 If you are making different versions of rxvt you can configure them 74 All confgiure options are also described in README.configure.
25 to be installed with different names using configure arguments, e.g.
26 ./configure --enable-languages --program-transform-name='s,rxvt,kxvt,;'
27 75
28 3. set any other main preferences: 76 You can give `configure' initial values for configuration parameters
29 Edit "src/feature.h" 77by setting variables in the command line or in the environment. Here
30 Edit "config.h" if you didn't use ./configure options 78is an example:
31 If you're cross-compiling, edit the following in "config.h"
32 NO_XLOCALE
33 SIZEOF_* # sizeof some types
34 79
35 4. Build it (repeat step 2 as desired): 80 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
36 make
37 81
38 5. build rclock (small xclock with biff & appointments) and 82 *Note Defining Variables::, for more details.
39 optionally edit rclock/feature.h to add/remove features:
40 make clock
41 83
42 6. Install both rxvt and rclock: 84Compiling For Multiple Architectures
43 make install
44
45 or install them separately
46 (cd src; make install)
47 (cd rclock; make install)
48
49 you may also want to install doc/etc/rxvt-unicode.terminfo and
50 doc/etc/rxvt-unicode.termcap
51
52 7 a. If compiled with UTMP_SUPPORT, you may need to install rxvt setuid
53 root or setuid/setgid to match the file permissions on /etc/utmp
54 7 b. You may need to install setuid root anyway for some systems so that
55 they can give you ownership of the tty devices.
56
57 =================================== 85====================================
58 86
59NB: SunOS (with/without gcc?) gets reported by configure as 87 You can compile the package for more than one kind of computer at the
88same time, by placing the object files for each architecture in their
89own directory. To do this, you must use a version of `make' that
90supports the `VPATH' variable, such as GNU `make'. `cd' to the
91directory where you want the object files and executables to go and run
92the `configure' script. `configure' automatically checks for the
93source code in the directory that `configure' is in and in `..'.
60 94
61 #undef STDC_HEADERS 95 If you have to use a `make' that does not support the `VPATH'
62 #define HAVE_SYS_IOCTL_H 1 96variable, you have to compile the package for one architecture at a
97time in the source code directory. After you have installed the
98package for one architecture, use `make distclean' before reconfiguring
99for another architecture.
63 100
64 but the ioctl() defines aren't protected against multiple 101Installation Names
65 inclusion, in this case by <termios.h> so use a hack in 102==================
66 "feature.h" to avoid the problem.
67 103
68 Gave up checking for `STDC_HEADERS', since they really should be 104 By default, `make install' will install the package's files in
69 there and I don't want to deal with the problems when they don't 105`/usr/local/bin', `/usr/local/man', etc. You can specify an
70 exist. 106installation prefix other than `/usr/local' by giving `configure' the
107option `--prefix=PATH'.
71 108
72 SunOS users might complain to the right places and get their 109 You can specify separate installation prefixes for
73 system headers fixed so that one day the rest of us won't have 110architecture-specific files and architecture-independent files. If you
74 to keep compensating :( 111give `configure' the option `--exec-prefix=PATH', the package will use
112PATH as the prefix for installing programs and libraries.
113Documentation and other data files will still use the regular prefix.
75 114
76 SVR4 users (that aren't using gcc) will have to add -DSVR4 to 115 In addition, if you use an unusual directory layout you can give
77 CPPFLAGS for configure. 116options like `--bindir=PATH' to specify different values for particular
117kinds of files. Run `configure --help' for a list of the directories
118you can set and what kinds of files go in them.
78 119
79-- 120 If the package supports it, you can cause programs to be installed
80EOF 121with an extra prefix or suffix on their names by giving `configure' the
122option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
81 123
124Optional Features
125=================
126
127 Some packages pay attention to `--enable-FEATURE' options to
128`configure', where FEATURE indicates an optional part of the package.
129They may also pay attention to `--with-PACKAGE' options, where PACKAGE
130is something like `gnu-as' or `x' (for the X Window System). The
131`README' should mention any `--enable-' and `--with-' options that the
132package recognizes.
133
134 For packages that use the X Window System, `configure' can usually
135find the X include and library files automatically, but if it doesn't,
136you can use the `configure' options `--x-includes=DIR' and
137`--x-libraries=DIR' to specify their locations.
138
139Specifying the System Type
140==========================
141
142 There may be some features `configure' cannot figure out
143automatically, but needs to determine by the type of machine the package
144will run on. Usually, assuming the package is built to be run on the
145_same_ architectures, `configure' can figure that out, but if it prints
146a message saying it cannot guess the machine type, give it the
147`--build=TYPE' option. TYPE can either be a short name for the system
148type, such as `sun4', or a canonical name which has the form:
149
150 CPU-COMPANY-SYSTEM
151
152where SYSTEM can have one of these forms:
153
154 OS KERNEL-OS
155
156 See the file `config.sub' for the possible values of each field. If
157`config.sub' isn't included in this package, then this package doesn't
158need to know the machine type.
159
160 If you are _building_ compiler tools for cross-compiling, you should
161use the `--target=TYPE' option to select the type of system they will
162produce code for.
163
164 If you want to _use_ a cross compiler, that generates code for a
165platform different from the build platform, you should specify the
166"host" platform (i.e., that on which the generated programs will
167eventually be run) with `--host=TYPE'.
168
169Sharing Defaults
170================
171
172 If you want to set default values for `configure' scripts to share,
173you can create a site shell script called `config.site' that gives
174default values for variables like `CC', `cache_file', and `prefix'.
175`configure' looks for `PREFIX/share/config.site' if it exists, then
176`PREFIX/etc/config.site' if it exists. Or, you can set the
177`CONFIG_SITE' environment variable to the location of the site script.
178A warning: not all `configure' scripts look for a site script.
179
180Defining Variables
181==================
182
183 Variables not defined in a site shell script can be set in the
184environment passed to `configure'. However, some packages may run
185configure again during the build, and the customized values of these
186variables may be lost. In order to avoid this problem, you should set
187them in the `configure' command line, using `VAR=value'. For example:
188
189 ./configure CC=/usr/local2/bin/gcc
190
191will cause the specified gcc to be used as the C compiler (unless it is
192overridden in the site shell script).
193
194`configure' Invocation
195======================
196
197 `configure' recognizes the following options to control how it
198operates.
199
200`--help'
201`-h'
202 Print a summary of the options to `configure', and exit.
203
204`--version'
205`-V'
206 Print the version of Autoconf used to generate the `configure'
207 script, and exit.
208
209`--cache-file=FILE'
210 Enable the cache: use and save the results of the tests in FILE,
211 traditionally `config.cache'. FILE defaults to `/dev/null' to
212 disable caching.
213
214`--config-cache'
215`-C'
216 Alias for `--cache-file=config.cache'.
217
218`--quiet'
219`--silent'
220`-q'
221 Do not print messages saying which checks are being made. To
222 suppress all normal output, redirect it to `/dev/null' (any error
223 messages will still be shown).
224
225`--srcdir=DIR'
226 Look for the package's source code in directory DIR. Usually
227 `configure' can determine that directory automatically.
228
229`configure' also accepts some other, not widely useful, options. Run
230`configure --help' for more details.
231

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines