<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)">
+ content="Vadim SANDLER, Open CASCADE SAS (vadim.sandler@opencascade.com)">
+ <meta name="Copyright" content="2002-2006 CEA">
<title>SALOME Installation Wizard Help</title>
- <meta content="Vadim SANDLER" name="author">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 229);"
alink="#ff0000" link="#0000ee" vlink="#551a8b">
</table>
</center>
<div align="right"><b><font color="#000099">updated for the version </font><font
- color="#ff0000">3.2.0</font></b></div>
+ color="#ff0000">3.2.4</font></b></div>
<hr>
<ul>
<li> <a href="#install_from_wizard">Installing products with the
<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>
style="font-weight: bold;"></span>
<p>[ python ] <b>runInstall </b>[options]<b><br>
</b></p>
-<p>Without opstions this script will launch the SALOME Installation
+<p>Without options this script will launch the SALOME Installation
Wizard in the default mode (GUI).<br>
-The default mode can be overriden by using command line options. Each
+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><b>-b / --batch</b><br>
</p>
<div style="margin-left: 40px;">Runs the Installation Wizard in
-command-line mode. <br>
+the terminal mode. <br>
</div>
<p><b>-f FILE / --file=</b><span style="font-weight: bold;">FILE<br>
</span></p>
configuration XML file (usually<span style="font-weight: bold;">
${HOME}/salome_<version></span>,
see
-<a href="#xml_files">here</a> for more detail). <br>
+<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 is used for
-temporary files. If used, this option overrides the default temporary
+<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="readme.html#xml_files">here</a> for more detail).<br>
+ 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 about available
-options. <br>
+<div style="margin-left: 40px;">Prints help information on the
+Installation Wizard's usage. <br>
</div>
<p></p>
<p>
<p>The installation procedure supports different <span
style="color: rgb(0, 0, 153);">Linux
</span>platforms
-and installs various installation 3d-party pre-requisite products which
+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>
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 thepre-requisite products you
+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
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 wizard
-was developed
+<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
-quides the user through several subsequent pages. To navigate between
+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>
+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>
</p>
<center><a name="IntroPage"></a><br>
<img alt="Intro page" src="intropage.png"
- style="width: 586px; height: 347px;">
+ 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 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 be shown.<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 GUI mode the Installation Wizard provides two different options
+<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 only the target installation
-directory. All other installation options are taken from the XML
+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>
-<
div style="text-align: center;"><a name="Product_page1"></a><br>
+<
center><a name="Product_page1"></a><br>
<img alt="Intro page" src="productpage1.png"
- style="width: 586px; height: 347px;"></div>
-<p></p>
-<p style="text-align: center;"><b>Figure 2:</b> "Installation settings"
-page in the 'basic' mode<br>
+ 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>
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. Possible options and default
+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 can be installed only together with other products (or
-these prerequisite products should be already installed on your
+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.
<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>"Auto set
-prerequisites products"</i> checkbox. Turn on this checkbox if you
-want all pre-requisite products to be automatically checked when you
+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>
-<b>t</b><img src="productpage.png" alt="Products page"
- style="width: 586px; height: 544px;">
+<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
and <i>"SALOME binaries"</i>.
These three-state checkboxes allow quick selecting/unselecting SALOME
modules sources/binaries packages
-for the installation.</p>
+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
provided in the XML file) and current user
choice.
</p>
-The <i>"Total disk space required:"</i> field displays how much
+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
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
+<p><b>Note: </b><b>you are strongly recommended not to use directory
+names
containing
-spaces.</b> </p>
+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
Otherwise
the wizard will proceed to the next page: </p>
<center>
-<p><a name="ChoicePage"></a><br>
-<b>t</b><img src="choicepage.png" alt="Choice page"
- style="width: 586px; height: 544px;"> </p>
-<p><b>Figure 4:</b> "Check your choice" page</p>
+<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
follow to the <a href="#ProgressPage">next page</a>. </p>
<center><a name="ProgressPage"></a><br>
<img alt="Progress page" src="progresspage1.png"
- style="width: 586px; height: 366px;"><br>
-<p><b>Figure 5:</b> "Installation progress" page</p>
+ 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 the progress the corresponding messages
+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
implementation it is not possible to resume stopped installation
process; it will be re-started from the very beginning. <br>
</p>
-<div style="text-align: center;"><a name="ProgressPage1"></a><br>
-</div>
+<center><a name="ProgressPage1"></a><br>
<img alt="Progress page" src="progresspage.png"
- style="width: 586px; height: 366px;"><br>
-<p><b>Figure 6:</b> "Installation progress" page: installation in
-progress<br>
-</p>
+ 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
installation
or click <i>"Next"</i> button to go the Readme page: </p>
<center>
-<p><a name="readmepage"></a><br>
+<a name="readmepage"></a><br>
<img alt="Read page" src="readmepage.png"
- style="width: 586px; height: 486px;"><br>
-</p>
-<p><b>Figure 7:</b> "Finish installation" page</p>
+ 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 by clicking <i>"Launch
-SALOME" </i>button.<br>
+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 type use <span
+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 konsole. In the batch mode user do
+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 (see <a
- href="#install_from_wizard">here</a>).<br>
-<div style="text-align: center;"><a name="BatchMode"></a><br>
+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: 687px; height: 453px;"><br>
-<b><br>
-Figure 8:</b> Batch mode<br>
-</div>
+ 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
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>
+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>and <span style="font-weight: bold;">env_build.csh
</span>+ <span style="font-weight: bold;">env_build.sh</span> in the
-target directory.<br>
+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 th CD). The <span style="font-weight: bold;">env_products.*</span>
+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 0 in env_build.* files and to 1 in emv_products.*
+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>
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 pre-requisite products for SALOME version
-3.2.0.<br>
+this section refers to the prerequisite products for SALOME version
+3.2.4.<br>
<ul>
<li>gcc 3.4.1<br>
</li>
variable if you have preinstalled
version of msg2qm tool
<ul>
- <li>Open CASCADE 6.1.0</li>
+ <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.0.<br>
+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>
variable if you
have preinstalled version of qwt.<br>
<ul>
- <li>hdf 5-1.6.3</li>
+ <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.3.<br>
+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>
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>
<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
+--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.0).</li>
+(3.2.4).</li>
</ul>
-For each SALOME module sources package (KERNEL, GUI, GEOM, etc...) <span
- style="font-weight: bold;">bin</span> directory contains file <span
- style="font-weight: bold;">VERSION</span> which defines version
+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>
<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.0)</li>
+ 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
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
+<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
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 procede with the installation but in this case you should be aware
+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 only helpful if you plan to build all products from
+This can be helpful only if you plan to build all products from
sources. <br>
</p>
<h3>
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">XNL tags are in bold blue, optional sections/tags
+<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>
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>
supported=<supported_installation_modes></font> <br>
<font color="#000000">
- disable=<disable_flag><br>
+ [ disable=<disable_flag>
+ ]<br>
[
pickupenv=<pickup_env_flag> ]</font><font
color="#000000"><br>
color="#000000"> ... </font><font color="#000099"><br>
/<b>></b></font><font color="#000000">
<br>
- ]</font> <font color="#000000"><br>
- <b> .</b></font><b><font color="#000099">..</font></b>
-<b><font color="#000099"><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; it provides general
-information Installation Wizard itself.<br>
+information about Installation Wizard itself.<br>
<br>
Attributes:<br>
</font>
<ul>
<li> <font color="#000000"><b>disable</b></font></li>
</ul>
-<font color="#000000">If this flag has 'true'
+<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>
program. See the <a href="#new_products">next
section</a> for
more information.</font><br>
-<b><br>
-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.
+<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>
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">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>
+ <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
procedure to perform pick-up environment procedure for the product.<br>
<br>
<font color="#000000">The calling signature of the product installation
-script is following:</font> <br>
+script is the following:</font> <br>
<b><font color="#000000"><product_script_name>
<function_name> <temp_folder> <products_directory>
<target_directory>
<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
+<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
procedure.</font>
</p>
<hr> <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>
