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>PAL/SALOME v1.4.1 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">PAL/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="45" width="104">
  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 1.4.1</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 (currently it provides only configuration scripts for <i>RedHat-8.0</i>)
  99 and various number of products. <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 has 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 installed
 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 Linux Red Hat 8.0 products (these are gcc, tcl,
 149 Python, Qt, Sip and PyQt), select <i>"use native" </i>option. </p>
 150
 151 <p>The box at the right side of the page displays the information about currently
 152 highlighted product: name, version, short description (if provided), required
 153 disk space, temporary files disk space, list of prerequisites and user choice.
 154 </p>
 155
 156 <center><a name="ProductPage"></a><br>
 157   <img src="productpage.png" height="525" width="565" alt="">
 158
 159 <p><b>Figure 1:</b> "Installation settings" page in the advanced mode</p>
 160   </center>
 161
 162 <p>The <i>"Total disk space required:"</i> field displays how much disk space
 163 on the hard drive is required for installation of selected products. <br>
 164   <b>Note: </b>Please, take into account that displayed amount of required
 165  disk space is approximate and may differ when you install products on your
 166  hard drive. </p>
 167
 168 <p>Installation procedure uses a special directory to store temporary files.
 169  The <i>"Space for temporary files:"</i> field shows the information about
 170  required disk space on the hard drive for extracting and compiling of the
 171  selected products. You can change the default directory - just type path
 172 to the folder you want to use or click on the corresponding <i>"Browse..."</i>
 173  button. </p>
 174
 175 <p>The installation procedure also checks available disk space on the selected
 176  directories according to the products selected. If there is no enough disk
 177  space on your hard drive you will see the corresponding error message box.
 178  </p>
 179
 180 <p><b>Note: </b>Unfortunately, the configure procedure has a very annoying
 181  bug under Linux platform. The directory should be obligatory entered without
 182  spaces. For example, the configure procedure for <b><i>gcc</i></b> won't
 183 work if you pass the following parameter: <i>--prefix="/New Folder 1"</i>.
 184 <b>Therefore  you are strongly recommended not to use directory names containing
 185 spaces.</b>  </p>
 186
 187 <p>To proceed further click <i>"Next"</i> button. At this moment program
 188 will make some tests to check installation settings: if there is enough disk
 189 space on the hard drive, if native products are preinstalled, dependencies
 190 (prerequisites) for each product you have selected to be&nbsp; installed.
 191 If any test fails you will see corresponding warning message box. Otherwise
 192 wizard will follow to the next page: </p>
 193
 194 <center>
 195 <p><a name="ChoicePage"></a><br>
 196   <img src="choicepage.png" height="525" width="565" alt="">
 197  </p>
 198
 199 <p><b>Figure 2:</b> "Check your choice" page</p>
 200   </center>
 201
 202 <p>This page summarizes the installation settings you've made on the previous
 203  pages. You can check again your choice to change it if necessary. <br>
 204   When you are sure that everything is OK, press <i>"Next"</i> button to
 205 follow to the <a href="#ProgressPage">next page</a>. </p>
 206
 207 <center><a name="ProgressPage"></a><br>
 208   <img src="progresspage.png" height="525" width="565" alt="">
 209
 210 <p><b>Figure 3:</b> "Installation progress" page</p>
 211   </center>
 212
 213 <p>To start installation of the selected products click <i>"Start"</i> button.
 214 It launches the shell installation script and you will be able to see the
 215 output of the script in the topmost dialog's frame. In case of any installation
 216 problems (for example, you have accidentally removed the temporary directory)
 217 the script will ask you: <i>"Would you like to continue : (Y,N) ?"</i>. You
 218 can answer this question by typing [Y] or [N] in the middle text edit control
 219 frame. <br>
 220   <b>Note:</b> press [Enter] when you finish typing data. </p>
 221
 222 <p>The <i>"Installation Status"</i> frame window shows you the progress of
 223 installation. It contains a list of all selected products with brief descriptions.
 224 "<font color="#ff0000">Waiting</font>" description means that installation
 225 of this product have not started yet. Currently installing product is marked
 226 as "<font color="#ff9900">Processing</font>". All installed products have
 227 "<font color="#33ff33">Completed</font>" description. </p>
 228
 229 <p>You can abort installation and close the installation procedure using
 230 <i>"Cancel"</i>  button. It sends the signal "SIGTERM" to the shell script.
 231 The script has  a signal handler and will try to clear all temporary files.
 232 The process of removing temporary files can take some time, so the installation
 233 wizard will wait 3 seconds before closing. </p>
 234
 235 <p>At the end of installation (all selected products have been installed
 236 successfully) you can go back to the previous pages to start a new installation
 237 or click <i>"Next"</i> button to go the Readme page: </p>
 238
 239 <center>
 240 <p><a name="readmepage"></a><br>
 241   <img src="readmepage.png" height="525" width="565" alt="">
 242  </p>
 243
 244 <p><b>Figure 4:</b> "Finish installation" page</p>
 245   </center>
 246
 247 <p>In this page you can read important information about the Instalation
 248 Wizard itself and some hints: how to run and test SALOME or how to build
 249 SALOME from the sources. This is the contents of the README file which you
 250 can find in the root directory of the Installation Wizard. <br>
 251   You can also launch SALOME Desktop from this page by clicking <i>"Launch
 252  SALOME" </i>button. </p>
 253
 254 <p>During the process of installation the script creates some environment
 255  files to simplify procedure of launching SALOME. These shell scripts set
 256 all necessary environment variables for all products you have installed.
 257 To learn how installation scripts collects the environment, see&nbsp;<a
 258  href="#pick_up_env"> here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b>
 259 in the <span style="font-style: italic;"><span
 260  style="font-weight: bold;">KERNEL module</span></span><b><i> sources</i></b>
 261 and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL</span></span><b><i>
 262 module binaries</i></b> root directories and <b>env_products.csh</b> + <b>env_products.sh
 263  </b>in the target directory. </p>
 264
 265 <hr>
 266 <h3><a name="check_version_proc"></a>Notes on<font color="#ff0000"> check
 267 products version</font> procedure</h3>
 268   Unfortunately under Linux platform there is no exact algorithm to identify
 269  the product's version. The table below contains the information relating
 270 to checking preinstalled products for the Linux.RedHat 8.0 platform <br>
 271   &nbsp;
 272 <table border="1" width="100%" nosave="">
 273     <tbody>
 274       <tr nosave="">
 275         <th nosave="">
 276       <center><font size="+1">Product</font></center>
 277         </th>
 278         <th nosave="">
 279       <center><font size="+1">Algorithm of checking</font></center>
 280         </th>
 281         <th nosave="">
 282       <center><font size="+1">Preliminary steps before launching</font>
 283     <br>
 284         <font size="+1">of installation procedure</font></center>
 285         </th>
 286         <th nosave="">
 287       <center><font size="+1">Notes</font></center>
 288         </th>
 289       </tr>
 290       <tr>
 291         <td>gcc 3.2</td>
 292         <td>ver=`/usr/bin/gcc --version | grep 'gcc (GCC) .*' | cut -b 11-13`</td>
 293         <td>
 294       <center>-</center>
 295         </td>
 296         <td>ver should be equal 3.2 <br>
 297   It is recommended to use native gcc on Linux RedHat 8.0</td>
 298       </tr>
 299       <tr nosave="">
 300         <td>tcl 8.3</td>
 301         <td nosave="">existence of TCLHOME <br>
 302   existence of tclsh8.3 <br>
 303   existence of wish8.3 <br>
 304   existence of libtcl8.3.so <br>
 305   existence of libtk8.3.so <br>
 306   existence of libtclx8.3.so <br>
 307   existence of libtkx8.3.so</td>
 308         <td>set TCLHOME if you have preinstalled version of tcl. <br>
 309   set LD_LIBRARY_PATH on a directory where libs can be found.</td>
 310         <td>It is recommended to use native tcl on Linux RedHat 8.0</td>
 311       </tr>
 312       <tr>
 313        <td valign="top">boost 1.30.2<br>
 314        </td>
 315        <td valign="top">ver=`egrep 'BOOST_VERSION [0-9]+' ${BOOSTDIR}/boost/version.hpp
 316 | sed 's/.*BOOST_VERSION \([0-9]\+\)/\1/g'`<br>
 317        </td>
 318        <td valign="top">set BOOSTDIR if you have preinstalled version of
 319 boost<br>
 320        </td>
 321        <td valign="top">It is impossible to use native BOOST and to install
 322 BOOST from binaries.<br>
 323        </td>
 324      </tr>
 325      <tr>
 326         <td>Cascade 5.1.2<br>
 327         </td>
 328         <td>existence of CASROOT environment variable</td>
 329         <td>set CASROOT if you have preinstalled version of CASCADE</td>
 330         <td>Unfortunately we can't say anything exactly about CASCADE 5.1.2
 331 and we only check CASROOT environment variable. If you have problem with
 332 preinstalled  version of CASCADE reinstall it</td>
 333       </tr>
 334       <tr>
 335         <td>Python 2.2.1</td>
 336         <td>existence of PYTHONHOME <br>
 337   isPython=`which python` <br>
 338   ver=`python -V`</td>
 339         <td>set PYTHONHOME to root Python folder <br>
 340   set PATH on a directory where python can be found</td>
 341         <td>Python should exist and ver should be equal to 2.2.1 <br>
 342   It is recommended to use native Python on Linux RedHat 8.0</td>
 343       </tr>
 344       <tr>
 345         <td>Mesa 3.4.2</td>
 346         <td>existence of libGL.so.1.2.030402</td>
 347         <td>set LD_LIBRARY_PATH on a directory where libGL.so.1.2.030402
 348 can be found</td>
 349         <td>You have a possibility to build products (vtk &amp; qt) with
 350 Mesa drivers from the package supplied with this installation procedure or
 351 to use OpenGL drivers installed on your computer locally. This check procedure
 352  concerns only supplied Mesa driver.</td>
 353       </tr>
 354       <tr>
 355         <td>Swig 1.3.17</td>
 356         <td>isSwig=`which swig` <br>
 357   ver=`swig -version` <br>
 358   ver=`echo $ver | awk '{print $3}'`</td>
 359         <td>set PATH on a directory where swig can be found</td>
 360         <td>Swig should exist and ver should be equal to 1.3.17</td>
 361       </tr>
 362       <tr>
 363         <td>Qt 3.0.5</td>
 364         <td>existence of QTDIR <br>
 365   existence of libqt-mt.so.3.0.5</td>
 366         <td>set QTDIR if you have preinstalled version of qt</td>
 367         <td>We try to find libqt-mt.so.3.0.5 in ${QTDIR}/lib folder. <br>
 368   You should set MESA_HOME only if you have preinstalled version of Mesa
 369 3.4.2.       <br>
 370   It is recommended to use native Qt on Linux RedHat 8.0</td>
 371       </tr>
 372       <tr>
 373         <td>Qwt 0.4.1</td>
 374         <td>existence of QWTHOME <br>
 375   existence of libqwt.so.0.4.1</td>
 376         <td>set&nbsp; QWTHOME if you have preinstalled version of qwt</td>
 377         <td>We try to find libqwt.so.0.4.1 in the ${QWTHOME}/lib folder.&nbsp;</td>
 378       </tr>
 379       <tr>
 380         <td>Hdf 5-1.4.4</td>
 381         <td>existence of HDF5HOME <br>
 382   existence of libhdf5.so.0.0.0 <br>
 383   existence of libhdf5.settings</td>
 384         <td>set HDF5HOME if you have preinstalled version of hdf</td>
 385         <td>We try to find libhdf5.so.0.0.0 and libhdf5.settings in ${HDF5HOME}/lib
 386  folder. <br>
 387   File libhdf5.settings should contain the following entry: <br>
 388   HDF5 Version: 1.4.4</td>
 389       </tr>
 390       <tr>
 391         <td>Med 2.1.6</td>
 392         <td>existence of MED2HOME <br>
 393   existence of libmed.so.0.0.0</td>
 394         <td>set MED2HOME if you have preinstalled version of med</td>
 395         <td>Unfortunately we can't check version number. <br>
 396   We try to find libmed.so.0.0.0 in ${MED2HOME}/lib folder. <br>
 397   If you have problem with preinstalled version of med reinstall it.</td>
 398       </tr>
 399       <tr>
 400         <td>Vtk 4.2</td>
 401         <td>existence of VTKHOME <br>
 402   existence of libvtkCommon.so</td>
 403         <td>set VTKHOME if you have preinstalled version of vtk</td>
 404         <td>Unfortunately we can't check the version number. <br>
 405   We try to find libvtkCommon.so in ${VTKHOME}/lib/vtk folder. <br>
 406   If you have problem with preinstalled version of vtk reinstall it.</td>
 407       </tr>
 408       <tr>
 409        <td valign="top">Netgen 4.3<br>
 410        </td>
 411        <td valign="top">existence of NETGENROOT<br>
 412        </td>
 413        <td valign="top">set NETGENROOT if you have preinstalled version of
 414 Netgen.<br>
 415        </td>
 416        <td valign="top">Unfortunarely we can't find anything about netgen
 417 version.<br>
 418 We just check if NETGENROOT environment varible is set.<br>
 419        </td>
 420      </tr>
 421      <tr>
 422         <td>OmniORB 3.0.5, <br>
 423   OmniORBpy 1.5, <br>
 424   OmniNotify 1.2</td>
 425         <td>existence of OMNIORBDIR <br>
 426   existence of libomniORB3.so.0.5 <br>
 427   existence of _omnipymodule.so.0.5 <br>
 428   existence of libCOSNotify3.so.0.5 <br>
 429   existence of notifd <br>
 430   existence of THIS_IS_omniORB_3_0_5 <br>
 431   existence of THIS_IS_omniNotify_1_2 <br>
 432   existence of THIS_IS_OMNIORBPY_1_5</td>
 433         <td>set OMNIORBDIR if you have preinstalled version of omni</td>
 434         <td>We try to find libomniORB3.so.0.5, _omnipymodule.so.0.5 and libCOSNotify3.so.0.5
 435  in ${OMNIORBDIR}/lib/i586_linux_2.0_glibc2.1 folder. <br>
 436   We try to find notifd in ${OMNIORBDIR}/bin/i586_linux_2.0_glibc2.1 folder.
 437       <br>
 438   Additional checking - omni add special files THIS_IS_... <br>
 439   We try to find THIS_IS_omniORB_3_0_5 in ${OMNIORBDIR} folder. <br>
 440   We try to find THIS_IS_omniNotify_1_2 in ${OMNIORBDIR}/src/services/omniNotify.
 441       <br>
 442   We try to find THIS_IS_OMNIORBPY_1_5 in ${OMNIORBDIR}/src/lib/omniORBpy
 443 folder.</td>
 444       </tr>
 445       <tr>
 446         <td>Numeric 22.0</td>
 447         <td>existence of Numeric folder <br>
 448   existence of _numpy.so</td>
 449         <td>set PYTHONHOME if you have preinstalled version of python</td>
 450         <td>Unfortunately we can't check the version number. <br>
 451   We try to find Numeric folder in ${PYTHONHOME}/lib/python2.2/site-packages/Numeric
 452  folder. <br>
 453   If you have problem with preinstalled version of numeric 22.0 reinstall
 454 it.</td>
 455       </tr>
 456       <tr>
 457         <td>Sip 3.3.2</td>
 458         <td>existence of SIPDIR <br>
 459   existence of sip <br>
 460   existence of libsip.so.9.1.0</td>
 461         <td>set SIPDIR to directory where you have sip preinstalled</td>
 462         <td>We try to find sip and libsip.so.9.1.0 in $SIPDIR folder if you
 463 set SIPDIR , otherwise searching is done using $PATH and $LD_LIBRARY_PATH
 464  accordingly. <br>
 465   It is recommended to use native Sip on Linux RedHat 8.0</td>
 466       </tr>
 467       <tr>
 468         <td>PyQt 3.3.2</td>
 469         <td>existence of PYQTDIR <br>
 470   existence of libqtxmlcmodule.so.1.0.0</td>
 471         <td>set PYQTDIR to directory where you have sip preinstalled</td>
 472         <td>Unfortunately we can't check the version number. <br>
 473   We try to find libqtxmlcmodule.so.1.0.0 in $PYQTDIR folder if you set PYQTDIR,
 474 otherwise searching is done using $LD_LIBRARY_PATH . <br>
 475   If you have problem with preinstalled version of PyQt 3.3.2 reinstall it.
 476       <br>
 477   It is recommended to use native PyQt on Linux RedHat 8.0</td>
 478       </tr>
 479       <tr>
 480         <td>HappyDoc 2.1</td>
 481         <td>existence of happydoc <br>
 482   ver=`happydoc | grep "HappyDoc version 2.1"`</td>
 483         <td>set PYTHONHOME if you have preinstalled version of python</td>
 484         <td>We try to find happydoc in $PYTHONHOME/bin folder. <br>
 485   ver should not be empty. <br>
 486   This product is not obligatory. It was added only for your comfort.</td>
 487       </tr>
 488       <tr>
 489         <td>Doxygen 1.3-rc2</td>
 490         <td>existence of doxygen <br>
 491   existence of doxysearch <br>
 492   existence of doxytag <br>
 493   existence of doxywizard</td>
 494         <td>set QTDIR if you have preinstalled version of qt <br>
 495   set PATH on a directory where doxygen, doxysearch, doxytag and doxywizard
 496  can be found</td>
 497         <td>Unfortunately we can't check the version number. <br>
 498   It's necessary to have compiled Qt in order to build doxywizard. <br>
 499   If you have problem with preinstalled version of doxygen 1.3-rc2 reinstall
 500  it. <br>
 501   This product is not obligatory. It was added only for your comfort.</td>
 502       </tr>
 503       <tr>
 504         <td>Graphviz 1.9</td>
 505         <td>existence of dot</td>
 506         <td>add GraphViz's bin directory to the PATH environment variable</td>
 507         <td>Unfortunately we can't check the version number. <br>
 508   We try to find dot program in the $PATH</td>
 509       </tr>
 510       <tr>
 511         <td>MODULE binaries<br>
 512   (MODULE=KERNEL,GEOM, ...)<br>
 513         </td>
 514         <td>existence of MODULE_ROOT_DIR <br>
 515   existence of VERSION file <br>
 516   ver=`cat $MODULE_ROOT_DIR/bin/salome/VERSION | awk -F: '{print $2}' | tr
 517 -d '[:space:]'`</td>
 518         <td>set MODULE_ROOT_DIR if you have preinstalled binaries of MODULE
 519  version 1.4.x</td>
 520         <td>MODULE binaries should exist and ver should be equal to 1.4.x</td>
 521       </tr>
 522       <tr>
 523         <td>MODULE sources<br>
 524   (MODULE=KERNEL,GEOM, ...)<br>
 525         </td>
 526         <td>existence of MODULE_SRC_DIR <br>
 527   existence of VERSION file <br>
 528   ver=`cat $MODULE_SRC/bin/VERSION | awk -F: '{print $2}' | tr -d '[:space:]'`</td>
 529         <td>set MODULE_SRC_DIR if you have preinstalled sources of MODULE
 530 version  1.4.x</td>
 531         <td>MODULE sources should exist and ver should be equal to 1.4.x</td>
 532       </tr>
 533
 534   </tbody>
 535 </table>
 536
 537 <p>Note: For native products installation procedure sets proper environment
 538  variables itself, and you do not need to set such variables like, e.g. <b>TCLHOME</b>
 539  or <b>PYTHONHOME</b>. <br>
 540   If you have native products installed to different from default directories
 541  (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is recommended to follow above
 542 description. Or you should set properly $PATH and $LD_LIBRARY_PATH variables
 543 <b><font color="#ff0000">before</font></b> starting Installation Wizard. Otherwise
 544 installation script will fail to find preinstalled products. </p>
 545
 546 <h3>
 547 <hr></h3>
 548
 549 <h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
 550   Please, read carefully the following information. This section describes
 551  how the installation procedure collects environment.
 552 <p>After installing each product shell script creates in the product root
 553  folder special environment file. The name of the file is generated from
 554 the name of product by the following scheme: <b>env_&lt;product_name&gt;.sh.</b>
 555  This file includes all necessary product settings. For example for Vtk the
 556 file is <b>env_Vtk.sh</b>. Environment files allows to pick up all environment
 557 settings which are necessary to build and launch SALOME. When installing SALOME
 558 sources and/or binaries, installation procedure picks up all the settings
 559 files and generate two scripts: <b>salome.sh</b> and <b>salome.csh </b>for
 560  sh and csh correspondingly. Such approach helps to save time when reinstalling
 561  products and you may not to care about setting all environment variables
 562 manually to build/launch SALOME. What you need is just to use one of these
 563 scripts.  </p>
 564
 565 <p>This concerns also those products which are not currently installed. For
 566 example, you install some SALOME binaries to the directory where you have
 567 previously installed other products.&nbsp; Installation procedure still tries
 568 to collect environment files from the target directory if it find necessary
 569 products there. If some product is not found in the target directory the corresponding
 570 section of <b>salome.sh/salome.csh</b> files will be skipped.  <br>
 571   For native products (<i><b>gcc, tcl, python, qt, sip, pyqt </b>for RedHat-8.0<b>)</b></i>
 572 instal script tries to find them using <b>$PATH</b> / <b>$LD_LIBRARY_PATH</b>
 573 variables and then in the system default directories (<b>/usr/bin, /usr/lib</b>
 574 etc., depending on the product). </p>
 575
 576 <p>In any case you may edit <b>salome.*</b> files after installation procedure
 577  finishes, as you want. </p>
 578
 579 <hr>
 580 <h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font> configuration
 581  <font color="#ff0000">file</font></h3>
 582   <font color="#000000">You can create your own configuration. Installation
 583  Wizard then can take it as command line argument to provide list of products
 584  you want to install with it. The list of products and some another settings
 585  for the Installation Wizard are provided in xml file. The default file which
 586 Installation Wizard looks for if no command line arguments ar given, is <b>config.xml</b>.
 587 This section describes the format of configuration file.</font> <br>
 588   <font color="#000000">Xml tags are in bold blue, optional sections/tags
 589 are in brackets.</font>
 590 <p><b><font color="#000099">&lt;document&gt;</font></b> <br>
 591   <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[</font><b><font
 592  color="#000099">&lt;config</font></b><font color="#000000"> [version=&lt;install_wizard_version&gt;]</font>
 593  <br>
 594   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 595  [caption=&lt;install_wizard_caption&gt;]</font> <br>
 596   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 597  [copyright=&lt;install_wizard_copyright&gt;]</font> <br>
 598   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 599  [license=&lt;install_wizard_license_info&gt;]</font> <br>
 600   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 601  [os=&lt;target_paltform&gt;]</font><b><font color="#000099">/&gt;</font></b><font
 602  color="#000000">]</font> <br>
 603   <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[</font><b><font
 604  color="#000099">&lt;path</font></b><font color="#000000"> [targetdir=&lt;target_directory&gt;]</font>
 605  <br>
 606   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 607  [tempdir=&lt;temp_directory&gt;]</font><b><font color="#000099">/&gt;</font></b><font
 608  color="#000000">]</font> <br>
 609   <font color="#000000">&nbsp;&nbsp;&nbsp; [</font><b><font
 610  color="#000099">&lt;product</font></b><font color="#000000"> name=&lt;product_name&gt;</font>
 611  <br>
 612   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 613  version=&lt;product_version&gt;</font> <br>
 614   &nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;
 615 &nbsp;&nbsp; &nbsp;&nbsp; [description=&lt;product_description&gt;]<br>
 616   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 617  install=&lt;installation_mode&gt;</font> <br>
 618   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 619  supported=&lt;supported_installation_modes&gt;</font> <br>
 620   <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 621  disable=&lt;disable_flag&gt;<br>
 622 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
 623 [pickupenv=&lt;pickup_env_flag&gt;]</font><font color="#000000"><br>
 624 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 625 dependancies=&lt;list_of_prerequisites&gt;</font>&nbsp;<font
 626  color="#000000"><br>
 627 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 628  &nbsp;installdiskspace=&lt;install_disk_space&gt;</font>  <font
 629  color="#000000"><br>
 630 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 631 &nbsp;temporarydiskspace=&lt;tmp_disk_space&gt;</font>  <font
 632  color="#000000"><br>
 633 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 634 &nbsp;script=&lt;installation_script_name&gt;</font><font
 635  color="#000099">/<b>&gt;</b></font><font color="#000000">]</font>  <font
 636  color="#000000"><br>
 637 &nbsp;&nbsp;&nbsp; [</font><b><font color="#000099">&lt;product</font></b><font
 638  color="#000000"> ... </font><font color="#000099">/<b>&gt;</b></font><font
 639  color="#000000">]</font>  <font color="#000000"><br>
 640 &nbsp;&nbsp;&nbsp;<b> .</b></font><b><font color="#000099">..</font></b>
 641 <b><font color="#000099"><br>
 642 &lt;/document&gt;</font></b> </p>
 643
 644 <h4><font color="#000000">&lt;config&gt; section</font></h4>
 645   <font color="#000000">This is optional section - contains general information
 646  Installation Wizard itself.</font>
 647 <ul>
 648     <li> <font color="#000000"><b>version</b>: Installation Wizard's version
 649  number;</font></li>
 650     <li> <font color="#000000"><b>caption</b>: Installation Wizard's main
 651 window  title - if this string contains '%1' text - the title will contain
 652 in this  place version number (see above);</font></li>
 653     <li> <font color="#000000"><b>copyright</b>: Installation Wizard's copyright
 654  information (appears on the first page of program);</font></li>
 655     <li> <font color="#000000"><b>license</b>: Installation Wizard's license
 656  information (appears on the first page of program);</font></li>
 657     <li> <font color="#000000"><b>os</b>: Contains directory name (relative
 658  from ./Products/BINARIES) where Installation Wizard should search precompiled
 659  binaries packages. If this tag is skipped, binaries are implied to be in
 660 the ./Products/BINARIES directory.</font></li>
 661
 662 </ul>
 663
 664 <h4> <b><font color="#000000">&lt;path&gt; section</font></b></h4>
 665   This is optional section - contains default directories.
 666 <ul>
 667     <li> <font color="#000000"><b>targetdir</b>: Starting target directory
 668 - path to the directory where products should be installed;</font></li>
 669     <li> <font color="#000000"><b>tempdir</b>: Starting temp directory -
 670 path to the directory for the temporary files.</font></li>
 671
 672 </ul>
 673
 674 <h4> <b>&lt;product&gt; section</b></h4>
 675   This section describes product to be installed with the Installation Wizard.
 676  All tags are obligatory. Products appears in the products tree and are installed
 677 in the order they are described in the configuration file. It is recommended
 678 to insert native products at the top of the list before all other products.
 679
 680 <ul>
 681     <li> <font color="#000000"><b>name</b>: Name of the product;</font></li>
 682     <li> <font color="#000000"><b>version</b>: Version of the product;</font></li>
 683     <li><font color="#000000"><span style="font-weight: bold;">description</span>:
 684  Description of the product (optional);<br>
 685       </font></li>
 686     <li> <font color="#000000"><b>supported</b>: Supported modes of installation,
 687  should contain one or more of the following options, separated by comma:
 688     <i>install sources</i>, <i>install binaries</i>, <i>use native</i>. Installation
 689  script should contain corresponding functions for each of supported installation
 690  modes;</font></li>
 691     <li> <font color="#000000"><b>install</b>: Default (starting) installation
 692 mode;</font></li>
 693     <li> <font color="#000000"><b>disable</b>: If this flag has 'true' value,
 694 corresponding product will not appear in the list of products tree and will
 695 not be installed;</font></li>
 696   <li><b>pickupenv</b>: This flag points that pickup environment procedure
 697 should be performed for this module. If this flag equal to <b>true</b>, &nbsp;salome.sh
 698 and salome.csh files will&nbsp; be created in the product's installation
 699 directory. This is optional key, default value is <b>false.</b><br>
 700   </li>
 701     <li> <font color="#000000"><b>dependancies</b>: list of prerequisite
 702 products,  which are necessary to build this product, separated by comma;</font></li>
 703     <li> <font color="#000000"><b>installdiskspace</b>: Total amount space
 704  (integer, in Kbytes), which product occupies on the hard drive after the
 705 installation;</font></li>
 706     <li> <font color="#000000"><b>temporarydiskspace</b>: Disk space (integer,
 707 in Kbytes) for the temporary files, which is necessary to build the product
 708  from the sources;</font></li>
 709     <li> <font color="#000000"><b>script</b>: Installation script name. This
 710  script is in charge of installation of the product. It is called when necessary
 711  from the main program. See <a href="#new_products">next section</a> for
 712 more information.</font></li>
 713
 714 </ul>
 715   <b>Note:</b> If you add new products to be installed with Installation
 716 Wizard, you should also provide installation script for this product. See
 717 next section for more details.
 718 <hr>
 719 <h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
 720  scripts</font> for the new products</h3>
 721   When you want some product to be installed with the Installation Wizard,
 722  you should add it's description it <a href="#xml_files">in the configuration
 723  file</a> and create bash installation script, following described in this
 724  section rules. <br>
 725   There are some obligatory functions to be provided in this installation
 726 script. These functions are automatically called by master installation script
 727 or/and GUI shell when it is necessary.<br>
 728 <font color="#000000">File <b>common.sh</b> contains some service functions
 729 which  can be used in your installation script, like <b>make_env()</b>,<b>
 730 make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b> find_in_path()</b>,
 731 etc.</font>
 732 <ul>
 733     <li> <b>check_version()</b>:&nbsp; This function allows to check the
 734 version  of the product already installed on the computer. It should try
 735 to find product (native or preinstalled in the target directory) and check
 736 it version. This helps to avoid unnecessary reinstallation. This is internal
 737 function and is not called</li>
 738     <li> <b><font color="#000000">try_native()</font></b><font
 739  color="#000099">: </font><font color="#000000">This function is called when
 740     <i>'use native' </i>installation mode is selected by the user. The function
 741 should try to find native version of the product and define possibility of
 742 it usage. Should create environment for the product in the temporary directory
 743 (see also description of <b>print_env(</b>) function). If you do not provide
 744 native mode installation, you can omit this function.</font></li>
 745     <li> <font color="#000000"><b>install_source()</b>: This function is
 746 called  when <i>'install sources</i>' installation mode is selected by the
 747 user. The function is responsible for the building of the product from the
 748 sources package. Should create environment for the product in the temporary
 749 directory (see also description of <b>print_env(</b>) function). If you do
 750 not provide sources mode installation, you can omit this function</font></li>
 751     <li> <font color="#000000"><b>install_binary()</b>: This function is
 752 called  when <i>'install binaries'</i> installation mode is selected by the
 753 user.  The function is responsible for the extracting of the product from
 754 the binaries package. Should create environment for the product in the temporary
 755 directory (see also description of <b>print_env(</b>) function). If you do
 756 not provide binaries mode installation, you can omit this function.</font></li>
 757     <li> <b>try_preinstalled()</b>: <font color="#000000">This function is
 758  called when<i> 'not install'</i> installation mode is selected by the user.
 759 In this case script should inspect target directory to try to find already
 760  preinstalled product, pick up and check environment from there. See <a
 761  href="#pick_up_env">here</a> for more details.</font></li>
 762     <li> <font color="#000000"><b>print_env()</b>: This function is in charge
 763 of creation environment script. It should create file with name </font><b>env_&lt;product_name&gt;.sh</b>
 764  in the temporary directory and then copy it into the product installation
 765  directory. The file should contain all necessary environment variables settings
 766 for the product. It will be collected during the 'pick-up-environment' procedure.</li>
 767   <li><b>pickup-env()</b>: This procedure corresponds <b>pickupenv</b> tag
 768 of the configuration xml file (see previous section). Should call <b>make_env</b>
 769 procedure to perform pick-up environment procedure for the product.<br>
 770   </li>
 771
 772 </ul>
 773   <font color="#000000">The calling signature of the product installation
 774 script is following:</font> <br>
 775   <b><font color="#000000">&lt;product_script_name&gt; &lt;function_name&gt;
 776  &lt;temp_folder&gt; &lt;products_directory&gt; &lt;target_directory&gt;
 777 &lt;dependancies&gt;  &lt;product_name&gt;</font></b>
 778 <p><font color="#000000">where</font> <br>
 779   <font color="#000000"><b>&lt;product_script_name&gt;</b> - installation
 780 script name (described in configuration xml file);</font> <br>
 781   <font color="#000000"><b>&lt;function_name&gt;</b> - the name of function,
 782  corresponding to the selected installation mode: <i>try_native, install_source,
 783  install_binary</i> or <i>try_preinstalled</i>;</font> <br>
 784   <font color="#000000"><b>&lt;temp_folder&gt;</b> - temporary files directory;</font>
 785  <br>
 786   <font color="#000000"><b>&lt;products_directory&gt;</b> - directory where
 787  the sources/binaries package can be found. You should provide sources package
 788  in the <i>&lt;Install_Wizard_root_directory&gt;/Products/SOURCES</i> directory
 789  and binaries package&nbsp; in the <i>&lt;InstallWizard_root_directory&gt;/Products/BINARIES/&lt;os_version&gt;</i>,
 790  where &lt;os_version&gt; is target platform description, which appears in
 791  the corresponding section of the <a href="#xml_files">configuration xml
 792 file</a>.</font>  <br>
 793   <font color="#000000"><b>&lt;target_directory&gt;</b> - root target directory
 794  where product should be installed to;</font> <br>
 795   <font color="#000000"><b>&lt;dependancies&gt;</b> - single-quoted list
 796 of prerequisite products, separated by space;</font> <br>
 797   <font color="#000000"><b>&lt;product_name&gt; </b>- product name itself.</font>
 798  </p>
 799
 800 <p><font color="#000000">Example:</font> <br>
 801   <i><font color="#000000">med-2.1.6.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0
 802  /usr/salome 'gcc Hdf' med</font></i> </p>
 803
 804 <p><font color="#000000">Copy created script into the <i>&lt;Install_Wizard_root_directory&gt;/config_files</i>
 805  sub-directory where all installation scripts are stored. Installation Wizard
 806 will automatically search and call your script during the installation procedure.</font>
 807 </p>
 808
 809 <hr> <br>
 810  <br>
 811 </body>
 812 </html>