Annotation of generator/INSTALL, revision 1.1.1.1

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

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.