~sarahstrong/ubuntu/lucid/gedit/mypatch

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Joe Drew
  • Date: 2002-01-13 02:13:27 UTC
  • Revision ID: james.westby@ubuntu.com-20020113021327-dukaa4n50oykvrjg
Tags: upstream-0.9.6
ImportĀ upstreamĀ versionĀ 0.9.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Basic Installation
 
2
==================
 
3
 
 
4
Instalation Instructions for a '.RPM' or a '.SRPM':
 
5
==============================================
 
6
rpm -Uvh <rpm-file>
 
7
 
 
8
Instalation Instructions for a 'tar.gz' file :
 
9
==============================================
 
10
 
 
11
   These are generic installation instructions.
 
12
 
 
13
   The `configure' shell script attempts to guess correct values for
 
14
various system-dependent variables used during compilation.  It uses
 
15
those values to create a `Makefile' in each directory of the package.
 
16
It may also create one or more `.h' files containing system-dependent
 
17
definitions.  Finally, it creates a shell script `config.status' that
 
18
you can run in the future to recreate the current configuration, a file
 
19
`config.cache' that saves the results of its tests to speed up
 
20
reconfiguring, and a file `config.log' containing compiler output
 
21
(useful mainly for debugging `configure').
 
22
 
 
23
   If you need to do unusual things to compile the package, please try
 
24
to figure out how `configure' could check whether to do them, and mail
 
25
diffs or instructions to the address given in the `README' so they can
 
26
be considered for the next release.  If at some point `config.cache'
 
27
contains results you don't want to keep, you may remove or edit it.
 
28
 
 
29
   The file `configure.in' is used to create `configure' by a program
 
30
called `autoconf'.  You only need `configure.in' if you want to change
 
31
it or regenerate `configure' using a newer version of `autoconf'.
 
32
 
 
33
The simplest way to compile this package is:
 
34
 
 
35
  1. `cd' to the directory containing the package's source code and type
 
36
     `./configure' to configure the package for your system.  If you're
 
37
     using `csh' on an old version of System V, you might need to type
 
38
     `sh ./configure' instead to prevent `csh' from trying to execute
 
39
     `configure' itself.
 
40
 
 
41
     Running `configure' takes awhile.  While running, it prints some
 
42
     messages telling which features it is checking for.
 
43
 
 
44
  2. Type `make' to compile the package.
 
45
 
 
46
  3. Optionally, type `make check' to run any self-tests that come with
 
47
     the package.
 
48
 
 
49
  4. Type `make install' to install the programs and any data files and
 
50
     documentation.
 
51
 
 
52
  5. You can remove the program binaries and object files from the
 
53
     source code directory by typing `make clean'.  To also remove the
 
54
     files that `configure' created (so you can compile the package for
 
55
     a different kind of computer), type `make distclean'.  There is
 
56
     also a `make maintainer-clean' target, but that is intended mainly
 
57
     for the package's developers.  If you use it, you may have to get
 
58
     all sorts of other programs in order to regenerate files that came
 
59
     with the distribution.
 
60
 
 
61
Compilers and Options
 
62
=====================
 
63
 
 
64
   Some systems require unusual options for compilation or linking that
 
65
the `configure' script does not know about.  You can give `configure'
 
66
initial values for variables by setting them in the environment.  Using
 
67
a Bourne-compatible shell, you can do that on the command line like
 
68
this:
 
69
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 
70
 
 
71
Or on systems that have the `env' program, you can do it like this:
 
72
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 
73
 
 
74
Compiling For Multiple Architectures
 
75
====================================
 
76
 
 
77
   You can compile the package for more than one kind of computer at the
 
78
same time, by placing the object files for each architecture in their
 
79
own directory.  To do this, you must use a version of `make' that
 
80
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 
81
directory where you want the object files and executables to go and run
 
82
the `configure' script.  `configure' automatically checks for the
 
83
source code in the directory that `configure' is in and in `..'.
 
84
 
 
85
   If you have to use a `make' that does not supports the `VPATH'
 
86
variable, you have to compile the package for one architecture at a time
 
87
in the source code directory.  After you have installed the package for
 
88
one architecture, use `make distclean' before reconfiguring for another
 
89
architecture.
 
90
 
 
91
Installation Names
 
92
==================
 
93
 
 
94
   By default, `make install' will install the package's files in
 
95
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
 
96
installation prefix other than `/usr/local' by giving `configure' the
 
97
option `--prefix=PATH'.
 
98
 
 
99
   You can specify separate installation prefixes for
 
100
architecture-specific files and architecture-independent files.  If you
 
101
give `configure' the option `--exec-prefix=PATH', the package will use
 
102
PATH as the prefix for installing programs and libraries.
 
103
Documentation and other data files will still use the regular prefix.
 
104
 
 
105
   In addition, if you use an unusual directory layout you can give
 
106
options like `--bindir=PATH' to specify different values for particular
 
107
kinds of files.  Run `configure --help' for a list of the directories
 
108
you can set and what kinds of files go in them.
 
109
 
 
110
   If the package supports it, you can cause programs to be installed
 
111
with an extra prefix or suffix on their names by giving `configure' the
 
112
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 
113
 
 
114
Optional Features
 
115
=================
 
116
 
 
117
   Some packages pay attention to `--enable-FEATURE' options to
 
118
`configure', where FEATURE indicates an optional part of the package.
 
119
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 
120
is something like `gnu-as' or `x' (for the X Window System).  The
 
121
`README' should mention any `--enable-' and `--with-' options that the
 
122
package recognizes.
 
123
 
 
124
   For packages that use the X Window System, `configure' can usually
 
125
find the X include and library files automatically, but if it doesn't,
 
126
you can use the `configure' options `--x-includes=DIR' and
 
127
`--x-libraries=DIR' to specify their locations.
 
128
 
 
129
Specifying the System Type
 
130
==========================
 
131
 
 
132
   There may be some features `configure' can not figure out
 
133
automatically, but needs to determine by the type of host the package
 
134
will run on.  Usually `configure' can figure that out, but if it prints
 
135
a message saying it can not guess the host type, give it the
 
136
`--host=TYPE' option.  TYPE can either be a short name for the system
 
137
type, such as `sun4', or a canonical name with three fields:
 
138
     CPU-COMPANY-SYSTEM
 
139
 
 
140
See the file `config.sub' for the possible values of each field.  If
 
141
`config.sub' isn't included in this package, then this package doesn't
 
142
need to know the host type.
 
143
 
 
144
   If you are building compiler tools for cross-compiling, you can also
 
145
use the `--target=TYPE' option to select the type of system they will
 
146
produce code for and the `--build=TYPE' option to select the type of
 
147
system on which you are compiling the package.
 
148
 
 
149
Sharing Defaults
 
150
================
 
151
 
 
152
   If you want to set default values for `configure' scripts to share,
 
153
you can create a site shell script called `config.site' that gives
 
154
default values for variables like `CC', `cache_file', and `prefix'.
 
155
`configure' looks for `PREFIX/share/config.site' if it exists, then
 
156
`PREFIX/etc/config.site' if it exists.  Or, you can set the
 
157
`CONFIG_SITE' environment variable to the location of the site script.
 
158
A warning: not all `configure' scripts look for a site script.
 
159
 
 
160
Operation Controls
 
161
==================
 
162
 
 
163
   `configure' recognizes the following options to control how it
 
164
operates.
 
165
 
 
166
`--cache-file=FILE'
 
167
     Use and save the results of the tests in FILE instead of
 
168
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 
169
     debugging `configure'.
 
170
 
 
171
`--help'
 
172
     Print a summary of the options to `configure', and exit.
 
173
 
 
174
`--quiet'
 
175
`--silent'
 
176
`-q'
 
177
     Do not print messages saying which checks are being made.  To
 
178
     suppress all normal output, redirect it to `/dev/null' (any error
 
179
     messages will still be shown).
 
180
 
 
181
`--srcdir=DIR'
 
182
     Look for the package's source code in directory DIR.  Usually
 
183
     `configure' can determine that directory automatically.
 
184
 
 
185
`--version'
 
186
     Print the version of Autoconf used to generate the `configure'
 
187
     script, and exit.
 
188
 
 
189
`configure' also accepts some other, not widely useful, options.