<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">\r
-<html>\r
-<head>\r
- <meta http-equiv="Content-Type"\r
- content="text/html; charset=iso-8859-1">\r
- <meta name="GENERATOR"\r
- content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">\r
- <meta name="Author"\r
- content="Alexander KOVALEV, Open CASCADE SAS (alexander.kovalev@opencascade.com)">\r
- <meta name="Copyright" content="2002-2008 CEA">\r
- <title>SALOME Installation Wizard Help</title>\r
-</head>\r
-<body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 229);"\r
- alink="#ff0000" link="#0000ee" vlink="#551a8b">\r
- \r
-<center>\r
-<table nosave="" width="100%">\r
- <tbody>\r
- <tr nosave="">\r
- <td nosave="">\r
- <h1><a href="http://www.opencascade.com"><img src="logocorp.png"\r
- border="0" height="47" width="139"> </a></h1>\r
- </td>\r
- <td>\r
- <center>\r
- <h3><font size="+4"><font color="#000099">SALOME Installation\r
-Wizard Help</font></font></h3>\r
- </center>\r
- </td>\r
- <td>\r
- <div align="right"><a href="http://www.opencascade.org/SALOME/"><img\r
- src="application.png" border="0" height="47" width="109"> </a></div>\r
- </td>\r
- </tr>\r
- </tbody>\r
-</table>\r
-</center>\r
-<div align="right"><b><font color="#000099">updated for the version </font><font\r
- color="#ff0000">4.1.4</font></b></div>\r
-<hr>\r
-<ul>\r
- <li> <a href="#install_from_wizard">Installing products with the\r
-Installation Wizard<br>\r
- </a></li>\r
- <ul>\r
- <li><a href="#gui_mode">GUI mode</a></li>\r
- <li><a href="#batch_mode">Batch mode</a></li>\r
- <li><a href="#env_files">Environment files</a><br>\r
- </li>\r
- </ul>\r
- <li> <a href="#pick_up_env">Pick up the environment</a></li>\r
- <li> <a href="#xml_files">Modifying XML configuration file</a></li>\r
- <li> <a href="#new_products">Implementing installation scripts for\r
-the new products</a></li>\r
- <li> <a href="#finish_buttons">Customizing Readme page buttons</a></li>\r
-</ul>\r
-<h3>\r
-<hr></h3>\r
-<h3> <a name="install_from_wizard"></a>Installing products with the <font\r
- color="#ff0000">Installation Wizard</font></h3>\r
-The Installation Wizard can be launched in two modes: <span\r
- style="font-weight: bold;">GUI </span>and <span\r
- style="font-weight: bold;">batch</span>. <br>\r
-The root directory of the Installation Wizard\r
-contains Python script <span style="font-weight: bold;">runInstall</span>.\r
-To run the Installation Wizard just type <b>./runInstall</b> in the\r
-terminal\r
-window:<span style="font-weight: bold;"></span><span\r
- style="font-weight: bold;"></span>\r
-<p>[ python ] <b>./runInstall </b>[options]<b><br>\r
-</b></p>\r
-<p>Without options this script will launch the SALOME Installation\r
-Wizard in the GUI mode.<br>\r
-The default installation settings can be overridden by using of command\r
-line options. Each option has short and long notations:<br>\r
-</p>\r
-<p><b>-g / --gui</b><br>\r
-</p>\r
-<div style="margin-left: 40px;">Runs the Installation Wizard in the\r
-GUI\r
-mode (this is the default mode).<br>\r
-</div>\r
-<p><b>-b / --batch</b><br>\r
-</p>\r
-<div style="margin-left: 40px;">Runs the Installation Wizard in\r
-the terminal mode. <br>\r
-</div>\r
-<p><b>-f FILE / --file=</b><span style="font-weight: bold;">FILE<br>\r
-</span></p>\r
-<div style="margin-left: 40px;">\r
-This is the XML configuration file used by the Installation Wizard. \r
-If this option is not used, the installation script tries to define \r
-the<i>Linux </i>version and to use the corresponding XML file\r
-if it is present.\r
-For example, for <span style="color: rgb(0, 0, 153);">Linux Mandriva\r
-2006</span> the <b>config_Mandriva_2006.0.xml</b> \r
-file\r
-will be used by default.\r
-</div>\r
-<p> <b>-d DIR / --target=DIR</b><br>\r
-</p>\r
-<div style="margin-left: 40px;">This is the target installation \r
-directory for SALOME platform. If used, this option overrides \r
-the default target directory, given in the\r
-configuration XML file (usually<span style="font-weight: bold;">\r
-${HOME}/salome_<version></span><!--,\r
-see\r
-<a href="#xml_files">here</a> for more details-->).<br>\r
-</div>\r
-<p><b>-t DIR / --tmp=DIR </b></p>\r
-<div style="margin-left: 40px;">This is the directory, for \r
-temporary files. If given, this option overrides the default \r
-temporary directory, given in the configuration xml file \r
-(usually <span style="font-weight: bold;">/tmp</span>\r
-<span style="font-weight: bold;"></span><!--, \r
-see <a href="#xml_files">here</a> for more information-->).<br>\r
-</div>\r
-<p><b>-a / --all-from-sources</b></p>\r
-<div style="margin-left: 40px;">\r
-Force all the products to be installed from sources (including all\r
-SALOME modules). If this option is used, all the default installation\r
-modes for all the products are ignored.<br>\r
-This option is helpful when the user wants to install SALOME on the\r
-platform which is not officially supported. In this case, the user can\r
-try to run the SALOME Installation Wizard with the <span\r
- style="font-weight: bold;">-a</span> option in order to build all the\r
-products from sources.<br>\r
-<b>Note, that this is long-time operation which can take more than \r
-24 hours depending on the computer.</b><br>\r
-</div>\r
-<p><b>-s / --single-directory </b></p>\r
-<div style="margin-left: 40px;">Install all SALOME binaries packages \r
-to one directory.<br>\r
-<b>This option is ignored when --all-from-sources (-a) option is used.\r
-</b></div>\r
-<p><b>-h / --help</b><br>\r
-</p>\r
-<div style="margin-left: 40px;">Prints help information on\r
-the usage of the Installation Wizard. <br>\r
-</div>\r
-<p></p>\r
-<p>\r
-<b>-v / --version</b><br>\r
-</p>\r
-<div style="margin-left: 40px;">Prints version information\r
-(<span style="font-weight: bold;">Note: </span>this\r
-is the version number of the Installation Wizard, not of SALOME platform). <br>\r
-</div>\r
-<p>\r
-</p>\r
-<p>The installation procedure supports different <span style="color: rgb(0, 0, 153);">Linux\r
-</span>platforms and installs various 3d-party installation prerequisite products, which\r
-are required by SALOME platform. As it was mentioned above, the basic\r
-target platform for SALOME 4.0.0 and later is <span style="color: rgb(0, 0, 153);">Linux Mandriva 2006</span>.<br>\r
-The usage of configuration XML files provides a flexible way to modify\r
-the list of products to be installed by the Installation Wizard without\r
-changing the source code of the application. Just create your own XML\r
-configuration file and implement installation scripts for the prerequisite products you\r
-need and then use this XML file with the Installation Wizard. This can\r
-be done, for example, for some <span style="color: rgb(0, 0, 153);">Linux\r
-</span>platform which is not supported directly by the\r
-Installation Wizard. See <a href="#xml_files">Modifying XML\r
-configuration file</a> and <a href="#new_products">Implementing installation\r
-scripts for the new products</a> sections for more information. </p>\r
-<h3 style="margin-left: 40px;"> <a name="gui_mode"></a>GUI\r
-mode<br>\r
-</h3>\r
-<p>The GUI of the <font color="#ff0000">Installation Wizard</font> has been\r
-developed with <span style="font-weight: bold;"><span style="color: rgb(0, 0, 153);">Qt\r
-3.3.8 </span> </span>toolkit by <span style="color: rgb(0, 0, 153);">\r
-Trolltech </span>. After launching the Installation Wizard\r
-in the GUI mode the wizard window is shown to the user. This wizard\r
-guides the user through several subsequent pages. To navigate between\r
-the pages use <i>"Next"</i> and <i>"Back"</i>\r
-buttons in the lower part of the wizard window. <i>"Cancel"</i> button\r
-closes the wizard window and quits the installation procedure after user\r
-confirmation. <i>"Help"</i> button opens a window with the help information. </p>\r
-<p>The first "<span style="font-style: italic;">Introduction"</span>\r
-page is shown in <a href="#IntroPage">Figure 1</a>.\r
-Skip this page by pressing <i>"Next"</i> button:\r
-</p>\r
-<center><a name="IntroPage"></a><br>\r
-<img alt="Intro page" src="intropage.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 1:</b> "Introduction" page</p>\r
-</center>\r
-<p>In the second page you are proposed to select the type of the\r
-SALOME installation.<br>\r
-<br>\r
-At this step three possible types of installation are available:<br>\r
-</p>\r
-<ol>\r
- <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install binaries"</b></font></span>\r
-type:<br>\r
- <ul>\r
- <li>all binaries and sources of the chosen modules are\r
-installed;</li>\r
- <li>all binaries of the chosen prerequisites are installed.</li>\r
- <br>\r
- </ul>\r
- </li>\r
- <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install sources"</b></font></span>\r
-type:<br>\r
- <ul>\r
- <li>all sources of the chosen modules and prerequisites are\r
-installed without compilation.</li>\r
- <br>\r
- </ul>\r
- </li>\r
- <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install sources and\r
-make compilation"</b></font></span> type:<br>\r
- <ul>\r
- <li>all sources of the chosen modules and prerequisites are\r
-installed;</li>\r
- <li>all sources are compiled.</li>\r
- </ul>\r
- </li>\r
-</ol>\r
-<p></p>\r
-<p>In case you select "Install sources and make compilation"\r
-installation type, then you can also check "Remove sources and\r
-temporary files after compilation" option.\r
-</p>\r
-<center><a name="Installation_type_page"></a><br>\r
-<img alt="Installation type page" src="installtypepage.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 2:</b> "Type of installation" page\r
-</p>\r
-</center>\r
-<p>After the installation type has been selected you click <i>"Next"</i>\r
-button and the Installation Wizard tries to determine the Linux\r
-platform to load the corresponding configuration file. If the user\r
-system is not defined or the current SALOME package does not support\r
-this one, the warning will appear ("<i>Install binaries</i>"\r
-and "<i>Install sources</i>" installation types only):\r
-</p>\r
-<center><a name="Platform_page"></a><br>\r
-<img alt="Platform page" src="platformpage.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 3:</b> "Installation platform" page\r
-</p>\r
-</center>\r
-<p>If "<i>Install sources and make compilation</i>"\r
-installation type has been selected, the warning message will be\r
-slightly different: "<i>Your Linux platform is not supported by\r
-this SALOME package and compilation is not tested on this one</i>".<br>\r
-There is a list of all platforms supported by SALOME, but only those\r
-supported by the current package are available for selection. in this\r
-page you need to to select the reference platform, if you wish to\r
-proceed with the present installation procedure.<br>\r
-<b>Note:</b> this page is not displayed if the installation\r
-platform has been defined automatically.\r
-</p>\r
-<p>In the next page you are proposed to enter the target\r
-installation directory for SALOME platform. You can also press <i>"Browse..."</i>\r
-button and choose the destination folder using the standard browse\r
-directory dialog box. <br>\r
-If the necessary directory does not exist you are\r
-prompted to confirm the directory creation. If you type a wrong\r
-directory\r
-path, or if you do not have the permissions to write to the chosen\r
-directory, the corresponding message box is shown.<br>\r
-</p>\r
-<p><b>Note: you are strongly recommended to avoid using\r
-directory names containing spaces.</b> Otherwise you can\r
-experience some troubles with the\r
-installation.\r
-</p>\r
-<center><a name="Directory_page"></a><br>\r
-<img alt="Directory page" src="directorypage.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 4:</b> "Installation directory" page\r
-</p>\r
-</center>\r
-<p>You can select the products to be installed in the "Choice of\r
-the products to be installed" page.<br>\r
-In the default mode it gives you the possibility to view and select\r
-SALOME modules only. There is a hidden list of 3d-party prerequisite\r
-products. To show it, just click "<i>Show prerequisites...</i>"\r
-button.\r
-</p>\r
-<center><a name="Products_page1"></a><br>\r
-<img alt="Products page (default mode)" src="productpage1.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 5:</b> Choice of the SALOME modules\r
-</p>\r
-</center>\r
-<p>In the full mode you also have the possibility to select\r
-prerequisites.<br>\r
-The checkbox before each product indicates if this one will be\r
-installed or not (checked or unchecked). The second column shows the\r
-disk space occupied by the corresponding module. This value depends on\r
-the selected type of installation.<br>\r
-To hide the prerequisites list - click "<i>Hide prerequisites</i>"\r
-button.</p>\r
-<center><a name="Products_page2"></a><br>\r
-<img alt="Products page (full mode)" src="productpage2.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 6:</b> Choice of the prerequisites\r
-</p>\r
-</center>\r
-<p>\r
-Some products may require some other prerequisite products to be\r
-installed. So the installation procedure has a special feature to\r
-automatically mark these products in the list view. For example, to\r
-install PyQt it is necessary to have gcc, Python, Qt and Sip installed,\r
-and these products will be also turned on when you check on PyQt. GEOM\r
-module requires KERNEL, GUI modules and such prerequisites as:\r
-OpenCascade, Python, Swig, Qt, etc.\r
-</p>\r
-<p>The dependencies between SALOME modules are managed in the\r
-following way:\r
-</p>\r
-<ul>\r
- <li>If one module is unchecked, all modules which depend on\r
-this one are also unchecked automatically;</li>\r
- <li>If one module is checked, all modules required for this one\r
-are also checked automatically.</li>\r
-</ul>\r
-<p></p>\r
-<p>Dependency between modules and prerequisites is realized in\r
-the following way:\r
-</p>\r
-<ul>\r
- <li>The choices made by the user in the list of modules have a\r
-direct impact on the list of prerequisites;</li>\r
- <li>Whenever a module is checked, all the necessary\r
-prerequisites are checked automatically with no possibility for the\r
-user to uncheck them (see <a href="#Products_page3">Fig.7</a>\r
-below);</li>\r
- <li>Whenever a module is unchecked, according to the remaining\r
-checked modules, the unnecessary prerequisites are unchecked\r
-automatically (see <a href="#Products_page3">Fig.7</a>\r
-below).</li>\r
-</ul>\r
-It is possible to check again the prerequisites, which have been\r
-automatically unchecked. In other words, it is possible to add more\r
-prerequisites than necessary.\r
-<p></p>\r
-<center><a name="Products_page3"></a><br>\r
-<img alt="Products page (dependencies presentation)" src="productpage3.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 7:</b> Dependencies between modules and\r
-prerequisites\r
-</p>\r
-</center>\r
-<p>The "<i>Installation with GUI</i>" checkbox allows\r
-managing the installation of the graphical interface. Only modules for that \r
-'woguimode' attribute is set to "true" value in the XML file \r
-(see <a href="#xml_files">here</a> for more information about\r
-customizing this installation mode) support without GUI mode and \r
-will be checked and installed with their necessary prerequisites in \r
-case of installation without GUI. And other modules are unchecked with no\r
-possibility to check them in this mode (see <a href="#Products_page4">figure</a> below).<br>\r
-By default 'Installation with GUI' checkbox is switched on.\r
-</p>\r
-<center><a name="Products_page4"></a><br>\r
-<img alt="Products page (Installation without GUI)" src="productpage4.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 8:</b> Installation without GUI mode\r
-</p>\r
-</center>\r
-<p>The box at the right side of the page displays the information\r
-about the currently selected product: name, version and short description,\r
-required disk space, disk space required for the temporary files and\r
-the list of prerequisites (this information is provided in the XML\r
-file).\r
-</p>\r
-<p>The <i>"Disk space required:"</i> field displays\r
-how much\r
-disk space on the hard drive is required for installation of the\r
-selected\r
-products.<br>\r
-<b>Note:</b> please, take into account that the displayed\r
-amount of\r
-the required disk space is approximate and may differ when you actually\r
-install products on your hard drive.\r
-</p>\r
-<p>The installation procedure uses a special directory to store\r
-temporary files. The <i>"Space for temporary files"</i>\r
-field shows\r
-the information about the required disk space on the hard drive for\r
-extracting and compiling the selected products. You can change the\r
-temporary directory (this information is provided in the XML file) to\r
-the folder you want.<br>\r
-<span style="font-weight: bold;">Note:</span>\r
-actually, the temporary files\r
-are not stored directly in the directory selected by the user. The\r
-Installation Wizard creates in this directory an additional folder\r
-named\r
-like INSTALLWORK<span style="font-weight: bold;">XXXXX</span>\r
-where XXXXX is a unique number. This allows launching several\r
-Installation Wizards simultaneously. This temporary directory is\r
-removed automatically when the installation finishes.<br>\r
-</p>\r
-<p>The installation procedure also checks the available disk\r
-space. If\r
-there is not enough disk space on your hard drive you will see the\r
-corresponding error message box.\r
-</p>\r
-<p>Also in the current version of Installation Wizard is possible\r
-to install all binaries of the selected SALOME modules into a <b>single</b>\r
-directory. It is "<i>SALOME</i>" directory.\r
-For this purpose there is a checkbox "<i>Install modules to a\r
-single directory</i>" checkbox exists (see <a href="#Products_page4">Fig.8</a>).<br>\r
-This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH\r
-environment variables.<br>\r
-<b>Note:</b> the installation into a single directory is\r
-available with the binaries installation type only.\r
-</p>\r
-<p>To proceed further, click <i>"Next"</i> button.\r
-At this moment\r
-the program will make some tests to check the installation settings: if\r
-there is enough disk space on the hard drive, check for the\r
-dependencies for each product you have selected to be installed. If any\r
-test fails you will see the corresponding warning message box.\r
-Otherwise the wizard will proceed to the next page:\r
-</p>\r
-<center><a name="ChoicePage"></a><br>\r
-<img alt="Choice page" src="choicepage.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 9:</b> "Check your choice" page\r
-</p>\r
-</center>\r
-<p>This page summarizes the installation options you've selected\r
-in the\r
-previous pages. You can review again your choices and change them if\r
-necessary returning to the previous pages. <br>\r
-When you are sure that everything is OK, press <i>"Next"</i>\r
-button to\r
-follow to the <a href="#ProgressPage">progress page</a>.\r
-</p>\r
-<center><a name="ProgressPage1"></a><br>\r
-<img alt="Progress page (not started yet)" src="progresspage1.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 10:</b> "Installation progress" page:\r
-not started yet\r
-</p>\r
-</center>\r
-<div style="text-align: left;">To start the installation\r
-of the selected\r
-products click <i>"Start"</i>\r
-button. It launches the shell installation script and you will be able\r
-to see the output of the script in the topmost frame of the dialog box.\r
-If any\r
-errors occur during the installation progress, the corresponding\r
-messages\r
-will be printed to the log window in the bold red font.<br>\r
-</div>\r
-<div style="text-align: left;">It is possible to break the\r
-installation at any time by pressing <span style="font-style: italic;">"Stop"</span>\r
-button. Then you can get back to the previous pages if you wish to\r
-change the installation settings or restart the installation by\r
-pressing <span style="font-style: italic;">"Start"</span>\r
-button again.<br>\r
-</div>\r
-<p style="text-align: left;"><span style="font-weight: bold;">Note:</span>\r
-in the current\r
-implementation it is not possible to resume the stopped installation\r
-process; the installation will restart from the very beginning. <br>\r
-</p>\r
-<center><a name="ProgressPage2"></a><br>\r
-<img alt="Progress page (installation started)" src="progresspage2.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 11:</b> "Installation progress" page:\r
-installation in\r
-progress\r
-</p>\r
-</center>\r
-<p>The <i>"Installation Status"</i> frame window\r
-shows you the\r
-progress of installation. "<font color="#ff0000">Waiting</font>"\r
-status\r
-means that the installation of this product has not started\r
-yet. The product currently being installed is marked as "<font color="#ff9900">Processing</font>" and is displayed in\r
-the status bar under "Installation Status" view. All installed products\r
-have "<font color="#33ff33">Completed</font>"\r
-status.\r
-</p>\r
-<p>You can abort the installation and close the installation\r
-procedure\r
-using <i>"Cancel"</i> button. <br>\r
-<span style="font-weight: bold;">Note:</span> this\r
-button sends the\r
-signal "SIGTERM" to the shell script.\r
-The script tries to clear all temporary files.\r
-The process of removing the temporary files can take some time, so the\r
-installation wizard will wait for 3 seconds before closing.\r
-</p>\r
-<p>At the end of the installation "<b>Installation completed</b>"\r
-message will appear in the status bar. You can return to the previous\r
-pages to start a new installation or click <i>"Next"</i>\r
-button to go to the readme page: </p>\r
-<center><a name="readmepage"></a><br>\r
-<img alt="Readme page" src="readmepage.png" style="width: 593px; height: 468px;">\r
-<p><b>Figure 12:</b> "Finish installation" page\r
-</p>\r
-</center>\r
-<p>In this page you can read important information about the\r
-Installation Wizard itself and some tips: how to run and test SALOME or\r
-how to build SALOME from the sources. This is also described the\r
-README file which you can find in the root directory of the\r
-Installation Wizard. <br>\r
-You can also launch SALOME Desktop from this\r
-page or read the Release Notes file by clicking on the corresponding\r
-buttons in the lower part of the page (see <a href="#xml_files">here</a>\r
-and <a href="#finish_buttons">here</a> for more\r
-information about\r
-customizing these buttons).<br>\r
-</p>\r
-<h3 style="margin-left: 40px;"> <a name="batch_mode"></a>Batch mode<br>\r
-</h3>\r
-To launch the Installation Wizard in the batch mode use <span\r
-style="font-weight: bold;">-b</span>\r
-(<span style="font-weight: bold;">--batch</span>) parameter.<br>\r
-In this mode the GUI wizard is not shown but all the installation\r
-status is displayed directly in the console. In the batch mode user do\r
-not have a possibility to change installation settings which are given\r
-in the configuration file, except target and temporary directories\r
-which can be overridden by the corresponding command line options.<br>\r
-There are two exceptions: <b>--all-from-sources</b>\r
-(<b>-a</b>) option which enables\r
-special installation mode in which all the products (including SALOME\r
-modules) are installed from sources, ignoring default mode defined in\r
-the XML configuration file (see <a href="#install_from_wizard">here</a>\r
-for details) and <b>--single-directory</b> (<b>-s</b>) option which defines\r
-that all SALOME modules have to be installed into the one directory \r
-(SALOME_<version>, by default, where <version> is SALOME version).\r
-<center><a name="BatchMode"></a><br>\r
-<br>\r
-<img alt="Batch mode" src="batchmode.png"\r
-style="width: 660px; height: 410px;">\r
-<p><b>Figure 9:</b> Batch mode</p>\r
-</center>\r
-<h3 style="margin-left: 40px;"><a name="env_files"></a>Environment\r
-files</h3>\r
-<p>During the process of installation the\r
-script creates some\r
-environment files to simplify the procedure of launching SALOME. These\r
-shell scripts set\r
-all necessary environment variables for all products you have\r
-installed.\r
-To learn how the installation scripts collect the environment, see <a href="#pick_up_env">here</a>. These files are: <b>salome.csh</b>\r
-+ <b>salome.sh</b>\r
-in the <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL module</span></span><b><i>\r
-sources</i></b>\r
-and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL\r
-module</span></span><b><i> binaries</i></b>\r
-root directories and <b>env_products.csh</b>\r
-+ <b>env_products.sh </b>and <span style="font-weight: bold;">env_build.csh\r
-</span>+ <span style="font-weight: bold;">env_build.sh</span>\r
-in the\r
-target installation directory.<br>\r
-</p>\r
-<span style="font-weight: bold;">Note:</span> there\r
-is some difference\r
-between these files: <span style="font-weight: bold;">env_build.*</span>\r
-files are optimized to\r
-be used for the building of SALOME modules from sources (see <span style="font-weight: bold;">README </span>file\r
-provided with the\r
-installation procedure on the CD). The <span style="font-weight: bold;">env_products.*</span>\r
-(and<span style="font-weight: bold;"> salome.*</span>)\r
-files are\r
-optimized for\r
-the SALOME launching. The behavior is defined by the environment\r
-variable<span style="font-weight: bold;"> </span><b>ENV_FOR_LAUNCH</b>\r
-which is set to <span style="font-weight: bold;">0</span>\r
-in\r
-env_build.* files and to <span style="font-weight: bold;">1</span>\r
-in\r
-env_products.*\r
-(salome.*) files.<br>\r
-<br>\r
-<hr>\r
-<h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>\r
-Please, read carefully the following information. This section\r
-describes how the installation procedure generates the environment\r
-scripts for the SALOME platform being installed.\r
-<p>After the installation of each product the shell script\r
-creates a special\r
-environment file for the product in its installation folder. The name\r
-of the file is generated from the name of the product by the following\r
-scheme: <b>env_<product_name>.sh</b>\r
-(for example <b>env_Vtk.sh </b>for the Vtk).\r
-This file includes all necessary environment settings. At the final\r
-step of the installation the script picks up all settings files and\r
-generates from them two common environment files: <b>salome.sh</b>\r
-and <b>salome.csh\r
-</b>for <span style="font-weight: bold;">bash</span>\r
-and <span style="font-weight: bold;">csh</span>\r
-shells correspondingly. This\r
-approach helps to save time when reinstalling products and you may can\r
-avoid setting all environment variables\r
-manually to build/launch SALOME. What you need is to source one of\r
-these environment files. </p>\r
-<p>This also concerns the products which are not being installed.\r
-For example, you install some SALOME binaries to the directory where\r
-you have previously installed other products. The\r
-installation\r
-procedure tries to collect the environment files from the target\r
-directory if it finds necessary products installed there. If a\r
-product is not found in the target directory the corresponding\r
-section of <b>salome.sh/salome.csh</b> files will be\r
-commented. <br>\r
-For the native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>\r
-the installation procedure tries to find them first using <b>PATH</b>\r
-/ <b>LD_LIBRARY_PATH</b> variables and then in the system\r
-default\r
-directories (<b>/usr/bin, /usr/lib</b> etc., depending on\r
-the product).\r
-</p>\r
-<p>In any case you are able to edit <b>salome.*</b>\r
-files after the installation procedure finished.<br>\r
-<span style="font-weight: bold;"><br>\r
-Note:</span> as it has been mentioned <a href="#env_files">above</a>\r
-there\r
-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\r
-files can be\r
-found in the target installation root directory.<br>\r
-</p>\r
-<hr>\r
-<h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font>\r
-configuration <font color="#ff0000">file</font></h3>\r
-<font color="#000000">You can create your own XML\r
-configuration file.\r
-The Installation Wizard can take it as a command line argument to\r
-provide a list of products you want to install with it. The list of\r
-products and some other settings for the Installation Wizard are\r
-provided in the XML file.<br>\r
-This section describes the structure of the configuration file.</font>\r
-<font color="#000000">XML tags are in bold blue, optional\r
-sections/tags\r
-are in brackets.</font>\r
-<font face="Courier">\r
-<p><b><font color="#000099"><document></font></b>\r
-<br>\r
-<font color="#000000"><b> \r
-</b></font><b><font color="#000099">\r
-<config</font></b><font color="#000000">\r
-[ version=<application_version>\r
- ]</font> <br>\r
-<font color="#000000"> \r
- \r
- [\r
-caption=<application_caption>\r
- ]</font> <br>\r
-<font color="#000000"> \r
- \r
- [\r
-copyright=<application_copyright> ]</font>\r
-<br>\r
-<font color="#000000"> \r
- \r
- [\r
-license=<application_license_info> ]</font> <br>\r
-<font color="#000000"> \r
- \r
- \r
-platforms=<target_platform></font> <br>\r
-<font color="#000000"> \r
- \r
- [\r
-targetdir=<target_directory>\r
- ] </font>\r
-<br>\r
-<font color="#000000"> \r
- \r
- \r
-[\r
-tempdir=<temp_directory> \r
- ]</font><b><font color="#000099"><br>\r
- /> </font></b>\r
-<br>\r
-<font color="#000000"><b> \r
-</b>[ </font><b><font color="#000099"><buttons></font></b>\r
-<br>\r
-<font color="#000000"><b> \r
-</b>[ </font><b><font color="#000099"><button</font></b>\r
-<font color="#000000"> \r
-label=<button_label> </font>\r
-<br>\r
-<font color="#000000"> \r
- \r
-[ tooltip=<button_tooltip> ]</font> <br>\r
-<font color="#000000"> \r
- \r
- \r
-script=<button_script> </font>\r
-<br>\r
-<font color="#000000"> \r
- \r
-[ disable=<disable_flag> ]</font><font color="#000099"><br>\r
- <b>/></b>\r
-</font><font color="#000000"><br>\r
- ]</font> <br>\r
-<font color="#000000"> \r
-[</font><b><font color="#000099">\r
-<button</font></b><font color="#000000">\r
-... </font><font color="#000099"><br>\r
- <b>/></b></font>\r
-<br>\r
-<font color="#000000"> \r
-]</font><br>\r
-<font color="#000000"> \r
-...</font>\r
-<font color="#000099"><br>\r
- <b></buttons></b>\r
-</font><font color="#000000"><br>\r
- ]</font> <br>\r
-<font color="#000000"> [</font><b><font color="#000099"> <products></font></b>\r
-<br>\r
-<font color="#000000"> \r
-[</font><b><font color="#000099">\r
-<product</font></b><font color="#000000"> \r
-name=<product_name></font> <br>\r
-<font color="#000000"> \r
- \r
- \r
-type=<product_type></font> <br>\r
- \r
- [\r
-description=<product_description> ]<br>\r
-<font color="#000000"> \r
-</font><b><font color="#000099">\r
-<installation</font></b><font color="#000000"> \r
-os=<installation_platform></font> <br>\r
-<font color="#000000"> \r
- \r
- \r
- \r
-version=<product_version></font> <br>\r
-<font color="#000000"> \r
- \r
- \r
- [\r
-disable=<disable_flag>\r
- ]\r
-<font color="#000000"><br> \r
- \r
- \r
- [\r
-woguimode=<without_gui_mode_flag> ]\r
-<font color="#000000"><br>\r
- \r
- \r
-installdiskspace=<install_disk_space></font><br>\r
- \r
- \r
- [\r
-pickupenv=<pickup_env_flag>\r
- ]</font> \r
-<font color="#000000"><br>\r
- \r
- \r
- \r
- \r
-script=<installation_script_name></font><br>\r
-<font color="#000099"> \r
-<b>/></b></font><br>\r
-<font color="#000000"> \r
-...</font>\r
-<font color="#000099"><br>\r
- <b>/></b></font><font color="#000000">\r
-<br>\r
- ]</font> <font color="#000000"><br>\r
- [</font><b><font color="#000099"> <product</font></b><font color="#000000"> ... </font><font color="#000099"><br>\r
- <b>/></b></font><font color="#000000"> <br>\r
- ]</font><br>\r
-<font color="#000000"> \r
-...</font><br>\r
-<font color="#000000"> </font><b><font color="#000099"> </products></font></b>\r
-<br>\r
-<font color="#000000"> ]</font><br>\r
-<font color="#000000"> [</font><b><font color="#000099"> <dependencies></font></b>\r
-<br>\r
-<font color="#000000"> \r
-[</font><b><font color="#000099">\r
-<product</font></b><font color="#000000"> \r
-name=<product_name></font><b><font color="#000099"> ></font></b> <br>\r
-<font color="#000000"> \r
-[</font><b><font color="#000099">\r
-<dep></font></b> <font color="#000000"><prerequisite_name></font>\r
-<b><font color="#000099"> </dep></font></b>\r
-<font color="#000000">]</font><br>\r
-<font color="#000000"> \r
-...</font><br>\r
-<font color="#000000"> </font><b><font color="#000099"> </product></font></b>\r
-<br>\r
-<font color="#000000"> \r
-]</font><br>\r
-<font color="#000000"> \r
-...</font><br>\r
-<font color="#000000"> </font><b><font color="#000099"> </dependencies></font></b>\r
-<br>\r
-<font color="#000000"> ]</font><br>\r
-<b><font color="#000099">\r
-</document></font></b> </font></p>\r
-\r
-<h4><font color="#000000"><config>\r
-section</font></h4>\r
-<font color="#000000">This section provides general\r
-information about an application that will be installed.<br>\r
-<br>\r
-Attributes:<br>\r
-</font>\r
-<ul>\r
- <li> <font color="#000000"><b>version</b></font></li>\r
-</ul>\r
-<font color="#000000">The application version number to be\r
-shown in the\r
-caption.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>caption</b></font></li>\r
-</ul>\r
-<font color="#000000">The application main window caption\r
-- if this\r
-string contains '%1' text the title will contain\r
-the version number in this place (see above).</font>\r
-<ul>\r
- <li> <font color="#000000"><b>copyright</b></font></li>\r
-</ul>\r
-<font color="#000000">The application\r
-copyright information (shown in the first page).</font>\r
-<ul>\r
- <li> <font color="#000000"><b>license</b></font></li>\r
-</ul>\r
-<font color="#000000">The application license information\r
-(shown in the\r
-first page).</font>\r
-<ul>\r
- <li> <font color="#000000"><b>platforms</b></font></li>\r
-</ul>\r
-<font color="#000000">This parameter defines platforms for\r
-whose the configurations from this file will be used. Also it provides\r
-the directory name (relative from ./Products/BINARIES) where the\r
-Installation Wizard will search for precompiled binaries packages.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>targetdir</b></font></li>\r
-</ul>\r
-<font color="#000000">The target\r
-directory is the path to the directory where the products should be\r
-installed.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>tempdir</b></font></li>\r
-</ul>\r
-<font color="#000000">The temporary directory is\r
-the path to the directory for the temporary files.</font>\r
-<h4> <b><buttons> section</b></h4>\r
-This is an optional section and may contains one or more\r
-<product> sections.\r
-<h4> <b><button> section</b></h4>\r
-This optional section allows customization of the last <i>"Finish\r
-installation"</i> page of the Installation Wizard by adding one\r
-or\r
-more buttons in the lower part of the Installation Wizard window. The\r
-script\r
-which is attached to each such button, can perform some specific\r
-actions, for example, launch the application or show the 'Release\r
-Notes'\r
-file by using an external program.\r
-See <a href="#finish_buttons">here</a> for more\r
-details about\r
-writing scripts.<br>\r
-<font color="#000000"><br>\r
-Attributes:</font><br>\r
-<ul>\r
- <li> <font color="#000000"><b>label</b></font></li>\r
-</ul>\r
-<font color="#000000">This is the button text.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>tooltip</b></font></li>\r
-</ul>\r
-<font color="#000000">The button tooltip (optional).</font>\r
-<ul>\r
- <li> <font color="#000000"><b>script</b></font></li>\r
-</ul>\r
-<font color="#000000">The script attached to the button.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>disable</b></font></li>\r
-</ul>\r
-<font color="#000000">If this optional flag has 'true'\r
-value, the corresponding button will not appear in the <i>"Finish\r
-installation"</i> page - the section of XML file is ignored.</font><br>\r
-<h4> <b><products> section</b></h4>\r
-This one contains a list of <product> sections. The\r
-products appear in the tree view and are installed in the order they\r
-are described in this section.\r
-<h4> <b><product> section</b></h4>\r
-Current section is optional. It describes the product to be installed\r
-with the Installation\r
-Wizard. The <products> container should include\r
-<product> section for each\r
-product to be installed.<br>\r
-<font color="#000000"><br>\r
-Attributes:</font><br>\r
-<ul>\r
- <li> <font color="#000000"><b>name</b></font></li>\r
-</ul>\r
-<font color="#000000">The name of the product.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>type</b></font></li>\r
-</ul>\r
-<font color="#000000">The type of the product: '<i>component</i>'\r
-- SALOME module or '<i>prerequisite</i>' - prerequisite\r
-product.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>description</b></font></li>\r
-</ul>\r
-The <font color="#000000">product </font><font color="#000000">description\r
-(optional).</font>\r
-<h4> <b><installation> section</b></h4>\r
-It is a part of the <product> section, that provides\r
-installation information by platforms. The <product>\r
-section may contains a several <installation> ones for\r
-the different platforms.\r
-<br>\r
-<font color="#000000"><br>\r
-Attributes:</font><br>\r
-<ul>\r
- <li> <font color="#000000"><b>os</b></font></li>\r
-</ul>\r
-<font color="#000000">A possible installation platform.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>version</b></font></li>\r
-</ul>\r
-<font color="#000000">The version of the product.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>disable</b></font></li>\r
-</ul>\r
-<font color="#000000">If this optional flag has 'true'\r
-value, the corresponding product will not appear in the list of\r
-products and will not be installed.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>woguimode</b></font></li>\r
-</ul>\r
-<font color="#000000">This optional flag defines that \r
-it's possible to install this module without GUI.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>installdiskspace</b></font></li>\r
-</ul>\r
-<font color="#000000">List of three total amount spaces\r
-(integer, in Kbytes, derived by comma), which product occupies on the\r
-hard drive after the installation in case 'binary', 'sources' and\r
-'sources and compile' installation type.</font>\r
-<ul>\r
- <li><b>pickupenv</b></li>\r
-</ul>\r
-This flag shows that the pickup environment\r
-procedure should be performed for this product. If this flag equal to\r
-'true',\r
- salome.sh and salome.csh files will be created in\r
-the product's\r
-installation directory. Usually this option is set to true for SALOME\r
-KERNEL module. This is optional key, default value is 'false'<b>.</b><br>\r
-<ul>\r
- <li> <font color="#000000"><b>script</b></font></li>\r
-</ul>\r
-<font color="#000000">The installation script name.\r
-This script is in charge of the installation of the product. It is\r
-called\r
-automatically by the Installation Wizard when necessary from the main\r
-program. See the <a href="#new_products">next\r
-section</a> for\r
-more information.</font><br>\r
-<br>\r
-<b>Note:</b> If you add new products to be\r
-installed with Installation Wizard, you should also provide\r
-installation script for this product. See the next section for more\r
-details.\r
-<p><br>\r
-</p>\r
-<hr>\r
-<h3><a name="new_products"></a>Implementing <font color="#ff0000">installation\r
-scripts</font> for the new products</h3>\r
-When you want some product to be installed with the Installation\r
-Wizard, you should add it's description it <a href="#xml_files">in\r
-the\r
-configuration file</a> and create the installation script,\r
-following\r
-rules described in this section. <br>\r
-<br>\r
-There are some obligatory functions which should be implemented in this\r
-installation\r
-script. These functions are automatically called by master installation\r
-script\r
-or/and its GUI shell when it is necessary.<br>\r
-<font color="#000000">File <b>common.sh</b>\r
-contains some service\r
-functions\r
-which can be used in your installation script, like <b>make_env()</b>,<b>\r
-make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b>\r
-find_in_path()</b>,\r
-etc.</font>\r
-<ul>\r
- <li> <b>check_version()</b></li>\r
-</ul>\r
-This function allows to check the\r
-version of the product already installed on the computer. It should try\r
-to find product (native or preinstalled in the target directory) and\r
-check\r
-its version. This helps to avoid unnecessary reinstallation. This is\r
-internal\r
-function and is not called from the master installation script.<br>\r
-<ul>\r
- <li><font color="#000000"><b>install_binary()</b></font></li>\r
-</ul>\r
-<font color="#000000">This function is\r
-called when <i>'Install binaries'</i> installation mode is\r
-selected by\r
-the user. The function is responsible for the extracting of the product\r
-from the binaries package. It should create environment for the product\r
-in\r
-the temporary directory (see also the description of <b>print_env()</b>\r
-function). It is not necessary to implement this function if you do not\r
-provide binaries mode\r
-installation for the current product. <br>\r
-</font>\r
-<ul>\r
- <li> <font color="#000000"><b>install_source()</b></font></li>\r
-</ul>\r
-<font color="#000000">This function is\r
-called to install SALOME modules sources, if <i>'Install binaries</i>'\r
-installation mode is selected by the user, and to install prerequisite\r
-products sources, in <i>'Install sources</i>' case (see <a href="#Installation_type_page">Fig.2</a> above). The\r
-function is responsible for the building of the product from\r
-the sources package. It should create the environment file for the\r
-product\r
-in the temporary directory (see also the description of <b>print_env()</b>\r
-function). It is not necessary to implement this function if you do not\r
-provide a sources mode installation for the current product.</font>\r
-<br>\r
-<ul>\r
- <li> <font color="#000000"><b>install_source_and_build()</b></font></li>\r
-</ul>\r
-<font color="#000000">This function is\r
-called when <i>'Install sources and make a compilation'</i>\r
-installation mode is selected. This function should be used to unpack\r
-SALOME or prerequisite sources package and then call build/install\r
-procedure for it.<br>\r
-For more details please refer to <a href="#gui_mode">this</a>\r
-section for more details.<br>\r
-</font>\r
-<ul>\r
- <li> <b>try_preinstalled()</b></li>\r
-</ul>\r
-<font color="#000000">This function\r
-is used to parse the target directory to try to find an already\r
-installed product, to pick up and to check the environment from\r
-there. See <a href="#pick_up_env">here</a> for more\r
-details.</font>\r
-<ul>\r
- <li> <font color="#000000"><b>print_env_bin()\r
- </b> & <b> print_env_src()</b></font></li>\r
-</ul>\r
-<font color="#000000">These functions are in charge of the\r
-creation of the environment scripts. They should create in the\r
-temporary directory two files with <b>env_<product_name>.sh</b>\r
-and <b>env_<product_name>_src.sh</b>\r
-names and then copy them into the binary and sources product\r
-installation directories correspondingly. The file should contain all\r
-necessary\r
-environment variable settings for the product. It will be collected\r
-during the 'pick-up-environment' procedure.</font>\r
-<ul>\r
- <li><b>pickup_env()</b></li>\r
-</ul>\r
-This procedure corresponds to <b>pickupenv</b> tag\r
-of the configuration xml file (see the previous section). It should\r
-call <b>make_env</b>\r
-procedure to perform the pick-up environment procedure for the product.<br>\r
-<br>\r
-<font color="#000000">The calling signature of the product\r
-installation\r
-script is the following:</font> <br>\r
-<b><font color="#000000">\r
-<product_script_name>\r
-<function_name>\r
-<temp_folder>\r
-<products_directory>\r
-<target_directory>\r
-<all_products>\r
-<product_name>\r
-<install_products>\r
-<sources_directory>\r
-<remove_sources_flag>\r
-<binaries_directory>\r
-<single_directory_flag> </font></b>\r
-<p><font color="#000000">where</font> <br>\r
-</p>\r
-<p><font color="#000000"><b><product_script_name></b>\r
--\r
-the name of the installation script (described in the configuration XML\r
-file);</font> <br>\r
-<font color="#000000"><b><function_name></b>\r
-- the name of\r
-the function, corresponding to the selected installation type and\r
-currently installed product; </font> <br>\r
-<font color="#000000"><b>\r
-<temp_folder> </b> - the directory for the\r
-temporary files; </font> <br>\r
-<font color="#000000"><b><products_directory></b>\r
-- the directory\r
-where the sources/binaries package can be found. You should provide\r
-sources package in the <i><Install_Wizard_root_directory>/Products/SOURCES</i>\r
-directory and binaries package in the <i><InstallWizard_root_directory>/Products/BINARIES/<os_version></i>,\r
-where <os_version> is the target platform description,\r
-which appears\r
-in the corresponding section of the <a href="#xml_files">configuration\r
-xml\r
-file</a>.</font> <br>\r
-<font color="#000000"><b>\r
-<target_directory> </b> - the root target\r
-directory where the product should be installed to;</font> <br>\r
-<font color="#000000"><b>\r
-<all_products> </b> - single-quoted list\r
-of all products, separated by space;</font> <br>\r
-<font color="#000000"><b>\r
-<product_name> </b>- product name\r
-itself;</font> <br>\r
-<font color="#000000"><b>\r
-<install_products> </b> - single-quoted list\r
-of all products to be installed, separated by space;</font> <br>\r
-<font color="#000000"><b>\r
-<sources_directory> </b> - the directory\r
-where the sources package can be found (it is usable if the\r
-<products_directory> parameter gives the binaries\r
-directory path); </font> <br>\r
-<font color="#000000"><b>\r
-<remove_sources_flag> </b> - bool parameter, that\r
-is equal to 'TRUE' if 'Remove sources and temporary files after\r
-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>\r
-<font color="#000000"><b>\r
-<binaries_directory> </b> - the directory\r
-where the binaries package can be found (it is usable if the\r
-<products_directory> parameter gives the sources\r
-directory path); </font> <br>\r
-<font color="#000000"><b>\r
-<single_directory_flag> </b> - bool parameter,\r
-that is equal to 'TRUE' if 'Install modules to a single directory'\r
-option is selected by the user (see <a href="#Products_page1">Fig.5</a>\r
-above). </font> <br>\r
-</p>\r
-<p><font color="#000000">Example:</font> <br>\r
-<i><font color="#000000">med-2.3.3.sh install_binary\r
-/tmp/INSTALLWORK21797\r
-./Products/BINARIES/Mandriva2006.0\r
-'gcc tcltk tcltk_src Python Python_src Qt Qt_src ... DOCUMENTATION\r
-DOCUMENTATION_src'\r
-Med\r
-'gcc Hdf Med'\r
-./Products/SOURCES\r
-FALSE\r
-./Products/BINARIES/Mandriva2006.0\r
-</font></i></p>\r
-<p><font color="#000000">Copy the created script\r
-into\r
-the <i><Install_Wizard_root_directory>/config_files</i>\r
-sub-directory where all installation scripts are stored. The Installation\r
-Wizard will automatically search and call your script during the\r
-installation\r
-procedure.</font>\r
-</p>\r
-<hr> <br>\r
-<h3><a name="finish_buttons"></a>Customizing <font color="#ff0000">Readme\r
-page</font> buttons</h3>\r
-The Installation Wizard allows customizing the layout of the last\r
-<i>"Finish installation"</i> page. If you want to add one\r
-or more\r
-buttons in this page to perform some specific actions at the\r
-end of the installation (for example, show the 'Release Notes' file by using\r
-Open Office) you can put an additional section to the XML\r
-configuration file. This is the <b><button></b>\r
-section (see <a href="#xml_files">here</a> for more\r
-details). <br>\r
-<br>\r
-To implement the action which will be performed when the user clicks on\r
-the button, you need to create a script and to put it into the\r
-<i><Install_Wizard_root_directory>/config_files</i>\r
-directory.<br>\r
-There are some obligatory functions which should be implemented in this\r
-script. These functions are automatically called by the Installation\r
-Wizard GUI.\r
-<ul>\r
- <li><b>check_enabled()</b></li>\r
-</ul>\r
-This procedure is called by the Installation Wizard when the\r
-<i>"Finish installation"</i> page is displayed and the\r
-status of the\r
-buttons should be modified according to the installation options. This\r
-procedure should return <b>0</b> if the corresponding\r
-action can be\r
-performed and, thus, the button should be enabled. Otherwise, it\r
-should return <b>1</b> - in this case the corresponding\r
-button will be\r
-disabled.\r
-<ul>\r
- <li><b>execute()</b></li>\r
-</ul>\r
-This procedure is invoked when the user clicks the button. This\r
-procedure should return <b>0</b> if the corresponding\r
-action is carried out\r
-successfully and <b>1</b> if any error occurs.<br>\r
-<br>\r
-The calling signature of the script is the following:<br>\r
-<b><font color="#000000"><product_script_name>\r
-<function_name> <target_directory>\r
-<temp_folder></font></b>\r
-<p><font color="#000000">where</font> <br>\r
-</p>\r
-<p><font color="#000000"><b><product_script_name></b>\r
--\r
-the script name itself (retrieved from the XML configuration xml\r
-file);</font> <br>\r
-<font color="#000000"><b><function_name></b>\r
-- the name of the function;</font> <br>\r
-<font color="#000000"><b><target_directory></b>\r
-- the root target\r
-directory where the product is\r
-installed to;</font> <br>\r
-<font color="#000000"><b><temp_folder>\r
-</b> - the directory for the temporary files.</font> <br>\r
-<br>\r
-<b>Note:</b> The standard Installation Wizard buttons\r
-"Launch\r
-SALOME" and "Release Notes" are implemented with this\r
-feature. Refer to the scripts <b>start_salome.sh</b> and\r
-<b>release_notes.sh</b> for the sample implementation.<br>\r
-<br>\r
-<b>Note:</b> Any button (even standard) can be ignored by\r
-the\r
-Installation Wizard if the attribute <b><disable></b>\r
-in the XML\r
-configuration file is set to the "true" value.\r
-</p>\r
-<hr><br>\r
-</font>\r
-</body>\r
+<html>
+<head>
+ <meta http-equiv="Content-Type"
+ content="text/html; charset=iso-8859-1">
+ <meta name="GENERATOR"
+ content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">
+ <meta name="Author"
+ content="Alexander KOVALEV, Open CASCADE SAS (alexander.kovalev@opencascade.com)">
+ <meta name="Copyright" content="2002-2008 CEA">
+ <title>SALOME Installation Wizard Help</title>
+</head>
+<body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 229);"
+ alink="#ff0000" link="#0000ee" vlink="#551a8b">
+
+<center>
+<table nosave="" width="100%">
+ <tbody>
+ <tr nosave="">
+ <td nosave="">
+ <h1><a href="http://www.opencascade.com"><img src="logocorp.png"
+ border="0" height="47" width="139"> </a></h1>
+ </td>
+ <td>
+ <center>
+ <h3><font size="+4"><font color="#000099">SALOME Installation
+Wizard Help</font></font></h3>
+ </center>
+ </td>
+ <td>
+ <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
+ src="application.png" border="0" height="47" width="109"> </a></div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</center>
+<div align="right"><b><font color="#000099">updated for the version </font><font
+ color="#ff0000">4.1.4</font></b></div>
+<hr>
+<ul>
+ <li> <a href="#install_from_wizard">Installing products with the
+Installation Wizard<br>
+ </a></li>
+ <ul>
+ <li><a href="#gui_mode">GUI mode</a></li>
+ <li><a href="#batch_mode">Batch mode</a></li>
+ <li><a href="#env_files">Environment files</a><br>
+ </li>
+ </ul>
+ <li> <a href="#pick_up_env">Pick up the environment</a></li>
+ <li> <a href="#xml_files">Modifying XML configuration file</a></li>
+ <li> <a href="#new_products">Implementing installation scripts for
+the new products</a></li>
+ <li> <a href="#finish_buttons">Customizing Readme page buttons</a></li>
+</ul>
+<h3>
+<hr></h3>
+<h3> <a name="install_from_wizard"></a>Installing products with the <font
+ color="#ff0000">Installation Wizard</font></h3>
+The Installation Wizard can be launched in two modes: <span
+ style="font-weight: bold;">GUI </span>and <span
+ style="font-weight: bold;">batch</span>. <br>
+The root directory of the Installation Wizard
+contains Python script <span style="font-weight: bold;">runInstall</span>.
+To run the Installation Wizard just type <b>./runInstall</b> in the
+terminal
+window:<span style="font-weight: bold;"></span><span
+ style="font-weight: bold;"></span>
+<p>[ python ] <b>./runInstall </b>[options]<b><br>
+</b></p>
+<p>Without options this script will launch the SALOME Installation
+Wizard in the GUI mode.<br>
+The default installation settings can be overridden by using of command
+line options. Each option has short and long notations:<br>
+</p>
+<p><b>-g / --gui</b><br>
+</p>
+<div style="margin-left: 40px;">Runs the Installation Wizard in the
+GUI
+mode (this is the default mode).<br>
+</div>
+<p><b>-b / --batch</b><br>
+</p>
+<div style="margin-left: 40px;">Runs the Installation Wizard in
+the terminal mode. <br>
+</div>
+<p><b>-f FILE / --file=</b><span style="font-weight: bold;">FILE<br>
+</span></p>
+<div style="margin-left: 40px;">
+This is the XML configuration file used by the Installation Wizard.
+If this option is not used, the installation script tries to define
+the<i>Linux </i>version and to use the corresponding XML file
+if it is present.
+For example, for <span style="color: rgb(0, 0, 153);">Linux Mandriva
+2006</span> the <b>config_Mandriva_2006.0.xml</b>
+file
+will be used by default.
+</div>
+<p> <b>-d DIR / --target=DIR</b><br>
+</p>
+<div style="margin-left: 40px;">This is the target installation
+directory for SALOME platform. If used, this option overrides
+the default target directory, given in the
+configuration XML file (usually<span style="font-weight: bold;">
+${HOME}/salome_<version></span><!--,
+see
+<a href="#xml_files">here</a> for more details-->).<br>
+</div>
+<p><b>-t DIR / --tmp=DIR </b></p>
+<div style="margin-left: 40px;">This is the directory, for
+temporary files. If given, this option overrides the default
+temporary directory, given in the configuration xml file
+(usually <span style="font-weight: bold;">/tmp</span>
+<span style="font-weight: bold;"></span><!--,
+see <a href="#xml_files">here</a> for more information-->).<br>
+</div>
+<p><b>-a / --all-from-sources</b></p>
+<div style="margin-left: 40px;">
+Force all the products to be installed from sources (including all
+SALOME modules). If this option is used, all the default installation
+modes for all the products are ignored.<br>
+This option is helpful when the user wants to install SALOME on the
+platform which is not officially supported. In this case, the user can
+try to run the SALOME Installation Wizard with the <span
+ style="font-weight: bold;">-a</span> option in order to build all the
+products from sources.<br>
+<b>Note, that this is long-time operation which can take more than
+24 hours depending on the computer.</b><br>
+</div>
+<p><b>-s / --single-directory </b></p>
+<div style="margin-left: 40px;">Install all SALOME binaries packages
+to one directory.<br>
+<b>This option is ignored when --all-from-sources (-a) option is used.
+</b></div>
+<p><b>-h / --help</b><br>
+</p>
+<div style="margin-left: 40px;">Prints help information on
+the usage of the Installation Wizard. <br>
+</div>
+<p></p>
+<p>
+<b>-v / --version</b><br>
+</p>
+<div style="margin-left: 40px;">Prints version information
+(<span style="font-weight: bold;">Note: </span>this
+is the version number of the Installation Wizard, not of SALOME platform). <br>
+</div>
+<p>
+</p>
+<p>The installation procedure supports different <span style="color: rgb(0, 0, 153);">Linux
+</span>platforms and installs various 3d-party installation prerequisite products, which
+are required by SALOME platform. 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
+need and then use this XML file with the Installation Wizard. This can
+be done, for example, for some <span style="color: rgb(0, 0, 153);">Linux
+</span>platform which is not supported directly by the
+Installation Wizard. See <a href="#xml_files">Modifying XML
+configuration file</a> and <a href="#new_products">Implementing installation
+scripts for the new products</a> sections for more information. </p>
+<h3 style="margin-left: 40px;"> <a name="gui_mode"></a>GUI
+mode<br>
+</h3>
+<p>The GUI of the <font color="#ff0000">Installation Wizard</font> has been
+developed with <span style="font-weight: bold;"><span style="color: rgb(0, 0, 153);">Qt
+3.3.8 </span> </span>toolkit by <span style="color: rgb(0, 0, 153);">
+Trolltech </span>. After launching the Installation Wizard
+in the GUI mode the wizard window is shown to the user. This wizard
+guides the user through several subsequent pages. To navigate between
+the pages use <i>"Next"</i> and <i>"Back"</i>
+buttons in the lower part of the wizard window. <i>"Cancel"</i> button
+closes the wizard window and quits the installation procedure after user
+confirmation. <i>"Help"</i> button opens a window with the help information. </p>
+<p>The first "<span style="font-style: italic;">Introduction"</span>
+page is shown in <a href="#IntroPage">Figure 1</a>.
+Skip this page by pressing <i>"Next"</i> button:
+</p>
+<center><a name="IntroPage"></a><br>
+<img alt="Intro page" src="intropage.png" style="width: 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>
+<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>
+</ol>
+<p></p>
+<p>In case you select "Install sources and make compilation"
+installation type, then you can also check "Remove sources and
+temporary files after compilation" option.
+</p>
+<center><a name="Installation_type_page"></a><br>
+<img alt="Installation type page" src="installtypepage.png" style="width: 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 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;">
+<p><b>Figure 3:</b> "Installation platform" page
+</p>
+</center>
+<p>If "<i>Install sources and make compilation</i>"
+installation type has been selected, the warning message will be
+slightly different: "<i>Your Linux platform is not supported by
+this SALOME package and compilation is not tested on this one</i>".<br>
+There is a list of all platforms supported by SALOME, but only those
+supported by the current package are available for selection. in this
+page you need to to select the reference platform, if you wish to
+proceed with the present installation procedure.<br>
+<b>Note:</b> this page is not displayed if the installation
+platform has been defined automatically.
+</p>
+<p>In the next page you are proposed to enter the target
+installation directory for SALOME platform. You can also press <i>"Browse..."</i>
+button and choose the destination folder using the standard browse
+directory dialog box. <br>
+If the necessary directory does not exist you are
+prompted to confirm the directory creation. If you type a wrong
+directory
+path, or if you do not have the permissions to write to the chosen
+directory, the corresponding message box is shown.<br>
+</p>
+<p><b>Note: you are strongly recommended to avoid using
+directory names containing spaces.</b> Otherwise you can
+experience some troubles with the
+installation.
+</p>
+<center><a name="Directory_page"></a><br>
+<img alt="Directory page" src="directorypage.png" style="width: 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 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;">
+<p><b>Figure 5:</b> Choice of the SALOME modules
+</p>
+</center>
+<p>In the full mode you also have the possibility to select
+prerequisites.<br>
+The checkbox before each product indicates if this one will be
+installed or not (checked or unchecked). The second column shows the
+disk space occupied by the corresponding module. This value depends on
+the selected type of installation.<br>
+To hide the prerequisites list - click "<i>Hide prerequisites</i>"
+button.</p>
+<center><a name="Products_page2"></a><br>
+<img alt="Products page (full mode)" src="productpage2.png" style="width: 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.
+</p>
+<p>The dependencies between SALOME modules are managed in the
+following way:
+</p>
+<ul>
+ <li>If one module is unchecked, all modules which depend on
+this one are also unchecked automatically;</li>
+ <li>If one module is checked, all modules required for this one
+are also checked automatically.</li>
+</ul>
+<p></p>
+<p>Dependency between modules and prerequisites is realized in
+the following way:
+</p>
+<ul>
+ <li>The choices made by the user in the list of modules have a
+direct impact on the list of prerequisites;</li>
+ <li>Whenever a module is checked, all the necessary
+prerequisites are checked automatically with no possibility for the
+user to uncheck them (see <a href="#Products_page3">Fig.7</a>
+below);</li>
+ <li>Whenever a module is unchecked, according to the remaining
+checked modules, the unnecessary prerequisites are unchecked
+automatically (see <a href="#Products_page3">Fig.7</a>
+below).</li>
+</ul>
+It is possible to check again the prerequisites, which have been
+automatically unchecked. In other words, it is possible to add more
+prerequisites than necessary.
+<p></p>
+<center><a name="Products_page3"></a><br>
+<img alt="Products page (dependencies presentation)" src="productpage3.png" style="width: 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. Only modules for that
+'woguimode' attribute is set to "true" value in the XML file
+(see <a href="#xml_files">here</a> for more information about
+customizing this installation mode) support without GUI mode and
+will be checked and installed with their necessary prerequisites in
+case of installation without GUI. And other modules are unchecked with no
+possibility to check them in this mode (see <a href="#Products_page4">figure</a> below).<br>
+By default 'Installation with GUI' checkbox is switched on.
+</p>
+<center><a name="Products_page4"></a><br>
+<img alt="Products page (Installation without GUI)" src="productpage4.png" style="width: 593px; height: 468px;">
+<p><b>Figure 8:</b> Installation without GUI mode
+</p>
+</center>
+<p>The box at the right side of the page displays the information
+about the currently selected product: name, version and short description,
+required disk space, disk space required for the temporary files and
+the list of prerequisites (this information is provided in the XML
+file).
+</p>
+<p>The <i>"Disk space required:"</i> field displays
+how much
+disk space on the hard drive is required for installation of the
+selected
+products.<br>
+<b>Note:</b> please, take into account that the displayed
+amount of
+the required disk space is approximate and may differ when you actually
+install products on your hard drive.
+</p>
+<p>The installation procedure uses a special directory to store
+temporary files. The <i>"Space for temporary files"</i>
+field shows
+the information about the required disk space on the hard drive for
+extracting and compiling the selected products. You can change the
+temporary directory (this information is provided in the XML file) to
+the folder you want.<br>
+<span style="font-weight: bold;">Note:</span>
+actually, the temporary files
+are not stored directly in the directory selected by the user. The
+Installation Wizard creates in this directory an additional folder
+named
+like INSTALLWORK<span style="font-weight: bold;">XXXXX</span>
+where XXXXX is a unique number. This allows launching several
+Installation Wizards simultaneously. This temporary directory is
+removed automatically when the installation finishes.<br>
+</p>
+<p>The installation procedure also checks the available disk
+space. If
+there is not enough disk space on your hard drive you will see the
+corresponding error message box.
+</p>
+<p>Also in the current version of Installation Wizard is possible
+to install all binaries of the selected SALOME modules into a <b>single</b>
+directory. It is "<i>SALOME</i>" directory.
+For this purpose there is a checkbox "<i>Install modules to a
+single directory</i>" checkbox exists (see <a href="#Products_page4">Fig.8</a>).<br>
+This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH
+environment variables.<br>
+<b>Note:</b> the installation into a single directory is
+available with the binaries installation type only.
+</p>
+<p>To proceed further, click <i>"Next"</i> button.
+At this moment
+the program will make some tests to check the installation settings: if
+there is enough disk space on the hard drive, check for the
+dependencies for each product you have selected to be installed. If any
+test fails you will see the corresponding warning message box.
+Otherwise the wizard will proceed to the next page:
+</p>
+<center><a name="ChoicePage"></a><br>
+<img alt="Choice page" src="choicepage.png" style="width: 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
+previous pages. You can review again your choices and change them if
+necessary returning to the previous pages. <br>
+When you are sure that everything is OK, press <i>"Next"</i>
+button to
+follow to the <a href="#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
+</p>
+</center>
+<div style="text-align: left;">To start the installation
+of the selected
+products click <i>"Start"</i>
+button. It launches the shell installation script and you will be able
+to see the output of the script in the topmost frame of the dialog box.
+If any
+errors occur during the installation progress, the corresponding
+messages
+will be printed to the log window in the bold red font.<br>
+</div>
+<div style="text-align: left;">It is possible to break the
+installation at any time by pressing <span style="font-style: italic;">"Stop"</span>
+button. Then you can get back to the previous pages if you wish to
+change the installation settings or restart the installation by
+pressing <span style="font-style: italic;">"Start"</span>
+button again.<br>
+</div>
+<p style="text-align: left;"><span style="font-weight: bold;">Note:</span>
+in the current
+implementation it is not possible to resume the stopped installation
+process; the installation will restart from the very beginning. <br>
+</p>
+<center><a name="ProgressPage2"></a><br>
+<img alt="Progress page (installation started)" src="progresspage2.png" style="width: 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
+means that the installation of this product has not started
+yet. The product currently being installed is marked as "<font color="#ff9900">Processing</font>" and is displayed in
+the status bar under "Installation Status" view. All installed products
+have "<font color="#33ff33">Completed</font>"
+status.
+</p>
+<p>You can abort the installation and close the installation
+procedure
+using <i>"Cancel"</i> button. <br>
+<span style="font-weight: bold;">Note:</span> this
+button sends the
+signal "SIGTERM" to the shell script.
+The script tries to clear all temporary files.
+The process of removing the temporary files can take some time, so the
+installation wizard will wait for 3 seconds before closing.
+</p>
+<p>At the end of the installation "<b>Installation completed</b>"
+message will appear in the status bar. You can return to the previous
+pages to start a new installation or click <i>"Next"</i>
+button to go to the readme page: </p>
+<center><a name="readmepage"></a><br>
+<img alt="Readme page" src="readmepage.png" style="width: 593px; height: 468px;">
+<p><b>Figure 12:</b> "Finish installation" page
+</p>
+</center>
+<p>In this page you can read important information about the
+Installation Wizard itself and some tips: how to run and test SALOME or
+how to build SALOME from the sources. This is also described the
+README file which you can find in the root directory of the
+Installation Wizard. <br>
+You can also launch SALOME Desktop from this
+page or read the Release Notes file by clicking on the corresponding
+buttons in the lower part of the page (see <a href="#xml_files">here</a>
+and <a href="#finish_buttons">here</a> for more
+information about
+customizing these buttons).<br>
+</p>
+<h3 style="margin-left: 40px;"> <a name="batch_mode"></a>Batch mode<br>
+</h3>
+To launch the Installation Wizard in the batch mode use <span
+style="font-weight: bold;">-b</span>
+(<span style="font-weight: bold;">--batch</span>) parameter.<br>
+In this mode the GUI wizard is not shown but all the installation
+status is displayed directly in the console. In the batch mode user do
+not have a possibility to change installation settings which are given
+in the configuration file, except target and temporary directories
+which can be overridden by the corresponding command line options.<br>
+There are two exceptions: <b>--all-from-sources</b>
+(<b>-a</b>) option which enables
+special installation mode in which all the products (including SALOME
+modules) are installed from sources, ignoring default mode defined in
+the XML configuration file (see <a href="#install_from_wizard">here</a>
+for details) and <b>--single-directory</b> (<b>-s</b>) option which defines
+that all SALOME modules have to be installed into the one directory
+(SALOME_<version>, by default, where <version> is SALOME version).
+<center><a name="BatchMode"></a><br>
+<br>
+<img alt="Batch mode" src="batchmode.png"
+style="width: 660px; height: 410px;">
+<p><b>Figure 9:</b> Batch mode</p>
+</center>
+<h3 style="margin-left: 40px;"><a name="env_files"></a>Environment
+files</h3>
+<p>During the process of installation the
+script creates some
+environment files to simplify the procedure of launching SALOME. These
+shell scripts set
+all necessary environment variables for all products you have
+installed.
+To learn how the installation scripts collect the environment, see <a href="#pick_up_env">here</a>. These files are: <b>salome.csh</b>
++ <b>salome.sh</b>
+in the <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL module</span></span><b><i>
+sources</i></b>
+and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL
+module</span></span><b><i> binaries</i></b>
+root directories and <b>env_products.csh</b>
++ <b>env_products.sh </b>and <span style="font-weight: bold;">env_build.csh
+</span>+ <span style="font-weight: bold;">env_build.sh</span>
+in the
+target installation directory.<br>
+</p>
+<span style="font-weight: bold;">Note:</span> there
+is some difference
+between these files: <span style="font-weight: bold;">env_build.*</span>
+files are optimized to
+be used for the building of SALOME modules from sources (see <span style="font-weight: bold;">README </span>file
+provided with the
+installation procedure on the CD). The <span style="font-weight: bold;">env_products.*</span>
+(and<span style="font-weight: bold;"> salome.*</span>)
+files are
+optimized for
+the SALOME launching. The behavior is defined by the environment
+variable<span style="font-weight: bold;"> </span><b>ENV_FOR_LAUNCH</b>
+which is set to <span style="font-weight: bold;">0</span>
+in
+env_build.* files and to <span style="font-weight: bold;">1</span>
+in
+env_products.*
+(salome.*) files.<br>
+<br>
+<hr>
+<h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
+Please, read carefully the following information. This section
+describes how the installation procedure generates the environment
+scripts for the SALOME platform being installed.
+<p>After the installation of each product the shell script
+creates a special
+environment file for the product in its installation folder. The name
+of the file is generated from the name of the product by the following
+scheme: <b>env_<product_name>.sh</b>
+(for example <b>env_Vtk.sh </b>for the Vtk).
+This file includes all necessary environment settings. At the final
+step of the installation the script picks up all settings files and
+generates from them two common environment files: <b>salome.sh</b>
+and <b>salome.csh
+</b>for <span style="font-weight: bold;">bash</span>
+and <span style="font-weight: bold;">csh</span>
+shells correspondingly. This
+approach helps to save time when reinstalling products and you may can
+avoid setting all environment variables
+manually to build/launch SALOME. What you need is to source one of
+these environment files. </p>
+<p>This also concerns the products which are not being installed.
+For example, you install some SALOME binaries to the directory where
+you have previously installed other products. The
+installation
+procedure tries to collect the environment files from the target
+directory if it finds necessary products installed there. If a
+product is not found in the target directory the corresponding
+section of <b>salome.sh/salome.csh</b> files will be
+commented. <br>
+For the native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>
+the installation procedure tries to find them first using <b>PATH</b>
+/ <b>LD_LIBRARY_PATH</b> variables and then in the system
+default
+directories (<b>/usr/bin, /usr/lib</b> etc., depending on
+the product).
+</p>
+<p>In any case you are able to edit <b>salome.*</b>
+files after the installation procedure finished.<br>
+<span style="font-weight: bold;"><br>
+Note:</span> as it has been mentioned <a href="#env_files">above</a>
+there
+are other environment files generated by the installation procedure: <span style="font-weight: bold;">env_products.csh</span> + <span style="font-weight: bold;">env_products.sh</span> and <span style="font-weight: bold;">env_build.csh</span> + <span style="font-weight: bold;">env_build.sh</span>. These
+files can be
+found in the target installation root directory.<br>
+</p>
+<hr>
+<h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font>
+configuration <font color="#ff0000">file</font></h3>
+<font color="#000000">You can create your own XML
+configuration file.
+The Installation Wizard can take it as a command line argument to
+provide a list of products you want to install with it. The list of
+products and some other settings for the Installation Wizard are
+provided in the XML file.<br>
+This section describes the structure of the configuration file.</font>
+<font color="#000000">XML tags are in bold blue, optional
+sections/tags
+are in brackets.</font>
+<font face="Courier">
+<p><b><font color="#000099"><document></font></b>
+<br>
+<font color="#000000"><b>
+</b></font><b><font color="#000099">
+<config</font></b><font color="#000000">
+[ version=<application_version>
+ ]</font> <br>
+<font color="#000000">
+
+ [
+caption=<application_caption>
+ ]</font> <br>
+<font color="#000000">
+
+ [
+copyright=<application_copyright> ]</font>
+<br>
+<font color="#000000">
+
+ [
+license=<application_license_info> ]</font> <br>
+<font color="#000000">
+
+
+platforms=<target_platform></font> <br>
+<font color="#000000">
+
+ [
+targetdir=<target_directory>
+ ] </font>
+<br>
+<font color="#000000">
+
+
+[
+tempdir=<temp_directory>
+ ]</font><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><font color="#000099"><br>
+ <b>/></b>
+</font><font color="#000000"><br>
+ ]</font> <br>
+<font color="#000000">
+[</font><b><font color="#000099">
+<button</font></b><font color="#000000">
+... </font><font color="#000099"><br>
+ <b>/></b></font>
+<br>
+<font color="#000000">
+]</font><br>
+<font color="#000000">
+...</font>
+<font color="#000099"><br>
+ <b></buttons></b>
+</font><font color="#000000"><br>
+ ]</font> <br>
+<font color="#000000"> [</font><b><font color="#000099"> <products></font></b>
+<br>
+<font color="#000000">
+[</font><b><font color="#000099">
+<product</font></b><font color="#000000">
+name=<product_name></font> <br>
+<font color="#000000">
+
+
+type=<product_type></font> <br>
+
+ [
+description=<product_description> ]<br>
+<font color="#000000">
+</font><b><font color="#000099">
+<installation</font></b><font color="#000000">
+os=<installation_platform></font> <br>
+<font color="#000000">
+
+
+
+version=<product_version></font> <br>
+<font color="#000000">
+
+
+ [
+disable=<disable_flag>
+ ]
+<font color="#000000"><br>
+
+
+ [
+woguimode=<without_gui_mode_flag> ]
+<font color="#000000"><br>
+
+
+installdiskspace=<install_disk_space></font><br>
+
+
+ [
+pickupenv=<pickup_env_flag>
+ ]</font>
+<font color="#000000"><br>
+
+
+
+
+script=<installation_script_name></font><br>
+<font color="#000099">
+<b>/></b></font><br>
+<font color="#000000">
+...</font>
+<font color="#000099"><br>
+ <b>/></b></font><font color="#000000">
+<br>
+ ]</font> <font color="#000000"><br>
+ [</font><b><font color="#000099"> <product</font></b><font color="#000000"> ... </font><font color="#000099"><br>
+ <b>/></b></font><font color="#000000"> <br>
+ ]</font><br>
+<font color="#000000">
+...</font><br>
+<font color="#000000"> </font><b><font color="#000099"> </products></font></b>
+<br>
+<font color="#000000"> ]</font><br>
+<font color="#000000"> [</font><b><font color="#000099"> <dependencies></font></b>
+<br>
+<font color="#000000">
+[</font><b><font color="#000099">
+<product</font></b><font color="#000000">
+name=<product_name></font><b><font color="#000099"> ></font></b> <br>
+<font color="#000000">
+[</font><b><font color="#000099">
+<dep></font></b> <font color="#000000"><prerequisite_name></font>
+<b><font color="#000099"> </dep></font></b>
+<font color="#000000">]</font><br>
+<font color="#000000">
+...</font><br>
+<font color="#000000"> </font><b><font color="#000099"> </product></font></b>
+<br>
+<font color="#000000">
+]</font><br>
+<font color="#000000">
+...</font><br>
+<font color="#000000"> </font><b><font color="#000099"> </dependencies></font></b>
+<br>
+<font color="#000000"> ]</font><br>
+<b><font color="#000099">
+</document></font></b> </font></p>
+
+<h4><font color="#000000"><config>
+section</font></h4>
+<font color="#000000">This section provides general
+information about an application that will be installed.<br>
+<br>
+Attributes:<br>
+</font>
+<ul>
+ <li> <font color="#000000"><b>version</b></font></li>
+</ul>
+<font color="#000000">The application version number to be
+shown in the
+caption.</font>
+<ul>
+ <li> <font color="#000000"><b>caption</b></font></li>
+</ul>
+<font color="#000000">The application main window caption
+- if this
+string contains '%1' text the title will contain
+the version number in this place (see above).</font>
+<ul>
+ <li> <font color="#000000"><b>copyright</b></font></li>
+</ul>
+<font color="#000000">The application
+copyright information (shown in the first page).</font>
+<ul>
+ <li> <font color="#000000"><b>license</b></font></li>
+</ul>
+<font color="#000000">The application license information
+(shown in the
+first page).</font>
+<ul>
+ <li> <font color="#000000"><b>platforms</b></font></li>
+</ul>
+<font color="#000000">This parameter defines platforms for
+whose the configurations from this file will be used. Also it provides
+the directory name (relative from ./Products/BINARIES) where the
+Installation Wizard will search for precompiled binaries packages.</font>
+<ul>
+ <li> <font color="#000000"><b>targetdir</b></font></li>
+</ul>
+<font color="#000000">The target
+directory is the path to the directory where the products should be
+installed.</font>
+<ul>
+ <li> <font color="#000000"><b>tempdir</b></font></li>
+</ul>
+<font color="#000000">The temporary directory is
+the path to the directory for the temporary files.</font>
+<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>
+Current section is optional. It describes the product to be installed
+with the Installation
+Wizard. The <products> container should include
+<product> section for each
+product to be installed.<br>
+<font color="#000000"><br>
+Attributes:</font><br>
+<ul>
+ <li> <font color="#000000"><b>name</b></font></li>
+</ul>
+<font color="#000000">The name of the product.</font>
+<ul>
+ <li> <font color="#000000"><b>type</b></font></li>
+</ul>
+<font color="#000000">The type of the product: '<i>component</i>'
+- SALOME module or '<i>prerequisite</i>' - prerequisite
+product.</font>
+<ul>
+ <li> <font color="#000000"><b>description</b></font></li>
+</ul>
+The <font color="#000000">product </font><font color="#000000">description
+(optional).</font>
+<h4> <b><installation> section</b></h4>
+It is a part of the <product> section, that provides
+installation information by platforms. The <product>
+section may contains a several <installation> ones for
+the different platforms.
+<br>
+<font color="#000000"><br>
+Attributes:</font><br>
+<ul>
+ <li> <font color="#000000"><b>os</b></font></li>
+</ul>
+<font color="#000000">A possible installation platform.</font>
+<ul>
+ <li> <font color="#000000"><b>version</b></font></li>
+</ul>
+<font color="#000000">The version of the product.</font>
+<ul>
+ <li> <font color="#000000"><b>disable</b></font></li>
+</ul>
+<font color="#000000">If this optional flag has 'true'
+value, the corresponding product will not appear in the list of
+products and will not be installed.</font>
+<ul>
+ <li> <font color="#000000"><b>woguimode</b></font></li>
+</ul>
+<font color="#000000">This optional flag defines that
+it's possible to install this module without GUI.</font>
+<ul>
+ <li> <font color="#000000"><b>installdiskspace</b></font></li>
+</ul>
+<font color="#000000">List of three total amount spaces
+(integer, in Kbytes, derived by comma), which product occupies on the
+hard drive after the installation in case 'binary', 'sources' and
+'sources and compile' installation type.</font>
+<ul>
+ <li><b>pickupenv</b></li>
+</ul>
+This flag shows that the pickup environment
+procedure should be performed for this product. If this flag equal to
+'true',
+ salome.sh and salome.csh files will be created in
+the product's
+installation directory. Usually this option is set to true for SALOME
+KERNEL module. This is optional key, default value is 'false'<b>.</b><br>
+<ul>
+ <li> <font color="#000000"><b>script</b></font></li>
+</ul>
+<font color="#000000">The installation script name.
+This script is in charge of the installation of the product. It is
+called
+automatically by the Installation Wizard when necessary from the main
+program. See the <a href="#new_products">next
+section</a> for
+more information.</font><br>
+<br>
+<b>Note:</b> If you add new products to be
+installed with Installation Wizard, you should also provide
+installation script for this product. See the next section for more
+details.
+<p><br>
+</p>
+<hr>
+<h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
+scripts</font> for the new products</h3>
+When you want some product to be installed with the Installation
+Wizard, you should add it's description it <a href="#xml_files">in
+the
+configuration file</a> and create the installation script,
+following
+rules described in this section. <br>
+<br>
+There are some obligatory functions which should be implemented in this
+installation
+script. These functions are automatically called by master installation
+script
+or/and its GUI shell when it is necessary.<br>
+<font color="#000000">File <b>common.sh</b>
+contains some service
+functions
+which can be used in your installation script, like <b>make_env()</b>,<b>
+make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b>
+find_in_path()</b>,
+etc.</font>
+<ul>
+ <li> <b>check_version()</b></li>
+</ul>
+This function allows to check the
+version of the product already installed on the computer. It should try
+to find product (native or preinstalled in the target directory) and
+check
+its version. This helps to avoid unnecessary reinstallation. This is
+internal
+function and is not called from the master installation script.<br>
+<ul>
+ <li><font color="#000000"><b>install_binary()</b></font></li>
+</ul>
+<font color="#000000">This function is
+called when <i>'Install binaries'</i> installation mode is
+selected by
+the user. The function is responsible for the extracting of the product
+from the binaries package. It should create environment for the product
+in
+the temporary directory (see also the description of <b>print_env()</b>
+function). It is not necessary to implement this function if you do not
+provide binaries mode
+installation for the current product. <br>
+</font>
+<ul>
+ <li> <font color="#000000"><b>install_source()</b></font></li>
+</ul>
+<font color="#000000">This function is
+called to install SALOME modules sources, if <i>'Install binaries</i>'
+installation mode is selected by the user, and to install prerequisite
+products sources, in <i>'Install sources</i>' case (see <a href="#Installation_type_page">Fig.2</a> above). The
+function is responsible for the building of the product from
+the sources package. It should create the environment file for the
+product
+in the temporary directory (see also the description of <b>print_env()</b>
+function). It is not necessary to implement this function if you do not
+provide a sources mode installation for the current product.</font>
+<br>
+<ul>
+ <li> <font color="#000000"><b>install_source_and_build()</b></font></li>
+</ul>
+<font color="#000000">This function is
+called when <i>'Install sources and make a compilation'</i>
+installation mode is selected. This function should be used to unpack
+SALOME or prerequisite sources package and then call build/install
+procedure for it.<br>
+For more details please refer to <a href="#gui_mode">this</a>
+section for more details.<br>
+</font>
+<ul>
+ <li> <b>try_preinstalled()</b></li>
+</ul>
+<font color="#000000">This function
+is used to parse the target directory to try to find an already
+installed product, to pick up and to check the environment from
+there. See <a href="#pick_up_env">here</a> for more
+details.</font>
+<ul>
+ <li> <font color="#000000"><b>print_env_bin()
+ </b> & <b> print_env_src()</b></font></li>
+</ul>
+<font color="#000000">These functions are in charge of the
+creation of the environment scripts. They should create in the
+temporary directory two files with <b>env_<product_name>.sh</b>
+and <b>env_<product_name>_src.sh</b>
+names and then copy them into the binary and sources product
+installation directories correspondingly. The file should contain all
+necessary
+environment variable settings for the product. It will be collected
+during the 'pick-up-environment' procedure.</font>
+<ul>
+ <li><b>pickup_env()</b></li>
+</ul>
+This procedure corresponds to <b>pickupenv</b> tag
+of the configuration xml file (see the previous section). It should
+call <b>make_env</b>
+procedure to perform the pick-up environment procedure for the product.<br>
+<br>
+<font color="#000000">The calling signature of the product
+installation
+script is the following:</font> <br>
+<b><font color="#000000">
+<product_script_name>
+<function_name>
+<temp_folder>
+<products_directory>
+<target_directory>
+<all_products>
+<product_name>
+<install_products>
+<sources_directory>
+<remove_sources_flag>
+<binaries_directory>
+<single_directory_flag> </font></b>
+<p><font color="#000000">where</font> <br>
+</p>
+<p><font color="#000000"><b><product_script_name></b>
+-
+the name of the installation script (described in the configuration XML
+file);</font> <br>
+<font color="#000000"><b><function_name></b>
+- the name of
+the function, corresponding to the selected installation type and
+currently installed product; </font> <br>
+<font color="#000000"><b>
+<temp_folder> </b> - the directory for the
+temporary files; </font> <br>
+<font color="#000000"><b><products_directory></b>
+- the directory
+where the sources/binaries package can be found. You should provide
+sources package in the <i><Install_Wizard_root_directory>/Products/SOURCES</i>
+directory and binaries package in the <i><InstallWizard_root_directory>/Products/BINARIES/<os_version></i>,
+where <os_version> is the target platform description,
+which appears
+in the corresponding section of the <a href="#xml_files">configuration
+xml
+file</a>.</font> <br>
+<font color="#000000"><b>
+<target_directory> </b> - the root target
+directory where the product should be installed to;</font> <br>
+<font color="#000000"><b>
+<all_products> </b> - single-quoted list
+of all products, separated by space;</font> <br>
+<font color="#000000"><b>
+<product_name> </b>- product name
+itself;</font> <br>
+<font color="#000000"><b>
+<install_products> </b> - single-quoted list
+of all products to be installed, separated by space;</font> <br>
+<font color="#000000"><b>
+<sources_directory> </b> - the directory
+where the sources package can be found (it is usable if the
+<products_directory> parameter gives the binaries
+directory path); </font> <br>
+<font color="#000000"><b>
+<remove_sources_flag> </b> - bool parameter, that
+is equal to 'TRUE' if 'Remove sources and temporary files after
+compilation' option has been selected by the user (see <a href="#Installation_type_page">Fig.2</a> in the <a href="#gui_mode">GUI part</a>);</font> <br>
+<font color="#000000"><b>
+<binaries_directory> </b> - the directory
+where the binaries package can be found (it is usable if the
+<products_directory> parameter gives the sources
+directory path); </font> <br>
+<font color="#000000"><b>
+<single_directory_flag> </b> - bool parameter,
+that is equal to 'TRUE' if 'Install modules to a single directory'
+option is selected by the user (see <a href="#Products_page1">Fig.5</a>
+above). </font> <br>
+</p>
+<p><font color="#000000">Example:</font> <br>
+<i><font color="#000000">med-2.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 layout of the last
+<i>"Finish installation"</i> page. If you want to add one
+or more
+buttons in this page to perform some specific actions at the
+end of the installation (for example, show the 'Release Notes' file by using
+Open Office) you can put an additional section to the XML
+configuration file. This is the <b><button></b>
+section (see <a href="#xml_files">here</a> for more
+details). <br>
+<br>
+To implement the action which will be performed when the user clicks on
+the button, you need to create a script and to put it into the
+<i><Install_Wizard_root_directory>/config_files</i>
+directory.<br>
+There are some obligatory functions which should be implemented in this
+script. These functions are automatically called by the Installation
+Wizard GUI.
+<ul>
+ <li><b>check_enabled()</b></li>
+</ul>
+This procedure is called by the Installation Wizard when the
+<i>"Finish installation"</i> page is displayed and the
+status of the
+buttons should be modified according to the installation options. This
+procedure should return <b>0</b> if the corresponding
+action can be
+performed and, thus, the button should be enabled. Otherwise, it
+should return <b>1</b> - in this case the corresponding
+button will be
+disabled.
+<ul>
+ <li><b>execute()</b></li>
+</ul>
+This procedure is invoked when the user clicks the button. This
+procedure should return <b>0</b> if the corresponding
+action is carried out
+successfully and <b>1</b> if any error occurs.<br>
+<br>
+The calling signature of the script is the following:<br>
+<b><font color="#000000"><product_script_name>
+<function_name> <target_directory>
+<temp_folder></font></b>
+<p><font color="#000000">where</font> <br>
+</p>
+<p><font color="#000000"><b><product_script_name></b>
+-
+the script name itself (retrieved from the XML configuration xml
+file);</font> <br>
+<font color="#000000"><b><function_name></b>
+- the name of the function;</font> <br>
+<font color="#000000"><b><target_directory></b>
+- the root target
+directory where the product is
+installed to;</font> <br>
+<font color="#000000"><b><temp_folder>
+</b> - the directory for the temporary files.</font> <br>
+<br>
+<b>Note:</b> The standard Installation Wizard buttons
+"Launch
+SALOME" and "Release Notes" are implemented with this
+feature. Refer to the scripts <b>start_salome.sh</b> and
+<b>release_notes.sh</b> for the sample implementation.<br>
+<br>
+<b>Note:</b> Any button (even standard) can be ignored by
+the
+Installation Wizard if the attribute <b><disable></b>
+in the XML
+configuration file is set to the "true" value.
+</p>
+<hr><br>
+</font>
+</body>
</html>
\ No newline at end of file
