[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[certi-cvs] certi/doc .cvsignore certi_install.cnf.in certi...
|
From: |
certi-cvs |
|
Subject: |
[certi-cvs] certi/doc .cvsignore certi_install.cnf.in certi... |
|
Date: |
Sun, 19 Oct 2008 21:44:26 +0000 |
CVSROOT: /sources/certi
Module name: certi
Changes by: Petr Gotthard <gotthardp> 08/10/19 21:44:26
Modified files:
doc : .cvsignore certi_install.cnf.in
certi_install_doc.tree certi_user.cnf.in
certi_user_doc.tree
Added files:
doc : build.dox execute.dox install.dox
introduction.dox
doc/images : billiard.png cmake-binaries.png
cmake-generate.png cmake-generator.png
cmake-launch.png cmake-verify.png
cmake-vsfiles.png cmake-vsproject.png rtig.png
Removed files:
doc : certi_install.dox certi_introduction.dox
certi_user.dox
Log message:
Installation documentation updated. Integrated text and screenshots
from CERTI-Compilation-HOWTO.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/.cvsignore?cvsroot=certi&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install.cnf.in?cvsroot=certi&r1=3.3&r2=3.4
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install_doc.tree?cvsroot=certi&r1=3.3&r2=3.4
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.cnf.in?cvsroot=certi&r1=3.5&r2=3.6
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user_doc.tree?cvsroot=certi&r1=3.3&r2=3.4
http://cvs.savannah.gnu.org/viewcvs/certi/doc/build.dox?cvsroot=certi&rev=3.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/execute.dox?cvsroot=certi&rev=3.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/install.dox?cvsroot=certi&rev=3.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/introduction.dox?cvsroot=certi&rev=3.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install.dox?cvsroot=certi&r1=3.3&r2=0
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_introduction.dox?cvsroot=certi&r1=3.1&r2=0
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.dox?cvsroot=certi&r1=3.4&r2=0
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/billiard.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/cmake-binaries.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/cmake-generate.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/cmake-generator.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/cmake-launch.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/cmake-verify.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/cmake-vsfiles.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/cmake-vsproject.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/rtig.png?cvsroot=certi&rev=1.1
Patches:
Index: .cvsignore
===================================================================
RCS file: /sources/certi/certi/doc/.cvsignore,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- .cvsignore 12 Oct 2008 15:58:37 -0000 1.2
+++ .cvsignore 19 Oct 2008 21:44:23 -0000 1.3
@@ -2,3 +2,4 @@
CTestTestfile.cmake
cmake_install.cmake
Makefile
+*.cnf
Index: certi_install.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_install.cnf.in,v
retrieving revision 3.3
retrieving revision 3.4
diff -u -b -r3.3 -r3.4
--- certi_install.cnf.in 11 Oct 2008 21:40:16 -0000 3.3
+++ certi_install.cnf.in 19 Oct 2008 21:44:24 -0000 3.4
@@ -435,8 +435,12 @@
# with spaces.
INPUT = "${CMAKE_SOURCE_DIR}/doc/certi_install_doc.tree" \
- "${CMAKE_SOURCE_DIR}/doc/certi_introduction.dox" \
- "${CMAKE_SOURCE_DIR}/doc/certi_install.dox"
+ "${CMAKE_SOURCE_DIR}/doc/introduction.dox" \
+ "${CMAKE_SOURCE_DIR}/doc/build.dox" \
+ "${CMAKE_SOURCE_DIR}/doc/install.dox" \
+ "${CMAKE_SOURCE_DIR}/doc/execute.dox" \
+ "${CMAKE_SOURCE_DIR}/RTIG/main.cc" \
+ "${CMAKE_SOURCE_DIR}/RTIA/main.cc"
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -496,7 +500,8 @@
# directories that contain image that are included in the documentation (see
# the \image command).
-IMAGE_PATH =
+IMAGE_PATH = "${CMAKE_SOURCE_DIR}/doc" \
+ "${CMAKE_SOURCE_DIR}/doc/images"
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
Index: certi_install_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_install_doc.tree,v
retrieving revision 3.3
retrieving revision 3.4
diff -u -b -r3.3 -r3.4
--- certi_install_doc.tree 13 Oct 2008 14:32:36 -0000 3.3
+++ certi_install_doc.tree 19 Oct 2008 21:44:24 -0000 3.4
@@ -25,15 +25,22 @@
/**
* \page index
*
- * <h1> CERTI Installation Documentation </h1>
- * \n
- * This is the CERTI installation documentation.
- * The installation documentation is divided into several part:
+ * \image html "certi.png"
+ * <h1>Installation Documentation</h1>
+ *
+ * This documentation describes CERTI installation/configuration and simulation
+ * execution.
+ * If you want to develop own HLA simulations using CERTI, please refer the
User documentation.
+ *
+ * This documentation is divided into several parts:
*
* <ul>
* <li>\ref intro</li>
+ * <li>\ref build</li>
* <li>\ref install</li>
+ * <li>\ref execute</li>
* </ul>
*
*/
+// $Id: certi_install_doc.tree,v 3.4 2008/10/19 21:44:24 gotthardp Exp $
Index: certi_user.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_user.cnf.in,v
retrieving revision 3.5
retrieving revision 3.6
diff -u -b -r3.5 -r3.6
--- certi_user.cnf.in 13 Oct 2008 19:07:30 -0000 3.5
+++ certi_user.cnf.in 19 Oct 2008 21:44:24 -0000 3.6
@@ -435,8 +435,9 @@
# with spaces.
INPUT = "${CMAKE_SOURCE_DIR}/doc/certi_user_doc.tree" \
- "${CMAKE_SOURCE_DIR}/doc/certi_introduction.dox" \
- "${CMAKE_SOURCE_DIR}/doc/certi_user.dox" \
+ "${CMAKE_SOURCE_DIR}/doc/introduction.dox" \
+ "${CMAKE_SOURCE_DIR}/doc/execute.dox" \
+ "${CMAKE_SOURCE_DIR}/RTIG/main.cc" \
"${CMAKE_SOURCE_DIR}/RTIA/main.cc"
# If the value of the INPUT tag contains directories, you can use the
@@ -497,7 +498,8 @@
# directories that contain image that are included in the documentation (see
# the \image command).
-IMAGE_PATH =
+IMAGE_PATH = "${CMAKE_SOURCE_DIR}/doc" \
+ "${CMAKE_SOURCE_DIR}/doc/images"
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
Index: certi_user_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_user_doc.tree,v
retrieving revision 3.3
retrieving revision 3.4
diff -u -b -r3.3 -r3.4
--- certi_user_doc.tree 13 Oct 2008 14:32:35 -0000 3.3
+++ certi_user_doc.tree 19 Oct 2008 21:44:24 -0000 3.4
@@ -22,11 +22,12 @@
// ----------------------------------------------------------------------------
*/
- /**
+/**
* \page index
*
- * <h1> CERTI User Documentation </h1>
- * \n
+ * \image html "certi.png"
+ * <h1>User Documentation</h1>
+ *
* This is the CERTI installation documentation.
* The installation documentation is divided into several part:
*
@@ -36,3 +37,5 @@
* </ul>
*
*/
+
+// $Id: certi_user_doc.tree,v 3.4 2008/10/19 21:44:24 gotthardp Exp $
Index: build.dox
===================================================================
RCS file: build.dox
diff -N build.dox
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ build.dox 19 Oct 2008 21:44:24 -0000 3.1
@@ -0,0 +1,165 @@
+/**
+ * \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
+ * - Fedora 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
+ * - Fedora 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
+ * - Fedora Linux
+\verbatim
+ yum install libxml2-devel
+\endverbatim
+ * - Debian/Ubuntu Linux
+\verbatim
+ apt-get install libxml2-devel
+\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.2.4-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"
+ *
+ * Hit the \c Configure button.
+ *
+ * \image html "cmake-generator.png"
+ *
+ * Choose the appropriate Generator.
+ *
+ * \image html "cmake-verify.png"
+ *
+ * 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"
+ *
+ * You should get a \c build folder (e.g. \\tempo) which looks like this:
+ *
+ * \image html "cmake-vsfiles.png"
+ *
+ * Launch the \c CERTI.sln (e.g. using Microsoft Visual C++ 2005).
+ *
+ * \image html "cmake-vsproject.png"
+ *
+ * Select desired configuration (Debug or Release) and build the project
+ * (using Build All). Take a look at your folder:
+ *
+ * \image html "cmake-binaries.png"
+ *
+ */
+
+// $Id: build.dox,v 3.1 2008/10/19 21:44:24 gotthardp Exp $
Index: execute.dox
===================================================================
RCS file: execute.dox
diff -N execute.dox
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ execute.dox 19 Oct 2008 21:44:24 -0000 3.1
@@ -0,0 +1,76 @@
+/**
+ * \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
+ *
+ * TODO: How to execute simulation: (0) configure PATH, (1) store .fed file,
(2) run rtig,
+ * (3) configure HOST/PORT/PROXY, (3) run federations, rtia is started
automatically.
+ *
+ * \subsection certi_user_env CERTI environment variables
+ *
+ * CERTI uses a set of environment variables which may influence its
+ * execution behavior.
+ * <center>
+ * <TABLE>
+ * <tr>
+ * <td><b>Variable</b></td><td><b>Used by</b></td><td><b>Description</b></td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_HOST</td> <td>RTIA</td><td>machine on which RTIG is running</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</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"
+ *
+ * Open another windows command prompt and run the billard program.
+\verbatim
+ billiard -n 1 fTest FTest.fed
+\endverbatim
+ * \image html "billiard.png"
+ */
+
+// $Id: execute.dox,v 3.1 2008/10/19 21:44:24 gotthardp Exp $
Index: install.dox
===================================================================
RCS file: install.dox
diff -N install.dox
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ install.dox 19 Oct 2008 21:44:24 -0000 3.1
@@ -0,0 +1,43 @@
+/**
+ * \page install Installing CERTI
+ *
+ * \addindex installation
+ *
+ * CERTI comes as a set of libraries and binaries executables, which may
+ * be used to build an HLA compliant simulation.
+ *
+ * \section certi_install Install the CERTI software
+ *
+ * \subsection certi_install_layout CERTI installation layout
+ * CERTI components are installed in a user-chosen CERTI_HOME
+ * directory. Below this root directory the layout is as described below:
+ * \dot
+ * digraph certi_layout {
+ * size = "2.5,2.5";
+ * node [shape=record, fontname=Helvetica, fontsize=10];
+ * home [ label="CERTI_HOME"];
+ * bin [ label="bin"];
+ * lib [ label="lib"];
+ * share [ label="share"];
+ * doc [label="doc"];
+ * federations [label="federations"];
+ * home -> bin [ arrowhead="open", style="solid" ];
+ * home -> lib [ arrowhead="open", style="solid" ];
+ * home -> share [ arrowhead="open", style="solid" ];
+ * share -> doc [ arrowhead="open", style="solid" ];
+ * share -> federations [ arrowhead="open", style="solid" ];
+ * }
+ * \enddot
+ *
+ * TODO: How to set $PATH, LD_LIBRARY_PATH
+ * TODO: Where to store .fed files, what are the .fed files?
+ *
+ * \subsection certi_install_windows Windows installer
+ * TODO: How to use the Windows installer.
+ *
+ * \subsection certi_install_rpm RPM package
+ * TODO: How to install CERTI from a .RPM file.
+ *
+ */
+
+// $Id: install.dox,v 3.1 2008/10/19 21:44:24 gotthardp Exp $
Index: introduction.dox
===================================================================
RCS file: introduction.dox
diff -N introduction.dox
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ introduction.dox 19 Oct 2008 21:44:25 -0000 3.1
@@ -0,0 +1,23 @@
+/**
+ * \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>.
+ * 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.1 2008/10/19 21:44:25 gotthardp Exp $
Index: images/billiard.png
===================================================================
RCS file: images/billiard.png
diff -N images/billiard.png
Binary files /dev/null and /tmp/cvsmf2DfN differ
Index: images/cmake-binaries.png
===================================================================
RCS file: images/cmake-binaries.png
diff -N images/cmake-binaries.png
Binary files /dev/null and /tmp/cvs5hlrEL differ
Index: images/cmake-generate.png
===================================================================
RCS file: images/cmake-generate.png
diff -N images/cmake-generate.png
Binary files /dev/null and /tmp/cvsY764OL differ
Index: images/cmake-generator.png
===================================================================
RCS file: images/cmake-generator.png
diff -N images/cmake-generator.png
Binary files /dev/null and /tmp/cvsNrEMxM differ
Index: images/cmake-launch.png
===================================================================
RCS file: images/cmake-launch.png
diff -N images/cmake-launch.png
Binary files /dev/null and /tmp/cvsKj63gP differ
Index: images/cmake-verify.png
===================================================================
RCS file: images/cmake-verify.png
diff -N images/cmake-verify.png
Binary files /dev/null and /tmp/cvsX0A4lP differ
Index: images/cmake-vsfiles.png
===================================================================
RCS file: images/cmake-vsfiles.png
diff -N images/cmake-vsfiles.png
Binary files /dev/null and /tmp/cvsclHc6P differ
Index: images/cmake-vsproject.png
===================================================================
RCS file: images/cmake-vsproject.png
diff -N images/cmake-vsproject.png
Binary files /dev/null and /tmp/cvshrmFUN differ
Index: images/rtig.png
===================================================================
RCS file: images/rtig.png
diff -N images/rtig.png
Binary files /dev/null and /tmp/cvsOjK4hO differ
Index: certi_install.dox
===================================================================
RCS file: certi_install.dox
diff -N certi_install.dox
--- certi_install.dox 11 Oct 2008 21:40:16 -0000 3.3
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,72 +0,0 @@
-/**
- * \page install Installing CERTI
- *
- * \addindex installation
- * CERTI comes as either as an installer (binary) or compressed tar source
archives.
- * 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_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.2.4-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
- *
- * CMake 2.
- *
- */
Index: certi_introduction.dox
===================================================================
RCS file: certi_introduction.dox
diff -N certi_introduction.dox
--- certi_introduction.dox 10 Oct 2008 12:37:06 -0000 3.1
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,21 +0,0 @@
-/**
- * \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>.
- * 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.
- *
- */
Index: certi_user.dox
===================================================================
RCS file: certi_user.dox
diff -N certi_user.dox
--- certi_user.dox 13 Oct 2008 19:07:30 -0000 3.4
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,69 +0,0 @@
-/**
- * \page user Using CERTI
- *
- * \addindex user
- *
- * CERTI comes as a set of libraries and binaries executables, which may
- * be used to build an HLA compliant simulation.
- *
- * \section certi_user_running Running an HLA simulation with CERTI
- * \subsection certi_user_layout CERTI installation layout
- * CERTI components are installed in a user-chosen CERTI_HOME
- * directory. Below this root directory the layout is as described below:
- * \dot
- * digraph certi_layout {
- * node [shape=record, fontname=Helvetica, fontsize=10];
- * home [ label="CERTI_HOME"];
- * bin [ label="bin"];
- * lib [ label="lib"];
- * share [ label="share"];
- * doc [label="doc"];
- * federations [label="federations"];
- * home -> bin [ arrowhead="open", style="solid" ];
- * home -> lib [ arrowhead="open", style="solid" ];
- * home -> share [ arrowhead="open", style="solid" ];
- * share -> doc [ arrowhead="open", style="solid" ];
- * share -> federations [ arrowhead="open", style="solid" ];
- * }
- * \enddot
- *
- * \section certi_user_env CERTI environment variables
- *
- * CERTI uses a set of environment variables which may influence its
- * execution behavior.
- * <center>
- * <TABLE>
- * <tr>
- * <td><b>Variable</b></td><td><b>Component</b></td><td><b>Description</b></td>
- * </tr>
- * <tr>
- * <td>CERTI_HOST</td> <td>RTIA</td><td>machine on which RTIG is running</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_NO_STATISTICS</td> <td>RTIA</td> <td>if set, do not display
service calls statistics</td>
- * </tr>
- * </TABLE>
- * </center>
- *
- * \section certi_user_executables CERTI executables
- * CERTI comes with mainly 2 executables:
- * \subsection certi_user_rtig CERTI RunTime Infrastructure Gateway aka RTIG.
- * The CERTI RunTime Infrastructure Gateway (RTIG) is a process which
- * coordinate the HLA simulation with CERTI, there should be at least
- * one rtig process for each federation. However a single rtig may
- * be used for several federation.
- *
- * \subsection certi_user_rtia RTIA CERTI RunTime Infrastructure Ambassador
aka RTIA
- *
- * \copydoc certi_executable_RTIA
- *
- * The CERTI RunTime Infrastructure Ambassador (RTIA) is a process
- * which is automatically launched by any federate as soon as its
- * RTIambassador is created.
- *
- */
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [certi-cvs] certi/doc .cvsignore certi_install.cnf.in certi...,
certi-cvs <=