~ubuntu-branches/ubuntu/utopic/vice/utopic-proposed

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Package Import Robot
  • Author(s): Logan Rosen
  • Date: 2014-05-10 21:08:23 UTC
  • mfrom: (17.1.1 sid)
  • Revision ID: package-import@ubuntu.com-20140510210823-v5aojvy1pv1sg132
Tags: 2.4.dfsg+2.4.6-1ubuntu1
Use autotools-dev to update config.{sub,guess} for new arches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Installation notes for VICE
2
 
***************************
3
 
 
4
 
 
5
 
This version of VICE can be compiled and installed under Unix/X-Window,
6
 
MS-DOS, MS-Windows, OS2, and this file explains how this can be done.
7
 
There is currently no documentation how to compile under RiscOS or BeOS.
8
 
 
9
 
1. What you will need
 
1
Installation Instructions
 
2
*************************
 
3
 
 
4
Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation,
 
5
Inc.
 
6
 
 
7
   Copying and distribution of this file, with or without modification,
 
8
are permitted in any medium without royalty provided the copyright
 
9
notice and this notice are preserved.  This file is offered as-is,
 
10
without warranty of any kind.
 
11
 
 
12
Basic Installation
 
13
==================
 
14
 
 
15
   Briefly, the shell commands `./configure; make; make install' should
 
16
configure, build, and install this package.  The following
 
17
more-detailed instructions are generic; see the `README' file for
 
18
instructions specific to this package.  Some packages provide this
 
19
`INSTALL' file but do not implement all of the features documented
 
20
below.  The lack of an optional feature in a given package is not
 
21
necessarily a bug.  More recommendations for GNU packages can be found
 
22
in *note Makefile Conventions: (standards)Makefile Conventions.
 
23
 
 
24
   The `configure' shell script attempts to guess correct values for
 
25
various system-dependent variables used during compilation.  It uses
 
26
those values to create a `Makefile' in each directory of the package.
 
27
It may also create one or more `.h' files containing system-dependent
 
28
definitions.  Finally, it creates a shell script `config.status' that
 
29
you can run in the future to recreate the current configuration, and a
 
30
file `config.log' containing compiler output (useful mainly for
 
31
debugging `configure').
 
32
 
 
33
   It can also use an optional file (typically called `config.cache'
 
34
and enabled with `--cache-file=config.cache' or simply `-C') that saves
 
35
the results of its tests to speed up reconfiguring.  Caching is
 
36
disabled by default to prevent problems with accidental use of stale
 
37
cache files.
 
38
 
 
39
   If you need to do unusual things to compile the package, please try
 
40
to figure out how `configure' could check whether to do them, and mail
 
41
diffs or instructions to the address given in the `README' so they can
 
42
be considered for the next release.  If you are using the cache, and at
 
43
some point `config.cache' contains results you don't want to keep, you
 
44
may remove or edit it.
 
45
 
 
46
   The file `configure.ac' (or `configure.in') is used to create
 
47
`configure' by a program called `autoconf'.  You need `configure.ac' if
 
48
you want to change it or regenerate `configure' using a newer version
 
49
of `autoconf'.
 
50
 
 
51
   The simplest way to compile this package is:
 
52
 
 
53
  1. `cd' to the directory containing the package's source code and type
 
54
     `./configure' to configure the package for your system.
 
55
 
 
56
     Running `configure' might take a while.  While running, it prints
 
57
     some messages telling which features it is checking for.
 
58
 
 
59
  2. Type `make' to compile the package.
 
60
 
 
61
  3. Optionally, type `make check' to run any self-tests that come with
 
62
     the package, generally using the just-built uninstalled binaries.
 
63
 
 
64
  4. Type `make install' to install the programs and any data files and
 
65
     documentation.  When installing into a prefix owned by root, it is
 
66
     recommended that the package be configured and built as a regular
 
67
     user, and only the `make install' phase executed with root
 
68
     privileges.
 
69
 
 
70
  5. Optionally, type `make installcheck' to repeat any self-tests, but
 
71
     this time using the binaries in their final installed location.
 
72
     This target does not install anything.  Running this target as a
 
73
     regular user, particularly if the prior `make install' required
 
74
     root privileges, verifies that the installation completed
 
75
     correctly.
 
76
 
 
77
  6. You can remove the program binaries and object files from the
 
78
     source code directory by typing `make clean'.  To also remove the
 
79
     files that `configure' created (so you can compile the package for
 
80
     a different kind of computer), type `make distclean'.  There is
 
81
     also a `make maintainer-clean' target, but that is intended mainly
 
82
     for the package's developers.  If you use it, you may have to get
 
83
     all sorts of other programs in order to regenerate files that came
 
84
     with the distribution.
 
85
 
 
86
  7. Often, you can also type `make uninstall' to remove the installed
 
87
     files again.  In practice, not all packages have tested that
 
88
     uninstallation works correctly, even though it is required by the
 
89
     GNU Coding Standards.
 
90
 
 
91
  8. Some packages, particularly those that use Automake, provide `make
 
92
     distcheck', which can by used by developers to test that all other
 
93
     targets like `make install' and `make uninstall' work correctly.
 
94
     This target is generally not run by end users.
 
95
 
 
96
Compilers and Options
10
97
=====================
11
98
 
12
 
  1.1. Unix
13
 
  ---------
14
 
 
15
 
    To compile VICE under Unix, you basically need a Unix machine
16
 
    running the X-Window system version 11 R5 or better, with the
17
 
    standard Xt and Xaw libraries.  R4 should work too, but hasn't
18
 
    been tested lately.
19
 
 
20
 
    If you want to use joysticks under Linux, you must install the
21
 
    proper joystick module (`joystick-0.8.0.tar.gz' or more recent),
22
 
    which is available from `sunsite.unc.edu'.  You can also use a
23
 
    customized `joystick-0.8.0.2.tar.gz' that has support for digital
24
 
    joysticks connected to the parallel port.  This is available from
25
 
    the VICE home page (see the `README' file).
26
 
 
27
 
    Unlike previous (pre-0.12) versions that only worked with 8-bit
28
 
    displays, this release will work with all depths, though 8-bit is
29
 
    still highly recommended for best performance.
30
 
 
31
 
    With version 0.16.0, VICE includes Dag Lem's reSID engine; to
32
 
    compile it, you will need a C++ compiler.
33
 
 
34
 
    NLS (national language support) has been tested with Linux and
35
 
    Solaris systems. The following environment variables have to be
36
 
    set and exported before starting an emulator:
37
 
 
38
 
    - Linux: LANGUAGE=de        # de is currently the only available 
39
 
                                # translation
40
 
                        
41
 
    - Solaris: NLSPATH=${prefix}/lib/locale
42
 
               LC_MESSAGES=de
43
 
 
44
 
    VICE has been compiled successfully on the following Unix systems
45
 
    in the past:
46
 
 
47
 
      - Various i486/Pentium/Pentium Pro PCs running Linux 2.0.x and
48
 
        XFree86 3.2/3.3, with both libc 5 and glibc 2;
49
 
        Further support for October Gnome and newer Versions should work.
50
 
 
51
 
      - Some HP9000 (712, 715, 735, 800) machines running HP-UX 9.x
52
 
        and 10.x;
53
 
 
54
 
      - SUN SPARC 5, 10 and Ultra running Solaris 2.3, 2.4, 2.5, 2.5.1
55
 
        and 2.7.
56
 
        Further support for October Gnome and newer Versions should
57
 
        work. Gnome Libraries prior to October Gnome are known to be
58
 
        broken with Vice.
59
 
        (using gcc);
60
 
 
61
 
      - SUN SPARC 10 running SunOS 4.1 with both X11R4 and X11R5
62
 
        (using gcc);
63
 
 
64
 
      - SUN SPARC 20 running Linux (2.0.30, RedHat 4.2);
65
 
 
66
 
      - SGI Indy R5000 and R4600 running Irix 5.3 and 6.2;
67
 
 
68
 
      - AlphaStation 500/533 with Digital Unix 3.2;
69
 
 
70
 
      - IBM RS6000 running AIX4.1 (using gcc or IBM C++ Set compiler);
71
 
 
72
 
      - MkLinux on Apple Macintosh, Kernel 2.0.33, X11R6.3 (no sound).
73
 
 
74
 
    Unluckily, not all of these systems have been tested with the
75
 
    current release.  Success/failure reports are welcome at any time.
76
 
    If you encounter any problems, you probably want to read the Hints
77
 
    section below.
78
 
 
79
 
    If you are compiling on a Pentium machine, you might consider
80
 
    using the Pentium-specific GCC compiler, which is available at
81
 
    `http://www.goof.com/pcg'.  Each time we have tried it, and the
82
 
    performance was always at least 20% better (even with just `-O2'
83
 
    or `-O3').  However some versions of PGCC are known to produce
84
 
    broken executables.  If you observe graphics errors try to compile
85
 
    without optimizations.  If the graphics errors disappear, throw
86
 
    away your compiler and install another one.
87
 
 
88
 
    Warning: you might need quite a lot of memory to compile VICE with
89
 
    full optimizations on some platforms (in particular, this happens
90
 
    with the Pentium-specific GCC).  Moreover, archaic versions of GCC
91
 
    (e.g. 2.5.x and older) are known to cause trouble.  In that case,
92
 
    it is a good idea to upgrade the compiler to a more recent
93
 
    version.
94
 
 
95
 
  1.2. MS-DOS
96
 
  -----------
97
 
 
98
 
    The MS-DOS port requires the Allegro library by Shawn Hargreaves
99
 
    (`http://www.talula.demon.co.uk/allegro') to be compiled.
100
 
 
101
 
    You might apply this patch to `src/djgpp/timer.c' to achieve better
102
 
    results on low end machines.
103
 
 
104
 
    --- old-timer.c Sat Jan  2 03:29:55 1999
105
 
    +++ timer.c     Sat Jan  2 03:30:02 1999
106
 
    @@ -197,8 +197,9 @@
107
 
           new_delay = bios_counter;
108
 
 
109
 
        /* fudge factor to prevent interrupts coming too close to each other */
110
 
    -   if (new_delay < 1024)
111
 
    -      timer_delay = 1024;
112
 
    +   /* FIXME: changed from 1024 to 0 (EP) */
113
 
    +   if (new_delay < 0)
114
 
    +      timer_delay = 0;
115
 
        else
116
 
           timer_delay = new_delay;
117
 
 
118
 
    Moreover, you also need DJGPP, the MS-DOS port of GCC
119
 
    (`http://www.delorie.com').
120
 
 
121
 
    There is a separate file `MSDOS-Howto.txt' in the `doc' directory
122
 
    describing what is required to compile VICE under MS-DOS.
123
 
 
124
 
  1.3.MS-Windows 
125
 
  --------------
126
 
 
127
 
    There is a separate file `Win32-Howto.txt' in the `doc' directory
128
 
    describing what is required to compile VICE under MS-Windows.
129
 
 
130
 
  1.4. OS/2
131
 
  --------------
132
 
 
133
 
    After unzipping the archive and moving the folder 'Vice2' to
134
 
    where-ever-you-want run 'install.cmd' to create the desktop-objects.
135
 
 
136
 
    Mention that 'install.cmd' does nothing else than creating desktop-
137
 
    objects which could be easily removed.
138
 
    
139
 
 
140
 
2. Configuring and compiling
141
 
============================
142
 
 
143
 
  2.1. Compiling under Unix, for Unix or MS-DOS
144
 
  ---------------------------------------------
145
 
 
146
 
    The release comes with an auto-configuring script created using
147
 
    the GNU autoconf package; this script must be executed before
148
 
    compiling VICE to detect the characteristics of your machine and
149
 
    specify certain features you might want to enable or disable.
150
 
 
151
 
    To execute the configuration script, enter the distribution directory
152
 
    and type:
153
 
 
154
 
      ./configure <options>
155
 
 
156
 
    There are several options available, and some of them are not
157
 
    necessary for the configuration. The important ones are:
158
 
 
159
 
      --prefix=PREFIX (default is `/usr/local/')
160
 
      --bindir=DIR (default is `PREFIX/bin')
161
 
      --mandir=DIR (default is `PREFIX/man')
162
 
 
163
 
        Specify the place where the VICE executable and support files
164
 
        will be installed.
165
 
 
166
 
      --host=HOST
167
 
 
168
 
        Specify the host for which the executable will be produced.
169
 
        If you want to compile for MS-DOS from a Unix machine using
170
 
        GCC, use `--host=i386-go32-gnu'.  If not specified, the
171
 
        configure script tries to guess it by itself, so you normally
172
 
        don't need to use this option.
173
 
 
174
 
      --x-includes=DIR
175
 
      --x-libraries=DIR
176
 
 
177
 
        Specify the paths for X11 include files and libraries.  The
178
 
        configure script is usually smart enough to find them by
179
 
        itself if the setup is not too odd; use these option if it is
180
 
        not.
181
 
 
182
 
      --enable-autobpp
183
 
      --enable-8bpp
184
 
      --enable-16bpp
185
 
      --enable-24bpp
186
 
 
187
 
        Specify the bit depth of your X11 display.  The default is
188
 
        `autobpp', that enables support for all bit depths (the
189
 
        emulator tries to find the ones your server supports by itself
190
 
        at runtime).  If you think you are going to use only one type
191
 
        of display, specifying this might give you (very) slightly
192
 
        better performance.
193
 
 
194
 
      --disable-textfield
195
 
 
196
 
        Disable Robert W. McMullen's text widget; if you experience
197
 
        problems with the text or file manager widgets, you can enable
198
 
        the standard Athena one by using this option.  This can also
199
 
        be useful if you are using a non-standard Athena-compatible
200
 
        library that provides a better looking text widget; it that
201
 
        case, using this option will give you that one (this is true
202
 
        for neXtaw, for example).
203
 
        Problems are known to occur on DEC Alpha systems running
204
 
        Digital Unix.
205
 
 
206
 
      --with-xaw3d
207
 
 
208
 
        Use Xaw3d (instead of plain Xaw) if present.
209
 
 
210
 
      --without-resid
211
 
      --with-resid=no
212
 
 
213
 
        Compile without the enhanced reSID engine.
214
 
 
215
 
      --with-resid=PATH
216
 
 
217
 
        Compile with a reSID engine located at `PATH'.  This is useful
218
 
        in case you want to compile VICE with another version of the
219
 
        reSID engine.
220
 
 
221
 
      --enable-gnomeui
222
 
 
223
 
        Compile Vice supporting the Gnome libraries. The location of
224
 
        the Gnome/Gtk+ libraries are not detected automatically,
225
 
        therefore `gnome-config' has to be found in the configuring
226
 
        users path. Refer `to src/arch/unix/x11/gnome/TODO' for a list
227
 
        of known problems/limitations.
228
 
 
229
 
     --disable-nls
230
 
 
231
 
        Force configure to ignore NLS support.
232
 
 
233
 
 
234
 
    (to obtain a complete list of the available options with a
235
 
    description, use `./configure --help')
236
 
 
237
 
    By default, VICE will be compiled by passing the following options
238
 
    to the C compiler:
239
 
 
240
 
      `-g -Wall -O5 -fomit-frame-pointer -funroll-loops
241
 
       -finline-functions -fno-strength-reduce'
242
 
          on Intel-based x86 Unix systems that have gcc installed;
243
 
 
244
 
      `-g -Wall -O5 -finline-functions'
245
 
          on other systems that have gcc installed;
246
 
 
247
 
      `-g'
248
 
          on systems that do not have gcc installed.
249
 
 
250
 
    If these options do not fit your needs, you can specify what
251
 
    options you want by simply passing them in the `CFLAGS' variable,
252
 
    e.g. this is something you might want to do on HP-UX:
253
 
 
254
 
      CFLAGS="-Ae -g +O3" ./configure
255
 
 
256
 
    In the same way, you can force usage of a specific C compiler by
257
 
    passing the `CC' variable, e.g.:
258
 
 
259
 
      CC="cc" CFLAGS="-Ae -g +O3" ./configure
260
 
 
261
 
    To specify a C++ compiler, use the `CXX' variable:
262
 
 
263
 
      CXX="g++" CFLAGS="-Wall -Wno-strict-prototypes" ./configure
264
 
 
265
 
    Important notice: if you use the Pentium-specific GCC, some
266
 
    optimizations might have to be disabled.  The best way to make
267
 
    sure everything works is
268
 
 
269
 
      CFLAGS="-mpentium -O3" ./configure
270
 
 
271
 
    If you are running on a Linux system and the joystick module is
272
 
    installed properly, the configure script will auto-detect it and
273
 
    support for it will be enabled.  Otherwise, the joystick will be
274
 
    only emulated with the numeric keypad.
275
 
 
276
 
    In case the `configure' script fails or complains about missing
277
 
    libraries and you cannot explain this, please send the
278
 
    `config.log' file to us together with a precise description of
279
 
    your setup; otherwise, we cannot guess what is wrong with it.
280
 
 
281
 
    When the configure script has finished, the necessary Makefiles
282
 
    will be produced and you can simply type
283
 
 
284
 
      make
285
 
 
286
 
    to build all the emulators and utilities (`x128', `x64', `xcbm2',
287
 
    `xpet', `xplus4', `xvic', `c1541', `petcat') under the `src'
288
 
    directory.  It is possible that `configure' is not able to find all
289
 
    the needed libraries automatically (this is usually due to a weird
290
 
    setup); if this happens, the script will report a warning message
291
 
    but the `Makefile' will be produced anyway.  In this case, you can
292
 
    try to re-run `configure' with different options or edit the
293
 
    `Makefile's by hand to add the missing options.
294
 
 
295
 
    If you are cross-compiling for MS-DOS, check that all the DJGPP
296
 
    libraries and include files, together with Allegro, are in the
297
 
    right places.
298
 
 
299
 
    If you want to install the emulators and utilities, together with
300
 
    the documentation and ROM files, just type
301
 
 
302
 
      make install
303
 
 
304
 
    The binaries and support files will all go under PREFIX/lib/vice.
305
 
    You must of course have write permissions for the directories where
306
 
    VICE is to be installed. Normally only the system administrator
307
 
    has write access to /usr/local, the default PREFIX. Either ask
308
 
    your system administrator to install VICE for you or use a PREFIX
309
 
    in your home directory for example, where you do have write access.
310
 
 
311
 
    If you want to remove VICE from your system, you can use
312
 
 
313
 
      make uninstall
314
 
 
315
 
    If you want to re-compile with different options, you should do a
316
 
 
317
 
      make mrproper
318
 
 
319
 
    This will also remove the cache of the `configure' script,
320
 
    assuring that all the tests are performed from scratch.
321
 
 
322
 
  2.2. Configuring for multiple architectures
323
 
  -------------------------------------------
324
 
 
325
 
    As with most packages using GNU autoconf, you can compile VICE for
326
 
    multiple architectures from the same source tree.
327
 
 
328
 
    To do so, simply create a build directory:
329
 
 
330
 
      mkdir {build-dir}
331
 
 
332
 
    Then run `configure' from the VICE source tree:
333
 
 
334
 
      {vice-source-path}/configure
335
 
 
336
 
    Of course, you can specify options, flags, etc. as explained on
337
 
    par. 2.1.
338
 
 
339
 
    After you have configured VICE this way, you can simply compile
340
 
    VICE as you would normally do, by typing `make'.
341
 
 
342
 
    For example, you might want to do something like this to produce
343
 
    and MS-DOS executable of X64 (let's suppose a cross-compiling GCC
344
 
    is installed as `gcc-dos' somewhere in your `$PATH'):
345
 
 
346
 
      cd sources/vice-0.14.2
347
 
      mkdir i386-go32-msdos
348
 
      cd i386-go32-msdos
349
 
      CC="gcc-dos" CFLAGS="-O5" ../configure --host=i386-go32-msdos
350
 
      make x64
351
 
 
352
 
 
353
 
3. Hints
354
 
========
355
 
 
356
 
  In this section we compiled some hints about problems we encountered
357
 
  on different test machines and different setups. Any comments on or even 
358
 
  solutions to these problems are welcome. 
359
 
 
360
 
  On Unix, if you are using alternative Xaw libraries (e.g. neXtaw,
361
 
  Xaw95, Xaw3d) and you are having troubles with the GUI, try to use
362
 
  the standard Xaw first.  There are some incompatibilities that can
363
 
  cause them to crash or not to work properly.  Xaw3d should work, but
364
 
  in any case please try to use the standard Xaw library before
365
 
  reporting bugs.
366
 
 
367
 
  If you can, please use GCC (or EGCS) instead of the vendor's CC
368
 
  supplied with your machine: it is usually less buggy and produces
369
 
  better code.  On certain systems (most notably SunOS), configure
370
 
  might completely refuse to use the standard CC.
371
 
 
372
 
  Some version of the HP-UX 10.x linker was also reported to fail
373
 
  linking `x128'.  Unluckily, we believe it's a bug in the system and
374
 
  we don't know a way to fix this problem (and we did not try very
375
 
  hard, either).  If you know how, please let us know.
376
 
 
377
 
  Some versions of GCC seem to have troubles with `-funroll-loops' on
378
 
  certain architectures; on an Alpha and a SPARC we have tried to
379
 
  compile VICE on, the compiler died while trying to optimize the code
380
 
  when this option was specified (GCC version 2.7.2).  If you
381
 
  experience such a problem reconfigure by specifying the `CFLAGS' as
382
 
  explained above, removing `-funroll-loops'.
383
 
 
384
 
  SunOS 4.1.x systems running X11R4 can cause a couple of troubles.
385
 
  The first one is that `configure' might not find `-lXmu' and `-lXaw'
386
 
  properly, because of some issues related to dynamic libraries.  This
387
 
  would need some custom `configure' checks, which might be made
388
 
  available in future versions.  For now, just edit `src/Makefile'
389
 
  after it has been created by `configure' and add `-lXaw -lXmu' (in
390
 
  this order) before `-lXt' on the `LIBS=...' line.  Moreover, you
391
 
  might get undefined references to
392
 
 
393
 
    _get_wmShellWidgetClass
394
 
    _get_applicationShellWidgetClass
395
 
 
396
 
  when linking `x64', `xvic' or `xpet'.  In that case you have to link
397
 
  `-lXmu' statically (default is dynamically).  This can be done by
398
 
  editing the `Makefile' by hand and replacing `-lXmu' with `-Bstatic
399
 
  -lXmu -Bdynamic' in the `LIBS=...'  line.  A simplier way is to link
400
 
  *everything* statically; this can be achieved by running `configure'
401
 
  like this:
402
 
 
403
 
    LDFLAGS="-static" ./configure
404
 
 
405
 
  This will build much bigger executables, though.  We are sorry, but
406
 
  that is not our fault.
407
 
 
408
 
  Some HP-UX (versions 9 and 10) need the "--without-readline" switch
409
 
  because autoconf fails to detect that it needs "-lcurses"
410
 
  (the configure test passes, but the compile is broken. Is this an
411
 
  autoconf bug?). 
412
 
 
413
 
  One HP-UX 9 test machine failed to compile resid.cc, probably 
414
 
  due to a broken gcc installation. In this case try to apply this 
415
 
  patch:
416
 
--------------------------
417
 
--- vice-old/src/sid/resid.cc  Wed Mar 10 22:57:19 1999
418
 
+++ vice-new/src/sid/resid.cc  Mon Apr 12 16:22:03 1999
419
 
@@ -27,10 +27,11 @@
420
 
 
421
 
 #include "resid/sid.h"
422
 
 
423
 
-extern "C" {
424
 
 
425
 
 #include <stdio.h>
426
 
 #include <math.h>
427
 
+
428
 
+extern "C" {
429
 
 
430
 
 #include "vice.h"
431
 
 #include "sid.h"
432
 
--------------------------
433
 
  
434
 
  When compiling on AIX in a directory different from where the source 
435
 
  is and with the native C++ compiler "cc", then the C++ compiler mixes 
436
 
  up the order in which include files are included. This makes the `resid'
437
 
  package wrongly believe that `bool' is defined. You might use
438
 
  `CXX="cc -qidirfirst"' instead. 
439
 
  On the other hand using "cc" as C++ compiler resulted in a linkage 
440
 
  error on our test machine. We thus recommend using the GCC C++ compiler 
441
 
  or the configure switch `--without-resid'.
442
 
  If you know how to fix this, any comments are welcome.
443
 
 
444
 
  On a DEC alpha-EV6 machine (64 bit, OSF1 operating system) when using
445
 
  the DEC compiler, you might want to use `CC="cc -std1"' to enforce ANSI C
446
 
  standard.
447
 
 
448
 
  To build a debug version of VICE, use `CFLAGS="-g -DNO_INLINE"'.
449
 
  This disables inlining of functions in most of the places and does not
450
 
  do any optimization. This way the debugger can produce a much better 
451
 
  output. This also serves as a test whether the compiler optimization
452
 
  breaks the code.
 
99
   Some systems require unusual options for compilation or linking that
 
100
the `configure' script does not know about.  Run `./configure --help'
 
101
for details on some of the pertinent environment variables.
 
102
 
 
103
   You can give `configure' initial values for configuration parameters
 
104
by setting variables in the command line or in the environment.  Here
 
105
is an example:
 
106
 
 
107
     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
 
108
 
 
109
   *Note Defining Variables::, for more details.
 
110
 
 
111
Compiling For Multiple Architectures
 
112
====================================
 
113
 
 
114
   You can compile the package for more than one kind of computer at the
 
115
same time, by placing the object files for each architecture in their
 
116
own directory.  To do this, you can use GNU `make'.  `cd' to the
 
117
directory where you want the object files and executables to go and run
 
118
the `configure' script.  `configure' automatically checks for the
 
119
source code in the directory that `configure' is in and in `..'.  This
 
120
is known as a "VPATH" build.
 
121
 
 
122
   With a non-GNU `make', it is safer to compile the package for one
 
123
architecture at a time in the source code directory.  After you have
 
124
installed the package for one architecture, use `make distclean' before
 
125
reconfiguring for another architecture.
 
126
 
 
127
   On MacOS X 10.5 and later systems, you can create libraries and
 
128
executables that work on multiple system types--known as "fat" or
 
129
"universal" binaries--by specifying multiple `-arch' options to the
 
130
compiler but only a single `-arch' option to the preprocessor.  Like
 
131
this:
 
132
 
 
133
     ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 
134
                 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 
135
                 CPP="gcc -E" CXXCPP="g++ -E"
 
136
 
 
137
   This is not guaranteed to produce working output in all cases, you
 
138
may have to build one architecture at a time and combine the results
 
139
using the `lipo' tool if you have problems.
 
140
 
 
141
Installation Names
 
142
==================
 
143
 
 
144
   By default, `make install' installs the package's commands under
 
145
`/usr/local/bin', include files under `/usr/local/include', etc.  You
 
146
can specify an installation prefix other than `/usr/local' by giving
 
147
`configure' the option `--prefix=PREFIX', where PREFIX must be an
 
148
absolute file name.
 
149
 
 
150
   You can specify separate installation prefixes for
 
151
architecture-specific files and architecture-independent files.  If you
 
152
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 
153
PREFIX as the prefix for installing programs and libraries.
 
154
Documentation and other data files still use the regular prefix.
 
155
 
 
156
   In addition, if you use an unusual directory layout you can give
 
157
options like `--bindir=DIR' to specify different values for particular
 
158
kinds of files.  Run `configure --help' for a list of the directories
 
159
you can set and what kinds of files go in them.  In general, the
 
160
default for these options is expressed in terms of `${prefix}', so that
 
161
specifying just `--prefix' will affect all of the other directory
 
162
specifications that were not explicitly provided.
 
163
 
 
164
   The most portable way to affect installation locations is to pass the
 
165
correct locations to `configure'; however, many packages provide one or
 
166
both of the following shortcuts of passing variable assignments to the
 
167
`make install' command line to change installation locations without
 
168
having to reconfigure or recompile.
 
169
 
 
170
   The first method involves providing an override variable for each
 
171
affected directory.  For example, `make install
 
172
prefix=/alternate/directory' will choose an alternate location for all
 
173
directory configuration variables that were expressed in terms of
 
174
`${prefix}'.  Any directories that were specified during `configure',
 
175
but not in terms of `${prefix}', must each be overridden at install
 
176
time for the entire installation to be relocated.  The approach of
 
177
makefile variable overrides for each directory variable is required by
 
178
the GNU Coding Standards, and ideally causes no recompilation.
 
179
However, some platforms have known limitations with the semantics of
 
180
shared libraries that end up requiring recompilation when using this
 
181
method, particularly noticeable in packages that use GNU Libtool.
 
182
 
 
183
   The second method involves providing the `DESTDIR' variable.  For
 
184
example, `make install DESTDIR=/alternate/directory' will prepend
 
185
`/alternate/directory' before all installation names.  The approach of
 
186
`DESTDIR' overrides is not required by the GNU Coding Standards, and
 
187
does not work on platforms that have drive letters.  On the other hand,
 
188
it does better at avoiding recompilation issues, and works well even
 
189
when some directory options were not specified in terms of `${prefix}'
 
190
at `configure' time.
 
191
 
 
192
Optional Features
 
193
=================
 
194
 
 
195
   If the package supports it, you can cause programs to be installed
 
196
with an extra prefix or suffix on their names by giving `configure' the
 
197
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 
198
 
 
199
   Some packages pay attention to `--enable-FEATURE' options to
 
200
`configure', where FEATURE indicates an optional part of the package.
 
201
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 
202
is something like `gnu-as' or `x' (for the X Window System).  The
 
203
`README' should mention any `--enable-' and `--with-' options that the
 
204
package recognizes.
 
205
 
 
206
   For packages that use the X Window System, `configure' can usually
 
207
find the X include and library files automatically, but if it doesn't,
 
208
you can use the `configure' options `--x-includes=DIR' and
 
209
`--x-libraries=DIR' to specify their locations.
 
210
 
 
211
   Some packages offer the ability to configure how verbose the
 
212
execution of `make' will be.  For these packages, running `./configure
 
213
--enable-silent-rules' sets the default to minimal output, which can be
 
214
overridden with `make V=1'; while running `./configure
 
215
--disable-silent-rules' sets the default to verbose, which can be
 
216
overridden with `make V=0'.
 
217
 
 
218
Particular systems
 
219
==================
 
220
 
 
221
   On HP-UX, the default C compiler is not ANSI C compatible.  If GNU
 
222
CC is not installed, it is recommended to use the following options in
 
223
order to use an ANSI C compiler:
 
224
 
 
225
     ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
 
226
 
 
227
and if that doesn't work, install pre-built binaries of GCC for HP-UX.
 
228
 
 
229
   HP-UX `make' updates targets which have the same time stamps as
 
230
their prerequisites, which makes it generally unusable when shipped
 
231
generated files such as `configure' are involved.  Use GNU `make'
 
232
instead.
 
233
 
 
234
   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
 
235
parse its `<wchar.h>' header file.  The option `-nodtk' can be used as
 
236
a workaround.  If GNU CC is not installed, it is therefore recommended
 
237
to try
 
238
 
 
239
     ./configure CC="cc"
 
240
 
 
241
and if that doesn't work, try
 
242
 
 
243
     ./configure CC="cc -nodtk"
 
244
 
 
245
   On Solaris, don't put `/usr/ucb' early in your `PATH'.  This
 
246
directory contains several dysfunctional programs; working variants of
 
247
these programs are available in `/usr/bin'.  So, if you need `/usr/ucb'
 
248
in your `PATH', put it _after_ `/usr/bin'.
 
249
 
 
250
   On Haiku, software installed for all users goes in `/boot/common',
 
251
not `/usr/local'.  It is recommended to use the following options:
 
252
 
 
253
     ./configure --prefix=/boot/common
 
254
 
 
255
Specifying the System Type
 
256
==========================
 
257
 
 
258
   There may be some features `configure' cannot figure out
 
259
automatically, but needs to determine by the type of machine the package
 
260
will run on.  Usually, assuming the package is built to be run on the
 
261
_same_ architectures, `configure' can figure that out, but if it prints
 
262
a message saying it cannot guess the machine type, give it the
 
263
`--build=TYPE' option.  TYPE can either be a short name for the system
 
264
type, such as `sun4', or a canonical name which has the form:
 
265
 
 
266
     CPU-COMPANY-SYSTEM
 
267
 
 
268
where SYSTEM can have one of these forms:
 
269
 
 
270
     OS
 
271
     KERNEL-OS
 
272
 
 
273
   See the file `config.sub' for the possible values of each field.  If
 
274
`config.sub' isn't included in this package, then this package doesn't
 
275
need to know the machine type.
 
276
 
 
277
   If you are _building_ compiler tools for cross-compiling, you should
 
278
use the option `--target=TYPE' to select the type of system they will
 
279
produce code for.
 
280
 
 
281
   If you want to _use_ a cross compiler, that generates code for a
 
282
platform different from the build platform, you should specify the
 
283
"host" platform (i.e., that on which the generated programs will
 
284
eventually be run) with `--host=TYPE'.
 
285
 
 
286
Sharing Defaults
 
287
================
 
288
 
 
289
   If you want to set default values for `configure' scripts to share,
 
290
you can create a site shell script called `config.site' that gives
 
291
default values for variables like `CC', `cache_file', and `prefix'.
 
292
`configure' looks for `PREFIX/share/config.site' if it exists, then
 
293
`PREFIX/etc/config.site' if it exists.  Or, you can set the
 
294
`CONFIG_SITE' environment variable to the location of the site script.
 
295
A warning: not all `configure' scripts look for a site script.
 
296
 
 
297
Defining Variables
 
298
==================
 
299
 
 
300
   Variables not defined in a site shell script can be set in the
 
301
environment passed to `configure'.  However, some packages may run
 
302
configure again during the build, and the customized values of these
 
303
variables may be lost.  In order to avoid this problem, you should set
 
304
them in the `configure' command line, using `VAR=value'.  For example:
 
305
 
 
306
     ./configure CC=/usr/local2/bin/gcc
 
307
 
 
308
causes the specified `gcc' to be used as the C compiler (unless it is
 
309
overridden in the site shell script).
 
310
 
 
311
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
 
312
an Autoconf bug.  Until the bug is fixed you can use this workaround:
 
313
 
 
314
     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
 
315
 
 
316
`configure' Invocation
 
317
======================
 
318
 
 
319
   `configure' recognizes the following options to control how it
 
320
operates.
 
321
 
 
322
`--help'
 
323
`-h'
 
324
     Print a summary of all of the options to `configure', and exit.
 
325
 
 
326
`--help=short'
 
327
`--help=recursive'
 
328
     Print a summary of the options unique to this package's
 
329
     `configure', and exit.  The `short' variant lists options used
 
330
     only in the top level, while the `recursive' variant lists options
 
331
     also present in any nested packages.
 
332
 
 
333
`--version'
 
334
`-V'
 
335
     Print the version of Autoconf used to generate the `configure'
 
336
     script, and exit.
 
337
 
 
338
`--cache-file=FILE'
 
339
     Enable the cache: use and save the results of the tests in FILE,
 
340
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
 
341
     disable caching.
 
342
 
 
343
`--config-cache'
 
344
`-C'
 
345
     Alias for `--cache-file=config.cache'.
 
346
 
 
347
`--quiet'
 
348
`--silent'
 
349
`-q'
 
350
     Do not print messages saying which checks are being made.  To
 
351
     suppress all normal output, redirect it to `/dev/null' (any error
 
352
     messages will still be shown).
 
353
 
 
354
`--srcdir=DIR'
 
355
     Look for the package's source code in directory DIR.  Usually
 
356
     `configure' can determine that directory automatically.
 
357
 
 
358
`--prefix=DIR'
 
359
     Use DIR as the installation prefix.  *note Installation Names::
 
360
     for more details, including other options available for fine-tuning
 
361
     the installation locations.
 
362
 
 
363
`--no-create'
 
364
`-n'
 
365
     Run the configure checks, but stop before creating any output
 
366
     files.
 
367
 
 
368
`configure' also accepts some other, not widely useful, options.  Run
 
369
`configure --help' for more details.
453
370