<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
-
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
-
<meta name="GENERATOR"
content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">
-
<meta name="Author"
- content="Vadim SANDLER (v-sandler@opencascade.com)">
- <title>SALOME v2.2.0 Installation Wizard Help</title>
+ content="Vadim SANDLER, Open CASCADE SAS (vadim.sandler@opencascade.com)">
+ <meta name="Copyright" content="2002-2006 CEA">
+ <title>SALOME Installation Wizard Help</title>
</head>
- <body style="color: rgb(0,0,0); background-color: rgb(255,255,229);"
- link="#0000ee" vlink="#551a8b" alink="#ff0000">
-
-<center>
-<table width="100%" nosave="">
- <tbody>
- <tr nosave="">
- <td nosave="">
+<body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 229);"
+ alink="#ff0000" link="#0000ee" vlink="#551a8b">
+
+<center>
+<table nosave="" width="100%">
+ <tbody>
+ <tr nosave="">
+ <td nosave="">
<h1><a href="http://www.opencascade.com"><img src="logocorp.png"
- border="0" height="47" width="139">
- </a></h1>
- </td>
- <td>
- <center>
- <h1><font size="+4"><font color="#000099">SALOME Installation Wizard
- Help</font> </font></h1>
- </center>
- </td>
- <td>
+ border="0" height="47" width="139"> </a></h1>
+ </td>
+ <td>
+ <center>
+ <h3><font size="+4"><font color="#000099">SALOME Installation
+Wizard Help</font></font></h3>
+ </center>
+ </td>
+ <td>
<div align="right"><a href="http://www.opencascade.org/SALOME/"><img
- src="application.png" border="0" height="47" width="109">
- </a></div>
- </td>
- </tr>
-
- </tbody>
+ src="application.png" border="0" height="47" width="109"> </a></div>
+ </td>
+ </tr>
+ </tbody>
</table>
- </center>
-
-<div align="right"><b><font color="#000099">updated for the version 2.2.0</font></b></div>
-
-<hr>
-<ul>
- <li> <a href="#install_from_wizard">Installing products with the Installation
- Wizard</a></li>
- <li> <a href="#check_version_proc">Notes on check products version procedure</a></li>
- <li> <a href="#pick_up_env">Pick up the environment</a></li>
- <li> <a href="#xml_files">Modifying XML configuration file</a></li>
- <li> <a href="#new_products">Implementing installation scripts for the
- new products</a></li>
-
-</ul>
-
-<h3>
+</center>
+<div align="right"><b><font color="#000099">updated for the version </font><font
+ color="#ff0000">3.2.4</font></b></div>
+<hr>
+<ul>
+ <li> <a href="#install_from_wizard">Installing products with the
+Installation Wizard<br>
+ </a></li>
+ <ul>
+ <li><a href="#gui_mode">GUI mode</a></li>
+ <li><a href="#batch_mode">Batch mode</a></li>
+ <li><a href="#env_files">Environment files</a><br>
+ </li>
+ </ul>
+ <li> <a href="#check_version_proc">Notes on check products version
+procedure</a></li>
+ <li> <a href="#pick_up_env">Pick up the environment</a></li>
+ <li> <a href="#xml_files">Modifying XML configuration file</a></li>
+ <li> <a href="#new_products">Implementing installation scripts for
+the new products</a></li>
+ <li> <a href="#finish_buttons">Customizing Readme page buttons</a></li>
+</ul>
+<h3>
<hr></h3>
-
<h3> <a name="install_from_wizard"></a>Installing products with the <font
color="#ff0000">Installation Wizard</font></h3>
- You can run the Installation Wizard in two modes. It's root directory contains
- python script runInstall.py:
-<p><b>[ python ] runInstall [ -g | b ] [ -f <xml-file> ] [ -t <target-dir>
- ] [ -tmp <tmp-dir> ]</b> </p>
-
-<p><b>-g</b><br>
- Runs the Installation Wizard in the GUI
-mode. In this case only <xml-file> key is taken into account. This
-option is used by default. <br>
- <b>-b</b><br>
- Runs the Installation Wizard in the batch
-mode. <br>
- <b>-f <xml-file></b><br>
- The configuration file to be used by the
-Installation Wizard. If this parameter is missed then the script tries
-to define the <i>Red Hat </i>version and uses corresponding xml file. For
-examle, for the <i>Red Hat 8.0</i> <b>config_RedHat8_0.xml</b> file
-is supposed to be used by default. If the appropriate file is not found, <b>config.xml</b>
-is used by default. <br>
- <b>-t <target-dir></b><br>
- The target directory, SALOME products to
-be installed to. If used, overloads target directory, given in the configuration
-xml file. <br>
- <b>-tmp <tmp-dir></b><br>
- The directory, which is used to contain
- temporary files. If used, overloads temporary directory, given in the
-configuration xml file.<br>
-<b>-h</b><br>
- Prints help information. <br>
- </p>
-
-<p>So, to run the Installation Wizard in the GUI mode, just type <b>runInstall</b>.
- </p>
-
-<p>The installation procedure can support some different Linux platforms
-(currently it provides only configuration scripts for <i>RedHat-8.0</i>)
-and various number of products. <br>
- The using of configuration xml files gives flexible way to modify the list
-of products to be installed by the Installation Wizard without changing program's
-source code. Just create your own configuration file and implement installation
-scripts for products you want to be provided by Wizard. See <a
- href="#xml_files">modifying XML configuration file</a> and <a
- href="#new_products">implementing installation scripts for the new products</a>
-for more information. </p>
-
-<p>The <font color="#ff0000">Installation Wizard</font> was built with using
-of the <b><i>Qt </i></b>library. The program contains several pages.
-To navigate between pages use <i>"Next"</i> and <i>"Back"</i> buttons in the
-lower part of the wizard window. <i>"Cancel"</i> button closes dialog window
-and quits the installation procedure. To invoke this help information click
-<i>"Help"</i> button. </p>
-
-<p>Skip the first <i>"Introduction"</i> page by pressing <i>"Next"</i> button.
- </p>
-
-<p>In the second page you are proposed to enter the target directory where
- all selected products will be installed to. You can also press <i>"Browse..."</i>
- button and choose the folder for installation using standard <b><i>Qt</i></b>
- browse directory dialog box. <br>
- If the directory you want to install products does not exist you will be
-prompted to confirm directory creation. If you type wrong directory path,
-or if you have no permission for the directory you use, the corresponding
- message box will raise. </p>
-
-<p>The Installation Wizard has two modes of the installation: basic and advanced.
-In the basic mode it is necessary just to enter target directory. If you want
-to use advanced mode, click <i>"More..."</i> button. </p>
-
-<p>In the advanced mode you have the possibility to select products to be
-installed (see <a href="#ProductPage">Fig.1</a> ). Each product can have several
-options of installation: you have a possibility to use native products, install
-already precompiled binaries, build product from the sources or not install it
-at all. Possible options and default choice are provided by the configuration
-file. You can mark the products, you want to install, by clicking the corresponding
-radiobuttons in the list view in the left part of the page. Note that some
-products can be installed only together with other products (or these prerequisite
-products should be already installed on your computer). The installation procedure
-has a special feature to automatically mark these products in the list view.
-For example, in order to install <b><i>pyqt</i></b> it's necessary to have
-<b><i>gcc, python</i></b>,<b><i> qt</i></b> and <b><i>sip</i></b> installed.
-Therefore all these products will be marked when you check on <b><i>pyqt</i></b>.
-This feature can be switched off by clicking <i>"Auto set prerequisites products"</i>
- checkbox. <br>
- Special button in the right part of the page - <i>"Unselect All" </i>-
-allows to reset quickly all products to the <i>"not install"</i> state. <br>
- If you want to use native Linux Red Hat 8.0 products (these are gcc, tcl,
-Python, Qt, Sip and PyQt), select <i>"use native" </i>option. </p>
-
-<p>The box at the right side of the page displays the information about currently
-highlighted product: name, version, short description (if provided), required
-disk space, temporary files disk space, list of prerequisites and user choice.
-</p>
-
-<center><a name="ProductPage"></a><br>
- <img src="productpage.png" height="558" width="599" alt="">
-
-<p><b>Figure 1:</b> "Installation settings" page in the advanced mode</p>
- </center>
-
-<p>The <i>"Total disk space required:"</i> field displays how much disk space
-on the hard drive is required for installation of selected products. <br>
- <b>Note: </b>Please, take into account that displayed amount of required
- disk space is approximate and may differ when you install products on your
- hard drive. </p>
-
-<p>Installation procedure uses a special directory to store temporary files.
- The <i>"Space for temporary files:"</i> field shows the information about
- required disk space on the hard drive for extracting and compiling of the
- selected products. You can change the default directory - just type path
+The Installation Wizard can be launched in two modes: <span
+ style="font-weight: bold;">GUI </span>and <span
+ style="font-weight: bold;">batch</span>. <br>
+The root directory of the Installation Wizard
+contains Python script <span style="font-weight: bold;">runInstall</span>.
+To run the Installation Wizard just type <b>runInstall</b> in the
+terminal
+window:<span style="font-weight: bold;"></span><span
+ style="font-weight: bold;"></span>
+<p>[ python ] <b>runInstall </b>[options]<b><br>
+</b></p>
+<p>Without options this script will launch the SALOME Installation
+Wizard in the default mode (GUI).<br>
+The default installation settings can be overriden by using of command
+line options. Each
+option has short and long notations:<br>
+</p>
+<p><b>-g / --gui</b><br>
+</p>
+<div style="margin-left: 40px;">Runs the Installation Wizard in the
+GUI
+mode (this is default mode).<br>
+</div>
+<p><b>-b / --batch</b><br>
+</p>
+<div style="margin-left: 40px;">Runs the Installation Wizard in
+the terminal mode. <br>
+</div>
+<p><b>-f FILE / --file=</b><span style="font-weight: bold;">FILE<br>
+</span></p>
+<div style="margin-left: 40px;">The XML configuration file to be used
+by
+the
+Installation Wizard. If this option is not used then the
+installation script
+tries
+to define the <i>Linux </i>version and use the corresponding XML file
+if it is present.
+For
+examle, for the <span style="color: rgb(0, 0, 153);">Linux Mandrake
+10.1</span> the <b>config_Mandrake_10.1.xml</b>
+file
+will be used by default. If the appropriate file is not
+found, the file <b>config.xml</b> will be used. This file refers to
+the basic target platform
+which is <span style="color: rgb(0, 0, 153);">Linux Mandrake 10.1</span>
+for SALOME 3.0 and newer. If <span style="font-weight: bold;">config.xml</span>
+file is
+also not found, the warning message box is shown (in GUI mode) or
+printed to the console (in batch mode) and the Installation Wizard
+quits.<br>
+</div>
+<p> <b>-d DIR / --target=DIR</b><br>
+</p>
+<div style="margin-left: 40px;">The target directory SALOME platform
+to
+be installed to. If used, this option overrides the default target
+directory, given in
+the
+configuration XML file (usually<span style="font-weight: bold;">
+${HOME}/salome_<version></span>,
+see
+<a href="#xml_files">here</a> for more details). <br>
+</div>
+<p><b>-t DIR / --tmp=DIR </b></p>
+<div style="margin-left: 40px;">The directory, which should be used for
+temporary files. If given, this option overrides the default temporary
+directory,
+given in the
+configuration xml file (usually <span style="font-weight: bold;">/tmp</span><span
+ style="font-weight: bold;"></span>, see <a href="#xml_files">here</a>
+for more information).<br>
+</div>
+<p><b>-a / --all-from-sources</b></p>
+<span style="font-weight: bold;"></span><b> </b>
+<div style="margin-left: 40px;">
+Force all the products to be installed from sources (including all
+SALOME modules). If this option is used, all the default installation
+modes for all the products are ignored.<br>
+This option is helpful when the user wants to install SALOME on the
+platform which is not officially supported. In this case, the user can
+try to run the SALOME Installation Wizard with the <span
+ style="font-weight: bold;">-a</span> option in order to build all the
+products from sources.<br>
+<span style="font-weight: bold; color: rgb(255, 0, 0);">Note, that this
+is long-time operation which can take more than 24 hours depending on
+the computer.</span><br>
+</div>
+<p><b>-h / --help</b><br>
+</p>
+<div style="margin-left: 40px;">Prints help information on the
+Installation Wizard's usage. <br>
+</div>
+<p></p>
+<p>
+<b>-v / --version</b><br>
+</p>
+<div style="margin-left: 40px;">Prints version information (<span
+ style="font-weight: bold;">Note: </span>this is the
+Installation Wizard's version number, not of SALOME platform). <br>
+</div>
+<p>
+</p>
+<p>The installation procedure supports different <span
+ style="color: rgb(0, 0, 153);">Linux
+</span>platforms
+and installs various installation 3d-party prerequisite products which
+are required by SALOME platform. As it was mentioned above, the basic
+target platform for SALOME 3.0 and newer is <span
+ style="color: rgb(0, 0, 153);">Linux Mandrake 10.1</span>.<br>
+The using of configuration XML files gives flexible way to modify the
+list of products to be installed by the Installation Wizard without
+changing program's source code. Just create your own XML configuration
+file
+and implement installation scripts for the prerequisite products you
+need and then use this XML file with the Installation Wizard. This can
+be done, for example, for some <span style="color: rgb(0, 0, 153);">Linux
+</span>platform which is not supported directly by the Installation
+Wizard. See <a href="#xml_files">Modifying XML configuration file</a>
+and <a href="#new_products">Implementing installation scripts for the
+new products</a> sections for more information. </p>
+<h3 style="margin-left: 40px;"> <a name="gui_mode"></a>GUI mode<br>
+</h3>
+<p>The <font color="#ff0000">Installation Wizard</font>'s GUI has been
+developed
+with
+using of the <span style="color: rgb(0, 0, 153);">Trolltech's </span><span
+ style="font-weight: bold;"><span style="color: rgb(0, 0, 153);">Qt
+3.0.5</span> </span>toolkit. After launching the Installation Wizard
+in the GUI mode the wizard window is shown to the user. This wizard
+guides the user through several subsequent pages. To navigate between
+the pages use <i>"Next"</i> and <i>"Back"</i>
+buttons in the
+lower part of the wizard window. <i>"Cancel"</i> button closes the
+wizard
+window and quits the installation procedure after user's
+confirmation. <i>"Help"</i> button opens an additional window to show
+the help information. </p>
+<p>The first "<span style="font-style: italic;">Introduction"</span>
+page is shown at the <a href="#IntroPage">Figure 1</a>. Skip this page
+by pressing <i>"Next"</i>
+button:
+</p>
+<center><a name="IntroPage"></a><br>
+<img alt="Intro page" src="intropage.png"
+ style="width: 586px; height: 364px;">
+<p><b>Figure 1:</b> "Introduction" page</p>
+</center>
+<p>In the second page you are proposed to enter the target directory
+where the SALOME platform should be installed to. You can also press <i>"Browse..."</i>
+button and choose the destination folder using standard browse
+directory dialog box. <br>
+If the directory you want to install products does not exist you are
+prompted to confirm directory creation. If you type wrong directory
+path, or if you do not have write permissions for the directory you
+use, the
+corresponding message box is shown.<br>
+</p>
+<p>You can also change the temporary directory (which is used to store
+temporary files required for the installation).<br>
+In the bottom part of the window the total disk space required for the
+installation and for the temporary files is displayed (see below for
+more details).<br>
+</p>
+<p>In the GUI mode the Installation Wizard provides two different
+options
+to install the SALOME platform: <span style="font-weight: bold;">basic</span>
+(which is default) and
+<span style="font-weight: bold;">advanced.</span> In the <span
+ style="font-weight: bold;">basic</span> mode the
+user should enter the target installation
+directory and temporary folder. All other installation options are
+taken from the XML
+configuration file (see <a href="#Product_page1">Fig.2</a>):<br>
+</p>
+<center><a name="Product_page1"></a><br>
+<img alt="Intro page" src="productpage1.png"
+ style="width: 586px; height: 364px;">
+<p><b>Figure 2:</b> "Installation settings"
+</p>
+</center>
+<p>In addition, you have choice to use "Install all products from
+sources" check box. If this option is turned on, all the products will
+be installed from the sources (using their own build procedures). This
+check box correspond to the <span style="font-weight: bold;">--all-from-sources</span>
+(<span style="font-weight: bold;">-a</span>) option of the <span
+ style="font-weight: bold;">runInstall</span> script (see <a
+ href="#install_from_wizard">here</a>). <span
+ style="font-weight: bold;">Note:</span> the installation of all
+products from sources is a long-time operation.<br>
+</p>
+<p>To switch to the <span style="font-weight: bold;">advanced</span>
+option, click <i>"More..."</i> button (see <a href="#ProductPage2">Fig.3</a>
+).</p>
+<p>In the advanced mode you have the possibility to select products to
+be installed. Each product can
+have several options of installation: you have a possibility to use
+native product (provided with Linux distribution and installed in the
+system folders), install already precompiled binaries, build product
+from the sources or not install it at all. Avaiable options and default
+option are taken from the XML configuration file. You can mark the
+products you want to install by clicking the corresponding
+radiobuttons in the list view in the left part of the page. <br>
+Note, that
+some products may require some other pre-requisite products to be
+installed (or
+these prerequisite products should be already available on your
+computer). The installation procedure
+has a special feature to automatically mark these products in the list
+view.
+For example, in order to install <b><i>PyQt</i></b> it's necessary to
+have
+<b><i>gcc, Python</i></b>,<b><i> Qt</i></b> and <b><i>Sip</i></b>
+installed.
+Therefore all these products will be also turned on when you check on <b><i>PyQt</i></b>.
+This feature can be switched off by clicking <i>"Automatic
+dependencies"</i> checkbox. Turn on this checkbox if you
+want all prerequisite products to be automatically checked when you
+select some product to be installed. Turn off this checkbox if you
+want to disable this feature.<br>
+</p>
+<center><a name="ProductPage2"></a><br>
+<img src="productpage.png" alt="Products page"
+ style="width: 586px; height: 525px;">
+<p><b>Figure 3:</b> "Installation settings" page in the 'advanced' mode</p>
+</center>
+<p>If you want to use native products (like <span
+ style="font-weight: bold;">gcc</span>, <span
+ style="font-weight: bold;">tcl</span>, etc.), select <i>"use native" </i>option.
+<br>
+Special button in the right part of the page - <i>"Unselect All" </i>-
+allows to reset quickly all products to the <i>"not install"</i>
+state. <br>
+</p>
+<p>There are also two checkboxes on this page: <i>"SALOME sources"</i>
+and <i>"SALOME binaries"</i>.
+These three-state checkboxes allow quick selecting/unselecting SALOME
+modules sources/binaries packages
+for the installation.<br>
+</p>
+<p>In addition, when some SALOME sources are selected, one more check
+box becomes available: <span style="font-style: italic;">"Build SALOME
+sources"</span>. If this option is turned on, the selected SALOME
+modules will be built and installed from sources.<br>
+<span style="font-weight: bold;">Note: if this check box is turned on,
+the corresponding SALOME module binaries package installation is
+disabled, because of conflicting of SALOME module sources an binaries
+packages </span>(see <a href="#ProductPage3">Fig. 4</a> below).
+</p>
+<center><a name="ProductPage3"></a><br>
+<img src="productpage2.png"
+ alt="Products page" style="width: 586px; height: 525px;">
+<p><b>Figure 4:</b> "Build SALOME sources" check box usage</p><br>
+</center>
+<p>The box at the right side of the page displays the information about
+currently highlighted product: name, version and short description,
+required
+disk space, disk space required for temporary files, list of
+prerequisites (this information is
+provided in the XML file) and current user
+choice.
+</p>
+The <i>"Disk space required:"</i> field displays how much
+disk space on the hard drive is required for installation of selected
+products. <br>
+<p><b>Note: </b>Please, take into account that displayed amount of
+required disk space is approximate and may differ when you install
+products on your hard drive. </p>
+<p>The installation procedure uses a special directory to store
+temporary files. The <i>"Space for temporary files:"</i> field shows
+the information about required disk space on the hard drive for
+extracting and compiling of the selected products. You can change the
+temporary directory - just type path
to the folder you want to use or click on the corresponding <i>"Browse..."</i>
- button. </p>
-
-<p>The installation procedure also checks available disk space on the selected
- directories according to the products selected. If there is no enough disk
- space on your hard drive you will see the corresponding error message box.
- </p>
-
-<p><b>Note: </b>Unfortunately, the configure procedure has a very annoying
- bug under Linux platform. The directory should be obligatory entered without
- spaces. For example, the configure procedure for <b><i>gcc</i></b> won't
-work if you pass the following parameter: <i>--prefix="/New Folder 1"</i>.
-<b>Therefore you are strongly recommended not to use directory names containing
-spaces.</b> </p>
-
-<p>To proceed further click <i>"Next"</i> button. At this moment program
-will make some tests to check installation settings: if there is enough disk
-space on the hard drive, if native products are preinstalled, dependencies
-(prerequisites) for each product you have selected to be installed.
-If any test fails you will see corresponding warning message box. Otherwise
-wizard will follow to the next page: </p>
-
-<center>
-<p><a name="ChoicePage"></a><br>
- <img src="choicepage.png" height="558" width="599" alt="">
- </p>
-
-<p><b>Figure 2:</b> "Check your choice" page</p>
- </center>
-
-<p>This page summarizes the installation settings you've made on the previous
- pages. You can check again your choice to change it if necessary. <br>
- When you are sure that everything is OK, press <i>"Next"</i> button to
+button. <br>
+<span style="font-weight: bold;">Note:</span> actually, temporary files
+are stored not directly in the directory entered by user. The
+Installation
+Wizard creates in this directory an additional folder named
+something like INSTALLWORK<span style="font-weight: bold;">XXXXX</span>
+where XXXXX is unique number. This allows to launch several
+Installation Wizards simultaneously. This temporary directory is
+removed automaticaly when the installation finishes.<br>
+</p>
+<p>The installation procedure also checks available disk space. If
+there is no
+enough disk space on your hard drive you will see the corresponding
+error message box. </p>
+<p><b>Note: </b><b>you are strongly recommended not to use directory
+names
+containing
+spaces. </b>Otherwise you can experience some troubles with the
+installation.<b> </b> </p>
+<p>To proceed further click <i>"Next"</i> button. At this moment
+program
+will make some tests to check installation settings: if there is enough
+disk
+space on the hard drive, check for native products installation,
+dependencies
+(prerequisites) for each product you have selected to be
+installed.
+If any test fails you will see the corresponding warning message box.
+Otherwise
+the wizard will proceed to the next page: </p>
+<center>
+<a name="ChoicePage"></a><br>
+<img src="choicepage.png" alt="Choice page"
+ style="width: 586px; height: 485px;">
+<p><b>Figure 5:</b> "Check your choice" page</p>
+</center>
+<p>This page summarizes the installation options you've made on the
+previous pages. You can check again your choice and change it if
+necessary by getting back to previous page. <br>
+When you are sure that everything is OK, press <i>"Next"</i> button to
follow to the <a href="#ProgressPage">next page</a>. </p>
-
<center><a name="ProgressPage"></a><br>
- <img src="progresspage.png" height="558" width="599" alt="">
-
-<p><b>Figure 3:</b> "Installation progress" page</p>
- </center>
-
-<p>To start installation of the selected products click <i>"Start"</i> button.
-It launches the shell installation script and you will be able to see the
-output of the script in the topmost dialog's frame. In case of any installation
-problems (for example, you have accidentally removed the temporary directory)
-the script will ask you: <i>"Would you like to continue : (Y,N) ?"</i>. You
-can answer this question by typing [Y] or [N] in the middle text edit control
-frame. <br>
- <b>Note:</b> press [Enter] when you finish typing data. </p>
-
-<p>The <i>"Installation Status"</i> frame window shows you the progress of
-installation. It contains a list of all selected products with brief descriptions.
-"<font color="#ff0000">Waiting</font>" description means that installation
-of this product have not started yet. Currently installing product is marked
-as "<font color="#ff9900">Processing</font>". All installed products have
-"<font color="#33ff33">Completed</font>" description. </p>
-
-<p>You can abort installation and close the installation procedure using
-<i>"Cancel"</i> button. It sends the signal "SIGTERM" to the shell script.
-The script has a signal handler and will try to clear all temporary files.
-The process of removing temporary files can take some time, so the installation
+<img alt="Progress page" src="progresspage1.png"
+ style="width: 586px; height: 364px;"><br>
+<p><b>Figure 6:</b> "Installation progress" page</p>
+</center>
+<div style="text-align: left;">To start installation of the selected
+products click <i>"Start"</i>
+button. It launches the shell installation script and you will be able
+to see the output of the script in the topmost dialog's frame. If any
+errors
+occur during the installation progress the corresponding messages
+will be printed to the log window in the bold red font.<br>
+</div>
+<div style="text-align: left;">It is possible at any time to break the
+installation by pressing <span style="font-style: italic;">"Stop"</span>
+button. Then you can get back to the previous pages if you wish to
+change installation settings or restart installation by pressing again <span
+ style="font-style: italic;">"Start"</span> button.<br>
+</div>
+<p style="text-align: left;"><span style="font-weight: bold;">Note:</span>
+in the current
+implementation it is not possible to resume stopped installation
+process; it will be re-started from the very beginning. <br>
+</p>
+<center><a name="ProgressPage1"></a><br>
+<img alt="Progress page" src="progresspage.png"
+ style="width: 586px; height: 364px;">
+<p><b>Figure 7:</b> "Installation progress" page: installation in
+progress</p>
+</center>
+<p>The <i>"Installation Status"</i> frame window shows you the
+progress of installation. "<font color="#ff0000">Waiting</font>" status
+means that installation of this product has not been started
+yet. The product currently being installed is marked as "<font
+ color="#ff9900">Processing</font>".
+All installed products have "<font color="#33ff33">Completed</font>"
+status. </p>
+<p>You can abort installation and close the installation procedure
+using
+<i>"Cancel"</i> button. <br>
+<span style="font-weight: bold;">Note:</span> this button sends the
+signal "SIGTERM" to the shell
+script.
+The script tries to clear all temporary
+files.
+The process of removing temporary files can take some time, so the
+installation
wizard will wait 3 seconds before closing. </p>
-
-<p>At the end of installation (all selected products have been installed
-successfully) you can go back to the previous pages to start a new installation
+<p>At the end of installation (all selected products have been
+installed
+successfully) you can go back to the previous pages to start a new
+installation
or click <i>"Next"</i> button to go the Readme page: </p>
-
-<center>
-<p><a name="readmepage"></a><br>
- <img src="readmepage.png" height="558" width="599" alt="">
- </p>
-
-<p><b>Figure 4:</b> "Finish installation" page</p>
- </center>
-
-<p>In this page you can read important information about the Instalation
-Wizard itself and some hints: how to run and test SALOME or how to build
-SALOME from the sources. This is the contents of the README file which you
-can find in the root directory of the Installation Wizard. <br>
- You can also launch SALOME Desktop from this page by clicking <i>"Launch
- SALOME" </i>button. </p>
-
-<p>During the process of installation the script creates some environment
- files to simplify procedure of launching SALOME. These shell scripts set
-all necessary environment variables for all products you have installed.
-To learn how installation scripts collects the environment, see <a
- href="#pick_up_env"> here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b>
+<center>
+<a name="readmepage"></a><br>
+<img alt="Read page" src="readmepage.png"
+ style="width: 586px; height: 484px;">
+<p><b>Figure 8:</b> "Finish installation" page</p>
+</center>
+<p>In this page you can read important information about the
+Instalation Wizard itself and some tips: how to run and test SALOME or
+how to build SALOME from the sources. This is the contents of the
+README file which you can find in the root directory of the
+Installation Wizard. <br>
+You can also launch SALOME Desktop from this
+page or read Release Notes file by clicking on the corresponding
+buttons in the lower part of the page (see <a href="#xml_files">here</a>
+and <a href="#finish_buttons">here</a> for more information about
+customizing these buttons).<br>
+</p>
+<h3 style="margin-left: 40px;"> <a name="batch_mode"></a>Batch mode<br>
+</h3>
+To launch the Installation Wizard in the batch mode use <span
+ style="font-weight: bold;">-b</span>
+(<span style="font-weight: bold;">--batch</span>) parameter.<br>
+In this mode the GUI wizard is not shown but all the installation
+status is displayed directly in the console. In the batch mode user do
+not have a possibility to change installation settings which are given
+in the configuration file, except target and temporary directories
+which can be overridden by the corresponding command line options.<br>
+The only exception is <span style="font-weight: bold;">--all-from-sources</span>
+(<span style="font-weight: bold;">-a</span>) option which enables
+special installation mode in which all the products (including SALOME
+modules) are installed from sources, ignoring default mode defined in
+the XML configuration file (see <a href="#install_from_wizard">here</a>
+for details).
+<center><a name="BatchMode"></a><br>
+<br>
+<img alt="Batch mode" src="batchmode.png"
+ style="width: 660px; height: 410px;">
+<p><b>Figure 9:</b> Batch mode</p>
+</center>
+<h3 style="margin-left: 40px;"><a name="env_files"></a>Environment files</h3>
+<p>During the process of installation the
+script creates some
+environment files to simplify procedure of launching SALOME. These
+shell scripts set
+all necessary environment variables for all products you have
+installed.
+To learn how installation scripts collects the environment, see <a
+ href="#pick_up_env">here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b>
in the <span style="font-style: italic;"><span
style="font-weight: bold;">KERNEL module</span></span><b><i> sources</i></b>
-and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL module</span></span><b><i>
- binaries</i></b> root directories and <b>env_products.csh</b> + <b>env_products.sh
- </b>in the target directory. </p>
-
-<hr>
-<h3><a name="check_version_proc"></a>Notes on<font color="#ff0000"> check
-products version</font> procedure</h3>
- Unfortunately under Linux platform there is no exact algorithm to identify
- the product's version. The table below contains the information relating
-to checking preinstalled products for the Linux RedHat 8.0 platform <br>
-
-<table border="1" width="100%" nosave="">
- <tbody>
- <tr nosave="">
- <th nosave="">
- <center><font size="+1">Product</font></center>
- </th>
- <th nosave="">
- <center><font size="+1">Algorithm of checking</font></center>
- </th>
- <th nosave="">
- <center><font size="+1">Preliminary steps before launching</font>
- <br>
- <font size="+1">of installation procedure</font></center>
- </th>
- <th nosave="">
- <center><font size="+1">Notes</font></center>
- </th>
- </tr>
- <tr>
- <td>gcc 3.2</td>
- <td>ver=`gcc -dumpversion`</td>
- <td>
- <center>-</center>
- </td>
- <td>ver should be 3.2.<br>
- It is recommended to use native gcc on Linux RedHat 8.0</td>
- </tr>
- <tr nosave="">
- <td>tcl 8.3</td>
- <td nosave="">existence of TCLHOME <br>
- existence of tclsh8.3 <br>
- existence of wish8.3 <br>
- existence of libtcl8.3.so <br>
- existence of libtk8.3.so <br>
- existence of libtclx8.3.so <br>
- existence of libtkx8.3.so</td>
- <td>set TCLHOME if you have preinstalled version of tcl. <br>
- set LD_LIBRARY_PATH on a directory where libs can be found.</td>
- <td>It is recommended to use native tcl on Linux RedHat 8.0</td>
- </tr>
- <tr>
- <td valign="top">boost 1.30.2<br>
- </td>
- <td valign="top">ver=`egrep 'BOOST_VERSION [0-9]+' ${BOOSTDIR}/boost/version.hpp
-| sed 's/.*BOOST_VERSION \([0-9]\+\)/\1/g'`<br>
- </td>
- <td valign="top">set BOOSTDIR if you have preinstalled version of
-boost<br>
- </td>
- <td valign="top">It is impossible to use native BOOST and to install
-BOOST from binaries.<br>
- </td>
- </tr>
- <tr>
- <td>Open CASCADE 5.2<br>
- </td>
- <td>existence of CASROOT environment variable</td>
- <td>set CASROOT if you have preinstalled version of Open CASCADE</td>
- <td>Unfortunately we can't say anything exactly about CASCADE 5.2
-and we only check CASROOT environment variable. If you have problem with
-preinstalled version of Open CASCADE, reinstall it</td>
- </tr>
- <tr>
- <td>Patch for Open CASCADE 5.2<br>
- </td>
- <td></td>
- <td></td>
- <td>Open CASCADE 5.2 provided with the Installation Wizard already includes the patch,
-necessary for SALOME 2.2.0. In addition the Installation Wizard provides the sources of a Open CASCADE patch
-which can be applied to original Open CASCADE 5.2. sources before compilation.</td>
- </tr>
- <tr>
- <td>Python 2.2.1</td>
- <td>existence of PYTHONHOME <br>
- isPython=`which python` <br>
- ver=`python -V`</td>
- <td>set PYTHONHOME to root Python folder <br>
- set PATH on a directory where python can be found</td>
- <td>Python should exist and ver should be equal to 2.2.1 <br>
- It is recommended to use native Python on Linux RedHat 8.0</td>
- </tr>
- <tr>
- <td>Mesa 3.4.2</td>
- <td>existence of libGL.so.1.2.030402</td>
- <td>set LD_LIBRARY_PATH on a directory where libGL.so.1.2.030402
-can be found</td>
- <td>You have a possibility to build products (vtk & qt) with
-Mesa drivers from the package supplied with this installation procedure or
-to use OpenGL drivers installed on your computer locally. This check procedure
- concerns only supplied Mesa driver.</td>
- </tr>
- <tr>
- <td>Swig 1.3.17</td>
- <td>isSwig=`which swig` <br>
- ver=`swig -version` <br>
- ver=`echo $ver | awk '{print $3}'`</td>
- <td>set PATH on a directory where swig can be found</td>
- <td>Swig should exist and ver should be equal to 1.3.17</td>
- </tr>
- <tr>
- <td>Qt 3.0.5</td>
- <td>existence of QTDIR <br>
- existence of libqt-mt.so.3.0.5</td>
- <td>set QTDIR if you have preinstalled version of qt</td>
- <td>We try to find libqt-mt.so.3.0.5 in ${QTDIR}/lib folder. <br>
- You should set MESA_HOME only if you have preinstalled version of Mesa
-3.4.2. <br>
- It is recommended to use native Qt on Linux RedHat 8.0</td>
- </tr>
- <tr>
- <td>Qwt 0.4.1</td>
- <td>existence of QWTHOME <br>
- existence of libqwt.so.0.4.1</td>
- <td>set QWTHOME if you have preinstalled version of qwt</td>
- <td>We try to find libqwt.so.0.4.1 in the ${QWTHOME}/lib folder. </td>
- </tr>
- <tr>
- <td>Hdf 5-1.4.4</td>
- <td>existence of HDF5HOME <br>
- existence of libhdf5.so.0.0.0 <br>
- existence of libhdf5.settings</td>
- <td>set HDF5HOME if you have preinstalled version of hdf</td>
- <td>We try to find libhdf5.so.0.0.0 and libhdf5.settings in ${HDF5HOME}/lib
- folder. <br>
- File libhdf5.settings should contain the following entry: <br>
- HDF5 Version: 1.4.4</td>
- </tr>
- <tr>
- <td>Med 2.2.2</td>
- <td>existence of MED2HOME <br>
- existence of libmed.so.1.0.1</td>
- <td>set MED2HOME if you have preinstalled version of med</td>
- <td>Unfortunately we can't check version number. <br>
- We try to find libmed.so.1.0.1 in ${MED2HOME}/lib folder. <br>
- If you have problem with preinstalled version of med reinstall it.</td>
- </tr>
- <tr>
- <td>Vtk 4.2</td>
- <td>existence of VTKHOME <br>
- existence of libvtkCommon.so</td>
- <td>set VTKHOME if you have preinstalled version of vtk</td>
- <td>Unfortunately we can't check the version number. <br>
- We try to find libvtkCommon.so in ${VTKHOME}/lib/vtk folder. <br>
- If you have problem with preinstalled version of vtk reinstall it.</td>
- </tr>
- <tr>
- <td valign="top">Netgen 4.3<br>
- </td>
- <td valign="top">existence of NETGENROOT<br>
- </td>
- <td valign="top">set NETGENROOT if you have preinstalled version of
-Netgen.<br>
- </td>
- <td valign="top">Unfortunarely we can't find anything about netgen
-version.<br>
-We just check if NETGENROOT environment varible is set.<br>
- </td>
- </tr>
- <tr>
- <td>OmniORB 3.0.5, <br>
- OmniORBpy 1.5, <br>
- OmniNotify 1.2</td>
- <td>existence of OMNIORBDIR <br>
- existence of libomniORB3.so.0.5 <br>
- existence of _omnipymodule.so.0.5 <br>
- existence of libCOSNotify3.so.0.5 <br>
- existence of notifd <br>
- existence of THIS_IS_omniORB_3_0_5 <br>
- existence of THIS_IS_omniNotify_1_2 <br>
- existence of THIS_IS_OMNIORBPY_1_5</td>
- <td>set OMNIORBDIR if you have preinstalled version of omni</td>
- <td>We try to find libomniORB3.so.0.5, _omnipymodule.so.0.5 and libCOSNotify3.so.0.5
- in ${OMNIORBDIR}/lib/i586_linux_2.0_glibc2.1 folder. <br>
- We try to find notifd in ${OMNIORBDIR}/bin/i586_linux_2.0_glibc2.1 folder.
- <br>
- Additional checking - omni add special files THIS_IS_... <br>
- We try to find THIS_IS_omniORB_3_0_5 in ${OMNIORBDIR} folder. <br>
- We try to find THIS_IS_omniNotify_1_2 in ${OMNIORBDIR}/src/services/omniNotify.
- <br>
- We try to find THIS_IS_OMNIORBPY_1_5 in ${OMNIORBDIR}/src/lib/omniORBpy
-folder.</td>
- </tr>
- <tr>
- <td>Numeric 22.0</td>
- <td>existence of Numeric folder <br>
- existence of _numpy.so</td>
- <td>set PYTHONHOME if you have preinstalled version of python</td>
- <td>Unfortunately we can't check the version number. <br>
- We try to find Numeric folder in ${PYTHONHOME}/lib/python2.2/site-packages/Numeric
- folder. <br>
- If you have problem with preinstalled version of numeric 22.0 reinstall
-it.</td>
- </tr>
- <tr>
- <td>Sip 3.3.2</td>
- <td>existence of SIPDIR <br>
- existence of sip <br>
- existence of libsip.so.9.1.0</td>
- <td>set SIPDIR to directory where you have sip preinstalled</td>
- <td>We try to find sip and libsip.so.9.1.0 in $SIPDIR folder if you
-set SIPDIR , otherwise searching is done using $PATH and $LD_LIBRARY_PATH
- accordingly. <br>
- It is recommended to use native Sip on Linux RedHat 8.0</td>
- </tr>
- <tr>
- <td>PyQt 3.3.2</td>
- <td>existence of PYQTDIR <br>
- existence of libqtxmlcmodule.so.1.0.0</td>
- <td>set PYQTDIR to directory where you have sip preinstalled</td>
- <td>Unfortunately we can't check the version number. <br>
- We try to find libqtxmlcmodule.so.1.0.0 in $PYQTDIR folder if you set PYQTDIR,
-otherwise searching is done using $LD_LIBRARY_PATH . <br>
- If you have problem with preinstalled version of PyQt 3.3.2 reinstall it.
- <br>
- It is recommended to use native PyQt on Linux RedHat 8.0</td>
- </tr>
- <tr>
- <td>HappyDoc 2.1</td>
- <td>existence of happydoc <br>
- ver=`happydoc | grep "HappyDoc version 2.1"`</td>
- <td>set PYTHONHOME if you have preinstalled version of python</td>
- <td>We try to find happydoc in $PYTHONHOME/bin folder. <br>
- ver should not be empty. <br>
- This product is not obligatory. It was added only for your comfort.</td>
- </tr>
- <tr>
- <td>Doxygen 1.3-rc2</td>
- <td>existence of doxygen <br>
- existence of doxysearch <br>
- existence of doxytag <br>
- existence of doxywizard</td>
- <td>set QTDIR if you have preinstalled version of qt <br>
- set PATH on a directory where doxygen, doxysearch, doxytag and doxywizard
- can be found</td>
- <td>Unfortunately we can't check the version number. <br>
- It's necessary to have compiled Qt in order to build doxywizard. <br>
- If you have problem with preinstalled version of doxygen 1.3-rc2 reinstall
- it. <br>
- This product is not obligatory. It was added only for your comfort.</td>
- </tr>
- <tr>
- <td>Graphviz 1.9</td>
- <td>existence of dot</td>
- <td>add GraphViz's bin directory to the PATH environment variable</td>
- <td>Unfortunately we can't check the version number. <br>
- We try to find dot program in the $PATH</td>
- </tr>
- <tr>
- <td>MODULE binaries<br>
- (MODULE=KERNEL,GEOM, ...)<br>
- </td>
- <td>existence of MODULE_ROOT_DIR <br>
- existence of VERSION file <br>
- ver=`cat $MODULE_ROOT_DIR/bin/salome/VERSION | awk -F: '{print $2}' | tr
--d '[:space:]'`</td>
- <td>set MODULE_ROOT_DIR if you have preinstalled binaries of MODULE
- version 2.2.0</td>
- <td>MODULE binaries should exist and ver should be equal to 2.2.0</td>
- </tr>
- <tr>
- <td>MODULE sources<br>
- (MODULE=KERNEL,GEOM, ...)<br>
- </td>
- <td>existence of MODULE_SRC_DIR <br>
- existence of VERSION file <br>
- ver=`cat $MODULE_SRC/bin/VERSION | awk -F: '{print $2}' | tr -d '[:space:]'`</td>
- <td>set MODULE_SRC_DIR if you have preinstalled sources of MODULE
-version 2.2.0</td>
- <td>MODULE sources should exist and ver should be equal to 2.2.0</td>
- </tr>
-
- </tbody>
-</table>
-
-<p><b>Note:</b> For native products installation procedure sets proper environment
- variables itself, and you do not need to set such variables like, e.g. <b>TCLHOME</b>
- or <b>PYTHONHOME</b>. <br>
- If you have native products installed to different from default directories
- (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is recommended to follow above
-description. Or you should set properly $PATH and $LD_LIBRARY_PATH variables
-<b><font color="#ff0000">before</font></b> starting Installation Wizard. Otherwise
-installation script will fail to find preinstalled products. </p>
-<p><b>Note:</b> For some native products (e.g. gcc, Python) the rules of version
-checking are not so strict as described in the table. Only major and minor numbers of version
-should coincide with prerequisite. Release number can be larger. It is done for making a possibility
-to use native products for newer versions of Red Hat (for example, Linux Red Hat 9 includes native
-gcc 3.2.2 installation).
-If native product has version number larger than that required by installation procedure,
-you will be prompted by the warning message like this: "You have newer version of gcc installed
-on your computer than that is required (3.2). Continue?". You can press "Yes" button
-to procede with the installation but in this case you should be aware of what you are doing.
-SALOME binaries (inluding other products) are compiled with the prerequisites from the list
-and most likely can not be run successfully if this products are not found.
-This can be only helpful if you intend to build all products from sources.</p>
-
-<h3>
+and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL
+module</span></span><b><i> binaries</i></b> root directories and <b>env_products.csh</b>
++ <b>env_products.sh </b>and <span style="font-weight: bold;">env_build.csh
+</span>+ <span style="font-weight: bold;">env_build.sh</span> in the
+target installation directory.<br>
+</p>
+<span style="font-weight: bold;">Note:</span> there is some difference
+betwen these files: <span style="font-weight: bold;">env_build.*</span>
+files are optimized to
+be used for the building of SALOME modules from sources (see <span
+ style="font-weight: bold;">README </span>file provided with the
+installation procedure on the CD). The <span style="font-weight: bold;">env_products.*</span>
+(and<span style="font-weight: bold;"> salome.*</span>) files are
+optimized for
+the SALOME launching. The behavior is defined by the environment
+variable<span style="font-weight: bold;"> </span><b>ENV_FOR_LAUNCH</b>
+which is set to <span style="font-weight: bold;">0</span> in
+env_build.* files and to <span style="font-weight: bold;">1</span> in
+env_products.*
+(salome.*) files.<br>
+<br>
+<hr>
+<h3><a name="check_version_proc"></a>Notes on<font color="#ff0000">
+check products version</font> procedure</h3>
+Unfortunately under Linux platform there is no exact algorithm to
+identify the product's version. The information in this section gives
+an idea how the
+version is checked for the native/preinstalled products (this
+information refers to the base platform <span
+ style="color: rgb(0, 0, 153);">Linux Mandrake
+10.1</span>; and the same algorithms are used for other platforms). <br>
+The general rule for all products is that the path to the binaries
+should be set via <span style="font-weight: bold;">PATH</span>
+environment variable, path to the libraries should be set via <span
+ style="font-weight: bold;">LD_LIBRARY_PATH</span> variable and the
+python modules should be available via <span style="font-weight: bold;">PYTHONPATH</span>
+variable.<br>
+<span style="font-weight: bold;">Note:</span> the information given in
+this section refers to the prerequisite products for SALOME version
+3.2.4.<br>
+<ul>
+ <li>gcc 3.4.1<br>
+ </li>
+</ul>
+Version number is checked by <span style="font-weight: bold;">gcc
+-dumpversion</span> command. <span style="font-weight: bold;">gcc</span>
+executable should be in the <span style="font-weight: bold;">PATH</span>
+environment variable. Version should
+be equal to the "3.4.1". It is recommended to use native gcc on
+Mandrake 10.1.<br>
+<ul>
+ <li>tcl/tk 8.4.5</li>
+</ul>
+Version number for <span style="font-weight: bold;">tcl/tk</span> can
+be found in tclConfig.sh and tkConfig.sh files (<span
+ style="font-weight: bold;">TCL_VERSION</span> and <span
+ style="font-weight: bold;">TK_VERSION</span> variables
+correspondingly). Version number should be equal to "8.4" (release
+number is not checked). <br>
+Set <span style="font-weight: bold;">TCLHOME</span> environment
+variable to the root directory of tcl/tk installation.<br>
+It is recommended to use native tcl/tk on Mandrake 10.1. <span
+ style="font-weight: bold;"></span>
+<ul>
+ <li>boost 1.31.0</li>
+</ul>
+Version number is defined by <span style="font-weight: bold;">version.hpp</span>
+file which is part of the boost distribution. This file defines <span
+ style="font-weight: bold;">BOOST_VERSION</span> macro which should be
+equal to the "103100". In addition the existence of boost libraries is
+checked. <br>
+Set <span style="font-weight: bold;">BOOSTDIR</span>
+environment variable if you have preinstalled version of
+boost.<br>
+<ul>
+ <li>Python 2.3.4</li>
+</ul>
+Version number is checked by <span style="font-weight: bold;">python -V</span>
+command. <span style="font-weight: bold;">python</span> executable
+should be in the <span style="font-weight: bold;">PATH</span>
+environment variable. Version number should be equal to "2.3.4". It is
+recommended to use native Python on
+Mandrake 10.1.<br>
+Set <span style="font-weight: bold;">PYTHONHOME</span> environment
+variable if you have preinstalled version of Python.<br>
+<ul>
+ <li>Swig 1.3.24</li>
+</ul>
+Version number is checked by <span style="font-weight: bold;">swig
+-version</span> command. <span style="font-weight: bold;">swig</span>
+executable should be in the <span style="font-weight: bold;">PATH</span>
+environment variable. Version number should be equal to "1.3.24".<br>
+<ul>
+ <li>Qt 3.3.3</li>
+</ul>
+Version number is defined by <span style="font-weight: bold;">qglobal.h</span>
+file which is part of the Qt distribution. This file defines <span
+ style="font-weight: bold;">QT_VERSION_STR</span> macro which should be
+equal to "3.3.3". It is recommended to use native Qt on Mandrake 10.1.<br>
+Set <span style="font-weight: bold;">QTDIR</span> environment
+variable if you
+have preinstalled version of qt.<br>
+<ul>
+ <li>msg2qm</li>
+</ul>
+<span style="font-weight: bold;">msg2qm</span> is Qt tool which is used
+to
+convert text *.po files to *.qm resource files. Unfortunately this tool
+is not included to the Linux distribution and provided only in Qt
+sources
+package. This is the reason why this tool is suppplied with the SALOME
+Installation Wizard.<br>
+There is no way to check the version number of msg2qm tool. Just set <span
+ style="font-weight: bold;">MSG2QM_ROOT</span> environment
+variable if you have preinstalled
+version of msg2qm tool
+<ul>
+ <li>Open CASCADE 6.1.2a2</li>
+</ul>
+Version number is defined by <span style="font-weight: bold;">Standard_Version.hxx</span>
+file which is part of the Open CASCADE distribution. This file defines <span
+ style="font-weight: bold;">OCC_VERSION_MAJOR,</span> <span
+ style="font-weight: bold;">OCC_VERSION_MINOR</span> and <span
+ style="font-weight: bold;">OCC_VERSION_MAINTENANCE</span> macros which
+should refer to version 6.1.2.<br>
+Set <span style="font-weight: bold;">CASROOT</span> environment
+variable if you have preinstalled version of Open CASCADE.<br>
+<ul>
+ <li>qwt 4.2.0/0.4.2</li>
+</ul>
+Version number is defined by <span style="font-weight: bold;">qwt_global.h</span>
+file which is part of the qwt distribution. This file defines <span
+ style="font-weight: bold;">QWT_VERSION_STR</span> macro which should
+be
+equal to "4.2.0".<br>
+Set <span style="font-weight: bold;">QWTHOME</span> environment
+variable if you
+have preinstalled version of qwt.<br>
+<ul>
+ <li>hdf 5-1.6.4</li>
+</ul>
+Version number is defined by <span style="font-weight: bold;">libhdf5.settings</span>
+file which is part of the <span style="font-weight: bold;">hdf5</span>
+distribution. Version should be equal to 1.6.4.<br>
+Set <span style="font-weight: bold;">HDF5HOME</span> environment
+variable if you
+have preinstalled version of hdf5.<br>
+<ul>
+ <li>med 2.2.3</li>
+</ul>
+Unfortunately there is no formal way to check med version
+number. We check existense of libmed.so.1.0.2 library on the computer.
+If you have problem with preinstalled version of med, please, reinstall
+it.<br>
+Set <span style="font-weight: bold;">MED2HOME</span> environment
+variable if you
+have preinstalled version of med.<br>
+<ul>
+ <li>Vtk 4.2.6</li>
+</ul>
+Unfortunately there is no formal way to check VTK version
+number. We just check existence of <span style="font-weight: bold;">libvtkCommon.so</span>
+library on the computer and hope that it is of version we need. If you
+have problem with preinstalled version of Vtk, please, reinstall it.<br>
+Set <span style="font-weight: bold;">VTKHOME</span> environment
+variable if you
+have preinstalled version of Vtk.<br>
+<ul>
+ <li>OmniORB 4.0.5, OmniORBpy 2.5, OmniNotify 2.1</li>
+</ul>
+We just check existence of some omniORB libraries and executable on the
+computer, like <span style="font-weight: bold;">libomniORB4.so.0.5</span>,
+<span style="font-weight: bold;">_omnipymodule.so.2.4</span>, <span
+ style="font-weight: bold;">libCOSNotify4.so.0.1</span> and <span
+ style="font-weight: bold;">notifd</span>.<br>
+Set <span style="font-weight: bold;">OMNIORBDIR</span> environment
+variable if
+you have preinstalled version of omniORB products.<br>
+<ul>
+ <li>sip 4.1</li>
+</ul>
+Version number is checked by <span style="font-weight: bold;">sip -V</span>
+command. <span style="font-weight: bold;">sip</span> executable should
+be in the <span style="font-weight: bold;">PATH</span>
+environment variable. Version number should be equal to "4.1".<br>
+Set <span style="font-weight: bold;">SIPDIR</span> environment
+variable to the
+directory where you have sip executable preinstalled.<br>
+<ul>
+ <li>PyQt 3.13</li>
+</ul>
+Version number is defined by <span style="font-weight: bold;">pyqtconfig.py</span>
+Python module file which is part of the <span
+ style="font-weight: bold;">PyQt</span> distribution. Version should be
+equal to "3.13".<br>
+Set <span style="font-weight: bold;">PYQTDIR</span>environment
+variable if you
+have preinstalled version of PyQt.
+<ul>
+ <li>netgen 4.5</li>
+</ul>
+Unfortunarely we can't find anything about
+netgen version. We just check if <span style="font-weight: bold;">NETGENROOT</span>
+environment varible is set.<br>
+Set <span style="font-weight: bold;">NETGENROOT</span>
+environment
+variable if you have preinstalled version
+of netgen mesher.<br>
+<span style="font-weight: bold;">Note: </span>netgen 4.5 provided with
+the SALOME installation Wizard has been patched to improve its
+performance.<br>
+<ul>
+ <li>Numeric 23.7</li>
+</ul>
+Version number is checked by <span style="font-weight: bold;">python
+-c
+'import Numeric; print Numeric.__version__'</span> command. <span
+ style="font-weight: bold;">python</span> executable should be in the <span
+ style="font-weight: bold;">PATH</span>
+environment variable and <span style="font-weight: bold;">Numeric</span>
+module should be avaible for the Python (for example it should be in
+the <span style="font-weight: bold;">PYTHONPATH</span> environment
+variable). Version number should be equal to "23.7". If you have
+problem with preinstalled version of Numeric 23.7, please,
+reinstall it.<br>
+Add the directory where <span style="font-weight: bold;"></span>you
+have preinstalled version of Numeric
+package to the <span style="font-weight: bold;">PYTHONHOME </span>environment
+variable.<br>
+<ul>
+ <li>graphviz 2.2.1</li>
+</ul>
+Version number is checked by <span style="font-weight: bold;">dot -V</span>
+command. <span style="font-weight: bold;">dot</span> executable should
+be in the <span style="font-weight: bold;">PATH</span>
+environment variable. Version number should be equal to "2.2.1".<br>
+Add <span style="font-weight: bold;">graphviz</span> bin directory to
+the <span style="font-weight: bold;">PATH</span> environment variable.<br>
+<ul>
+ <li>doxygen 1.4.6</li>
+</ul>
+Version number is checked by <span style="font-weight: bold;">doxygen
+--version</span> command. <span style="font-weight: bold;">doxygen</span>
+executable
+should be in the <span style="font-weight: bold;">PATH</span>
+environment variable. Version number should be equal to "1.4.6".<br>
+<ul>
+ <li><span style="font-weight: bold; color: rgb(0, 0, 153);">SALOME </span>module
+ <span style="font-weight: bold;"></span><span
+ style="font-weight: bold; color: rgb(0, 0, 153);">sources</span>
+(3.2.4).</li>
+</ul>
+For each SALOME module sources package (KERNEL, GUI, GEOM, etc...) root
+directory contains file configure.in (configure.ac) which defines
+version
+information.<br>
+Set <span style="font-weight: bold;"><MODULE>_SRC_DIR</span>
+environment variable for each SALOME <span style="font-weight: bold;">MODULE</span>
+sources package installed (where <span style="font-weight: bold;">MODULE</span>
+is KERNEL, GUI, GEOM, ...).<br>
+<ul>
+ <li><span style="font-weight: bold; color: rgb(0, 0, 153);">SALOME </span>module
+ <span style="font-weight: bold;"></span><span
+ style="font-weight: bold; color: rgb(0, 0, 153);">binaries </span>(3.2.4)</li>
+</ul>
+For each SALOME module binaries package (KERNEL, GUI, GEOM, etc...) <span
+ style="font-weight: bold;">bin/salome</span> directory contains file <span
+ style="font-weight: bold;">VERSION</span> which defines version
+information.<br>
+Set <span style="font-weight: bold;"><MODULE>_ROOT_DIR</span>
+environment variable for each SALOME <span style="font-weight: bold;">MODULE</span>
+binaries package installed (where <span style="font-weight: bold;">MODULE</span>
+is KERNEL, GUI, GEOM, ...).<br>
+<p><b></b>If you have native products installed to different from
+default
+directories (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is
+recommended to follow above mentioned instructions. Or you should
+properly set <span style="font-weight: bold;">PATH</span> and <span
+ style="font-weight: bold;">LD_LIBRARY_PATH</span> variables <b><font
+ color="#ff0000">before</font></b>
+starting the Installation Wizard. Otherwise
+the installation script will fail to find preinstalled/native products.
+</p>
+<p><b>Note:</b> for some native products (e.g. gcc, Python) the rules
+of version
+checking are not so strict as described in the table. Only major and
+minor numbers of version
+should coincide with prerequisite. Newer version of the product can be
+used also. If some native product has version number larger than that
+required by
+the
+installation procedure, user will be prompted by the warning message
+like this: <i>"You have
+newer version of gcc installed
+on your computer than that is required (3.4.1). Continue?"</i>. You can
+press <i>"Yes"</i> button
+to proceed with the installation but in this case you should be aware
+of what you are doing.
+SALOME binaries (including other products) are compiled with the
+predefined prerequisites
+and most likely can not be run successfully if these products are not
+found.
+This can be helpful only if you plan to build all products from
+sources. <br>
+</p>
+<h3>
<hr></h3>
-
<h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
- Please, read carefully the following information. This section describes
- how the installation procedure collects environment.
-<p>After installing each product shell script creates in the product root
- folder special environment file. The name of the file is generated from
-the name of product by the following scheme: <b>env_<product_name>.sh.</b>
- This file includes all necessary product settings. For example for Vtk the
-file is <b>env_Vtk.sh</b>. Environment files allows to pick up all environment
-settings which are necessary to build and launch SALOME. When installing SALOME
-sources and/or binaries, installation procedure picks up all the settings
-files and generate two scripts: <b>salome.sh</b> and <b>salome.csh </b>for
- sh and csh correspondingly. Such approach helps to save time when reinstalling
- products and you may not to care about setting all environment variables
-manually to build/launch SALOME. What you need is just to use one of these
-scripts. </p>
-
-<p>This concerns also those products which are not currently installed. For
-example, you install some SALOME binaries to the directory where you have
-previously installed other products. Installation procedure still tries
-to collect environment files from the target directory if it find necessary
-products there. If some product is not found in the target directory the corresponding
-section of <b>salome.sh/salome.csh</b> files will be skipped. <br>
- For native products (<i><b>gcc, tcl, python, qt, sip, pyqt </b>for RedHat-8.0<b>)</b></i>
-instal script tries to find them using <b>$PATH</b> / <b>$LD_LIBRARY_PATH</b>
-variables and then in the system default directories (<b>/usr/bin, /usr/lib</b>
-etc., depending on the product). </p>
-
-<p>In any case you may edit <b>salome.*</b> files after installation procedure
- finishes, as you want. </p>
-
-<hr>
-<h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font> configuration
- <font color="#ff0000">file</font></h3>
- <font color="#000000">You can create your own configuration. Installation
- Wizard then can take it as command line argument to provide list of products
- you want to install with it. The list of products and some another settings
- for the Installation Wizard are provided in xml file. The default file which
-Installation Wizard looks for if no command line arguments ar given, is <b>config.xml</b>.
-This section describes the format of configuration file.</font> <br>
- <font color="#000000">Xml tags are in bold blue, optional sections/tags
-are in brackets.</font>
-<p><b><font color="#000099"><document></font></b> <br>
- <font color="#000000"><b> </b>[</font><b><font
- color="#000099"><config</font></b><font color="#000000"> [version=<install_wizard_version>]</font>
- <br>
- <font color="#000000">
- [caption=<install_wizard_caption>]</font> <br>
- <font color="#000000">
- [copyright=<install_wizard_copyright>]</font> <br>
- <font color="#000000">
- [license=<install_wizard_license_info>]</font> <br>
- <font color="#000000">
- [os=<target_platform>]</font><b><font color="#000099">/></font></b><font
- color="#000000">]</font> <br>
- <font color="#000000"><b> </b>[</font><b><font
- color="#000099"><path</font></b><font color="#000000"> [targetdir=<target_directory>]</font>
- <br>
- <font color="#000000">
- [tempdir=<temp_directory>]</font><b><font color="#000099">/></font></b><font
- color="#000000">]</font> <br>
- <font color="#000000"> [</font><b><font
- color="#000099"><product</font></b><font color="#000000"> name=<product_name></font>
- <br>
- <font color="#000000">
- version=<product_version></font> <br>
-
- [description=<product_description>]<br>
- <font color="#000000">
- install=<installation_mode></font> <br>
- <font color="#000000">
- supported=<supported_installation_modes></font> <br>
- <font color="#000000">
- disable=<disable_flag><br>
-
-[pickupenv=<pickup_env_flag>]</font><font color="#000000"><br>
-
-dependancies=<list_of_prerequisites></font> <font
- color="#000000"><br>
-
- installdiskspace=<install_disk_space></font> <font
+Please, read carefully the following information. This section
+describes how the installation procedure generates the environment
+scripts for the SALOME platform being installed.
+<p>After installing of each product shell the script creates special
+environment file for the product in its installation folder. The name
+of
+the file is generated
+from
+the name of product by the following scheme: <b>env_<product_name>.sh</b>
+(for example <b>env_Vtk.sh </b>for the Vtk).
+This file includes all necessary environment settings. At the final
+step of the installation the script picks up all the
+settings files and generate from them two common environment files: <b>salome.sh</b>
+and <b>salome.csh
+</b>for <span style="font-weight: bold;">bash</span> and <span
+ style="font-weight: bold;">csh</span> shells correspondingly. Such
+approach helps to save time
+when reinstalling products and you may not to care about setting all
+environment variables
+manually to build/launch SALOME. What you need is just to source one of
+these
+environment files. </p>
+<p>This concerns also those products which are not being installed.
+For example, you install some SALOME binaries to the directory where
+you have previously installed other products. Installation
+procedure tries to collect environment files from the target
+directory if it finds necessary products installed there. If some
+product is not
+found in the target directory the corresponding
+section of <b>salome.sh/salome.csh</b> files will be skipped. <br>
+For native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>
+installation procedure tries to find them first using <b>PATH</b>
+/ <b>LD_LIBRARY_PATH</b> variables and then in the system default
+directories (<b>/usr/bin, /usr/lib</b> etc., depending on the product).
+</p>
+<p>In any case you may edit <b>salome.*</b> files after installation
+procedure finishes, if you want.<br>
+<span style="font-weight: bold;"><br>
+Note:</span> as it was mentioned <a href="#env_files">above</a> there
+are another environment files which
+are generated by the installation procedure: <span
+ style="font-weight: bold;">env_products.csh</span> + <span
+ style="font-weight: bold;">env_products.sh</span> and <span
+ style="font-weight: bold;">env_build.csh</span> + <span
+ style="font-weight: bold;">env_build.sh</span>. These files can be
+found in the target installation root directory.<br>
+</p>
+<hr>
+<h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font>
+configuration <font color="#ff0000">file</font></h3>
+<font color="#000000">You can create your own XML configuration file.
+The Installation Wizard then can take it as command line argument to
+provide list of products you want to install with it. The list of
+products and some another settings for the Installation Wizard are
+provided in the XML file. The default file which Installation Wizard
+looks
+for if no command line arguments are given, is <b>config.xml</b>.<br>
+This
+section describes the structure of the configuration file.</font> <br>
+<font color="#000000">XML tags are in bold blue, optional sections/tags
+are in brackets.</font>
+<font face="Courier">
+<p><b><font color="#000099"><document></font></b>
+<br>
+<font color="#000000"><b> </b>[</font><b><font
+ color="#000099"> <config</font></b><font color="#000000">
+[ version=<install_wizard_version> ]</font> <br>
+<font color="#000000">
+ [
+caption=<install_wizard_caption> ]</font> <br>
+<font color="#000000">
+ [
+copyright=<install_wizard_copyright> ]</font> <br>
+<font color="#000000">
+ [
+license=<install_wizard_license_info> ]</font> <br>
+<font color="#000000">
+ [ os=<target_platform>
+]</font><b><font color="#000099"><br>
+ /></font></b><font color="#000000"> <br>
+ ]</font> <br>
+<font color="#000000"><b> </b>[ </font><b><font
+ color="#000099"><path</font></b><font color="#000000">
+[ targetdir=<target_directory> ]</font> <br>
+<font color="#000000">
+
+[ tempdir=<temp_directory> ]</font><b><font
+ color="#000099"><br>
+ /> </font></b><font color="#000000"><br>
+ ]</font> <br>
+<font color="#000000"><b> </b>[ </font><b><font
+ color="#000099"><button</font></b><font color="#000000">
+ label=<button_label> </font> <br>
+<font color="#000000">
+
+[ tooltip=<button_tooltip> ]</font> <br>
+<font color="#000000">
+
+ script=<button_script> </font> <br>
+<font color="#000000">
+
+[ disable=<disable_flag> ]</font><b><font
+ color="#000099"><br>
+ /> </font></b><font color="#000000"><br>
+ ]</font> <br>
+<font color="#000000"> [</font><b><font
+ color="#000099"> <button</font></b><font color="#000000"> ... </font><font
+ color="#000099"><br>
+ /<b>></b></font><br>
+<font color="#000000"> ]</font> <br>
+<font color="#000000"> [</font><b><font
+ color="#000099"> <product</font></b><font color="#000000">
+name=<product_name></font> <br>
+<font color="#000000">
+
+version=<product_version></font> <br>
+ [
+context=<product_context>
+]<br>
+ [
+description=<product_description> ]<br>
+<font color="#000000">
+
+install=<installation_mode></font> <br>
+<font color="#000000">
+
+supported=<supported_installation_modes></font> <br>
+<font color="#000000">
+ [ disable=<disable_flag>
+ ]<br>
+ [
+pickupenv=<pickup_env_flag> ]</font><font
color="#000000"><br>
-
- temporarydiskspace=<tmp_disk_space></font> <font
+
+
+dependancies=<list_of_prerequisites></font> <font
color="#000000"><br>
-
- script=<installation_script_name></font><font
- color="#000099">/<b>></b></font><font color="#000000">]</font> <font
+
+ installdiskspace=<install_disk_space></font>
+<font color="#000000"><br>
+
+ temporarydiskspace=<tmp_disk_space></font> <font
color="#000000"><br>
- [</font><b><font color="#000099"><product</font></b><font
- color="#000000"> ... </font><font color="#000099">/<b>></b></font><font
- color="#000000">]</font> <font color="#000000"><br>
- <b> .</b></font><b><font color="#000099">..</font></b>
-<b><font color="#000099"><br>
+
+ script=<installation_script_name></font><font
+ color="#000099"><br>
+ /<b>></b></font><font color="#000000">
+<br>
+ ]</font> <font color="#000000"><br>
+ [</font><b><font color="#000099"> <product</font></b><font
+ color="#000000"> ... </font><font color="#000099"><br>
+ /<b>></b></font><font color="#000000">
+<br>
+ ]</font><br>
+<font color="#000000"> ...</font><br>
+<b><font color="#000099">
</document></font></b> </p>
-
+</font>
<h4><font color="#000000"><config> section</font></h4>
- <font color="#000000">This is optional section - contains general information
- Installation Wizard itself.</font>
-<ul>
- <li> <font color="#000000"><b>version</b>: Installation Wizard's version
- number;</font></li>
- <li> <font color="#000000"><b>caption</b>: Installation Wizard's main
-window title - if this string contains '%1' text - the title will contain
-in this place version number (see above);</font></li>
- <li> <font color="#000000"><b>copyright</b>: Installation Wizard's copyright
- information (appears on the first page of program);</font></li>
- <li> <font color="#000000"><b>license</b>: Installation Wizard's license
- information (appears on the first page of program);</font></li>
- <li> <font color="#000000"><b>os</b>: Contains directory name (relative
- from ./Products/BINARIES) where Installation Wizard should search precompiled
- binaries packages. If this tag is skipped, binaries are implied to be in
-the ./Products/BINARIES directory.</font></li>
-
-</ul>
-
+<font color="#000000">This is optional section; it provides general
+information about Installation Wizard itself.<br>
+<br>
+Attributes:<br>
+</font>
+<ul>
+ <li> <font color="#000000"><b>version</b></font></li>
+</ul>
+<font color="#000000">The application version number to be shown in the
+caption.</font>
+<ul>
+ <li> <font color="#000000"><b>caption</b></font></li>
+</ul>
+<font color="#000000">The application main window caption - if this
+string contains '%1' text the title will
+contain
+in this place the version number (see above).</font>
+<ul>
+ <li> <font color="#000000"><b>copyright</b></font></li>
+</ul>
+<font color="#000000">The application
+copyright information (shown in the first page).</font>
+<ul>
+ <li> <font color="#000000"><b>license</b></font></li>
+</ul>
+<font color="#000000">The application license information (shown in the
+first page).</font>
+<ul>
+ <li> <font color="#000000"><b>os</b></font></li>
+</ul>
+<font color="#000000">This parameter defines the directory (relative
+from ./Products/BINARIES) where the Installation Wizard will
+search precompiled binaries packages. If this tag is not provided,
+binaries packages are looked for in
+the ./Products/BINARIES directory.</font>
<h4> <b><font color="#000000"><path> section</font></b></h4>
- This is optional section - contains default directories.
+This is optional section; it defines default installation directories.<br>
+<font color="#000000"><br>
+Attributes:</font><br>
+<ul>
+ <li> <font color="#000000"><b>targetdir</b></font></li>
+</ul>
+<font color="#000000">The target
+directory - the path to the directory where products should be
+installed.</font>
<ul>
- <li> <font color="#000000"><b>targetdir</b>: Starting target directory
-- path to the directory where products should be installed;</font></li>
- <li> <font color="#000000"><b>tempdir</b>: Starting temp directory -
-path to the directory for the temporary files.</font></li>
-
+ <li> <font color="#000000"><b>tempdir</b></font></li>
</ul>
-
+<font color="#000000">The temporary directory -
+the path to the directory for the temporary files.</font>
<h4> <b><product> section</b></h4>
- This section describes product to be installed with the Installation Wizard.
- All tags are obligatory. Products appears in the products tree and are installed
-in the order they are described in the configuration file. It is recommended
-to insert native products at the top of the list before all other products.
-
-<ul>
- <li> <font color="#000000"><b>name</b>: Name of the product;</font></li>
- <li> <font color="#000000"><b>version</b>: Version of the product;</font></li>
- <li><font color="#000000"><span style="font-weight: bold;">description</span>:
- Description of the product (optional);<br>
- </font></li>
- <li> <font color="#000000"><b>supported</b>: Supported modes of installation,
- should contain one or more of the following options, separated by comma:
- <i>install sources</i>, <i>install binaries</i>, <i>use native</i>. Installation
- script should contain corresponding functions for each of supported installation
- modes;</font></li>
- <li> <font color="#000000"><b>install</b>: Default (starting) installation
-mode;</font></li>
- <li> <font color="#000000"><b>disable</b>: If this flag has 'true' value,
-corresponding product will not appear in the list of products tree and will
-not be installed;</font></li>
- <li><b>pickupenv</b>: This flag points that pickup environment procedure
-should be performed for this module. If this flag equal to <b>true</b>, salome.sh
-and salome.csh files will be created in the product's installation
-directory. This is optional key, default value is <b>false.</b><br>
- </li>
- <li> <font color="#000000"><b>dependancies</b>: list of prerequisite
-products, which are necessary to build this product, separated by comma;</font></li>
- <li> <font color="#000000"><b>installdiskspace</b>: Total amount space
- (integer, in Kbytes), which product occupies on the hard drive after the
-installation;</font></li>
- <li> <font color="#000000"><b>temporarydiskspace</b>: Disk space (integer,
-in Kbytes) for the temporary files, which is necessary to build the product
- from the sources;</font></li>
- <li> <font color="#000000"><b>script</b>: Installation script name. This
- script is in charge of installation of the product. It is called when necessary
- from the main program. See <a href="#new_products">next section</a> for
-more information.</font></li>
-
-</ul>
- <b>Note:</b> If you add new products to be installed with Installation
-Wizard, you should also provide installation script for this product. See
-next section for more details.
-<hr>
+This section describes product to be installed with the Installation
+Wizard. XML file should include <product> section for each
+product to be installed. The products appear in the tree view
+and are installed in the order they are described in the configuration
+file. It is recommended (but not obligatory) to define native products
+at the top of the
+list before all other products.<br>
+<font color="#000000"><br>
+Attributes:</font><br>
+<ul>
+ <li> <font color="#000000"><b>name</b></font></li>
+</ul>
+<font color="#000000">The name of the product.</font>
+<ul>
+ <li> <font color="#000000"><b>version</b></font></li>
+</ul>
+<font color="#000000">The version of the product.</font>
+<ul>
+ <li> <font color="#000000"><b>description</b></font></li>
+</ul>
+The <font color="#000000">product </font><font color="#000000">description
+(optional).</font>
+<ul>
+ <li> <font color="#000000"><b>context</b></font></li>
+</ul>
+<font color="#000000">Context (optional). The possible values are <b>'salome
+sources'</b>, <b>'salome
+binaries'</b> and <b>'prerequisite'</b> (several context can be given
+separated by ":" symbol).</font>
+<ul>
+ <li> <font color="#000000"><b>supported</b></font></li>
+</ul>
+<font color="#000000">Supported modes of
+installation. Several modes can be separated by comma. Possible value
+are: <i>install sources</i>, <i>install binaries</i>, <i>use
+native</i>. Installation script should contain the corresponding
+functions
+for each of the supported installation modes (see <a
+ href="#new_products">here</a>).</font>
+<ul>
+ <li> <font color="#000000"><b>install</b></font></li>
+</ul>
+<font color="#000000">Default (starting)
+installation mode.</font>
+<ul>
+ <li> <font color="#000000"><b>disable</b></font></li>
+</ul>
+<font color="#000000">If this optional flag has 'true'
+value, the corresponding product will not appear in the list of
+products and will not be installed.</font>
+<ul>
+ <li><b>pickupenv</b></li>
+</ul>
+This flag points that pickup environment
+procedure
+should be performed for this product. If this flag equal to 'true',
+ salome.sh
+and salome.csh files will be created in the product's
+installation
+directory. Usually this option is set to true for SALOME KERNEL module
+sources and binaries package. This is optional key, default value is
+'false'<b>.</b><br>
+<ul>
+ <li> <font color="#000000"><b>dependancies</b></font></li>
+</ul>
+<font color="#000000">List of prerequisite
+products, which are necessary to build this product, separated by comma.</font>
+<ul>
+ <li> <font color="#000000"><b>installdiskspace</b></font></li>
+</ul>
+<font color="#000000">Total amount
+space (integer, in Kbytes), which product occupies on the hard drive
+after the
+installation.</font>
+<ul>
+ <li> <font color="#000000"><b>temporarydiskspace</b></font></li>
+</ul>
+<font color="#000000">Disk space
+(integer, in Kbytes) for the temporary files, which is necessary to
+build the product from the sources.</font>
+<ul>
+ <li> <font color="#000000"><b>script</b></font></li>
+</ul>
+<font color="#000000">The installation script name.
+This script is in charge of the installation of the product. It is
+called
+automatically by the Installation Wizard when necessary from the main
+program. See the <a href="#new_products">next
+section</a> for
+more information.</font><br>
+<h4> <b><button> section</b></h4>
+This is optional section. It allows customing of the last <i>"Finish
+installation"</i> page of the Installation Wizard by adding one or
+more buttons in the lower part of the wizard's window. The script
+which is attached to each such button, can perform some specific
+action, for example, launch the application or show the Release Notes
+file by using external program.
+See <a href="#finish_buttons">here</a> for more details about
+writing scripts.<br>
+<font color="#000000"><br>
+Attributes:</font><br>
+<ul>
+ <li> <font color="#000000"><b>label</b></font></li>
+</ul>
+<font color="#000000">This is the button text.</font>
+<ul>
+ <li> <font color="#000000"><b>tooltip</b></font></li>
+</ul>
+<font color="#000000">The button's tooltip (optional).</font>
+<ul>
+ <li> <font color="#000000"><b>script</b></font></li>
+</ul>
+<font color="#000000">The script attached to the button.</font>
+<ul>
+ <li> <font color="#000000"><b>disable</b></font></li>
+</ul>
+<font color="#000000">If this optional flag has 'true'
+value, the corresponding button will not appear in the <i>"Finish
+installation"</i> page - the section of XML file is silently
+ignored.</font><br>
+<br>
+<b>Note:</b> If you add new products to be
+installed with Installation Wizard, you should also provide
+installation script for this product. See the next section for more
+details.
+<p><br>
+</p>
+<hr>
<h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
- scripts</font> for the new products</h3>
- When you want some product to be installed with the Installation Wizard,
- you should add it's description it <a href="#xml_files">in the configuration
- file</a> and create bash installation script, following described in this
- section rules. <br>
- There are some obligatory functions to be provided in this installation
-script. These functions are automatically called by master installation script
-or/and GUI shell when it is necessary.<br>
-<font color="#000000">File <b>common.sh</b> contains some service functions
-which can be used in your installation script, like <b>make_env()</b>,<b>
-make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b> find_in_path()</b>,
-etc.</font>
-<ul>
- <li> <b>check_version()</b>: This function allows to check the
-version of the product already installed on the computer. It should try
-to find product (native or preinstalled in the target directory) and check
-it version. This helps to avoid unnecessary reinstallation. This is internal
-function and is not called</li>
- <li> <b><font color="#000000">try_native()</font></b><font
- color="#000099">: </font><font color="#000000">This function is called when
- <i>'use native' </i>installation mode is selected by the user. The function
-should try to find native version of the product and define possibility of
-it usage. Should create environment for the product in the temporary directory
-(see also description of <b>print_env(</b>) function). If you do not provide
-native mode installation, you can omit this function.</font></li>
- <li> <font color="#000000"><b>install_source()</b>: This function is
-called when <i>'install sources</i>' installation mode is selected by the
-user. The function is responsible for the building of the product from the
-sources package. Should create environment for the product in the temporary
-directory (see also description of <b>print_env(</b>) function). If you do
-not provide sources mode installation, you can omit this function</font></li>
- <li> <font color="#000000"><b>install_binary()</b>: This function is
-called when <i>'install binaries'</i> installation mode is selected by the
-user. The function is responsible for the extracting of the product from
-the binaries package. Should create environment for the product in the temporary
-directory (see also description of <b>print_env(</b>) function). If you do
-not provide binaries mode installation, you can omit this function.</font></li>
- <li> <b>try_preinstalled()</b>: <font color="#000000">This function is
- called when<i> 'not install'</i> installation mode is selected by the user.
-In this case script should inspect target directory to try to find already
- preinstalled product, pick up and check environment from there. See <a
- href="#pick_up_env">here</a> for more details.</font></li>
- <li> <font color="#000000"><b>print_env()</b>: This function is in charge
-of creation environment script. It should create file with name </font><b>env_<product_name>.sh</b>
- in the temporary directory and then copy it into the product installation
- directory. The file should contain all necessary environment variables settings
-for the product. It will be collected during the 'pick-up-environment' procedure.</li>
- <li><b>pickup-env()</b>: This procedure corresponds <b>pickupenv</b> tag
-of the configuration xml file (see previous section). Should call <b>make_env</b>
-procedure to perform pick-up environment procedure for the product.<br>
- </li>
-
+scripts</font> for the new products</h3>
+When you want some product to be installed with the Installation
+Wizard, you should add it's description it <a href="#xml_files">in the
+configuration file</a> and create the installation script, following
+rules described in this section. <br>
+<br>
+There are some obligatory functions which should be implemented in this
+installation
+script. These functions are automatically called by master installation
+script
+or/and its GUI shell when it is necessary.<br>
+<font color="#000000">File <b>common.sh</b> contains some service
+functions
+which can be used in your installation script, like <b>make_env()</b>,<b>
+make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b>
+find_in_path()</b>,
+etc.</font>
+<ul>
+ <li> <b>check_version()</b></li>
+</ul>
+This function allows to check the
+version of the product already installed on the computer. It should try
+to find product (native or preinstalled in the target directory) and
+check
+its version. This helps to avoid unnecessary reinstallation. This is
+internal
+function and is not called from the master installation script.<br>
+<ul>
+ <li> <b><font color="#000000">try_native()</font></b></li>
+</ul>
+<font color="#000000">This function is
+called when <i>'use native' </i>installation mode is selected by the
+user. The function should try to find native version of the product and
+define possibility of its usage. It should create the environment file
+for the
+product in the temporary directory (see also description of <b>print_env(</b>)
+function). I</font><font color="#000000">t is not necessary to
+implement
+this function i</font><font color="#000000">f you do not provide native
+mode. installation.<br>
+</font>
+<ul>
+ <li> <font color="#000000"><b>install_source()</b></font></li>
+</ul>
+<font color="#000000">This function is
+called when <i>'install sources</i>' installation mode is selected by
+the
+user. The function is responsible for the building of the product from
+the
+sources package. It should create the environment file for the product
+in the
+temporary
+directory (see also description of <b>print_env(</b>) function). </font><font
+ color="#000000">I</font><font color="#000000">t is not necessary to
+implement
+this function i</font><font color="#000000">f you do not provide </font><font
+ color="#000000">sources mode installation.</font>
+<br>
+<ul>
+ <li> <font color="#000000"><b>install_source_and_build()</b></font></li>
</ul>
- <font color="#000000">The calling signature of the product installation
-script is following:</font> <br>
- <b><font color="#000000"><product_script_name> <function_name>
- <temp_folder> <products_directory> <target_directory>
-<dependancies> <product_name></font></b>
+<font color="#000000">This function is
+called when SALOME module is installed and the <span
+ style="font-weight: bold;">--all-from-sources</span> (<span
+ style="font-weight: bold;">-a</span>) option is used (<span
+ style="font-style: italic;">"Build SALOME sources"</span> check box in
+GUI mode). This function should be used to unpack SALOME sources
+package and then call build/install procedure for it.<br>
+For more details please refer to the <a href="#install_from_wizard">this</a>
+and <a href="#gui_mode">this</a> sections for more details.<br>
+</font>
+<ul>
+ <li><font color="#000000"><b>install_binary()</b></font></li>
+</ul>
+<font color="#000000">This function is
+called when <i>'install binaries'</i> installation mode is selected by
+the
+user. The function is responsible for the extracting of the product
+from
+the binaries package. It should create environment for the product in
+the
+temporary
+directory (see also description of <b>print_env(</b>) function).</font><font
+ color="#000000"> I</font><font color="#000000">t is not necessary to
+implement
+this function i</font><font color="#000000">f you do not provide </font><font
+ color="#000000">binaries</font><font color="#000000"> mode
+installation.</font><font color="#000000"> <br>
+</font>
+<ul>
+ <li> <b>try_preinstalled()</b></li>
+</ul>
+<font color="#000000">This function
+is called when<i> 'not install'</i> installation mode is selected by
+the user. In this case script should inspect target directory to try to
+find already preinstalled product, pick up and check environment from
+there. See <a href="#pick_up_env">here</a> for more details.</font>
+<ul>
+ <li> <font color="#000000"><b>print_env()</b></font></li>
+</ul>
+<font color="#000000">This function is in
+charge of creation environment script. It should create file with name </font><b>env_<product_name>.sh</b>
+in the temporary directory and then copy it into the product
+installation directory. The file should contain all necessary
+environment variables settings for the product. It will be collected
+during the 'pick-up-environment' procedure.
+<ul>
+ <li><b>pickup_env()</b></li>
+</ul>
+This procedure corresponds <b>pickupenv</b>
+tag
+of the configuration xml file (see previous section). It should call <b>make_env</b>
+procedure to perform pick-up environment procedure for the product.<br>
+<br>
+<font color="#000000">The calling signature of the product installation
+script is the following:</font> <br>
+<b><font color="#000000"><product_script_name>
+<function_name> <temp_folder> <products_directory>
+<target_directory>
+<dependancies> <product_name></font></b>
<p><font color="#000000">where</font> <br>
- <font color="#000000"><b><product_script_name></b> - installation
+</p>
+<p><font color="#000000"><b><product_script_name></b> -
+installation
script name (described in configuration xml file);</font> <br>
- <font color="#000000"><b><function_name></b> - the name of function,
- corresponding to the selected installation mode: <i>try_native, install_source,
- install_binary</i> or <i>try_preinstalled</i>;</font> <br>
- <font color="#000000"><b><temp_folder></b> - temporary files directory;</font>
- <br>
- <font color="#000000"><b><products_directory></b> - directory where
- the sources/binaries package can be found. You should provide sources package
- in the <i><Install_Wizard_root_directory>/Products/SOURCES</i> directory
- and binaries package in the <i><InstallWizard_root_directory>/Products/BINARIES/<os_version></i>,
- where <os_version> is target platform description, which appears in
- the corresponding section of the <a href="#xml_files">configuration xml
-file</a>.</font> <br>
- <font color="#000000"><b><target_directory></b> - root target directory
- where product should be installed to;</font> <br>
- <font color="#000000"><b><dependancies></b> - single-quoted list
+<font color="#000000"><b><function_name></b> - the name of
+function, corresponding to the selected installation mode: <i>try_native,
+install_source, install_binary</i> or <i>try_preinstalled</i>;</font> <br>
+<font color="#000000"><b><temp_folder></b> - temporary files
+directory;</font> <br>
+<font color="#000000"><b><products_directory></b> - directory
+where the sources/binaries package can be found. You should provide
+sources package in the <i><Install_Wizard_root_directory>/Products/SOURCES</i>
+directory and binaries package in the <i><InstallWizard_root_directory>/Products/BINARIES/<os_version></i>,
+where <os_version> is target platform description, which appears
+in the corresponding section of the <a href="#xml_files">configuration
+xml
+file</a>.</font> <br>
+<font color="#000000"><b><target_directory></b> - root target
+directory where product should be installed to;</font> <br>
+<font color="#000000"><b><dependancies></b> - single-quoted list
of prerequisite products, separated by space;</font> <br>
- <font color="#000000"><b><product_name> </b>- product name itself.</font>
- </p>
-
+<font color="#000000"><b><product_name> </b>- product name
+itself.</font> </p>
<p><font color="#000000">Example:</font> <br>
- <i><font color="#000000">med-2.2.2.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0
- /usr/salome 'gcc Hdf' med</font></i> </p>
-
+<i><font color="#000000">med-2.2.3.sh install_binary /tmp/work
+./Products/BINARIES/Mandrake10.1 /usr/salome 'gcc Hdf' med</font></i> </p>
<p><font color="#000000">Copy created script into the <i><Install_Wizard_root_directory>/config_files</i>
- sub-directory where all installation scripts are stored. Installation Wizard
-will automatically search and call your script during the installation procedure.</font>
+sub-directory where all installation scripts are stored. Installation
+Wizard
+will automatically search and call your script during the installation
+procedure.</font>
</p>
-
<hr> <br>
- <br>
+<h3><a name="finish_buttons"></a>Customizing <font color="#ff0000">Readme
+page</font> buttons</h3>
+The Installation Wizard allows customizing the look-n-feel of the last
+<i>"Finish installation"</i> page. If you want to add one or more
+buttons to this page in order to perform some specific actions at the
+end of the installation (for example, show Release Notes file by using
+Open Office) you can put an additional section to the XML
+configuration file. This is the <b><button></b> section (see <a
+ href="#xml_files">here</a> for more details).
+<p><br>
+</p>
+To implement the action which will be performed when the user click on
+the button, you need to create a script and put it to the
+<i><Install_Wizard_root_directory>/config_files</i> directory.<br>
+There are some obligatory functions which should be implemented in this
+script. These functions are automatically called by the Installation
+Wizard GUI.
+<ul>
+ <li><b>check_enabled()</b></li>
+</ul>
+This procedure is called by the Installation Wizard when the
+<i>"Finish installation"</i> page is displayed and the status of the
+buttons should be modified according to the installation options. This
+procedure should return <b>0</b> if the corresponding action can be
+performed and, thus, the button should become enabled. Otherwise, it
+should return <b>1</b> - in this case the corresponding button will be
+disabled.
+<ul>
+ <li><b>execute()</b></li>
+</ul>
+This procedure is invoked when the user clicks the button. This
+procedure should return <b>0</b> if the corresponding action is done
+successfully and <b>1</b> if any error occurs.<br>
+<br>
+The calling signature of the script is the following:<br>
+<b><font color="#000000"><product_script_name>
+<function_name> <target_directory> <temp_folder></font></b>
+<p><font color="#000000">where</font> <br>
+</p>
+<p><font color="#000000"><b><product_script_name></b> -
+the script name itself (retrieved from the XML configuration xml
+file);</font> <br>
+<font color="#000000"><b><function_name></b>
+- the name of function;</font> <br>
+<font color="#000000"><b><target_directory></b> - root target
+directory where product are
+installed to;</font> <br>
+<font color="#000000"><b><temp_folder>
+</b> - temporary files directory;</font> <br>
+<br>
+<b>Note:</b> The standard Installation Wizard buttons "Launch
+SALOME" and "Release Notes" are implemented with this
+feature. Refer to the scripts <b>start_salome.sh</b> and
+<b>release_notes.sh</b> for sample implementation.<br>
+<br>
+<b>Note:</b> Any button (even standard) can be ignored by the
+Installation Wizard if the attribute <b><disable></b> in the XML
+configuration file is set to the "true" value.
+</p>
+<hr><br>
</body>
</html>
