]> SALOME platform Git repositories - tools/install.git/blobdiff - doc/readme.html
Salome HOME
Update for SALOME 4.1.3.
[tools/install.git] / doc / readme.html
index 542e471f7a80c5f1c8eec9321cda415684c7d43a..ebab71b3f0a92eae7703cc1cc3ec92f8cb2a04a9 100755 (executable)
@@ -36,7 +36,7 @@ Wizard Help</font></font></h3>
 </table>
 </center>
 <div align="right"><b><font color="#000099">updated for the version </font><font
- color="#ff0000">4.1.1</font></b></div>
+ color="#ff0000">4.1.3</font></b></div>
 <hr>
 <ul>
   <li> <a href="#install_from_wizard">Installing products with the
@@ -44,7 +44,7 @@ Installation Wizard<br>
     </a></li>
   <ul>
     <li><a href="#gui_mode">GUI mode</a></li>
-<!--    <li><a href="#batch_mode">Batch mode</a></li>-->
+    <li><a href="#batch_mode">Batch mode</a></li>
     <li><a href="#env_files">Environment files</a><br>
     </li>
   </ul>
@@ -58,9 +58,9 @@ the new products</a></li>
 <hr></h3>
 <h3> <a name="install_from_wizard"></a>Installing products with the <font
  color="#ff0000">Installation Wizard</font></h3>
-<!--The Installation Wizard can be launched in two modes: <span
+The Installation Wizard can be launched in two modes: <span
  style="font-weight: bold;">GUI </span>and <span
- style="font-weight: bold;">batch</span>. <br>-->
+ style="font-weight: bold;">batch</span>. <br>
 The root directory of the Installation Wizard
 contains Python script <span style="font-weight: bold;">runInstall</span>.
 To run the Installation Wizard just type <b>runInstall</b> in the
@@ -80,11 +80,11 @@ line options. Each option has short and long notations:<br>
 GUI
 mode (this is the default mode).<br>
 </div>
-<!--<p><b>-b / --batch</b><br>
+<p><b>-b / --batch</b><br>
 </p>
 <div style="margin-left: 40px;">Runs the Installation Wizard in
 the terminal mode. <br>
-</div>-->
+</div>
 <p><b>-f FILE / --file=</b><span style="font-weight: bold;">FILE<br>
 </span></p>
 <div style="margin-left: 40px;">
@@ -115,6 +115,24 @@ temporary directory, given in the configuration xml file
 <span style="font-weight: bold;"></span><!--, 
 see <a href="#xml_files">here</a> for more information-->).<br>
 </div>
+<p><b>-a / --all-from-sources</b></p>
+<div style="margin-left: 40px;">
+Force all the products to be installed from sources (including all
+SALOME modules). If this option is used, all the default installation
+modes for all the products are ignored.<br>
+This option is helpful when the user wants to install SALOME on the
+platform which is not officially supported. In this case, the user can
+try to run the SALOME Installation Wizard with the <span
+ style="font-weight: bold;">-a</span> option in order to build all the
+products from sources.<br>
+<b>Note, that this is long-time operation which can take more than 
+24 hours depending on the computer.</b><br>
+</div>
+<p><b>-s / --single-directory </b></p>
+<div style="margin-left: 40px;">Install all SALOME binaries packages 
+to one directory.<br>
+<b>This option is ignored when --all-from-sources (-a) option is used.
+</b></div>
 <p><b>-h / --help</b><br>
 </p>
 <div style="margin-left: 40px;">Prints help information on
@@ -320,15 +338,18 @@ prerequisites
 </p>
 </center>
 <p>The "<i>Installation with GUI</i>" checkbox allows
-managing the installation of the graphical interface. If it is
-unchecked, only "KERNEL" and "MED" modules are installed with their
-necessary prerequisites, and other modules are unchecked with no
+managing the installation of the graphical interface. Only modules for that 
+'woguimode' attribute is set to "true" value in the XML file 
+(see <a href="#xml_files">here</a> for more information about
+customizing this installation mode) support without GUI mode and 
+will be checked and installed with their necessary prerequisites in 
+case of installation without GUI. And other modules are unchecked with no
 possibility to check them in this mode (see <a href="#Products_page4">figure</a> below).<br>
-By default this checkbox is switched on.
+By default 'Installation with GUI' checkbox is switched on.
 </p>
 <center><a name="Products_page4"></a><br>
 <img alt="Products page (Installation without GUI)" src="productpage4.png" style="width: 593px; height: 468px;">
-<p><b>Figure 8:</b> Installation MED without GUI mode
+<p><b>Figure 8:</b> Installation without GUI mode
 </p>
 </center>
 <p>The box at the right side of the page displays the information
@@ -461,7 +482,7 @@ pages to start a new installation or click <i>"Next"</i>
 button to go to the readme page: </p>
 <center><a name="readmepage"></a><br>
 <img alt="Readme page" src="readmepage.png" style="width: 593px; height: 468px;">
-<p><b>Figure 12:</b> "Finish installation" page
+<p><b>Figure 12:<b> "Finish installation" page
 </p>
 </center>
 <p>In this page you can read important information about the
@@ -476,7 +497,7 @@ and <a href="#finish_buttons">here</a> for more
 information about
 customizing these buttons).<br>
 </p>
-<!--<h3 style="margin-left: 40px;"> <a name="batch_mode"></a>Batch mode<br>
+<h3 style="margin-left: 40px;"> <a name="batch_mode"></a>Batch mode<br>
 </h3>
 To launch the Installation Wizard in the batch mode use <span
 style="font-weight: bold;">-b</span>
@@ -486,18 +507,20 @@ status is displayed directly in the console. In the batch mode user do
 not have a possibility to change installation settings which are given
 in the configuration file, except target and temporary directories
 which can be overridden by the corresponding command line options.<br>
-The only exception is <span style="font-weight: bold;">--all-from-sources</span>
-(<span style="font-weight: bold;">-a</span>) option which enables
+There are two exceptions: <b>--all-from-sources</b>
+(<b>-a</b>) option which enables
 special installation mode in which all the products (including SALOME
 modules) are installed from sources, ignoring default mode defined in
 the XML configuration file (see <a href="#install_from_wizard">here</a>
-for details).
+for details) and <b>--single-directory</b> (<b>-s</b>) option which defines
+that all SALOME modules have to be installed into the one directory 
+(SALOME_&lt;version&gt;, by default, where &lt;version&gt; is SALOME version).
 <center><a name="BatchMode"></a><br>
 <br>
 <img alt="Batch mode" src="batchmode.png"
 style="width: 660px; height: 410px;">
 <p><b>Figure 9:</b> Batch mode</p>
-</center>-->
+</center>
 <h3 style="margin-left: 40px;"><a name="env_files"></a>Environment
 files</h3>
 <p>During the process of installation the
@@ -700,7 +723,12 @@ version=&lt;product_version&gt;</font> <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [
 disable=&lt;disable_flag&gt;
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]
+<font color="#000000"><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+&nbsp;&nbsp;&nbsp;
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [
+woguimode=&lt;without_gui_mode_flag&gt; ]
 <font color="#000000"><br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -708,7 +736,8 @@ installdiskspace=&lt;install_disk_space&gt;</font><br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp;
 &nbsp;&nbsp;&nbsp;&nbsp; [
-pickupenv=&lt;pickup_env_flag&gt; ]</font>&nbsp;
+pickupenv=&lt;pickup_env_flag&gt;
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]</font>&nbsp;
 <font color="#000000"><br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 &nbsp;
@@ -890,6 +919,11 @@ Attributes:</font><br>
 <font color="#000000">If this optional flag has 'true'
 value, the corresponding product will not appear in the list of
 products and will not be installed.</font>
+<ul>
+  <li> <font color="#000000"><b>woguimode</b></font></li>
+</ul>
+<font color="#000000">This optional flag defines that 
+it's possible to install this module without GUI.</font>
 <ul>
   <li> <font color="#000000"><b>installdiskspace</b></font></li>
 </ul>