~ubuntu-branches/ubuntu/oneiric/libice/oneiric

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Brice Goglin, Julien Cristau, Brice Goglin
  • Date: 2007-08-21 09:16:11 UTC
  • mfrom: (1.1.3 upstream) (0.2.3 lenny)
  • Revision ID: james.westby@ubuntu.com-20070821091611-wpnd0rc3nk82eidn
Tags: 2:1.0.4-1
[ Julien Cristau ]
* Sync package sections with the override.

[ Brice Goglin ]
* New upstream release.
* Fix typo in long descriptions, thanks Philippe Cloutier
  (closes: #436009).

Show diffs side-by-side

added added

removed removed

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