<!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>PAL/SALOME v2.0.0 Installation Wizard Help</title>
+ content="Alexander KOVALEV, Open CASCADE SAS (alexander.kovalev@opencascade.com)">
+ <meta name="Copyright" content="2002-2014 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">PAL/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="45" width="104">
- </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.0.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">7.5.1</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="#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 has several
-options of installation: you have a possibility to use native products, install
-already precompiled binaries, build product from the sources or not installed
-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="525" width="565" 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
-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="525" width="565" 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
-follow to the <a href="#ProgressPage">next page</a>. </p>
-
-<center><a name="ProgressPage"></a><br>
- <img src="progresspage.png" height="525" width="565" 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
-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
-or click <i>"Next"</i> button to go the Readme page: </p>
-
-<center>
-<p><a name="readmepage"></a><br>
- <img src="readmepage.png" height="525" width="565" 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>
-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</span></span><b><i>
-module 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=`/usr/bin/gcc --version | grep 'gcc (GCC) .*' | cut -b 11-13`</td>
- <td>
- <center>-</center>
- </td>
- <td>ver should be equal 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>Cascade 5.1.2<br>
- </td>
- <td>existence of CASROOT environment variable</td>
- <td>set CASROOT if you have preinstalled version of CASCADE</td>
- <td>Unfortunately we can't say anything exactly about CASCADE 5.1.2
-and we only check CASROOT environment variable. If you have problem with
-preinstalled version of CASCADE reinstall it</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.1.6</td>
- <td>existence of MED2HOME <br>
- existence of libmed.so.0.0.0</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.0.0.0 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.
+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 GUI mode.<br>
+The default installation settings can be overridden 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 the 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;">
+This is the XML configuration file used by the Installation Wizard.
+If this option is not used, the installation script tries to define
+the<i>Linux </i>version and to use the corresponding XML file
+if it is present.
+For example, for <span style="color: rgb(0, 0, 153);">Linux Mandriva
+2010</span> the <b>config_Mandriva_2010.0.xml</b>
+file
+will be used by default.
+</div>
+<p> <b>-d DIR / --target=DIR</b><br>
+</p>
+<div style="margin-left: 40px;">This is the target installation
+directory for SALOME platform. 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;">This is the directory, 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>
+<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>
+<b>Note, that this is long-time operation which can take more than
+24 hours depending on the computer.</b><br>
+</div>
+<p><b>-s / --single-directory </b></p>
+<div style="margin-left: 40px;">Install all SALOME binaries packages
+to one directory.<br>
+<b>This option is ignored when --all-from-sources (-a) option is used.
+</b></div>
+<p><b>-h / --help</b><br>
+</p>
+<div style="margin-left: 40px;">Prints help information on
+the usage of the Installation Wizard. <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 version number of the Installation Wizard, 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 3d-party installation prerequisite products, which
+are required by SALOME platform. Among supported Linux platforms there are Mandriva 2008
+(32bit and 64bit), Mandriva 2010 (32bit and 64bit), Debian 4.0 Etch (32bit and 64bit),
+Debian 5.0 Lenny 64bit, Debian 6.0 Squeeze 64bit and other ones.<br>
+The usage of configuration XML files provides a flexible way to modify
+the list of products to be installed by the Installation Wizard without
+changing the source code of the application. 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 GUI of the <font color="#ff0000">Installation Wizard</font> has been
+developed with <span style="font-weight: bold;"><span style="color: rgb(0, 0, 153);">Qt
+3.3.8 </span> </span>toolkit by <span style="color: rgb(0, 0, 153);">
+Trolltech </span>. 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
+confirmation. <i>"Help"</i> button opens a window with the help information. </p>
+<p>The first "<span style="font-style: italic;">Introduction"</span>
+page is shown in <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: 606px; height: 422px;">
+<p><b>Figure 1:</b> "Introduction" page</p>
+</center>
+<p>In the second page you are proposed to select the type of the
+SALOME installation.<br>
+<br>
+At this step three possible types of installation are available:<br>
+</p>
+<ol>
+ <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install binaries"</b></font></span>
+type:<br>
+ <ul>
+ <li>all binaries and sources of the chosen modules are
+installed;</li>
+ <li>all binaries of the chosen prerequisites are installed.</li>
<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.
+ </ul>
+ </li>
+ <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install sources"</b></font></span>
+type:<br>
+ <ul>
+ <li>all sources of the chosen modules and prerequisites are
+installed without compilation.</li>
<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 1.4.x</td>
- <td>MODULE binaries should exist and ver should be equal to 1.4.x</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 1.4.x</td>
- <td>MODULE sources should exist and ver should be equal to 1.4.x</td>
- </tr>
-
- </tbody>
-</table>
-
-<p>Note: 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>
-
-<h3>
-<hr></h3>
-
+ </ul>
+ </li>
+ <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install sources and
+make compilation"</b></font></span> type:<br>
+ <ul>
+ <li>all sources of the chosen modules and prerequisites are
+installed;</li>
+ <li>all sources are compiled.</li>
+ </ul>
+ </li>
+</ol>
+<p></p>
+<p>In case you select "Install sources and make compilation"
+installation type, then you can also check "Remove sources and
+temporary files after compilation" option.
+</p>
+<center><a name="Installation_type_page"></a><br>
+<img alt="Installation type page" src="installtypepage.png" style="width: 606px; height: 422px;">
+<p><b>Figure 2:</b> "Type of installation" page
+</p>
+</center>
+<p>After the installation type has been selected you click <i>"Next"</i>
+button and the Installation Wizard tries to determine the Linux
+platform to load the corresponding configuration file. If the operating
+system is not defined or the current SALOME package does not support
+this system, the warning message will appear ("<i>Install binaries</i>"
+and "<i>Install sources</i>" installation types only):
+</p>
+<center><a name="Platform_page"></a><br>
+<img alt="Platform page" src="platformpage.png" style="width: 603px; height: 420px;">
+<p><b>Figure 3:</b> "Installation platform" page
+</p>
+</center>
+<p>If "<i>Install sources and make compilation</i>"
+installation type has been selected, the warning message will be
+slightly different: "<i>Your Linux platform is not supported by
+this SALOME package and compilation is not tested on this one</i>".<br>
+There is a list of all platforms supported by SALOME, but only those
+supported by the current package are available for selection. in this
+page you need to to select the reference platform, if you wish to
+proceed with the present installation procedure.<br>
+<b>Note:</b> this page is not displayed if the installation
+platform has been defined automatically.
+</p>
+<p>In the next page you are proposed to enter the target
+installation directory for SALOME platform. You can also press <i>"Browse..."</i>
+button and choose the destination folder using the standard browse
+directory dialog box. <br>
+If the necessary directory does not exist you are
+prompted to confirm the directory creation. If you type a wrong
+directory
+path, or if you do not have the permissions to write to the chosen
+directory, the corresponding message box is shown.<br>
+</p>
+<p><b>Note: you are strongly recommended to avoid using
+directory names containing spaces.</b> Otherwise you can
+experience some troubles with the
+installation.
+</p>
+<center><a name="Directory_page"></a><br>
+<img alt="Directory page" src="directorypage.png" style="width: 606px; height: 422px;">
+<p><b>Figure 4:</b> "Installation directory" page
+</p>
+</center>
+<p>You can select the products to be installed in the "Choice of
+the products to be installed" page.<br>
+In the default mode it gives you the possibility to view and select
+SALOME modules only. There is a hidden list of 3d-party prerequisite
+products. To show it, just click "<i>Show prerequisites...</i>"
+button.
+</p>
+<center><a name="Products_page1"></a><br>
+<img alt="Products page (default mode)" src="productpage1.png" style="width: 606px; height: 422px;">
+<p><b>Figure 5:</b> Choice of the SALOME modules
+</p>
+</center>
+<p>In the full mode you also have the possibility to select
+prerequisites.<br>
+The checkbox before each product indicates if this one will be
+installed or not (checked or unchecked). The second column shows the
+disk space occupied by the corresponding module. This value depends on
+the selected type of installation.<br>
+To hide the prerequisites list - click "<i>Hide prerequisites</i>"
+button.</p>
+<center><a name="Products_page2"></a><br>
+<img alt="Products page (full mode)" src="productpage2.png" style="width: 606px; height: 422px;">
+<p><b>Figure 6:</b> Choice of the prerequisites
+</p>
+</center>
+<p>
+Some products may require some other prerequisite products to be
+installed. So the installation procedure has a special feature to
+automatically mark these products in the list view. For example, to
+install PyQt it is necessary to have gcc, Python, Qt and Sip installed,
+and these products will be also turned on when you check on PyQt. GEOM
+module requires KERNEL, GUI modules and such prerequisites as:
+OpenCascade, Python, Swig, Qt, etc.
+</p>
+<p>The dependencies between SALOME modules are managed in the
+following way:
+</p>
+<ul>
+ <li>If one module is unchecked, all modules which depend on
+this one are also unchecked automatically;</li>
+ <li>If one module is checked, all modules required for this one
+are also checked automatically.</li>
+</ul>
+<p></p>
+<p>Dependency between modules and prerequisites is realized in
+the following way:
+</p>
+<ul>
+ <li>The choices made by the user in the list of modules have a
+direct impact on the list of prerequisites;</li>
+ <li>Whenever a module is checked, all the necessary
+prerequisites are checked automatically with no possibility for the
+user to uncheck them (see <a href="#Products_page3">Fig.7</a>
+below);</li>
+ <li>Whenever a module is unchecked, according to the remaining
+checked modules, the unnecessary prerequisites are unchecked
+automatically (see <a href="#Products_page3">Fig.7</a>
+below).</li>
+</ul>
+It is possible to check again the prerequisites, which have been
+automatically unchecked. In other words, it is possible to add more
+prerequisites than necessary.
+<p></p>
+<center><a name="Products_page3"></a><br>
+<img alt="Products page (dependencies presentation)" src="productpage3.png" style="width: 606px; height: 422px;">
+<p><b>Figure 7:</b> Dependencies between modules and
+prerequisites
+</p>
+</center>
+<p>The "<i>Installation with GUI</i>" checkbox allows
+managing the installation of the graphical interface. Only modules for that
+'woguimode' attribute is set to "true" value in the XML file
+(see <a href="#xml_files">here</a> for more information about
+customizing this installation mode) support without GUI mode and
+will be checked and installed with their necessary prerequisites in
+case of installation without GUI. And other modules are unchecked with no
+possibility to check them in this mode (see <a href="#Products_page4">figure</a> below).<br>
+By default 'Installation with GUI' checkbox is switched on.
+</p>
+<center><a name="Products_page4"></a><br>
+<img alt="Products page (Installation without GUI)" src="productpage4.png" style="width: 606px; height: 422px;">
+<p><b>Figure 8:</b> Installation without GUI mode
+</p>
+</center>
+<p>The box at the right side of the page displays the information
+about the currently selected product: name, version and short description,
+required disk space, disk space required for the temporary files and
+the list of prerequisites (this information is provided in the XML
+file).
+</p>
+<p>The <i>"Disk space required:"</i> field displays
+how much
+disk space on the hard drive is required for installation of the
+selected
+products.<br>
+<b>Note:</b> please, take into account that the displayed
+amount of
+the required disk space is approximate and may differ when you actually
+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 the required disk space on the hard drive for
+extracting and compiling the selected products. You can change the
+temporary directory (this information is provided in the XML file) to
+the folder you want.<br>
+<span style="font-weight: bold;">Note:</span>
+actually, the temporary files
+are not stored directly in the directory selected by the user. The
+Installation Wizard creates in this directory an additional folder
+named
+like INSTALLWORK<span style="font-weight: bold;">XXXXX</span>
+where XXXXX is a unique number. This allows launching several
+Installation Wizards simultaneously. This temporary directory is
+removed automatically when the installation finishes.<br>
+</p>
+<p>The installation procedure also checks the available disk
+space. If
+there is not enough disk space on your hard drive you will see the
+corresponding error message box.
+</p>
+<p>Also in the current version of Installation Wizard is possible
+to install all binaries of the selected SALOME modules into a <b>single</b>
+directory. It is "<i>SALOME</i>" directory.
+For this purpose there is a checkbox "<i>Install modules to a
+single directory</i>" checkbox exists (see <a href="#Products_page4">Fig.8</a>).<br>
+This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH
+environment variables.<br>
+<b>Note:</b> the installation into a single directory is
+available with the binaries installation type only.
+</p>
+<p>To proceed further, click <i>"Next"</i> button.
+At this moment
+the program will make some tests to check the installation settings: if
+there is enough disk space on the hard drive, check for the
+dependencies 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 alt="Choice page" src="choicepage.png" style="width: 606px; height: 422px;">
+<p><b>Figure 9:</b> "Check your choice" page
+</p>
+</center>
+<p>This page summarizes the installation options you've selected
+in the
+previous pages. You can review again your choices and change them if
+necessary returning to the previous pages. <br>
+When you are sure that everything is OK, press <i>"Next"</i>
+button to
+follow to the <a href="#ProgressPage1">progress page</a>.
+</p>
+<center><a name="ProgressPage1"></a><br>
+<img alt="Progress page (not started yet)" src="progresspage1.png" style="width: 606px; height: 422px;">
+<p><b>Figure 10:</b> "Installation progress" page:
+not started yet
+</p>
+</center>
+<div style="text-align: left;">To start the 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 frame of the dialog box.
+If any errors occur during the installation progress, the corresponding
+messages will be printed to the log window in the bold red font and
+installation process will be aborted with error message box. But user
+has possibility to change this default behaviour by
+<i>"Ignore errors"</i> checkbox. It is necessary to check
+it before start and all occured errors will be passed,
+and installation will be continued in any case.<br>
+</div>
+<div style="text-align: left;">It is possible to break the
+installation at any time by pressing <span style="font-style: italic;">"Stop"</span>
+button. Then you can get back to the previous pages if you wish to
+change the installation settings or restart the installation by
+pressing <span style="font-style: italic;">"Start"</span>
+button again.<br>
+</div>
+<p style="text-align: left;"><span style="font-weight: bold;">Note:</span>
+in the current
+implementation it is not possible to resume the stopped installation
+process; the installation will restart from the very beginning. <br>
+</p>
+<center><a name="ProgressPage2"></a><br>
+<img alt="Progress page (installation started)" src="progresspage2.png" style="width: 606px; height: 422px;">
+<p><b>Figure 11:</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 the installation of this product has not started
+yet. The product currently being installed is marked as "<font color="#ff9900">Processing</font>" and is displayed in
+the status bar under "Installation Status" view. All installed products
+have "<font color="#33ff33">Completed</font>"
+status.
+</p>
+<p>You can abort the 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 the temporary files can take some time, so the
+installation wizard will wait for 3 seconds before closing.
+</p>
+<p>At the end of the installation "<b>Installation completed</b>"
+message will appear in the status bar. You can return to the previous
+pages to start a new installation or click <i>"Next"</i>
+button to go to the readme page: </p>
+<center><a name="readmepage"></a><br>
+<img alt="Readme page" src="readmepage.png" style="width: 606px; height: 422px;">
+<p><b>Figure 12:</b> "Finish installation" page
+</p>
+</center>
+<p>In this page you can read important information about the
+Installation Wizard itself and some tips: how to run and test SALOME or
+how to build SALOME from the sources. This is also described 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 the 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>
+There are two exceptions: <b>--all-from-sources</b>
+(<b>-a</b>) 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) and <b>--single-directory</b> (<b>-s</b>) option which defines
+that all SALOME modules have to be installed into the one directory
+(SALOME_<version>, by default, where <version> is SALOME version).
+<center><a name="BatchMode"></a><br>
+<br>
+<img alt="Batch mode" src="batchmode.png"
+style="width: 745px; height: 415px;">
+<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 the procedure of launching SALOME. These
+shell scripts set
+all necessary environment variables for all products you have
+installed.
+To learn how the installation scripts collect 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>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
+between 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="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_paltform>]</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
- color="#000000"><br>
-
- temporarydiskspace=<tmp_disk_space></font> <font
- color="#000000"><br>
-
- script=<installation_script_name></font><font
- color="#000099">/<b>></b></font><font color="#000000">]</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>
+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 the installation of each product the shell script
+creates a special
+environment file for the product in its installation folder. The name
+of the file is generated from the name of the 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 settings files and
+generates 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. This
+approach helps to save time when reinstalling products and you may can
+avoid setting all environment variables
+manually to build/launch SALOME. What you need is to source one of
+these environment files. </p>
+<p>This also concerns the products which are not being installed.
+For example, you install some SALOME binaries to the directory where
+you have previously installed other products. The
+installation
+procedure tries to collect the environment files from the target
+directory if it finds necessary products installed there. If a
+product is not found in the target directory the corresponding
+section of <b>salome.sh/salome.csh</b> files will be
+commented. <br>
+For the native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>
+the 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 are able to edit <b>salome.*</b>
+files after the installation procedure finished.<br>
+<span style="font-weight: bold;"><br>
+Note:</span> as it has been mentioned <a href="#env_files">above</a>
+there
+are other environment files 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 can take it as a command line argument to
+provide a list of products you want to install with it. The list of
+products and some other settings for the Installation Wizard are
+provided in the XML file.<br>
+This section describes the structure of the configuration file.</font>
+<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=<application_version>
+ ]</font> <br>
+<font color="#000000">
+
+ [
+caption=<application_caption>
+ ]</font> <br>
+<font color="#000000">
+
+ [
+copyright=<application_copyright> ]</font>
+<br>
+<font color="#000000">
+
+ [
+license=<application_license_info> ]</font> <br>
+<font color="#000000">
+
+
+platforms=<target_platform></font> <br>
+<font color="#000000">
+
+ [
+targetdir=<target_directory>
+ ] </font>
+<br>
+<font color="#000000">
+
+
+[
+tempdir=<temp_directory>
+ ]</font>
+<br><font color="#000000">
+ [
+optionallibs=<optional_libraries> ]</font>
<b><font color="#000099"><br>
-</document></font></b> </p>
-
-<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>
-
-<h4> <b><font color="#000000"><path> section</font></b></h4>
- This is optional section - contains default directories.
-<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>
-
-</ul>
-
+ /> </font></b>
+<br>
+<font color="#000000"><b>
+</b>[ </font><b><font color="#000099"><buttons></font></b>
+<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><font color="#000099"><br>
+ <b>/></b>
+</font><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>
+<font color="#000099"><br>
+ <b></buttons></b>
+</font><font color="#000000"><br>
+ ]</font> <br>
+<font color="#000000"> [</font><b><font color="#000099"> <products></font></b>
+<br>
+<font color="#000000">
+[</font><b><font color="#000099">
+<product</font></b><font color="#000000">
+name=<product_name></font> <br>
+<font color="#000000">
+
+
+type=<product_type></font> <br>
+
+ [
+description=<product_description> ]<br>
+<font color="#000000">
+</font><b><font color="#000099">
+<installation</font></b><font color="#000000">
+os=<installation_platform></font> <br>
+<font color="#000000">
+
+
+
+version=<product_version></font> <br>
+<font color="#000000">
+
+
+ [
+disable=<disable_flag>
+ ]
+<font color="#000000"><br>
+
+
+ [
+woguimode=<without_gui_mode_flag> ]
+<font color="#000000"><br>
+
+
+installdiskspace=<install_disk_space></font><br>
+
+
+ [
+pickupenv=<pickup_env_flag>
+ ]</font>
+<font color="#000000"><br>
+
+
+
+
+script=<installation_script_name></font><br>
+<font color="#000099">
+<b>/></b></font><br>
+<font color="#000000">
+...</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>
+<font color="#000000"> </font><b><font color="#000099"> </products></font></b>
+<br>
+<font color="#000000"> ]</font><br>
+<font color="#000000"> [</font><b><font color="#000099"> <dependencies></font></b>
+<br>
+<font color="#000000">
+[</font><b><font color="#000099">
+<product</font></b><font color="#000000">
+name=<product_name></font><b><font color="#000099"> ></font></b> <br>
+<font color="#000000">
+[</font><b><font color="#000099">
+<dep></font></b> <font color="#000000"><prerequisite_name></font>
+<b><font color="#000099"> </dep></font></b>
+<font color="#000000">]</font><br>
+<font color="#000000">
+...</font><br>
+<font color="#000000"> </font><b><font color="#000099"> </product></font></b>
+<br>
+<font color="#000000">
+]</font><br>
+<font color="#000000">
+...</font><br>
+<font color="#000000"> </font><b><font color="#000099"> </dependencies></font></b>
+<br>
+<font color="#000000"> ]</font><br>
+<b><font color="#000099">
+</document></font></b> </font></p>
+
+<h4><font color="#000000"><config>
+section</font></h4>
+<font color="#000000">This section provides general
+information about an application that will be installed.<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
+the version number in this place (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>platforms</b></font></li>
+</ul>
+<font color="#000000">This parameter defines platforms for
+whose the configurations from this file will be used. Also it provides
+the directory name (relative from ./Products/BINARIES) where the
+Installation Wizard will search for precompiled binaries packages.</font>
+<ul>
+ <li> <font color="#000000"><b>targetdir</b></font></li>
+</ul>
+<font color="#000000">The target
+directory is the path to the directory where the products should be
+installed.</font>
+<ul>
+ <li> <font color="#000000"><b>tempdir</b></font></li>
+</ul>
+<font color="#000000">The temporary directory is
+the path to the directory for the temporary files.</font>
+<ul>
+ <li> <font color="#000000"><b>optionallibs</b></font></li>
+</ul>
+<font color="#000000">A list of names of libraries.
+An absence of these libraries in the user's system
+doesn't affect on the correct work of SALOME platform.</font>
+<h4> <b><buttons> section</b></h4>
+This is an optional section and may contains one or more
+<product> sections.
+<h4> <b><button> section</b></h4>
+This optional section allows customization of the last <i>"Finish
+installation"</i> page of the Installation Wizard by adding one
+or
+more buttons in the lower part of the Installation Wizard window. The
+script
+which is attached to each such button, can perform some specific
+actions, for example, launch the application or show the 'Release
+Notes'
+file by using an 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 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 ignored.</font><br>
+<h4> <b><products> section</b></h4>
+This one contains a list of <product> sections. The
+products appear in the tree view and are installed in the order they
+are described in this section.
<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>
+Current section is optional. It describes the product to be installed
+with the Installation
+Wizard. The <products> container should include
+<product> section for each
+product to be installed.<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>type</b></font></li>
+</ul>
+<font color="#000000">The type of the product: '<i>component</i>'
+- SALOME module or '<i>prerequisite</i>' - prerequisite
+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>
+<h4> <b><installation> section</b></h4>
+It is a part of the <product> section, that provides
+installation information by platforms. The <product>
+section may contains a several <installation> ones for
+the different platforms.
+<br>
+<font color="#000000"><br>
+Attributes:</font><br>
+<ul>
+ <li> <font color="#000000"><b>os</b></font></li>
+</ul>
+<font color="#000000">A possible installation platform.</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>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> <font color="#000000"><b>woguimode</b></font></li>
+</ul>
+<font color="#000000">This optional flag defines that
+it's possible to install this module without GUI.</font>
+<ul>
+ <li> <font color="#000000"><b>installdiskspace</b></font></li>
+</ul>
+<font color="#000000">List of three total amount spaces
+(integer, in Kbytes, derived by comma), which product occupies on the
+hard drive after the installation in case 'binary', 'sources' and
+'sources and compile' installation type.</font>
+<ul>
+ <li><b>pickupenv</b></li>
+</ul>
+This flag shows that the 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. This is optional key, default value is 'false'<b>.</b><br>
+<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>
+<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><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 the description of <b>print_env()</b>
+function). It is not necessary to implement this function if you do not
+provide binaries mode
+installation for the current product. <br>
+</font>
+<ul>
+ <li> <font color="#000000"><b>install_source()</b></font></li>
+</ul>
+<font color="#000000">This function is
+called to install SALOME modules sources, if <i>'Install binaries</i>'
+installation mode is selected by the user, and to install prerequisite
+products sources, in <i>'Install sources</i>' case (see <a href="#Installation_type_page">Fig.2</a> above). 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 the description of <b>print_env()</b>
+function). It is not necessary to implement this function if you do not
+provide a sources mode installation for the current product.</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 <i>'Install sources and make a compilation'</i>
+installation mode is selected. This function should be used to unpack
+SALOME or prerequisite sources package and then call build/install
+procedure for it.<br>
+For more details please refer to <a href="#gui_mode">this</a>
+section for more details.<br>
+</font>
+<ul>
+ <li> <b>try_preinstalled()</b></li>
+</ul>
+<font color="#000000">This function
+is used to parse the target directory to try to find an already
+installed product, to pick up and to check the environment from
+there. See <a href="#pick_up_env">here</a> for more
+details.</font>
+<ul>
+ <li> <font color="#000000"><b>print_env_bin()
+ </b> & <b> print_env_src()</b></font></li>
+</ul>
+<font color="#000000">These functions are in charge of the
+creation of the environment scripts. They should create in the
+temporary directory two files with <b>env_<product_name>.sh</b>
+and <b>env_<product_name>_src.sh</b>
+names and then copy them into the binary and sources product
+installation directories correspondingly. The file should contain all
+necessary
+environment variable settings for the product. It will be collected
+during the 'pick-up-environment' procedure.</font>
+<ul>
+ <li><b>pickup_env()</b></li>
+</ul>
+This procedure corresponds to <b>pickupenv</b> tag
+of the configuration xml file (see the previous section). It should
+call <b>make_env</b>
+procedure to perform the 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>
+<all_products>
+<product_name>
+<install_products>
+<sources_directory>
+<remove_sources_flag>
+<binaries_directory>
+<single_directory_flag> </font></b>
<p><font color="#000000">where</font> <br>
- <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
-of prerequisite products, separated by space;</font> <br>
- <font color="#000000"><b><product_name> </b>- product name itself.</font>
- </p>
-
+</p>
+<p><font color="#000000"><b><product_script_name></b>
+-
+the name of the installation script (described in the configuration XML
+file);</font> <br>
+<font color="#000000"><b><function_name></b>
+- the name of
+the function, corresponding to the selected installation type and
+currently installed product; </font> <br>
+<font color="#000000"><b>
+<temp_folder> </b> - the directory for the
+temporary files; </font> <br>
+<font color="#000000"><b><products_directory></b>
+- the 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 the 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> - the root target
+directory where the product should be installed to;</font> <br>
+<font color="#000000"><b>
+<all_products> </b> - single-quoted list
+of all products, separated by space;</font> <br>
+<font color="#000000"><b>
+<product_name> </b>- product name
+itself;</font> <br>
+<font color="#000000"><b>
+<install_products> </b> - single-quoted list
+of all products to be installed, separated by space;</font> <br>
+<font color="#000000"><b>
+<sources_directory> </b> - the directory
+where the sources package can be found (it is usable if the
+<products_directory> parameter gives the binaries
+directory path); </font> <br>
+<font color="#000000"><b>
+<remove_sources_flag> </b> - bool parameter, that
+is equal to 'TRUE' if 'Remove sources and temporary files after
+compilation' option has been selected by the user (see <a href="#Installation_type_page">Fig.2</a> in the <a href="#gui_mode">GUI part</a>);</font> <br>
+<font color="#000000"><b>
+<binaries_directory> </b> - the directory
+where the binaries package can be found (it is usable if the
+<products_directory> parameter gives the sources
+directory path); </font> <br>
+<font color="#000000"><b>
+<single_directory_flag> </b> - bool parameter,
+that is equal to 'TRUE' if 'Install modules to a single directory'
+option is selected by the user (see <a href="#Products_page1">Fig.5</a>
+above). </font> <br>
+</p>
<p><font color="#000000">Example:</font> <br>
- <i><font color="#000000">med-2.1.6.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0
- /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>
-</p>
-
+<i><font color="#000000">med.sh install_binary
+/tmp/INSTALLWORK21797
+./Products/BINARIES/Mandriva2010.0
+'gcc tcltk tcltk_src Python Python_src Qt Qt_src ... DOCUMENTATION
+DOCUMENTATION_src'
+Med
+'gcc Hdf Med'
+./Products/SOURCES
+FALSE
+./Products/BINARIES/Mandriva2010.0
+</font></i></p>
+<p><font color="#000000">Copy the created script
+into
+the <i><Install_Wizard_root_directory>/config_files</i>
+sub-directory where all installation scripts are stored. The Installation
+Wizard will automatically search and call your script during the
+installation
+procedure.</font>
+</p>
<hr> <br>
- <br>
-</body>
+<h3><a name="finish_buttons"></a>Customizing <font color="#ff0000">Readme
+page</font> buttons</h3>
+The Installation Wizard allows customizing the layout of the last
+<i>"Finish installation"</i> page. If you want to add one
+or more
+buttons in this page to perform some specific actions at the
+end of the installation (for example, show the '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). <br>
+<br>
+To implement the action which will be performed when the user clicks on
+the button, you need to create a script and to put it into 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 be 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 carried out
+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 the function;</font> <br>
+<font color="#000000"><b><target_directory></b>
+- the root target
+directory where the product is
+installed to;</font> <br>
+<font color="#000000"><b><temp_folder>
+</b> - the directory for the temporary files.</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 the 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>
+</font></body>
</html>
