1 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
5 <meta http-equiv="Content-Type"
6 content="text/html; charset=iso-8859-1">
9 content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">
12 content="Vadim SANDLER (v-sandler@opencascade.com)">
13 <title>SALOME v2.2.x Installation Wizard Help</title>
15 <body style="color: rgb(0,0,0); background-color: rgb(255,255,229);"
16 link="#0000ee" vlink="#551a8b" alink="#ff0000">
19 <table width="100%" nosave="">
23 <h1><a href="http://www.opencascade.com"><img src="logocorp.png"
24 border="0" height="47" width="139">
29 <h1><font size="+4"><font color="#000099">SALOME Installation Wizard
30 Help</font> </font></h1>
34 <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
35 src="application.png" border="0" height="47" width="109">
44 <div align="right"><b><font color="#000099">updated for the version 2.2.6</font></b></div>
48 <li> <a href="#install_from_wizard">Installing products with the Installation
50 <li> <a href="#check_version_proc">Notes on check products version procedure</a></li>
51 <li> <a href="#pick_up_env">Pick up the environment</a></li>
52 <li> <a href="#xml_files">Modifying XML configuration file</a></li>
53 <li> <a href="#new_products">Implementing installation scripts for the
61 <h3> <a name="install_from_wizard"></a>Installing products with the <font
62 color="#ff0000">Installation Wizard</font></h3>
63 You can run the Installation Wizard in two modes. It's root directory contains
64 python script runInstall.py:
65 <p><b>[ python ] runInstall [ -g | b ] [ -f <xml-file> ] [ -t <target-dir>
66 ] [ -tmp <tmp-dir> ]</b> </p>
69 Runs the Installation Wizard in the GUI
70 mode. In this case only <xml-file> key is taken into account. This
71 option is used by default. <br>
73 Runs the Installation Wizard in the batch
75 <b>-f <xml-file></b><br>
76 The configuration file to be used by the
77 Installation Wizard. If this parameter is missed then the script tries
78 to define the <i>Red Hat </i>version and uses corresponding xml file. For
79 examle, for the <i>Red Hat 8.0</i> <b>config_RedHat_8.0.xml</b> file
80 is supposed to be used by default. If the appropriate file is not found, <b>config.xml</b>
81 is used by default. <br>
82 <b>-t <target-dir></b><br>
83 The target directory, SALOME products to
84 be installed to. If used, overloads target directory, given in the configuration
86 <b>-tmp <tmp-dir></b><br>
87 The directory, which is used to contain
88 temporary files. If used, overloads temporary directory, given in the
89 configuration xml file.<br>
91 Prints help information. <br>
94 <p>So, to run the Installation Wizard in the GUI mode, just type <b>runInstall</b>.
97 <p>The installation procedure can support some different Linux platforms
98 and various number of products. Currently the basic target platform is <i>Linux RedHat 8.0</i>.
99 From SALOME version 2.2.4 Installation Wizard also supports <i>Linux Mandrake 10.1</i>.<br>
100 The using of configuration xml files gives flexible way to modify the list
101 of products to be installed by the Installation Wizard without changing program's
102 source code. Just create your own configuration file and implement installation
103 scripts for products you want to be provided by Wizard. See <a
104 href="#xml_files">modifying XML configuration file</a> and <a
105 href="#new_products">implementing installation scripts for the new products</a>
106 for more information. </p>
108 <p>The <font color="#ff0000">Installation Wizard</font> was built with using
109 of the <b><i>Qt </i></b>library. The program contains several pages.
110 To navigate between pages use <i>"Next"</i> and <i>"Back"</i> buttons in the
111 lower part of the wizard window. <i>"Cancel"</i> button closes dialog window
112 and quits the installation procedure. To invoke this help information click
113 <i>"Help"</i> button. </p>
115 <p>Skip the first <i>"Introduction"</i> page by pressing <i>"Next"</i> button.
118 <p>In the second page you are proposed to enter the target directory where
119 all selected products will be installed to. You can also press <i>"Browse..."</i>
120 button and choose the folder for installation using standard <b><i>Qt</i></b>
121 browse directory dialog box. <br>
122 If the directory you want to install products does not exist you will be
123 prompted to confirm directory creation. If you type wrong directory path,
124 or if you have no permission for the directory you use, the corresponding
125 message box will raise. </p>
127 <p>The Installation Wizard has two modes of the installation: basic and advanced.
128 In the basic mode it is necessary just to enter target directory. If you want
129 to use advanced mode, click <i>"More..."</i> button. </p>
131 <p>In the advanced mode you have the possibility to select products to be
132 installed (see <a href="#ProductPage">Fig.1</a> ). Each product can have several
133 options of installation: you have a possibility to use native products, install
134 already precompiled binaries, build product from the sources or not install it
135 at all. Possible options and default choice are provided by the configuration
136 file. You can mark the products, you want to install, by clicking the corresponding
137 radiobuttons in the list view in the left part of the page. Note that some
138 products can be installed only together with other products (or these prerequisite
139 products should be already installed on your computer). The installation procedure
140 has a special feature to automatically mark these products in the list view.
141 For example, in order to install <b><i>pyqt</i></b> it's necessary to have
142 <b><i>gcc, python</i></b>,<b><i> qt</i></b> and <b><i>sip</i></b> installed.
143 Therefore all these products will be marked when you check on <b><i>pyqt</i></b>.
144 This feature can be switched off by clicking <i>"Auto set prerequisites products"</i>
146 Special button in the right part of the page - <i>"Unselect All" </i>-
147 allows to reset quickly all products to the <i>"not install"</i> state. <br>
148 If you want to use native products (for example, for Linux Red Hat 8.0 these are gcc, tcl,
149 Python, Qt, Sip and PyQt), select <i>"use native" </i>option. </p>
151 <p>There are also two checkboxes on this page: <i>"SALOME sources"</i> and <i>"SALOME binaries"</i>.
152 These three-state checkboxes allow quick selecting/unselecting SALOME packages
153 for the installation.</p>
155 <p>The box at the right side of the page displays the information about currently
156 highlighted product: name, version, short description (if provided), required
157 disk space, temporary files disk space, list of prerequisites and user choice.
160 <center><a name="ProductPage"></a><br>
161 <img src="productpage.png" height="544" width="567" alt="">
163 <p><b>Figure 1:</b> "Installation settings" page in the advanced mode</p>
166 <p>The <i>"Total disk space required:"</i> field displays how much disk space
167 on the hard drive is required for installation of selected products. <br>
168 <b>Note: </b>Please, take into account that displayed amount of required
169 disk space is approximate and may differ when you install products on your
172 <p>The installation procedure uses a special directory to store temporary files.
173 The <i>"Space for temporary files:"</i> field shows the information about
174 required disk space on the hard drive for extracting and compiling of the
175 selected products. You can change the default directory - just type path
176 to the folder you want to use or click on the corresponding <i>"Browse..."</i>
179 <p>The installation procedure also checks available disk space on the selected
180 directories according to the products selected. If there is no enough disk
181 space on your hard drive you will see the corresponding error message box.
184 <p><b>Note: </b>Unfortunately, the configure procedure has a very annoying
185 bug under Linux platform. The directory should be obligatory entered without
186 spaces. For example, the configure procedure for <b><i>gcc</i></b> won't
187 work if you pass the following parameter: <i>--prefix="/New Folder 1"</i>.
188 <b>Therefore you are strongly recommended not to use directory names containing
191 <p>To proceed further click <i>"Next"</i> button. At this moment program
192 will make some tests to check installation settings: if there is enough disk
193 space on the hard drive, if native products are preinstalled, dependencies
194 (prerequisites) for each product you have selected to be installed.
195 If any test fails you will see corresponding warning message box. Otherwise
196 wizard will follow to the next page: </p>
199 <p><a name="ChoicePage"></a><br>
200 <img src="choicepage.png" height="544" width="567" alt="">
203 <p><b>Figure 2:</b> "Check your choice" page</p>
206 <p>This page summarizes the installation settings you've made on the previous
207 pages. You can check again your choice to change it if necessary. <br>
208 When you are sure that everything is OK, press <i>"Next"</i> button to
209 follow to the <a href="#ProgressPage">next page</a>. </p>
211 <center><a name="ProgressPage"></a><br>
212 <img src="progresspage.png" height="544" width="567" alt="">
214 <p><b>Figure 3:</b> "Installation progress" page</p>
217 <p>To start installation of the selected products click <i>"Start"</i> button.
218 It launches the shell installation script and you will be able to see the
219 output of the script in the topmost dialog's frame. If any errors
220 occur during the installation the progress the corresponding messages
221 will be printed to the log grame window in the bold red font.
223 <p>The <i>"Installation Status"</i> frame window shows you the progress of
224 installation. It contains a list of all selected products with brief descriptions.
225 "<font color="#ff0000">Waiting</font>" description means that installation
226 of this product have not started yet. Currently installing product is marked
227 as "<font color="#ff9900">Processing</font>". All installed products have
228 "<font color="#33ff33">Completed</font>" description. </p>
230 <p>You can abort installation and close the installation procedure using
231 <i>"Cancel"</i> button. It sends the signal "SIGTERM" to the shell script.
232 The script has a signal handler and will try to clear all temporary files.
233 The process of removing temporary files can take some time, so the installation
234 wizard will wait 3 seconds before closing. </p>
236 <p>At the end of installation (all selected products have been installed
237 successfully) you can go back to the previous pages to start a new installation
238 or click <i>"Next"</i> button to go the Readme page: </p>
241 <p><a name="readmepage"></a><br>
242 <img src="readmepage.png" height="544" width="567" alt="">
245 <p><b>Figure 4:</b> "Finish installation" page</p>
248 <p>In this page you can read important information about the Instalation
249 Wizard itself and some hints: how to run and test SALOME or how to build
250 SALOME from the sources. This is the contents of the README file which you
251 can find in the root directory of the Installation Wizard. <br>
252 You can also launch SALOME Desktop from this page by clicking <i>"Launch
253 SALOME" </i>button. </p>
255 <p>During the process of installation the script creates some environment
256 files to simplify procedure of launching SALOME. These shell scripts set
257 all necessary environment variables for all products you have installed.
258 To learn how installation scripts collects the environment, see <a
259 href="#pick_up_env"> here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b>
260 in the <span style="font-style: italic;"><span
261 style="font-weight: bold;">KERNEL module</span></span><b><i> sources</i></b>
262 and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL module</span></span><b><i>
263 binaries</i></b> root directories and <b>env_products.csh</b> + <b>env_products.sh
264 </b>in the target directory. </p>
267 <h3><a name="check_version_proc"></a>Notes on<font color="#ff0000"> check
268 products version</font> procedure</h3>
269 Unfortunately under Linux platform there is no exact algorithm to identify
270 the product's version. The table below contains the information relating
271 to checking preinstalled products for the Linux RedHat 8.0 platform. <br>
273 <table border="1" width="100%" nosave="">
277 <center><font size="+1">Product</font></center>
280 <center><font size="+1">Algorithm of checking</font></center>
283 <center><font size="+1">Preliminary steps before launching</font>
285 <font size="+1">of installation procedure</font></center>
288 <center><font size="+1">Notes</font></center>
293 <td>ver=`gcc -dumpversion`</td>
297 <td>ver should be 3.2.<br>
298 It is recommended to use native gcc on Linux RedHat 8.0</td>
302 <td nosave="">existence of TCLHOME <br>
303 existence of tclsh8.3 <br>
304 existence of wish8.3 <br>
305 existence of libtcl8.3.so <br>
306 existence of libtk8.3.so <br>
307 existence of libtclx8.3.so <br>
308 existence of libtkx8.3.so</td>
309 <td>set TCLHOME if you have preinstalled version of tcl. <br>
310 set LD_LIBRARY_PATH on a directory where libs can be found.</td>
311 <td>It is recommended to use native tcl/tk on Linux RedHat 8.0</td>
314 <td valign="top">boost 1.30.2<br>
316 <td valign="top">ver=`egrep 'BOOST_VERSION [0-9]+' ${BOOSTDIR}/boost/version.hpp
317 | sed 's/.*BOOST_VERSION \([0-9]\+\)/\1/g'`<br>
319 <td valign="top">set BOOSTDIR if you have preinstalled version of
322 <td valign="top">It is impossible to use native BOOST and to install
323 BOOST from binaries.<br>
327 <td>Open CASCADE 5.2<br>
329 <td>existence of CASROOT environment variable<br>ver_major=`grep "!define OCC_VERSION_MAJOR" ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
330 ver_minor=`grep "!define OCC_VERSION_MINOR" ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
331 ver="$ver_major.$ver_minor"<br>
333 <td>set CASROOT if you have preinstalled version of Open CASCADE</td>
334 <td>CASCADE's Standard_Version.hxx file provides version information.</td>
337 <td>Patch for Open CASCADE 5.2<br>
341 <td>Open CASCADE 5.2 provided with the Installation Wizard already includes the patch,
342 necessary for SALOME 2.2.x. In addition the Installation Wizard provides the sources of a Open CASCADE patch
343 which can be applied to original Open CASCADE 5.2 sources before its compilation.</td>
346 <td>Python 2.2.1</td>
347 <td>existence of PYTHONHOME <br>
348 isPython=`which python` <br>
350 <td>set PYTHONHOME to root Python folder <br>
351 set PATH on a directory where python can be found</td>
352 <td>Python should exist and ver should be equal to 2.2.1 <br>
353 It is recommended to use native Python on Linux RedHat 8.0</td>
357 <td>existence of libGL.so.1.2.030402</td>
358 <td>set LD_LIBRARY_PATH on a directory where libGL.so.1.2.030402
360 <td>You have a possibility to build products (vtk & qt) with
361 Mesa drivers from the package supplied with this installation procedure or
362 to use OpenGL drivers installed on your computer locally. This check procedure
363 concerns only supplied Mesa driver.</td>
367 <td>isSwig=`which swig` <br>
368 ver=`swig -version` <br>
369 ver=`echo $ver | awk '{print $3}'`</td>
370 <td>set PATH on a directory where swig can be found</td>
371 <td>Swig should exist and ver should be equal to 1.3.17</td>
375 <td>existence of QTDIR <br>
376 ver=`grep "QT_VERSION_STR" ${QTDIR}/include/qglobal.h | sed -e 's%^#define QT_VERSION_STR\([[:space:]]*\)%%g' -e 's%\"%%g'`</td>
377 <td>set QTDIR if you have preinstalled version of qt</td>
378 <td>Qt's qglobal.h file provides version information: ver should be 3.0.5.<br>
379 You should set MESA_HOME only if you have preinstalled version of Mesa
381 It is recommended to use native Qt on Linux RedHat 8.0</td>
385 <td>existence of QWTHOME <br>
386 existence of libqwt.so.0.4.1</td>
387 <td>set QWTHOME if you have preinstalled version of qwt</td>
388 <td>We try to find libqwt.so.0.4.1 in the ${QWTHOME}/lib folder. </td>
392 <td>existence of HDF5HOME <br>
393 existence of libhdf5.so.0.0.0 <br>
394 existence of libhdf5.settings<br>ver=`grep "HDF5 Version:" ${HDF5HOME}/lib/libhdf5.settings | awk '{print $3}'`</td>
395 <td>set HDF5HOME if you have preinstalled version of hdf</td>
396 <td>We try to find libhdf5.so.0.0.0 and libhdf5.settings in ${HDF5HOME}/lib
398 File libhdf5.settings should contain the following entry: <br>
399 HDF5 Version: 1.4.4</td>
403 <td>existence of MED2HOME <br>
404 existence of libmed.so.1.0.1</td>
405 <td>set MED2HOME if you have preinstalled version of med</td>
406 <td>Unfortunately we can't check version number. <br>
407 We try to find libmed.so.1.0.1 in ${MED2HOME}/lib folder. <br>
408 If you have problem with preinstalled version of med reinstall it.</td>
412 <td>existence of VTKHOME <br>
413 existence of libvtkCommon.so</td>
414 <td>set VTKHOME if you have preinstalled version of vtk</td>
415 <td>Unfortunately we can't check the version number. <br>
416 We try to find libvtkCommon.so in ${VTKHOME}/lib/vtk folder. <br>
417 If you have problem with preinstalled version of vtk reinstall it.</td>
420 <td valign="top">Netgen 4.3<br>
422 <td valign="top">existence of NETGENROOT<br>
424 <td valign="top">set NETGENROOT if you have preinstalled version of
427 <td valign="top">Unfortunarely we can't find anything about netgen
429 We just check if NETGENROOT environment varible is set.<br>
433 <td>OmniORB 3.0.5, <br>
436 <td>existence of OMNIORBDIR <br>
437 existence of libomniORB3.so.0.5 <br>
438 existence of _omnipymodule.so.0.5 <br>
439 existence of libCOSNotify3.so.0.5 <br>
440 existence of notifd <br>
441 existence of THIS_IS_omniORB_3_0_5 <br>
442 existence of THIS_IS_omniNotify_1_2 <br>
443 existence of THIS_IS_OMNIORBPY_1_5</td>
444 <td>set OMNIORBDIR if you have preinstalled version of omni</td>
445 <td>We try to find libomniORB3.so.0.5, _omnipymodule.so.0.5 and libCOSNotify3.so.0.5
446 in ${OMNIORBDIR}/lib/i586_linux_2.0_glibc2.1 folder. <br>
447 We try to find notifd in ${OMNIORBDIR}/bin/i586_linux_2.0_glibc2.1 folder.
449 Additional checking - omni add special files THIS_IS_... <br>
450 We try to find THIS_IS_omniORB_3_0_5 in ${OMNIORBDIR} folder. <br>
451 We try to find THIS_IS_omniNotify_1_2 in ${OMNIORBDIR}/src/services/omniNotify.
453 We try to find THIS_IS_OMNIORBPY_1_5 in ${OMNIORBDIR}/src/lib/omniORBpy
457 <td>Numeric 22.0</td>
458 <td>ver=`python -c 'import Numeric; print Numeric.__version__' 2>/dev/null`</td>
459 <td>set PYTHONHOME if you have preinstalled version of Numeric package</td>
460 <td>If you have problem with preinstalled version of numeric 22.0 reinstall it.</td>
464 <td>existence of SIPDIR <br>sip_ver=`${SIPDIR}/sip -V | awk '{print $1}'`</td>
465 <td>set SIPDIR to directory where you have sip preinstalled</td>
466 <td>Searching for the sip binary is performed in the folder pointed by the $SIPDIR variable if it is set
467 and then by using $PATH variable. <br>
468 It is recommended to use native Sip on Linux RedHat 8.0</td>
472 <td>existence of PYQTDIR <br>
473 existence of libqtxmlcmodule.so.1.0.0</td>
474 <td>set PYQTDIR to directory where you have sip preinstalled</td>
475 <td>Unfortunately we can't check the version number. <br>
476 We try to find libqtxmlcmodule.so.1.0.0 in $PYQTDIR folder if you set PYQTDIR,
477 otherwise searching is done using $LD_LIBRARY_PATH . <br>
478 If you have problem with preinstalled version of PyQt 3.3.2 reinstall it.
480 It is recommended to use native PyQt on Linux RedHat 8.0</td>
483 <td>HappyDoc 2.1</td>
484 <td>existence of happydoc <br>
485 ver=`happydoc | grep "HappyDoc version 2.1"`</td>
486 <td>set PATH variable to the directory where you have HappyDoc installed.</td>
487 <td>We try to find happydoc in $PATH. <br>
488 ver should not be empty. <br>
489 This product is not obligatory. It was added only for your comfort.</td>
492 <td>Doxygen 1.3-rc2</td>
493 <td>existence of doxygen <br>
494 existence of doxysearch <br>
495 existence of doxytag <br>
496 existence of doxywizard<br>ver=`doxygen --version`</td>
497 <td>set QTDIR if you have preinstalled version of qt <br>
498 set PATH on a directory where doxygen, doxysearch, doxytag and doxywizard
500 <td>doxygen, doxysearch, doxytag, doxywizard binaries should exist; ver should be 1.3-rc2.<br>
501 It's necessary to have compiled Qt in order to build doxywizard. <br>
502 If you have problem with preinstalled version of doxygen 1.3-rc2 reinstall
504 This product is not obligatory. It was added only for your comfort.</td>
507 <td>Graphviz 1.9</td>
508 <td>existence of dot binary.<br>ver=`dot -V 2>&1 | awk '{print $3}'`</td>
509 <td>add GraphViz's bin directory to the PATH environment variable</td>
510 <td>We try to find dot program in the $PATH.</td>
513 <td>MODULE binaries<br>
514 (MODULE=KERNEL,GEOM, ...)<br>
516 <td>existence of MODULE_ROOT_DIR <br>
517 existence of VERSION file <br>
518 ver=`cat $MODULE_ROOT_DIR/bin/salome/VERSION | awk -F: '{print $2}' | tr
520 <td>set MODULE_ROOT_DIR if you have preinstalled binaries of MODULE
522 <td>MODULE binaries should exist and ver should be equal to 2.2.4</td>
525 <td>MODULE sources<br>
526 (MODULE=KERNEL,GEOM, ...)<br>
528 <td>existence of MODULE_SRC_DIR <br>
529 existence of VERSION file <br>
530 ver=`cat $MODULE_SRC/bin/VERSION | awk -F: '{print $2}' | tr -d '[:space:]'`</td>
531 <td>set MODULE_SRC_DIR if you have preinstalled sources of MODULE
533 <td>MODULE sources should exist and ver should be equal to 2.2.4</td>
539 <p><b>Note:</b> For native products installation procedure sets proper environment
540 variables itself, and you do not need to set such variables like, e.g. <b>TCLHOME</b>
541 or <b>PYTHONHOME</b>. <br>
542 If you have native products installed to different from default directories
543 (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is recommended to follow above
544 description. Or you should set properly $PATH and $LD_LIBRARY_PATH variables
545 <b><font color="#ff0000">before</font></b> starting Installation Wizard. Otherwise
546 installation script will fail to find preinstalled products. </p>
547 <p><b>Note:</b> For some native products (e.g. gcc, Python) the rules of version
548 checking are not so strict as described in the table. Only major and minor numbers of version
549 should coincide with prerequisite. Release number can be larger. It is done for making a possibility
550 to use native products for newer versions of Red Hat (for example, Linux Red Hat 9 includes native
551 gcc 3.2.2 installation).
552 If native product has version number larger than that required by installation procedure,
553 you will be prompted by the warning message like this: <i>"You have newer version of gcc installed
554 on your computer than that is required (3.2). Continue?"</i>. You can press <i>"Yes"</i> button
555 to procede with the installation but in this case you should be aware of what you are doing.
556 SALOME binaries (including other products) are compiled with the prerequisites from the list
557 and most likely can not be run successfully if this products are not found.
558 This can be only helpful if you intend to build all products from sources.</p>
563 <h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
564 Please, read carefully the following information. This section describes
565 how the installation procedure collects environment.
566 <p>After installing each product shell script creates in the product root
567 folder special environment file. The name of the file is generated from
568 the name of product by the following scheme: <b>env_<product_name>.sh.</b>
569 This file includes all necessary product settings. For example for Vtk the
570 file is <b>env_Vtk.sh</b>. Environment files allows to pick up all environment
571 settings which are necessary to build and launch SALOME. When installing SALOME
572 sources and/or binaries, installation procedure picks up all the settings
573 files and generate two scripts: <b>salome.sh</b> and <b>salome.csh </b>for
574 sh and csh correspondingly. Such approach helps to save time when reinstalling
575 products and you may not to care about setting all environment variables
576 manually to build/launch SALOME. What you need is just to use one of these
579 <p>This concerns also those products which are not currently installed. For
580 example, you install some SALOME binaries to the directory where you have
581 previously installed other products. Installation procedure still tries
582 to collect environment files from the target directory if it find necessary
583 products there. If some product is not found in the target directory the corresponding
584 section of <b>salome.sh/salome.csh</b> files will be skipped. <br>
585 For native products (<i><b>gcc, tcl, python, qt, sip, pyqt </b>for RedHat-8.0<b>)</b></i>
586 instal script tries to find them using <b>$PATH</b> / <b>$LD_LIBRARY_PATH</b>
587 variables and then in the system default directories (<b>/usr/bin, /usr/lib</b>
588 etc., depending on the product). </p>
590 <p>In any case you may edit <b>salome.*</b> files after installation procedure
591 finishes, as you want. </p>
594 <h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font> configuration
595 <font color="#ff0000">file</font></h3>
596 <font color="#000000">You can create your own configuration. Installation
597 Wizard then can take it as command line argument to provide list of products
598 you want to install with it. The list of products and some another settings
599 for the Installation Wizard are provided in xml file. The default file which
600 Installation Wizard looks for if no command line arguments ar given, is <b>config.xml</b>.
601 This section describes the format of configuration file.</font> <br>
602 <font color="#000000">Xml tags are in bold blue, optional sections/tags
603 are in brackets.</font>
604 <p><b><font color="#000099"><document></font></b> <br>
605 <font color="#000000"><b> </b>[</font><b><font
606 color="#000099"><config</font></b><font color="#000000"> [version=<install_wizard_version>]</font>
608 <font color="#000000">
609 [caption=<install_wizard_caption>]</font> <br>
610 <font color="#000000">
611 [copyright=<install_wizard_copyright>]</font> <br>
612 <font color="#000000">
613 [license=<install_wizard_license_info>]</font> <br>
614 <font color="#000000">
615 [os=<target_platform>]</font><b><font color="#000099">/></font></b><font
616 color="#000000">]</font> <br>
617 <font color="#000000"><b> </b>[</font><b><font
618 color="#000099"><path</font></b><font color="#000000"> [targetdir=<target_directory>]</font>
620 <font color="#000000">
621 [tempdir=<temp_directory>]</font><b><font color="#000099">/></font></b><font
622 color="#000000">]</font> <br>
623 <font color="#000000"> [</font><b><font
624 color="#000099"><product</font></b><font color="#000000"> name=<product_name></font>
626 <font color="#000000">
627 version=<product_version></font> <br>
628
629 [context=<product_context>]<br>
630
631 [description=<product_description>]<br>
632 <font color="#000000">
633 install=<installation_mode></font> <br>
634 <font color="#000000">
635 supported=<supported_installation_modes></font> <br>
636 <font color="#000000">
637 disable=<disable_flag><br>
638
639 [pickupenv=<pickup_env_flag>]</font><font color="#000000"><br>
640
641 dependancies=<list_of_prerequisites></font> <font
643
644 installdiskspace=<install_disk_space></font> <font
646
647 temporarydiskspace=<tmp_disk_space></font> <font
649
650 script=<installation_script_name></font><font
651 color="#000099">/<b>></b></font><font color="#000000">]</font> <font
653 [</font><b><font color="#000099"><product</font></b><font
654 color="#000000"> ... </font><font color="#000099">/<b>></b></font><font
655 color="#000000">]</font> <font color="#000000"><br>
656 <b> .</b></font><b><font color="#000099">..</font></b>
657 <b><font color="#000099"><br>
658 </document></font></b> </p>
660 <h4><font color="#000000"><config> section</font></h4>
661 <font color="#000000">This is optional section - contains general information
662 Installation Wizard itself.</font>
664 <li> <font color="#000000"><b>version</b>: Installation Wizard's version
666 <li> <font color="#000000"><b>caption</b>: Installation Wizard's main
667 window title - if this string contains '%1' text - the title will contain
668 in this place version number (see above);</font></li>
669 <li> <font color="#000000"><b>copyright</b>: Installation Wizard's copyright
670 information (appears on the first page of program);</font></li>
671 <li> <font color="#000000"><b>license</b>: Installation Wizard's license
672 information (appears on the first page of program);</font></li>
673 <li> <font color="#000000"><b>os</b>: Contains directory name (relative
674 from ./Products/BINARIES) where Installation Wizard should search precompiled
675 binaries packages. If this tag is skipped, binaries are implied to be in
676 the ./Products/BINARIES directory.</font></li>
680 <h4> <b><font color="#000000"><path> section</font></b></h4>
681 This is optional section - contains default directories.
683 <li> <font color="#000000"><b>targetdir</b>: Starting target directory
684 - path to the directory where products should be installed;</font></li>
685 <li> <font color="#000000"><b>tempdir</b>: Starting temp directory -
686 path to the directory for the temporary files.</font></li>
690 <h4> <b><product> section</b></h4>
691 This section describes product to be installed with the Installation Wizard.
692 All tags are obligatory. Products appears in the products tree and are installed
693 in the order they are described in the configuration file. It is recommended
694 to insert native products at the top of the list before all other products.
697 <li> <font color="#000000"><b>name</b>: Name of the product;</font></li>
698 <li> <font color="#000000"><b>version</b>: Version of the product;</font></li>
699 <li> <font color="#000000"><b>description</b>: Description of the product (optional);</font></li>
700 <li> <font color="#000000"><b>context</b>: Context of the product (optional); the possible values are <b>'salome sources'</b>,
701 <b>'salome binaries'</b> and <b>'prerequisite'</b>;</font></li>
702 <li> <font color="#000000"><b>supported</b>: Supported modes of installation,
703 should contain one or more of the following options, separated by comma:
704 <i>install sources</i>, <i>install binaries</i>, <i>use native</i>. Installation
705 script should contain corresponding functions for each of supported installation
707 <li> <font color="#000000"><b>install</b>: Default (starting) installation
709 <li> <font color="#000000"><b>disable</b>: If this flag has 'true' value,
710 corresponding product will not appear in the list of products tree and will
711 not be installed;</font></li>
712 <li><b>pickupenv</b>: This flag points that pickup environment procedure
713 should be performed for this module. If this flag equal to <b>true</b>, salome.sh
714 and salome.csh files will be created in the product's installation
715 directory. This is optional key, default value is <b>false.</b><br>
717 <li> <font color="#000000"><b>dependancies</b>: list of prerequisite
718 products, which are necessary to build this product, separated by comma;</font></li>
719 <li> <font color="#000000"><b>installdiskspace</b>: Total amount space
720 (integer, in Kbytes), which product occupies on the hard drive after the
721 installation;</font></li>
722 <li> <font color="#000000"><b>temporarydiskspace</b>: Disk space (integer,
723 in Kbytes) for the temporary files, which is necessary to build the product
724 from the sources;</font></li>
725 <li> <font color="#000000"><b>script</b>: Installation script name. This
726 script is in charge of installation of the product. It is called when necessary
727 from the main program. See <a href="#new_products">next section</a> for
728 more information.</font></li>
731 <b>Note:</b> If you add new products to be installed with Installation
732 Wizard, you should also provide installation script for this product. See
733 next section for more details.
735 <h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
736 scripts</font> for the new products</h3>
737 When you want some product to be installed with the Installation Wizard,
738 you should add it's description it <a href="#xml_files">in the configuration
739 file</a> and create bash installation script, following described in this
741 There are some obligatory functions to be provided in this installation
742 script. These functions are automatically called by master installation script
743 or/and GUI shell when it is necessary.<br>
744 <font color="#000000">File <b>common.sh</b> contains some service functions
745 which can be used in your installation script, like <b>make_env()</b>,<b>
746 make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b> find_in_path()</b>,
749 <li> <b>check_version()</b>: This function allows to check the
750 version of the product already installed on the computer. It should try
751 to find product (native or preinstalled in the target directory) and check
752 it version. This helps to avoid unnecessary reinstallation. This is internal
753 function and is not called</li>
754 <li> <b><font color="#000000">try_native()</font></b><font
755 color="#000099">: </font><font color="#000000">This function is called when
756 <i>'use native' </i>installation mode is selected by the user. The function
757 should try to find native version of the product and define possibility of
758 it usage. Should create environment for the product in the temporary directory
759 (see also description of <b>print_env(</b>) function). If you do not provide
760 native mode installation, you can omit this function.</font></li>
761 <li> <font color="#000000"><b>install_source()</b>: This function is
762 called when <i>'install sources</i>' installation mode is selected by the
763 user. The function is responsible for the building of the product from the
764 sources package. Should create environment for the product in the temporary
765 directory (see also description of <b>print_env(</b>) function). If you do
766 not provide sources mode installation, you can omit this function</font></li>
767 <li> <font color="#000000"><b>install_binary()</b>: This function is
768 called when <i>'install binaries'</i> installation mode is selected by the
769 user. The function is responsible for the extracting of the product from
770 the binaries package. Should create environment for the product in the temporary
771 directory (see also description of <b>print_env(</b>) function). If you do
772 not provide binaries mode installation, you can omit this function.</font></li>
773 <li> <b>try_preinstalled()</b>: <font color="#000000">This function is
774 called when<i> 'not install'</i> installation mode is selected by the user.
775 In this case script should inspect target directory to try to find already
776 preinstalled product, pick up and check environment from there. See <a
777 href="#pick_up_env">here</a> for more details.</font></li>
778 <li> <font color="#000000"><b>print_env()</b>: This function is in charge
779 of creation environment script. It should create file with name </font><b>env_<product_name>.sh</b>
780 in the temporary directory and then copy it into the product installation
781 directory. The file should contain all necessary environment variables settings
782 for the product. It will be collected during the 'pick-up-environment' procedure.</li>
783 <li><b>pickup-env()</b>: This procedure corresponds <b>pickupenv</b> tag
784 of the configuration xml file (see previous section). Should call <b>make_env</b>
785 procedure to perform pick-up environment procedure for the product.<br>
789 <font color="#000000">The calling signature of the product installation
790 script is following:</font> <br>
791 <b><font color="#000000"><product_script_name> <function_name>
792 <temp_folder> <products_directory> <target_directory>
793 <dependancies> <product_name></font></b>
794 <p><font color="#000000">where</font> <br>
795 <font color="#000000"><b><product_script_name></b> - installation
796 script name (described in configuration xml file);</font> <br>
797 <font color="#000000"><b><function_name></b> - the name of function,
798 corresponding to the selected installation mode: <i>try_native, install_source,
799 install_binary</i> or <i>try_preinstalled</i>;</font> <br>
800 <font color="#000000"><b><temp_folder></b> - temporary files directory;</font>
802 <font color="#000000"><b><products_directory></b> - directory where
803 the sources/binaries package can be found. You should provide sources package
804 in the <i><Install_Wizard_root_directory>/Products/SOURCES</i> directory
805 and binaries package in the <i><InstallWizard_root_directory>/Products/BINARIES/<os_version></i>,
806 where <os_version> is target platform description, which appears in
807 the corresponding section of the <a href="#xml_files">configuration xml
808 file</a>.</font> <br>
809 <font color="#000000"><b><target_directory></b> - root target directory
810 where product should be installed to;</font> <br>
811 <font color="#000000"><b><dependancies></b> - single-quoted list
812 of prerequisite products, separated by space;</font> <br>
813 <font color="#000000"><b><product_name> </b>- product name itself.</font>
816 <p><font color="#000000">Example:</font> <br>
817 <i><font color="#000000">med-2.2.2.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0
818 /usr/salome 'gcc Hdf' med</font></i> </p>
820 <p><font color="#000000">Copy created script into the <i><Install_Wizard_root_directory>/config_files</i>
821 sub-directory where all installation scripts are stored. Installation Wizard
822 will automatically search and call your script during the installation procedure.</font>
