Salome HOME
Update version
[tools/install.git] / doc / readme.html
index 542e471f7a80c5f1c8eec9321cda415684c7d43a..7a35afd3fde56f97c0ae215bb3177ff4df492697 100755 (executable)
@@ -1,4 +1,4 @@
-<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
+<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">\r
 <html>
 <head>
   <meta http-equiv="Content-Type"
@@ -7,7 +7,7 @@
  content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">
   <meta name="Author"
  content="Alexander KOVALEV, Open CASCADE SAS (alexander.kovalev@opencascade.com)">
-  <meta name="Copyright" content="2002-2008 CEA">
+  <meta name="Copyright" content="2002-2009 CEA">
   <title>SALOME Installation Wizard Help</title>
 </head>
 <body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 229);"
@@ -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">6.3.0</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,16 +58,16 @@ 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
+To run the Installation Wizard just type <b>./runInstall</b> in the
 terminal
 window:<span style="font-weight: bold;"></span><span
  style="font-weight: bold;"></span>
-<p>[ python ] <b>runInstall </b>[options]<b><br>
+<p>[ python ] <b>./runInstall </b>[options]<b><br>
 </b></p>
 <p>Without options this script will launch the SALOME Installation
 Wizard in the GUI mode.<br>
@@ -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
@@ -132,8 +150,8 @@ is the version number of the Installation Wizard, not of SALOME platform). <br>
 </p>
 <p>The installation procedure supports different <span style="color: rgb(0, 0, 153);">Linux
 </span>platforms and installs various 3d-party installation prerequisite products, which
-are required by SALOME platform. As it was mentioned above, the basic
-target platform for SALOME 4.0.0 and later is <span style="color: rgb(0, 0, 153);">Linux Mandriva 2006</span>.<br>
+are required by SALOME platform. The basic target platforms for SALOME
+5.0.0 and newer are <b>Linux Mandriva 2008 32bit</b> and <b>Linux Debian 4.0 (Etch) 64bit</b>.<br>
 The usage of configuration XML files provides a flexible way to modify
 the list of products to be installed by the Installation Wizard without
 changing the source code of the application. Just create your own XML
@@ -162,7 +180,7 @@ page is shown in <a href="#IntroPage">Figure 1</a>.
 Skip this page by pressing <i>"Next"</i> button:
 </p>
 <center><a name="IntroPage"></a><br>
-<img alt="Intro page" src="intropage.png" style="width: 593px; height: 468px;">
+<img alt="Intro page" src="intropage.png" style="width: 606px; height: 419px;">
 <p><b>Figure 1:</b> "Introduction" page</p>
 </center>
 <p>In the second page you are proposed to select the type of the
@@ -203,19 +221,19 @@ installation type, then you can also check "Remove sources and
 temporary files after compilation" option.
 </p>
 <center><a name="Installation_type_page"></a><br>
-<img alt="Installation type page" src="installtypepage.png" style="width: 593px; height: 468px;">
+<img alt="Installation type page" src="installtypepage.png" style="width: 606px; height: 419px;">
 <p><b>Figure 2:</b> "Type of installation" page
 </p>
 </center>
 <p>After the installation type has been selected you click <i>"Next"</i>
 button and the Installation Wizard tries to determine the Linux
-platform to load the corresponding configuration file. If the user
+platform to load the corresponding configuration file. If the operating
 system is not defined or the current SALOME package does not support
-this one, the warning will appear ("<i>Install binaries</i>"
+this system, the warning message will appear ("<i>Install binaries</i>"
 and "<i>Install sources</i>" installation types only):
 </p>
 <center><a name="Platform_page"></a><br>
-<img alt="Platform page" src="platformpage.png" style="width: 593px; height: 468px;">
+<img alt="Platform page" src="platformpage.png" style="width: 606px; height: 419px;">
 <p><b>Figure 3:</b> "Installation platform" page
 </p>
 </center>
@@ -246,7 +264,7 @@ experience some troubles with the
 installation.
 </p>
 <center><a name="Directory_page"></a><br>
-<img alt="Directory page" src="directorypage.png" style="width: 593px; height: 468px;">
+<img alt="Directory page" src="directorypage.png" style="width: 606px; height: 419px;">
 <p><b>Figure 4:</b> "Installation directory" page
 </p>
 </center>
@@ -258,7 +276,7 @@ products. To show it, just click "<i>Show prerequisites...</i>"
 button.
 </p>
 <center><a name="Products_page1"></a><br>
-<img alt="Products page (default mode)" src="productpage1.png" style="width: 593px; height: 468px;">
+<img alt="Products page (default mode)" src="productpage1.png" style="width: 606px; height: 419px;">
 <p><b>Figure 5:</b> Choice of the SALOME modules
 </p>
 </center>
@@ -271,7 +289,7 @@ the selected type of installation.<br>
 To hide the prerequisites list - click "<i>Hide prerequisites</i>"
 button.</p>
 <center><a name="Products_page2"></a><br>
-<img alt="Products page (full mode)" src="productpage2.png" style="width: 593px; height: 468px;">
+<img alt="Products page (full mode)" src="productpage2.png" style="width: 606px; height: 419px;">
 <p><b>Figure 6:</b> Choice of the prerequisites
 </p>
 </center>
@@ -314,21 +332,24 @@ automatically unchecked. In other words, it is possible to add more
 prerequisites than necessary.
 <p></p>
 <center><a name="Products_page3"></a><br>
-<img alt="Products page (dependencies presentation)" src="productpage3.png" style="width: 593px; height: 468px;">
+<img alt="Products page (dependencies presentation)" src="productpage3.png" style="width: 606px; height: 419px;">
 <p><b>Figure 7:</b> Dependencies between modules and
 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
+<img alt="Products page (Installation without GUI)" src="productpage4.png" style="width: 606px; height: 419px;">
+<p><b>Figure 8:</b> Installation without GUI mode
 </p>
 </center>
 <p>The box at the right side of the page displays the information
@@ -388,7 +409,7 @@ test fails you will see the corresponding warning message box.
 Otherwise the wizard will proceed to the next page:
 </p>
 <center><a name="ChoicePage"></a><br>
-<img alt="Choice page" src="choicepage.png" style="width: 593px; height: 468px;">
+<img alt="Choice page" src="choicepage.png" style="width: 606px; height: 419px;">
 <p><b>Figure 9:</b> "Check your choice" page
 </p>
 </center>
@@ -398,23 +419,25 @@ previous pages. You can review again your choices and change them if
 necessary returning to the previous pages. <br>
 When you are sure that everything is OK, press <i>"Next"</i>
 button to
-follow to the <a href="#ProgressPage">progress page</a>.
+follow to the <a href="#ProgressPage1">progress page</a>.
 </p>
 <center><a name="ProgressPage1"></a><br>
-<img alt="Progress page (not started yet)" src="progresspage1.png" style="width: 593px; height: 468px;">
+<img alt="Progress page (not started yet)" src="progresspage1.png" style="width: 606px; height: 419px;">
 <p><b>Figure 10:</b> "Installation progress" page:
 not started yet
 </p>
 </center>
 <div style="text-align: left;">To start the installation
-of the selected
-products click <i>"Start"</i>
+of the selected products click <i>"Start"</i>
 button. It launches the shell installation script and you will be able
 to see the output of the script in the topmost frame of the dialog box.
-If any
-errors occur during the installation progress, the corresponding
-messages
-will be printed to the log window in the bold red font.<br>
+If any errors occur during the installation progress, the corresponding
+messages will be printed to the log window in the bold red font and 
+installation process will be aborted with error message box. But user 
+has possibility to change this default behaviour by 
+<i>"Ignore installation errors"</i> checkbox. It is necessary to check 
+it before start and all occured errors will be passed, 
+and installation will be continued in any case.<br>
 </div>
 <div style="text-align: left;">It is possible to break the
 installation at any time by pressing <span style="font-style: italic;">"Stop"</span>
@@ -429,7 +452,7 @@ implementation it is not possible to resume the stopped installation
 process; the installation will restart from the very beginning. <br>
 </p>
 <center><a name="ProgressPage2"></a><br>
-<img alt="Progress page (installation started)" src="progresspage2.png" style="width: 593px; height: 468px;">
+<img alt="Progress page (installation started)" src="progresspage2.png" style="width: 606px; height: 419px;">
 <p><b>Figure 11:</b> "Installation progress" page:
 installation in
 progress
@@ -460,7 +483,7 @@ message will appear in the status bar. You can return to the previous
 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;">
+<img alt="Readme page" src="readmepage.png" style="width: 606px; height: 419px;">
 <p><b>Figure 12:</b> "Finish installation" page
 </p>
 </center>
@@ -476,7 +499,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 +509,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;">
+style="width: 638px; height: 425px;">
 <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
@@ -634,7 +659,11 @@ targetdir=&lt;target_directory&gt;
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 [
 tempdir=&lt;temp_directory&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-&nbsp;&nbsp;&nbsp;&nbsp; ]</font><b><font color="#000099"><br>
+&nbsp;&nbsp;&nbsp;&nbsp; ]</font>
+<br><font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[
+optionallibs=&lt;optional_libraries&gt;&nbsp;&nbsp;]</font>
+<b><font color="#000099"><br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /&gt; </font></b>
 <br>
 <font color="#000000"><b>&nbsp;&nbsp;&nbsp;
@@ -700,7 +729,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 +742,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;
@@ -754,8 +789,8 @@ name=&lt;product_name&gt;</font><b><font color="#000099"> &gt;</font></b> <br>
 <br>
 <font color="#000000">&nbsp;&nbsp;&nbsp; ]</font><br>
 <b><font color="#000099">
-&lt;/document&gt;</font></b> </p>
-</font>
+&lt;/document&gt;</font></b> </font></p>
+
 <h4><font color="#000000">&lt;config&gt;
 section</font></h4>
 <font color="#000000">This section provides general
@@ -805,6 +840,12 @@ installed.</font>
 </ul>
 <font color="#000000">The temporary directory is
 the path to the directory for the temporary files.</font>
+<ul>
+  <li> <font color="#000000"><b>optionallibs</b></font></li>
+</ul>
+<font color="#000000">A list of names of libraries. 
+An absence of these libraries in the user's system 
+doesn't affect on the correct work of SALOME platform.</font>
 <h4> <b>&lt;buttons&gt; section</b></h4>
 This is an optional section and may contains one or more
 &lt;product&gt; sections.
@@ -890,6 +931,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>
@@ -1188,5 +1234,5 @@ in the XML
 configuration file is set to the "true" value.
 </p>
 <hr><br>
-</body>
-</html>
\ No newline at end of file
+</font></body>
+</html>