annotate INSTALL @ 408:2a94b2e64621

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