1 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
4 <meta http-equiv="Content-Type"
5 content="text/html; charset=iso-8859-1">
7 content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">
9 content="Vadim SANDLER (v-sandler@opencascade.com)">
10 <title>SALOME 3 Installation Wizard Help</title>
11 <meta content="Vadim SANDLER" name="author">
13 <body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 229);"
14 alink="#ff0000" link="#0000ee" vlink="#551a8b">
17 <table nosave="" width="100%">
21 <h1><a href="http://www.opencascade.com"><img src="logocorp.png"
22 border="0" height="47" width="139"> </a></h1>
26 <h1><font size="+4"><font color="#000099">SALOME Installation
27 Wizard Help</font> </font></h1>
31 <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
32 src="application.png" border="0" height="47" width="109"> </a></div>
38 <div align="right"><b><font color="#000099">updated for the version </font><font
39 color="#ff0000">3.0.0</font></b></div>
42 <li> <a href="#install_from_wizard">Installing products with the
43 Installation Wizard</a></li>
44 <li> <a href="#check_version_proc">Notes on check products version
46 <li> <a href="#pick_up_env">Pick up the environment</a></li>
47 <li> <a href="#xml_files">Modifying XML configuration file</a></li>
48 <li> <a href="#new_products">Implementing installation scripts for
49 the new products</a></li>
53 <h3> <a name="install_from_wizard"></a>Installing products with the <font
54 color="#ff0000">Installation Wizard</font></h3>
55 The Installation Wizard can be launched in two modes: gui and batch. <br>
56 The root directory of the Installation Wizard
57 contains python script <span style="font-weight: bold;">runInstall</span>.
58 To run the Installation Wizard just type <b>runInstall</b> in terminal
60 <p><b>[ python ] runInstall [ -g | -b ] [ -f <xml-file> ] [ -t
61 <target-dir> ] [ -tmp <tmp-dir> ]</b> </p>
63 Runs the Installation Wizard in the
65 mode (default option). In this case only<span style="font-weight: bold;">
66 <xml-file></span> key is taken into account.
67 Other parameters are ignored. <br>
69 Runs the Installation Wizard in
70 command-line mode. <br>
71 <b>-f <xml-file></b><br>
72 The configuration file to be used by
74 Installation Wizard. If this parameter is missed then the script
76 to define the <i>Linux </i>version and uses corresponding xml file.
78 examle, for the <i>Linux Mandrake 10.1</i> <b>config_Mandrake10_1.xml</b>
80 is supposed to be used by default. If the appropriate file is not
81 found, <b>config.xml</b>
82 is used by default. This file refers to the basic target platform
83 which is Mandrake 10.1 for SALOME 3.0 and higher. If config.xml file is
84 also not found the warning message box is shown and Installation Wizard
86 <b>-t <target-dir></b><br>
87 The target directory, SALOME platform
89 be installed to. If used, overloads default target directory, given in
92 xml file (usually <span style="font-weight: bold;">/salome</span>, see
93 <a href="#xml_files">here</a>). <br>
94 <b>-tmp <tmp-dir></b><br>
95 The directory, which is used to
96 contain temporary files. If used, overloads default temporary
99 configuration xml file (usually <span style="font-weight: bold;">/tmp</span><span
100 style="font-weight: bold;"></span>, see <a
101 href="readme.html#xml_files">here</a>).<br>
103 Prints help information. <br>
105 <p>The installation procedure can support some different Linux
107 and various number of products. As it was mentioned above the basic
108 target platform for SALOME 3.0.0 and higher is <i>Linux Mandrake 10.1</i>.<br>
109 The using of configuration xml files gives flexible way to modify the
110 list of products to be installed by the Installation Wizard without
111 changing program's source code. Just create your own configuration file
112 and implement installation scripts for products you want to be provided
113 by Wizard. See <a href="#xml_files">modifying XML configuration file</a>
114 and <a href="#new_products">implementing installation scripts for the
115 new products</a> for more information. </p>
116 <p>The <font color="#ff0000">Installation Wizard</font> was built with
117 using of the <span style="font-style: italic;">Trolltech's</span> <b><i>Qt
118 3.0.5 </i></b>library. The program contains
119 several pages. To navigate between pages use <i>"Next"</i> and <i>"Back"</i>
121 lower part of the wizard window. <i>"Cancel"</i> button closes dialog
123 and quits the installation procedure. To invoke this help information
125 <i>"Help"</i> button. </p>
126 <p>Skip the first <i>"Introduction"</i> page by pressing <i>"Next"</i>
129 <center><a name="IntroPage"></a><br>
130 <img alt="Intro page" src="intropage.png"
131 style="width: 586px; height: 390px;">
132 <p><b>Figure 1:</b> "Introduction" page</p>
134 <p>In the second page you are proposed to enter the target directory
135 where all selected products should be installed to. You can also press <i>"Browse..."</i>
136 button and choose the folder for installation using standard <b><i>Qt</i></b>'s
137 browse directory dialog box. <br>
138 If the directory you want to install products does not exist you will
139 be prompted to confirm directory creation. If you type wrong directory
140 path, or if you have no permission for the directory you use, the
141 corresponding message box will raise. </p>
142 <p>The Installation Wizard has two modes of the installation: basic
144 advanced. In the basic mode it is necessary just to enter target
145 directory. If you want
146 to use advanced mode, click <i>"More..."</i> button. </p>
147 <p>In the advanced mode you have the possibility to select products to
148 be installed (see <a href="#ProductPage">Fig.2</a> ). Each product can
149 have several options of installation: you have a possibility to use
150 native products, install already precompiled binaries, build product
151 from the sources or not install it at all. Possible options and default
152 choice are provided by the configuration file. You can mark the
153 products you want to install by clicking the corresponding
154 radiobuttons in the list view in the left part of the page. Note that
155 some products can be installed only together with other products (or
156 these prerequisite products should be already installed on your
157 computer). The installation procedure
158 has a special feature to automatically mark these products in the list
160 For example, in order to install <b><i>PyQt</i></b> it's necessary to
162 <b><i>gcc, Python</i></b>,<b><i> Qt</i></b> and <b><i>Sip</i></b>
164 Therefore all these products will be marked when you check on <b><i>PyQt</i></b>.
165 This feature can be switched off by clicking <i>"Auto set
166 prerequisites products"</i> checkbox. <br>
167 Special button in the right part of the page - <i>"Unselect All" </i>-
168 allows to reset quickly all products to the <i>"not install"</i>
170 If you want to use native products (like <span
171 style="font-weight: bold;">gcc</span>, <span
172 style="font-weight: bold;">tcl</span>, etc.), select <i>"use native" </i>option.
174 <p>There are also two checkboxes on this page: <i>"SALOME sources"</i>
175 and <i>"SALOME binaries"</i>.
176 These three-state checkboxes allow quick selecting/unselecting SALOME
178 for the installation.</p>
179 <p>The box at the right side of the page displays the information about
180 currently highlighted product: name, version, short description (if
181 provided in XML file), required
182 disk space, disk space required for temporary files, list of
183 prerequisites and current user
186 <center><a name="ProductPage"></a><br>
187 <img src="productpage.png" alt="Products page"
188 style="width: 586px; height: 589px;">
189 <p><b>Figure 2:</b> "Installation settings" page in the advanced mode</p>
191 <p>The <i>"Total disk space required:"</i> field displays how much
192 disk space on the hard drive is required for installation of selected
194 <b>Note: </b>Please, take into account that displayed amount of
195 required disk space is approximate and may differ when you install
196 products on your hard drive. </p>
197 <p>The installation procedure uses a special directory to store
198 temporary files. The <i>"Space for temporary files:"</i> field shows
199 the information about required disk space on the hard drive for
200 extracting and compiling of the selected products. You can change the
201 default directory - just type path
202 to the folder you want to use or click on the corresponding <i>"Browse..."</i>
204 <span style="font-weight: bold;">Note:</span> actually temporary files
205 are stored not in the directory entered by user. The Installation
206 Wizard creates in this directory an additional one folder named
207 something like INSTALLWORK<span style="font-weight: bold;">XXXXX</span>
208 where XXXXX is unique number. This allows to launch several
209 Installation Wizards simultaneously. This temporary directory is
210 removed automaticaly when the installation finishes.<br>
212 <p>The installation procedure also checks available disk space on the
213 selected directories according to the products selected. If there is no
214 enough disk space on your hard drive you will see the corresponding
215 error message box. </p>
216 <p><b>Note: </b>Unfortunately, the configure procedure has a very
217 annoying bug under Linux platform. The directory should be obligatory
218 entered without spaces. For example, the configure procedure for <b><i>gcc</i></b>
220 work if you pass the following parameter: <i>--prefix="/New Folder 1"</i>.
221 <b>Therefore you are strongly recommended not to use directory names
224 <p>To proceed further click <i>"Next"</i> button. At this moment
226 will make some tests to check installation settings: if there is enough
228 space on the hard drive, if native products are preinstalled,
230 (prerequisites) for each product you have selected to be
232 If any test fails you will see the corresponding warning message box.
234 wizard will follow to the next page: </p>
236 <p><a name="ChoicePage"></a><br>
237 <img src="choicepage.png" alt="Choice page"
238 style="width: 586px; height: 589px;"> </p>
239 <p><b>Figure 3:</b> "Check your choice" page</p>
241 <p>This page summarizes the installation settings you've made on the
242 previous pages. You can check again your choice to change it if
244 When you are sure that everything is OK, press <i>"Next"</i> button to
245 follow to the <a href="#ProgressPage">next page</a>. </p>
246 <center><a name="ProgressPage"></a><br>
247 <img src="progresspage.png" alt="Progress page"
248 style="width: 586px; height: 589px;">
249 <p><b>Figure 4:</b> "Installation progress" page</p>
251 <p>To start installation of the selected products click <i>"Start"</i>
252 button. It launches the shell installation script and you will be able
253 to see the output of the script in the topmost dialog's frame. In case
254 of any installation problems (for example, you have accidentally
255 removed the temporary directory) the script will ask you: <i>"Would
256 you like to continue : (Y,N) ?"</i>. You can answer this question by
257 typing [Y] or [N] in the middle text edit control frame. <br>
258 <b>Note:</b> press [Enter] when you finish typing data. </p>
259 <p>The <i>"Installation Status"</i> frame window shows you the
260 progress of installation. It contains a list of all selected products
261 with brief descriptions. "<font color="#ff0000">Waiting</font>"
262 description means that installation of this product have not started
263 yet. Currently installing product is marked as "<font color="#ff9900">Processing</font>".
264 All installed products have "<font color="#33ff33">Completed</font>"
266 <p>You can abort installation and close the installation procedure
268 <i>"Cancel"</i> button. It sends the signal "SIGTERM" to the shell
270 The script has a signal handler and will try to clear all temporary
272 The process of removing temporary files can take some time, so the
274 wizard will wait 3 seconds before closing. </p>
275 <p>At the end of installation (all selected products have been
277 successfully) you can go back to the previous pages to start a new
279 or click <i>"Next"</i> button to go the Readme page: </p>
281 <p><a name="readmepage"></a><br>
282 <img src="readmepage.png" alt="Readme page"
283 style="width: 586px; height: 589px;"> </p>
284 <p><b>Figure 5:</b> "Finish installation" page</p>
286 <p>In this page you can read important information about the
288 Wizard itself and some hints: how to run and test SALOME or how to
290 SALOME from the sources. This is the contents of the README file which
292 can find in the root directory of the Installation Wizard. <br>
293 You can also launch SALOME Desktop from this page by clicking <i>"Launch
294 SALOME" </i>button. </p>
295 <p><a name="env_files"></a>During the process of installation the
297 environment files to simplify procedure of launching SALOME. These
299 all necessary environment variables for all products you have
301 To learn how installation scripts collects the environment, see <a
302 href="#pick_up_env"> here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b>
303 in the <span style="font-style: italic;"><span
304 style="font-weight: bold;">KERNEL module</span></span><b><i> sources</i></b>
305 and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL
306 module</span></span><b><i> binaries</i></b> root directories and <b>env_products.csh</b>
307 + <b>env_products.sh </b>in the target directory.<br>
309 <span style="font-weight: bold;">Note:</span> <b>salome.(c)sh</b> and <b>env_products.(c)sh
310 files</b> are slightly different: env_products.* files are optimized to
311 be used for the building of SALOME modules from sources (see <span
312 style="font-weight: bold;">README </span>file provided with the
313 installation procedure on th CD). The salome.* files are optimized for
314 the SALOME launching. This difference is defined by the environment
315 variable<span style="font-weight: bold;"> </span><b>ENV_FOR_LAUNCH</b>
316 which is set to 0 in env_products.* files and to 1 in salome.* files.<br>
320 <h3><a name="check_version_proc"></a>Notes on<font color="#ff0000">
321 check products version</font> procedure</h3>
322 Unfortunately under Linux platform there is no exact algorithm to
323 identify the product's version. The table below gives an idea how the
324 version is checked for the preinstalled products for the Linux Mandrake
327 <table nosave="" border="1" width="100%">
331 <center><font size="+1">Product</font></center>
334 <center><font size="+1">Algorithm of checking</font></center>
337 <center><font size="+1">Preliminary steps before launching</font>
339 <font size="+1">of installation procedure</font></center>
342 <center><font size="+1">Notes</font></center>
347 <td><span style="font-weight: bold;">ver</span>=`gcc -dumpversion`</td>
351 <td><span style="font-weight: bold;">ver</span> should be 3.4.1.<br>
352 It is recommended to use native gcc on Mandrake 10.1.<br>
357 <td nosave=""><span style="font-weight: bold;">1)</span> check if
358 <span style="font-weight: bold;">TCLHOME</span> variable is set<br>
359 <span style="font-weight: bold;">2)</span> existence of tclsh8.4<br>
360 <span style="font-weight: bold;">3)</span> existence of wish8.4 <br>
361 <span style="font-weight: bold;">4)</span> existence of
363 <span style="font-weight: bold;">5)</span> existence of
366 <td>set <span style="font-weight: bold;">TCLHOME</span> if you
367 have preinstalled version of tcl. <br>
368 add a directory where libraries can be found to the <span
369 style="font-weight: bold;">LD_LIBRARY_PATH</span><br>
371 <td>Unfortunately there is no more strict way to check the tcl
373 It is recommended to use native tcl/tk on Mandrake 10.1.</td>
376 <td valign="top">boost 1.31.0<br>
378 <td valign="top"><span style="font-weight: bold;">1)</span> check
379 if <span style="font-weight: bold;">BOOSTDIR</span> variable is set.<br>
380 <span style="font-weight: bold;">2)</span> <span
381 style="font-weight: bold;">ver</span>=`egrep 'BOOST_VERSION [0-9]+'
382 ${BOOSTDIR}/boost/version.hpp | sed 's/.*BOOST_VERSION
383 \([0-9]\+\)/\1/g'`<br>
385 <td valign="top">set <span style="font-weight: bold;">BOOSTDIR</span>
386 if you have preinstalled version of
389 <td valign="top">we use version.hpp file in the boost
390 distribution to get the version information.<br>
391 <span style="font-weight: bold;">ver</span> should be equal to
396 <td>Open CASCADE 5.2.3<br>
398 <td><span style="font-weight: bold;">1)</span> check if <span
399 style="font-weight: bold;">CASROOT</span> variable is set<br>
400 <span style="font-weight: bold;">2)</span> ver_major=`grep
401 "!define OCC_VERSION_MAJOR"
402 ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
403 <span style="font-weight: bold;">3)</span> ver_minor=`grep
404 "!define OCC_VERSION_MINOR"
405 ${CASROOT}/inc/Standard_Version.hxx | awk '{print $3}'`<br>
406 <span style="font-weight: bold;">4)</span> <span
407 style="font-weight: bold;">ver</span>="$ver_major.$ver_minor"<br>
408 <span style="font-weight: bold;">5)</span> Check existence of
409 libStdPlugin.so in OpenCASCADE distribution,<br>
411 <td>set <span style="font-weight: bold;">CASROOT</span> if you
412 have preinstalled version of Open CASCADE</td>
413 <td>CASCADE's Standard_Version.hxx file provides version
415 <span style="font-weight: bold;">ver</span> should be equal to
418 Unfortunately there is impossible to define release version number.
419 Instead we check if libStdPlugin.so library exists: it is introduced in
420 OpenCASCADE from version 5.2.2.<br>
424 <td>Python 2.3.4</td>
425 <td><span style="font-weight: bold;">1)</span> <span
426 style="font-weight: bold;">PYTHONHOME</span> variable should be set<br>
427 <span style="font-weight: bold;">2)</span> isPython=`which
429 <span style="font-weight: bold;">3)</span> <span
430 style="font-weight: bold;">ver</span>=`python -V`</td>
431 <td>set <span style="font-weight: bold;">PYTHONHOME</span> to
432 root Python distribution folder;<br>
433 add the directory where python can be found to the <span
434 style="font-weight: bold;">PATH</span> variable<br>
436 <td>Python should exist and <span style="font-weight: bold;">ver</span>
437 should be equal to 2.3.4 <br>
438 It is recommended to use native Python on Mandrake 10.1.</td>
442 <td><span style="font-weight: bold;">ver</span>=`swig -version
443 2>&1 | grep -i version | awk '{ print $3 }' | sed -e
444 's/^\([0-9.]*\)\(.*\)/\1/'`</td>
445 <td>add the directory where swig binary can be found to the <span
446 style="font-weight: bold;">PATH</span> variable</td>
447 <td>Swig should exist and <span style="font-weight: bold;">ver</span>
448 should be equal to 1.3.24.</td>
452 <td><span style="font-weight: bold;">1) QTDIR</span> variable
454 <span style="font-weight: bold;">2) ver</span>=`grep
455 "QT_VERSION_STR" ${QTDIR}/include/qglobal.h | sed -e
456 's%^#define QT_VERSION_STR\([[:space:]]*\)%%g' -e 's%\"%%g'`</td>
457 <td>set <span style="font-weight: bold;">QTDIR</span> if you
458 have preinstalled version of qt</td>
459 <td>Qt's qglobal.h file provides version information: <span
460 style="font-weight: bold;">ver</span> should
461 be equal to 3.0.5.<br>
462 It is recommended to use native Qt on Mandrake 10.1.</td>
465 <td style="vertical-align: top;">msg2qm (Qt 3.3.3 compatible)<br>
467 <td style="vertical-align: top;"><span style="font-weight: bold;">MSG2QM_ROOT</span>
468 variable should be set.<br>
470 <td style="vertical-align: top;">set <span
471 style="font-weight: bold;">MSG2QM_ROOT</span> if you have preinstalled
472 version of msg2qm tool<br>
474 <td style="vertical-align: top;">msg2qm is Qt tool used to
475 convert text *.po files to *.qm resource files. Unfortunately this tool
476 is not included to the Qt distribution and provided only in its sources
477 package. We distribute this tool with the Installation Wizard.<br>
478 In addition there is no way to check the version number of msg2qm tool.<br>
482 <td>Qwt 4.2.0/0.4.2</td>
483 <td><span style="font-weight: bold;">1)</span> <span
484 style="font-weight: bold;">QWTHOME</span> variable should be set.<br>
485 <span style="font-weight: bold;">2)</span> check if
486 libqwt.so.4.2.0 exists<br>
488 <td>set <span style="font-weight: bold;">QWTHOME</span> if
489 you have preinstalled version of qwt</td>
490 <td>Unfortunately there is no strict way to check qwt version
492 We try to find libqwt.so.4.2.0 in the ${<span style="font-weight: bold;">QWTHOME</span>}/lib
497 <td><span style="font-weight: bold;">1) HDF5HOME</span> variable
499 <span style="font-weight: bold;">2)</span> existence of
500 libhdf5.so.0.0.0 <br>
501 <span style="font-weight: bold;">3)</span> existence of
503 <span style="font-weight: bold;">4)</span> <span
504 style="font-weight: bold;">ver</span>=`grep "HDF5 Version:"
505 ${HDF5HOME}/lib/libhdf5.settings | awk
507 <td>set <span style="font-weight: bold;">HDF5HOME</span> if you
508 have preinstalled version of hdf</td>
509 <td>We try to find libhdf5.so.0.0.0 and libhdf5.settings in
510 ${<span style="font-weight: bold;">HDF5HOME</span>}/lib folder. <br>
511 File libhdf5.settings contains the following version information: <br>
512 HDF5 Version: 1.6.3</td>
516 <td><span style="font-weight: bold;">1) MED2HOME</span> variable
518 <span style="font-weight: bold;">2)</span> existence of
520 <td>set <span style="font-weight: bold;">MED2HOME</span> if you
521 have preinstalled version of med</td>
522 <td>Unfortunately there is no strict way to check med version
524 We try to find libmed.so.1.0.1 in ${<span style="font-weight: bold;">MED2HOME</span>}/lib
526 If you have problem with preinstalled version of med reinstall it.</td>
530 <td><span style="font-weight: bold;">1) VTKHOME</span> variable
532 <span style="font-weight: bold;">2)</span> existence of
534 <td>set <span style="font-weight: bold;">VTKHOME</span> if you
535 have preinstalled version of vtk</td>
536 <td>Unfortunately there is no strict way to check VTK version
538 We try to find libvtkCommon.so in ${<span style="font-weight: bold;">VTKHOME</span>}/lib/vtk
540 If you have problem with preinstalled version of vtk reinstall it.</td>
543 <td valign="top">Netgen 4.3<br>
545 <td valign="top"><span style="font-weight: bold;">NETGENROOT</span>
546 variable should be set. </td>
547 <td valign="top">set <span style="font-weight: bold;">NETGENROOT</span>
548 if you have preinstalled version
551 <td valign="top">Unfortunarely we can't find anything about
553 We just check if <span style="font-weight: bold;">NETGENROOT</span>
554 environment varible is set.<br>
558 <td>OmniORB 4.0.5, <br>
561 <td><span style="font-weight: bold;">1) OMNIORBDIR</span>
562 variable should be set.<br>
563 <span style="font-weight: bold;">2)</span> existence of
564 libomniORB4.so.0.5 <br>
565 <span style="font-weight: bold;">3)</span> existence of
566 _omnipymodule.so.2.4 <br>
567 <span style="font-weight: bold;">4)</span> existence of
568 libCOSNotify4.so.0.1 <br>
569 <span style="font-weight: bold;">5)</span> existence of notifd<br>
571 <td>set <span style="font-weight: bold;">OMNIORBDIR</span> if
572 you have preinstalled version of omni</td>
573 <td>We try to find several omni libraries and binaries in the ${<span
574 style="font-weight: bold;">OMNIORBDIR</span>}/lib and ${<span
575 style="font-weight: bold;">OMNIORBDIR</span>}/bin directories.<br>
580 <td>Numeric 23.7</td>
581 <td><span style="font-weight: bold;">ver</span>=`python -c
582 'import Numeric; print Numeric.__version__'
584 <td>add the directory where <span style="font-weight: bold;"></span>you
585 have preinstalled version of Numeric
586 package to your <span style="font-weight: bold;">PYTHONHOME </span>variable<span
587 style="font-weight: bold;"><br>
589 <td>If you have problem with preinstalled version of Numeric 23.7
595 <td><span style="font-weight: bold;">1) SIPDIR</span> variable
597 <span style="font-weight: bold;">2) ver</span>=`${SIPDIR}/sip -V
598 | awk '{print $1}'`</td>
599 <td>set <span style="font-weight: bold;">SIPDIR</span> to
600 directory where you have sip preinstalled</td>
601 <td><span style="font-weight: bold;">ver</span> should be equal
608 <td><span style="font-weight: bold;">1) PYQTDIR</span> variable
610 <span style="font-weight: bold;">2)</span> existence of qt.so
613 <td>set <span style="font-weight: bold;">PYQTDIR</span> to
614 directory where you have PyQt preinstalled</td>
615 <td>Unfortunately we can't check exact PyQt version number. <br>
616 We just try to find qt.so in ${<span style="font-weight: bold;">PYQTDIR</span>}.
621 <td>HappyDoc 2.1</td>
622 <td><span style="font-weight: bold;">1)</span> existence of
624 <span style="font-weight: bold;">2)</span> <span
625 style="font-weight: bold;">ver</span>=`happydoc | grep "HappyDoc
627 <td>add the directory where you have HappyDoc
628 installed to your <span style="font-weight: bold;">PATH</span>
631 <td>We try to find happydoc in ${<span style="font-weight: bold;">PATH</span>}.
633 <span style="font-weight: bold;">ver</span> should not be empty. <br>
635 <span style="font-weight: bold;">Note:</span> this product is not
636 obligatory for SALOME compilation.<br>
640 <td>Doxygen 1.3.7</td>
641 <td><span style="font-weight: bold;">1)</span> existence of
643 <span style="font-weight: bold;">2)</span> existence of doxytag <br>
644 <span style="font-weight: bold;">3)</span> existence of doxywizard<br>
645 <span style="font-weight: bold;">4)</span> <span
646 style="font-weight: bold;">ver</span>=`doxygen --version`</td>
647 <td>add the directory where you have doxygen binaries
648 preinstalled to the <span style="font-weight: bold;">PATH</span>
650 <td>doxygen, doxytag, doxywizard binaries should
651 exist; <span style="font-weight: bold;">ver</span> should be equal to
654 If you have problem with preinstalled version of doxygen
657 It is recommended to use native doxygen on Mandrake 10.1.<br>
661 <td>Graphviz 2.2.1<br>
663 <td><span style="font-weight: bold;">1)</span> existence of dot
665 <span style="font-weight: bold;">2)</span> <span
666 style="font-weight: bold;">ver</span>=`dot -V 2>&1 | awk
668 <td>add graphviz bin directory to the <span
669 style="font-weight: bold;">PATH</span> environment variable</td>
670 <td>We try to find dot program in the ${<span
671 style="font-weight: bold;">PATH</span>}.<br>
672 <span style="font-weight: bold;">ver</span> should be equal to
677 <td><span style="font-weight: bold;">MODULE</span> binaries<br>
678 (where <span style="font-weight: bold;">MODULE</span> = KERNEL, GUI,
681 <td><span style="font-weight: bold;">1) MODULE_ROOT_DIR</span>
682 variable should be set<br>
683 <span style="font-weight: bold;">2)</span> existence of VERSION
685 <span style="font-weight: bold;">3) ver</span>=`cat ${<span
686 style="font-weight: bold;">MODULE_ROOT_DIR</span>}/bin/salome/VERSION
687 | awk -F: '{print $NF}' |
688 tr -d '[:space:]'`</td>
689 <td>set <span style="font-weight: bold;">MODULE_ROOT_DIR</span>
690 if you have preinstalled binaries of <span style="font-weight: bold;">MODULE</span>
692 <td><span style="font-weight: bold;">MODULE</span> binaries
693 should exist and <span style="font-weight: bold;">ver</span> should be
698 <td><span style="font-weight: bold;">MODULE</span> sources<br>
699 (where <span style="font-weight: bold;">MODULE</span> = KERNEL, GUI,
702 <td><span style="font-weight: bold;">1)</span> existence of <span
703 style="font-weight: bold;">MODULE_SRC_DIR</span> <br>
704 <span style="font-weight: bold;">2)</span> existence of VERSION
706 <span style="font-weight: bold;">3) ver</span>=`cat ${<span
707 style="font-weight: bold;">MODULE_SRC_DIR</span>}/bin/VERSION | awk
708 -F: '{print $NF}' | tr -d
710 <td>set <span style="font-weight: bold;">MODULE_SRC_DIR</span>
711 if you have preinstalled sources of <span style="font-weight: bold;">MODULE</span>
714 <td><span style="font-weight: bold;">MODULE</span> sources should
715 exist and ver should be equal to 3.0.0.</td>
719 <p><b>Note:</b> For native products installation procedure sets proper
720 environment variables itself, and you do not need to set such variables
721 like, e.g. <b>TCLHOME</b> or <b>PYTHONHOME</b>. <br>
722 If you have native products installed to different from default
723 directories (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is
724 recommended to follow above description. Or you should set properly <span
725 style="font-weight: bold;">PATH</span> and <span
726 style="font-weight: bold;">LD_LIBRARY_PATH</span> variables <b><font
727 color="#ff0000">before</font></b>
728 starting Installation Wizard. Otherwise
729 installation script will fail to find preinstalled products. </p>
730 <p><b>Note:</b> For some native products (e.g. gcc, Python) the rules
732 checking are not so strict as described in the table. Only major and
733 minor numbers of version
734 should coincide with prerequisite. Release number can be larger. It is
735 done for making a possibility
736 to use native products for newer versions of Linux.
737 If some native product has version number larger than that required by
739 installation procedure, user will be prompted by the warning message
740 like this: <i>"You have
741 newer version of gcc installed
742 on your computer than that is required (3.4.1). Continue?"</i>. You can
743 press <i>"Yes"</i> button
744 to procede with the installation but in this case you should be aware
745 of what you are doing.
746 SALOME binaries (inluding other products) are compiled with the
747 predefined prerequisites
748 and most likely can not be run successfully if these products are not
750 This can be only helpful if you intend to build all products from
754 <h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
755 Please, read carefully the following information. This section
756 describes how the installation procedure collects the environment.
757 <p>After installing each product shell script creates special
758 environment file for each product in its target folder . The name of
759 the file is generated
761 the name of product by the following scheme: <b>env_<product_name>.sh.</b>
762 This file includes all necessary product settings. For example for Vtk
763 the file is <b>env_Vtk.sh</b>. Environment files allows to pick up all
764 environment settings which are necessary to build and launch SALOME.
765 When installing SALOME
766 sources and/or binaries, installation procedure picks up all the
767 settings files and generate two scripts: <b>salome.sh</b> and <b>salome.csh
768 </b>for sh and csh correspondingly. Such approach helps to save time
769 when reinstalling products and you may not to care about setting all
770 environment variables
771 manually to build/launch SALOME. What you need is just to use one of
774 <p>This concerns also those products which are not currently installed.
775 For example, you install some SALOME binaries to the directory where
776 you have previously installed other products. Installation
777 procedure still tries to collect environment files from the target
778 directory if it finds necessary products there. If some product is not
779 found in the target directory the corresponding
780 section of <b>salome.sh/salome.csh</b> files will be skipped. <br>
781 For native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>
782 installation procedure tries to find them first using <b>PATH</b>
783 / <b>LD_LIBRARY_PATH</b> variables and then in the system default
784 directories (<b>/usr/bin, /usr/lib</b> etc., depending on the product).
786 <p>In any case you may edit <b>salome.*</b> files after installation
787 procedure finishes, as you want.<br>
788 <span style="font-weight: bold;">Note:</span> as it was mentioned <a
789 href="#env_files">above</a> there are two more environment files which
790 are generated by the installation procedure: <span
791 style="font-weight: bold;">env_products.csh</span> and <span
792 style="font-weight: bold;">env_products.sh</span>. These files can be
793 found in the target installation root directory.<br>
796 <h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font>
797 configuration <font color="#ff0000">file</font></h3>
798 <font color="#000000">You can create your own configuration file.
799 Installation Wizard then can take it as command line argument to
800 provide list of products you want to install with it. The list of
801 products and some another settings for the Installation Wizard are
802 provided in XML file. The default file which Installation Wizard looks
803 for if no command line arguments are given, is <b>config.xml</b>. This
804 section describes the structure of the configuration file.</font> <br>
805 <font color="#000000">XNL tags are in bold blue, optional sections/tags
806 are in brackets.</font>
807 <font face="Courier"><p><b><font color="#000099"><document></font></b>
809 <font color="#000000"><b> </b>[</font><b><font
810 color="#000099"> <config</font></b><font color="#000000">
811 [ version=<install_wizard_version> ]</font> <br>
812 <font color="#000000">
813 [
814 caption=<install_wizard_caption> ]</font> <br>
815 <font color="#000000">
816 [
817 copyright=<install_wizard_copyright> ]</font> <br>
818 <font color="#000000">
819 [
820 license=<install_wizard_license_info> ]</font> <br>
821 <font color="#000000">
822 [ os=<target_platform>
823 ]</font><b><font color="#000099"><br>
824 /></font></b><font color="#000000"> <br>
825 ]</font> <br>
826 <font color="#000000"><b> </b>[ </font><b><font
827 color="#000099"><path</font></b><font color="#000000">
828 [ targetdir=<target_directory> ]</font> <br>
829 <font color="#000000">
830
831 [ tempdir=<temp_directory> ]</font><b><font
833 /> </font></b><font color="#000000"><br>
834 ]</font> <br>
835 <font color="#000000"> [</font><b><font
836 color="#000099"> <product</font></b><font color="#000000">
837 name=<product_name></font> <br>
838 <font color="#000000">
839
840 version=<product_version></font> <br>
841 [
842 context=<product_context>
844 [
845 description=<product_description> ]<br>
846 <font color="#000000">
847
848 install=<installation_mode></font> <br>
849 <font color="#000000">
850
851 supported=<supported_installation_modes></font> <br>
852 <font color="#000000">
853 disable=<disable_flag><br>
854 [
855 pickupenv=<pickup_env_flag> ]</font><font
857
858
859 dependancies=<list_of_prerequisites></font> <font
861
862 installdiskspace=<install_disk_space></font>
863 <font color="#000000"><br>
864
865 temporarydiskspace=<tmp_disk_space></font> <font
867
868 script=<installation_script_name></font><font
870 /<b>></b></font><font color="#000000">
872 ]</font> <font color="#000000"><br>
873 [</font><b><font color="#000099"> <product</font></b><font
874 color="#000000"> ... </font><font color="#000099"><br>
875 /<b>></b></font><font color="#000000">
877 ]</font> <font color="#000000"><br>
878 <b> .</b></font><b><font color="#000099">..</font></b>
879 <b><font color="#000099"><br>
880 </document></font></b> </p></font>
881 <h4><font color="#000000"><config> section</font></h4>
882 <font color="#000000">This is optional section - contains general
883 information Installation Wizard itself.</font>
885 <li> <font color="#000000"><b>version</b>: Installation Wizard's
886 version number;</font></li>
887 <li> <font color="#000000"><b>caption</b>: Installation Wizard's
889 window title - if this string contains '%1' text - the title will
891 in this place version number (see above);</font></li>
892 <li> <font color="#000000"><b>copyright</b>: Installation Wizard's
893 copyright information (appears on the first page of program);</font></li>
894 <li> <font color="#000000"><b>license</b>: Installation Wizard's
895 license information (appears on the first page of program);</font></li>
896 <li> <font color="#000000"><b>os</b>: Contains directory name
897 (relative from ./Products/BINARIES) where Installation Wizard should
898 search precompiled binaries packages. If this tag is skipped, binaries
900 the ./Products/BINARIES directory.</font></li>
902 <h4> <b><font color="#000000"><path> section</font></b></h4>
903 This is optional section - contains default directories.
905 <li> <font color="#000000"><b>targetdir</b>: Starting target
906 directory - path to the directory where products should be installed;</font></li>
907 <li> <font color="#000000"><b>tempdir</b>: Starting temp directory -
908 path to the directory for the temporary files.</font></li>
910 <h4> <b><product> section</b></h4>
911 This section describes product to be installed with the Installation
912 Wizard. Products appear in the products tree
913 and are installed in the order they are described in the configuration
914 file. It is recommended to insert native products at the top of the
915 list before all other products.
917 <li> <font color="#000000"><b>name</b>: Name of the product;</font></li>
918 <li> <font color="#000000"><b>version</b>: Version of the product;</font></li>
919 <li> <font color="#000000"><b>description</b>: Description of the
920 product (optional);</font></li>
921 <li> <font color="#000000"><b>context</b>: Context of the product
922 (optional); the possible values are <b>'salome sources'</b>, <b>'salome
923 binaries'</b> and <b>'prerequisite'</b>;</font></li>
924 <li> <font color="#000000"><b>supported</b>: Supported modes of
925 installation, should contain one or more of the following options,
926 separated by comma: <i>install sources</i>, <i>install binaries</i>, <i>use
927 native</i>. Installation script should contain corresponding functions
928 for each of supported installation modes;</font></li>
929 <li> <font color="#000000"><b>install</b>: Default (starting)
930 installation mode;</font></li>
931 <li> <font color="#000000"><b>disable</b>: If this flag has 'true'
932 value, corresponding product will not appear in the list of products
933 tree and will not be installed;</font></li>
934 <li><b>pickupenv</b>: This flag points that pickup environment
936 should be performed for this module. If this flag equal to <b>true</b>,
938 and salome.csh files will be created in the product's
940 directory. Usually this option is set to true for SALOME KERNEL module
941 sources and binaries pakcge. This is optional key, default value is <b>false.</b><br>
943 <li> <font color="#000000"><b>dependancies</b>: list of prerequisite
944 products, which are necessary to build this product, separated by comma;</font></li>
945 <li> <font color="#000000"><b>installdiskspace</b>: Total amount
946 space (integer, in Kbytes), which product occupies on the hard drive
948 installation;</font></li>
949 <li> <font color="#000000"><b>temporarydiskspace</b>: Disk space
950 (integer, in Kbytes) for the temporary files, which is necessary to
951 build the product from the sources;</font></li>
952 <li> <font color="#000000"><b>script</b>: Installation script name.
953 This script is in charge of installation of the product. It is called
954 when necessary from the main program. See <a href="#new_products">next
956 more information.</font></li>
958 <b>Note:</b> If you add new products to be installed with Installation
959 Wizard, you should also provide installation script for this product.
961 next section for more details.
963 <h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
964 scripts</font> for the new products</h3>
965 When you want some product to be installed with the Installation
966 Wizard, you should add it's description it <a href="#xml_files">in the
967 configuration file</a> and create bash installation script, following
968 described in this section rules. <br>
969 There are some obligatory functions to be provided in this installation
970 script. These functions are automatically called by master installation
972 or/and its GUI shell when it is necessary.<br>
973 <font color="#000000">File <b>common.sh</b> contains some service
975 which can be used in your installation script, like <b>make_env()</b>,<b>
976 make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b>
980 <li> <b>check_version()</b>: This function allows to check the
981 version of the product already installed on the computer. It should try
982 to find product (native or preinstalled in the target directory) and
984 it version. This helps to avoid unnecessary reinstallation. This is
986 function and is not called</li>
987 <li> <b><font color="#000000">try_native()</font></b><font
988 color="#000099">: </font><font color="#000000">This function is
989 called when <i>'use native' </i>installation mode is selected by the
990 user. The function should try to find native version of the product and
991 define possibility of it usage. Should create environment for the
992 product in the temporary directory (see also description of <b>print_env(</b>)
993 function). If you do not provide native mode installation, you can omit
994 this function.</font></li>
995 <li> <font color="#000000"><b>install_source()</b>: This function is
996 called when <i>'install sources</i>' installation mode is selected by
998 user. The function is responsible for the building of the product from
1000 sources package. Should create environment for the product in the
1002 directory (see also description of <b>print_env(</b>) function). If
1004 not provide sources mode installation, you can omit this function</font></li>
1005 <li> <font color="#000000"><b>install_binary()</b>: This function is
1006 called when <i>'install binaries'</i> installation mode is selected by
1008 user. The function is responsible for the extracting of the product
1010 the binaries package. Should create environment for the product in the
1012 directory (see also description of <b>print_env(</b>) function). If
1014 not provide binaries mode installation, you can omit this function.</font></li>
1015 <li> <b>try_preinstalled()</b>: <font color="#000000">This function
1016 is called when<i> 'not install'</i> installation mode is selected by
1017 the user. In this case script should inspect target directory to try to
1018 find already preinstalled product, pick up and check environment from
1019 there. See <a href="#pick_up_env">here</a> for more details.</font></li>
1020 <li> <font color="#000000"><b>print_env()</b>: This function is in
1021 charge of creation environment script. It should create file with name </font><b>env_<product_name>.sh</b>
1022 in the temporary directory and then copy it into the product
1023 installation directory. The file should contain all necessary
1024 environment variables settings for the product. It will be collected
1025 during the 'pick-up-environment' procedure.</li>
1026 <li><b>pickup_env()</b>: This procedure corresponds <b>pickupenv</b>
1028 of the configuration xml file (see previous section). Should call <b>make_env</b>
1029 procedure to perform pick-up environment procedure for the product.<br>
1032 <font color="#000000">The calling signature of the product installation
1033 script is following:</font> <br>
1034 <b><font color="#000000"><product_script_name>
1035 <function_name> <temp_folder> <products_directory>
1036 <target_directory>
1037 <dependancies> <product_name></font></b>
1038 <p><font color="#000000">where</font> <br>
1039 <font color="#000000"><b><product_script_name></b> - installation
1040 script name (described in configuration xml file);</font> <br>
1041 <font color="#000000"><b><function_name></b> - the name of
1042 function, corresponding to the selected installation mode: <i>try_native,
1043 install_source, install_binary</i> or <i>try_preinstalled</i>;</font> <br>
1044 <font color="#000000"><b><temp_folder></b> - temporary files
1045 directory;</font> <br>
1046 <font color="#000000"><b><products_directory></b> - directory
1047 where the sources/binaries package can be found. You should provide
1048 sources package in the <i><Install_Wizard_root_directory>/Products/SOURCES</i>
1049 directory and binaries package in the <i><InstallWizard_root_directory>/Products/BINARIES/<os_version></i>,
1050 where <os_version> is target platform description, which appears
1051 in the corresponding section of the <a href="#xml_files">configuration
1053 file</a>.</font> <br>
1054 <font color="#000000"><b><target_directory></b> - root target
1055 directory where product should be installed to;</font> <br>
1056 <font color="#000000"><b><dependancies></b> - single-quoted list
1057 of prerequisite products, separated by space;</font> <br>
1058 <font color="#000000"><b><product_name> </b>- product name
1060 <p><font color="#000000">Example:</font> <br>
1061 <i><font color="#000000">med-2.2.2.sh install_binary /tmp/work
1062 ./Products/BINARIES/Mandrake10.1 /usr/salome 'gcc Hdf' med</font></i> </p>
1063 <p><font color="#000000">Copy created script into the <i><Install_Wizard_root_directory>/config_files</i>
1064 sub-directory where all installation scripts are stored. Installation
1066 will automatically search and call your script during the installation