doc/readme.html

   1 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type"
   5  content="text/html; charset=iso-8859-1">
   6   <meta name="GENERATOR"
   7  content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">
   8   <meta name="Author"
   9  content="Vadim SANDLER (v-sandler@opencascade.com)">
  10   <title>SALOME 3 Installation Wizard Help</title>
  11   <meta content="Vadim SANDLER" name="author">
  12 </head>
  13 <body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 229);"
  14  alink="#ff0000" link="#0000ee" vlink="#551a8b">
  15 &nbsp;
  16 <center>
  17 <table nosave="" width="100%">
  18   <tbody>
  19     <tr nosave="">
  20       <td nosave="">
  21       <h1><a href="http://www.opencascade.com"><img src="logocorp.png"
  22  border="0" height="47" width="139"> </a></h1>
  23       </td>
  24       <td>
  25       <center>
  26       <h1><font size="+4"><font color="#000099">SALOME Installation
  27 Wizard Help</font>&nbsp;</font></h1>
  28       </center>
  29       </td>
  30       <td>
  31       <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
  32  src="application.png" border="0" height="47" width="109"> </a></div>
  33       </td>
  34     </tr>
  35   </tbody>
  36 </table>
  37 </center>
  38 <div align="right"><b><font color="#000099">updated for the version </font><font
  39  color="#ff0000">3.1.0a2</font></b></div>
  40 <hr>
  41 <ul>
  42   <li> <a href="#install_from_wizard">Installing products with the
  43 Installation Wizard</a></li>
  44   <li> <a href="#check_version_proc">Notes on check products version
  45 procedure</a></li>
  46   <li> <a href="#pick_up_env">Pick up the environment</a></li>
  47   <li> <a href="#xml_files">Modifying XML configuration file</a></li>
  48   <li> <a href="#new_products">Implementing installation scripts for
  49 the new products</a></li>
  50 </ul>
  51 <h3>
  52 <hr></h3>
  53 <h3> <a name="install_from_wizard"></a>Installing products with the <font
  54  color="#ff0000">Installation Wizard</font></h3>
  55 The Installation Wizard can be launched in two modes: gui and batch. <br>
  56 The root directory of the Installation Wizard
  57 contains python script <span style="font-weight: bold;">runInstall</span>.
  58 To run the Installation Wizard just type <b>runInstall</b> in terminal
  59 window:<br>
  60 <p><b>[ python ] runInstall [ -g | -b ] [ -f &lt;xml-file&gt; ] [ -t
  61 &lt;target-dir&gt; ] [ -tmp &lt;tmp-dir&gt; ]</b> </p>
  62 <p><b>-g</b><br>
  63 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Runs the Installation Wizard in the
  64 GUI
  65 mode (default option). In this case only<span style="font-weight: bold;">
  66 &lt;xml-file&gt;</span> key is taken into account.
  67 Other parameters are ignored. <br>
  68 <b>-b</b><br>
  69 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Runs the Installation Wizard in
  70 command-line mode. <br>
  71 <b>-f &lt;xml-file&gt;</b><br>
  72 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;The configuration file to be used by
  73 the
  74 Installation Wizard.&nbsp; If this parameter is missed then the script
  75 tries
  76 to define the <i>Linux </i>version and uses corresponding xml file.
  77 For
  78 examle, for the <i>Linux Mandrake 10.1</i> <b>config_Mandrake_10.1.xml</b>&nbsp;
  79 file
  80 is supposed to be used by default. If the appropriate file is not
  81 found, <b>config.xml</b>
  82 is used by default.&nbsp; This file refers to the basic target platform
  83 which is Mandrake 10.1 for SALOME 3.0 and higher. If config.xml file is
  84 also not found the warning message box is shown and Installation Wizard
  85 quits.<br>
  86 <b>-t &lt;target-dir&gt;</b><br>
  87 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;The target directory, SALOME platform
  88 to
  89 be installed to. If used, overloads default target directory, given in
  90 the
  91 configuration
  92 xml file (usually <span style="font-weight: bold;">/salome</span>, see
  93 <a href="#xml_files">here</a>). <br>
  94 <b>-tmp &lt;tmp-dir&gt;</b><br>
  95 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;The directory, which is used to
  96 contain temporary files.&nbsp; If used, overloads default temporary
  97 directory,
  98 given in the
  99 configuration xml file (usually <span style="font-weight: bold;">/tmp</span><span
 100  style="font-weight: bold;"></span>, see <a
 101  href="readme.html#xml_files">here</a>).<br>
 102 <b>-h</b><br>
 103 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Prints help information. <br>
 104 </p>
 105 <p>The installation procedure can support some different Linux
 106 platforms
 107 and various number of products. As it was mentioned above the basic
 108 target platform for SALOME 3.0 and higher is <i>Linux Mandrake 10.1</i>.<br>
 109 The using of configuration xml files gives flexible way to modify the
 110 list of products to be installed by the Installation Wizard without
 111 changing program's source code. Just create your own configuration file
 112 and implement installation scripts for products you want to be provided
 113 by Wizard. See <a href="#xml_files">modifying XML configuration file</a>
 114 and <a href="#new_products">implementing installation scripts for the
 115 new products</a> for more information. </p>
 116 <p>The <font color="#ff0000">Installation Wizard</font> was built with
 117 using of the <span style="font-style: italic;">Trolltech's</span> <b><i>Qt&nbsp;
 118 3.3.3 </i></b>library. The program contains
 119 several pages. To navigate between pages use <i>"Next"</i> and <i>"Back"</i>
 120 buttons in the
 121 lower part of the wizard window. <i>"Cancel"</i> button closes dialog
 122 window
 123 and quits the installation procedure. To invoke this help information
 124 click
 125 <i>"Help"</i> button. </p>
 126 <p>Skip the first <i>"Introduction"</i> page by pressing <i>"Next"</i>
 127 button:
 128 </p>
 129 <center><a name="IntroPage"></a><br>
 130 <img alt="Intro page" src="intropage.png"
 131  style="width: 586px; height: 347px;">
 132 <p><b>Figure 1:</b> "Introduction" page</p>
 133 </center>
 134 <p>In the second page you are proposed to enter the target directory
 135 where all selected products should be installed to. You can also press <i>"Browse..."</i>
 136 button and choose the folder for installation using standard <b><i>Qt</i></b>'s
 137 browse directory dialog box. <br>
 138 If the directory you want to install products does not exist you will
 139 be prompted to confirm directory creation. If you type wrong directory
 140 path, or if you have no permission for the directory you use, the
 141 corresponding message box will raise. </p>
 142 <p>The Installation Wizard has two modes of the installation: basic
 143 (default) and
 144 advanced. In the basic mode it is necessary just to enter target
 145 directory. If you want
 146 to use advanced mode, click <i>"More..."</i> button. </p>
 147 <p>In the advanced mode you have the possibility to select products to
 148 be installed (see <a href="#ProductPage">Fig.2</a> ). Each product can
 149 have several options of installation: you have a possibility to use
 150 native products, install already precompiled binaries, build product
 151 from the sources or not install it at all. Possible options and default
 152 choice are provided by the configuration file. You can mark the
 153 products you want to install by clicking the corresponding
 154 radiobuttons in the list view in the left part of the page. Note that
 155 some products can be installed only together with other products (or
 156 these prerequisite products should be already installed on your
 157 computer). The installation procedure
 158 has a special feature to automatically mark these products in the list
 159 view.
 160 For example, in order to install <b><i>PyQt</i></b> it's necessary to
 161 have
 162 <b><i>gcc, Python</i></b>,<b><i> Qt</i></b> and <b><i>Sip</i></b>
 163 installed.
 164 Therefore all these products will be marked when you check on <b><i>PyQt</i></b>.
 165 This feature can be switched off by clicking <i>"Auto set
 166 prerequisites products"</i> checkbox. <br>
 167 Special button in the right part of the page - <i>"Unselect All" </i>-
 168 allows to reset quickly all products to the <i>"not install"</i>
 169 state. <br>
 170 If you want to use native products (like <span
 171  style="font-weight: bold;">gcc</span>, <span
 172  style="font-weight: bold;">tcl</span>, etc.), select <i>"use native" </i>option.
 173 </p>
 174 <p>There are also two checkboxes on this page: <i>"SALOME sources"</i>
 175 and <i>"SALOME binaries"</i>.
 176 These three-state checkboxes allow quick selecting/unselecting SALOME
 177 itself packages
 178 for the installation.</p>
 179 <p>The box at the right side of the page displays the information about
 180 currently highlighted product: name, version, short description (if
 181 provided in XML file), required
 182 disk space, disk space required for temporary files, list of
 183 prerequisites and current user
 184 choice.
 185 </p>
 186 <center><a name="ProductPage"></a><br>
 187 <img src="productpage.png" alt="Products page"
 188  style="width: 586px; height: 544px;">
 189 <p><b>Figure 2:</b> "Installation settings" page in the advanced mode</p>
 190 </center>
 191 <p>The <i>"Total disk space required:"</i> field displays how much
 192 disk space on the hard drive is required for installation of selected
 193 products. <br>
 194 <b>Note: </b>Please, take into account that displayed amount of
 195 required disk space is approximate and may differ when you install
 196 products on your hard drive. </p>
 197 <p>The installation procedure uses a special directory to store
 198 temporary files. The <i>"Space for temporary files:"</i> field shows
 199 the information about required disk space on the hard drive for
 200 extracting and compiling of the selected products. You can change the
 201 default directory - just type path
 202 to the folder you want to use or click on the corresponding <i>"Browse..."</i>
 203 button. <br>
 204 <span style="font-weight: bold;">Note:</span> actually temporary files
 205 are stored not in the directory entered by user. The Installation
 206 Wizard creates in this directory an additional one folder named
 207 something like INSTALLWORK<span style="font-weight: bold;">XXXXX</span>
 208 where XXXXX is unique number. This allows to launch several
 209 Installation Wizards simultaneously. This temporary directory is
 210 removed automaticaly when the installation finishes.<br>
 211 </p>
 212 <p>The installation procedure also checks available disk space on the
 213 selected directories according to the products selected. If there is no
 214 enough disk space on your hard drive you will see the corresponding
 215 error message box. </p>
 216 <p><b>Note: </b>Unfortunately, the configure procedure has a very
 217 annoying bug under Linux platform. The directory should be obligatory
 218 entered without spaces. For example, the configure procedure for <b><i>gcc</i></b>
 219 won't
 220 work if you pass the following parameter: <i>--prefix="/New Folder 1"</i>.
 221 <b>Therefore you are strongly recommended not to use directory names
 222 containing
 223 spaces.</b> </p>
 224 <p>To proceed further click <i>"Next"</i> button. At this moment
 225 program
 226 will make some tests to check installation settings: if there is enough
 227 disk
 228 space on the hard drive, if native products are preinstalled,
 229 dependencies
 230 (prerequisites) for each product you have selected to be
 231 installed.
 232 If any test fails you will see the corresponding warning message box.
 233 Otherwise
 234 wizard will follow to the next page: </p>
 235 <center>
 236 <p><a name="ChoicePage"></a><br>
 237 <img src="choicepage.png" alt="Choice page"
 238  style="width: 586px; height: 544px;"> </p>
 239 <p><b>Figure 3:</b> "Check your choice" page</p>
 240 </center>
 241 <p>This page summarizes the installation settings you've made on the
 242 previous pages. You can check again your choice to change it if
 243 necessary. <br>
 244 When you are sure that everything is OK, press <i>"Next"</i> button to
 245 follow to the <a href="#ProgressPage">next page</a>. </p>
 246 <center><a name="ProgressPage"></a><br>
 247 <img src="progresspage.png" alt="Progress page"
 248  style="width: 586px; height: 544px;">
 249 <p><b>Figure 4:</b> "Installation progress" page</p>
 250 </center>
 251 <p>To start installation of the selected products click <i>"Start"</i>
 252 button. It launches the shell installation script and you will be able
 253 to see the output of the script in the topmost dialog's frame. If any errors
 254 occur during the installation the progress the corresponding messages
 255 will be printed to the log grame window in the bold red font.
 256
 257 <p>The <i>"Installation Status"</i> frame window shows you the
 258 progress of installation. It contains a list of all selected products
 259 with brief descriptions. "<font color="#ff0000">Waiting</font>"
 260 description means that installation of this product have not started
 261 yet. Currently installing product is marked as "<font color="#ff9900">Processing</font>".
 262 All installed products have "<font color="#33ff33">Completed</font>"
 263 description. </p>
 264 <p>You can abort installation and close the installation procedure
 265 using
 266 <i>"Cancel"</i> button. It sends the signal "SIGTERM" to the shell
 267 script.
 268 The script has a signal handler and will try to clear all temporary
 269 files.
 270 The process of removing temporary files can take some time, so the
 271 installation
 272 wizard will wait 3 seconds before closing. </p>
 273 <p>At the end of installation (all selected products have been
 274 installed
 275 successfully) you can go back to the previous pages to start a new
 276 installation
 277 or click <i>"Next"</i> button to go the Readme page: </p>
 278 <center>
 279 <p><a name="readmepage"></a><br>
 280 <img src="readmepage.png" alt="Readme page"
 281  style="width: 586px; height: 544px;"> </p>
 282 <p><b>Figure 5:</b> "Finish installation" page</p>
 283 </center>
 284 <p>In this page you can read important information about the
 285 Instalation
 286 Wizard itself and some hints: how to run and test SALOME or how to
 287 build
 288 SALOME from the sources. This is the contents of the README file which
 289 you
 290 can find in the root directory of the Installation Wizard. <br>
 291 You can also launch SALOME Desktop from this page by clicking <i>"Launch
 292 SALOME" </i>button. </p>
 293 <p><a name="env_files"></a>During the process of installation the
 294 script creates some
 295 environment files to simplify procedure of launching SALOME. These
 296 shell scripts set
 297 all necessary environment variables for all products you have
 298 installed.
 299 To learn how installation scripts collects the environment, see&nbsp;<a
 300  href="#pick_up_env"> here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b>
 301 in the <span style="font-style: italic;"><span
 302  style="font-weight: bold;">KERNEL module</span></span><b><i> sources</i></b>
 303 and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL
 304 module</span></span><b><i> binaries</i></b> root directories and <b>env_products.csh</b>
 305 + <b>env_products.sh </b>in the target directory.<br>
 306 </p>
 307 <span style="font-weight: bold;">Note:</span> <b>salome.(c)sh</b> and <b>env_products.(c)sh
 308 files</b> are slightly different: env_products.* files are optimized to
 309 be used for the building of SALOME modules from sources (see <span
 310  style="font-weight: bold;">README </span>file provided with the
 311 installation procedure on th CD). The salome.* files are optimized for
 312 the SALOME launching. This difference is defined by the environment
 313 variable<span style="font-weight: bold;"> </span><b>ENV_FOR_LAUNCH</b>
 314 which is set to 0 in env_products.* files and to 1 in salome.* files.<br>
 315 <b><br>
 316 </b>
 317 <hr>
 318 <h3><a name="check_version_proc"></a>Notes on<font color="#ff0000">
 319 check products version</font> procedure</h3>
 320 Unfortunately under Linux platform there is no exact algorithm to
 321 identify the product's version. The table below gives an idea how the
 322 version is checked for the preinstalled products for the Linux Mandrake
 323 10.1 platform. <br>
 324 &nbsp;
 325 <table nosave="" border="1" width="100%">
 326   <tbody>
 327     <tr nosave="">
 328       <th nosave="">
 329       <center><font size="+1">Product</font></center>
 330       </th>
 331       <th nosave="">
 332       <center><font size="+1">Algorithm of checking</font></center>
 333       </th>
 334       <th nosave="">
 335       <center><font size="+1">Preliminary steps before launching</font>
 336       <br>
 337       <font size="+1">of installation procedure</font></center>
 338       </th>
 339       <th nosave="">
 340       <center><font size="+1">Notes</font></center>
 341       </th>
 342     </tr>
 343     <tr>
 344       <td>gcc 3.4.1</td>
 345       <td><span style="font-weight: bold;">ver</span>=`gcc -dumpversion`</td>
 346       <td>
 347       <center>-</center>
 348       </td>
 349       <td><span style="font-weight: bold;">ver</span> should be 3.4.1.<br>
 350 It is recommended to use native gcc on Mandrake 10.1.<br>
 351       </td>
 352     </tr>
 353     <tr nosave="">
 354       <td>tcl 8.4.5</td>
 355       <td nosave=""><span style="font-weight: bold;">1)</span> check if
 356       <span style="font-weight: bold;">TCLHOME</span> variable is set<br>
 357       <span style="font-weight: bold;">2)</span> existence of tclsh8.4<br>
 358       <span style="font-weight: bold;">3)</span> existence of wish8.4 <br>
 359       <span style="font-weight: bold;">4)</span> existence of
 360 libtcl8.4.so <br>
 361       <span style="font-weight: bold;">5)</span> existence of
 362 libtk8.4.so<br>
 363       </td>
 364       <td>set <span style="font-weight: bold;">TCLHOME</span> if you
 365 have preinstalled version of tcl. <br>
 366 add a directory where libraries can be found to the <span
 367  style="font-weight: bold;">LD_LIBRARY_PATH</span><br>
 368       </td>
 369       <td>Unfortunately there is no more strict way to check the tcl
 370 version number.<br>
 371 It is recommended to use native tcl/tk on Mandrake 10.1.</td>
 372     </tr>
 373     <tr>
 374       <td valign="top">boost 1.31.0<br>
 375       </td>
 376       <td valign="top"><span style="font-weight: bold;">1)</span> check
 377 if <span style="font-weight: bold;">BOOSTDIR</span> variable is set.<br>
 378       <span style="font-weight: bold;">2)</span> <span
 379  style="font-weight: bold;">ver</span>=`egrep 'BOOST_VERSION [0-9]+'
 380 ${BOOSTDIR}/boost/version.hpp | sed 's/.*BOOST_VERSION
 381 \([0-9]\+\)/\1/g'`<br>
 382       </td>
 383       <td valign="top">set <span style="font-weight: bold;">BOOSTDIR</span>
 384 if you have preinstalled version of
 385 boost<br>
 386       </td>
 387       <td valign="top">we use version.hpp file in the boost
 388 distribution to get the version information.<br>
 389       <span style="font-weight: bold;">ver</span> should be equal to
 390 103100.<br>
 391       </td>
 392     </tr>
 393     <tr>
 394       <td>Open CASCADE 6.0<br>
 395       </td>
 396       <td><span style="font-weight: bold;">1)</span> check if <span
 397  style="font-weight: bold;">CASROOT</span> variable is set<br>
 398       <span style="font-weight: bold;">2)</span> ver_major=`grep
 399 "!define OCC_VERSION_MAJOR"
 400 ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
 401       <span style="font-weight: bold;">3)</span> ver_minor=`grep
 402 "!define OCC_VERSION_MINOR"
 403 ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
 404       <span style="font-weight: bold;">4)</span> ver_maint=`grep
 405 "!define OCC_VERSION_MAINTENANCE"
 406 ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
 407       <span style="font-weight: bold;">5)</span> <span
 408  style="font-weight: bold;">ver</span>="$ver_major.$ver_minor.$ver_maint"<br>
 409       </td>
 410       <td>set <span style="font-weight: bold;">CASROOT</span> if you
 411 have preinstalled version of Open CASCADE</td>
 412       <td>CASCADE's Standard_Version.hxx file provides version
 413 information.<br>
 414       <span style="font-weight: bold;">ver</span> should be equal to
 415 6.0.0.<br>
 416       </td>
 417     </tr>
 418     <tr>
 419       <td>Python 2.3.4</td>
 420       <td><span style="font-weight: bold;">1)</span> <span
 421  style="font-weight: bold;">PYTHONHOME</span> variable should be set<br>
 422       <span style="font-weight: bold;">2)</span> isPython=`which
 423 python` <br>
 424       <span style="font-weight: bold;">3)</span> <span
 425  style="font-weight: bold;">ver</span>=`python -V`</td>
 426       <td>set <span style="font-weight: bold;">PYTHONHOME</span> to
 427 root Python distribution folder;<br>
 428 add the directory where python can be found to the <span
 429  style="font-weight: bold;">PATH</span> variable<br>
 430       </td>
 431       <td>Python should exist and <span style="font-weight: bold;">ver</span>
 432 should be equal to 2.3.4 <br>
 433 It is recommended to use native Python on Mandrake 10.1.</td>
 434     </tr>
 435     <tr>
 436       <td>Swig 1.3.24</td>
 437       <td><span style="font-weight: bold;">ver</span>=`swig -version
 438 2&gt;&amp;1 | grep -i version | awk '{ print $3 }' | sed -e
 439 's/^\([0-9.]*\)\(.*\)/\1/'`</td>
 440       <td>add the directory where swig binary can be found to the <span
 441  style="font-weight: bold;">PATH</span> variable</td>
 442       <td>Swig should exist and <span style="font-weight: bold;">ver</span>
 443 should be equal to 1.3.24.</td>
 444     </tr>
 445     <tr>
 446       <td>Qt 3.3.3</td>
 447       <td><span style="font-weight: bold;">1) QTDIR</span> variable
 448 should be set.<br>
 449       <span style="font-weight: bold;">2) ver</span>=`grep
 450 "QT_VERSION_STR" ${QTDIR}/include/qglobal.h | sed -e
 451 's%^#define QT_VERSION_STR\([[:space:]]*\)%%g' -e 's%\"%%g'`</td>
 452       <td>set <span style="font-weight: bold;">QTDIR</span> if you
 453 have preinstalled version of qt</td>
 454       <td>Qt's qglobal.h file provides version information: <span
 455  style="font-weight: bold;">ver</span> should
 456 be equal to 3.0.5.<br>
 457 It is recommended to use native Qt on Mandrake 10.1.</td>
 458     </tr>
 459     <tr>
 460       <td style="vertical-align: top;">msg2qm (Qt 3.3.3 compatible)<br>
 461       </td>
 462       <td style="vertical-align: top;"><span style="font-weight: bold;">MSG2QM_ROOT</span>
 463 variable should be set.<br>
 464       </td>
 465       <td style="vertical-align: top;">set&nbsp; <span
 466  style="font-weight: bold;">MSG2QM_ROOT</span> if you have preinstalled
 467 version of msg2qm tool<br>
 468       </td>
 469       <td style="vertical-align: top;">msg2qm is Qt tool used to
 470 convert text *.po files to *.qm resource files. Unfortunately this tool
 471 is not included to the Qt distribution and provided only in its sources
 472 package. We distribute this tool with the Installation Wizard.<br>
 473 In addition there is no way to check the version number of msg2qm tool.<br>
 474       </td>
 475     </tr>
 476     <tr>
 477       <td>Qwt 4.2.0/0.4.2</td>
 478       <td><span style="font-weight: bold;">1)</span> <span
 479  style="font-weight: bold;">QWTHOME</span> variable should be set.<br>
 480       <span style="font-weight: bold;">2)</span> check if
 481 libqwt.so.4.2.0 exists<br>
 482       </td>
 483       <td>set&nbsp; <span style="font-weight: bold;">QWTHOME</span> if
 484 you have preinstalled version of qwt</td>
 485       <td>Unfortunately there is no strict way to check qwt version
 486 number.<br>
 487 We try to find libqwt.so.4.2.0 in the ${<span style="font-weight: bold;">QWTHOME</span>}/lib
 488 folder.&nbsp;</td>
 489     </tr>
 490     <tr>
 491       <td>Hdf 5-1.6.3</td>
 492       <td><span style="font-weight: bold;">1) HDF5HOME</span> variable
 493 should be set.<br>
 494       <span style="font-weight: bold;">2)</span> existence of
 495 libhdf5.so.0.0.0 <br>
 496       <span style="font-weight: bold;">3)</span> existence of
 497 libhdf5.settings<br>
 498       <span style="font-weight: bold;">4)</span> <span
 499  style="font-weight: bold;">ver</span>=`grep "HDF5 Version:"
 500 ${HDF5HOME}/lib/libhdf5.settings | awk
 501 '{print $3}'`</td>
 502       <td>set <span style="font-weight: bold;">HDF5HOME</span> if you
 503 have preinstalled version of hdf</td>
 504       <td>We try to find libhdf5.so.0.0.0 and libhdf5.settings in
 505 ${<span style="font-weight: bold;">HDF5HOME</span>}/lib folder. <br>
 506 File libhdf5.settings contains the following version information: <br>
 507 HDF5 Version: 1.6.3</td>
 508     </tr>
 509     <tr>
 510       <td>Med 2.2.2</td>
 511       <td><span style="font-weight: bold;">1) MED2HOME</span> variable
 512 should be set.<br>
 513       <span style="font-weight: bold;">2)</span> existence of
 514 libmed.so.1.0.1</td>
 515       <td>set <span style="font-weight: bold;">MED2HOME</span> if you
 516 have preinstalled version of med</td>
 517       <td>Unfortunately there is no strict way to check med version
 518 number.<br>
 519 We try to find libmed.so.1.0.1 in ${<span style="font-weight: bold;">MED2HOME</span>}/lib
 520 folder. <br>
 521 If you have problem with preinstalled version of med reinstall it.</td>
 522     </tr>
 523     <tr>
 524       <td>Vtk 4.2.6</td>
 525       <td><span style="font-weight: bold;">1) VTKHOME</span> variable
 526 should be set.<br>
 527       <span style="font-weight: bold;">2)</span> existence of
 528 libvtkCommon.so</td>
 529       <td>set <span style="font-weight: bold;">VTKHOME</span> if you
 530 have preinstalled version of vtk</td>
 531       <td>Unfortunately there is no strict way to check VTK version
 532 number.<br>
 533 We try to find libvtkCommon.so in ${<span style="font-weight: bold;">VTKHOME</span>}/lib/vtk
 534 folder. <br>
 535 If you have problem with preinstalled version of vtk reinstall it.</td>
 536     </tr>
 537     <tr>
 538       <td valign="top">Netgen 4.3<br>
 539       </td>
 540       <td valign="top"><span style="font-weight: bold;">NETGENROOT</span>
 541 variable should be set. </td>
 542       <td valign="top">set <span style="font-weight: bold;">NETGENROOT</span>
 543 if you have preinstalled version
 544 of Netgen.<br>
 545       </td>
 546       <td valign="top">Unfortunarely we can't find anything about
 547 netgen version.<br>
 548 We just check if <span style="font-weight: bold;">NETGENROOT</span>
 549 environment varible is set.<br>
 550       </td>
 551     </tr>
 552     <tr>
 553       <td>OmniORB 4.0.5, <br>
 554 OmniORBpy 2.5, <br>
 555 OmniNotify 2.1</td>
 556       <td><span style="font-weight: bold;">1) OMNIORBDIR</span>
 557 variable should be set.<br>
 558       <span style="font-weight: bold;">2)</span> existence of
 559 libomniORB4.so.0.5 <br>
 560       <span style="font-weight: bold;">3)</span> existence of
 561 _omnipymodule.so.2.4 <br>
 562       <span style="font-weight: bold;">4)</span> existence of
 563 libCOSNotify4.so.0.1 <br>
 564       <span style="font-weight: bold;">5)</span> existence of notifd<br>
 565       </td>
 566       <td>set <span style="font-weight: bold;">OMNIORBDIR</span> if
 567 you have preinstalled version of omni</td>
 568       <td>We try to find several omni libraries and binaries in the ${<span
 569  style="font-weight: bold;">OMNIORBDIR</span>}/lib and ${<span
 570  style="font-weight: bold;">OMNIORBDIR</span>}/bin directories.<br>
 571       <br>
 572       </td>
 573     </tr>
 574     <tr>
 575       <td>Numeric 23.7</td>
 576       <td><span style="font-weight: bold;">ver</span>=`python -c
 577 'import Numeric; print Numeric.__version__'
 578 2&gt;/dev/null`</td>
 579       <td>add the directory where&nbsp;<span style="font-weight: bold;"></span>you
 580 have preinstalled version of Numeric
 581 package to your <span style="font-weight: bold;">PYTHONHOME </span>variable<span
 582  style="font-weight: bold;"><br>
 583       </span></td>
 584       <td>If you have problem with preinstalled version of Numeric 23.7
 585 reinstall it.</td>
 586     </tr>
 587     <tr>
 588       <td>Sip 4.1<br>
 589       </td>
 590       <td><span style="font-weight: bold;">1) SIPDIR</span> variable
 591 should be set.<br>
 592       <span style="font-weight: bold;">2) ver</span>=`${SIPDIR}/sip -V
 593 | awk '{print $1}'`</td>
 594       <td>set <span style="font-weight: bold;">SIPDIR</span> to
 595 directory where you have sip preinstalled</td>
 596       <td><span style="font-weight: bold;">ver</span> should be equal
 597 to 4.1. <br>
 598       <br>
 599       </td>
 600     </tr>
 601     <tr>
 602       <td>PyQt 3.13</td>
 603       <td><span style="font-weight: bold;">1) PYQTDIR</span> variable
 604 should be set.<br>
 605       <span style="font-weight: bold;">2)</span> existence of qt.so
 606 library<br>
 607       </td>
 608       <td>set <span style="font-weight: bold;">PYQTDIR</span> to
 609 directory where you have PyQt preinstalled</td>
 610       <td>Unfortunately we can't check exact PyQt version number. <br>
 611 We just try to find qt.so in ${<span style="font-weight: bold;">PYQTDIR</span>}.
 612       <br>
 613       </td>
 614     </tr>
 615     <tr>
 616       <td>HappyDoc 2.1</td>
 617       <td><span style="font-weight: bold;">1)</span> existence of
 618 happydoc <br>
 619       <span style="font-weight: bold;">2)</span> <span
 620  style="font-weight: bold;">ver</span>=`happydoc | grep "HappyDoc
 621 version 2.1"`</td>
 622       <td>add the directory where you have HappyDoc
 623 installed to your <span style="font-weight: bold;">PATH</span>
 624 variable.<br>
 625       </td>
 626       <td>We try to find happydoc in ${<span style="font-weight: bold;">PATH</span>}.
 627       <br>
 628       <span style="font-weight: bold;">ver</span> should not be empty. <br>
 629       <br>
 630       <span style="font-weight: bold;">Note:</span> this product is not
 631 obligatory for SALOME compilation.<br>
 632       </td>
 633     </tr>
 634     <tr>
 635       <td>Doxygen 1.3.7</td>
 636       <td><span style="font-weight: bold;">1)</span> existence of
 637 doxygen <br>
 638       <span style="font-weight: bold;">2)</span> existence of doxytag <br>
 639       <span style="font-weight: bold;">3)</span> existence of doxywizard<br>
 640       <span style="font-weight: bold;">4)</span> <span
 641  style="font-weight: bold;">ver</span>=`doxygen --version`</td>
 642       <td>add the directory where you have doxygen binaries
 643 preinstalled to the&nbsp; <span style="font-weight: bold;">PATH</span>
 644 variable.</td>
 645       <td>doxygen, doxytag, doxywizard binaries should
 646 exist; <span style="font-weight: bold;">ver</span> should be equal to
 647 1.3.7.<br>
 648       <br>
 649 If you have problem with preinstalled version of doxygen
 650 reinstall it. <br>
 651       <br>
 652 It is recommended to use native doxygen on Mandrake 10.1.<br>
 653       </td>
 654     </tr>
 655     <tr>
 656       <td>Graphviz 2.2.1<br>
 657       </td>
 658       <td><span style="font-weight: bold;">1)</span> existence of dot
 659 binary.<br>
 660       <span style="font-weight: bold;">2)</span> <span
 661  style="font-weight: bold;">ver</span>=`dot -V 2&gt;&amp;1 | awk
 662 '{print $3}'`</td>
 663       <td>add graphviz bin directory to the <span
 664  style="font-weight: bold;">PATH</span> environment variable</td>
 665       <td>We try to find dot program in the ${<span
 666  style="font-weight: bold;">PATH</span>}.<br>
 667       <span style="font-weight: bold;">ver</span> should be equal to
 668 2.2.1.<br>
 669       </td>
 670     </tr>
 671     <tr>
 672       <td><span style="font-weight: bold;">MODULE</span> binaries<br>
 673 (where <span style="font-weight: bold;">MODULE</span> = KERNEL, GUI,
 674 GEOM, ...)<br>
 675       </td>
 676       <td><span style="font-weight: bold;">1) MODULE_ROOT_DIR</span>
 677 variable should be set<br>
 678       <span style="font-weight: bold;">2)</span> existence of VERSION
 679 file <br>
 680       <span style="font-weight: bold;">3) ver</span>=`cat ${<span
 681  style="font-weight: bold;">MODULE_ROOT_DIR</span>}/bin/salome/VERSION
 682 | awk -F: '{print $NF}' |
 683 tr -d '[:space:]'`</td>
 684       <td>set <span style="font-weight: bold;">MODULE_ROOT_DIR</span>
 685 if you have preinstalled binaries of <span style="font-weight: bold;">MODULE</span>.</td>
 686       <td><span style="font-weight: bold;">MODULE</span> binaries
 687 should exist and <span style="font-weight: bold;">ver</span> should be
 688 equal to &lt;version&gt;, where &lt;version&gt; is version number
 689 being installed.<br>
 690       </td>
 691     </tr>
 692     <tr>
 693       <td><span style="font-weight: bold;">MODULE</span> sources<br>
 694 (where <span style="font-weight: bold;">MODULE</span> = KERNEL, GUI,
 695 GEOM, ...)<br>
 696       </td>
 697       <td><span style="font-weight: bold;">1)</span> existence of <span
 698  style="font-weight: bold;">MODULE_SRC_DIR</span> <br>
 699       <span style="font-weight: bold;">2)</span> existence of VERSION
 700 file <br>
 701       <span style="font-weight: bold;">3) ver</span>=`cat ${<span
 702  style="font-weight: bold;">MODULE_SRC_DIR</span>}/bin/VERSION | awk
 703 -F: '{print $NF}' | tr -d
 704 '[:space:]'`</td>
 705       <td>set <span style="font-weight: bold;">MODULE_SRC_DIR</span>
 706 if you have preinstalled sources of <span style="font-weight: bold;">MODULE</span>.<br>
 707       </td>
 708       <td><span style="font-weight: bold;">MODULE</span> sources should
 709 exist and ver should be equal to &lt;version&gt;, where &lt;version&gt; is version number
 710 being installed.</td>
 711     </tr>
 712   </tbody>
 713 </table>
 714 <p><b>Note:</b> For native products installation procedure sets proper
 715 environment variables itself, and you do not need to set such variables
 716 like, e.g. <b>TCLHOME</b> or <b>PYTHONHOME</b>. <br>
 717 If you have native products installed to different from default
 718 directories (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is
 719 recommended to follow above description. Or you should set properly <span
 720  style="font-weight: bold;">PATH</span> and <span
 721  style="font-weight: bold;">LD_LIBRARY_PATH</span> variables <b><font
 722  color="#ff0000">before</font></b>
 723 starting Installation Wizard. Otherwise
 724 installation script will fail to find preinstalled products. </p>
 725 <p><b>Note:</b> For some native products (e.g. gcc, Python) the rules
 726 of version
 727 checking are not so strict as described in the table. Only major and
 728 minor numbers of version
 729 should coincide with prerequisite. Release number can be larger. It is
 730 done for making a possibility
 731 to use native products for newer versions of Linux.
 732 If some native product has version number larger than that required by
 733 the
 734 installation procedure, user will be prompted by the warning message
 735 like this: <i>"You have
 736 newer version of gcc installed
 737 on your computer than that is required (3.4.1). Continue?"</i>. You can
 738 press <i>"Yes"</i> button
 739 to procede with the installation but in this case you should be aware
 740 of what you are doing.
 741 SALOME binaries (including other products) are compiled with the
 742 predefined prerequisites
 743 and most likely can not be run successfully if these products are not
 744 found.
 745 This can be only helpful if you intend to build all products from
 746 sources.</p>
 747 <h3>
 748 <hr></h3>
 749 <h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
 750 Please, read carefully the following information. This section
 751 describes how the installation procedure collects the environment.
 752 <p>After installing each product shell script creates special
 753 environment file for each product in its target folder . The name of
 754 the file is generated
 755 from
 756 the name of product by the following scheme: <b>env_&lt;product_name&gt;.sh.</b>
 757 This file includes all necessary product settings. For example for Vtk
 758 the file is <b>env_Vtk.sh</b>. Environment files allows to pick up all
 759 environment settings which are necessary to build and launch SALOME.
 760 When installing SALOME
 761 sources and/or binaries, installation procedure picks up all the
 762 settings files and generate two scripts: <b>salome.sh</b> and <b>salome.csh
 763 </b>for sh and csh correspondingly. Such approach helps to save time
 764 when reinstalling products and you may not to care about setting all
 765 environment variables
 766 manually to build/launch SALOME. What you need is just to use one of
 767 these
 768 scripts. </p>
 769 <p>This concerns also those products which are not currently installed.
 770 For example, you install some SALOME binaries to the directory where
 771 you have previously installed other products.&nbsp; Installation
 772 procedure still tries to collect environment files from the target
 773 directory if it finds necessary products there. If some product is not
 774 found in the target directory the corresponding
 775 section of <b>salome.sh/salome.csh</b> files will be skipped. <br>
 776 For native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>
 777 installation procedure tries to find them first using <b>PATH</b>
 778 / <b>LD_LIBRARY_PATH</b> variables and then in the system default
 779 directories (<b>/usr/bin, /usr/lib</b> etc., depending on the product).
 780 </p>
 781 <p>In any case you may edit <b>salome.*</b> files after installation
 782 procedure finishes, as you want.<br>
 783 <span style="font-weight: bold;">Note:</span> as it was mentioned <a
 784  href="#env_files">above</a> there are two more environment files which
 785 are generated by the installation procedure: <span
 786  style="font-weight: bold;">env_products.csh</span> and <span
 787  style="font-weight: bold;">env_products.sh</span>. These files can be
 788 found in the target installation root directory.<br>
 789 </p>
 790 <hr>
 791 <h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font>
 792 configuration <font color="#ff0000">file</font></h3>
 793 <font color="#000000">You can create your own configuration file.
 794 Installation Wizard then can take it as command line argument to
 795 provide list of products you want to install with it. The list of
 796 products and some another settings for the Installation Wizard are
 797 provided in XML file. The default file which Installation Wizard looks
 798 for if no command line arguments are given, is <b>config.xml</b>. This
 799 section describes the structure of the configuration file.</font> <br>
 800 <font color="#000000">XNL tags are in bold blue, optional sections/tags
 801 are in brackets.</font>
 802 <font face="Courier"><p><b><font color="#000099">&lt;document&gt;</font></b>
 803 <br>
 804 <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[</font><b><font
 805  color="#000099"> &lt;config</font></b><font color="#000000">
 806 [ version=&lt;install_wizard_version&gt; ]</font> <br>
 807 <font color="#000000">&nbsp;&nbsp;&nbsp; &nbsp;
 808 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [
 809 caption=&lt;install_wizard_caption&gt; ]</font> <br>
 810 <font color="#000000">&nbsp;&nbsp;&nbsp; &nbsp;
 811 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [
 812 copyright=&lt;install_wizard_copyright&gt;&nbsp; ]</font> <br>
 813 <font color="#000000">&nbsp;&nbsp;&nbsp; &nbsp;
 814 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [
 815 license=&lt;install_wizard_license_info&gt; ]</font> <br>
 816 <font color="#000000">&nbsp;&nbsp;&nbsp; &nbsp;
 817 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [ os=&lt;target_platform&gt;
 818 ]</font><b><font color="#000099"><br>
 819 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /&gt;</font></b><font color="#000000"> <br>
 820 &nbsp;&nbsp;&nbsp; ]</font> <br>
 821 <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[ </font><b><font
 822  color="#000099">&lt;path</font></b><font color="#000000">&nbsp;&nbsp;
 823 [ targetdir=&lt;target_directory&gt; ]</font> <br>
 824 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 825 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 826 [ tempdir=&lt;temp_directory&gt;&nbsp;&nbsp;&nbsp;&nbsp; ]</font><b><font
 827  color="#000099"><br>
 828 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /&gt; </font></b><font color="#000000"><br>
 829 &nbsp;&nbsp;&nbsp; ]</font> <br>
 830 <font color="#000000">&nbsp;&nbsp;&nbsp; [</font><b><font
 831  color="#000099"> &lt;product</font></b><font color="#000000">&nbsp;
 832 name=&lt;product_name&gt;</font> <br>
 833 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 834 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 835 version=&lt;product_version&gt;</font> <br>
 836 &nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp;&nbsp; [
 837 context=&lt;product_context&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 838 ]<br>
 839 &nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp;&nbsp; [
 840 description=&lt;product_description&gt; ]<br>
 841 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 842 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 843 install=&lt;installation_mode&gt;</font> <br>
 844 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 845 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 846 supported=&lt;supported_installation_modes&gt;</font> <br>
 847 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 848 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; disable=&lt;disable_flag&gt;<br>
 849 &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;&nbsp; [
 850 pickupenv=&lt;pickup_env_flag&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ]</font><font
 851  color="#000000"><br>
 852 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 853 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 854 dependancies=&lt;list_of_prerequisites&gt;</font>&nbsp;<font
 855  color="#000000"><br>
 856 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 857 &nbsp;&nbsp;&nbsp;&nbsp; installdiskspace=&lt;install_disk_space&gt;</font>
 858 <font color="#000000"><br>
 859 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 860 &nbsp;&nbsp;&nbsp; temporarydiskspace=&lt;tmp_disk_space&gt;</font> <font
 861  color="#000000"><br>
 862 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 863 &nbsp;&nbsp; script=&lt;installation_script_name&gt;</font><font
 864  color="#000099"><br>
 865 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /<b>&gt;</b></font><font color="#000000">
 866 <br>
 867 &nbsp;&nbsp;&nbsp; ]</font> <font color="#000000"><br>
 868 &nbsp;&nbsp;&nbsp; [</font><b><font color="#000099"> &lt;product</font></b><font
 869  color="#000000"> ... </font><font color="#000099"><br>
 870 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /<b>&gt;</b></font><font color="#000000">
 871 <br>
 872 &nbsp;&nbsp;&nbsp; ]</font> <font color="#000000"><br>
 873 &nbsp;&nbsp;&nbsp;<b> .</b></font><b><font color="#000099">..</font></b>
 874 <b><font color="#000099"><br>
 875 &lt;/document&gt;</font></b> </p></font>
 876 <h4><font color="#000000">&lt;config&gt; section</font></h4>
 877 <font color="#000000">This is optional section - contains general
 878 information Installation Wizard itself.</font>
 879 <ul>
 880   <li> <font color="#000000"><b>version</b>: Installation Wizard's
 881 version number;</font></li>
 882   <li> <font color="#000000"><b>caption</b>: Installation Wizard's
 883 main
 884 window title - if this string contains '%1' text - the title will
 885 contain
 886 in this place version number (see above);</font></li>
 887   <li> <font color="#000000"><b>copyright</b>: Installation Wizard's
 888 copyright information (appears on the first page of program);</font></li>
 889   <li> <font color="#000000"><b>license</b>: Installation Wizard's
 890 license information (appears on the first page of program);</font></li>
 891   <li> <font color="#000000"><b>os</b>: Contains directory name
 892 (relative from ./Products/BINARIES) where Installation Wizard should
 893 search precompiled binaries packages. If this tag is skipped, binaries
 894 are implied to be in
 895 the ./Products/BINARIES directory.</font></li>
 896 </ul>
 897 <h4> <b><font color="#000000">&lt;path&gt; section</font></b></h4>
 898 This is optional section - contains default directories.
 899 <ul>
 900   <li> <font color="#000000"><b>targetdir</b>: Starting target
 901 directory - path to the directory where products should be installed;</font></li>
 902   <li> <font color="#000000"><b>tempdir</b>: Starting temp directory -
 903 path to the directory for the temporary files.</font></li>
 904 </ul>
 905 <h4> <b>&lt;product&gt; section</b></h4>
 906 This section describes product to be installed with the Installation
 907 Wizard. Products appear in the products tree
 908 and are installed in the order they are described in the configuration
 909 file. It is recommended to insert native products at the top of the
 910 list before all other products.
 911 <ul>
 912   <li> <font color="#000000"><b>name</b>: Name of the product;</font></li>
 913   <li> <font color="#000000"><b>version</b>: Version of the product;</font></li>
 914   <li> <font color="#000000"><b>description</b>: Description of the
 915 product (optional);</font></li>
 916   <li> <font color="#000000"><b>context</b>: Context of the product
 917 (optional); the possible values are <b>'salome sources'</b>, <b>'salome
 918 binaries'</b> and <b>'prerequisite'</b>;</font></li>
 919   <li> <font color="#000000"><b>supported</b>: Supported modes of
 920 installation, should contain one or more of the following options,
 921 separated by comma: <i>install sources</i>, <i>install binaries</i>, <i>use
 922 native</i>. Installation script should contain corresponding functions
 923 for each of supported installation modes;</font></li>
 924   <li> <font color="#000000"><b>install</b>: Default (starting)
 925 installation mode;</font></li>
 926   <li> <font color="#000000"><b>disable</b>: If this flag has 'true'
 927 value, corresponding product will not appear in the list of products
 928 tree and will not be installed;</font></li>
 929   <li><b>pickupenv</b>: This flag points that pickup environment
 930 procedure
 931 should be performed for this module. If this flag equal to <b>true</b>,
 932 &nbsp;salome.sh
 933 and salome.csh files will&nbsp; be created in the product's
 934 installation
 935 directory. Usually this option is set to true for SALOME KERNEL module
 936 sources and binaries pakcge. This is optional key, default value is <b>false.</b><br>
 937   </li>
 938   <li> <font color="#000000"><b>dependancies</b>: list of prerequisite
 939 products, which are necessary to build this product, separated by comma;</font></li>
 940   <li> <font color="#000000"><b>installdiskspace</b>: Total amount
 941 space (integer, in Kbytes), which product occupies on the hard drive
 942 after the
 943 installation;</font></li>
 944   <li> <font color="#000000"><b>temporarydiskspace</b>: Disk space
 945 (integer, in Kbytes) for the temporary files, which is necessary to
 946 build the product from the sources;</font></li>
 947   <li> <font color="#000000"><b>script</b>: Installation script name.
 948 This script is in charge of installation of the product. It is called
 949 when necessary from the main program. See <a href="#new_products">next
 950 section</a> for
 951 more information.</font></li>
 952 </ul>
 953 <b>Note:</b> If you add new products to be installed with Installation
 954 Wizard, you should also provide installation script for this product.
 955 See
 956 next section for more details.
 957 <hr>
 958 <h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
 959 scripts</font> for the new products</h3>
 960 When you want some product to be installed with the Installation
 961 Wizard, you should add it's description it <a href="#xml_files">in the
 962 configuration file</a> and create bash installation script, following
 963 described in this section rules. <br>
 964 There are some obligatory functions to be provided in this installation
 965 script. These functions are automatically called by master installation
 966 script
 967 or/and its GUI shell when it is necessary.<br>
 968 <font color="#000000">File <b>common.sh</b> contains some service
 969 functions
 970 which can be used in your installation script, like <b>make_env()</b>,<b>
 971 make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b>
 972 find_in_path()</b>,
 973 etc.</font>
 974 <ul>
 975   <li> <b>check_version()</b>:&nbsp; This function allows to check the
 976 version of the product already installed on the computer. It should try
 977 to find product (native or preinstalled in the target directory) and
 978 check
 979 it version. This helps to avoid unnecessary reinstallation. This is
 980 internal
 981 function and is not called</li>
 982   <li> <b><font color="#000000">try_native()</font></b><font
 983  color="#000099">: </font><font color="#000000">This function is
 984 called when <i>'use native' </i>installation mode is selected by the
 985 user. The function should try to find native version of the product and
 986 define possibility of it usage. Should create environment for the
 987 product in the temporary directory (see also description of <b>print_env(</b>)
 988 function). If you do not provide native mode installation, you can omit
 989 this function.</font></li>
 990   <li> <font color="#000000"><b>install_source()</b>: This function is
 991 called when <i>'install sources</i>' installation mode is selected by
 992 the
 993 user. The function is responsible for the building of the product from
 994 the
 995 sources package. Should create environment for the product in the
 996 temporary
 997 directory (see also description of <b>print_env(</b>) function). If
 998 you do
 999 not provide sources mode installation, you can omit this function</font></li>
1000   <li> <font color="#000000"><b>install_binary()</b>: This function is
1001 called when <i>'install binaries'</i> installation mode is selected by
1002 the
1003 user. The function is responsible for the extracting of the product
1004 from
1005 the binaries package. Should create environment for the product in the
1006 temporary
1007 directory (see also description of <b>print_env(</b>) function). If
1008 you do
1009 not provide binaries mode installation, you can omit this function.</font></li>
1010   <li> <b>try_preinstalled()</b>: <font color="#000000">This function
1011 is called when<i> 'not install'</i> installation mode is selected by
1012 the user. In this case script should inspect target directory to try to
1013 find already preinstalled product, pick up and check environment from
1014 there. See <a href="#pick_up_env">here</a> for more details.</font></li>
1015   <li> <font color="#000000"><b>print_env()</b>: This function is in
1016 charge of creation environment script. It should create file with name </font><b>env_&lt;product_name&gt;.sh</b>
1017 in the temporary directory and then copy it into the product
1018 installation directory. The file should contain all necessary
1019 environment variables settings for the product. It will be collected
1020 during the 'pick-up-environment' procedure.</li>
1021   <li><b>pickup_env()</b>: This procedure corresponds <b>pickupenv</b>
1022 tag
1023 of the configuration xml file (see previous section). Should call <b>make_env</b>
1024 procedure to perform pick-up environment procedure for the product.<br>
1025   </li>
1026 </ul>
1027 <font color="#000000">The calling signature of the product installation
1028 script is following:</font> <br>
1029 <b><font color="#000000">&lt;product_script_name&gt;
1030 &lt;function_name&gt; &lt;temp_folder&gt; &lt;products_directory&gt;
1031 &lt;target_directory&gt;
1032 &lt;dependancies&gt; &lt;product_name&gt;</font></b>
1033 <p><font color="#000000">where</font> <br>
1034 <font color="#000000"><b>&lt;product_script_name&gt;</b> - installation
1035 script name (described in configuration xml file);</font> <br>
1036 <font color="#000000"><b>&lt;function_name&gt;</b> - the name of
1037 function, corresponding to the selected installation mode: <i>try_native,
1038 install_source, install_binary</i> or <i>try_preinstalled</i>;</font> <br>
1039 <font color="#000000"><b>&lt;temp_folder&gt;</b> - temporary files
1040 directory;</font> <br>
1041 <font color="#000000"><b>&lt;products_directory&gt;</b> - directory
1042 where the sources/binaries package can be found. You should provide
1043 sources package in the <i>&lt;Install_Wizard_root_directory&gt;/Products/SOURCES</i>
1044 directory and binaries package in the <i>&lt;InstallWizard_root_directory&gt;/Products/BINARIES/&lt;os_version&gt;</i>,
1045 where &lt;os_version&gt; is target platform description, which appears
1046 in the corresponding section of the <a href="#xml_files">configuration
1047 xml
1048 file</a>.</font> <br>
1049 <font color="#000000"><b>&lt;target_directory&gt;</b> - root target
1050 directory where product should be installed to;</font> <br>
1051 <font color="#000000"><b>&lt;dependancies&gt;</b> - single-quoted list
1052 of prerequisite products, separated by space;</font> <br>
1053 <font color="#000000"><b>&lt;product_name&gt; </b>- product name
1054 itself.</font> </p>
1055 <p><font color="#000000">Example:</font> <br>
1056 <i><font color="#000000">med-2.2.2.sh install_binary /tmp/work
1057 ./Products/BINARIES/Mandrake10.1 /usr/salome 'gcc Hdf' med</font></i> </p>
1058 <p><font color="#000000">Copy created script into the <i>&lt;Install_Wizard_root_directory&gt;/config_files</i>
1059 sub-directory where all installation scripts are stored. Installation
1060 Wizard
1061 will automatically search and call your script during the installation
1062 procedure.</font>
1063 </p>
1064 <hr> <br>
1065 <br>
1066 </body>
1067 </html>