INSTALL

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