Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Tesh sort wanted output
[simgrid.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 7c5877f..4953f2b 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,28 +2,29 @@
 * Installation information specific to SimGrid *
 ************************************************
 
 * Installation information specific to SimGrid *
 ************************************************
 
-The main source of information to compile SimGrid is the project FAQ.
-It is available online from http://simgrid.gforge.inria.fr/doc/faq.html or
-in the doc/ directory of this archive.
+The main source of information on how to compile SimGrid is the project
+documentation available in doc/install.html or online on our website
+http://simgrid.gforge.inria.fr/ . This INSTALL file contains mainly generic
+information on how to compile SimGrid or any project using cmake.
 
 Quick way to compile
 ====================
 
 
 Quick way to compile
 ====================
 
-In short, the way to compile SimGrid depends on whether you are
-compiling a tar.gz archive or directly from the SVN. In the latter
-case, you have to do an extra step (noted 0 below).
-
-(0) regenerate the autotools files (only needed from SVN):
-$ ./bootstrap
+In short, the way to compile SimGrid depends on whether you are compiling a
+tar.gz archive or directly from the SVN.
 
 (1) configure SimGrid (both in SVN and archives)
 
 (1) configure SimGrid (both in SVN and archives)
-$ ./configure <all options>
+$ cmake <all options> ./
+
 Main options are:
 Main options are:
-  --prefix=<path>: specify where to install SimGrid
-  --with-pthreads: use pthreads instead of Unix contextes (less
-                   efficient but maybe easier to debug)
-  --enable-maintainer-mode: get the makefiles regenerated automatically
-  --disable-compiler-optimizations: compile with -O0 instead of -O3
+  -DCMAKE_INSTALL_PREFIX=<path>: specify where to install SimGrid
+  -Denable_maintainer_mode=on/off: get the maintainer files regenerated
+                                   automatically
+  -Denable_compile_optimizations=on/off: compile or not with -O0 instead of -O3
+  -Denable_java=on/off: enable or not binding java
+  -Denable_lua=on/off: enable or not binding lua
+  -Denable_ruby=on/off: enable or not binding ruby
+  -Denable_smpi=on/off: enable or not smpi
 See below for other configure options which are common to any project,
 not only SimGrid related.
 
 See below for other configure options which are common to any project,
 not only SimGrid related.
 
@@ -31,9 +32,8 @@ not only SimGrid related.
 $ make
 
 (3) Test it (optional)
 $ make
 
 (3) Test it (optional)
-$ make check 
-     or
-$ ./checkall
+$ make check
+$ ctest
 
 (4) Install it
 $ make install
 
 (4) Install it
 $ make install
@@ -41,251 +41,22 @@ $ make install
 
 Dependencies
 ============
 
 Dependencies
 ============
-SimGrid archives do not have any firm dependencies. 
-
-If you want to compile from the svn, you have to have autotool,
-automake and libtool installed.
-
-If you want to compile the java bindings, you have to have a java
-compiler, and the jni.h header file (available from the JDK)
-
-If you want to compile the GTNetS backend, you have to have a patched
-version of GTNetS installed. The patch lives in the contrib section of
-the SVN.
-
-Again, you should check the FAQ for more information.
-
-****************************************************************************
-* Generic Installation information from autotools                          *
-* (provided for completion at the step where you have to launch configure) *
-****************************************************************************
-
-Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
-Foundation, Inc.
-
-   This file is free documentation; the Free Software Foundation gives
-unlimited permission to copy, distribute and modify it.
-
-Basic Installation
-==================
-
-   These are generic installation instructions.
-
-   The `configure' shell script attempts to guess correct values for
-various system-dependent variables used during compilation.  It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions.  Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, and a
-file `config.log' containing compiler output (useful mainly for
-debugging `configure').
-
-   It can also use an optional file (typically called `config.cache'
-and enabled with `--cache-file=config.cache' or simply `-C') that saves
-the results of its tests to speed up reconfiguring.  (Caching is
-disabled by default to prevent problems with accidental use of stale
-cache files.)
-
-   If you need to do unusual things to compile the package, please try
-to figure out how `configure' could check whether to do them, and mail
-diffs or instructions to the address given in the `README' so they can
-be considered for the next release.  If you are using the cache, and at
-some point `config.cache' contains results you don't want to keep, you
-may remove or edit it.
-
-   The file `configure.ac' (or `configure.in') is used to create
-`configure' by a program called `autoconf'.  You only need
-`configure.ac' if you want to change it or regenerate `configure' using
-a newer version of `autoconf'.
-
-The simplest way to compile this package is:
-
-  1. `cd' to the directory containing the package's source code and type
-     `./configure' to configure the package for your system.  If you're
-     using `csh' on an old version of System V, you might need to type
-     `sh ./configure' instead to prevent `csh' from trying to execute
-     `configure' itself.
-
-     Running `configure' takes awhile.  While running, it prints some
-     messages telling which features it is checking for.
-
-  2. Type `make' to compile the package.
-
-  3. Optionally, type `make check' to run any self-tests that come with
-     the package.
-
-  4. Type `make install' to install the programs and any data files and
-     documentation.
-
-  5. You can remove the program binaries and object files from the
-     source code directory by typing `make clean'.  To also remove the
-     files that `configure' created (so you can compile the package for
-     a different kind of computer), type `make distclean'.  There is
-     also a `make maintainer-clean' target, but that is intended mainly
-     for the package's developers.  If you use it, you may have to get
-     all sorts of other programs in order to regenerate files that came
-     with the distribution.
-
-Compilers and Options
-=====================
-
-   Some systems require unusual options for compilation or linking that
-the `configure' script does not know about.  Run `./configure --help'
-for details on some of the pertinent environment variables.
-
-   You can give `configure' initial values for configuration parameters
-by setting variables in the command line or in the environment.  Here
-is an example:
-
-     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
-
-   *Note Defining Variables::, for more details.
-
-Compiling For Multiple Architectures
-====================================
-
-   You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory.  To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'.  `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script.  `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
-
-   If you have to use a `make' that does not support the `VPATH'
-variable, you have to compile the package for one architecture at a
-time in the source code directory.  After you have installed the
-package for one architecture, use `make distclean' before reconfiguring
-for another architecture.
-
-Installation Names
-==================
-
-   By default, `make install' will install the package's files in
-`/usr/local/bin', `/usr/local/man', etc.  You can specify an
-installation prefix other than `/usr/local' by giving `configure' the
-option `--prefix=PATH'.
-
-   You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files.  If you
-give `configure' the option `--exec-prefix=PATH', the package will use
-PATH as the prefix for installing programs and libraries.
-Documentation and other data files will still use the regular prefix.
-
-   In addition, if you use an unusual directory layout you can give
-options like `--bindir=PATH' to specify different values for particular
-kinds of files.  Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them.
-
-   If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
-
-Optional Features
-=================
-
-   Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System).  The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
-
-   For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Specifying the System Type
-==========================
-
-   There may be some features `configure' cannot figure out
-automatically, but needs to determine by the type of machine the package
-will run on.  Usually, assuming the package is built to be run on the
-_same_ architectures, `configure' can figure that out, but if it prints
-a message saying it cannot guess the machine type, give it the
-`--build=TYPE' option.  TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name which has the form:
-
-     CPU-COMPANY-SYSTEM
-
-where SYSTEM can have one of these forms:
-
-     OS KERNEL-OS
-
-   See the file `config.sub' for the possible values of each field.  If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the machine type.
-
-   If you are _building_ compiler tools for cross-compiling, you should
-use the `--target=TYPE' option to select the type of system they will
-produce code for.
-
-   If you want to _use_ a cross compiler, that generates code for a
-platform different from the build platform, you should specify the
-"host" platform (i.e., that on which the generated programs will
-eventually be run) with `--host=TYPE'.
-
-Sharing Defaults
-================
-
-<   If you want to set default values for `configure' scripts to share,
-you can create a site shell script called `config.site' that gives
-default values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists.  Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.
-
-Defining Variables
-==================
-
-   Variables not defined in a site shell script can be set in the
-environment passed to `configure'.  However, some packages may run
-configure again during the build, and the customized values of these
-variables may be lost.  In order to avoid this problem, you should set
-them in the `configure' command line, using `VAR=value'.  For example:
-
-     ./configure CC=/usr/local2/bin/gcc
-
-will cause the specified gcc to be used as the C compiler (unless it is
-overridden in the site shell script).
-
-`configure' Invocation
-======================
-
-   `configure' recognizes the following options to control how it
-operates.
-
-`--help'
-`-h'
-     Print a summary of the options to `configure', and exit.
-
-`--version'
-`-V'
-     Print the version of Autoconf used to generate the `configure'
-     script, and exit.
+SimGrid archives do not have any firm dependencies.
 
 
-`--cache-file=FILE'
-     Enable the cache: use and save the results of the tests in FILE,
-     traditionally `config.cache'.  FILE defaults to `/dev/null' to
-     disable caching.
+If you want to compile, you must have installed perl and cmake version 2.6 or
+above.
+In order to improve memory management you should install libpcre.
 
 
-`--config-cache'
-`-C'
-     Alias for `--cache-file=config.cache'.
+If you want to compile the java bindings, you have to have a java compiler, and
+the jni.h header file (available from the JDK).
 
 
-`--quiet'
-`--silent'
-`-q'
-     Do not print messages saying which checks are being made.  To
-     suppress all normal output, redirect it to `/dev/null' (any error
-     messages will still be shown).
+If you want to compile the lua bindings, you have to have lua5.1 executable and
+liblua5.1-dev.
 
 
-`--srcdir=DIR'
-     Look for the package's source code in directory DIR.  Usually
-     `configure' can determine that directory automatically.
+If you want to compile the ruby bindings, you have to install ruby executable
+and ruby-dev version 1.9.
 
 
-`configure' also accepts some other, not widely useful, options.  Run
-`configure --help' for more details.
+If you want to compile smpi, you should install f2c for use Fortran code.
 
 
+If you want to compile the GTNetS backend, you have to have a patched version of
+GTNetS installed. The patch lives in the contrib section of the SVN.