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

Comparing rxvt-unicode/INSTALL (file contents):
Revision 1.5 by root, Tue Dec 27 11:30:29 2005 UTC vs.
Revision 1.6 by ayin, Sat Nov 24 19:03:15 2007 UTC

1Installation Instructions
2*************************
3
1Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software 4Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
2Foundation, Inc. 52006 Free Software Foundation, Inc.
3 6
4 This file is free documentation; the Free Software Foundation gives 7This file is free documentation; the Free Software Foundation gives
5unlimited permission to copy, distribute and modify it. 8unlimited permission to copy, distribute and modify it.
6 9
7Basic Installation 10Basic Installation
8================== 11==================
9 12
10 These are generic installation instructions. 13Briefly, the shell commands `./configure; make; make install' should
14configure, build, and install this package. The following
15more-detailed instructions are generic; see the `README' file for
16instructions specific to this package.
11 17
12 The `configure' shell script attempts to guess correct values for 18 The `configure' shell script attempts to guess correct values for
13various system-dependent variables used during compilation. It uses 19various system-dependent variables used during compilation. It uses
14those values to create a `Makefile' in each directory of the package. 20those values to create a `Makefile' in each directory of the package.
15It may also create one or more `.h' files containing system-dependent 21It may also create one or more `.h' files containing system-dependent
… …
18file `config.log' containing compiler output (useful mainly for 24file `config.log' containing compiler output (useful mainly for
19debugging `configure'). 25debugging `configure').
20 26
21 It can also use an optional file (typically called `config.cache' 27 It can also use an optional file (typically called `config.cache'
22and enabled with `--cache-file=config.cache' or simply `-C') that saves 28and enabled with `--cache-file=config.cache' or simply `-C') that saves
23the results of its tests to speed up reconfiguring. (Caching is 29the results of its tests to speed up reconfiguring. Caching is
24disabled by default to prevent problems with accidental use of stale 30disabled by default to prevent problems with accidental use of stale
25cache files.) 31cache files.
26 32
27 If you need to do unusual things to compile the package, please try 33 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 34to 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 35diffs 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 36be 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 37some point `config.cache' contains results you don't want to keep, you
32may remove or edit it. 38may remove or edit it.
33 39
34 The file `configure.ac' (or `configure.in') is used to create 40 The file `configure.ac' (or `configure.in') is used to create
35`configure' by a program called `autoconf'. You only need 41`configure' by a program called `autoconf'. You need `configure.ac' if
36`configure.ac' if you want to change it or regenerate `configure' using 42you want to change it or regenerate `configure' using a newer version
37a newer version of `autoconf'. 43of `autoconf'.
38 44
39The simplest way to compile this package is: 45The simplest way to compile this package is:
40 46
41 1. `cd' to the directory containing the package's source code and type 47 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 48 `./configure' to configure the package for your system.
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 49
47 Running `configure' takes awhile. While running, it prints some 50 Running `configure' might take a while. While running, it prints
48 messages telling which features it is checking for. 51 some messages telling which features it is checking for.
49 52
50 2. Type `make' to compile the package. 53 2. Type `make' to compile the package.
51 54
55 3. Optionally, type `make check' to run any self-tests that come with
56 the package.
57
52 3. Type `make install' to install the programs and any data files and 58 4. Type `make install' to install the programs and any data files and
53 documentation. 59 documentation.
54 60
55 4. You can remove the program binaries and object files from the 61 5. You can remove the program binaries and object files from the
56 source code directory by typing `make clean'. To also remove the 62 source code directory by typing `make clean'. To also remove the
57 files that `configure' created (so you can compile the package for 63 files that `configure' created (so you can compile the package for
58 a different kind of computer), type `make distclean'. There is 64 a different kind of computer), type `make distclean'. There is
59 also a `make maintainer-clean' target, but that is intended mainly 65 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 66 for the package's developers. If you use it, you may have to get
… …
62 with the distribution. 68 with the distribution.
63 69
64Compilers and Options 70Compilers and Options
65===================== 71=====================
66 72
67 Some systems require unusual options for compilation or linking that 73Some systems require unusual options for compilation or linking that the
68the `configure' script does not know about. Run `./configure --help' 74`configure' script does not know about. Run `./configure --help' for
69for details on some of the pertinent environment variables. 75details on some of the pertinent environment variables.
70
71 All confgiure options are also described in README.configure.
72 76
73 You can give `configure' initial values for configuration parameters 77 You can give `configure' initial values for configuration parameters
74by setting variables in the command line or in the environment. Here 78by setting variables in the command line or in the environment. Here
75is an example: 79is an example:
76 80
77 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix 81 ./configure CC=c99 CFLAGS=-g LIBS=-lposix
78 82
79 *Note Defining Variables::, for more details. 83 *Note Defining Variables::, for more details.
80 84
81Compiling For Multiple Architectures 85Compiling For Multiple Architectures
82==================================== 86====================================
83 87
84 You can compile the package for more than one kind of computer at the 88You can compile the package for more than one kind of computer at the
85same time, by placing the object files for each architecture in their 89same time, by placing the object files for each architecture in their
86own directory. To do this, you must use a version of `make' that 90own directory. To do this, you can use GNU `make'. `cd' to the
87supports the `VPATH' variable, such as GNU `make'. `cd' to the
88directory where you want the object files and executables to go and run 91directory where you want the object files and executables to go and run
89the `configure' script. `configure' automatically checks for the 92the `configure' script. `configure' automatically checks for the
90source code in the directory that `configure' is in and in `..'. 93source code in the directory that `configure' is in and in `..'.
91 94
92 If you have to use a `make' that does not support the `VPATH' 95 With a non-GNU `make', it is safer to compile the package for one
93variable, you have to compile the package for one architecture at a
94time in the source code directory. After you have installed the 96architecture at a time in the source code directory. After you have
95package for one architecture, use `make distclean' before reconfiguring 97installed the package for one architecture, use `make distclean' before
96for another architecture. 98reconfiguring for another architecture.
97 99
98Installation Names 100Installation Names
99================== 101==================
100 102
101 By default, `make install' will install the package's files in 103By default, `make install' installs the package's commands under
102`/usr/local/bin', `/usr/local/man', etc. You can specify an 104`/usr/local/bin', include files under `/usr/local/include', etc. You
103installation prefix other than `/usr/local' by giving `configure' the 105can specify an installation prefix other than `/usr/local' by giving
104option `--prefix=PATH'. 106`configure' the option `--prefix=PREFIX'.
105 107
106 You can specify separate installation prefixes for 108 You can specify separate installation prefixes for
107architecture-specific files and architecture-independent files. If you 109architecture-specific files and architecture-independent files. If you
108give `configure' the option `--exec-prefix=PATH', the package will use 110pass the option `--exec-prefix=PREFIX' to `configure', the package uses
109PATH as the prefix for installing programs and libraries. 111PREFIX as the prefix for installing programs and libraries.
110Documentation and other data files will still use the regular prefix. 112Documentation and other data files still use the regular prefix.
111 113
112 In addition, if you use an unusual directory layout you can give 114 In addition, if you use an unusual directory layout you can give
113options like `--bindir=PATH' to specify different values for particular 115options like `--bindir=DIR' to specify different values for particular
114kinds of files. Run `configure --help' for a list of the directories 116kinds of files. Run `configure --help' for a list of the directories
115you can set and what kinds of files go in them. 117you can set and what kinds of files go in them.
116 118
117 If the package supports it, you can cause programs to be installed 119 If the package supports it, you can cause programs to be installed
118with an extra prefix or suffix on their names by giving `configure' the 120with an extra prefix or suffix on their names by giving `configure' the
119option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 121option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
120 122
121Optional Features 123Optional Features
122================= 124=================
123 125
124 Some packages pay attention to `--enable-FEATURE' options to 126Some packages pay attention to `--enable-FEATURE' options to
125`configure', where FEATURE indicates an optional part of the package. 127`configure', where FEATURE indicates an optional part of the package.
126They may also pay attention to `--with-PACKAGE' options, where PACKAGE 128They may also pay attention to `--with-PACKAGE' options, where PACKAGE
127is something like `gnu-as' or `x' (for the X Window System). The 129is something like `gnu-as' or `x' (for the X Window System). The
128`README' should mention any `--enable-' and `--with-' options that the 130`README' should mention any `--enable-' and `--with-' options that the
129package recognizes. 131package recognizes.
… …
134`--x-libraries=DIR' to specify their locations. 136`--x-libraries=DIR' to specify their locations.
135 137
136Specifying the System Type 138Specifying the System Type
137========================== 139==========================
138 140
139 There may be some features `configure' cannot figure out 141There may be some features `configure' cannot figure out automatically,
140automatically, but needs to determine by the type of machine the package 142but needs to determine by the type of machine the package will run on.
141will run on. Usually, assuming the package is built to be run on the 143Usually, assuming the package is built to be run on the _same_
142_same_ architectures, `configure' can figure that out, but if it prints 144architectures, `configure' can figure that out, but if it prints a
143a message saying it cannot guess the machine type, give it the 145message saying it cannot guess the machine type, give it the
144`--build=TYPE' option. TYPE can either be a short name for the system 146`--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: 147type, such as `sun4', or a canonical name which has the form:
146 148
147 CPU-COMPANY-SYSTEM 149 CPU-COMPANY-SYSTEM
148 150
… …
153 See the file `config.sub' for the possible values of each field. If 155 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 156`config.sub' isn't included in this package, then this package doesn't
155need to know the machine type. 157need to know the machine type.
156 158
157 If you are _building_ compiler tools for cross-compiling, you should 159 If you are _building_ compiler tools for cross-compiling, you should
158use the `--target=TYPE' option to select the type of system they will 160use the option `--target=TYPE' to select the type of system they will
159produce code for. 161produce code for.
160 162
161 If you want to _use_ a cross compiler, that generates code for a 163 If you want to _use_ a cross compiler, that generates code for a
162platform different from the build platform, you should specify the 164platform different from the build platform, you should specify the
163"host" platform (i.e., that on which the generated programs will 165"host" platform (i.e., that on which the generated programs will
164eventually be run) with `--host=TYPE'. 166eventually be run) with `--host=TYPE'.
165 167
166Sharing Defaults 168Sharing Defaults
167================ 169================
168 170
169 If you want to set default values for `configure' scripts to share, 171If you want to set default values for `configure' scripts to share, you
170you can create a site shell script called `config.site' that gives 172can create a site shell script called `config.site' that gives default
171default values for variables like `CC', `cache_file', and `prefix'. 173values for variables like `CC', `cache_file', and `prefix'.
172`configure' looks for `PREFIX/share/config.site' if it exists, then 174`configure' looks for `PREFIX/share/config.site' if it exists, then
173`PREFIX/etc/config.site' if it exists. Or, you can set the 175`PREFIX/etc/config.site' if it exists. Or, you can set the
174`CONFIG_SITE' environment variable to the location of the site script. 176`CONFIG_SITE' environment variable to the location of the site script.
175A warning: not all `configure' scripts look for a site script. 177A warning: not all `configure' scripts look for a site script.
176 178
177Defining Variables 179Defining Variables
178================== 180==================
179 181
180 Variables not defined in a site shell script can be set in the 182Variables not defined in a site shell script can be set in the
181environment passed to `configure'. However, some packages may run 183environment passed to `configure'. However, some packages may run
182configure again during the build, and the customized values of these 184configure again during the build, and the customized values of these
183variables may be lost. In order to avoid this problem, you should set 185variables may be lost. In order to avoid this problem, you should set
184them in the `configure' command line, using `VAR=value'. For example: 186them in the `configure' command line, using `VAR=value'. For example:
185 187
186 ./configure CC=/usr/local2/bin/gcc 188 ./configure CC=/usr/local2/bin/gcc
187 189
188will cause the specified gcc to be used as the C compiler (unless it is 190causes the specified `gcc' to be used as the C compiler (unless it is
189overridden in the site shell script). 191overridden in the site shell script).
192
193Unfortunately, this technique does not work for `CONFIG_SHELL' due to
194an 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
190 197
191`configure' Invocation 198`configure' Invocation
192====================== 199======================
193 200
194 `configure' recognizes the following options to control how it 201`configure' recognizes the following options to control how it operates.
195operates.
196 202
197`--help' 203`--help'
198`-h' 204`-h'
199 Print a summary of the options to `configure', and exit. 205 Print a summary of the options to `configure', and exit.
200 206

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines