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