From: crouzet <nicolas.crouzet@cea.fr>
Date: Thu, 12 Apr 2018 14:51:07 +0000 (+0200)
Subject: ajout commande generate, complétion launcher.rst
X-Git-Tag: 5.1.0~39^2~2^2~2
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=31b7a3ded83f733f645a0cd3ed13c73e98d04546;p=tools%2Fsat.git

ajout commande generate, complétion launcher.rst
---

diff --git a/doc/src/commands/application.rst b/doc/src/commands/application.rst
index 908e935..6a6008a 100644
--- a/doc/src/commands/application.rst
+++ b/doc/src/commands/application.rst
@@ -23,7 +23,7 @@ Usage
 
 * Change the directory where the application is created: ::
 
-    sat application <application> --target </my/applications/directory>
+    sat application <application> --target </my/appli/directory>
 
 * Set a specific SALOME resources catalog (it will be used for the distribution of components on distant machines): ::
 
@@ -37,6 +37,9 @@ Usage
 
   This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
 
+* Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
+
+    sat launcher <application> --use_mesa
 
 Configuration
 =============
diff --git a/doc/src/commands/compile.rst b/doc/src/commands/compile.rst
index 8d057fd..c079501 100644
--- a/doc/src/commands/compile.rst
+++ b/doc/src/commands/compile.rst
@@ -32,7 +32,8 @@ Usage
 * Clean the build and install directories before starting compilation: ::
 
     sat compile <application> --products GEOM  --clean_all
-    Note: a warning will be shown if option --products is missing (as it will clean everything!)
+    Note: a warning will be shown if option --products is missing 
+    (as it will clean everything!)
 
 * Clean only the install directories before starting compilation: ::
 
diff --git a/doc/src/commands/generate.rst b/doc/src/commands/generate.rst
new file mode 100644
index 0000000..632a29c
--- /dev/null
+++ b/doc/src/commands/generate.rst
@@ -0,0 +1,37 @@
+****************
+Command generate
+****************
+
+Description
+===========
+The **generate** command generates and compile SALOME modules from cpp modules using YACSGEN.
+
+.. note:: This command uses YACSGEN to generate the module. It needs to be specified with *--yacsgen* option, or defined in the product or by the environment variable ``$YACSGEN_ROOT_DIR``.
+
+
+Remarks
+=======
+* This command will only apply on the CPP modules of the application, those who have both properties: ::
+
+        cpp : "yes"
+        generate : "yes"
+
+* The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)
+
+
+Usage
+=====
+* Generate all the modules of a product: ::
+
+    sat generate <application>
+
+* Generate only specific modules: ::
+
+    sat generate <application> --products <list of products>
+
+  Remark: modules which don't have the *generate* property are ignored.
+
+* Use a specific version of YACSGEN: ::
+
+    sat generate <application> --yacsgen <path to yacsgen>
+
diff --git a/doc/src/commands/launcher.rst b/doc/src/commands/launcher.rst
index c67120a..642ad78 100644
--- a/doc/src/commands/launcher.rst
+++ b/doc/src/commands/launcher.rst
@@ -15,24 +15,30 @@ Usage
     
   Generate a launcher in the application directory, i.e ``$APPLICATION.workdir``.
 
-* Create a launcher with a given name ::
+* Create a launcher with a given name (default name is APPLICATION.profile.launcher_name) ::
 
-    sat launcher <application>
+    sat launcher <application> --name ZeLauncher
 
   The launcher will called ZeLauncher.
 
 * Set a specific resources catalog: ::
 
-    sat launcher <application>
+    sat launcher <application>  --catalog  <path of a salome resources catalog>
     
   Note that the catalog specified will be copied to the profile directory.
 
 * Generate the catalog for a list of machines: ::
 
-    sat launcher <application>
+    sat launcher <application> --gencat <list of machines>
 
   This will create a catalog by querying each machine (memory, number of processor) with ssh.
 
+* Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
+
+    sat launcher <application> --use_mesa
+
+
+
 Configuration
 =============
 * APPLICATION.profile
diff --git a/doc/src/index.rst b/doc/src/index.rst
index 8f88d09..799753b 100644
--- a/doc/src/index.rst
+++ b/doc/src/index.rst
@@ -42,6 +42,7 @@ List of Commands
    environ <commands/environ>
    clean <commands/clean>
    package <commands/package>
+   generate <commands/generate>
 
 Code documentation
 ==================