Salome HOME
Rollback wrong integration
[tools/install.git] / doc / readme.html
index 102f546874c1c541cbf1b4af1a308a3976a7389c..fbdec4ba179788b04390c4ae37270e302c264e72 100755 (executable)
@@ -10,7 +10,7 @@
        
   <meta name="Author"
  content="Vadim SANDLER (v-sandler@opencascade.com)">
-  <title>SALOME v1.4.1 Installation Wizard Help</title>
+  <title>SALOME v2.2.x Installation Wizard Help</title>
 </head>
   <body style="color: rgb(0,0,0); background-color: rgb(255,255,229);"
  link="#0000ee" vlink="#551a8b" alink="#ff0000">
         </td>
         <td>              
       <center>              
-      <h1><font size="+4"><font color="#000099">PAL/SALOME Installation Wizard
+      <h1><font size="+4"><font color="#000099">SALOME Installation Wizard
  Help</font>&nbsp;</font></h1>
         </center>
         </td>
         <td>              
       <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
- src="application.png" border="0" height="45" width="104">
+ src="application.png" border="0" height="47" width="109">
        </a></div>
         </td>
       </tr>
@@ -41,7 +41,7 @@
 </table>
   </center>
    
-<div align="right"><b><font color="#000099">updated for the version 1.4.1</font></b></div>
+<div align="right"><b><font color="#000099">updated for the version 2.2.4</font></b></div>
    
 <hr>  
 <ul>
@@ -95,9 +95,9 @@ configuration xml file.<br>
  </p>
    
 <p>The installation procedure can support some different Linux platforms
-(currently it provides only configuration scripts for <i>RedHat-8.0</i>)
-and various number of products. <br>
-  The using of configuration xml files gives flexible way to modify the list 
+and various number of products. Currently the basic target platform is <i>Linux RedHat 8.0</i>. 
+From SALOME version 2.2.4 Installation Wizard also supports <i>Linux Mandrake 10.1</i>.<br>
+The using of configuration xml files gives flexible way to modify the list 
 of products to be installed by the Installation Wizard without changing program's 
 source code. Just create your own configuration file and implement installation 
 scripts for products you want to be provided by Wizard. See <a
@@ -129,9 +129,9 @@ In the basic mode it is necessary just to enter target directory. If you want
 to use advanced mode, click <i>"More..."</i> button. </p>
    
 <p>In the advanced mode you have the possibility to select products to be 
-installed (see <a href="#ProductPage">Fig.1</a> ). Each product has several 
+installed (see <a href="#ProductPage">Fig.1</a> ). Each product can have several 
 options of installation: you have a possibility to use native products, install 
-already precompiled binaries, build product from the sources or not installed 
+already precompiled binaries, build product from the sources or not install it 
 at all. Possible options and default choice are provided by the configuration 
 file. You can mark the products, you want to install, by clicking the corresponding 
 radiobuttons in the list view in the left part of the page. Note that some 
@@ -145,16 +145,20 @@ This feature can be switched off by clicking <i>"Auto set prerequisites products
  checkbox. <br>
   Special button in the right part of the page - <i>"Unselect All" </i>-
 allows to reset quickly all products to the <i>"not install"</i> state. <br>
-  If you want to use native Linux Red Hat 8.0 products (these are gcc, tcl, 
+  If you want to use native products (for example, for Linux Red Hat 8.0 these are gcc, tcl, 
 Python, Qt, Sip and PyQt), select <i>"use native" </i>option. </p>
-   
+
+<p>There are also two checkboxes on this page: <i>"SALOME sources"</i> and <i>"SALOME binaries"</i>.
+These three-state checkboxes allow quick selecting/unselecting SALOME packages
+for the installation.</p>
+
 <p>The box at the right side of the page displays the information about currently 
 highlighted product: name, version, short description (if provided), required
 disk space, temporary files disk space, list of prerequisites and user choice.
 </p>
    
 <center><a name="ProductPage"></a><br>
-  <img src="productpage.png" height="525" width="565" alt="">
+  <img src="productpage.png" height="551" width="567" alt="">
    
 <p><b>Figure 1:</b> "Installation settings" page in the advanced mode</p>
   </center>
@@ -165,7 +169,7 @@ on the hard drive is required for installation of selected products. <br>
  disk space is approximate and may differ when you install products on your
  hard drive. </p>
    
-<p>Installation procedure uses a special directory to store temporary files.
+<p>The installation procedure uses a special directory to store temporary files.
  The <i>"Space for temporary files:"</i> field shows the information about
  required disk space on the hard drive for extracting and compiling of the
  selected products. You can change the default directory - just type path
@@ -193,7 +197,7 @@ wizard will follow to the next page: </p>
    
 <center>  
 <p><a name="ChoicePage"></a><br>
-  <img src="choicepage.png" height="525" width="565" alt="">
+  <img src="choicepage.png" height="551" width="567" alt="">
  </p>
    
 <p><b>Figure 2:</b> "Check your choice" page</p>
@@ -205,7 +209,7 @@ wizard will follow to the next page: </p>
 follow to the <a href="#ProgressPage">next page</a>. </p>
    
 <center><a name="ProgressPage"></a><br>
-  <img src="progresspage.png" height="525" width="565" alt="">
+  <img src="progresspage.png" height="551" width="567" alt="">
    
 <p><b>Figure 3:</b> "Installation progress" page</p>
   </center>
@@ -238,7 +242,7 @@ or click <i>"Next"</i> button to go the Readme page: </p>
    
 <center>  
 <p><a name="readmepage"></a><br>
-  <img src="readmepage.png" height="525" width="565" alt="">
+  <img src="readmepage.png" height="551" width="567" alt="">
  </p>
    
 <p><b>Figure 4:</b> "Finish installation" page</p>
@@ -258,8 +262,8 @@ To learn how installation scripts collects the environment, see&nbsp;<a
  href="#pick_up_env"> here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b> 
 in the <span style="font-style: italic;"><span
  style="font-weight: bold;">KERNEL module</span></span><b><i> sources</i></b>
-and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL</span></span><b><i>
-module binaries</i></b> root directories and <b>env_products.csh</b> + <b>env_products.sh
+and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL module</span></span><b><i>
+ binaries</i></b> root directories and <b>env_products.csh</b> + <b>env_products.sh
  </b>in the target directory. </p>
    
 <hr>  
@@ -267,7 +271,7 @@ module binaries</i></b> root directories and <b>env_products.csh</b> + <b>env_pr
 products version</font> procedure</h3>
   Unfortunately under Linux platform there is no exact algorithm to identify
  the product's version. The table below contains the information relating
-to checking preinstalled products for the Linux.RedHat 8.0 platform <br>
+to checking preinstalled products for the Linux RedHat 8.0 platform. <br>
   &nbsp;  
 <table border="1" width="100%" nosave="">
     <tbody>
@@ -289,11 +293,11 @@ to checking preinstalled products for the Linux.RedHat 8.0 platform <br>
       </tr>
       <tr>
         <td>gcc 3.2</td>
-        <td>ver=`/usr/bin/gcc --version | grep 'gcc (GCC) .*' | cut -b 11-13`</td>
+        <td>ver=`gcc -dumpversion`</td>
         <td>              
       <center>-</center>
         </td>
-        <td>ver should be equal 3.2 <br>
+        <td>ver should be 3.2.<br>
   It is recommended to use native gcc on Linux RedHat 8.0</td>
       </tr>
       <tr nosave="">
@@ -307,7 +311,7 @@ to checking preinstalled products for the Linux.RedHat 8.0 platform <br>
   existence of libtkx8.3.so</td>
         <td>set TCLHOME if you have preinstalled version of tcl. <br>
   set LD_LIBRARY_PATH on a directory where libs can be found.</td>
-        <td>It is recommended to use native tcl on Linux RedHat 8.0</td>
+        <td>It is recommended to use native tcl/tk on Linux RedHat 8.0</td>
       </tr>
       <tr>
        <td valign="top">boost 1.30.2<br>
@@ -323,13 +327,23 @@ BOOST from binaries.<br>
        </td>
      </tr>
      <tr>
-        <td>Cascade 5.1.2<br>
+        <td>Open CASCADE 5.2<br>
         </td>
-        <td>existence of CASROOT environment variable</td>
-        <td>set CASROOT if you have preinstalled version of CASCADE</td>
-        <td>Unfortunately we can't say anything exactly about CASCADE 5.1.2 
-and we only check CASROOT environment variable. If you have problem with
-preinstalled  version of CASCADE reinstall it</td>
+        <td>existence of CASROOT environment variable<br>ver_major=`grep "!define OCC_VERSION_MAJOR" ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
+ver_minor=`grep "!define OCC_VERSION_MINOR" ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
+ver="$ver_major.$ver_minor"<br>
+</td>
+        <td>set CASROOT if you have preinstalled version of Open CASCADE</td>
+        <td>CASCADE's Standard_Version.hxx file provides version information.</td>
+      </tr>
+     <tr>
+        <td>Patch for Open CASCADE 5.2<br>
+        </td>
+        <td></td>
+        <td></td>
+        <td>Open CASCADE 5.2 provided with the Installation Wizard already includes the patch,
+necessary for SALOME 2.2.x. In addition the Installation Wizard provides the sources of a Open CASCADE patch
+which can be applied to original Open CASCADE 5.2 sources before its compilation.</td>
       </tr>
       <tr>
         <td>Python 2.2.1</td>
@@ -362,9 +376,9 @@ to use OpenGL drivers installed on your computer locally. This check procedure
       <tr>
         <td>Qt 3.0.5</td>
         <td>existence of QTDIR <br>
-  existence of libqt-mt.so.3.0.5</td>
+  ver=`grep "QT_VERSION_STR" ${QTDIR}/include/qglobal.h | sed -e 's%^#define QT_VERSION_STR\([[:space:]]*\)%%g' -e 's%\"%%g'`</td>
         <td>set QTDIR if you have preinstalled version of qt</td>
-        <td>We try to find libqt-mt.so.3.0.5 in ${QTDIR}/lib folder. <br>
+        <td>Qt's qglobal.h file provides version information: ver should be 3.0.5.<br>
   You should set MESA_HOME only if you have preinstalled version of Mesa
 3.4.2.       <br>
   It is recommended to use native Qt on Linux RedHat 8.0</td>
@@ -380,7 +394,7 @@ to use OpenGL drivers installed on your computer locally. This check procedure
         <td>Hdf 5-1.4.4</td>
         <td>existence of HDF5HOME <br>
   existence of libhdf5.so.0.0.0 <br>
-  existence of libhdf5.settings</td>
+  existence of libhdf5.settings<br>ver=`grep "HDF5 Version:" ${HDF5HOME}/lib/libhdf5.settings | awk '{print $3}'`</td>
         <td>set HDF5HOME if you have preinstalled version of hdf</td>
         <td>We try to find libhdf5.so.0.0.0 and libhdf5.settings in ${HDF5HOME}/lib
  folder. <br>
@@ -388,12 +402,12 @@ to use OpenGL drivers installed on your computer locally. This check procedure
   HDF5 Version: 1.4.4</td>
       </tr>
       <tr>
-        <td>Med 2.1.6</td>
+        <td>Med 2.2.2</td>
         <td>existence of MED2HOME <br>
-  existence of libmed.so.0.0.0</td>
+  existence of libmed.so.1.0.1</td>
         <td>set MED2HOME if you have preinstalled version of med</td>
         <td>Unfortunately we can't check version number. <br>
-  We try to find libmed.so.0.0.0 in ${MED2HOME}/lib folder. <br>
+  We try to find libmed.so.1.0.1 in ${MED2HOME}/lib folder. <br>
   If you have problem with preinstalled version of med reinstall it.</td>
       </tr>
       <tr>
@@ -444,24 +458,16 @@ folder.</td>
       </tr>
       <tr>
         <td>Numeric 22.0</td>
-        <td>existence of Numeric folder <br>
-  existence of _numpy.so</td>
-        <td>set PYTHONHOME if you have preinstalled version of python</td>
-        <td>Unfortunately we can't check the version number. <br>
-  We try to find Numeric folder in ${PYTHONHOME}/lib/python2.2/site-packages/Numeric
- folder. <br>
-  If you have problem with preinstalled version of numeric 22.0 reinstall
-it.</td>
+        <td>ver=`python -c 'import Numeric; print Numeric.__version__' 2>/dev/null`</td>
+        <td>set PYTHONHOME if you have preinstalled version of Numeric package</td>
+        <td>If you have problem with preinstalled version of numeric 22.0 reinstall it.</td>
       </tr>
       <tr>
         <td>Sip 3.3.2</td>
-        <td>existence of SIPDIR <br>
-  existence of sip <br>
-  existence of libsip.so.9.1.0</td>
+        <td>existence of SIPDIR <br>sip_ver=`${SIPDIR}/sip -V | awk '{print $1}'`</td>
         <td>set SIPDIR to directory where you have sip preinstalled</td>
-        <td>We try to find sip and libsip.so.9.1.0 in $SIPDIR folder if you 
-set SIPDIR , otherwise searching is done using $PATH and $LD_LIBRARY_PATH
- accordingly. <br>
+        <td>Searching for the sip binary is performed in the folder pointed by the $SIPDIR variable if it is set
+and then by using $PATH variable. <br>
   It is recommended to use native Sip on Linux RedHat 8.0</td>
       </tr>
       <tr>
@@ -480,8 +486,8 @@ otherwise searching is done using $LD_LIBRARY_PATH . <br>
         <td>HappyDoc 2.1</td>
         <td>existence of happydoc <br>
   ver=`happydoc | grep "HappyDoc version 2.1"`</td>
-        <td>set PYTHONHOME if you have preinstalled version of python</td>
-        <td>We try to find happydoc in $PYTHONHOME/bin folder. <br>
+        <td>set PATH variable to the directory where you have HappyDoc installed.</td>
+        <td>We try to find happydoc in $PATH. <br>
   ver should not be empty. <br>
   This product is not obligatory. It was added only for your comfort.</td>
       </tr>
@@ -490,22 +496,21 @@ otherwise searching is done using $LD_LIBRARY_PATH . <br>
         <td>existence of doxygen <br>
   existence of doxysearch <br>
   existence of doxytag <br>
-  existence of doxywizard</td>
+  existence of doxywizard<br>ver=`doxygen --version`</td>
         <td>set QTDIR if you have preinstalled version of qt <br>
   set PATH on a directory where doxygen, doxysearch, doxytag and doxywizard
  can be found</td>
-        <td>Unfortunately we can't check the version number. <br>
-  It's necessary to have compiled Qt in order to build doxywizard. <br>
+        <td>doxygen, doxysearch, doxytag, doxywizard binaries should exist; ver should be 1.3-rc2.<br>
+It's necessary to have compiled Qt in order to build doxywizard. <br>
   If you have problem with preinstalled version of doxygen 1.3-rc2 reinstall
  it. <br>
   This product is not obligatory. It was added only for your comfort.</td>
       </tr>
       <tr>
         <td>Graphviz 1.9</td>
-        <td>existence of dot</td>
+        <td>existence of dot binary.<br>ver=`dot -V 2>&1 | awk '{print $3}'`</td>
         <td>add GraphViz's bin directory to the PATH environment variable</td>
-        <td>Unfortunately we can't check the version number. <br>
-  We try to find dot program in the $PATH</td>
+        <td>We try to find dot program in the $PATH.</td>
       </tr>
       <tr>
         <td>MODULE binaries<br>
@@ -516,8 +521,8 @@ otherwise searching is done using $LD_LIBRARY_PATH . <br>
   ver=`cat $MODULE_ROOT_DIR/bin/salome/VERSION | awk -F: '{print $2}' | tr 
 -d '[:space:]'`</td>
         <td>set MODULE_ROOT_DIR if you have preinstalled binaries of MODULE
- version 1.4.x</td>
-        <td>MODULE binaries should exist and ver should be equal to 1.4.x</td>
+ version 2.2.4</td>
+        <td>MODULE binaries should exist and ver should be equal to 2.2.4</td>
       </tr>
       <tr>
         <td>MODULE sources<br>
@@ -527,14 +532,14 @@ otherwise searching is done using $LD_LIBRARY_PATH . <br>
   existence of VERSION file <br>
   ver=`cat $MODULE_SRC/bin/VERSION | awk -F: '{print $2}' | tr -d '[:space:]'`</td>
         <td>set MODULE_SRC_DIR if you have preinstalled sources of MODULE
-version  1.4.x</td>
-        <td>MODULE sources should exist and ver should be equal to 1.4.x</td>
+version  2.2.4</td>
+        <td>MODULE sources should exist and ver should be equal to 2.2.4</td>
       </tr>
        
   </tbody>  
 </table>
    
-<p>Note: For native products installation procedure sets proper environment
+<p><b>Note:</b> For native products installation procedure sets proper environment
  variables itself, and you do not need to set such variables like, e.g. <b>TCLHOME</b>
  or <b>PYTHONHOME</b>. <br>
   If you have native products installed to different from default directories
@@ -542,6 +547,18 @@ version  1.4.x</td>
 description. Or you should set properly $PATH and $LD_LIBRARY_PATH variables 
 <b><font color="#ff0000">before</font></b> starting Installation Wizard. Otherwise
 installation script will fail to find preinstalled products. </p>
+<p><b>Note:</b> For some native products (e.g. gcc, Python) the rules of version
+checking are not so strict as described in the table. Only major and minor numbers of version
+should coincide with prerequisite. Release number can be larger. It is done for making a possibility
+to use native products for newer versions of Red Hat (for example, Linux Red Hat 9 includes native
+gcc 3.2.2 installation).
+If native product has version number larger than that required by installation procedure,
+you will be prompted by the warning message like this: <i>"You have newer version of gcc installed
+on your computer than that is required (3.2). Continue?"</i>. You can press <i>"Yes"</i> button
+to procede with the installation but in this case you should be aware of what you are doing.
+SALOME binaries (inluding other products) are compiled with the prerequisites from the list
+and most likely can not be run successfully if this products are not found.
+This can be only helpful if you intend to build all products from sources.</p>
    
 <h3>  
 <hr></h3>
@@ -598,7 +615,7 @@ are in brackets.</font>
   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  [license=&lt;install_wizard_license_info&gt;]</font> <br>
   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- [os=&lt;target_paltform&gt;]</font><b><font color="#000099">/&gt;</font></b><font
+ [os=&lt;target_platform&gt;]</font><b><font color="#000099">/&gt;</font></b><font
  color="#000000">]</font> <br>
   <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[</font><b><font
  color="#000099">&lt;path</font></b><font color="#000000"> [targetdir=&lt;target_directory&gt;]</font>
@@ -612,6 +629,8 @@ are in brackets.</font>
   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  version=&lt;product_version&gt;</font> <br>
   &nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;
+&nbsp;&nbsp; &nbsp;&nbsp; [context=&lt;product_context&gt;]<br>
+  &nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;
 &nbsp;&nbsp; &nbsp;&nbsp; [description=&lt;product_description&gt;]<br>
   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  install=&lt;installation_mode&gt;</font> <br>
@@ -680,9 +699,9 @@ to insert native products at the top of the list before all other products.
 <ul>
     <li> <font color="#000000"><b>name</b>: Name of the product;</font></li>
     <li> <font color="#000000"><b>version</b>: Version of the product;</font></li>
-    <li><font color="#000000"><span style="font-weight: bold;">description</span>:
- Description of the product (optional);<br>
-      </font></li>
+    <li> <font color="#000000"><b>description</b>: Description of the product (optional);</font></li>
+    <li> <font color="#000000"><b>context</b>: Context of the product (optional); the possible values are <b>'salome sources'</b>,
+        <b>'salome binaries'</b> and <b>'prerequisite'</b>;</font></li>
     <li> <font color="#000000"><b>supported</b>: Supported modes of installation,
  should contain one or more of the following options, separated by comma: 
     <i>install sources</i>, <i>install binaries</i>, <i>use native</i>. Installation
@@ -798,7 +817,7 @@ of prerequisite products, separated by space;</font> <br>
  </p>
    
 <p><font color="#000000">Example:</font> <br>
-  <i><font color="#000000">med-2.1.6.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0
+  <i><font color="#000000">med-2.2.2.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0
  /usr/salome 'gcc Hdf' med</font></i> </p>
    
 <p><font color="#000000">Copy created script into the <i>&lt;Install_Wizard_root_directory&gt;/config_files</i>