INSTALL

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