<li><a href="#env_files">Environment files</a><br>
</li>
</ul>
- <li> <a href="#check_version_proc">Notes on check products version
-procedure</a></li>
<li> <a href="#pick_up_env">Pick up the environment</a></li>
<li> <a href="#xml_files">Modifying XML configuration file</a></li>
<li> <a href="#new_products">Implementing installation scripts for
</b></p>
<p>Without options this script will launch the SALOME Installation
Wizard in the GUI mode.<br>
-The default installation settings can be overriden by using of command
+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>
configuration XML file (usually<span style="font-weight: bold;">
${HOME}/salome_<version></span><!--,
see
-<a href="#xml_files">here</a> for more details-->). <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;">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 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>-h / --help</b><br>
</p>
-<div style="margin-left: 40px;">Prints help information on the
-usage of the Installation Wizard. <br>
+<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 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
+<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. As it was mentioned above, the basic
-target platform for SALOME 4.0.0 and later is <span
- style="color: rgb(0, 0, 153);">Linux Mandriva 2006</span>.<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
+target platform for SALOME 4.0.0 and later is <span style="color: rgb(0, 0, 153);">Linux Mandriva 2006</span>.<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>
+</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
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>
+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:
+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: 593px; height: 468px;">
+<img alt="Intro page" src="intropage.png" style="width: 593px; height: 468px;">
<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>
+<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>
- </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>
- </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>
+ <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>
+ </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>
+ </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>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></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: 593px; height: 468px;">
+<img alt="Installation type page" src="installtypepage.png" style="width: 593px; height: 468px;">
<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 user system is not defined or the current SALOME
-package doesn't support this one, the warning will appear
-("<i>Install binaries</i>" and "<i>Install sources</i>" installation types only):
+<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 user
+system is not defined or the current SALOME package does not support
+this one, the warning 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: 593px; height: 468px;">
+<img alt="Platform page" src="platformpage.png" style="width: 593px; height: 468px;">
<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>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>
+<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>
+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
+<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: 593px; height: 468px;">
+<img alt="Directory page" src="directorypage.png" style="width: 593px; height: 468px;">
<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 prereqisites...</i>" button.
+<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: 593px; height: 468px;">
+<img alt="Products page (default mode)" src="productpage1.png" style="width: 593px; height: 468px;">
<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>
+<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: 593px; height: 468px;">
+<img alt="Products page (full mode)" src="productpage2.png" style="width: 593px; height: 468px;">
<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.
+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:
-<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>The dependencies between SALOME modules are managed in the
+following way:
</p>
-<p>Dependency between modules and prerequisites is realized in the following way:
<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.
+ <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: 593px; height: 468px;">
-<p><b>Figure 7:</b> Dependencies between modules and prerequisites
+<img alt="Products page (dependencies presentation)" src="productpage3.png" style="width: 593px; height: 468px;">
+<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. If it is unchecked, only "KERNEL" and
-"MED" modules are installed with their necessary prerequisites,
-and other modules are unchecked with no possibility to check them in this mode (see <a href="#Products_page4">figure</a> below).<br>
+<p>The "<i>Installation with GUI</i>" checkbox allows
+managing the installation of the graphical interface. If it is
+unchecked, only "KERNEL" and "MED" modules are installed with their
+necessary prerequisites, 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 this checkbox is switched on.
</p>
<center><a name="Products_page4"></a><br>
-<img alt="Products page (Installation without GUI)" src="productpage4.png"
- style="width: 593px; height: 468px;">
+<img alt="Products page (Installation without GUI)" src="productpage4.png" style="width: 593px; height: 468px;">
<p><b>Figure 8:</b> Installation MED 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>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
+<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
+<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
+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
+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
+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>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
+<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.
+<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>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: 593px; height: 468px;">
+<img alt="Choice page" src="choicepage.png" style="width: 593px; height: 468px;">
<p><b>Figure 9:</b> "Check your choice" page
</p>
</center>
-<p>This page summarizes the installation options you've selected in the
+<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
+When you are sure that everything is OK, press <i>"Next"</i>
+button to
follow to the <a href="#ProgressPage">progress page</a>.
</p>
<center><a name="ProgressPage1"></a><br>
-<img alt="Progress page (not started yet)" src="progresspage1.png"
- style="width: 593px; height: 468px;">
-<p><b>Figure 10:</b> "Installation progress" page: not started yet
+<img alt="Progress page (not started yet)" src="progresspage1.png" style="width: 593px; height: 468px;">
+<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
+<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
+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.<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>
+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
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: 593px; height: 468px;">
-<p><b>Figure 11:</b> "Installation progress" page: installation in
+<img alt="Progress page (installation started)" src="progresspage2.png" style="width: 593px; height: 468px;">
+<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
+<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.
+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
+<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
+<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>
+<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: 593px; height: 468px;">
+<img alt="Readme page" src="readmepage.png" style="width: 593px; height: 468px;">
<p><b>Figure 12:</b> "Finish installation" page
</p>
</center>
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
+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>
+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
<center><a name="BatchMode"></a><br>
<br>
<img alt="Batch mode" src="batchmode.png"
- style="width: 660px; height: 410px;">
+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>
+<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>
+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>
+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
+</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
+<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
+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
+(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
+which is set to <span style="font-weight: bold;">0</span>
+in
+env_build.* files and to <span style="font-weight: bold;">1</span>
+in
env_products.*
(salome.*) files.<br>
<br>
<hr>
-<h3><a name="check_version_proc"></a>Notes on<font color="#ff0000">
-check products version</font> procedure</h3>
-Unfortunately under Linux platform there is no exact algorithm to
-identify the product version. The information in this section gives
-an idea of how the
-version is checked for the native/preinstalled products (this
-information refers to the base platform <span
- style="color: rgb(0, 0, 153);">Linux Mandriva 2006</span>;
-and the same algorithms are used for other platforms). <br>
-The general rule for all products is that the path to the binaries
-should be set via <span style="font-weight: bold;">PATH</span>
-environment variable, the path to the libraries should be set via <span
- style="font-weight: bold;">LD_LIBRARY_PATH</span> variable and the
-python modules should be available via <span style="font-weight: bold;">PYTHONPATH</span>
-variable.<br>
-<span style="font-weight: bold;">Note:</span> the information given in
-this section refers to the prerequisite products for SALOME version
-4.1.1.<br>
-<ul>
- <li>gcc 4.0.1<br>
- </li>
-</ul>
-The version number is checked by <span style="font-weight: bold;">gcc
--dumpversion</span> command. <span style="font-weight: bold;">gcc</span>
-executable should be in the <span style="font-weight: bold;">PATH</span>
-environment variable. The version number should be equal to the "4.0.1".<br>
-<ul>
- <li>tcl/tk 8.4.14</li>
-</ul>
-The version number for <span style="font-weight: bold;">tcl/tk</span> can
-be found in tclConfig.sh and tkConfig.sh files (<span
- style="font-weight: bold;">TCL_VERSION</span> and <span
- style="font-weight: bold;">TK_VERSION</span> variables
-correspondingly). The version number should be equal to "8.4"
-(the release number is not checked). <br>
-Set <span style="font-weight: bold;">TCLHOME</span> environment
-variable to the root directory of tcl/tk installation.<br>
-<ul>
- <li>boost 1.34.1</li>
-</ul>
-The version number is defined by <span style="font-weight: bold;">version.hpp</span>
-file which is part of the boost distribution. This file defines <span
- style="font-weight: bold;">BOOST_VERSION</span> macro which should be
-equal to "103401". In addition the existence of boost libraries is
-checked. <br>
-Set <span style="font-weight: bold;">BOOSTDIR</span>
-environment variable if you have a preinstalled version of
-boost.<br>
-<ul>
- <li>Python 2.4.4</li>
-</ul>
-The version number is checked by <span style="font-weight: bold;">python -V</span>
-command. <span style="font-weight: bold;">python</span> executable
-should be in the <span style="font-weight: bold;">PATH</span>
-environment variable. The version number should be equal to "2.4.4".<br>
-Set <span style="font-weight: bold;">PYTHONHOME</span> environment
-variable if you have a preinstalled version of Python.<br>
-<ul>
- <li>Swig 1.3.31</li>
-</ul>
-The version number is checked by <span style="font-weight: bold;">swig
--version</span> command. <span style="font-weight: bold;">swig</span>
-executable should be in the <span style="font-weight: bold;">PATH</span>
-environment variable. The version number should be equal to "1.3.31".<br>
-<ul>
- <li>Qt 3.3.8</li>
-</ul>
-The version number is defined by <span style="font-weight: bold;">qglobal.h</span>
-file which is a part of the Qt distribution. This file defines <span
- style="font-weight: bold;">QT_VERSION_STR</span> macro which should be
-equal to "3.3.8".<br>
-Set <span style="font-weight: bold;">QTDIR</span> environment
-variable if you
-have a preinstalled version of qt.<br>
-<ul>
- <li>msg2qm</li>
-</ul>
-<span style="font-weight: bold;">msg2qm</span> is a Qt tool which is used
-to
-convert text *.po files to *.qm resource files. Unfortunately this tool
-is not included into the Linux distribution and is provided only in Qt
-sources
-package. This is the reason why this tool is supplied with the SALOME
-Installation Wizard.<br>
-There is no way to check the version number of msg2qm tool. Just set <span
- style="font-weight: bold;">MSG2QM_ROOT</span> environment
-variable if you have a preinstalled version of msg2qm tool
-<ul>
- <li>Open CASCADE 6.2sp3</li>
-</ul>
-The 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.2sp3.<br>
-Set <span style="font-weight: bold;">CASROOT</span> environment
-variable if you have a preinstalled version of Open CASCADE.<br>
-<ul>
- <li>qwt 4.2.0</li>
-</ul>
-The version number is defined by <span style="font-weight: bold;">qwt_global.h</span>
-file which is part of the qwt distribution. This file defines <span
- style="font-weight: bold;">QWT_VERSION_STR</span> macro which should
-be equal to "4.2.0".<br>
-Set <span style="font-weight: bold;">QWTHOME</span> environment
-variable if you have a preinstalled version of qwt.<br>
-<ul>
- <li>hdf 5-1.6.4</li>
-</ul>
-The 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. The version should be equal to 1.6.4.<br>
-Set <span style="font-weight: bold;">HDF5HOME</span> environment
-variable if you
-have a preinstalled version of hdf5.<br>
-<ul>
- <li>med 2.3.2</li>
-</ul>
-Unfortunately there is no formal way to check med version
-number. We check existence of libmed.so.1.0.2 library on the computer.
-If you have any problems with the preinstalled version of med, please, reinstall
-it.<br>
-Set <span style="font-weight: bold;">MED2HOME</span> environment
-variable if you
-have a preinstalled version of med.<br>
-<ul>
- <li>Vtk 5.0.0</li>
-</ul>
-Unfortunately there is no formal way to check VTK version
-number. We just check existence of <span style="font-weight: bold;">libvtkCommon.so</span>
-library on the computer and hope that it is of version we need. If you
-have problem with preinstalled version of Vtk, please, reinstall it.<br>
-Set <span style="font-weight: bold;">VTKHOME</span> environment
-variable if you
-have preinstalled version of Vtk.<br>
-<ul>
- <li>OmniORB 4.1.0, OmniORBpy 3.0, OmniNotify 2.1</li>
-</ul>
-We just check existence of some omniORB libraries and executable on the
-computer, like <span style="font-weight: bold;">libomniORB4.so.0.5</span>,
-<span style="font-weight: bold;">_omnipymodule.so.2.4</span>, <span
- style="font-weight: bold;">libCOSNotify4.so.0.1</span> and <span
- style="font-weight: bold;">notifd</span>.<br>
-Set <span style="font-weight: bold;">OMNIORBDIR</span> environment
-variable if
-you have preinstalled version of omniORB products.<br>
-<ul>
- <li>sip 4.7.3</li>
-</ul>
-The version number is checked by <span style="font-weight: bold;">sip -V</span>
-command. <span style="font-weight: bold;">sip</span> executable should
-be in the <span style="font-weight: bold;">PATH</span>
-environment variable. Version number should be equal to "4.7.3".<br>
-Set <span style="font-weight: bold;">SIPDIR</span> environment
-variable to the
-directory where you have sip executable preinstalled.<br>
-<ul>
- <li>PyQt 3.17.4</li>
-</ul>
-The version number is defined by <span style="font-weight: bold;">pyqtconfig.py</span>
-Python module file which is part of the <span
- style="font-weight: bold;">PyQt</span> distribution. Version should be
-equal to "3.17.4".<br>
-Set <span style="font-weight: bold;">PYQTDIR</span>environment
-variable if you
-have preinstalled version of PyQt.
-<ul>
- <li>netgen 4.5</li>
-</ul>
-Unfortunarely we can't find anything about
-netgen version. We just check if <span style="font-weight: bold;">NETGENROOT</span>
-environment varible is set.<br>
-Set <span style="font-weight: bold;">NETGENROOT</span>
-environment
-variable if you have preinstalled version
-of netgen mesher.<br>
-<span style="font-weight: bold;">Note: </span>netgen 4.5 provided with
-the SALOME installation Wizard has been patched to improve its
-performance.<br>
-<ul>
- <li>Numeric 24.2</li>
-</ul>
-The version number is checked by <span style="font-weight: bold;">python
--c
-'import Numeric; print Numeric.__version__'</span> command. <span
- style="font-weight: bold;">python</span> executable should be in the <span
- style="font-weight: bold;">PATH</span>
-environment variable and <span style="font-weight: bold;">Numeric</span>
-module should be avaible for the Python (for example it should be in
-the <span style="font-weight: bold;">PYTHONPATH</span> environment
-variable). Version number should be equal to "24.2". If you have
-problem with preinstalled version of Numeric 24.2, please,
-reinstall it.<br>
-Add the directory where <span style="font-weight: bold;"></span>you
-have preinstalled version of Numeric
-package to the <span style="font-weight: bold;">PYTHONHOME </span>environment
-variable.<br>
-<ul>
- <li>graphviz 2.16.1</li>
-</ul>
-The version number is checked by <span style="font-weight: bold;">dot -V</span>
-command. <span style="font-weight: bold;">dot</span> executable should
-be in the <span style="font-weight: bold;">PATH</span>
-environment variable. Version number should be equal to "2.16.1".<br>
-Add <span style="font-weight: bold;">graphviz</span> bin directory to
-the <span style="font-weight: bold;">PATH</span> environment variable.<br>
-<ul>
- <li>doxygen 1.4.7</li>
-</ul>
-The version number is checked by <span style="font-weight: bold;">doxygen
---version</span> command. <span style="font-weight: bold;">doxygen</span>
-executable
-should be in the <span style="font-weight: bold;">PATH</span>
-environment variable. Version number should be equal to "1.4.7".<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>
-(4.1.1).</li>
-</ul>
-For each SALOME module sources package (KERNEL, GUI, GEOM, etc...) root
-directory contains file configure.in (configure.ac) which defines
-version
-information.<br>
-Set <span style="font-weight: bold;"><MODULE>_SRC_DIR</span>
-environment variable for each SALOME <span style="font-weight: bold;">MODULE</span>
-sources package installed (where <span style="font-weight: bold;">MODULE</span>
-is KERNEL, GUI, GEOM, ...).<br>
-<ul>
- <li><span style="font-weight: bold; color: rgb(0, 0, 153);">SALOME </span>module
- <span style="font-weight: bold;"></span><span
- style="font-weight: bold; color: rgb(0, 0, 153);">binaries </span>(4.1.1)</li>
-</ul>
-For each SALOME module binaries package (KERNEL, GUI, GEOM, etc...) <span
- style="font-weight: bold;">bin/salome</span> directory contains file <span
- style="font-weight: bold;">VERSION</span> which defines version
-information.<br>
-Set <span style="font-weight: bold;"><MODULE>_ROOT_DIR</span>
-environment variable for each SALOME <span style="font-weight: bold;">MODULE</span>
-binaries package installed (where <span style="font-weight: bold;">MODULE</span>
-is KERNEL, GUI, GEOM, ...).<br>
-<p><b></b>If you have native products installed to different from
-default
-directories (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is
-recommended to follow above mentioned instructions. Or you should
-properly set <span style="font-weight: bold;">PATH</span> and <span
- style="font-weight: bold;">LD_LIBRARY_PATH</span> variables <b><font
- color="#ff0000">before</font></b>
-starting the Installation Wizard. Otherwise
-the installation script will fail to find preinstalled/native products.
-</p>
-<p><b>Note:</b> for some native products (e.g. gcc, Python) the rules
-of version
-checking are not so strict as described in the table. Only major and
-minor numbers of version
-should coincide with prerequisite. Newer version of the product can be
-used also. If some native product has version number larger than that
-required by
-the
-installation procedure, user will be prompted by the warning message
-like this: <i>"You have
-newer version of gcc installed
-on your computer than that is required (3.4.1). Continue?"</i>. You can
-press <i>"Yes"</i> button
-to proceed with the installation but in this case you should be aware
-of what you are doing.
-SALOME binaries (including other products) are compiled with the
-predefined prerequisites
-and most likely can not be run successfully if these products are not
-found.
-This can be helpful only if you plan to build all products from
-sources. <br>
-</p>
-<h3>
-<hr></h3>
<h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
Please, read carefully the following information. This section
describes how the installation procedure generates the environment
scripts for the SALOME platform being installed.
-<p>After installing of each product shell the script creates special
+<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 product by the following scheme: <b>env_<product_name>.sh</b>
+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 the
-settings files and generate from them two common environment files: <b>salome.sh</b>
+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. Such
-approach helps to save time
-when reinstalling products and you may not to care about setting all
-environment variables
-manually to build/launch SALOME. What you need is just to source one of
-these
-environment files. </p>
-<p>This concerns also those products which are not being installed.
+</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. Installation
-procedure tries to collect environment files from the target
-directory if it finds necessary products installed there. If some
-product is not
-found in the target directory the corresponding
-section of <b>salome.sh/salome.csh</b> files will be skipped. <br>
-For native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>
-installation procedure tries to find them first using <b>PATH</b>
-/ <b>LD_LIBRARY_PATH</b> variables and then in the system default
-directories (<b>/usr/bin, /usr/lib</b> etc., depending on the product).
+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 may edit <b>salome.*</b> files after installation
-procedure finishes, if you want.<br>
+<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 was mentioned <a href="#env_files">above</a> there
-are another environment files which
-are generated by the installation procedure: <span
- style="font-weight: bold;">env_products.csh</span> + <span
- style="font-weight: bold;">env_products.sh</span> and <span
- style="font-weight: bold;">env_build.csh</span> + <span
- style="font-weight: bold;">env_build.sh</span>. These files can be
+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 then can take it as command line argument to
-provide list of products you want to install with it. The list of
-products and some another settings for the Installation Wizard are
-provided in the XML file. The default file which Installation Wizard
-looks
-for if no command line arguments are given, is <b>config.xml</b>.<br>
-This
-section describes the structure of the configuration file.</font> <br>
-<font color="#000000">XML tags are in bold blue, optional sections/tags
+<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=<install_wizard_version> ]</font> <br>
-<font color="#000000">
- [
-caption=<install_wizard_caption> ]</font> <br>
-<font color="#000000">
- [
-copyright=<install_wizard_copyright> ]</font> <br>
-<font color="#000000">
- [
-license=<install_wizard_license_info> ]</font> <br>
-<font color="#000000">
- [ os=<target_platform>
-]</font><b><font color="#000099"><br>
- /></font></b><font color="#000000"> <br>
- ]</font> <br>
-<font color="#000000"><b> </b>[ </font><b><font
- color="#000099"><path</font></b><font color="#000000">
-[ targetdir=<target_directory> ]</font> <br>
-<font color="#000000">
-
-[ tempdir=<temp_directory> ]</font><b><font
- color="#000099"><br>
- /> </font></b><font color="#000000"><br>
- ]</font> <br>
-<font color="#000000"><b> </b>[ </font><b><font
- color="#000099"><button</font></b><font color="#000000">
- label=<button_label> </font> <br>
+<font color="#000000"><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><b><font color="#000099"><br>
+ /> </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><b><font
- color="#000099"><br>
- /> </font></b><font color="#000000"><br>
+
+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"> <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">
+<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">
-
-version=<product_version></font> <br>
- [
-context=<product_context>
-]<br>
- [
+<font color="#000000">
+
+
+type=<product_type></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">
+</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>
-
- temporarydiskspace=<tmp_disk_space></font> <font
- color="#000000"><br>
-
- script=<installation_script_name></font><font
- color="#000099"><br>
- /<b>></b></font><font color="#000000">
+
+
+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> <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">
+<font color="#000000"> ]</font><br>
+<font color="#000000"> [</font><b><font color="#000099"> <dependencies></font></b>
<br>
- ]</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><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> </p>
</font>
-<h4><font color="#000000"><config> section</font></h4>
-<font color="#000000">This is optional section; it provides general
-information about Installation Wizard itself.<br>
+<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
+<font color="#000000">The application version number to be
+shown in the
caption.</font>
<ul>
<li> <font color="#000000"><b>caption</b></font></li>
</ul>
-<font color="#000000">The application main window caption - if this
-string contains '%1' text the title will
-contain
-in this place the version number (see above).</font>
+<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>
<ul>
<li> <font color="#000000"><b>license</b></font></li>
</ul>
-<font color="#000000">The application license information (shown in the
+<font color="#000000">The application license information
+(shown in the
first page).</font>
<ul>
- <li> <font color="#000000"><b>os</b></font></li>
+ <li> <font color="#000000"><b>platforms</b></font></li>
</ul>
-<font color="#000000">This parameter defines the directory (relative
-from ./Products/BINARIES) where the Installation Wizard will
-search precompiled binaries packages. If this tag is not provided,
-binaries packages are looked for in
-the ./Products/BINARIES directory.</font>
-<h4> <b><font color="#000000"><path> section</font></b></h4>
-This is optional section; it defines default installation directories.<br>
-<font color="#000000"><br>
-Attributes:</font><br>
+<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 - the path to the directory where products should be
+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 -
+<font color="#000000">The temporary directory is
the path to the directory for the temporary files.</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. XML file should include <product> section for each
-product to be installed. The products appear in the tree view
-and are installed in the order they are described in the configuration
-file. It is recommended (but not obligatory) to define native products
-at the top of the
-list before all other products.<br>
+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>
</ul>
<font color="#000000">The name of the product.</font>
<ul>
- <li> <font color="#000000"><b>version</b></font></li>
+ <li> <font color="#000000"><b>type</b></font></li>
</ul>
-<font color="#000000">The version of the product.</font>
+<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>context</b></font></li>
-</ul>
-<font color="#000000">Context (optional). The possible values are <b>'salome
-sources'</b>, <b>'salome
-binaries'</b> and <b>'prerequisite'</b> (several context can be given
-separated by ":" symbol).</font>
-<ul>
- <li> <font color="#000000"><b>supported</b></font></li>
+ <li> <font color="#000000"><b>os</b></font></li>
</ul>
-<font color="#000000">Supported modes of
-installation. Several modes can be separated by comma. Possible value
-are: <i>install sources</i>, <i>install binaries</i>, <i>use
-native</i>. Installation script should contain the corresponding
-functions
-for each of the supported installation modes (see <a
- href="#new_products">here</a>).</font>
+<font color="#000000">A possible installation platform.</font>
<ul>
- <li> <font color="#000000"><b>install</b></font></li>
+ <li> <font color="#000000"><b>version</b></font></li>
</ul>
-<font color="#000000">Default (starting)
-installation mode.</font>
+<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><b>pickupenv</b></li>
-</ul>
-This flag points that pickup environment
-procedure
-should be performed for this product. If this flag equal to 'true',
- salome.sh
-and salome.csh files will be created in the product's
-installation
-directory. Usually this option is set to true for SALOME KERNEL module
-sources and binaries package. This is optional key, default value is
-'false'<b>.</b><br>
-<ul>
- <li> <font color="#000000"><b>dependancies</b></font></li>
-</ul>
-<font color="#000000">List of prerequisite
-products, which are necessary to build this product, separated by comma.</font>
<ul>
<li> <font color="#000000"><b>installdiskspace</b></font></li>
</ul>
-<font color="#000000">Total amount
-space (integer, in Kbytes), which product occupies on the hard drive
-after the
-installation.</font>
+<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> <font color="#000000"><b>temporarydiskspace</b></font></li>
+ <li><b>pickupenv</b></li>
</ul>
-<font color="#000000">Disk space
-(integer, in Kbytes) for the temporary files, which is necessary to
-build the product from the sources.</font>
+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>
program. See the <a href="#new_products">next
section</a> for
more information.</font><br>
-<h4> <b><button> section</b></h4>
-This is optional section. It allows customing of the last <i>"Finish
-installation"</i> page of the Installation Wizard by adding one or
-more buttons in the lower part of the wizard's window. The script
-which is attached to each such button, can perform some specific
-action, for example, launch the application or show the Release Notes
-file by using external program.
-See <a href="#finish_buttons">here</a> for more details about
-writing scripts.<br>
-<font color="#000000"><br>
-Attributes:</font><br>
-<ul>
- <li> <font color="#000000"><b>label</b></font></li>
-</ul>
-<font color="#000000">This is the button text.</font>
-<ul>
- <li> <font color="#000000"><b>tooltip</b></font></li>
-</ul>
-<font color="#000000">The button's tooltip (optional).</font>
-<ul>
- <li> <font color="#000000"><b>script</b></font></li>
-</ul>
-<font color="#000000">The script attached to the button.</font>
-<ul>
- <li> <font color="#000000"><b>disable</b></font></li>
-</ul>
-<font color="#000000">If this optional flag has 'true'
-value, the corresponding button will not appear in the <i>"Finish
-installation"</i> page - the section of XML file is silently
-ignored.</font><br>
<br>
<b>Note:</b> If you add new products to be
installed with Installation Wizard, you should also provide
<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 the installation script, following
+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
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
+<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>
internal
function and is not called from the master installation script.<br>
<ul>
- <li> <b><font color="#000000">try_native()</font></b></li>
+ <li><font color="#000000"><b>install_binary()</b></font></li>
</ul>
<font color="#000000">This function is
-called when <i>'use native' </i>installation mode is selected by the
-user. The function should try to find native version of the product and
-define possibility of its usage. It should create the environment file
-for the
-product in the temporary directory (see also description of <b>print_env(</b>)
-function). I</font><font color="#000000">t is not necessary to
-implement
-this function i</font><font color="#000000">f you do not provide native
-mode. installation.<br>
+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 when <i>'install sources</i>' installation mode is selected by
-the
-user. The function is responsible for the building of the product from
-the
-sources package. It should create the environment file for the product
-in the
-temporary
-directory (see also description of <b>print_env(</b>) function). </font><font
- color="#000000">I</font><font color="#000000">t is not necessary to
-implement
-this function i</font><font color="#000000">f you do not provide </font><font
- color="#000000">sources mode installation.</font>
+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">This function is
-called when SALOME module is installed and the <span
- style="font-weight: bold;">--all-from-sources</span> (<span
- style="font-weight: bold;">-a</span>) option is used (<span
- style="font-style: italic;">"Build SALOME sources"</span> check box in
-GUI mode). This function should be used to unpack SALOME sources
-package and then call build/install procedure for it.<br>
-For more details please refer to the <a href="#install_from_wizard">this</a>
-and <a href="#gui_mode">this</a> sections for more details.<br>
-</font>
-<ul>
- <li><font color="#000000"><b>install_binary()</b></font></li>
-</ul>
-<font color="#000000">This function is
-called when <i>'install binaries'</i> installation mode is selected by
-the
-user. The function is responsible for the extracting of the product
-from
-the binaries package. It should create environment for the product in
-the
-temporary
-directory (see also description of <b>print_env(</b>) function).</font><font
- color="#000000"> I</font><font color="#000000">t is not necessary to
-implement
-this function i</font><font color="#000000">f you do not provide </font><font
- color="#000000">binaries</font><font color="#000000"> mode
-installation.</font><font color="#000000"> <br>
+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 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>
+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()</b></font></li>
+ <li> <font color="#000000"><b>print_env_bin()
+ </b> & <b> print_env_src()</b></font></li>
</ul>
-<font color="#000000">This function is in
-charge of creation environment script. It should create file with name </font><b>env_<product_name>.sh</b>
-in the temporary directory and then copy it into the product
-installation directory. The file should contain all necessary
-environment variables settings for the product. It will be collected
-during the 'pick-up-environment' procedure.
+<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 <b>pickupenv</b>
-tag
-of the configuration xml file (see previous section). It should call <b>make_env</b>
-procedure to perform pick-up environment procedure for the product.<br>
+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
+<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>
+<b><font color="#000000">
+<product_script_name>
+<function_name>
+<temp_folder>
+<products_directory>
<target_directory>
-<dependancies> <product_name></font></b>
+<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>
</p>
-<p><font color="#000000"><b><product_script_name></b> -
-installation
-script name (described in configuration xml file);</font> <br>
-<font color="#000000"><b><function_name></b> - the name of
-function, corresponding to the selected installation mode: <i>try_native,
-install_source, install_binary</i> or <i>try_preinstalled</i>;</font> <br>
-<font color="#000000"><b><temp_folder></b> - temporary files
-directory;</font> <br>
-<font color="#000000"><b><products_directory></b> - directory
+<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 target platform description, which appears
+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> - root target
-directory where product should be installed to;</font> <br>
-<font color="#000000"><b><dependancies></b> - single-quoted list
-of prerequisite products, separated by space;</font> <br>
-<font color="#000000"><b><product_name> </b>- product name
-itself.</font> </p>
+<font color="#000000"><b>
+<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.2.3.sh install_binary /tmp/work
-./Products/BINARIES/Mandrake10.1 /usr/salome 'gcc Hdf' med</font></i> </p>
-<p><font color="#000000">Copy created script into the <i><Install_Wizard_root_directory>/config_files</i>
-sub-directory where all installation scripts are stored. Installation
-Wizard
-will automatically search and call your script during the installation
+<i><font color="#000000">med-2.3.3.sh install_binary
+/tmp/INSTALLWORK21797
+./Products/BINARIES/Mandriva2006.0
+'gcc tcltk tcltk_src Python Python_src Qt Qt_src ... DOCUMENTATION
+DOCUMENTATION_src'
+Med
+'gcc Hdf Med'
+./Products/SOURCES
+FALSE
+./Products/BINARIES/Mandriva2006.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>
<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
+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).
-<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>
+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.
<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
+<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
+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 done
+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>
+<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> -
+<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
+- 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> - temporary files directory;</font> <br>
+</b> - the directory for the temporary files.</font> <br>
<br>
-<b>Note:</b> The standard Installation Wizard buttons "Launch
+<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>
+<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
+<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>
+</html>
\ No newline at end of file
