From: crouzet <nicolas.crouzet@cea.fr>
Date: Fri, 7 Jan 2022 13:47:33 +0000 (+0100)
Subject: documentation, option de sat package --with_vcs en combinaison avec --bin_products
X-Git-Tag: V9_9_0~17
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=512d8e507e03381f229b389baceef8a9e6afda9f;p=tools%2Fsat.git

documentation, option de sat package --with_vcs en combinaison avec --bin_products
---

diff --git a/commands/package.py b/commands/package.py
index c4fb437..bbb20be 100644
--- a/commands/package.py
+++ b/commands/package.py
@@ -121,7 +121,8 @@ parser.add_option('', 'bin_products', 'boolean', 'bin_products',
     _('Optional: Create binary archives for all products.'), False)
 parser.add_option('', 'with_vcs', 'boolean', 'with_vcs',
     _('Optional: Do not make archive for products in VCS mode (git, cvs, svn). ' 
-      'Sat prepare will use VCS mode instead to retrieve them'),
+      'Sat prepare will use VCS mode instead to retrieve them.'
+      '\n          Also, when combined with "--bin_products" option, restrict the building of product archives to VCS products.'),
     False)
 parser.add_option('', 'ftp', 'boolean', 'ftp',
     _('Optional: Do not embed archives for products in archive mode.' 
diff --git a/doc/README b/doc/README
index b412c82..4c17041 100644
--- a/doc/README
+++ b/doc/README
@@ -32,5 +32,5 @@ firefox build/html/index.html &
 # make doc pdf
 cd doc
 make latexpdf
-evince build/latex/salomeTools.pdf &
+evince build/latex/sat.pdf &
 
diff --git a/doc/src/commands/install.rst b/doc/src/commands/install.rst
new file mode 100644
index 0000000..b493114
--- /dev/null
+++ b/doc/src/commands/install.rst
@@ -0,0 +1,16 @@
+
+.. include:: ../../rst_prolog.rst
+
+Command install
+***************
+
+Description
+===========
+The **install** command gets the binaries of the application products from local (ARCHIVEPATH) or ftp server.
+
+
+Usage
+=====
+* Create a binary installation of SALOME which only contains SALOME,GEOM and SMESH modules, plus their dependencies: ::
+
+    sat install SALOME-master --products SALOME,GEOM,SMESH
diff --git a/doc/src/commands/package.rst b/doc/src/commands/package.rst
index f2ec862..8e6680b 100644
--- a/doc/src/commands/package.rst
+++ b/doc/src/commands/package.rst
@@ -74,6 +74,13 @@ Usage
 
   The version control systems known by this option are CVS_, SVN_ and Git_.
 
+* Create binary archives for each product: ::
+
+    # Create binary product archives for all products
+    sat package SALOME_xx --bin_products
+
+    # Create binary product archives only for VCS products
+    sat package SALOME_xx --bin_products --with_vcs
 
 Some useful configuration paths
 =================================
diff --git a/doc/src/index.rst b/doc/src/index.rst
index eeaef73..dec9d89 100644
--- a/doc/src/index.rst
+++ b/doc/src/index.rst
@@ -66,6 +66,7 @@ List of Commands
    init <commands/init>
    template <commands/template>
    application <commands/application>
+   install <commands/install>
 
 
 Release Notes