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, Open CASCADE SAS (vadim.sandler@opencascade.com)">
  10   <meta name="Copyright" content="2002-2006 CEA">
  11   <title>SALOME Installation Wizard Help</title>
  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       <h3><font size="+4"><font color="#000099">SALOME Installation
  27 Wizard Help</font></font></h3>
  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.2.4</font></b></div>
  40 <hr>
  41 <ul>
  42   <li> <a href="#install_from_wizard">Installing products with the
  43 Installation Wizard<br>
  44     </a></li>
  45   <ul>
  46     <li><a href="#gui_mode">GUI mode</a></li>
  47     <li><a href="#batch_mode">Batch mode</a></li>
  48     <li><a href="#env_files">Environment files</a><br>
  49     </li>
  50   </ul>
  51   <li> <a href="#check_version_proc">Notes on check products version
  52 procedure</a></li>
  53   <li> <a href="#pick_up_env">Pick up the environment</a></li>
  54   <li> <a href="#xml_files">Modifying XML configuration file</a></li>
  55   <li> <a href="#new_products">Implementing installation scripts for
  56 the new products</a></li>
  57   <li> <a href="#finish_buttons">Customizing Readme page buttons</a></li>
  58 </ul>
  59 <h3>
  60 <hr></h3>
  61 <h3> <a name="install_from_wizard"></a>Installing products with the <font
  62  color="#ff0000">Installation Wizard</font></h3>
  63 The Installation Wizard can be launched in two modes: <span
  64  style="font-weight: bold;">GUI </span>and <span
  65  style="font-weight: bold;">batch</span>. <br>
  66 The root directory of the Installation Wizard
  67 contains Python script <span style="font-weight: bold;">runInstall</span>.
  68 To run the Installation Wizard just type <b>runInstall</b> in the
  69 terminal
  70 window:<span style="font-weight: bold;"></span><span
  71  style="font-weight: bold;"></span>
  72 <p>[ python ] <b>runInstall </b>[options]<b><br>
  73 </b></p>
  74 <p>Without options this script will launch the SALOME Installation
  75 Wizard in the default mode (GUI).<br>
  76 The default installation settings can be overriden by using of command
  77 line options. Each
  78 option has short and long notations:<br>
  79 </p>
  80 <p><b>-g / --gui</b><br>
  81 </p>
  82 <div style="margin-left: 40px;">Runs the Installation Wizard in the
  83 GUI
  84 mode (this is default mode).<br>
  85 </div>
  86 <p><b>-b / --batch</b><br>
  87 </p>
  88 <div style="margin-left: 40px;">Runs the Installation Wizard in
  89 the terminal mode. <br>
  90 </div>
  91 <p><b>-f FILE / --file=</b><span style="font-weight: bold;">FILE<br>
  92 </span></p>
  93 <div style="margin-left: 40px;">The XML configuration file to be used
  94 by
  95 the
  96 Installation Wizard.&nbsp; If this option is not used then the
  97 installation script
  98 tries
  99 to define the <i>Linux </i>version and use the corresponding XML file
 100 if it is present.
 101 For
 102 examle, for the <span style="color: rgb(0, 0, 153);">Linux Mandrake
 103 10.1</span>&nbsp; the <b>config_Mandrake_10.1.xml</b>&nbsp;
 104 file
 105 will be used by default. If the appropriate file is not
 106 found, the file <b>config.xml</b> will be used. This file refers to
 107 the basic target platform
 108 which is <span style="color: rgb(0, 0, 153);">Linux Mandrake 10.1</span>
 109 for SALOME 3.0 and newer. If <span style="font-weight: bold;">config.xml</span>
 110 file is
 111 also not found, the warning message box is shown (in GUI mode) or
 112 printed to the console (in batch mode) and the Installation Wizard
 113 quits.<br>
 114 </div>
 115 <p> <b>-d DIR / --target=DIR</b><br>
 116 </p>
 117 <div style="margin-left: 40px;">The target directory SALOME platform
 118 to
 119 be installed to. If used, this option overrides the default target
 120 directory, given in
 121 the
 122 configuration XML file (usually<span style="font-weight: bold;">
 123 ${HOME}/salome_&lt;version&gt;</span>,
 124 see
 125 <a href="#xml_files">here</a> for more details). <br>
 126 </div>
 127 <p><b>-t DIR / --tmp=DIR </b></p>
 128 <div style="margin-left: 40px;">The directory, which should be used for
 129 temporary files. If given, this option overrides the default temporary
 130 directory,
 131 given in the
 132 configuration xml file (usually <span style="font-weight: bold;">/tmp</span><span
 133  style="font-weight: bold;"></span>, see <a href="#xml_files">here</a>
 134 for more information).<br>
 135 </div>
 136 <p><b>-a / --all-from-sources</b></p>
 137 <span style="font-weight: bold;"></span><b> </b>
 138 <div style="margin-left: 40px;">
 139 Force all the products to be installed from sources (including all
 140 SALOME modules). If this option is used, all the default installation
 141 modes for all the products are ignored.<br>
 142 This option is helpful when the user wants to install SALOME on the
 143 platform which is not officially supported. In this case, the user can
 144 try to run the SALOME Installation Wizard with the <span
 145  style="font-weight: bold;">-a</span> option in order to build all the
 146 products from sources.<br>
 147 <span style="font-weight: bold; color: rgb(255, 0, 0);">Note, that this
 148 is long-time operation which can take more than 24 hours depending on
 149 the computer.</span><br>
 150 </div>
 151 <p><b>-h / --help</b><br>
 152 </p>
 153 <div style="margin-left: 40px;">Prints help information on the
 154 Installation Wizard's usage. <br>
 155 </div>
 156 <p></p>
 157 <p>
 158 <b>-v / --version</b><br>
 159 </p>
 160 <div style="margin-left: 40px;">Prints version information (<span
 161  style="font-weight: bold;">Note: </span>this is the
 162 Installation Wizard's version number, not of SALOME platform). <br>
 163 </div>
 164 <p>
 165 </p>
 166 <p>The installation procedure supports different <span
 167  style="color: rgb(0, 0, 153);">Linux
 168 </span>platforms
 169 and installs various installation 3d-party prerequisite products which
 170 are required by SALOME platform. As it was mentioned above, the basic
 171 target platform for SALOME 3.0 and newer is <span
 172  style="color: rgb(0, 0, 153);">Linux Mandrake 10.1</span>.<br>
 173 The using of configuration XML files gives flexible way to modify the
 174 list of products to be installed by the Installation Wizard without
 175 changing program's source code. Just create your own XML configuration
 176 file
 177 and implement installation scripts for the prerequisite products you
 178 need and then use this XML file with the Installation Wizard. This can
 179 be done, for example, for some <span style="color: rgb(0, 0, 153);">Linux
 180 </span>platform which is not supported directly by the Installation
 181 Wizard. See <a href="#xml_files">Modifying XML configuration file</a>
 182 and <a href="#new_products">Implementing installation scripts for the
 183 new products</a> sections for more information. </p>
 184 <h3 style="margin-left: 40px;"> <a name="gui_mode"></a>GUI mode<br>
 185 </h3>
 186 <p>The <font color="#ff0000">Installation Wizard</font>'s GUI has been
 187 developed
 188 with
 189 using of the <span style="color: rgb(0, 0, 153);">Trolltech's </span><span
 190  style="font-weight: bold;"><span style="color: rgb(0, 0, 153);">Qt
 191 3.0.5</span> </span>toolkit. After launching the Installation Wizard
 192 in the GUI mode the wizard window is shown to the user. This wizard
 193 guides the user through several subsequent pages. To navigate between
 194 the pages use <i>"Next"</i> and <i>"Back"</i>
 195 buttons in the
 196 lower part of the wizard window. <i>"Cancel"</i> button closes the
 197 wizard
 198 window&nbsp;and quits the installation procedure after user's
 199 confirmation. <i>"Help"</i> button opens an additional window to show
 200 the help information. </p>
 201 <p>The first "<span style="font-style: italic;">Introduction"</span>
 202 page is shown at the <a href="#IntroPage">Figure 1</a>. Skip this page
 203 by pressing <i>"Next"</i>
 204 button:
 205 </p>
 206 <center><a name="IntroPage"></a><br>
 207 <img alt="Intro page" src="intropage.png"
 208  style="width: 586px; height: 364px;">
 209 <p><b>Figure 1:</b> "Introduction" page</p>
 210 </center>
 211 <p>In the second page you are proposed to enter the target directory
 212 where the SALOME platform should be installed to. You can also press <i>"Browse..."</i>
 213 button and choose the destination folder using standard browse
 214 directory dialog box. <br>
 215 If the directory you want to install products does not exist you are
 216 prompted to confirm directory creation. If you type wrong directory
 217 path, or if you do not have write permissions for the directory you
 218 use, the
 219 corresponding message box is shown.<br>
 220 </p>
 221 <p>You can also change the temporary directory (which is used to store
 222 temporary files required for the installation).<br>
 223 In the bottom part of the window the total disk space required for the
 224 installation and for the temporary files is displayed (see below for
 225 more details).<br>
 226 </p>
 227 <p>In the GUI mode the Installation Wizard provides two different
 228 options
 229 to install the SALOME platform: <span style="font-weight: bold;">basic</span>
 230 (which is default) and
 231 <span style="font-weight: bold;">advanced.</span> In the <span
 232  style="font-weight: bold;">basic</span> mode the
 233 user should enter the target installation
 234 directory and temporary folder. All other installation options are
 235 taken from the XML
 236 configuration file (see <a href="#Product_page1">Fig.2</a>):<br>
 237 </p>
 238 <center><a name="Product_page1"></a><br>
 239 <img alt="Intro page" src="productpage1.png"
 240  style="width: 586px; height: 364px;">
 241 <p><b>Figure 2:</b> "Installation settings"
 242 </p>
 243 </center>
 244 <p>In addition, you have choice to use "Install all products from
 245 sources" check box. If this option is turned on, all the products will
 246 be installed from the sources (using their own build procedures). This
 247 check box correspond to the <span style="font-weight: bold;">--all-from-sources</span>
 248 (<span style="font-weight: bold;">-a</span>) option of the <span
 249  style="font-weight: bold;">runInstall</span> script (see <a
 250  href="#install_from_wizard">here</a>). <span
 251  style="font-weight: bold;">Note:</span> the installation of all
 252 products from sources is a long-time operation.<br>
 253 </p>
 254 <p>To switch to the <span style="font-weight: bold;">advanced</span>
 255 option, click <i>"More..."</i> button (see <a href="#ProductPage2">Fig.3</a>
 256 ).</p>
 257 <p>In the advanced mode you have the possibility to select products to
 258 be installed. Each product can
 259 have several options of installation: you have a possibility to use
 260 native product (provided with Linux distribution and installed in the
 261 system folders), install already precompiled binaries, build product
 262 from the sources or not install it at all. Avaiable options and default
 263 option are taken from the XML configuration file. You can mark the
 264 products you want to install by clicking the corresponding
 265 radiobuttons in the list view in the left part of the page. <br>
 266 Note, that
 267 some products may require some other pre-requisite products to be
 268 installed (or
 269 these prerequisite products should be already available on your
 270 computer). The installation procedure
 271 has a special feature to automatically mark these products in the list
 272 view.
 273 For example, in order to install <b><i>PyQt</i></b> it's necessary to
 274 have
 275 <b><i>gcc, Python</i></b>,<b><i> Qt</i></b> and <b><i>Sip</i></b>
 276 installed.
 277 Therefore all these products will be also turned on when you check on <b><i>PyQt</i></b>.
 278 This feature can be switched off by clicking <i>"Automatic
 279 dependencies"</i> checkbox. Turn on this checkbox if you
 280 want all prerequisite products to be automatically checked when you
 281 select some product to be installed. Turn off this checkbox if you
 282 want to disable this feature.<br>
 283 </p>
 284 <center><a name="ProductPage2"></a><br>
 285 <img src="productpage.png" alt="Products page"
 286  style="width: 586px; height: 525px;">
 287 <p><b>Figure 3:</b> "Installation settings" page in the 'advanced' mode</p>
 288 </center>
 289 <p>If you want to use native products (like <span
 290  style="font-weight: bold;">gcc</span>, <span
 291  style="font-weight: bold;">tcl</span>, etc.), select <i>"use native" </i>option.
 292 <br>
 293 Special button in the right part of the page - <i>"Unselect All" </i>-
 294 allows to reset quickly all products to the <i>"not install"</i>
 295 state. <br>
 296 </p>
 297 <p>There are also two checkboxes on this page: <i>"SALOME sources"</i>
 298 and <i>"SALOME binaries"</i>.
 299 These three-state checkboxes allow quick selecting/unselecting SALOME
 300 modules sources/binaries packages
 301 for the installation.<br>
 302 </p>
 303 <p>In addition, when some SALOME sources are selected, one more check
 304 box becomes available: <span style="font-style: italic;">"Build SALOME
 305 sources"</span>. If this option is turned on, the selected SALOME
 306 modules will be built and installed from sources.<br>
 307 <span style="font-weight: bold;">Note: if this check box is turned on,
 308 the corresponding SALOME module binaries package installation is
 309 disabled, because of conflicting of SALOME module sources an binaries
 310 packages </span>(see <a href="#ProductPage3">Fig. 4</a> below).
 311 </p>
 312 <center><a name="ProductPage3"></a><br>
 313 <img src="productpage2.png"
 314  alt="Products page" style="width: 586px; height: 525px;">
 315 <p><b>Figure 4:</b> "Build SALOME sources" check box usage</p><br>
 316 </center>
 317 <p>The box at the right side of the page displays the information about
 318 currently highlighted product: name, version and short description,
 319 required
 320 disk space, disk space required for temporary files, list of
 321 prerequisites (this information is
 322 provided in the XML file) and current user
 323 choice.
 324 </p>
 325 The <i>"Disk space required:"</i> field displays how much
 326 disk space on the hard drive is required for installation of selected
 327 products. <br>
 328 <p><b>Note: </b>Please, take into account that displayed amount of
 329 required disk space is approximate and may differ when you install
 330 products on your hard drive. </p>
 331 <p>The installation procedure uses a special directory to store
 332 temporary files. The <i>"Space for temporary files:"</i> field shows
 333 the information about required disk space on the hard drive for
 334 extracting and compiling of the selected products. You can change the
 335 temporary directory - just type path
 336 to the folder you want to use or click on the corresponding <i>"Browse..."</i>
 337 button. <br>
 338 <span style="font-weight: bold;">Note:</span> actually, temporary files
 339 are stored not directly in the directory entered by user. The
 340 Installation
 341 Wizard creates in this directory an additional folder named
 342 something like INSTALLWORK<span style="font-weight: bold;">XXXXX</span>
 343 where XXXXX is unique number. This allows to launch several
 344 Installation Wizards simultaneously. This temporary directory is
 345 removed automaticaly when the installation finishes.<br>
 346 </p>
 347 <p>The installation procedure also checks available disk space. If
 348 there is no
 349 enough disk space on your hard drive you will see the corresponding
 350 error message box. </p>
 351 <p><b>Note: </b><b>you are strongly recommended not to use directory
 352 names
 353 containing
 354 spaces. </b>Otherwise you can experience some troubles with the
 355 installation.<b> </b> </p>
 356 <p>To proceed further click <i>"Next"</i> button. At this moment
 357 program
 358 will make some tests to check installation settings: if there is enough
 359 disk
 360 space on the hard drive, check for native products installation,
 361 dependencies
 362 (prerequisites) for each product you have selected to be
 363 installed.
 364 If any test fails you will see the corresponding warning message box.
 365 Otherwise
 366 the wizard will proceed to the next page: </p>
 367 <center>
 368 <a name="ChoicePage"></a><br>
 369 <img src="choicepage.png" alt="Choice page"
 370  style="width: 586px; height: 485px;">
 371 <p><b>Figure 5:</b> "Check your choice" page</p>
 372 </center>
 373 <p>This page summarizes the installation options you've made on the
 374 previous pages. You can check again your choice and change it if
 375 necessary by getting back to previous page. <br>
 376 When you are sure that everything is OK, press <i>"Next"</i> button to
 377 follow to the <a href="#ProgressPage">next page</a>. </p>
 378 <center><a name="ProgressPage"></a><br>
 379 <img alt="Progress page" src="progresspage1.png"
 380  style="width: 586px; height: 364px;"><br>
 381 <p><b>Figure 6:</b> "Installation progress" page</p>
 382 </center>
 383 <div style="text-align: left;">To start installation of the selected
 384 products click <i>"Start"</i>
 385 button. It launches the shell installation script and you will be able
 386 to see the output of the script in the topmost dialog's frame. If any
 387 errors
 388 occur during the installation progress the corresponding messages
 389 will be printed to the log window in the bold red font.<br>
 390 </div>
 391 <div style="text-align: left;">It is possible at any time to break the
 392 installation by pressing <span style="font-style: italic;">"Stop"</span>
 393 button. Then you can get back to the previous pages if you wish to
 394 change installation settings or restart installation by pressing again <span
 395  style="font-style: italic;">"Start"</span> button.<br>
 396 </div>
 397 <p style="text-align: left;"><span style="font-weight: bold;">Note:</span>
 398 in the current
 399 implementation it is not possible to resume stopped installation
 400 process; it will be re-started from the very beginning. <br>
 401 </p>
 402 <center><a name="ProgressPage1"></a><br>
 403 <img alt="Progress page" src="progresspage.png"
 404  style="width: 586px; height: 364px;">
 405 <p><b>Figure 7:</b> "Installation progress" page: installation in
 406 progress</p>
 407 </center>
 408 <p>The <i>"Installation Status"</i> frame window shows you the
 409 progress of installation. "<font color="#ff0000">Waiting</font>" status
 410 means that installation of this product has not been started
 411 yet. The product currently being installed is marked as "<font
 412  color="#ff9900">Processing</font>".
 413 All installed products have "<font color="#33ff33">Completed</font>"
 414 status. </p>
 415 <p>You can abort installation and close the installation procedure
 416 using
 417 <i>"Cancel"</i> button. <br>
 418 <span style="font-weight: bold;">Note:</span> this button sends the
 419 signal "SIGTERM" to the shell
 420 script.
 421 The script tries to clear all temporary
 422 files.
 423 The process of removing temporary files can take some time, so the
 424 installation
 425 wizard will wait 3 seconds before closing. </p>
 426 <p>At the end of installation (all selected products have been
 427 installed
 428 successfully) you can go back to the previous pages to start a new
 429 installation
 430 or click <i>"Next"</i> button to go the Readme page: </p>
 431 <center>
 432 <a name="readmepage"></a><br>
 433 <img alt="Read page" src="readmepage.png"
 434  style="width: 586px; height: 484px;">
 435 <p><b>Figure 8:</b> "Finish installation" page</p>
 436 </center>
 437 <p>In this page you can read important information about the
 438 Instalation Wizard itself and some tips: how to run and test SALOME or
 439 how to build SALOME from the sources. This is the contents of the
 440 README file which you can find in the root directory of the
 441 Installation Wizard. <br>
 442 You can also launch SALOME Desktop from this
 443 page or read Release Notes file by clicking on the corresponding
 444 buttons in the lower part of the page (see <a href="#xml_files">here</a>
 445 and <a href="#finish_buttons">here</a> for more information about
 446 customizing these buttons).<br>
 447 </p>
 448 <h3 style="margin-left: 40px;"> <a name="batch_mode"></a>Batch mode<br>
 449 </h3>
 450 To launch the Installation Wizard in the batch mode use <span
 451  style="font-weight: bold;">-b</span>
 452 (<span style="font-weight: bold;">--batch</span>) parameter.<br>
 453 In this mode the GUI wizard is not shown but all the installation
 454 status is displayed directly in the console. In the batch mode user do
 455 not have a possibility to change installation settings which are given
 456 in the configuration file, except target and temporary directories
 457 which can be overridden by the corresponding command line options.<br>
 458 The only exception is <span style="font-weight: bold;">--all-from-sources</span>
 459 (<span style="font-weight: bold;">-a</span>) option which enables
 460 special installation mode in which all the products (including SALOME
 461 modules) are installed from sources, ignoring default mode defined in
 462 the XML configuration file (see <a href="#install_from_wizard">here</a>
 463 for details).
 464 <center><a name="BatchMode"></a><br>
 465 <br>
 466 <img alt="Batch mode" src="batchmode.png"
 467  style="width: 660px; height: 410px;">
 468 <p><b>Figure 9:</b> Batch mode</p>
 469 </center>
 470 <h3 style="margin-left: 40px;"><a name="env_files"></a>Environment files</h3>
 471 <p>During the process of installation the
 472 script creates some
 473 environment files to simplify procedure of launching SALOME. These
 474 shell scripts set
 475 all necessary environment variables for all products you have
 476 installed.
 477 To learn how installation scripts collects the environment, see <a
 478  href="#pick_up_env">here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b>
 479 in the <span style="font-style: italic;"><span
 480  style="font-weight: bold;">KERNEL module</span></span><b><i> sources</i></b>
 481 and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL
 482 module</span></span><b><i> binaries</i></b> root directories and <b>env_products.csh</b>
 483 + <b>env_products.sh </b>and <span style="font-weight: bold;">env_build.csh
 484 </span>+ <span style="font-weight: bold;">env_build.sh</span> in the
 485 target installation directory.<br>
 486 </p>
 487 <span style="font-weight: bold;">Note:</span> there is some difference
 488 betwen these files: <span style="font-weight: bold;">env_build.*</span>
 489 files are optimized to
 490 be used for the building of SALOME modules from sources (see <span
 491  style="font-weight: bold;">README </span>file provided with the
 492 installation procedure on the CD). The <span style="font-weight: bold;">env_products.*</span>
 493 (and<span style="font-weight: bold;"> salome.*</span>) files are
 494 optimized for
 495 the SALOME launching. The behavior is defined by the environment
 496 variable<span style="font-weight: bold;"> </span><b>ENV_FOR_LAUNCH</b>
 497 which is set to <span style="font-weight: bold;">0</span> in
 498 env_build.* files and to <span style="font-weight: bold;">1</span> in
 499 env_products.*
 500 (salome.*) files.<br>
 501 <br>
 502 <hr>
 503 <h3><a name="check_version_proc"></a>Notes on<font color="#ff0000">
 504 check products version</font> procedure</h3>
 505 Unfortunately under Linux platform there is no exact algorithm to
 506 identify the product's version. The information in this section gives
 507 an idea how the
 508 version is checked for the native/preinstalled products (this
 509 information refers to the base platform <span
 510  style="color: rgb(0, 0, 153);">Linux Mandrake
 511 10.1</span>; and the same algorithms are used for other platforms). <br>
 512 The general rule for all products is that the path to the binaries
 513 should be set via <span style="font-weight: bold;">PATH</span>
 514 environment variable, path to the libraries should be set via <span
 515  style="font-weight: bold;">LD_LIBRARY_PATH</span> variable and the
 516 python modules should be available via <span style="font-weight: bold;">PYTHONPATH</span>
 517 variable.<br>
 518 <span style="font-weight: bold;">Note:</span> the information given in
 519 this section refers to the prerequisite products for SALOME version
 520 3.2.4.<br>
 521 <ul>
 522   <li>gcc 3.4.1<br>
 523   </li>
 524 </ul>
 525 Version number is checked by <span style="font-weight: bold;">gcc
 526 -dumpversion</span> command. <span style="font-weight: bold;">gcc</span>
 527 executable should be in the <span style="font-weight: bold;">PATH</span>
 528 environment variable. Version should
 529 be equal to the "3.4.1". It is recommended to use native gcc on
 530 Mandrake 10.1.<br>
 531 <ul>
 532   <li>tcl/tk 8.4.5</li>
 533 </ul>
 534 Version number for <span style="font-weight: bold;">tcl/tk</span> can
 535 be found in tclConfig.sh and tkConfig.sh files (<span
 536  style="font-weight: bold;">TCL_VERSION</span> and <span
 537  style="font-weight: bold;">TK_VERSION</span> variables
 538 correspondingly). Version number should be equal to "8.4" (release
 539 number is not checked). <br>
 540 Set <span style="font-weight: bold;">TCLHOME</span> environment
 541 variable to the root directory of tcl/tk installation.<br>
 542 It is recommended to use native tcl/tk on Mandrake 10.1. <span
 543  style="font-weight: bold;"></span>
 544 <ul>
 545   <li>boost 1.31.0</li>
 546 </ul>
 547 Version number is defined by <span style="font-weight: bold;">version.hpp</span>
 548 file which is part of the boost distribution. This file defines <span
 549  style="font-weight: bold;">BOOST_VERSION</span> macro which should be
 550 equal to the "103100". In addition the existence of boost libraries is
 551 checked. <br>
 552 Set <span style="font-weight: bold;">BOOSTDIR</span>
 553 environment variable if you have preinstalled version of
 554 boost.<br>
 555 <ul>
 556   <li>Python 2.3.4</li>
 557 </ul>
 558 Version number is checked by <span style="font-weight: bold;">python -V</span>
 559 command. <span style="font-weight: bold;">python</span> executable
 560 should be in the <span style="font-weight: bold;">PATH</span>
 561 environment variable. Version number should be equal to "2.3.4". It is
 562 recommended to use native Python on
 563 Mandrake 10.1.<br>
 564 Set <span style="font-weight: bold;">PYTHONHOME</span> environment
 565 variable if you have preinstalled version of Python.<br>
 566 <ul>
 567   <li>Swig 1.3.24</li>
 568 </ul>
 569 Version number is checked by <span style="font-weight: bold;">swig
 570 -version</span> command. <span style="font-weight: bold;">swig</span>
 571 executable should be in the <span style="font-weight: bold;">PATH</span>
 572 environment variable. Version number should be equal to "1.3.24".<br>
 573 <ul>
 574   <li>Qt 3.3.3</li>
 575 </ul>
 576 Version number is defined by <span style="font-weight: bold;">qglobal.h</span>
 577 file which is part of the Qt distribution. This file defines <span
 578  style="font-weight: bold;">QT_VERSION_STR</span> macro which should be
 579 equal to "3.3.3". It is recommended to use native Qt on Mandrake 10.1.<br>
 580 Set <span style="font-weight: bold;">QTDIR</span> environment
 581 variable if you
 582 have preinstalled version of qt.<br>
 583 <ul>
 584   <li>msg2qm</li>
 585 </ul>
 586 <span style="font-weight: bold;">msg2qm</span> is Qt tool which is used
 587 to
 588 convert text *.po files to *.qm resource files. Unfortunately this tool
 589 is not included to the Linux distribution and provided only in Qt
 590 sources
 591 package. This is the reason why this tool is suppplied with the SALOME
 592 Installation Wizard.<br>
 593 There is no way to check the version number of msg2qm tool. Just set <span
 594  style="font-weight: bold;">MSG2QM_ROOT</span> environment
 595 variable if you have preinstalled
 596 version of msg2qm tool
 597 <ul>
 598   <li>Open CASCADE 6.1.2a2</li>
 599 </ul>
 600 Version number is defined by <span style="font-weight: bold;">Standard_Version.hxx</span>
 601 file which is part of the Open CASCADE distribution. This file defines <span
 602  style="font-weight: bold;">OCC_VERSION_MAJOR,</span> <span
 603  style="font-weight: bold;">OCC_VERSION_MINOR</span> and <span
 604  style="font-weight: bold;">OCC_VERSION_MAINTENANCE</span> macros which
 605 should refer to version 6.1.2.<br>
 606 Set <span style="font-weight: bold;">CASROOT</span> environment
 607 variable if you have preinstalled version of Open CASCADE.<br>
 608 <ul>
 609   <li>qwt 4.2.0/0.4.2</li>
 610 </ul>
 611 Version number is defined by <span style="font-weight: bold;">qwt_global.h</span>
 612 file which is part of the qwt distribution. This file defines <span
 613  style="font-weight: bold;">QWT_VERSION_STR</span> macro which should
 614 be
 615 equal to "4.2.0".<br>
 616 Set <span style="font-weight: bold;">QWTHOME</span> environment
 617 variable if you
 618 have preinstalled version of qwt.<br>
 619 <ul>
 620   <li>hdf 5-1.6.4</li>
 621 </ul>
 622 Version number is defined by <span style="font-weight: bold;">libhdf5.settings</span>
 623 file which is part of the <span style="font-weight: bold;">hdf5</span>
 624 distribution. Version should be equal to 1.6.4.<br>
 625 Set <span style="font-weight: bold;">HDF5HOME</span> environment
 626 variable if you
 627 have preinstalled version of hdf5.<br>
 628 <ul>
 629   <li>med 2.2.3</li>
 630 </ul>
 631 Unfortunately there is no formal way to check med version
 632 number. We check existense of libmed.so.1.0.2 library on the computer.
 633 If you have problem with preinstalled version of med, please, reinstall
 634 it.<br>
 635 Set <span style="font-weight: bold;">MED2HOME</span> environment
 636 variable if you
 637 have preinstalled version of med.<br>
 638 <ul>
 639   <li>Vtk 4.2.6</li>
 640 </ul>
 641 Unfortunately there is no formal way to check VTK version
 642 number. We just check existence of <span style="font-weight: bold;">libvtkCommon.so</span>
 643 library on the computer and hope that it is of version we need. If you
 644 have problem with preinstalled version of Vtk, please, reinstall it.<br>
 645 Set <span style="font-weight: bold;">VTKHOME</span> environment
 646 variable if you
 647 have preinstalled version of Vtk.<br>
 648 <ul>
 649   <li>OmniORB 4.0.5, OmniORBpy 2.5, OmniNotify 2.1</li>
 650 </ul>
 651 We just check existence of some omniORB libraries and executable on the
 652 computer, like <span style="font-weight: bold;">libomniORB4.so.0.5</span>,
 653 <span style="font-weight: bold;">_omnipymodule.so.2.4</span>, <span
 654  style="font-weight: bold;">libCOSNotify4.so.0.1</span> and <span
 655  style="font-weight: bold;">notifd</span>.<br>
 656 Set <span style="font-weight: bold;">OMNIORBDIR</span> environment
 657 variable if
 658 you have preinstalled version of omniORB products.<br>
 659 <ul>
 660   <li>sip 4.1</li>
 661 </ul>
 662 Version number is checked by <span style="font-weight: bold;">sip -V</span>
 663 command. <span style="font-weight: bold;">sip</span> executable should
 664 be in the <span style="font-weight: bold;">PATH</span>
 665 environment variable. Version number should be equal to "4.1".<br>
 666 Set <span style="font-weight: bold;">SIPDIR</span> environment
 667 variable to the
 668 directory where you have sip executable preinstalled.<br>
 669 <ul>
 670   <li>PyQt 3.13</li>
 671 </ul>
 672 Version number is defined by <span style="font-weight: bold;">pyqtconfig.py</span>
 673 Python module file which is part of the <span
 674  style="font-weight: bold;">PyQt</span> distribution. Version should be
 675 equal to "3.13".<br>
 676 Set <span style="font-weight: bold;">PYQTDIR</span>environment
 677 variable if you
 678 have preinstalled version of PyQt.
 679 <ul>
 680   <li>netgen 4.5</li>
 681 </ul>
 682 Unfortunarely we can't find anything about
 683 netgen version. We just check if <span style="font-weight: bold;">NETGENROOT</span>
 684 environment varible is set.<br>
 685 Set <span style="font-weight: bold;">NETGENROOT</span>
 686 environment
 687 variable if you have preinstalled version
 688 of netgen mesher.<br>
 689 <span style="font-weight: bold;">Note: </span>netgen 4.5 provided with
 690 the SALOME installation Wizard has been patched to improve its
 691 performance.<br>
 692 <ul>
 693   <li>Numeric 23.7</li>
 694 </ul>
 695 Version number is checked by <span style="font-weight: bold;">python
 696 -c
 697 'import Numeric; print Numeric.__version__'</span> command. <span
 698  style="font-weight: bold;">python</span> executable should be in the <span
 699  style="font-weight: bold;">PATH</span>
 700 environment variable and <span style="font-weight: bold;">Numeric</span>
 701 module should be avaible for the Python (for example it should be in
 702 the <span style="font-weight: bold;">PYTHONPATH</span> environment
 703 variable). Version number should be equal to "23.7". If you have
 704 problem with preinstalled version of Numeric 23.7, please,
 705 reinstall it.<br>
 706 Add the directory where&nbsp;<span style="font-weight: bold;"></span>you
 707 have preinstalled version of Numeric
 708 package to the <span style="font-weight: bold;">PYTHONHOME </span>environment
 709 variable.<br>
 710 <ul>
 711   <li>graphviz 2.2.1</li>
 712 </ul>
 713 Version number is checked by <span style="font-weight: bold;">dot -V</span>
 714 command. <span style="font-weight: bold;">dot</span> executable should
 715 be in the <span style="font-weight: bold;">PATH</span>
 716 environment variable. Version number should be equal to "2.2.1".<br>
 717 Add <span style="font-weight: bold;">graphviz</span> bin directory to
 718 the <span style="font-weight: bold;">PATH</span> environment variable.<br>
 719 <ul>
 720   <li>doxygen 1.4.6</li>
 721 </ul>
 722 Version number is checked by <span style="font-weight: bold;">doxygen
 723 --version</span> command. <span style="font-weight: bold;">doxygen</span>
 724 executable
 725 should be in the <span style="font-weight: bold;">PATH</span>
 726 environment variable. Version number should be equal to "1.4.6".<br>
 727 <ul>
 728   <li><span style="font-weight: bold; color: rgb(0, 0, 153);">SALOME </span>module
 729     <span style="font-weight: bold;"></span><span
 730  style="font-weight: bold; color: rgb(0, 0, 153);">sources</span>
 731 (3.2.4).</li>
 732 </ul>
 733 For each SALOME module sources package (KERNEL, GUI, GEOM, etc...) root
 734 directory contains file configure.in (configure.ac) which defines
 735 version
 736 information.<br>
 737 Set <span style="font-weight: bold;">&lt;MODULE&gt;_SRC_DIR</span>
 738 environment variable for each SALOME <span style="font-weight: bold;">MODULE</span>
 739 sources package installed (where <span style="font-weight: bold;">MODULE</span>
 740 is KERNEL, GUI, GEOM, ...).<br>
 741 <ul>
 742   <li><span style="font-weight: bold; color: rgb(0, 0, 153);">SALOME </span>module
 743     <span style="font-weight: bold;"></span><span
 744  style="font-weight: bold; color: rgb(0, 0, 153);">binaries </span>(3.2.4)</li>
 745 </ul>
 746 For each SALOME module binaries package (KERNEL, GUI, GEOM, etc...) <span
 747  style="font-weight: bold;">bin/salome</span> directory contains file <span
 748  style="font-weight: bold;">VERSION</span> which defines version
 749 information.<br>
 750 Set <span style="font-weight: bold;">&lt;MODULE&gt;_ROOT_DIR</span>
 751 environment variable for each SALOME <span style="font-weight: bold;">MODULE</span>
 752 binaries package installed (where <span style="font-weight: bold;">MODULE</span>
 753 is KERNEL, GUI, GEOM, ...).<br>
 754 <p><b></b>If you have native products installed to different from
 755 default
 756 directories (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is
 757 recommended to follow above mentioned instructions. Or you should
 758 properly set <span style="font-weight: bold;">PATH</span> and <span
 759  style="font-weight: bold;">LD_LIBRARY_PATH</span> variables <b><font
 760  color="#ff0000">before</font></b>
 761 starting the Installation Wizard. Otherwise
 762 the installation script will fail to find preinstalled/native products.
 763 </p>
 764 <p><b>Note:</b> for some native products (e.g. gcc, Python) the rules
 765 of version
 766 checking are not so strict as described in the table. Only major and
 767 minor numbers of version
 768 should coincide with prerequisite. Newer version of the product can be
 769 used also. If some native product has version number larger than that
 770 required by
 771 the
 772 installation procedure, user will be prompted by the warning message
 773 like this: <i>"You have
 774 newer version of gcc installed
 775 on your computer than that is required (3.4.1). Continue?"</i>. You can
 776 press <i>"Yes"</i> button
 777 to proceed with the installation but in this case you should be aware
 778 of what you are doing.
 779 SALOME binaries (including other products) are compiled with the
 780 predefined prerequisites
 781 and most likely can not be run successfully if these products are not
 782 found.
 783 This can be helpful only if you plan to build all products from
 784 sources. <br>
 785 </p>
 786 <h3>
 787 <hr></h3>
 788 <h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
 789 Please, read carefully the following information. This section
 790 describes how the installation procedure generates the environment
 791 scripts for the SALOME platform being installed.
 792 <p>After installing of each product shell the script creates special
 793 environment file for the product in its installation folder. The name
 794 of
 795 the file is generated
 796 from
 797 the name of product by the following scheme: <b>env_&lt;product_name&gt;.sh</b>
 798 (for example <b>env_Vtk.sh </b>for the Vtk).
 799 This file includes all necessary environment settings. At the final
 800 step of the installation the script picks up all the
 801 settings files and generate from them two common environment files: <b>salome.sh</b>
 802 and <b>salome.csh
 803 </b>for <span style="font-weight: bold;">bash</span> and <span
 804  style="font-weight: bold;">csh</span> shells correspondingly. Such
 805 approach helps to save time
 806 when reinstalling products and you may not to care about setting all
 807 environment variables
 808 manually to build/launch SALOME. What you need is just to source one of
 809 these
 810 environment files. </p>
 811 <p>This concerns also those products which are not being installed.
 812 For example, you install some SALOME binaries to the directory where
 813 you have previously installed other products.&nbsp; Installation
 814 procedure tries to collect environment files from the target
 815 directory if it finds necessary products installed there. If some
 816 product is not
 817 found in the target directory the corresponding
 818 section of <b>salome.sh/salome.csh</b> files will be skipped. <br>
 819 For native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>
 820 installation procedure tries to find them first using <b>PATH</b>
 821 / <b>LD_LIBRARY_PATH</b> variables and then in the system default
 822 directories (<b>/usr/bin, /usr/lib</b> etc., depending on the product).
 823 </p>
 824 <p>In any case you may edit <b>salome.*</b> files after installation
 825 procedure finishes, if you want.<br>
 826 <span style="font-weight: bold;"><br>
 827 Note:</span> as it was mentioned <a href="#env_files">above</a> there
 828 are another environment files which
 829 are generated by the installation procedure: <span
 830  style="font-weight: bold;">env_products.csh</span> + <span
 831  style="font-weight: bold;">env_products.sh</span> and <span
 832  style="font-weight: bold;">env_build.csh</span> + <span
 833  style="font-weight: bold;">env_build.sh</span>. These files can be
 834 found in the target installation root directory.<br>
 835 </p>
 836 <hr>
 837 <h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font>
 838 configuration <font color="#ff0000">file</font></h3>
 839 <font color="#000000">You can create your own XML configuration file.
 840 The Installation Wizard then can take it as command line argument to
 841 provide list of products you want to install with it. The list of
 842 products and some another settings for the Installation Wizard are
 843 provided in the XML file. The default file which Installation Wizard
 844 looks
 845 for if no command line arguments are given, is <b>config.xml</b>.<br>
 846 This
 847 section describes the structure of the configuration file.</font> <br>
 848 <font color="#000000">XML tags are in bold blue, optional sections/tags
 849 are in brackets.</font>
 850 <font face="Courier">
 851 <p><b><font color="#000099">&lt;document&gt;</font></b>
 852 <br>
 853 <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[</font><b><font
 854  color="#000099"> &lt;config</font></b><font color="#000000">
 855 [ version=&lt;install_wizard_version&gt; ]</font> <br>
 856 <font color="#000000">&nbsp;&nbsp;&nbsp; &nbsp;
 857 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [
 858 caption=&lt;install_wizard_caption&gt; ]</font> <br>
 859 <font color="#000000">&nbsp;&nbsp;&nbsp; &nbsp;
 860 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [
 861 copyright=&lt;install_wizard_copyright&gt;&nbsp; ]</font> <br>
 862 <font color="#000000">&nbsp;&nbsp;&nbsp; &nbsp;
 863 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [
 864 license=&lt;install_wizard_license_info&gt; ]</font> <br>
 865 <font color="#000000">&nbsp;&nbsp;&nbsp; &nbsp;
 866 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [ os=&lt;target_platform&gt;
 867 ]</font><b><font color="#000099"><br>
 868 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /&gt;</font></b><font color="#000000"> <br>
 869 &nbsp;&nbsp;&nbsp; ]</font> <br>
 870 <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[ </font><b><font
 871  color="#000099">&lt;path</font></b><font color="#000000">&nbsp;&nbsp;
 872 [ targetdir=&lt;target_directory&gt; ]</font> <br>
 873 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 874 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 875 [ tempdir=&lt;temp_directory&gt;&nbsp;&nbsp;&nbsp;&nbsp; ]</font><b><font
 876  color="#000099"><br>
 877 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /&gt; </font></b><font color="#000000"><br>
 878 &nbsp;&nbsp;&nbsp; ]</font> <br>
 879 <font color="#000000"><b>&nbsp;&nbsp;&nbsp; </b>[ </font><b><font
 880  color="#000099">&lt;button</font></b><font color="#000000">
 881 &nbsp; label=&lt;button_label&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</font> <br>
 882 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 883 &nbsp;&nbsp;&nbsp;&nbsp;
 884 [ tooltip=&lt;button_tooltip&gt; ]</font> <br>
 885 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 886 &nbsp;&nbsp;&nbsp;&nbsp;
 887 &nbsp; script=&lt;button_script&gt;&nbsp;&nbsp;&nbsp;</font> <br>
 888 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 889 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 890 [ disable=&lt;disable_flag&gt;&nbsp;&nbsp;&nbsp;]</font><b><font
 891  color="#000099"><br>
 892 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /&gt; </font></b><font color="#000000"><br>
 893 &nbsp;&nbsp;&nbsp; ]</font> <br>
 894 <font color="#000000">&nbsp;&nbsp;&nbsp; [</font><b><font
 895  color="#000099"> &lt;button</font></b><font color="#000000"> ... </font><font
 896  color="#000099"><br>
 897 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /<b>&gt;</b></font><br>
 898 <font color="#000000">&nbsp;&nbsp;&nbsp; ]</font> <br>
 899 <font color="#000000">&nbsp;&nbsp;&nbsp; [</font><b><font
 900  color="#000099"> &lt;product</font></b><font color="#000000">&nbsp;
 901 name=&lt;product_name&gt;</font> <br>
 902 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 903 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 904 version=&lt;product_version&gt;</font> <br>
 905 &nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp;&nbsp; [
 906 context=&lt;product_context&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 907 ]<br>
 908 &nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp;&nbsp; [
 909 description=&lt;product_description&gt; ]<br>
 910 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 911 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 912 install=&lt;installation_mode&gt;</font> <br>
 913 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 914 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 915 supported=&lt;supported_installation_modes&gt;</font> <br>
 916 <font color="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 917 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [ disable=&lt;disable_flag&gt;
 918 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]<br>
 919 &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp;&nbsp; [
 920 pickupenv=&lt;pickup_env_flag&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ]</font><font
 921  color="#000000"><br>
 922 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 923 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 924 dependancies=&lt;list_of_prerequisites&gt;</font>&nbsp;<font
 925  color="#000000"><br>
 926 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 927 &nbsp;&nbsp;&nbsp;&nbsp; installdiskspace=&lt;install_disk_space&gt;</font>
 928 <font color="#000000"><br>
 929 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 930 &nbsp;&nbsp;&nbsp; temporarydiskspace=&lt;tmp_disk_space&gt;</font> <font
 931  color="#000000"><br>
 932 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
 933 &nbsp;&nbsp; script=&lt;installation_script_name&gt;</font><font
 934  color="#000099"><br>
 935 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /<b>&gt;</b></font><font color="#000000">
 936 <br>
 937 &nbsp;&nbsp;&nbsp; ]</font> <font color="#000000"><br>
 938 &nbsp;&nbsp;&nbsp; [</font><b><font color="#000099"> &lt;product</font></b><font
 939  color="#000000"> ... </font><font color="#000099"><br>
 940 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /<b>&gt;</b></font><font color="#000000">
 941 <br>
 942 &nbsp;&nbsp;&nbsp; ]</font><br>
 943 <font color="#000000">&nbsp;&nbsp;&nbsp; ...</font><br>
 944 <b><font color="#000099">
 945 &lt;/document&gt;</font></b> </p>
 946 </font>
 947 <h4><font color="#000000">&lt;config&gt; section</font></h4>
 948 <font color="#000000">This is optional section; it provides general
 949 information about Installation Wizard itself.<br>
 950 <br>
 951 Attributes:<br>
 952 </font>
 953 <ul>
 954   <li> <font color="#000000"><b>version</b></font></li>
 955 </ul>
 956 <font color="#000000">The application version number to be shown in the
 957 caption.</font>
 958 <ul>
 959   <li> <font color="#000000"><b>caption</b></font></li>
 960 </ul>
 961 <font color="#000000">The application main window caption - if this
 962 string contains '%1' text the title will
 963 contain
 964 in this place the version number (see above).</font>
 965 <ul>
 966   <li> <font color="#000000"><b>copyright</b></font></li>
 967 </ul>
 968 <font color="#000000">The application
 969 copyright information (shown in the first page).</font>
 970 <ul>
 971   <li> <font color="#000000"><b>license</b></font></li>
 972 </ul>
 973 <font color="#000000">The application license information (shown in the
 974 first page).</font>
 975 <ul>
 976   <li> <font color="#000000"><b>os</b></font></li>
 977 </ul>
 978 <font color="#000000">This parameter defines the directory (relative
 979 from ./Products/BINARIES) where the Installation Wizard will
 980 search precompiled binaries packages. If this tag is not provided,
 981 binaries packages are looked for in
 982 the ./Products/BINARIES directory.</font>
 983 <h4> <b><font color="#000000">&lt;path&gt; section</font></b></h4>
 984 This is optional section; it defines default installation directories.<br>
 985 <font color="#000000"><br>
 986 Attributes:</font><br>
 987 <ul>
 988   <li> <font color="#000000"><b>targetdir</b></font></li>
 989 </ul>
 990 <font color="#000000">The target
 991 directory - the path to the directory where products should be
 992 installed.</font>
 993 <ul>
 994   <li> <font color="#000000"><b>tempdir</b></font></li>
 995 </ul>
 996 <font color="#000000">The temporary directory -
 997 the path to the directory for the temporary files.</font>
 998 <h4> <b>&lt;product&gt; section</b></h4>
 999 This section describes product to be installed with the Installation
1000 Wizard. XML file should include &lt;product&gt; section for each
1001 product to be installed. The products appear in the tree view
1002 and are installed in the order they are described in the configuration
1003 file. It is recommended (but not obligatory) to define native products
1004 at the top of the
1005 list before all other products.<br>
1006 <font color="#000000"><br>
1007 Attributes:</font><br>
1008 <ul>
1009   <li> <font color="#000000"><b>name</b></font></li>
1010 </ul>
1011 <font color="#000000">The name of the product.</font>
1012 <ul>
1013   <li> <font color="#000000"><b>version</b></font></li>
1014 </ul>
1015 <font color="#000000">The version of the product.</font>
1016 <ul>
1017   <li> <font color="#000000"><b>description</b></font></li>
1018 </ul>
1019 The <font color="#000000">product </font><font color="#000000">description
1020 (optional).</font>
1021 <ul>
1022   <li> <font color="#000000"><b>context</b></font></li>
1023 </ul>
1024 <font color="#000000">Context (optional). The possible values are <b>'salome
1025 sources'</b>, <b>'salome
1026 binaries'</b> and <b>'prerequisite'</b> (several context can be given
1027 separated by ":" symbol).</font>
1028 <ul>
1029   <li> <font color="#000000"><b>supported</b></font></li>
1030 </ul>
1031 <font color="#000000">Supported modes of
1032 installation. Several modes can be separated by comma. Possible value
1033 are: <i>install sources</i>, <i>install binaries</i>, <i>use
1034 native</i>. Installation script should contain the corresponding
1035 functions
1036 for each of the supported installation modes (see <a
1037  href="#new_products">here</a>).</font>
1038 <ul>
1039   <li> <font color="#000000"><b>install</b></font></li>
1040 </ul>
1041 <font color="#000000">Default (starting)
1042 installation mode.</font>
1043 <ul>
1044   <li> <font color="#000000"><b>disable</b></font></li>
1045 </ul>
1046 <font color="#000000">If this optional flag has 'true'
1047 value, the corresponding product will not appear in the list of
1048 products and will not be installed.</font>
1049 <ul>
1050   <li><b>pickupenv</b></li>
1051 </ul>
1052 This flag points that pickup environment
1053 procedure
1054 should be performed for this product. If this flag equal to 'true',
1055 &nbsp;salome.sh
1056 and salome.csh files will&nbsp; be created in the product's
1057 installation
1058 directory. Usually this option is set to true for SALOME KERNEL module
1059 sources and binaries package. This is optional key, default value is
1060 'false'<b>.</b><br>
1061 <ul>
1062   <li> <font color="#000000"><b>dependancies</b></font></li>
1063 </ul>
1064 <font color="#000000">List of prerequisite
1065 products, which are necessary to build this product, separated by comma.</font>
1066 <ul>
1067   <li> <font color="#000000"><b>installdiskspace</b></font></li>
1068 </ul>
1069 <font color="#000000">Total amount
1070 space (integer, in Kbytes), which product occupies on the hard drive
1071 after the
1072 installation.</font>
1073 <ul>
1074   <li> <font color="#000000"><b>temporarydiskspace</b></font></li>
1075 </ul>
1076 <font color="#000000">Disk space
1077 (integer, in Kbytes) for the temporary files, which is necessary to
1078 build the product from the sources.</font>
1079 <ul>
1080   <li> <font color="#000000"><b>script</b></font></li>
1081 </ul>
1082 <font color="#000000">The installation script name.
1083 This script is in charge of the installation of the product. It is
1084 called
1085 automatically by the Installation Wizard when necessary from the main
1086 program. See the <a href="#new_products">next
1087 section</a> for
1088 more information.</font><br>
1089 <h4> <b>&lt;button&gt; section</b></h4>
1090 This is optional section. It allows customing of the last <i>"Finish
1091 installation"</i> page of the Installation Wizard by adding one or
1092 more buttons in the lower part of the wizard's window. The script
1093 which is attached to each such button, can perform some specific
1094 action, for example, launch the application or show the Release Notes
1095 file by using external program.
1096 See <a href="#finish_buttons">here</a> for more details about
1097 writing scripts.<br>
1098 <font color="#000000"><br>
1099 Attributes:</font><br>
1100 <ul>
1101   <li> <font color="#000000"><b>label</b></font></li>
1102 </ul>
1103 <font color="#000000">This is the button text.</font>
1104 <ul>
1105   <li> <font color="#000000"><b>tooltip</b></font></li>
1106 </ul>
1107 <font color="#000000">The button's tooltip (optional).</font>
1108 <ul>
1109   <li> <font color="#000000"><b>script</b></font></li>
1110 </ul>
1111 <font color="#000000">The script attached to the button.</font>
1112 <ul>
1113   <li> <font color="#000000"><b>disable</b></font></li>
1114 </ul>
1115 <font color="#000000">If this optional flag has 'true'
1116 value, the corresponding button will not appear in the <i>"Finish
1117 installation"</i> page - the section of XML file is silently
1118 ignored.</font><br>
1119 <br>
1120 <b>Note:</b> If you add new products to be
1121 installed with Installation Wizard, you should also provide
1122 installation script for this product. See the next section for more
1123 details.
1124 <p><br>
1125 </p>
1126 <hr>
1127 <h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
1128 scripts</font> for the new products</h3>
1129 When you want some product to be installed with the Installation
1130 Wizard, you should add it's description it <a href="#xml_files">in the
1131 configuration file</a> and create the installation script, following
1132 rules described in this section. <br>
1133 <br>
1134 There are some obligatory functions which should be implemented in this
1135 installation
1136 script. These functions are automatically called by master installation
1137 script
1138 or/and its GUI shell when it is necessary.<br>
1139 <font color="#000000">File <b>common.sh</b> contains some service
1140 functions
1141 which can be used in your installation script, like <b>make_env()</b>,<b>
1142 make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b>
1143 find_in_path()</b>,
1144 etc.</font>
1145 <ul>
1146   <li> <b>check_version()</b></li>
1147 </ul>
1148 This function allows to check the
1149 version of the product already installed on the computer. It should try
1150 to find product (native or preinstalled in the target directory) and
1151 check
1152 its version. This helps to avoid unnecessary reinstallation. This is
1153 internal
1154 function and is not called from the master installation script.<br>
1155 <ul>
1156   <li> <b><font color="#000000">try_native()</font></b></li>
1157 </ul>
1158 <font color="#000000">This function is
1159 called when <i>'use native' </i>installation mode is selected by the
1160 user. The function should try to find native version of the product and
1161 define possibility of its usage. It should create the environment file
1162 for the
1163 product in the temporary directory (see also description of <b>print_env(</b>)
1164 function). I</font><font color="#000000">t is not necessary to
1165 implement
1166 this function i</font><font color="#000000">f you do not provide native
1167 mode. installation.<br>
1168 </font>
1169 <ul>
1170   <li> <font color="#000000"><b>install_source()</b></font></li>
1171 </ul>
1172 <font color="#000000">This function is
1173 called when <i>'install sources</i>' installation mode is selected by
1174 the
1175 user. The function is responsible for the building of the product from
1176 the
1177 sources package. It should create the environment file for the product
1178 in the
1179 temporary
1180 directory (see also description of <b>print_env(</b>) function). </font><font
1181  color="#000000">I</font><font color="#000000">t is not necessary to
1182 implement
1183 this function i</font><font color="#000000">f you do not provide </font><font
1184  color="#000000">sources mode installation.</font>
1185 <br>
1186 <ul>
1187   <li> <font color="#000000"><b>install_source_and_build()</b></font></li>
1188 </ul>
1189 <font color="#000000">This function is
1190 called when SALOME module is installed and the <span
1191  style="font-weight: bold;">--all-from-sources</span> (<span
1192  style="font-weight: bold;">-a</span>) option is used (<span
1193  style="font-style: italic;">"Build SALOME sources"</span> check box in
1194 GUI mode). This function should be used to unpack SALOME sources
1195 package and then call build/install procedure for it.<br>
1196 For more details please refer to the <a href="#install_from_wizard">this</a>
1197 and <a href="#gui_mode">this</a> sections for more details.<br>
1198 </font>
1199 <ul>
1200   <li><font color="#000000"><b>install_binary()</b></font></li>
1201 </ul>
1202 <font color="#000000">This function is
1203 called when <i>'install binaries'</i> installation mode is selected by
1204 the
1205 user. The function is responsible for the extracting of the product
1206 from
1207 the binaries package. It should create environment for the product in
1208 the
1209 temporary
1210 directory (see also description of <b>print_env(</b>) function).</font><font
1211  color="#000000"> I</font><font color="#000000">t is not necessary to
1212 implement
1213 this function i</font><font color="#000000">f you do not provide </font><font
1214  color="#000000">binaries</font><font color="#000000"> mode
1215 installation.</font><font color="#000000"> <br>
1216 </font>
1217 <ul>
1218   <li> <b>try_preinstalled()</b></li>
1219 </ul>
1220 <font color="#000000">This function
1221 is called when<i> 'not install'</i> installation mode is selected by
1222 the user. In this case script should inspect target directory to try to
1223 find already preinstalled product, pick up and check environment from
1224 there. See <a href="#pick_up_env">here</a> for more details.</font>
1225 <ul>
1226   <li> <font color="#000000"><b>print_env()</b></font></li>
1227 </ul>
1228 <font color="#000000">This function is in
1229 charge of creation environment script. It should create file with name </font><b>env_&lt;product_name&gt;.sh</b>
1230 in the temporary directory and then copy it into the product
1231 installation directory. The file should contain all necessary
1232 environment variables settings for the product. It will be collected
1233 during the 'pick-up-environment' procedure.
1234 <ul>
1235   <li><b>pickup_env()</b></li>
1236 </ul>
1237 This procedure corresponds <b>pickupenv</b>
1238 tag
1239 of the configuration xml file (see previous section). It should call <b>make_env</b>
1240 procedure to perform pick-up environment procedure for the product.<br>
1241 <br>
1242 <font color="#000000">The calling signature of the product installation
1243 script is the following:</font> <br>
1244 <b><font color="#000000">&lt;product_script_name&gt;
1245 &lt;function_name&gt; &lt;temp_folder&gt; &lt;products_directory&gt;
1246 &lt;target_directory&gt;
1247 &lt;dependancies&gt; &lt;product_name&gt;</font></b>
1248 <p><font color="#000000">where</font> <br>
1249 </p>
1250 <p><font color="#000000"><b>&lt;product_script_name&gt;</b> -
1251 installation
1252 script name (described in configuration xml file);</font> <br>
1253 <font color="#000000"><b>&lt;function_name&gt;</b> - the name of
1254 function, corresponding to the selected installation mode: <i>try_native,
1255 install_source, install_binary</i> or <i>try_preinstalled</i>;</font> <br>
1256 <font color="#000000"><b>&lt;temp_folder&gt;</b> - temporary files
1257 directory;</font> <br>
1258 <font color="#000000"><b>&lt;products_directory&gt;</b> - directory
1259 where the sources/binaries package can be found. You should provide
1260 sources package in the <i>&lt;Install_Wizard_root_directory&gt;/Products/SOURCES</i>
1261 directory and binaries package in the <i>&lt;InstallWizard_root_directory&gt;/Products/BINARIES/&lt;os_version&gt;</i>,
1262 where &lt;os_version&gt; is target platform description, which appears
1263 in the corresponding section of the <a href="#xml_files">configuration
1264 xml
1265 file</a>.</font> <br>
1266 <font color="#000000"><b>&lt;target_directory&gt;</b> - root target
1267 directory where product should be installed to;</font> <br>
1268 <font color="#000000"><b>&lt;dependancies&gt;</b> - single-quoted list
1269 of prerequisite products, separated by space;</font> <br>
1270 <font color="#000000"><b>&lt;product_name&gt; </b>- product name
1271 itself.</font> </p>
1272 <p><font color="#000000">Example:</font> <br>
1273 <i><font color="#000000">med-2.2.3.sh install_binary /tmp/work
1274 ./Products/BINARIES/Mandrake10.1 /usr/salome 'gcc Hdf' med</font></i> </p>
1275 <p><font color="#000000">Copy created script into the <i>&lt;Install_Wizard_root_directory&gt;/config_files</i>
1276 sub-directory where all installation scripts are stored. Installation
1277 Wizard
1278 will automatically search and call your script during the installation
1279 procedure.</font>
1280 </p>
1281 <hr> <br>
1282 <h3><a name="finish_buttons"></a>Customizing <font color="#ff0000">Readme
1283 page</font> buttons</h3>
1284 The Installation Wizard allows customizing the look-n-feel of the last
1285 <i>"Finish installation"</i> page. If you want to add one or more
1286 buttons to this page in order to perform some specific actions at the
1287 end of the installation (for example, show Release Notes file by using
1288 Open Office) you can put an additional section to the XML
1289 configuration file. This is the <b>&lt;button&gt;</b> section (see <a
1290  href="#xml_files">here</a> for more details).
1291 <p><br>
1292 </p>
1293 To implement the action which will be performed when the user click on
1294 the button, you need to create a script and put it to the
1295 <i>&lt;Install_Wizard_root_directory&gt;/config_files</i> directory.<br>
1296 There are some obligatory functions which should be implemented in this
1297 script. These functions are automatically called by the Installation
1298 Wizard GUI.
1299 <ul>
1300   <li><b>check_enabled()</b></li>
1301 </ul>
1302 This procedure is called by the Installation Wizard when the
1303 <i>"Finish installation"</i> page is displayed and the status of the
1304 buttons should be modified according to the installation options. This
1305 procedure should return <b>0</b> if the corresponding action can be
1306 performed and, thus, the button should become enabled. Otherwise, it
1307 should return <b>1</b> - in this case the corresponding button will be
1308 disabled.
1309 <ul>
1310   <li><b>execute()</b></li>
1311 </ul>
1312 This procedure is invoked when the user clicks the button. This
1313 procedure should return <b>0</b> if the corresponding action is done
1314 successfully and <b>1</b> if any error occurs.<br>
1315 <br>
1316 The calling signature of the script is the following:<br>
1317 <b><font color="#000000">&lt;product_script_name&gt;
1318 &lt;function_name&gt; &lt;target_directory&gt; &lt;temp_folder&gt;</font></b>
1319 <p><font color="#000000">where</font> <br>
1320 </p>
1321 <p><font color="#000000"><b>&lt;product_script_name&gt;</b> -
1322 the script name itself (retrieved from the XML configuration xml
1323 file);</font> <br>
1324 <font color="#000000"><b>&lt;function_name&gt;</b>
1325 - the name of function;</font> <br>
1326 <font color="#000000"><b>&lt;target_directory&gt;</b> - root target
1327 directory where product are
1328 installed to;</font> <br>
1329 <font color="#000000"><b>&lt;temp_folder&gt;
1330 </b> - temporary files directory;</font> <br>
1331 <br>
1332 <b>Note:</b> The standard Installation Wizard buttons "Launch
1333 SALOME" and "Release Notes" are implemented with this
1334 feature. Refer to the scripts <b>start_salome.sh</b> and
1335 <b>release_notes.sh</b> for sample implementation.<br>
1336 <br>
1337 <b>Note:</b> Any button (even standard) can be ignored by the
1338 Installation Wizard if the attribute <b>&lt;disable&gt;</b> in the XML
1339 configuration file is set to the "true" value.
1340 </p>
1341 <hr><br>
1342 </body>
1343 </html>