X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Freadme.html;h=137f24800cebd8501c2b72842f35f4fb857c42f1;hb=57a88d00ae1e926c9854ea7377647e7fd039a103;hp=94b6dfb5dfb521419b6254e58d99700828967300;hpb=f2f6cf21f8b9562fe44f25d1dc85bccb4f7cd9f8;p=tools%2Finstall.git diff --git a/doc/readme.html b/doc/readme.html index 94b6dfb..137f248 100755 --- a/doc/readme.html +++ b/doc/readme.html @@ -1,1226 +1,1239 @@ - - - - - - - - SALOME Installation Wizard Help - - -  -
- - - - - - - - -
-

- 		-
-

SALOME Installation -Wizard Help

-
- 		- -
-
-
updated for the version 5.1.0
-
- -

-

-

Installing products with the Installation Wizard

-The Installation Wizard can be launched in two modes: GUI and batch.
-The root directory of the Installation Wizard -contains Python script runInstall. -To run the Installation Wizard just type runInstall in the -terminal -window: -

[ python ] runInstall [options]
-

-

Without options this script will launch the SALOME Installation -Wizard in the GUI mode.
-The default installation settings can be overridden by using of command -line options. Each option has short and long notations:
-

-

-g / --gui
-

-
Runs the Installation Wizard in the -GUI -mode (this is the default mode).
-
-

-b / --batch
-

-
Runs the Installation Wizard in -the terminal mode.
-
-

-f FILE / --file=FILE
-

-
-This is the XML configuration file used by the Installation Wizard. -If this option is not used, the installation script tries to define -theLinux version and to use the corresponding XML file -if it is present. -For example, for Linux Mandriva -2006  the config_Mandriva_2006.0.xml  -file -will be used by default. -
-

-d DIR / --target=DIR
-

-
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 -${HOME}/salome_<version>).
-
-

-t DIR / --tmp=DIR

-
This is the directory, for -temporary files. If given, this option overrides the default -temporary directory, given in the configuration xml file -(usually /tmp -).
-
-

-a / --all-from-sources

-
-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.
-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 -a option in order to build all the -products from sources.
-Note, that this is long-time operation which can take more than -24 hours depending on the computer.
-
-

-s / --single-directory

-
Install all SALOME binaries packages -to one directory.
-This option is ignored when --all-from-sources (-a) option is used. -
-

-h / --help
-

-
Prints help information on -the usage of the Installation Wizard.
-
-

-

--v / --version
-

-
Prints version information -(Note: this -is the version number of the Installation Wizard, not of SALOME platform).
-
-

-

-

The installation procedure supports different Linux -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 Linux Mandriva 2006.
-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 Linux -platform which is not supported directly by the -Installation Wizard. See Modifying XML -configuration file and Implementing installation -scripts for the new products sections for more information.

-

GUI -mode
-

-

The GUI of the Installation Wizard has been -developed with Qt -3.3.8 toolkit by -Trolltech . 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 "Next" and "Back" -buttons in the lower part of the wizard window. "Cancel" button -closes the wizard window and quits the installation procedure after user -confirmation. "Help" button opens a window with the help information.

-

The first "Introduction" -page is shown in Figure 1. -Skip this page by pressing "Next" button: -

-

-Intro page -

Figure 1: "Introduction" page

-
-

In the second page you are proposed to select the type of the -SALOME installation.
-
-At this step three possible types of installation are available:
-

-
    -
  1. "Install binaries" -type:
    - -
    2. -
  2. "Install sources" -type:
    - -
    3. -
  3. "Install sources and -make compilation" type:
    - -
    4. -
-

-

In case you select "Install sources and make compilation" -installation type, then you can also check "Remove sources and -temporary files after compilation" option. -

-

-Installation type page -

Figure 2: "Type of installation" page -

-
-

After the installation type has been selected you click "Next" -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 ("Install binaries" -and "Install sources" installation types only): -

-

-Platform page -

Figure 3: "Installation platform" page -

-
-

If "Install sources and make compilation" -installation type has been selected, the warning message will be -slightly different: "Your Linux platform is not supported by -this SALOME package and compilation is not tested on this one".
-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.
-Note: this page is not displayed if the installation -platform has been defined automatically. -

-

In the next page you are proposed to enter the target -installation directory for SALOME platform. You can also press "Browse..." -button and choose the destination folder using the standard browse -directory dialog box.
-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.
-

-

Note: you are strongly recommended to avoid using -directory names containing spaces. Otherwise you can -experience some troubles with the -installation. -

-

-Directory page -

Figure 4: "Installation directory" page -

-
-

You can select the products to be installed in the "Choice of -the products to be installed" page.
-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 "Show prerequisites..." -button. -

-

-Products page (default mode) -

Figure 5: Choice of the SALOME modules -

-
-

In the full mode you also have the possibility to select -prerequisites.
-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.
-To hide the prerequisites list - click "Hide prerequisites" -button.

-

-Products page (full mode) -

Figure 6: Choice of the prerequisites -

-
-

-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. -

-

The dependencies between SALOME modules are managed in the -following way: -

- -

-

Dependency between modules and prerequisites is realized in -the following way: -

- -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. -

-

-Products page (dependencies presentation) -

Figure 7: Dependencies between modules and -prerequisites -

-
-

The "Installation with GUI" 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 here 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 figure below).
-By default 'Installation with GUI' checkbox is switched on. -

-

-Products page (Installation without GUI) -

Figure 8: Installation without GUI mode -

-
-

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). -

-

The "Disk space required:" field displays -how much -disk space on the hard drive is required for installation of the -selected -products.
-Note: 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. -

-

The installation procedure uses a special directory to store -temporary files. The "Space for temporary files" -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.
-Note: -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 INSTALLWORKXXXXX -where XXXXX is a unique number. This allows launching several -Installation Wizards simultaneously. This temporary directory is -removed automatically when the installation finishes.
-

-

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. -

-

Also in the current version of Installation Wizard is possible -to install all binaries of the selected SALOME modules into a single -directory. It is "SALOME" directory. -For this purpose there is a checkbox "Install modules to a -single directory" checkbox exists (see Fig.8).
-This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH -environment variables.
-Note: the installation into a single directory is -available with the binaries installation type only. -

-

To proceed further, click "Next" 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: -

-

-Choice page -

Figure 9: "Check your choice" page -

-
-

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.
-When you are sure that everything is OK, press "Next" -button to -follow to the progress page. -

-

-Progress page (not started yet) -

Figure 10: "Installation progress" page: -not started yet -

-
-
To start the installation -of the selected -products click "Start" -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.
-
-
It is possible to break the -installation at any time by pressing "Stop" -button. Then you can get back to the previous pages if you wish to -change the installation settings or restart the installation by -pressing "Start" -button again.
-
-

Note: -in the current -implementation it is not possible to resume the stopped installation -process; the installation will restart from the very beginning.
-

-

-Progress page (installation started) -

Figure 11: "Installation progress" page: -installation in -progress -

-
-

The "Installation Status" frame window -shows you the -progress of installation. "Waiting" -status -means that the installation of this product has not started -yet. The product currently being installed is marked as "Processing" and is displayed in -the status bar under "Installation Status" view. All installed products -have "Completed" -status. -

-

You can abort the installation and close the installation -procedure -using "Cancel" button.
-Note: 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. -

-

At the end of the installation "Installation completed" -message will appear in the status bar. You can return to the previous -pages to start a new installation or click "Next" -button to go to the readme page:

-

-Readme page -

Figure 12: "Finish installation" page -

-
-

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.
-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 here -and here for more -information about -customizing these buttons).
-

-

Batch mode
-

-To launch the Installation Wizard in the batch mode use -b -(--batch) parameter.
-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.
-There are two exceptions: --all-from-sources -(-a) 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 here -for details) and --single-directory (-s) option which defines -that all SALOME modules have to be installed into the one directory -(SALOME_<version>, by default, where <version> is SALOME version). -

-
-Batch mode -

Figure 9: Batch mode

-
-

Environment -files

-

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 here. These files are: salome.csh -+ salome.sh -in the KERNEL module -sources -and KERNEL -module binaries -root directories and env_products.csh -+ env_products.sh and env_build.csh -+ env_build.sh -in the -target installation directory.
-

-Note: there -is some difference -between these files: env_build.* -files are optimized to -be used for the building of SALOME modules from sources (see README file -provided with the -installation procedure on the CD). The env_products.* -(and salome.*) -files are -optimized for -the SALOME launching. The behavior is defined by the environment -variable ENV_FOR_LAUNCH -which is set to 0 -in -env_build.* files and to 1 -in -env_products.* -(salome.*) files.
-
-
-

Pick up the environment

-Please, read carefully the following information. This section -describes how the installation procedure generates the environment -scripts for the SALOME platform being installed. -

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: env_<product_name>.sh -(for example env_Vtk.sh 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: salome.sh -and salome.csh -for bash -and csh -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.

-

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 salome.sh/salome.csh files will be -commented.
-For the native products (like gcc, tcl, etc...) -the installation procedure tries to find them first using PATH -/ LD_LIBRARY_PATH variables and then in the system -default -directories (/usr/bin, /usr/lib etc., depending on -the product). -

-

In any case you are able to edit salome.* -files after the installation procedure finished.
-
-Note: as it has been mentioned above -there -are other environment files generated by the installation procedure: env_products.csh + env_products.sh and env_build.csh + env_build.sh. These -files can be -found in the target installation root directory.
-

-
-

Modifying XML -configuration file

-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.
-This section describes the structure of the configuration file. -XML tags are in bold blue, optional -sections/tags -are in brackets. - -

<document> -
-      - -<config -[ version=<application_version> -     ]
-      -  -      [ -caption=<application_caption> -     ]
-      -  -      [ -copyright=<application_copyright>  ] -
-      -  -      [ -license=<application_license_info> ]
-      -  -        -platforms=<target_platform>
-      -  -      [ -targetdir=<target_directory> -      ] -
-      -  -      -[ -tempdir=<temp_directory>      -     ]
-      /> -
-    -[ <buttons> -
-      -[ <button -  -label=<button_label>      -
-         -       -[ tooltip=<button_tooltip> ]
-         -       -  -script=<button_script>    -
-       -         -[ disable=<disable_flag>   ]
-        /> -
-      ]
-      -[ -<button -...
-        /> -
-      -]
-        -... -
-      </buttons> -
-    ]
-    [ <products> -
-      -[ -<product  -name=<product_name>
-     -  -           -type=<product_type>
-        -        [ -description=<product_description> ]
-          - -<installation  -os=<installation_platform>
-     -     -   -            -version=<product_version>
-      -    -       -      [ -disable=<disable_flag> -           ] -
      -    -       -      [ -woguimode=<without_gui_mode_flag> ] -
-            -             -installdiskspace=<install_disk_space>
-       -           -     [ -pickupenv=<pickup_env_flag> -      ]  -
-           -  -     -       -script=<installation_script_name>
-          -/>
-          -... -
-        /> -
-      ]
-      [ <product ...
-        />
-      ]
-        -...
-      </products> -
-    ]
-    [ <dependencies> -
-      -[ -<product  -name=<product_name> >
-        -[ -<dep> <prerequisite_name> - </dep> -]
-          -...
-        </product> -
-      -]
-        -...
-      </dependencies> -
-    ]
- -</document>

- -

<config> -section

-This section provides general -information about an application that will be installed.
-
-Attributes:
- - -The application version number to be -shown in the -caption. - -The application main window caption -- if this -string contains '%1' text the title will contain -the version number in this place (see above). - -The application -copyright information (shown in the first page). - -The application license information -(shown in the -first page). - -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. - -The target -directory is the path to the directory where the products should be -installed. - -The temporary directory is -the path to the directory for the temporary files. -

<buttons> section

-This is an optional section and may contains one or more -<product> sections. -

<button> section

-This optional section allows customization of the last "Finish -installation" 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 here for more -details about -writing scripts.
-
-Attributes:
- -This is the button text. - -The button tooltip (optional). - -The script attached to the button. - -If this optional flag has 'true' -value, the corresponding button will not appear in the "Finish -installation" page - the section of XML file is ignored.
-

<products> section

-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. -

<product> section

-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.
-
-Attributes:
- -The name of the product. - -The type of the product: 'component' -- SALOME module or 'prerequisite' - prerequisite -product. - -The product description -(optional). -

<installation> section

-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. -
-
-Attributes:
- -A possible installation platform. - -The version of the product. - -If this optional flag has 'true' -value, the corresponding product will not appear in the list of -products and will not be installed. - -This optional flag defines that -it's possible to install this module without GUI. - -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. - -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'.
- -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 next -section for -more information.
-
-Note: 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. -


-

-
-

Implementing installation -scripts for the new products

-When you want some product to be installed with the Installation -Wizard, you should add it's description it in -the -configuration file and create the installation script, -following -rules described in this section.
-
-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.
-File common.sh -contains some service -functions -which can be used in your installation script, like make_env(), -make_dir(), try_existing(), sort_path(), -find_in_path(), -etc. - -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.
- -This function is -called when 'Install binaries' 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 print_env() -function). It is not necessary to implement this function if you do not -provide binaries mode -installation for the current product.
- - -This function is -called to install SALOME modules sources, if 'Install binaries' -installation mode is selected by the user, and to install prerequisite -products sources, in 'Install sources' case (see Fig.2 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 print_env() -function). It is not necessary to implement this function if you do not -provide a sources mode installation for the current product. -
- -This function is -called when 'Install sources and make a compilation' -installation mode is selected. This function should be used to unpack -SALOME or prerequisite sources package and then call build/install -procedure for it.
-For more details please refer to this -section for more details.
- - -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 here for more -details. - -These functions are in charge of the -creation of the environment scripts. They should create in the -temporary directory two files with env_<product_name>.sh -and env_<product_name>_src.sh -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. - -This procedure corresponds to pickupenv tag -of the configuration xml file (see the previous section). It should -call make_env -procedure to perform the pick-up environment procedure for the product.
-
-The calling signature of the product -installation -script is the following:
- -<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> -

where
-

-

<product_script_name> -- -the name of the installation script (described in the configuration XML -file);
-<function_name> -- the name of -the function, corresponding to the selected installation type and -currently installed product;
- -<temp_folder> - the directory for the -temporary files;
-<products_directory> -- the directory -where the sources/binaries package can be found. You should provide -sources package in the <Install_Wizard_root_directory>/Products/SOURCES -directory and binaries package in the <InstallWizard_root_directory>/Products/BINARIES/<os_version>, -where <os_version> is the target platform description, -which appears -in the corresponding section of the configuration -xml -file.
- -<target_directory> - the root target -directory where the product should be installed to;
- -<all_products> - single-quoted list -of all products, separated by space;
- -<product_name> - product name -itself;
- -<install_products> - single-quoted list -of all products to be installed, separated by space;
- -<sources_directory> - the directory -where the sources package can be found (it is usable if the -<products_directory> parameter gives the binaries -directory path);
- -<remove_sources_flag> - bool parameter, that -is equal to 'TRUE' if 'Remove sources and temporary files after -compilation' option has been selected by the user (see Fig.2 in the GUI part);
- -<binaries_directory> - the directory -where the binaries package can be found (it is usable if the -<products_directory> parameter gives the sources -directory path);
- -<single_directory_flag> - bool parameter, -that is equal to 'TRUE' if 'Install modules to a single directory' -option is selected by the user (see Fig.5 -above).
-

-

Example:
-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 -

-

Copy the created script -into -the <Install_Wizard_root_directory>/config_files -sub-directory where all installation scripts are stored. The Installation -Wizard will automatically search and call your script during the -installation -procedure. -

-

-

Customizing Readme -page buttons

-The Installation Wizard allows customizing the layout of the last -"Finish installation" 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 <button> -section (see here for more -details).
-
-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 -<Install_Wizard_root_directory>/config_files -directory.
-There are some obligatory functions which should be implemented in this -script. These functions are automatically called by the Installation -Wizard GUI. - -This procedure is called by the Installation Wizard when the -"Finish installation" page is displayed and the -status of the -buttons should be modified according to the installation options. This -procedure should return 0 if the corresponding -action can be -performed and, thus, the button should be enabled. Otherwise, it -should return 1 - in this case the corresponding -button will be -disabled. - -This procedure is invoked when the user clicks the button. This -procedure should return 0 if the corresponding -action is carried out -successfully and 1 if any error occurs.
-
-The calling signature of the script is the following:
-<product_script_name> -<function_name> <target_directory> -<temp_folder> -

where
-

-

<product_script_name> -- -the script name itself (retrieved from the XML configuration xml -file);
-<function_name> -- the name of the function;
-<target_directory> -- the root target -directory where the product is -installed to;
-<temp_folder> - - the directory for the temporary files.
-
-Note: The standard Installation Wizard buttons -"Launch -SALOME" and "Release Notes" are implemented with this -feature. Refer to the scripts start_salome.sh and -release_notes.sh for the sample implementation.
-
-Note: Any button (even standard) can be ignored by -the -Installation Wizard if the attribute <disable> -in the XML -configuration file is set to the "true" value. -

-

- - \ No newline at end of file + + + + + + + + SALOME Installation Wizard Help + + +  +
+ + + + + + + + +
+

+ 		+
+

SALOME Installation +Wizard Help

+
+ 		+ +
+
+
updated for the version 7.5.1
+
+ +

+

+

Installing products with the Installation Wizard

+The Installation Wizard can be launched in two modes: GUI and batch.
+The root directory of the Installation Wizard +contains Python script runInstall. +To run the Installation Wizard just type ./runInstall in the +terminal +window: +

[ python ] ./runInstall [options]
+

+

Without options this script will launch the SALOME Installation +Wizard in the GUI mode.
+The default installation settings can be overridden by using of command +line options. Each option has short and long notations:
+

+

-g / --gui
+

+
Runs the Installation Wizard in the +GUI +mode (this is the default mode).
+
+

-b / --batch
+

+
Runs the Installation Wizard in +the terminal mode.
+
+

-f FILE / --file=FILE
+

+
+This is the XML configuration file used by the Installation Wizard. +If this option is not used, the installation script tries to define +theLinux version and to use the corresponding XML file +if it is present. +For example, for Linux Mandriva +2010  the config_Mandriva_2010.0.xml  +file +will be used by default. +
+

-d DIR / --target=DIR
+

+
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 +${HOME}/salome_<version>).
+
+

-t DIR / --tmp=DIR

+
This is the directory, for +temporary files. If given, this option overrides the default +temporary directory, given in the configuration xml file +(usually /tmp +).
+
+

-a / --all-from-sources

+
+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.
+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 -a option in order to build all the +products from sources.
+Note, that this is long-time operation which can take more than +24 hours depending on the computer.
+
+

-s / --single-directory

+
Install all SALOME binaries packages +to one directory.
+This option is ignored when --all-from-sources (-a) option is used. +
+

-h / --help
+

+
Prints help information on +the usage of the Installation Wizard.
+
+

+

+-v / --version
+

+
Prints version information +(Note: this +is the version number of the Installation Wizard, not of SALOME platform).
+
+

+

+

The installation procedure supports different Linux +platforms and installs various 3d-party installation prerequisite products, which +are required by SALOME platform. Among supported Linux platforms there are Mandriva 2008 +(32bit and 64bit), Mandriva 2010 (32bit and 64bit), Debian 4.0 Etch (32bit and 64bit), +Debian 5.0 Lenny 64bit, Debian 6.0 Squeeze 64bit and other ones.
+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 Linux +platform which is not supported directly by the +Installation Wizard. See Modifying XML +configuration file and Implementing installation +scripts for the new products sections for more information.

+

GUI +mode
+

+

The GUI of the Installation Wizard has been +developed with Qt +3.3.8 toolkit by +Trolltech . 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 "Next" and "Back" +buttons in the lower part of the wizard window. "Cancel" button +closes the wizard window and quits the installation procedure after user +confirmation. "Help" button opens a window with the help information.

+

The first "Introduction" +page is shown in Figure 1. +Skip this page by pressing "Next" button: +

+

+Intro page +

Figure 1: "Introduction" page

+
+

In the second page you are proposed to select the type of the +SALOME installation.
+
+At this step three possible types of installation are available:
+

+
    +
  1. "Install binaries" +type:
    + +
    2. +
  2. "Install sources" +type:
    + +
    3. +
  3. "Install sources and +make compilation" type:
    + +
    4. +
+

+

In case you select "Install sources and make compilation" +installation type, then you can also check "Remove sources and +temporary files after compilation" option. +

+

+Installation type page +

Figure 2: "Type of installation" page +

+
+

After the installation type has been selected you click "Next" +button and the Installation Wizard tries to determine the Linux +platform to load the corresponding configuration file. If the operating +system is not defined or the current SALOME package does not support +this system, the warning message will appear ("Install binaries" +and "Install sources" installation types only): +

+

+Platform page +

Figure 3: "Installation platform" page +

+
+

If "Install sources and make compilation" +installation type has been selected, the warning message will be +slightly different: "Your Linux platform is not supported by +this SALOME package and compilation is not tested on this one".
+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.
+Note: this page is not displayed if the installation +platform has been defined automatically. +

+

In the next page you are proposed to enter the target +installation directory for SALOME platform. You can also press "Browse..." +button and choose the destination folder using the standard browse +directory dialog box.
+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.
+

+

Note: you are strongly recommended to avoid using +directory names containing spaces. Otherwise you can +experience some troubles with the +installation. +

+

+Directory page +

Figure 4: "Installation directory" page +

+
+

You can select the products to be installed in the "Choice of +the products to be installed" page.
+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 "Show prerequisites..." +button. +

+

+Products page (default mode) +

Figure 5: Choice of the SALOME modules +

+
+

In the full mode you also have the possibility to select +prerequisites.
+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.
+To hide the prerequisites list - click "Hide prerequisites" +button.

+

+Products page (full mode) +

Figure 6: Choice of the prerequisites +

+
+

+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. +

+

The dependencies between SALOME modules are managed in the +following way: +

+ +

+

Dependency between modules and prerequisites is realized in +the following way: +

+ +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. +

+

+Products page (dependencies presentation) +

Figure 7: Dependencies between modules and +prerequisites +

+
+

The "Installation with GUI" 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 here 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 figure below).
+By default 'Installation with GUI' checkbox is switched on. +

+

+Products page (Installation without GUI) +

Figure 8: Installation without GUI mode +

+
+

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). +

+

The "Disk space required:" field displays +how much +disk space on the hard drive is required for installation of the +selected +products.
+Note: 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. +

+

The installation procedure uses a special directory to store +temporary files. The "Space for temporary files" +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.
+Note: +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 INSTALLWORKXXXXX +where XXXXX is a unique number. This allows launching several +Installation Wizards simultaneously. This temporary directory is +removed automatically when the installation finishes.
+

+

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. +

+

Also in the current version of Installation Wizard is possible +to install all binaries of the selected SALOME modules into a single +directory. It is "SALOME" directory. +For this purpose there is a checkbox "Install modules to a +single directory" checkbox exists (see Fig.8).
+This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH +environment variables.
+Note: the installation into a single directory is +available with the binaries installation type only. +

+

To proceed further, click "Next" 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: +

+

+Choice page +

Figure 9: "Check your choice" page +

+
+

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.
+When you are sure that everything is OK, press "Next" +button to +follow to the progress page. +

+

+Progress page (not started yet) +

Figure 10: "Installation progress" page: +not started yet +

+
+
To start the installation +of the selected products click "Start" +button. It launches the shell installation script and you will be able +to see the output of the script in the topmost frame of the dialog box. +If any errors occur during the installation progress, the corresponding +messages will be printed to the log window in the bold red font and +installation process will be aborted with error message box. But user +has possibility to change this default behaviour by +"Ignore errors" checkbox. It is necessary to check +it before start and all occured errors will be passed, +and installation will be continued in any case.
+
+
It is possible to break the +installation at any time by pressing "Stop" +button. Then you can get back to the previous pages if you wish to +change the installation settings or restart the installation by +pressing "Start" +button again.
+
+

Note: +in the current +implementation it is not possible to resume the stopped installation +process; the installation will restart from the very beginning.
+

+

+Progress page (installation started) +

Figure 11: "Installation progress" page: +installation in +progress +

+
+

The "Installation Status" frame window +shows you the +progress of installation. "Waiting" +status +means that the installation of this product has not started +yet. The product currently being installed is marked as "Processing" and is displayed in +the status bar under "Installation Status" view. All installed products +have "Completed" +status. +

+

You can abort the installation and close the installation +procedure +using "Cancel" button.
+Note: 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. +

+

At the end of the installation "Installation completed" +message will appear in the status bar. You can return to the previous +pages to start a new installation or click "Next" +button to go to the readme page:

+

+Readme page +

Figure 12: "Finish installation" page +

+
+

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.
+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 here +and here for more +information about +customizing these buttons).
+

+

Batch mode
+

+To launch the Installation Wizard in the batch mode use -b +(--batch) parameter.
+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.
+There are two exceptions: --all-from-sources +(-a) 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 here +for details) and --single-directory (-s) option which defines +that all SALOME modules have to be installed into the one directory +(SALOME_<version>, by default, where <version> is SALOME version). +

+
+Batch mode +

Figure 9: Batch mode

+
+

Environment +files

+

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 here. These files are: salome.csh ++ salome.sh +in the KERNEL module +sources +and KERNEL +module binaries +root directories and env_products.csh ++ env_products.sh and env_build.csh ++ env_build.sh +in the +target installation directory.
+

+Note: there +is some difference +between these files: env_build.* +files are optimized to +be used for the building of SALOME modules from sources (see README file +provided with the +installation procedure on the CD). The env_products.* +(and salome.*) +files are +optimized for +the SALOME launching. The behavior is defined by the environment +variable ENV_FOR_LAUNCH +which is set to 0 +in +env_build.* files and to 1 +in +env_products.* +(salome.*) files.
+
+
+

Pick up the environment

+Please, read carefully the following information. This section +describes how the installation procedure generates the environment +scripts for the SALOME platform being installed. +

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: env_<product_name>.sh +(for example env_Vtk.sh 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: salome.sh +and salome.csh +for bash +and csh +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.

+

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 salome.sh/salome.csh files will be +commented.
+For the native products (like gcc, tcl, etc...) +the installation procedure tries to find them first using PATH +/ LD_LIBRARY_PATH variables and then in the system +default +directories (/usr/bin, /usr/lib etc., depending on +the product). +

+

In any case you are able to edit salome.* +files after the installation procedure finished.
+
+Note: as it has been mentioned above +there +are other environment files generated by the installation procedure: env_products.csh + env_products.sh and env_build.csh + env_build.sh. These +files can be +found in the target installation root directory.
+

+
+

Modifying XML +configuration file

+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.
+This section describes the structure of the configuration file. +XML tags are in bold blue, optional +sections/tags +are in brackets. + +

<document> +
+      + +<config +[ version=<application_version> +     ]
+      +  +      [ +caption=<application_caption> +     ]
+      +  +      [ +copyright=<application_copyright>  ] +
+      +  +      [ +license=<application_license_info> ]
+      +  +        +platforms=<target_platform>
+      +  +      [ +targetdir=<target_directory> +      ] +
+      +  +      +[ +tempdir=<temp_directory>      +     ] +
      +        [ +optionallibs=<optional_libraries>  ] +
+      /> +
+    +[ <buttons> +
+      +[ <button +  +label=<button_label>      +
+         +       +[ tooltip=<button_tooltip> ]
+         +       +  +script=<button_script>    +
+       +         +[ disable=<disable_flag>   ]
+        /> +
+      ]
+      +[ +<button +...
+        /> +
+      +]
+        +... +
+      </buttons> +
+    ]
+    [ <products> +
+      +[ +<product  +name=<product_name>
+     +  +           +type=<product_type>
+        +        [ +description=<product_description> ]
+          + +<installation  +os=<installation_platform>
+     +     +   +            +version=<product_version>
+      +    +       +      [ +disable=<disable_flag> +           ] +
      +    +       +      [ +woguimode=<without_gui_mode_flag> ] +
+            +             +installdiskspace=<install_disk_space>
+       +           +     [ +pickupenv=<pickup_env_flag> +      ]  +
+           +  +     +       +script=<installation_script_name>
+          +/>
+          +... +
+        /> +
+      ]
+      [ <product ...
+        />
+      ]
+        +...
+      </products> +
+    ]
+    [ <dependencies> +
+      +[ +<product  +name=<product_name> >
+        +[ +<dep> <prerequisite_name> + </dep> +]
+          +...
+        </product> +
+      +]
+        +...
+      </dependencies> +
+    ]
+ +</document>

+ +

<config> +section

+This section provides general +information about an application that will be installed.
+
+Attributes:
+ + +The application version number to be +shown in the +caption. + +The application main window caption +- if this +string contains '%1' text the title will contain +the version number in this place (see above). + +The application +copyright information (shown in the first page). + +The application license information +(shown in the +first page). + +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. + +The target +directory is the path to the directory where the products should be +installed. + +The temporary directory is +the path to the directory for the temporary files. + +A list of names of libraries. +An absence of these libraries in the user's system +doesn't affect on the correct work of SALOME platform. +

<buttons> section

+This is an optional section and may contains one or more +<product> sections. +

<button> section

+This optional section allows customization of the last "Finish +installation" 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 here for more +details about +writing scripts.
+
+Attributes:
+ +This is the button text. + +The button tooltip (optional). + +The script attached to the button. + +If this optional flag has 'true' +value, the corresponding button will not appear in the "Finish +installation" page - the section of XML file is ignored.
+

<products> section

+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. +

<product> section

+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.
+
+Attributes:
+ +The name of the product. + +The type of the product: 'component' +- SALOME module or 'prerequisite' - prerequisite +product. + +The product description +(optional). +

<installation> section

+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. +
+
+Attributes:
+ +A possible installation platform. + +The version of the product. + +If this optional flag has 'true' +value, the corresponding product will not appear in the list of +products and will not be installed. + +This optional flag defines that +it's possible to install this module without GUI. + +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. + +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'.
+ +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 next +section for +more information.
+
+Note: 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. +


+

+
+

Implementing installation +scripts for the new products

+When you want some product to be installed with the Installation +Wizard, you should add it's description it in +the +configuration file and create the installation script, +following +rules described in this section.
+
+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.
+File common.sh +contains some service +functions +which can be used in your installation script, like make_env(), +make_dir(), try_existing(), sort_path(), +find_in_path(), +etc. + +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.
+ +This function is +called when 'Install binaries' 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 print_env() +function). It is not necessary to implement this function if you do not +provide binaries mode +installation for the current product.
+ + +This function is +called to install SALOME modules sources, if 'Install binaries' +installation mode is selected by the user, and to install prerequisite +products sources, in 'Install sources' case (see Fig.2 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 print_env() +function). It is not necessary to implement this function if you do not +provide a sources mode installation for the current product. +
+ +This function is +called when 'Install sources and make a compilation' +installation mode is selected. This function should be used to unpack +SALOME or prerequisite sources package and then call build/install +procedure for it.
+For more details please refer to this +section for more details.
+ + +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 here for more +details. + +These functions are in charge of the +creation of the environment scripts. They should create in the +temporary directory two files with env_<product_name>.sh +and env_<product_name>_src.sh +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. + +This procedure corresponds to pickupenv tag +of the configuration xml file (see the previous section). It should +call make_env +procedure to perform the pick-up environment procedure for the product.
+
+The calling signature of the product +installation +script is the following:
+ +<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> +

where
+

+

<product_script_name> +- +the name of the installation script (described in the configuration XML +file);
+<function_name> +- the name of +the function, corresponding to the selected installation type and +currently installed product;
+ +<temp_folder> - the directory for the +temporary files;
+<products_directory> +- the directory +where the sources/binaries package can be found. You should provide +sources package in the <Install_Wizard_root_directory>/Products/SOURCES +directory and binaries package in the <InstallWizard_root_directory>/Products/BINARIES/<os_version>, +where <os_version> is the target platform description, +which appears +in the corresponding section of the configuration +xml +file.
+ +<target_directory> - the root target +directory where the product should be installed to;
+ +<all_products> - single-quoted list +of all products, separated by space;
+ +<product_name> - product name +itself;
+ +<install_products> - single-quoted list +of all products to be installed, separated by space;
+ +<sources_directory> - the directory +where the sources package can be found (it is usable if the +<products_directory> parameter gives the binaries +directory path);
+ +<remove_sources_flag> - bool parameter, that +is equal to 'TRUE' if 'Remove sources and temporary files after +compilation' option has been selected by the user (see Fig.2 in the GUI part);
+ +<binaries_directory> - the directory +where the binaries package can be found (it is usable if the +<products_directory> parameter gives the sources +directory path);
+ +<single_directory_flag> - bool parameter, +that is equal to 'TRUE' if 'Install modules to a single directory' +option is selected by the user (see Fig.5 +above).
+

+

Example:
+med.sh install_binary +/tmp/INSTALLWORK21797 +./Products/BINARIES/Mandriva2010.0 +'gcc tcltk tcltk_src Python Python_src Qt Qt_src ... DOCUMENTATION +DOCUMENTATION_src' +Med +'gcc Hdf Med' +./Products/SOURCES +FALSE +./Products/BINARIES/Mandriva2010.0 +

+

Copy the created script +into +the <Install_Wizard_root_directory>/config_files +sub-directory where all installation scripts are stored. The Installation +Wizard will automatically search and call your script during the +installation +procedure. +

+

+

Customizing Readme +page buttons

+The Installation Wizard allows customizing the layout of the last +"Finish installation" 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 <button> +section (see here for more +details).
+
+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 +<Install_Wizard_root_directory>/config_files +directory.
+There are some obligatory functions which should be implemented in this +script. These functions are automatically called by the Installation +Wizard GUI. + +This procedure is called by the Installation Wizard when the +"Finish installation" page is displayed and the +status of the +buttons should be modified according to the installation options. This +procedure should return 0 if the corresponding +action can be +performed and, thus, the button should be enabled. Otherwise, it +should return 1 - in this case the corresponding +button will be +disabled. + +This procedure is invoked when the user clicks the button. This +procedure should return 0 if the corresponding +action is carried out +successfully and 1 if any error occurs.
+
+The calling signature of the script is the following:
+<product_script_name> +<function_name> <target_directory> +<temp_folder> +

where
+

+

<product_script_name> +- +the script name itself (retrieved from the XML configuration xml +file);
+<function_name> +- the name of the function;
+<target_directory> +- the root target +directory where the product is +installed to;
+<temp_folder> + - the directory for the temporary files.
+
+Note: The standard Installation Wizard buttons +"Launch +SALOME" and "Release Notes" are implemented with this +feature. Refer to the scripts start_salome.sh and +release_notes.sh for the sample implementation.
+
+Note: Any button (even standard) can be ignored by +the +Installation Wizard if the attribute <disable> +in the XML +configuration file is set to the "true" value. +

+

+ +