/[path-sandbox]/trunk/INSTALL
Gentoo

Diff of /trunk/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 350 Revision 351
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 Free
2Foundation, Inc. 5Software 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. 13These are generic installation instructions.
11 14
12 The `configure' shell script attempts to guess correct values for 15 The `configure' shell script attempts to guess correct values for
13various system-dependent variables used during compilation. It uses 16various system-dependent variables used during compilation. It uses
14those values to create a `Makefile' in each directory of the package. 17those values to create a `Makefile' in each directory of the package.
15It may also create one or more `.h' files containing system-dependent 18It may also create one or more `.h' files containing system-dependent
65 with the distribution. 68 with the distribution.
66 69
67Compilers and Options 70Compilers and Options
68===================== 71=====================
69 72
70 Some systems require unusual options for compilation or linking that 73Some systems require unusual options for compilation or linking that the
71the `configure' script does not know about. Run `./configure --help' 74`configure' script does not know about. Run `./configure --help' for
72for details on some of the pertinent environment variables. 75details on some of the pertinent environment variables.
73 76
74 You can give `configure' initial values for configuration parameters 77 You can give `configure' initial values for configuration parameters
75by setting variables in the command line or in the environment. Here 78by setting variables in the command line or in the environment. Here
76is an example: 79is an example:
77 80
80 *Note Defining Variables::, for more details. 83 *Note Defining Variables::, for more details.
81 84
82Compiling For Multiple Architectures 85Compiling For Multiple Architectures
83==================================== 86====================================
84 87
85 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
86same time, by placing the object files for each architecture in their 89same time, by placing the object files for each architecture in their
87own directory. To do this, you must use a version of `make' that 90own directory. To do this, you must use a version of `make' that
88supports the `VPATH' variable, such as GNU `make'. `cd' to the 91supports the `VPATH' variable, such as GNU `make'. `cd' to the
89directory where you want the object files and executables to go and run 92directory where you want the object files and executables to go and run
90the `configure' script. `configure' automatically checks for the 93the `configure' script. `configure' automatically checks for the
97for another architecture. 100for another architecture.
98 101
99Installation Names 102Installation Names
100================== 103==================
101 104
102 By default, `make install' will install the package's files in 105By default, `make install' installs the package's commands under
103`/usr/local/bin', `/usr/local/man', etc. You can specify an 106`/usr/local/bin', include files under `/usr/local/include', etc. You
104installation prefix other than `/usr/local' by giving `configure' the 107can specify an installation prefix other than `/usr/local' by giving
105option `--prefix=PATH'. 108`configure' the option `--prefix=PREFIX'.
106 109
107 You can specify separate installation prefixes for 110 You can specify separate installation prefixes for
108architecture-specific files and architecture-independent files. If you 111architecture-specific files and architecture-independent files. If you
109give `configure' the option `--exec-prefix=PATH', the package will use 112pass the option `--exec-prefix=PREFIX' to `configure', the package uses
110PATH as the prefix for installing programs and libraries. 113PREFIX as the prefix for installing programs and libraries.
111Documentation and other data files will still use the regular prefix. 114Documentation and other data files still use the regular prefix.
112 115
113 In addition, if you use an unusual directory layout you can give 116 In addition, if you use an unusual directory layout you can give
114options like `--bindir=PATH' to specify different values for particular 117options like `--bindir=DIR' to specify different values for particular
115kinds of files. Run `configure --help' for a list of the directories 118kinds of files. Run `configure --help' for a list of the directories
116you can set and what kinds of files go in them. 119you can set and what kinds of files go in them.
117 120
118 If the package supports it, you can cause programs to be installed 121 If the package supports it, you can cause programs to be installed
119with an extra prefix or suffix on their names by giving `configure' the 122with an extra prefix or suffix on their names by giving `configure' the
120option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 123option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
121 124
122Optional Features 125Optional Features
123================= 126=================
124 127
125 Some packages pay attention to `--enable-FEATURE' options to 128Some packages pay attention to `--enable-FEATURE' options to
126`configure', where FEATURE indicates an optional part of the package. 129`configure', where FEATURE indicates an optional part of the package.
127They may also pay attention to `--with-PACKAGE' options, where PACKAGE 130They may also pay attention to `--with-PACKAGE' options, where PACKAGE
128is something like `gnu-as' or `x' (for the X Window System). The 131is something like `gnu-as' or `x' (for the X Window System). The
129`README' should mention any `--enable-' and `--with-' options that the 132`README' should mention any `--enable-' and `--with-' options that the
130package recognizes. 133package recognizes.
135`--x-libraries=DIR' to specify their locations. 138`--x-libraries=DIR' to specify their locations.
136 139
137Specifying the System Type 140Specifying the System Type
138========================== 141==========================
139 142
140 There may be some features `configure' cannot figure out 143There may be some features `configure' cannot figure out automatically,
141automatically, but needs to determine by the type of machine the package 144but needs to determine by the type of machine the package will run on.
142will run on. Usually, assuming the package is built to be run on the 145Usually, assuming the package is built to be run on the _same_
143_same_ architectures, `configure' can figure that out, but if it prints 146architectures, `configure' can figure that out, but if it prints a
144a message saying it cannot guess the machine type, give it the 147message saying it cannot guess the machine type, give it the
145`--build=TYPE' option. TYPE can either be a short name for the system 148`--build=TYPE' option. TYPE can either be a short name for the system
146type, such as `sun4', or a canonical name which has the form: 149type, such as `sun4', or a canonical name which has the form:
147 150
148 CPU-COMPANY-SYSTEM 151 CPU-COMPANY-SYSTEM
149 152
154 See the file `config.sub' for the possible values of each field. If 157 See the file `config.sub' for the possible values of each field. If
155`config.sub' isn't included in this package, then this package doesn't 158`config.sub' isn't included in this package, then this package doesn't
156need to know the machine type. 159need to know the machine type.
157 160
158 If you are _building_ compiler tools for cross-compiling, you should 161 If you are _building_ compiler tools for cross-compiling, you should
159use the `--target=TYPE' option to select the type of system they will 162use the option `--target=TYPE' to select the type of system they will
160produce code for. 163produce code for.
161 164
162 If you want to _use_ a cross compiler, that generates code for a 165 If you want to _use_ a cross compiler, that generates code for a
163platform different from the build platform, you should specify the 166platform different from the build platform, you should specify the
164"host" platform (i.e., that on which the generated programs will 167"host" platform (i.e., that on which the generated programs will
165eventually be run) with `--host=TYPE'. 168eventually be run) with `--host=TYPE'.
166 169
167Sharing Defaults 170Sharing Defaults
168================ 171================
169 172
170 If you want to set default values for `configure' scripts to share, 173If you want to set default values for `configure' scripts to share, you
171you can create a site shell script called `config.site' that gives 174can create a site shell script called `config.site' that gives default
172default values for variables like `CC', `cache_file', and `prefix'. 175values for variables like `CC', `cache_file', and `prefix'.
173`configure' looks for `PREFIX/share/config.site' if it exists, then 176`configure' looks for `PREFIX/share/config.site' if it exists, then
174`PREFIX/etc/config.site' if it exists. Or, you can set the 177`PREFIX/etc/config.site' if it exists. Or, you can set the
175`CONFIG_SITE' environment variable to the location of the site script. 178`CONFIG_SITE' environment variable to the location of the site script.
176A warning: not all `configure' scripts look for a site script. 179A warning: not all `configure' scripts look for a site script.
177 180
178Defining Variables 181Defining Variables
179================== 182==================
180 183
181 Variables not defined in a site shell script can be set in the 184Variables not defined in a site shell script can be set in the
182environment passed to `configure'. However, some packages may run 185environment passed to `configure'. However, some packages may run
183configure again during the build, and the customized values of these 186configure again during the build, and the customized values of these
184variables may be lost. In order to avoid this problem, you should set 187variables may be lost. In order to avoid this problem, you should set
185them in the `configure' command line, using `VAR=value'. For example: 188them in the `configure' command line, using `VAR=value'. For example:
186 189
187 ./configure CC=/usr/local2/bin/gcc 190 ./configure CC=/usr/local2/bin/gcc
188 191
189will cause the specified gcc to be used as the C compiler (unless it is 192causes the specified `gcc' to be used as the C compiler (unless it is
190overridden in the site shell script). 193overridden in the site shell script). Here is a another example:
194
195 /bin/bash ./configure CONFIG_SHELL=/bin/bash
196
197Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
198configuration-related scripts to be executed by `/bin/bash'.
191 199
192`configure' Invocation 200`configure' Invocation
193====================== 201======================
194 202
195 `configure' recognizes the following options to control how it 203`configure' recognizes the following options to control how it operates.
196operates.
197 204
198`--help' 205`--help'
199`-h' 206`-h'
200 Print a summary of the options to `configure', and exit. 207 Print a summary of the options to `configure', and exit.
201 208

Legend:
Removed from v.350  
changed lines
  Added in v.351

  ViewVC Help
Powered by ViewVC 1.1.20