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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines