Pierrick Martin / ctools

Commit b83a92ec3f1a0a86885361894b9eae44f06f7791

Authored by knodlseder
1 parent f68a241a

initial version

Inline Side-by-side
Showing 1 changed file with 290 additions and 0 deletions
INSTALL 0 → 100644
  View file @b83a92e
  1 +Basic Installation
  2 +==================
  3 +
  4 + These are generic installation instructions.
  5 +
  6 + The `configure' shell script attempts to guess correct values for
  7 +various system-dependent variables used during compilation. It uses
  8 +those values to create a `Makefile' in each directory of the package.
  9 +It may also create one or more `.h' files containing system-dependent
  10 +definitions. Finally, it creates a shell script `config.status' that
  11 +you can run in the future to recreate the current configuration, and a
  12 +file `config.log' containing compiler output (useful mainly for
  13 +debugging `configure').
  14 +
  15 + It can also use an optional file (typically called `config.cache'
  16 +and enabled with `--cache-file=config.cache' or simply `-C') that saves
  17 +the results of its tests to speed up reconfiguring. Caching is
  18 +disabled by default to prevent problems with accidental use of stale
  19 +cache files.
  20 +
  21 + If you need to do unusual things to compile the package, please try
  22 +to figure out how `configure' could check whether to do them, and mail
  23 +diffs or instructions to the address given in the `README' so they can
  24 +be considered for the next release. If you are using the cache, and at
  25 +some point `config.cache' contains results you don't want to keep, you
  26 +may remove or edit it.
  27 +
  28 + The file `configure.ac' (or `configure.in') is used to create
  29 +`configure' by a program called `autoconf'. You need `configure.ac' if
  30 +you want to change it or regenerate `configure' using a newer version
  31 +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.
  37 +
  38 + Running `configure' might take a while. While running, it prints
  39 + some messages telling which features it is checking for.
  40 +
  41 + 2. Type `make' to compile the package.
  42 +
  43 + 3. Optionally, type `make check' to run any self-tests that come with
  44 + the package.
  45 +
  46 + 4. Type `make install' to install the programs and any data files and
  47 + documentation.
  48 +
  49 + 5. You can remove the program binaries and object files from the
  50 + source code directory by typing `make clean'. To also remove the
  51 + files that `configure' created (so you can compile the package for
  52 + a different kind of computer), type `make distclean'. There is
  53 + also a `make maintainer-clean' target, but that is intended mainly
  54 + for the package's developers. If you use it, you may have to get
  55 + all sorts of other programs in order to regenerate files that came
  56 + with the distribution.
  57 +
  58 + 6. Often, you can also type `make uninstall' to remove the installed
  59 + files again.
  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. Run `./configure --help'
  66 +for details on some of the pertinent environment variables.
  67 +
  68 + You can give `configure' initial values for configuration parameters
  69 +by setting variables in the command line or in the environment. Here
  70 +is an example:
  71 +
  72 + ./configure CC=c99 CFLAGS=-g LIBS=-lposix
  73 +
  74 + *Note Defining Variables::, for more details.
  75 +
  76 +Compiling For Multiple Architectures
  77 +====================================
  78 +
  79 + You can compile the package for more than one kind of computer at the
  80 +same time, by placing the object files for each architecture in their
  81 +own directory. To do this, you can use GNU `make'. `cd' to the
  82 +directory where you want the object files and executables to go and run
  83 +the `configure' script. `configure' automatically checks for the
  84 +source code in the directory that `configure' is in and in `..'.
  85 +
  86 + With a non-GNU `make', it is safer to compile the package for one
  87 +architecture at a time in the source code directory. After you have
  88 +installed the package for one architecture, use `make distclean' before
  89 +reconfiguring for another architecture.
  90 +
  91 + On MacOS X 10.5 and later systems, you can create libraries and
  92 +executables that work on multiple system types--known as "fat" or
  93 +"universal" binaries--by specifying multiple `-arch' options to the
  94 +compiler but only a single `-arch' option to the preprocessor. Like
  95 +this:
  96 +
  97 + ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
  98 + CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
  99 + CPP="gcc -E" CXXCPP="g++ -E"
  100 +
  101 + This is not guaranteed to produce working output in all cases, you
  102 +may have to build one architecture at a time and combine the results
  103 +using the `lipo' tool if you have problems.
  104 +
  105 +Installation Names
  106 +==================
  107 +
  108 + By default, `make install' installs the package's libraries under
  109 +`/usr/local/gamma/lib', include files under `/usr/local/gamma/include',
  110 +etc. You can specify an installation prefix other than `/usr/local/gamma'
  111 +by giving `configure' the option `--prefix=PREFIX'.
  112 +
  113 + You can specify separate installation prefixes for
  114 +architecture-specific files and architecture-independent files. If you
  115 +pass the option `--exec-prefix=PREFIX' to `configure', the package uses
  116 +PREFIX as the prefix for installing programs and libraries.
  117 +Documentation and other data files still use the regular prefix.
  118 +
  119 + In addition, if you use an unusual directory layout you can give
  120 +options like `--bindir=DIR' to specify different values for particular
  121 +kinds of files. Run `configure --help' for a list of the directories
  122 +you can set and what kinds of files go in them.
  123 +
  124 + If the package supports it, you can cause programs to be installed
  125 +with an extra prefix or suffix on their names by giving `configure' the
  126 +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  127 +
  128 +Optional Features
  129 +=================
  130 +
  131 + Some packages pay attention to `--enable-FEATURE' options to
  132 +`configure', where FEATURE indicates an optional part of the package.
  133 +They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  134 +is something like `gnu-as' or `x' (for the X Window System). The
  135 +`README' should mention any `--enable-' and `--with-' options that the
  136 +package recognizes.
  137 +
  138 + For packages that use the X Window System, `configure' can usually
  139 +find the X include and library files automatically, but if it doesn't,
  140 +you can use the `configure' options `--x-includes=DIR' and
  141 +`--x-libraries=DIR' to specify their locations.
  142 +
  143 +Particular systems
  144 +==================
  145 +
  146 + On HP-UX, the default C compiler is not ANSI C compatible. If GNU
  147 +CC is not installed, it is recommended to use the following options in
  148 +order to use an ANSI C compiler:
  149 +
  150 + ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
  151 +
  152 +and if that doesn't work, install pre-built binaries of GCC for HP-UX.
  153 +
  154 + On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
  155 +parse its `<wchar.h>' header file. The option `-nodtk' can be used as
  156 +a workaround. If GNU CC is not installed, it is therefore recommended
  157 +to try
  158 +
  159 + ./configure CC="cc"
  160 +
  161 +and if that doesn't work, try
  162 +
  163 + ./configure CC="cc -nodtk"
  164 +
  165 + On Solaris, don't put `/usr/ucb' early in your `PATH'. This
  166 +directory contains several dysfunctional programs; working variants of
  167 +these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
  168 +in your `PATH', put it _after_ `/usr/bin'.
  169 +
  170 + On Haiku, software installed for all users goes in `/boot/common',
  171 +not `/usr/local'. It is recommended to use the following options:
  172 +
  173 + ./configure --prefix=/boot/common
  174 +
  175 +Specifying the System Type
  176 +==========================
  177 +
  178 + There may be some features `configure' cannot figure out
  179 +automatically, but needs to determine by the type of machine the package
  180 +will run on. Usually, assuming the package is built to be run on the
  181 +_same_ architectures, `configure' can figure that out, but if it prints
  182 +a message saying it cannot guess the machine type, give it the
  183 +`--build=TYPE' option. TYPE can either be a short name for the system
  184 +type, such as `sun4', or a canonical name which has the form:
  185 +
  186 + CPU-COMPANY-SYSTEM
  187 +
  188 +where SYSTEM can have one of these forms:
  189 +
  190 + OS
  191 + KERNEL-OS
  192 +
  193 + See the file `config.sub' for the possible values of each field. If
  194 +`config.sub' isn't included in this package, then this package doesn't
  195 +need to know the machine type.
  196 +
  197 + If you are _building_ compiler tools for cross-compiling, you should
  198 +use the option `--target=TYPE' to select the type of system they will
  199 +produce code for.
  200 +
  201 + If you want to _use_ a cross compiler, that generates code for a
  202 +platform different from the build platform, you should specify the
  203 +"host" platform (i.e., that on which the generated programs will
  204 +eventually be run) with `--host=TYPE'.
  205 +
  206 +Sharing Defaults
  207 +================
  208 +
  209 + If you want to set default values for `configure' scripts to share,
  210 +you can create a site shell script called `config.site' that gives
  211 +default values for variables like `CC', `cache_file', and `prefix'.
  212 +`configure' looks for `PREFIX/share/config.site' if it exists, then
  213 +`PREFIX/etc/config.site' if it exists. Or, you can set the
  214 +`CONFIG_SITE' environment variable to the location of the site script.
  215 +A warning: not all `configure' scripts look for a site script.
  216 +
  217 +Defining Variables
  218 +==================
  219 +
  220 + Variables not defined in a site shell script can be set in the
  221 +environment passed to `configure'. However, some packages may run
  222 +configure again during the build, and the customized values of these
  223 +variables may be lost. In order to avoid this problem, you should set
  224 +them in the `configure' command line, using `VAR=value'. For example:
  225 +
  226 + ./configure CC=/usr/local2/bin/gcc
  227 +
  228 +causes the specified `gcc' to be used as the C compiler (unless it is
  229 +overridden in the site shell script).
  230 +
  231 +Unfortunately, this technique does not work for `CONFIG_SHELL' due to
  232 +an Autoconf bug. Until the bug is fixed you can use this workaround:
  233 +
  234 + CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
  235 +
  236 +`configure' Invocation
  237 +======================
  238 +
  239 + `configure' recognizes the following options to control how it
  240 +operates.
  241 +
  242 +`--help'
  243 +`-h'
  244 + Print a summary of all of the options to `configure', and exit.
  245 +
  246 +`--help=short'
  247 +`--help=recursive'
  248 + Print a summary of the options unique to this package's
  249 + `configure', and exit. The `short' variant lists options used
  250 + only in the top level, while the `recursive' variant lists options
  251 + also present in any nested packages.
  252 +
  253 +`--version'
  254 +`-V'
  255 + Print the version of Autoconf used to generate the `configure'
  256 + script, and exit.
  257 +
  258 +`--cache-file=FILE'
  259 + Enable the cache: use and save the results of the tests in FILE,
  260 + traditionally `config.cache'. FILE defaults to `/dev/null' to
  261 + disable caching.
  262 +
  263 +`--config-cache'
  264 +`-C'
  265 + Alias for `--cache-file=config.cache'.
  266 +
  267 +`--quiet'
  268 +`--silent'
  269 +`-q'
  270 + Do not print messages saying which checks are being made. To
  271 + suppress all normal output, redirect it to `/dev/null' (any error
  272 + messages will still be shown).
  273 +
  274 +`--srcdir=DIR'
  275 + Look for the package's source code in directory DIR. Usually
  276 + `configure' can determine that directory automatically.
  277 +
  278 +`--prefix=DIR'
  279 + Use DIR as the installation prefix. *Note Installation Names::
  280 + for more details, including other options available for fine-tuning
  281 + the installation locations.
  282 +
  283 +`--no-create'
  284 +`-n'
  285 + Run the configure checks, but stop before creating any output
  286 + files.
  287 +
  288 +`configure' also accepts some other, not widely useful, options. Run
  289 +`configure --help' for more details.
  290 +
... ...