doc/readme.html

   1 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
   2 <html>
   3 <head>
   4
   5   <meta http-equiv="Content-Type"
   6  content="text/html; charset=iso-8859-1">
   7
   8   <meta name="GENERATOR"
   9  content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">
  10
  11   <meta name="Author"
  12  content="Vadim SANDLER (v-sandler@opencascade.com)">
  13   <title>SALOME v2.2.x Installation Wizard Help</title>
  14 </head>
  15   <body style="color: rgb(0,0,0); background-color: rgb(255,255,229);"
  16  link="#0000ee" vlink="#551a8b" alink="#ff0000">
  17   &nbsp;
  18 <center>
  19 <table width="100%" nosave="">
  20     <tbody>
  21       <tr nosave="">
  22         <td nosave="">
  23       <h1><a href="http://www.opencascade.com"><img src="logocorp.png"
  24  border="0" height="47" width="139">
  25        </a></h1>
  26         </td>
  27         <td>
  28       <center>
  29       <h1><font size="+4"><font color="#000099">SALOME Installation Wizard
  30  Help</font>&nbsp;</font></h1>
  31         </center>
  32         </td>
  33         <td>
  34       <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
  35  src="application.png" border="0" height="47" width="109">
  36        </a></div>
  37         </td>
  38       </tr>
  39
  40   </tbody>
  41 </table>
  42   </center>
  43
  44 <div align="right"><b><font color="#000099">updated for the version 2.2.4</font></b></div>
  45
  46 <hr>
  47 <ul>
  48     <li> <a href="#install_from_wizard">Installing products with the Installation
  49  Wizard</a></li>
  50     <li> <a href="#check_version_proc">Notes on check products version procedure</a></li>
  51     <li> <a href="#pick_up_env">Pick up the environment</a></li>
  52     <li> <a href="#xml_files">Modifying XML configuration file</a></li>
  53     <li> <a href="#new_products">Implementing installation scripts for the
  54  new products</a></li>
  55
  56 </ul>
  57
  58 <h3>
  59 <hr></h3>
  60
  61 <h3> <a name="install_from_wizard"></a>Installing products with the <font
  62  color="#ff0000">Installation Wizard</font></h3>
  63   You can run the Installation Wizard in two modes. It's root directory contains
  64  python script runInstall.py:
  65 <p><b>[ python ] runInstall [ -g | b ] [ -f &lt;xml-file&gt; ] [ -t &lt;target-dir&gt;
  66  ] [ -tmp &lt;tmp-dir&gt; ]</b> </p>
  67
  68 <p><b>-g</b><br>
  69 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Runs the Installation Wizard in the GUI
  70 mode. In this case only &lt;xml-file&gt;  key is taken into account. This
  71 option is used by default. <br>
  72   <b>-b</b><br>
  73 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Runs the Installation Wizard in the batch
  74 mode. <br>
  75   <b>-f &lt;xml-file&gt;</b><br>
  76 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;The configuration  file to be used by the
  77 Installation Wizard.&nbsp; If this parameter is missed then the script tries
  78 to define the <i>Red Hat </i>version and uses corresponding xml file. For
  79 examle, for the <i>Red Hat 8.0</i> <b>config_RedHat8_0.xml</b>&nbsp;  file
  80 is supposed to be used by default. If the appropriate file is not found, <b>config.xml</b>
  81 is used by default. <br>
  82   <b>-t &lt;target-dir&gt;</b><br>
  83 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;The target directory, SALOME products  to
  84 be installed to. If used, overloads target directory, given in the  configuration
  85 xml file. <br>
  86   <b>-tmp &lt;tmp-dir&gt;</b><br>
  87 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;The directory, which is used to contain
  88  temporary files.&nbsp; If used, overloads temporary directory, given in the
  89 configuration xml file.<br>
  90 <b>-h</b><br>
  91 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Prints help information. <br>
  92  </p>
  93
  94 <p>So, to run the Installation Wizard in the GUI mode, just type <b>runInstall</b>.
  95  </p>
  96
  97 <p>The installation procedure can support some different Linux platforms
  98 and various number of products. Currently the basic target platform is <i>Linux RedHat 8.0</i>.
  99 From SALOME version 2.2.4 Installation Wizard also supports <i>Linux Mandrake 10.1</i>.<br>
 100 The using of configuration xml files gives flexible way to modify the list
 101 of products to be installed by the Installation Wizard without changing program's
 102 source code. Just create your own configuration file and implement installation
 103 scripts for products you want to be provided by Wizard. See <a
 104  href="#xml_files">modifying XML configuration file</a> and <a
 105  href="#new_products">implementing installation scripts for the new products</a>
 106 for more information. </p>
 107
 108 <p>The <font color="#ff0000">Installation Wizard</font> was built with using
 109 of the <b><i>Qt&nbsp; </i></b>library. The program contains several pages.
 110 To navigate between pages use <i>"Next"</i> and <i>"Back"</i> buttons in the
 111 lower part of the wizard window. <i>"Cancel"</i> button closes dialog  window
 112 and quits the installation procedure. To invoke this help information  click
 113 <i>"Help"</i> button. </p>
 114
 115 <p>Skip the first <i>"Introduction"</i> page by pressing <i>"Next"</i> button.
 116  </p>
 117
 118 <p>In the second page you are proposed to enter the target directory where
 119  all selected products will be installed to. You can also press <i>"Browse..."</i>
 120  button and choose the folder for installation using standard <b><i>Qt</i></b>
 121  browse directory dialog box. <br>
 122   If the directory you want to install products does not exist you will be
 123 prompted to confirm directory creation. If you type wrong directory path,
 124 or if you have no permission for the directory you use, the corresponding
 125  message box will raise. </p>
 126
 127 <p>The Installation Wizard has two modes of the installation: basic and advanced.
 128 In the basic mode it is necessary just to enter target directory. If you want
 129 to use advanced mode, click <i>"More..."</i> button. </p>
 130
 131 <p>In the advanced mode you have the possibility to select products to be
 132 installed (see <a href="#ProductPage">Fig.1</a> ). Each product can have several
 133 options of installation: you have a possibility to use native products, install
 134 already precompiled binaries, build product from the sources or not install it
 135 at all. Possible options and default choice are provided by the configuration
 136 file. You can mark the products, you want to install, by clicking the corresponding
 137 radiobuttons in the list view in the left part of the page. Note that some
 138 products can be installed only together with other products (or these prerequisite
 139 products should be already installed on your computer). The installation procedure
 140 has a special feature to automatically mark these products in the list view.
 141 For example, in order to install <b><i>pyqt</i></b> it's necessary to have
 142 <b><i>gcc, python</i></b>,<b><i> qt</i></b> and <b><i>sip</i></b> installed.
 143 Therefore all these products will be marked when you check on <b><i>pyqt</i></b>.
 144 This feature can be switched off by clicking <i>"Auto set prerequisites products"</i>
 145  checkbox. <br>
 146   Special button in the right part of the page - <i>"Unselect All" </i>-
 147 allows to reset quickly all products to the <i>"not install"</i> state. <br>
 148   If you want to use native products (for example, for Linux Red Hat 8.0 these are gcc, tcl,
 149 Python, Qt, Sip and PyQt), select <i>"use native" </i>option. </p>
 150
 151 <p>There are also two checkboxes on this page: <i>"SALOME sources"</i> and <i>"SALOME binaries"</i>.
 152 These three-state checkboxes allow quick selecting/unselecting SALOME packages
 153 for the installation.</p>
 154
 155 <p>The box at the right side of the page displays the information about currently
 156 highlighted product: name, version, short description (if provided), required
 157 disk space, temporary files disk space, list of prerequisites and user choice.
 158 </p>
 159
 160 <center><a name="ProductPage"></a><br>
 161   <img src="productpage.png" height="551" width="567" alt="">
 162
 163 <p><b>Figure 1:</b> "Installation settings" page in the advanced mode</p>
 164   </center>
 165
 166 <p>The <i>"Total disk space required:"</i> field displays how much disk space
 167 on the hard drive is required for installation of selected products. <br>
 168   <b>Note: </b>Please, take into account that displayed amount of required
 169  disk space is approximate and may differ when you install products on your
 170  hard drive. </p>
 171
 172 <p>The installation procedure uses a special directory to store temporary files.
 173  The <i>"Space for temporary files:"</i> field shows the information about
 174  required disk space on the hard drive for extracting and compiling of the
 175  selected products. You can change the default directory - just type path
 176 to the folder you want to use or click on the corresponding <i>"Browse..."</i>
 177  button. </p>
 178
 179 <p>The installation procedure also checks available disk space on the selected
 180  directories according to the products selected. If there is no enough disk
 181  space on your hard drive you will see the corresponding error message box.
 182  </p>
 183
 184 <p><b>Note: </b>Unfortunately, the configure procedure has a very annoying
 185  bug under Linux platform. The directory should be obligatory entered without
 186  spaces. For example, the configure procedure for <b><i>gcc</i></b> won't
 187 work if you pass the following parameter: <i>--prefix="/New Folder 1"</i>.
 188 <b>Therefore  you are strongly recommended not to use directory names containing
 189 spaces.</b>  </p>
 190
 191 <p>To proceed further click <i>"Next"</i> button. At this moment program
 192 will make some tests to check installation settings: if there is enough disk
 193 space on the hard drive, if native products are preinstalled, dependencies
 194 (prerequisites) for each product you have selected to be&nbsp; installed.
 195 If any test fails you will see corresponding warning message box. Otherwise
 196 wizard will follow to the next page: </p>
 197
 198 <center>
 199 <p><a name="ChoicePage"></a><br>
 200   <img src="choicepage.png" height="551" width="567" alt="">
 201  </p>
 202
 203 <p><b>Figure 2:</b> "Check your choice" page</p>
 204   </center>
 205
 206 <p>This page summarizes the installation settings you've made on the previous
 207  pages. You can check again your choice to change it if necessary. <br>
 208   When you are sure that everything is OK, press <i>"Next"</i> button to
 209 follow to the <a href="#ProgressPage">next page</a>. </p>
 210
 211 <center><a name="ProgressPage"></a><br>
 212   <img src="progresspage.png" height="551" width="567" alt="">
 213
 214 <p><b>Figure 3:</b> "Installation progress" page</p>
 215   </center>
 216
 217 <p>To start installation of the selected products click <i>"Start"</i> button.
 218 It launches the shell installation script and you will be able to see the
 219 output of the script in the topmost dialog's frame. In case of any installation
 220 problems (for example, you have accidentally removed the temporary directory)
 221 the script will ask you: <i>"Would you like to continue : (Y,N) ?"</i>. You
 222 can answer this question by typing [Y] or [N] in the middle text edit control
 223 frame. <br>
 224   <b>Note:</b> press [Enter] when you finish typing data. </p>
 225
 226 <p>The <i>"Installation Status"</i> frame window shows you the progress of
 227 installation. It contains a list of all selected products with brief descriptions.
 228 "<font color="#ff0000">Waiting</font>" description means that installation
 229 of this product have not started yet. Currently installing product is marked
 230 as "<font color="#ff9900">Processing</font>". All installed products have
 231 "<font color="#33ff33">Completed</font>" description. </p>
 232
 233 <p>You can abort installation and close the installation procedure using
 234 <i>"Cancel"</i>  button. It sends the signal "SIGTERM" to the shell script.
 235 The script has  a signal handler and will try to clear all temporary files.
 236 The process of removing temporary files can take some time, so the installation
 237 wizard will wait 3 seconds before closing. </p>
 238
 239 <p>At the end of installation (all selected products have been installed
 240 successfully) you can go back to the previous pages to start a new installation
 241 or click <i>"Next"</i> button to go the Readme page: </p>
 242
 243 <center>
 244 <p><a name="readmepage"></a><br>
 245   <img src="readmepage.png" height="551" width="567" alt="">
 246  </p>
 247
 248 <p><b>Figure 4:</b> "Finish installation" page</p>
 249   </center>
 250
 251 <p>In this page you can read important information about the Instalation
 252 Wizard itself and some hints: how to run and test SALOME or how to build
 253 SALOME from the sources. This is the contents of the README file which you
 254 can find in the root directory of the Installation Wizard. <br>
 255   You can also launch SALOME Desktop from this page by clicking <i>"Launch
 256  SALOME" </i>button. </p>
 257
 258 <p>During the process of installation the script creates some environment
 259  files to simplify procedure of launching SALOME. These shell scripts set
 260 all necessary environment variables for all products you have installed.
 261 To learn how installation scripts collects the environment, see&nbsp;<a
 262  href="#pick_up_env"> here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b>
 263 in the <span style="font-style: italic;"><span
 264  style="font-weight: bold;">KERNEL module</span></span><b><i> sources</i></b>
 265 and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL module</span></span><b><i>
 266  binaries</i></b> root directories and <b>env_products.csh</b> + <b>env_products.sh
 267  </b>in the target directory. </p>
 268
 269 <hr>
 270 <h3><a name="check_version_proc"></a>Notes on<font color="#ff0000"> check
 271 products version</font> procedure</h3>
 272   Unfortunately under Linux platform there is no exact algorithm to identify
 273  the product's version. The table below contains the information relating
 274 to checking preinstalled products for the Linux RedHat 8.0 platform. <br>
 275   &nbsp;
 276 <table border="1" width="100%" nosave="">
 277     <tbody>
 278       <tr nosave="">
 279         <th nosave="">
 280       <center><font size="+1">Product</font></center>
 281         </th>
 282         <th nosave="">
 283       <center><font size="+1">Algorithm of checking</font></center>
 284         </th>
 285         <th nosave="">
 286       <center><font size="+1">Preliminary steps before launching</font>
 287     <br>
 288         <font size="+1">of installation procedure</font></center>
 289         </th>
 290         <th nosave="">
 291       <center><font size="+1">Notes</font></center>
 292         </th>
 293       </tr>
 294       <tr>
 295         <td>gcc 3.2</td>
 296         <td>ver=`gcc -dumpversion`</td>
 297         <td>
 298       <center>-</center>
 299         </td>
 300         <td>ver should be 3.2.<br>
 301   It is recommended to use native gcc on Linux RedHat 8.0</td>
 302       </tr>
 303       <tr nosave="">
 304         <td>tcl 8.3</td>
 305         <td nosave="">existence of TCLHOME <br>
 306   existence of tclsh8.3 <br>
 307   existence of wish8.3 <br>
 308   existence of libtcl8.3.so <br>
 309   existence of libtk8.3.so <br>
 310   existence of libtclx8.3.so <br>
 311   existence of libtkx8.3.so</td>
 312         <td>set TCLHOME if you have preinstalled version of tcl. <br>
 313   set LD_LIBRARY_PATH on a directory where libs can be found.</td>
 314         <td>It is recommended to use native tcl/tk on Linux RedHat 8.0</td>
 315       </tr>
 316       <tr>
 317        <td valign="top">boost 1.30.2<br>
 318        </td>
 319        <td valign="top">ver=`egrep 'BOOST_VERSION [0-9]+' ${BOOSTDIR}/boost/version.hpp
 320 | sed 's/.*BOOST_VERSION \([0-9]\+\)/\1/g'`<br>
 321        </td>
 322        <td valign="top">set BOOSTDIR if you have preinstalled version of
 323 boost<br>
 324        </td>
 325        <td valign="top">It is impossible to use native BOOST and to install
 326 BOOST from binaries.<br>
 327        </td>
 328      </tr>
 329      <tr>
 330         <td>Open CASCADE 5.2<br>
 331         </td>
 332         <td>existence of CASROOT environment variable<br>ver_major=`grep "!define OCC_VERSION_MAJOR" ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
 333 ver_minor=`grep "!define OCC_VERSION_MINOR" ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
 334 ver="$ver_major.$ver_minor"<br>
 335 </td>
 336         <td>set CASROOT if you have preinstalled version of Open CASCADE</td>
 337         <td>CASCADE's Standard_Version.hxx file provides version information.</td>
 338       </tr>
 339      <tr>
 340         <td>Patch for Open CASCADE 5.2<br>
 341         </td>
 342         <td></td>
 343         <td></td>
 344         <td>Open CASCADE 5.2 provided with the Installation Wizard already includes the patch,
 345 necessary for SALOME 2.2.x. In addition the Installation Wizard provides the sources of a Open CASCADE patch
 346 which can be applied to original Open CASCADE 5.2 sources before its compilation.</td>
 347       </tr>
 348       <tr>
 349         <td>Python 2.2.1</td>
 350         <td>existence of PYTHONHOME <br>
 351   isPython=`which python` <br>
 352   ver=`python -V`</td>
 353         <td>set PYTHONHOME to root Python folder <br>
 354   set PATH on a directory where python can be found</td>
 355         <td>Python should exist and ver should be equal to 2.2.1 <br>
 356   It is recommended to use native Python on Linux RedHat 8.0</td>
 357       </tr>
 358       <tr>
 359         <td>Mesa 3.4.2</td>
 360         <td>existence of libGL.so.1.2.030402</td>
 361         <td>set LD_LIBRARY_PATH on a directory where libGL.so.1.2.030402
 362 can be found</td>
 363         <td>You have a possibility to build products (vtk &amp; qt) with
 364 Mesa drivers from the package supplied with this installation procedure or
 365 to use OpenGL drivers installed on your computer locally. This check procedure
 366  concerns only supplied Mesa driver.</td>
 367       </tr>
 368       <tr>
 369         <td>Swig 1.3.17</td>
 370         <td>isSwig=`which swig` <br>
 371   ver=`swig -version` <br>
 372   ver=`echo $ver | awk '{print $3}'`</td>
 373         <td>set PATH on a directory where swig can be found</td>
 374         <td>Swig should exist and ver should be equal to 1.3.17</td>
 375       </tr>
 376       <tr>
 377         <td>Qt 3.0.5</td>
 378         <td>existence of QTDIR <br>
 379   ver=`grep "QT_VERSION_STR" ${QTDIR}/include/qglobal.h | sed -e 's%^#define QT_VERSION_STR\([[:space:]]*\)%%g' -e 's%\"%%g'`</td>
 380         <td>set QTDIR if you have preinstalled version of qt</td>
 381         <td>Qt's qglobal.h file provides version information: ver should be 3.0.5.<br>
 382   You should set MESA_HOME only if you have preinstalled version of Mesa
 383 3.4.2.       <br>
 384   It is recommended to use native Qt on Linux RedHat 8.0</td>
 385       </tr>
 386       <tr>
 387         <td>Qwt 0.4.1</td>
 388         <td>existence of QWTHOME <br>
 389   existence of libqwt.so.0.4.1</td>
 390         <td>set&nbsp; QWTHOME if you have preinstalled version of qwt</td>
 391         <td>We try to find libqwt.so.0.4.1 in the ${QWTHOME}/lib folder.&nbsp;</td>
 392       </tr>
 393       <tr>
 394         <td>Hdf 5-1.4.4</td>
 395         <td>existence of HDF5HOME <br>
 396   existence of libhdf5.so.0.0.0 <br>
 397   existence of libhdf5.settings<br>ver=`grep "HDF5 Version:" ${HDF5HOME}/lib/libhdf5.settings | awk '{print $3}'`</td>
 398         <td>set HDF5HOME if you have preinstalled version of hdf</td>
 399         <td>We try to find libhdf5.so.0.0.0 and libhdf5.settings in ${HDF5HOME}/lib
 400  folder. <br>
 401   File libhdf5.settings should contain the following entry: <br>
 402   HDF5 Version: 1.4.4</td>
 403       </tr>
 404       <tr>
 405         <td>Med 2.2.2</td>
 406         <td>existence of MED2HOME <br>
 407   existence of libmed.so.1.0.1</td>
 408         <td>set MED2HOME if you have preinstalled version of med</td>
 409         <td>Unfortunately we can't check version number. <br>
 410   We try to find libmed.so.1.0.1 in ${MED2HOME}/lib folder. <br>
 411   If you have problem with preinstalled version of med reinstall it.</td>
 412       </tr>
 413       <tr>
 414         <td>Vtk 4.2</td>
 415         <td>existence of VTKHOME <br>
 416   existence of libvtkCommon.so</td>
 417         <td>set VTKHOME if you have preinstalled version of vtk</td>
 418         <td>Unfortunately we can't check the version number. <br>
 419   We try to find libvtkCommon.so in ${VTKHOME}/lib/vtk folder. <br>
 420   If you have problem with preinstalled version of vtk reinstall it.</td>
 421       </tr>
 422       <tr>
 423        <td valign="top">Netgen 4.3<br>
 424        </td>
 425        <td valign="top">existence of NETGENROOT<br>
 426        </td>
 427        <td valign="top">set NETGENROOT if you have preinstalled version of
 428 Netgen.<br>
 429        </td>
 430        <td valign="top">Unfortunarely we can't find anything about netgen
 431 version.<br>
 432 We just check if NETGENROOT environment varible is set.<br>
 433        </td>
 434      </tr>
 435      <tr>
 436         <td>OmniORB 3.0.5, <br>
 437   OmniORBpy 1.5, <br>
 438   OmniNotify 1.2</td>
 439         <td>existence of OMNIORBDIR <br>
 440   existence of libomniORB3.so.0.5 <br>
 441   existence of _omnipymodule.so.0.5 <br>
 442   existence of libCOSNotify3.so.0.5 <br>
 443   existence of notifd <br>
 444   existence of THIS_IS_omniORB_3_0_5 <br>
 445   existence of THIS_IS_omniNotify_1_2 <br>
 446   existence of THIS_IS_OMNIORBPY_1_5</td>
 447         <td>set OMNIORBDIR if you have preinstalled version of omni</td>
 448         <td>We try to find libomniORB3.so.0.5, _omnipymodule.so.0.5 and libCOSNotify3.so.0.5
 449  in ${OMNIORBDIR}/lib/i586_linux_2.0_glibc2.1 folder. <br>
 450   We try to find notifd in ${OMNIORBDIR}/bin/i586_linux_2.0_glibc2.1 folder.
 451       <br>
 452   Additional checking - omni add special files THIS_IS_... <br>
 453   We try to find THIS_IS_omniORB_3_0_5 in ${OMNIORBDIR} folder. <br>
 454   We try to find THIS_IS_omniNotify_1_2 in ${OMNIORBDIR}/src/services/omniNotify.
 455       <br>
 456   We try to find THIS_IS_OMNIORBPY_1_5 in ${OMNIORBDIR}/src/lib/omniORBpy
 457 folder.</td>
 458       </tr>
 459       <tr>
 460         <td>Numeric 22.0</td>
 461         <td>ver=`python -c 'import Numeric; print Numeric.__version__' 2>/dev/null`</td>
 462         <td>set PYTHONHOME if you have preinstalled version of Numeric package</td>
 463         <td>If you have problem with preinstalled version of numeric 22.0 reinstall it.</td>
 464       </tr>
 465       <tr>
 466         <td>Sip 3.3.2</td>
 467         <td>existence of SIPDIR <br>sip_ver=`${SIPDIR}/sip -V | awk '{print $1}'`</td>
 468         <td>set SIPDIR to directory where you have sip preinstalled</td>
 469         <td>Searching for the sip binary is performed in the folder pointed by the $SIPDIR variable if it is set
 470 and then by using $PATH variable. <br>
 471   It is recommended to use native Sip on Linux RedHat 8.0</td>
 472       </tr>
 473       <tr>
 474         <td>PyQt 3.3.2</td>
 475         <td>existence of PYQTDIR <br>
 476   existence of libqtxmlcmodule.so.1.0.0</td>
 477         <td>set PYQTDIR to directory where you have sip preinstalled</td>
 478         <td>Unfortunately we can't check the version number. <br>
 479   We try to find libqtxmlcmodule.so.1.0.0 in $PYQTDIR folder if you set PYQTDIR,
 480 otherwise searching is done using $LD_LIBRARY_PATH . <br>
 481   If you have problem with preinstalled version of PyQt 3.3.2 reinstall it.
 482       <br>
 483   It is recommended to use native PyQt on Linux RedHat 8.0</td>
 484       </tr>
 485       <tr>
 486         <td>HappyDoc 2.1</td>
 487         <td>existence of happydoc <br>
 488   ver=`happydoc | grep "HappyDoc version 2.1"`</td>
 489         <td>set PATH variable to the directory where you have HappyDoc installed.</td>
 490         <td>We try to find happydoc in $PATH. <br>
 491   ver should not be empty. <br>
 492   This product is not obligatory. It was added only for your comfort.</td>
 493       </tr>
 494       <tr>
 495         <td>Doxygen 1.3-rc2</td>
 496         <td>existence of doxygen <br>
 497   existence of doxysearch <br>
 498   existence of doxytag <br>
 499   existence of doxywizard<br>ver=`doxygen --version`</td>
 500         <td>set QTDIR if you have preinstalled version of qt <br>
 501   set PATH on a directory where doxygen, doxysearch, doxytag and doxywizard
 502  can be found</td>
 503         <td>doxygen, doxysearch, doxytag, doxywizard binaries should exist; ver should be 1.3-rc2.<br>
 504 It's necessary to have compiled Qt in order to build doxywizard. <br>
 505   If you have problem with preinstalled version of doxygen 1.3-rc2 reinstall
 506  it. <br>
 507   This product is not obligatory. It was added only for your comfort.</td>
 508       </tr>
 509       <tr>
 510         <td>Graphviz 1.9</td>
 511         <td>existence of dot binary.<br>ver=`dot -V 2>&1 | awk '{print $3}'`</td>
 512         <td>add GraphViz's bin directory to the PATH environment variable</td>
 513         <td>We try to find dot program in the $PATH.</td>
 514       </tr>
 515       <tr>
 516         <td>MODULE binaries<br>
 517   (MODULE=KERNEL,GEOM, ...)<br>
 518         </td>
 519         <td>existence of MODULE_ROOT_DIR <br>
 520   existence of VERSION file <br>
 521   ver=`cat $MODULE_ROOT_DIR/bin/salome/VERSION | awk -F: '{print $2}' | tr
 522 -d '[:space:]'`</td>
 523         <td>set MODULE_ROOT_DIR if you have preinstalled binaries of MODULE
 524  version 2.2.4</td>
 525         <td>MODULE binaries should exist and ver should be equal to 2.2.4</td>
 526       </tr>
 527       <tr>
 528         <td>MODULE sources<br>
 529   (MODULE=KERNEL,GEOM, ...)<br>
 530         </td>
 531         <td>existence of MODULE_SRC_DIR <br>
 532   existence of VERSION file <br>
 533   ver=`cat $MODULE_SRC/bin/VERSION | awk -F: '{print $2}' | tr -d '[:space:]'`</td>
 534         <td>set MODULE_SRC_DIR if you have preinstalled sources of MODULE
 535 version  2.2.4</td>
 536         <td>MODULE sources should exist and ver should be equal to 2.2.4</td>
 537       </tr>
 538
 539   </tbody>
 540 </table>
 541
 542 <p><b>Note:</b> For native products installation procedure sets proper environment
 543  variables itself, and you do not need to set such variables like, e.g. <b>TCLHOME</b>
 544  or <b>PYTHONHOME</b>. <br>
 545   If you have native products installed to different from default directories
 546  (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is recommended to follow above
 547 description. Or you should set properly $PATH and $LD_LIBRARY_PATH variables
 548 <b><font color="#ff0000">before</font></b> starting Installation Wizard. Otherwise
 549 installation script will fail to find preinstalled products. </p>
 550 <p><b>Note:</b> For some native products (e.g. gcc, Python) the rules of version
 551 checking are not so strict as described in the table. Only major and minor numbers of version
 552 should coincide with prerequisite. Release number can be larger. It is done for making a possibility
 553 to use native products for newer versions of Red Hat (for example, Linux Red Hat 9 includes native
 554 gcc 3.2.2 installation).
 555 If native product has version number larger than that required by installation procedure,
 556 you will be prompted by the warning message like this: <i>"You have newer version of gcc installed
 557 on your computer than that is required (3.2). Continue?"</i>. You can press <i>"Yes"</i> button
 558 to procede with the installation but in this case you should be aware of what you are doing.
 559 SALOME binaries (inluding other products) are compiled with the prerequisites from the list
 560 and most likely can not be run successfully if this products are not found.
 561 This can be only helpful if you intend to build all products from sources.</p>
 562
 563 <h3>
 564 <hr></h3>
 565
 566 <h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
 567   Please, read carefully the following information. This section describes
 568  how the installation procedure collects environment.
 569 <p>After installing each product shell script creates in the product root
 570  folder special environment file. The name of the file is generated from
 571 the name of product by the following scheme: <b>env_&lt;product_name&gt;.sh.</b>
 572  This file includes all necessary product settings. For example for Vtk the
 573 file is <b>env_Vtk.sh</b>. Environment files allows to pick up all environment
 574 settings which are necessary to build and launch SALOME. When installing SALOME
 575 sources and/or binaries, installation procedure picks up all the settings
 576 files and generate two scripts: <b>salome.sh</b> and <b>salome.csh </b>for
 577  sh and csh correspondingly. Such approach helps to save time when reinstalling
 578  products and you may not to care about setting all environment variables
 579 manually to build/launch SALOME. What you need is just to use one of these
 580 scripts.  </p>
 581
 582 <p>This concerns also those products which are not currently installed. For
 583 example, you install some SALOME binaries to the directory where you have
 584 previously installed other products.&nbsp; Installation procedure still tries
 585 to collect environment files from the target directory if it find necessary
 586 products there. If some product is not found in the target directory the corresponding
 587 section of <b>salome.sh/salome.csh</b> files will be skipped.  <br>
 588   For native products (<i><b>gcc, tcl, python, qt, sip, pyqt </b>for RedHat-8.0<b>)</b></i>
 589 instal script tries to find them using <b>$PATH</b> / <b>$LD_LIBRARY_PATH</b>
 590 variables and then in the system default directories (<b>/usr/bin, /usr/lib</b>
 591 etc., depending on the product). </p>
 592
 593 <p>In any case you may edit <b>salome.*</b> files after installation procedure
 594  finishes, as you want. </p>
 595
 596 <hr>
 597 <h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font> configuration
 598  <font color="#ff0000">file</font></h3>
 599   <font color="#000000">You can create your own configuration. Installation
 600  Wizard then can take it as command line argument to provide list of products
 601  you want to install with it. The list of products and some another settings
 602  for the Installation Wizard are provided in xml file. The default file which
 603 Installation Wizard looks for if no command line arguments ar given, is <b>config.xml</b>.
 604 This section describes the format of configuration file.</font> <br>
 605   <font color="#000000">Xml tags are in bold blue, optional sections/tags
 606 are in brackets.</font>
 607 <p><b><font color="#000099">&lt;document&gt;</font></b> <br>
 608   <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[</font><b><font
 609  color="#000099">&lt;config</font></b><font color="#000000"> [version=&lt;install_wizard_version&gt;]</font>
 610  <br>
 611   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 612  [caption=&lt;install_wizard_caption&gt;]</font> <br>
 613   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 614  [copyright=&lt;install_wizard_copyright&gt;]</font> <br>
 615   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 616  [license=&lt;install_wizard_license_info&gt;]</font> <br>
 617   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 618  [os=&lt;target_platform&gt;]</font><b><font color="#000099">/&gt;</font></b><font
 619  color="#000000">]</font> <br>
 620   <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[</font><b><font
 621  color="#000099">&lt;path</font></b><font color="#000000"> [targetdir=&lt;target_directory&gt;]</font>
 622  <br>
 623   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 624  [tempdir=&lt;temp_directory&gt;]</font><b><font color="#000099">/&gt;</font></b><font
 625  color="#000000">]</font> <br>
 626   <font color="#000000">&nbsp;&nbsp;&nbsp; [</font><b><font
 627  color="#000099">&lt;product</font></b><font color="#000000"> name=&lt;product_name&gt;</font>
 628  <br>
 629   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 630  version=&lt;product_version&gt;</font> <br>
 631   &nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;
 632 &nbsp;&nbsp; &nbsp;&nbsp; [context=&lt;product_context&gt;]<br>
 633   &nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;
 634 &nbsp;&nbsp; &nbsp;&nbsp; [description=&lt;product_description&gt;]<br>
 635   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 636  install=&lt;installation_mode&gt;</font> <br>
 637   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 638  supported=&lt;supported_installation_modes&gt;</font> <br>
 639   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 640  disable=&lt;disable_flag&gt;<br>
 641 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
 642 [pickupenv=&lt;pickup_env_flag&gt;]</font><font color="#000000"><br>
 643 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 644 dependancies=&lt;list_of_prerequisites&gt;</font>&nbsp;<font
 645  color="#000000"><br>
 646 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 647  &nbsp;installdiskspace=&lt;install_disk_space&gt;</font>  <font
 648  color="#000000"><br>
 649 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 650 &nbsp;temporarydiskspace=&lt;tmp_disk_space&gt;</font>  <font
 651  color="#000000"><br>
 652 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 653 &nbsp;script=&lt;installation_script_name&gt;</font><font
 654  color="#000099">/<b>&gt;</b></font><font color="#000000">]</font>  <font
 655  color="#000000"><br>
 656 &nbsp;&nbsp;&nbsp; [</font><b><font color="#000099">&lt;product</font></b><font
 657  color="#000000"> ... </font><font color="#000099">/<b>&gt;</b></font><font
 658  color="#000000">]</font>  <font color="#000000"><br>
 659 &nbsp;&nbsp;&nbsp;<b> .</b></font><b><font color="#000099">..</font></b>
 660 <b><font color="#000099"><br>
 661 &lt;/document&gt;</font></b> </p>
 662
 663 <h4><font color="#000000">&lt;config&gt; section</font></h4>
 664   <font color="#000000">This is optional section - contains general information
 665  Installation Wizard itself.</font>
 666 <ul>
 667     <li> <font color="#000000"><b>version</b>: Installation Wizard's version
 668  number;</font></li>
 669     <li> <font color="#000000"><b>caption</b>: Installation Wizard's main
 670 window  title - if this string contains '%1' text - the title will contain
 671 in this  place version number (see above);</font></li>
 672     <li> <font color="#000000"><b>copyright</b>: Installation Wizard's copyright
 673  information (appears on the first page of program);</font></li>
 674     <li> <font color="#000000"><b>license</b>: Installation Wizard's license
 675  information (appears on the first page of program);</font></li>
 676     <li> <font color="#000000"><b>os</b>: Contains directory name (relative
 677  from ./Products/BINARIES) where Installation Wizard should search precompiled
 678  binaries packages. If this tag is skipped, binaries are implied to be in
 679 the ./Products/BINARIES directory.</font></li>
 680
 681 </ul>
 682
 683 <h4> <b><font color="#000000">&lt;path&gt; section</font></b></h4>
 684   This is optional section - contains default directories.
 685 <ul>
 686     <li> <font color="#000000"><b>targetdir</b>: Starting target directory
 687 - path to the directory where products should be installed;</font></li>
 688     <li> <font color="#000000"><b>tempdir</b>: Starting temp directory -
 689 path to the directory for the temporary files.</font></li>
 690
 691 </ul>
 692
 693 <h4> <b>&lt;product&gt; section</b></h4>
 694   This section describes product to be installed with the Installation Wizard.
 695  All tags are obligatory. Products appears in the products tree and are installed
 696 in the order they are described in the configuration file. It is recommended
 697 to insert native products at the top of the list before all other products.
 698
 699 <ul>
 700     <li> <font color="#000000"><b>name</b>: Name of the product;</font></li>
 701     <li> <font color="#000000"><b>version</b>: Version of the product;</font></li>
 702     <li> <font color="#000000"><b>description</b>: Description of the product (optional);</font></li>
 703     <li> <font color="#000000"><b>context</b>: Context of the product (optional); the possible values are <b>'salome sources'</b>,
 704          <b>'salome binaries'</b> and <b>'prerequisite'</b>;</font></li>
 705     <li> <font color="#000000"><b>supported</b>: Supported modes of installation,
 706  should contain one or more of the following options, separated by comma:
 707     <i>install sources</i>, <i>install binaries</i>, <i>use native</i>. Installation
 708  script should contain corresponding functions for each of supported installation
 709  modes;</font></li>
 710     <li> <font color="#000000"><b>install</b>: Default (starting) installation
 711 mode;</font></li>
 712     <li> <font color="#000000"><b>disable</b>: If this flag has 'true' value,
 713 corresponding product will not appear in the list of products tree and will
 714 not be installed;</font></li>
 715   <li><b>pickupenv</b>: This flag points that pickup environment procedure
 716 should be performed for this module. If this flag equal to <b>true</b>, &nbsp;salome.sh
 717 and salome.csh files will&nbsp; be created in the product's installation
 718 directory. This is optional key, default value is <b>false.</b><br>
 719   </li>
 720     <li> <font color="#000000"><b>dependancies</b>: list of prerequisite
 721 products,  which are necessary to build this product, separated by comma;</font></li>
 722     <li> <font color="#000000"><b>installdiskspace</b>: Total amount space
 723  (integer, in Kbytes), which product occupies on the hard drive after the
 724 installation;</font></li>
 725     <li> <font color="#000000"><b>temporarydiskspace</b>: Disk space (integer,
 726 in Kbytes) for the temporary files, which is necessary to build the product
 727  from the sources;</font></li>
 728     <li> <font color="#000000"><b>script</b>: Installation script name. This
 729  script is in charge of installation of the product. It is called when necessary
 730  from the main program. See <a href="#new_products">next section</a> for
 731 more information.</font></li>
 732
 733 </ul>
 734   <b>Note:</b> If you add new products to be installed with Installation
 735 Wizard, you should also provide installation script for this product. See
 736 next section for more details.
 737 <hr>
 738 <h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
 739  scripts</font> for the new products</h3>
 740   When you want some product to be installed with the Installation Wizard,
 741  you should add it's description it <a href="#xml_files">in the configuration
 742  file</a> and create bash installation script, following described in this
 743  section rules. <br>
 744   There are some obligatory functions to be provided in this installation
 745 script. These functions are automatically called by master installation script
 746 or/and GUI shell when it is necessary.<br>
 747 <font color="#000000">File <b>common.sh</b> contains some service functions
 748 which  can be used in your installation script, like <b>make_env()</b>,<b>
 749 make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b> find_in_path()</b>,
 750 etc.</font>
 751 <ul>
 752     <li> <b>check_version()</b>:&nbsp; This function allows to check the
 753 version  of the product already installed on the computer. It should try
 754 to find product (native or preinstalled in the target directory) and check
 755 it version. This helps to avoid unnecessary reinstallation. This is internal
 756 function and is not called</li>
 757     <li> <b><font color="#000000">try_native()</font></b><font
 758  color="#000099">: </font><font color="#000000">This function is called when
 759     <i>'use native' </i>installation mode is selected by the user. The function
 760 should try to find native version of the product and define possibility of
 761 it usage. Should create environment for the product in the temporary directory
 762 (see also description of <b>print_env(</b>) function). If you do not provide
 763 native mode installation, you can omit this function.</font></li>
 764     <li> <font color="#000000"><b>install_source()</b>: This function is
 765 called  when <i>'install sources</i>' installation mode is selected by the
 766 user. The function is responsible for the building of the product from the
 767 sources package. Should create environment for the product in the temporary
 768 directory (see also description of <b>print_env(</b>) function). If you do
 769 not provide sources mode installation, you can omit this function</font></li>
 770     <li> <font color="#000000"><b>install_binary()</b>: This function is
 771 called  when <i>'install binaries'</i> installation mode is selected by the
 772 user.  The function is responsible for the extracting of the product from
 773 the binaries package. Should create environment for the product in the temporary
 774 directory (see also description of <b>print_env(</b>) function). If you do
 775 not provide binaries mode installation, you can omit this function.</font></li>
 776     <li> <b>try_preinstalled()</b>: <font color="#000000">This function is
 777  called when<i> 'not install'</i> installation mode is selected by the user.
 778 In this case script should inspect target directory to try to find already
 779  preinstalled product, pick up and check environment from there. See <a
 780  href="#pick_up_env">here</a> for more details.</font></li>
 781     <li> <font color="#000000"><b>print_env()</b>: This function is in charge
 782 of creation environment script. It should create file with name </font><b>env_&lt;product_name&gt;.sh</b>
 783  in the temporary directory and then copy it into the product installation
 784  directory. The file should contain all necessary environment variables settings
 785 for the product. It will be collected during the 'pick-up-environment' procedure.</li>
 786   <li><b>pickup-env()</b>: This procedure corresponds <b>pickupenv</b> tag
 787 of the configuration xml file (see previous section). Should call <b>make_env</b>
 788 procedure to perform pick-up environment procedure for the product.<br>
 789   </li>
 790
 791 </ul>
 792   <font color="#000000">The calling signature of the product installation
 793 script is following:</font> <br>
 794   <b><font color="#000000">&lt;product_script_name&gt; &lt;function_name&gt;
 795  &lt;temp_folder&gt; &lt;products_directory&gt; &lt;target_directory&gt;
 796 &lt;dependancies&gt;  &lt;product_name&gt;</font></b>
 797 <p><font color="#000000">where</font> <br>
 798   <font color="#000000"><b>&lt;product_script_name&gt;</b> - installation
 799 script name (described in configuration xml file);</font> <br>
 800   <font color="#000000"><b>&lt;function_name&gt;</b> - the name of function,
 801  corresponding to the selected installation mode: <i>try_native, install_source,
 802  install_binary</i> or <i>try_preinstalled</i>;</font> <br>
 803   <font color="#000000"><b>&lt;temp_folder&gt;</b> - temporary files directory;</font>
 804  <br>
 805   <font color="#000000"><b>&lt;products_directory&gt;</b> - directory where
 806  the sources/binaries package can be found. You should provide sources package
 807  in the <i>&lt;Install_Wizard_root_directory&gt;/Products/SOURCES</i> directory
 808  and binaries package&nbsp; in the <i>&lt;InstallWizard_root_directory&gt;/Products/BINARIES/&lt;os_version&gt;</i>,
 809  where &lt;os_version&gt; is target platform description, which appears in
 810  the corresponding section of the <a href="#xml_files">configuration xml
 811 file</a>.</font>  <br>
 812   <font color="#000000"><b>&lt;target_directory&gt;</b> - root target directory
 813  where product should be installed to;</font> <br>
 814   <font color="#000000"><b>&lt;dependancies&gt;</b> - single-quoted list
 815 of prerequisite products, separated by space;</font> <br>
 816   <font color="#000000"><b>&lt;product_name&gt; </b>- product name itself.</font>
 817  </p>
 818
 819 <p><font color="#000000">Example:</font> <br>
 820   <i><font color="#000000">med-2.2.2.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0
 821  /usr/salome 'gcc Hdf' med</font></i> </p>
 822
 823 <p><font color="#000000">Copy created script into the <i>&lt;Install_Wizard_root_directory&gt;/config_files</i>
 824  sub-directory where all installation scripts are stored. Installation Wizard
 825 will automatically search and call your script during the installation procedure.</font>
 826 </p>
 827
 828 <hr> <br>
 829  <br>
 830 </body>
 831 </html>