Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid

[simgrid.git] / doc / install.doc

diff --git a/doc/install.doc b/doc/install.doc
index 5c93761..ce35441 100644 (file)
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -1,4 +1,4 @@
-/*! \page install Install Simgrid
+/*! \page install Installing Simgrid
 
 \htmlinclude .install.doc.toc
 
@@ -37,6 +37,7 @@ For Windows :
 "cmake -D[name]=[value] ... ./"
 
 [name]         enable_gtnets           [value] ON/OFF or TRUE/FALSE or 1/0
+       enable_ns3                      ON/OFF or TRUE/FALSE or 1/0
        enable_lua                      ON/OFF or TRUE/FALSE or 1/0
        enable_compile_optimizations    ON/OFF or TRUE/FALSE or 1/0
        enable_compile_warnings         ON/OFF or TRUE/FALSE or 1/0
@@ -50,8 +51,12 @@ For Windows :
        enable_jedule                   ON/OFF or TRUE/FALSE or 1/0
        enable_latency_bound_tracking   ON/OFF or TRUE/FALSE or 1/0
        enable_lib_static               ON/OFF or TRUE/FALSE or 1/0
+       enable_supernovae               ON/OFF or TRUE/FALSE or 1/0
+       enable_msg_deprecated           ON/OFF or TRUE/FALSE or 1/0                                                                                                                                                                                                                                                                               
+       enable_print_message            ON/OFF or TRUE/FALSE or 1/0 
        custom_flags                    <flags>
        gtnets_path                     <path_to_gtnets_directory>
+       ns3_path                        <path_to_ns3_directory>
        CMAKE_INSTALL_PREFIX            <path_to_install_directory>
        CMAKE_C_COMPILER                <path_to_compiler>
        CMAKE_CXX_COMPILER              <path_to_compiler>
@@ -61,6 +66,8 @@ For Windows :
 \subsubsection install_cmakeoption2 Options explaination
 
   \li enable_gtnets : set to true implie that user wants to use gtnets.
+  
+  \li enable_ns3 : set to true implie that user wants to use ns3.
 
   \li enable_lua : set to true implie that user wants to add lua langage into simgrid compilation.
 
@@ -86,11 +93,19 @@ For Windows :
   
   \li enable_latency_bound_tracking : Set to on if you want to be warned when communications are limited by round trip time.
   
-  \li enable_lib_static : Enable generated Simgrid and smpi static libraries.  
+  \li enable_lib_static : Enable generated Simgrid and smpi static libraries.
+  
+  \li enable_supernovae : Set to true make one file for each lib and compile with those generated files.
+  
+  \li enable_msg_deprecated : Simgrid is compiled with msg deprecated functions.                                                                                                                                                                                                                                                                              
+  
+  \li enable_print_message : When set to true configuration print more debug output.
   
   \li custom_flags : If user wants to use a specific flag during compilation, give here.
 
   \li gtnets_path : Path to gtnets install directory (ex /usr)
+  
+  \li ns3_path : Path to ns3 install directory (ex /usr)
 
   \li CMAKE_INSTALL_PREFIX : Path where are installed lib/ doc/ and include/ directories (ex /usr/local)
   
@@ -286,9 +301,9 @@ set(JMSG_JAVA_SRC
 )
 \endverbatim
 
-\section install_Win Installing the SimGrid library with Windows pakage
+\section install_Win Installing the SimGrid framework on Windows
 
-\subsection install_Win_install Installing SimGrid
+\subsection install_Win_install Installing SimGrid with the automatic installer
 
 Before start the installation, you need to be sure to have the following dependencies:
   \li cmake 2.8 <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
@@ -321,7 +336,19 @@ Step 3: Choice where to install packets previously selected. Please don't use sp
 <a href="win_install_04.png" border=0><img src="win_install_04.png" border=0></a>
 \endhtmlonly
 
-Step 4: Restart your computer to take in consideration environment variables.
+Step 4: Add CLASSPATH to environment variables.
+
+\htmlonly
+<a href="win_install_05.png" border=0><img src="win_install_05.png" border=0></a>
+\endhtmlonly
+
+Step 5: Add PATH to environment variables.
+
+\htmlonly
+<a href="win_install_06.png" border=0><img src="win_install_06.png" border=0></a>
+\endhtmlonly
+
+Step 6: Restart your computer to take in consideration environment variables.
 
 \subsection install_Win_compile1 Compile a project "HelloWorld"
 
@@ -363,6 +390,13 @@ cmake -G"MinGW Makefiles" \<path_to_HelloWorld_project\>
 \li Run "mingw32-make"
 \li You should obtain "TARGET_NAME.exe".
 
+\subsection install_Win_ruby Setup a virtualbox to use SimGrid-Ruby on windows 
+
+Allan Espinosa made these set of Vagrant rules available so that you
+can use the SimGrid Ruby bindings in a virtual machine using
+VirtualBox. Thanks to him for that. You can find his project here:
+https://github.com/aespinosa/simgrid-vagrant
+
 \section install_setting_MSG Setting up your own MSG code
 
 Do not build your simulator by modifying the SimGrid examples.  Go
@@ -381,7 +415,7 @@ feel free to organize it as you want).
       \li <tt>sched.c</tt>: a C file including <tt>sched.h</tt> and
           implementing the core of the scheduler. Most of these
           functions use the MSG functions defined in section \ref
-          msg_gos_functions.
+          msg_task_usage.
 
       \li <tt>masterslave.c</tt>: a C file with the main function, i.e.
           the MSG initialization (MSG_global_init()), the platform