[certi-cvs] certi/doc build.dox execute.dox introduction.dox

[CERTI CVS commits]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      14/02/04 09:03:48

Added files:
        doc            : build.dox execute.dox introduction.dox 

Log message:
        Resurrect documentation files that were suppressed by error

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/build.dox?cvsroot=certi&rev=3.7
http://cvs.savannah.gnu.org/viewcvs/certi/doc/execute.dox?cvsroot=certi&rev=3.8
http://cvs.savannah.gnu.org/viewcvs/certi/doc/introduction.dox?cvsroot=certi&rev=3.4

Patches:
Index: build.dox
===================================================================
RCS file: build.dox
diff -N build.dox
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ build.dox   4 Feb 2014 09:03:48 -0000       3.7
@@ -0,0 +1,187 @@
+/**
+ * \page build Building CERTI
+ *
+ * \addindex building
+ *
+ * CERTI comes as either as an installer (binary) or compressed tar source 
archives. This
+ * section describes how to build CERTI executables from the source code.
+ *
+ * The primary distribution format is gzip compressed tar source archive 
(.tar.gz)
+ * or ZIP archive (.zip) and may be found on Savannah CERTI download area: <a 
href="http://download.savannah.nongnu.org/releases/certi/";> 
http://download.savannah.nongnu.org/releases/certi/ </a>.
+ *
+ * CERTI build system uses  <a href="http://www.cmake.org/";>CMake, 
http://www.cmake.org/ </a>
+ * which is a cross-platform build system generator. CMake should be used to 
+ * compile CERTI SDK on a variety of platform/compiler combination like:
+ * <ul>
+ *   <li> Linux x86 / gcc </li>
+ *   <li> Linux x86_64 / gcc </li>
+ *   <li> Solaris Sparc / Sun Studio </li>
+ *   <li> Windows / Visual Studio </li>
+ *   <li> Windows / Code::Blocks+MinGW </li>
+ *   <li> ... </li>
+ * </ul>
+ * 
+ * You may follow generic CMake usage instruction for building CERTI
+ * on various platforms:  <a 
href="http://www.cmake.org/cmake/help/runningcmake.html";>Running CMake,  
http://www.cmake.org/cmake/help/runningcmake.html://www.cmake.org/ </a>
+ * or you may try to follow the below CERTI CMake usage.
+ *
+ * \section certi_cmake_prerequisites Prerequisites
+ *
+ * CERTI compilation requires a working C++ compiler and some development 
tools.
+ * You may have them already installed on your system or you may download and
+ * install the missing prerequisites. All used tools are free software.
+ *
+ * CMake 
+ * - Windows installer
+ *   - http://www.cmake.org/HTML/Download.html
+ * - RedHat/Fedora/CentOS Linux
+\verbatim
+ yum install cmake
+\endverbatim
+ * - Debian/Ubuntu Linux
+\verbatim
+ apt-get install cmake
+\endverbatim
+ *
+ * Flex, Bison and m4
+ * - Windows installer
+ *   - http://gnuwin32.sourceforge.net/packages/flex.htm
+ *   - http://gnuwin32.sourceforge.net/packages/bison.htm
+ *   - http://gnuwin32.sourceforge.net/packages/m4.htm
+ *     <br><em> Beware: you need to put m4 in the PATH such that bison may 
call it without trouble</em> 
+ * - RedHat/Fedora/CentOS Linux
+\verbatim
+ yum install flex bison
+\endverbatim
+ * - Debian/Ubuntu Linux
+\verbatim
+ apt-get install flex bison
+\endverbatim
+ *
+ * NSIS (optionally, for building a Windows installer)
+ * - Windows installer
+ *   - http://nsis.sourceforge.net/Main_Page
+ *
+ * libxml2 (optionally, to enable federation save and restore)
+ * - Windows installer
+ *   - http://www.zlatkovic.com/libxml.en.html
+ * - RedHat/Fedora/CentOS Linux
+\verbatim
+ yum install libxml2-devel
+\endverbatim
+ * - Debian/Ubuntu Linux
+\verbatim
+ apt-get install libxml2-dev
+\endverbatim
+ *
+ * X11 (optionally, to enable billard example with a graphical animation)
+ * - RedHat/Fedora/CentOS Linux
+\verbatim
+yum install libX11-devel
+\endverbatim
+ * - Older RedHat/Fedora/CentOS Linux
+\verbatim
+yum install xorg-x11-xbitmaps
+\endverbatim
+ * - Debian/Ubuntu Linux
+\verbatim
+apt-get install libx11-dev xbitmaps
+\endverbatim
+ *
+ * \section certi_unix_build Building CERTI on Unix with Makefile generator
+ * 
+ * If you get a tarball source CERTI distribution such as you may found in the 
download 
+ * section of the Savannah project 
+ * <a>http://download.savannah.nongnu.org/releases/certi/</a>, 
+ * you should follow these steps: 
+ * <ol>
+ * <li>untar the archive: tar zxvf certi-\<version\>-Source.tar.gz 
+ *     this should create a certi-\<version\>-Source directory
+ * </li>
+\verbatim
+ tar zxvf certi-3.4.0-Source.tar.gz
+ ... wait for tar ending ...
+\endverbatim
+ * <li>Prepare separate build directory and run CMake
+ * </li>
+\verbatim
+ mkdir build_certi
+ cd build_certi
+ cmake -DCMAKE_INSTALL_PREFIX=/path/to/install 
/path/to/certi-\<version\>-Source
+ ... wait for cmake run  ending ...
+\endverbatim
+ * <li>compile your certi</li>
+ *
+\verbatim
+ make
+ ... wait the compilation end ...
+\endverbatim
+ <li> Then you may either install CERTI or build
+      a binary package that will be usable for installation</li>
+ <ul>
+ * <li>install CERTI</li>
+ *
+\verbatim
+ make install
+ ... wait for make install end ...
+\endverbatim
+ * <li>build your binary package </li>
+\verbatim
+ make package
+\endverbatim
+ </ul>
+ * </ol>
+ * After that you will have a compiled and usable CERTI package.
+ *
+ * \section certi_unix_build_GUI Building CERTI on Unix (GUI)
+ *
+ * CMake 2.6.0 and up comes with a nice and handy graphical user interface
+ * which may be invoked with the cmake-gui command. 
+ *
+ * \section certi_win32_build Building CERTI on Windows
+ *
+ * Enter the Start menu and launch the CMake application.
+ * Enter the folder for the source code (e.g. \c \\certi, created during the
+ * previous step).
+ * Enter the folder for building the programs (e.g. \c \\tempo).
+ *
+ * \image html "cmake-launch.png"
+ * \image latex "cmake-launch.png" "Launch CMake" width=12cm
+ *
+ * Hit the \c Configure button.
+ *
+ * \image html "cmake-generator.png"
+ * \image latex "cmake-generator.png" "Configure" width=10cm
+ *
+ * Choose the appropriate Generator.
+ *
+ * \image html "cmake-verify.png"
+ * \image latex "cmake-verify.png" "Choose Generator" width=12cm
+ *
+ * Verify the the paths for the different tools (flex, bison) before hitting
+ * \c Configure again.
+ *
+ * Repeat \c Configure until you get an enabled \c OK button.
+ *
+ * \image html "cmake-generate.png"
+ * \image latex "cmake-generate.png" "Generate project" width=12cm
+ *
+ * You should get a \c build folder (e.g. \\tempo) which looks like this:
+ *
+ * \image html "cmake-vsfiles.png"
+ * \image latex "cmake-vsfiles.png" "Visual Studio files" width=12cm
+ *
+ * Launch the \c CERTI.sln (e.g. using Microsoft Visual C++ 2005).
+ *
+ * \image html "cmake-vsproject.png"
+ * \image latex "cmake-vsproject.png" "CMake VS Project" width=6cm
+ *
+ * Select desired configuration (Debug or Release) and build the project
+ * (using Build All). Take a look at your folder:
+ *
+ * \image html "cmake-binaries.png"
+ * \image latex "cmake-binaries.png" "Build Tree" width=14cm
+ *  
+ */
+
+// $Id: build.dox,v 3.7 2014/02/04 09:03:48 erk Exp $

Index: execute.dox
===================================================================
RCS file: execute.dox
diff -N execute.dox
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ execute.dox 4 Feb 2014 09:03:48 -0000       3.8
@@ -0,0 +1,106 @@
+/**
+ * \page execute Executing HLA simulation
+ *
+ * \addindex user
+ *  
+ * \section certi_user_executables CERTI executables
+ * CERTI comes with two main executables: RTIA and RTIG.
+ * \dot
+ *   graph certi_architecture {
+ *      size = "2.5,2.5";
+ *      node [shape=record, fontname=Helvetica, fontsize=10];
+ *      federate1 [ label="federate 1" ]; rtia1 [ label="RTIA"];
+ *      federate2 [ label="federate 2" ]; rtia2 [ label="RTIA"];
+ *      federate3 [ label="federate 3" ]; rtia3 [ label="RTIA"];
+ *      rtig [ label="RTIG"];
+ *      federate1 -- rtia1 [ style="solid" ];
+ *      federate2 -- rtia2 [ style="solid" ];
+ *      federate3 -- rtia3 [ style="solid" ];
+ *      rtia1 -- rtig [ style="solid" ];
+ *      rtia2 -- rtig [ style="solid" ];
+ *      rtia3 -- rtig [ style="solid" ];
+ *      node [shape=parallelogram, fontname=Helvetica, fontsize=10];
+ *      fed [ label=".fed file"];
+ *      rtig -- fed [ style="solid" ];
+ *   }
+ * \enddot
+ *
+ * \subsection certi_user_execute
+ * If ones want to properly execute an HLA simulation using CERTI one must:
+ * (FIXME more detail to come).
+ * <ol> 
+ *  <li> configure PATH </li>
+ *  <li> store .fed (or .xml) FOM file in the search path of the rtig \see 
certi_FOM_FileSearch</li>
+ *  <li> run rtig, \see certi_executable_RTIG </li>
+ *  <li> configure HOST/PORT/PROXY, </li>
+ *  <li> run federations, rtia is started automatically. </li>
+ * </ol>
+ * \subsection certi_user_env CERTI environment variables
+ * 
+ * CERTI uses a set of environment variables which may influence its 
+ * execution behavior. Those variables may be set on federate execution 
location
+ * or on RTIG (a.k.a. The CERTI CRC) location. 
+ * <center>
+ * <TABLE>
+ * <tr>
+ * <td><b>Variable</b></td><td><b>Used by</b></td><td><b>Description</b></td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_HOME</td> <td>RTIG</td><td>the CERTI installation base directory.
+ *                                      This is used by the RTIG in order
+ *                                      to look for FOM files 
+ *                                      (see \ref certi_executable_RTIG).</td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_FOM_PATH</td> <td>RTIG</td><td>the CERTI Federation Object Model 
search path. The variable may contain a ":" separated list of paths.
+ *                                      This is used by the RTIG in order
+ *                                      to look for FOM files 
+ *                                      (see \ref certi_executable_RTIG).</td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_HOST</td> <td>RTIA</td><td>machine on which RTIG is running. 
+ *                                      As soon as it starts the RTIA will try 
to connect 
+ *                                      to the RTIG running on CERTI_HOST 
+ *                                      (see \ref certi_executable_RTIA).</td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_TCP_PORT</td> <td>RTIG, RTIA</td> <td>TCP port used for RTIA/RTIG 
communications</td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_UDP_PORT</td> <td>RTIG, RTIA</td> <td>UDP port used for RTIA/RTIG 
communications</td>
+ * </tr>
+ * <tr> <td>CERTI_HTTP_PROXY</td> <td>RTIA</td>
+ * <td>HTTP proxy address in the format http://host:port.
+ * See \ref certi_HTTP_proxy "HTTP tunneling".</td>
+ * </tr>
+ * <tr> <td>http_proxy</td> <td>RTIA</td>
+ * <td>System-wide HTTP proxy address used if CERTI_HTTP_PROXY is not 
defined.</td>
+ * </tr>
+ * <tr> <td>CERTI_NO_STATISTICS</td> <td>RTIA</td> <td>if set, do not display 
service calls statistics</td>
+ * </tr>
+ * </TABLE>
+ * </center>
+ * 
+ * \subsection certi_user_rtig RTIG: CERTI RunTime Infrastructure Gateway
+ * \copydoc certi_executable_RTIG
+ *
+ * \subsection certi_user_rtia RTIA: CERTI RunTime Infrastructure Ambassador
+ * \copydoc certi_executable_RTIA
+ *
+ * \section billiard Sample federate: Billiard
+ * Open a windows command prompt and run the RTIG.
+\verbatim
+ rtig
+\endverbatim
+ * \image html "rtig.png"
+ * \image latex "rtig.png" "RTIG screenshot" width=12cm
+ *
+ * Open another windows command prompt and run the billard program.
+\verbatim
+ billiard -n 1 fTest FTest.fed
+\endverbatim
+ * \image html "billiard.png"
+ * \image latex "billiard.png" "Billard consoleshot" width=12cm
+ */
+
+// $Id: execute.dox,v 3.8 2014/02/04 09:03:48 erk Exp $

Index: introduction.dox
===================================================================
RCS file: introduction.dox
diff -N introduction.dox
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ introduction.dox    4 Feb 2014 09:03:48 -0000       3.4
@@ -0,0 +1,26 @@
+/**
+ * \page intro Introduction
+ *
+ * \addindex Introduction
+ * CERTI is an Open Source HLA compliant 
+ * <a 
href="http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation)"> 
RunTime Infrastructure (RTI)</a>,
+ * which aims at being a multi-standard, multi-language RTI including:
+ *    - DoD HLA 1.3 (a.k.a. RTI-NGv6): C++, Java, Python, Fortran90, Matlab
+ *    - IEEE1516-2000 (a.k.a. HLA 1516): C++
+ *    - IEEE1516-2010 (a.k.a. HLA Evolved): work-in-progress
+ * 
+ * You'll find hereafter the documentation for building and installing CERTI.
+ * CERTI is primarily developed and maintained by the Toulouse research center 
of ONERA [http://www.onera.fr], the French Aerospace Labs. 
+ * The primary goal of CERTI is to be used in research activities but CERTI 
has a growing
+ * number of users and contributors among the CERTI Open Source community.
+ * 
+ * People interested in CERTI may join the CERTI Open Source
+ * community at <a href="https://savannah.nongnu.org/projects/certi";>
+ * https://savannah.nongnu.org/projects/certi </a> and/or
+ * by using the mailing list 
+ * <a href="http://lists.nongnu.org/mailman/listinfo/certi-devel";>
+ * http://lists.nongnu.org/mailman/listinfo/certi-devel </a>
+ * for discussion regarding CERTI usage.
+ */
+
+// $Id: introduction.dox,v 3.4 2014/02/04 09:03:48 erk Exp $