1 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
\r
4 <meta http-equiv="Content-Type"
\r
5 content="text/html; charset=iso-8859-1">
\r
6 <meta name="GENERATOR"
\r
7 content="Mozilla/4.8 [en] (X11; U; Linux 2.4.18-14 i686) [Netscape]">
\r
9 content="Alexander KOVALEV, Open CASCADE SAS (alexander.kovalev@opencascade.com)">
\r
10 <meta name="Copyright" content="2002-2008 CEA">
\r
11 <title>SALOME Installation Wizard Help</title>
\r
13 <body style="color: rgb(0, 0, 0); background-color: rgb(255, 255, 229);"
\r
14 alink="#ff0000" link="#0000ee" vlink="#551a8b">
\r
17 <table nosave="" width="100%">
\r
21 <h1><a href="http://www.opencascade.com"><img src="logocorp.png"
\r
22 border="0" height="47" width="139"> </a></h1>
\r
26 <h3><font size="+4"><font color="#000099">SALOME Installation
\r
27 Wizard Help</font></font></h3>
\r
31 <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
\r
32 src="application.png" border="0" height="47" width="109"> </a></div>
\r
38 <div align="right"><b><font color="#000099">updated for the version </font><font
\r
39 color="#ff0000">5.1.0</font></b></div>
\r
42 <li> <a href="#install_from_wizard">Installing products with the
\r
43 Installation Wizard<br>
\r
46 <li><a href="#gui_mode">GUI mode</a></li>
\r
47 <li><a href="#batch_mode">Batch mode</a></li>
\r
48 <li><a href="#env_files">Environment files</a><br>
\r
51 <li> <a href="#pick_up_env">Pick up the environment</a></li>
\r
52 <li> <a href="#xml_files">Modifying XML configuration file</a></li>
\r
53 <li> <a href="#new_products">Implementing installation scripts for
\r
54 the new products</a></li>
\r
55 <li> <a href="#finish_buttons">Customizing Readme page buttons</a></li>
\r
59 <h3> <a name="install_from_wizard"></a>Installing products with the <font
\r
60 color="#ff0000">Installation Wizard</font></h3>
\r
61 The Installation Wizard can be launched in two modes: <span
\r
62 style="font-weight: bold;">GUI </span>and <span
\r
63 style="font-weight: bold;">batch</span>. <br>
\r
64 The root directory of the Installation Wizard
\r
65 contains Python script <span style="font-weight: bold;">runInstall</span>.
\r
66 To run the Installation Wizard just type <b>runInstall</b> in the
\r
68 window:<span style="font-weight: bold;"></span><span
\r
69 style="font-weight: bold;"></span>
\r
70 <p>[ python ] <b>runInstall </b>[options]<b><br>
\r
72 <p>Without options this script will launch the SALOME Installation
\r
73 Wizard in the GUI mode.<br>
\r
74 The default installation settings can be overridden by using of command
\r
75 line options. Each option has short and long notations:<br>
\r
77 <p><b>-g / --gui</b><br>
\r
79 <div style="margin-left: 40px;">Runs the Installation Wizard in the
\r
81 mode (this is the default mode).<br>
\r
83 <p><b>-b / --batch</b><br>
\r
85 <div style="margin-left: 40px;">Runs the Installation Wizard in
\r
86 the terminal mode. <br>
\r
88 <p><b>-f FILE / --file=</b><span style="font-weight: bold;">FILE<br>
\r
90 <div style="margin-left: 40px;">
\r
91 This is the XML configuration file used by the Installation Wizard.
\r
92 If this option is not used, the installation script tries to define
\r
93 the<i>Linux </i>version and to use the corresponding XML file
\r
95 For example, for <span style="color: rgb(0, 0, 153);">Linux Mandriva
\r
96 2006</span> the <b>config_Mandriva_2006.0.xml</b>
\r
98 will be used by default.
\r
100 <p> <b>-d DIR / --target=DIR</b><br>
\r
102 <div style="margin-left: 40px;">This is the target installation
\r
103 directory for SALOME platform. If used, this option overrides
\r
104 the default target directory, given in the
\r
105 configuration XML file (usually<span style="font-weight: bold;">
\r
106 ${HOME}/salome_<version></span><!--,
\r
108 <a href="#xml_files">here</a> for more details-->).<br>
\r
110 <p><b>-t DIR / --tmp=DIR </b></p>
\r
111 <div style="margin-left: 40px;">This is the directory, for
\r
112 temporary files. If given, this option overrides the default
\r
113 temporary directory, given in the configuration xml file
\r
114 (usually <span style="font-weight: bold;">/tmp</span>
\r
115 <span style="font-weight: bold;"></span><!--,
\r
116 see <a href="#xml_files">here</a> for more information-->).<br>
\r
118 <p><b>-a / --all-from-sources</b></p>
\r
119 <div style="margin-left: 40px;">
\r
120 Force all the products to be installed from sources (including all
\r
121 SALOME modules). If this option is used, all the default installation
\r
122 modes for all the products are ignored.<br>
\r
123 This option is helpful when the user wants to install SALOME on the
\r
124 platform which is not officially supported. In this case, the user can
\r
125 try to run the SALOME Installation Wizard with the <span
\r
126 style="font-weight: bold;">-a</span> option in order to build all the
\r
127 products from sources.<br>
\r
128 <b>Note, that this is long-time operation which can take more than
\r
129 24 hours depending on the computer.</b><br>
\r
131 <p><b>-s / --single-directory </b></p>
\r
132 <div style="margin-left: 40px;">Install all SALOME binaries packages
\r
133 to one directory.<br>
\r
134 <b>This option is ignored when --all-from-sources (-a) option is used.
\r
136 <p><b>-h / --help</b><br>
\r
138 <div style="margin-left: 40px;">Prints help information on
\r
139 the usage of the Installation Wizard. <br>
\r
143 <b>-v / --version</b><br>
\r
145 <div style="margin-left: 40px;">Prints version information
\r
146 (<span style="font-weight: bold;">Note: </span>this
\r
147 is the version number of the Installation Wizard, not of SALOME platform). <br>
\r
151 <p>The installation procedure supports different <span style="color: rgb(0, 0, 153);">Linux
\r
152 </span>platforms and installs various 3d-party installation prerequisite products, which
\r
153 are required by SALOME platform. As it was mentioned above, the basic
\r
154 target platform for SALOME 4.0.0 and later is <span style="color: rgb(0, 0, 153);">Linux Mandriva 2006</span>.<br>
\r
155 The usage of configuration XML files provides a flexible way to modify
\r
156 the list of products to be installed by the Installation Wizard without
\r
157 changing the source code of the application. Just create your own XML
\r
158 configuration file and implement installation scripts for the prerequisite products you
\r
159 need and then use this XML file with the Installation Wizard. This can
\r
160 be done, for example, for some <span style="color: rgb(0, 0, 153);">Linux
\r
161 </span>platform which is not supported directly by the
\r
162 Installation Wizard. See <a href="#xml_files">Modifying XML
\r
163 configuration file</a> and <a href="#new_products">Implementing installation
\r
164 scripts for the new products</a> sections for more information. </p>
\r
165 <h3 style="margin-left: 40px;"> <a name="gui_mode"></a>GUI
\r
168 <p>The GUI of the <font color="#ff0000">Installation Wizard</font> has been
\r
169 developed with <span style="font-weight: bold;"><span style="color: rgb(0, 0, 153);">Qt
\r
170 3.3.8 </span> </span>toolkit by <span style="color: rgb(0, 0, 153);">
\r
171 Trolltech </span>. After launching the Installation Wizard
\r
172 in the GUI mode the wizard window is shown to the user. This wizard
\r
173 guides the user through several subsequent pages. To navigate between
\r
174 the pages use <i>"Next"</i> and <i>"Back"</i>
\r
175 buttons in the lower part of the wizard window. <i>"Cancel"</i> button
\r
176 closes the wizard window and quits the installation procedure after user
\r
177 confirmation. <i>"Help"</i> button opens a window with the help information. </p>
\r
178 <p>The first "<span style="font-style: italic;">Introduction"</span>
\r
179 page is shown in <a href="#IntroPage">Figure 1</a>.
\r
180 Skip this page by pressing <i>"Next"</i> button:
\r
182 <center><a name="IntroPage"></a><br>
\r
183 <img alt="Intro page" src="intropage.png" style="width: 593px; height: 468px;">
\r
184 <p><b>Figure 1:</b> "Introduction" page</p>
\r
186 <p>In the second page you are proposed to select the type of the
\r
187 SALOME installation.<br>
\r
189 At this step three possible types of installation are available:<br>
\r
192 <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install binaries"</b></font></span>
\r
195 <li>all binaries and sources of the chosen modules are
\r
197 <li>all binaries of the chosen prerequisites are installed.</li>
\r
201 <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install sources"</b></font></span>
\r
204 <li>all sources of the chosen modules and prerequisites are
\r
205 installed without compilation.</li>
\r
209 <li><span style="font-style: italic;"> <font color="#ff0000"><b>"Install sources and
\r
210 make compilation"</b></font></span> type:<br>
\r
212 <li>all sources of the chosen modules and prerequisites are
\r
214 <li>all sources are compiled.</li>
\r
219 <p>In case you select "Install sources and make compilation"
\r
220 installation type, then you can also check "Remove sources and
\r
221 temporary files after compilation" option.
\r
223 <center><a name="Installation_type_page"></a><br>
\r
224 <img alt="Installation type page" src="installtypepage.png" style="width: 593px; height: 468px;">
\r
225 <p><b>Figure 2:</b> "Type of installation" page
\r
228 <p>After the installation type has been selected you click <i>"Next"</i>
\r
229 button and the Installation Wizard tries to determine the Linux
\r
230 platform to load the corresponding configuration file. If the user
\r
231 system is not defined or the current SALOME package does not support
\r
232 this one, the warning will appear ("<i>Install binaries</i>"
\r
233 and "<i>Install sources</i>" installation types only):
\r
235 <center><a name="Platform_page"></a><br>
\r
236 <img alt="Platform page" src="platformpage.png" style="width: 593px; height: 468px;">
\r
237 <p><b>Figure 3:</b> "Installation platform" page
\r
240 <p>If "<i>Install sources and make compilation</i>"
\r
241 installation type has been selected, the warning message will be
\r
242 slightly different: "<i>Your Linux platform is not supported by
\r
243 this SALOME package and compilation is not tested on this one</i>".<br>
\r
244 There is a list of all platforms supported by SALOME, but only those
\r
245 supported by the current package are available for selection. in this
\r
246 page you need to to select the reference platform, if you wish to
\r
247 proceed with the present installation procedure.<br>
\r
248 <b>Note:</b> this page is not displayed if the installation
\r
249 platform has been defined automatically.
\r
251 <p>In the next page you are proposed to enter the target
\r
252 installation directory for SALOME platform. You can also press <i>"Browse..."</i>
\r
253 button and choose the destination folder using the standard browse
\r
254 directory dialog box. <br>
\r
255 If the necessary directory does not exist you are
\r
256 prompted to confirm the directory creation. If you type a wrong
\r
258 path, or if you do not have the permissions to write to the chosen
\r
259 directory, the corresponding message box is shown.<br>
\r
261 <p><b>Note: you are strongly recommended to avoid using
\r
262 directory names containing spaces.</b> Otherwise you can
\r
263 experience some troubles with the
\r
266 <center><a name="Directory_page"></a><br>
\r
267 <img alt="Directory page" src="directorypage.png" style="width: 593px; height: 468px;">
\r
268 <p><b>Figure 4:</b> "Installation directory" page
\r
271 <p>You can select the products to be installed in the "Choice of
\r
272 the products to be installed" page.<br>
\r
273 In the default mode it gives you the possibility to view and select
\r
274 SALOME modules only. There is a hidden list of 3d-party prerequisite
\r
275 products. To show it, just click "<i>Show prerequisites...</i>"
\r
278 <center><a name="Products_page1"></a><br>
\r
279 <img alt="Products page (default mode)" src="productpage1.png" style="width: 593px; height: 468px;">
\r
280 <p><b>Figure 5:</b> Choice of the SALOME modules
\r
283 <p>In the full mode you also have the possibility to select
\r
285 The checkbox before each product indicates if this one will be
\r
286 installed or not (checked or unchecked). The second column shows the
\r
287 disk space occupied by the corresponding module. This value depends on
\r
288 the selected type of installation.<br>
\r
289 To hide the prerequisites list - click "<i>Hide prerequisites</i>"
\r
291 <center><a name="Products_page2"></a><br>
\r
292 <img alt="Products page (full mode)" src="productpage2.png" style="width: 593px; height: 468px;">
\r
293 <p><b>Figure 6:</b> Choice of the prerequisites
\r
297 Some products may require some other prerequisite products to be
\r
298 installed. So the installation procedure has a special feature to
\r
299 automatically mark these products in the list view. For example, to
\r
300 install PyQt it is necessary to have gcc, Python, Qt and Sip installed,
\r
301 and these products will be also turned on when you check on PyQt. GEOM
\r
302 module requires KERNEL, GUI modules and such prerequisites as:
\r
303 OpenCascade, Python, Swig, Qt, etc.
\r
305 <p>The dependencies between SALOME modules are managed in the
\r
309 <li>If one module is unchecked, all modules which depend on
\r
310 this one are also unchecked automatically;</li>
\r
311 <li>If one module is checked, all modules required for this one
\r
312 are also checked automatically.</li>
\r
315 <p>Dependency between modules and prerequisites is realized in
\r
319 <li>The choices made by the user in the list of modules have a
\r
320 direct impact on the list of prerequisites;</li>
\r
321 <li>Whenever a module is checked, all the necessary
\r
322 prerequisites are checked automatically with no possibility for the
\r
323 user to uncheck them (see <a href="#Products_page3">Fig.7</a>
\r
325 <li>Whenever a module is unchecked, according to the remaining
\r
326 checked modules, the unnecessary prerequisites are unchecked
\r
327 automatically (see <a href="#Products_page3">Fig.7</a>
\r
330 It is possible to check again the prerequisites, which have been
\r
331 automatically unchecked. In other words, it is possible to add more
\r
332 prerequisites than necessary.
\r
334 <center><a name="Products_page3"></a><br>
\r
335 <img alt="Products page (dependencies presentation)" src="productpage3.png" style="width: 593px; height: 468px;">
\r
336 <p><b>Figure 7:</b> Dependencies between modules and
\r
340 <p>The "<i>Installation with GUI</i>" checkbox allows
\r
341 managing the installation of the graphical interface. Only modules for that
\r
342 'woguimode' attribute is set to "true" value in the XML file
\r
343 (see <a href="#xml_files">here</a> for more information about
\r
344 customizing this installation mode) support without GUI mode and
\r
345 will be checked and installed with their necessary prerequisites in
\r
346 case of installation without GUI. And other modules are unchecked with no
\r
347 possibility to check them in this mode (see <a href="#Products_page4">figure</a> below).<br>
\r
348 By default 'Installation with GUI' checkbox is switched on.
\r
350 <center><a name="Products_page4"></a><br>
\r
351 <img alt="Products page (Installation without GUI)" src="productpage4.png" style="width: 593px; height: 468px;">
\r
352 <p><b>Figure 8:</b> Installation without GUI mode
\r
355 <p>The box at the right side of the page displays the information
\r
356 about the currently selected product: name, version and short description,
\r
357 required disk space, disk space required for the temporary files and
\r
358 the list of prerequisites (this information is provided in the XML
\r
361 <p>The <i>"Disk space required:"</i> field displays
\r
363 disk space on the hard drive is required for installation of the
\r
366 <b>Note:</b> please, take into account that the displayed
\r
368 the required disk space is approximate and may differ when you actually
\r
369 install products on your hard drive.
\r
371 <p>The installation procedure uses a special directory to store
\r
372 temporary files. The <i>"Space for temporary files"</i>
\r
374 the information about the required disk space on the hard drive for
\r
375 extracting and compiling the selected products. You can change the
\r
376 temporary directory (this information is provided in the XML file) to
\r
377 the folder you want.<br>
\r
378 <span style="font-weight: bold;">Note:</span>
\r
379 actually, the temporary files
\r
380 are not stored directly in the directory selected by the user. The
\r
381 Installation Wizard creates in this directory an additional folder
\r
383 like INSTALLWORK<span style="font-weight: bold;">XXXXX</span>
\r
384 where XXXXX is a unique number. This allows launching several
\r
385 Installation Wizards simultaneously. This temporary directory is
\r
386 removed automatically when the installation finishes.<br>
\r
388 <p>The installation procedure also checks the available disk
\r
390 there is not enough disk space on your hard drive you will see the
\r
391 corresponding error message box.
\r
393 <p>Also in the current version of Installation Wizard is possible
\r
394 to install all binaries of the selected SALOME modules into a <b>single</b>
\r
395 directory. It is "<i>SALOME</i>" directory.
\r
396 For this purpose there is a checkbox "<i>Install modules to a
\r
397 single directory</i>" checkbox exists (see <a href="#Products_page4">Fig.8</a>).<br>
\r
398 This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH
\r
399 environment variables.<br>
\r
400 <b>Note:</b> the installation into a single directory is
\r
401 available with the binaries installation type only.
\r
403 <p>To proceed further, click <i>"Next"</i> button.
\r
405 the program will make some tests to check the installation settings: if
\r
406 there is enough disk space on the hard drive, check for the
\r
407 dependencies for each product you have selected to be installed. If any
\r
408 test fails you will see the corresponding warning message box.
\r
409 Otherwise the wizard will proceed to the next page:
\r
411 <center><a name="ChoicePage"></a><br>
\r
412 <img alt="Choice page" src="choicepage.png" style="width: 593px; height: 468px;">
\r
413 <p><b>Figure 9:</b> "Check your choice" page
\r
416 <p>This page summarizes the installation options you've selected
\r
418 previous pages. You can review again your choices and change them if
\r
419 necessary returning to the previous pages. <br>
\r
420 When you are sure that everything is OK, press <i>"Next"</i>
\r
422 follow to the <a href="#ProgressPage">progress page</a>.
\r
424 <center><a name="ProgressPage1"></a><br>
\r
425 <img alt="Progress page (not started yet)" src="progresspage1.png" style="width: 593px; height: 468px;">
\r
426 <p><b>Figure 10:</b> "Installation progress" page:
\r
430 <div style="text-align: left;">To start the installation
\r
432 products click <i>"Start"</i>
\r
433 button. It launches the shell installation script and you will be able
\r
434 to see the output of the script in the topmost frame of the dialog box.
\r
436 errors occur during the installation progress, the corresponding
\r
438 will be printed to the log window in the bold red font.<br>
\r
440 <div style="text-align: left;">It is possible to break the
\r
441 installation at any time by pressing <span style="font-style: italic;">"Stop"</span>
\r
442 button. Then you can get back to the previous pages if you wish to
\r
443 change the installation settings or restart the installation by
\r
444 pressing <span style="font-style: italic;">"Start"</span>
\r
447 <p style="text-align: left;"><span style="font-weight: bold;">Note:</span>
\r
449 implementation it is not possible to resume the stopped installation
\r
450 process; the installation will restart from the very beginning. <br>
\r
452 <center><a name="ProgressPage2"></a><br>
\r
453 <img alt="Progress page (installation started)" src="progresspage2.png" style="width: 593px; height: 468px;">
\r
454 <p><b>Figure 11:</b> "Installation progress" page:
\r
459 <p>The <i>"Installation Status"</i> frame window
\r
461 progress of installation. "<font color="#ff0000">Waiting</font>"
\r
463 means that the installation of this product has not started
\r
464 yet. The product currently being installed is marked as "<font color="#ff9900">Processing</font>" and is displayed in
\r
465 the status bar under "Installation Status" view. All installed products
\r
466 have "<font color="#33ff33">Completed</font>"
\r
469 <p>You can abort the installation and close the installation
\r
471 using <i>"Cancel"</i> button. <br>
\r
472 <span style="font-weight: bold;">Note:</span> this
\r
474 signal "SIGTERM" to the shell script.
\r
475 The script tries to clear all temporary files.
\r
476 The process of removing the temporary files can take some time, so the
\r
477 installation wizard will wait for 3 seconds before closing.
\r
479 <p>At the end of the installation "<b>Installation completed</b>"
\r
480 message will appear in the status bar. You can return to the previous
\r
481 pages to start a new installation or click <i>"Next"</i>
\r
482 button to go to the readme page: </p>
\r
483 <center><a name="readmepage"></a><br>
\r
484 <img alt="Readme page" src="readmepage.png" style="width: 593px; height: 468px;">
\r
485 <p><b>Figure 12:</b> "Finish installation" page
\r
488 <p>In this page you can read important information about the
\r
489 Installation Wizard itself and some tips: how to run and test SALOME or
\r
490 how to build SALOME from the sources. This is also described the
\r
491 README file which you can find in the root directory of the
\r
492 Installation Wizard. <br>
\r
493 You can also launch SALOME Desktop from this
\r
494 page or read the Release Notes file by clicking on the corresponding
\r
495 buttons in the lower part of the page (see <a href="#xml_files">here</a>
\r
496 and <a href="#finish_buttons">here</a> for more
\r
498 customizing these buttons).<br>
\r
500 <h3 style="margin-left: 40px;"> <a name="batch_mode"></a>Batch mode<br>
\r
502 To launch the Installation Wizard in the batch mode use <span
\r
503 style="font-weight: bold;">-b</span>
\r
504 (<span style="font-weight: bold;">--batch</span>) parameter.<br>
\r
505 In this mode the GUI wizard is not shown but all the installation
\r
506 status is displayed directly in the console. In the batch mode user do
\r
507 not have a possibility to change installation settings which are given
\r
508 in the configuration file, except target and temporary directories
\r
509 which can be overridden by the corresponding command line options.<br>
\r
510 There are two exceptions: <b>--all-from-sources</b>
\r
511 (<b>-a</b>) option which enables
\r
512 special installation mode in which all the products (including SALOME
\r
513 modules) are installed from sources, ignoring default mode defined in
\r
514 the XML configuration file (see <a href="#install_from_wizard">here</a>
\r
515 for details) and <b>--single-directory</b> (<b>-s</b>) option which defines
\r
516 that all SALOME modules have to be installed into the one directory
\r
517 (SALOME_<version>, by default, where <version> is SALOME version).
\r
518 <center><a name="BatchMode"></a><br>
\r
520 <img alt="Batch mode" src="batchmode.png"
\r
521 style="width: 660px; height: 410px;">
\r
522 <p><b>Figure 9:</b> Batch mode</p>
\r
524 <h3 style="margin-left: 40px;"><a name="env_files"></a>Environment
\r
526 <p>During the process of installation the
\r
527 script creates some
\r
528 environment files to simplify the procedure of launching SALOME. These
\r
530 all necessary environment variables for all products you have
\r
532 To learn how the installation scripts collect the environment, see <a href="#pick_up_env">here</a>. These files are: <b>salome.csh</b>
\r
534 in the <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL module</span></span><b><i>
\r
536 and <span style="font-style: italic;"><span style="font-weight: bold;">KERNEL
\r
537 module</span></span><b><i> binaries</i></b>
\r
538 root directories and <b>env_products.csh</b>
\r
539 + <b>env_products.sh </b>and <span style="font-weight: bold;">env_build.csh
\r
540 </span>+ <span style="font-weight: bold;">env_build.sh</span>
\r
542 target installation directory.<br>
\r
544 <span style="font-weight: bold;">Note:</span> there
\r
546 between these files: <span style="font-weight: bold;">env_build.*</span>
\r
547 files are optimized to
\r
548 be used for the building of SALOME modules from sources (see <span style="font-weight: bold;">README </span>file
\r
550 installation procedure on the CD). The <span style="font-weight: bold;">env_products.*</span>
\r
551 (and<span style="font-weight: bold;"> salome.*</span>)
\r
554 the SALOME launching. The behavior is defined by the environment
\r
555 variable<span style="font-weight: bold;"> </span><b>ENV_FOR_LAUNCH</b>
\r
556 which is set to <span style="font-weight: bold;">0</span>
\r
558 env_build.* files and to <span style="font-weight: bold;">1</span>
\r
561 (salome.*) files.<br>
\r
564 <h3> <a name="pick_up_env"></a>Pick up the <font color="#ff0000">environment</font></h3>
\r
565 Please, read carefully the following information. This section
\r
566 describes how the installation procedure generates the environment
\r
567 scripts for the SALOME platform being installed.
\r
568 <p>After the installation of each product the shell script
\r
570 environment file for the product in its installation folder. The name
\r
571 of the file is generated from the name of the product by the following
\r
572 scheme: <b>env_<product_name>.sh</b>
\r
573 (for example <b>env_Vtk.sh </b>for the Vtk).
\r
574 This file includes all necessary environment settings. At the final
\r
575 step of the installation the script picks up all settings files and
\r
576 generates from them two common environment files: <b>salome.sh</b>
\r
578 </b>for <span style="font-weight: bold;">bash</span>
\r
579 and <span style="font-weight: bold;">csh</span>
\r
580 shells correspondingly. This
\r
581 approach helps to save time when reinstalling products and you may can
\r
582 avoid setting all environment variables
\r
583 manually to build/launch SALOME. What you need is to source one of
\r
584 these environment files. </p>
\r
585 <p>This also concerns the products which are not being installed.
\r
586 For example, you install some SALOME binaries to the directory where
\r
587 you have previously installed other products. The
\r
589 procedure tries to collect the environment files from the target
\r
590 directory if it finds necessary products installed there. If a
\r
591 product is not found in the target directory the corresponding
\r
592 section of <b>salome.sh/salome.csh</b> files will be
\r
594 For the native products (like <i><b>gcc, tcl, etc...</b><b>)</b></i>
\r
595 the installation procedure tries to find them first using <b>PATH</b>
\r
596 / <b>LD_LIBRARY_PATH</b> variables and then in the system
\r
598 directories (<b>/usr/bin, /usr/lib</b> etc., depending on
\r
601 <p>In any case you are able to edit <b>salome.*</b>
\r
602 files after the installation procedure finished.<br>
\r
603 <span style="font-weight: bold;"><br>
\r
604 Note:</span> as it has been mentioned <a href="#env_files">above</a>
\r
606 are other environment files generated by the installation procedure: <span style="font-weight: bold;">env_products.csh</span> + <span style="font-weight: bold;">env_products.sh</span> and <span style="font-weight: bold;">env_build.csh</span> + <span style="font-weight: bold;">env_build.sh</span>. These
\r
608 found in the target installation root directory.<br>
\r
611 <h3><a name="xml_files"></a>Modifying <font color="#ff0000">XML</font>
\r
612 configuration <font color="#ff0000">file</font></h3>
\r
613 <font color="#000000">You can create your own XML
\r
614 configuration file.
\r
615 The Installation Wizard can take it as a command line argument to
\r
616 provide a list of products you want to install with it. The list of
\r
617 products and some other settings for the Installation Wizard are
\r
618 provided in the XML file.<br>
\r
619 This section describes the structure of the configuration file.</font>
\r
620 <font color="#000000">XML tags are in bold blue, optional
\r
622 are in brackets.</font>
\r
623 <font face="Courier">
\r
624 <p><b><font color="#000099"><document></font></b>
\r
626 <font color="#000000"><b>
\r
627 </b></font><b><font color="#000099">
\r
628 <config</font></b><font color="#000000">
\r
629 [ version=<application_version>
\r
630 ]</font> <br>
\r
631 <font color="#000000">
\r
633 [
\r
634 caption=<application_caption>
\r
635 ]</font> <br>
\r
636 <font color="#000000">
\r
638 [
\r
639 copyright=<application_copyright> ]</font>
\r
641 <font color="#000000">
\r
643 [
\r
644 license=<application_license_info> ]</font> <br>
\r
645 <font color="#000000">
\r
647
\r
648 platforms=<target_platform></font> <br>
\r
649 <font color="#000000">
\r
651 [
\r
652 targetdir=<target_directory>
\r
653 ] </font>
\r
655 <font color="#000000">
\r
657
\r
659 tempdir=<temp_directory>
\r
660 ]</font><b><font color="#000099"><br>
\r
661 /> </font></b>
\r
663 <font color="#000000"><b>
\r
664 </b>[ </font><b><font color="#000099"><buttons></font></b>
\r
666 <font color="#000000"><b>
\r
667 </b>[ </font><b><font color="#000099"><button</font></b>
\r
668 <font color="#000000">
\r
669 label=<button_label> </font>
\r
671 <font color="#000000">
\r
672
\r
673 [ tooltip=<button_tooltip> ]</font> <br>
\r
674 <font color="#000000">
\r
675
\r
677 script=<button_script> </font>
\r
679 <font color="#000000">
\r
680
\r
681 [ disable=<disable_flag> ]</font><font color="#000099"><br>
\r
682 <b>/></b>
\r
683 </font><font color="#000000"><br>
\r
684 ]</font> <br>
\r
685 <font color="#000000">
\r
686 [</font><b><font color="#000099">
\r
687 <button</font></b><font color="#000000">
\r
688 ... </font><font color="#000099"><br>
\r
689 <b>/></b></font>
\r
691 <font color="#000000">
\r
693 <font color="#000000">
\r
695 <font color="#000099"><br>
\r
696 <b></buttons></b>
\r
697 </font><font color="#000000"><br>
\r
698 ]</font> <br>
\r
699 <font color="#000000"> [</font><b><font color="#000099"> <products></font></b>
\r
701 <font color="#000000">
\r
702 [</font><b><font color="#000099">
\r
703 <product</font></b><font color="#000000">
\r
704 name=<product_name></font> <br>
\r
705 <font color="#000000">
\r
707
\r
708 type=<product_type></font> <br>
\r
709
\r
710 [
\r
711 description=<product_description> ]<br>
\r
712 <font color="#000000">
\r
713 </font><b><font color="#000099">
\r
714 <installation</font></b><font color="#000000">
\r
715 os=<installation_platform></font> <br>
\r
716 <font color="#000000">
\r
717
\r
719
\r
720 version=<product_version></font> <br>
\r
721 <font color="#000000">
\r
723
\r
724 [
\r
725 disable=<disable_flag>
\r
726 ]
\r
727 <font color="#000000"><br>
\r
729
\r
730 [
\r
731 woguimode=<without_gui_mode_flag> ]
\r
732 <font color="#000000"><br>
\r
733
\r
734
\r
735 installdiskspace=<install_disk_space></font><br>
\r
736
\r
737
\r
738 [
\r
739 pickupenv=<pickup_env_flag>
\r
740 ]</font>
\r
741 <font color="#000000"><br>
\r
742
\r
744
\r
745
\r
746 script=<installation_script_name></font><br>
\r
747 <font color="#000099">
\r
748 <b>/></b></font><br>
\r
749 <font color="#000000">
\r
751 <font color="#000099"><br>
\r
752 <b>/></b></font><font color="#000000">
\r
754 ]</font> <font color="#000000"><br>
\r
755 [</font><b><font color="#000099"> <product</font></b><font color="#000000"> ... </font><font color="#000099"><br>
\r
756 <b>/></b></font><font color="#000000"> <br>
\r
757 ]</font><br>
\r
758 <font color="#000000">
\r
760 <font color="#000000"> </font><b><font color="#000099"> </products></font></b>
\r
762 <font color="#000000"> ]</font><br>
\r
763 <font color="#000000"> [</font><b><font color="#000099"> <dependencies></font></b>
\r
765 <font color="#000000">
\r
766 [</font><b><font color="#000099">
\r
767 <product</font></b><font color="#000000">
\r
768 name=<product_name></font><b><font color="#000099"> ></font></b> <br>
\r
769 <font color="#000000">
\r
770 [</font><b><font color="#000099">
\r
771 <dep></font></b> <font color="#000000"><prerequisite_name></font>
\r
772 <b><font color="#000099"> </dep></font></b>
\r
773 <font color="#000000">]</font><br>
\r
774 <font color="#000000">
\r
776 <font color="#000000"> </font><b><font color="#000099"> </product></font></b>
\r
778 <font color="#000000">
\r
780 <font color="#000000">
\r
782 <font color="#000000"> </font><b><font color="#000099"> </dependencies></font></b>
\r
784 <font color="#000000"> ]</font><br>
\r
785 <b><font color="#000099">
\r
786 </document></font></b> </font></p>
\r
788 <h4><font color="#000000"><config>
\r
789 section</font></h4>
\r
790 <font color="#000000">This section provides general
\r
791 information about an application that will be installed.<br>
\r
796 <li> <font color="#000000"><b>version</b></font></li>
\r
798 <font color="#000000">The application version number to be
\r
802 <li> <font color="#000000"><b>caption</b></font></li>
\r
804 <font color="#000000">The application main window caption
\r
806 string contains '%1' text the title will contain
\r
807 the version number in this place (see above).</font>
\r
809 <li> <font color="#000000"><b>copyright</b></font></li>
\r
811 <font color="#000000">The application
\r
812 copyright information (shown in the first page).</font>
\r
814 <li> <font color="#000000"><b>license</b></font></li>
\r
816 <font color="#000000">The application license information
\r
818 first page).</font>
\r
820 <li> <font color="#000000"><b>platforms</b></font></li>
\r
822 <font color="#000000">This parameter defines platforms for
\r
823 whose the configurations from this file will be used. Also it provides
\r
824 the directory name (relative from ./Products/BINARIES) where the
\r
825 Installation Wizard will search for precompiled binaries packages.</font>
\r
827 <li> <font color="#000000"><b>targetdir</b></font></li>
\r
829 <font color="#000000">The target
\r
830 directory is the path to the directory where the products should be
\r
833 <li> <font color="#000000"><b>tempdir</b></font></li>
\r
835 <font color="#000000">The temporary directory is
\r
836 the path to the directory for the temporary files.</font>
\r
837 <h4> <b><buttons> section</b></h4>
\r
838 This is an optional section and may contains one or more
\r
839 <product> sections.
\r
840 <h4> <b><button> section</b></h4>
\r
841 This optional section allows customization of the last <i>"Finish
\r
842 installation"</i> page of the Installation Wizard by adding one
\r
844 more buttons in the lower part of the Installation Wizard window. The
\r
846 which is attached to each such button, can perform some specific
\r
847 actions, for example, launch the application or show the 'Release
\r
849 file by using an external program.
\r
850 See <a href="#finish_buttons">here</a> for more
\r
852 writing scripts.<br>
\r
853 <font color="#000000"><br>
\r
854 Attributes:</font><br>
\r
856 <li> <font color="#000000"><b>label</b></font></li>
\r
858 <font color="#000000">This is the button text.</font>
\r
860 <li> <font color="#000000"><b>tooltip</b></font></li>
\r
862 <font color="#000000">The button tooltip (optional).</font>
\r
864 <li> <font color="#000000"><b>script</b></font></li>
\r
866 <font color="#000000">The script attached to the button.</font>
\r
868 <li> <font color="#000000"><b>disable</b></font></li>
\r
870 <font color="#000000">If this optional flag has 'true'
\r
871 value, the corresponding button will not appear in the <i>"Finish
\r
872 installation"</i> page - the section of XML file is ignored.</font><br>
\r
873 <h4> <b><products> section</b></h4>
\r
874 This one contains a list of <product> sections. The
\r
875 products appear in the tree view and are installed in the order they
\r
876 are described in this section.
\r
877 <h4> <b><product> section</b></h4>
\r
878 Current section is optional. It describes the product to be installed
\r
879 with the Installation
\r
880 Wizard. The <products> container should include
\r
881 <product> section for each
\r
882 product to be installed.<br>
\r
883 <font color="#000000"><br>
\r
884 Attributes:</font><br>
\r
886 <li> <font color="#000000"><b>name</b></font></li>
\r
888 <font color="#000000">The name of the product.</font>
\r
890 <li> <font color="#000000"><b>type</b></font></li>
\r
892 <font color="#000000">The type of the product: '<i>component</i>'
\r
893 - SALOME module or '<i>prerequisite</i>' - prerequisite
\r
896 <li> <font color="#000000"><b>description</b></font></li>
\r
898 The <font color="#000000">product </font><font color="#000000">description
\r
900 <h4> <b><installation> section</b></h4>
\r
901 It is a part of the <product> section, that provides
\r
902 installation information by platforms. The <product>
\r
903 section may contains a several <installation> ones for
\r
904 the different platforms.
\r
906 <font color="#000000"><br>
\r
907 Attributes:</font><br>
\r
909 <li> <font color="#000000"><b>os</b></font></li>
\r
911 <font color="#000000">A possible installation platform.</font>
\r
913 <li> <font color="#000000"><b>version</b></font></li>
\r
915 <font color="#000000">The version of the product.</font>
\r
917 <li> <font color="#000000"><b>disable</b></font></li>
\r
919 <font color="#000000">If this optional flag has 'true'
\r
920 value, the corresponding product will not appear in the list of
\r
921 products and will not be installed.</font>
\r
923 <li> <font color="#000000"><b>woguimode</b></font></li>
\r
925 <font color="#000000">This optional flag defines that
\r
926 it's possible to install this module without GUI.</font>
\r
928 <li> <font color="#000000"><b>installdiskspace</b></font></li>
\r
930 <font color="#000000">List of three total amount spaces
\r
931 (integer, in Kbytes, derived by comma), which product occupies on the
\r
932 hard drive after the installation in case 'binary', 'sources' and
\r
933 'sources and compile' installation type.</font>
\r
935 <li><b>pickupenv</b></li>
\r
937 This flag shows that the pickup environment
\r
938 procedure should be performed for this product. If this flag equal to
\r
940 salome.sh and salome.csh files will be created in
\r
942 installation directory. Usually this option is set to true for SALOME
\r
943 KERNEL module. This is optional key, default value is 'false'<b>.</b><br>
\r
945 <li> <font color="#000000"><b>script</b></font></li>
\r
947 <font color="#000000">The installation script name.
\r
948 This script is in charge of the installation of the product. It is
\r
950 automatically by the Installation Wizard when necessary from the main
\r
951 program. See the <a href="#new_products">next
\r
953 more information.</font><br>
\r
955 <b>Note:</b> If you add new products to be
\r
956 installed with Installation Wizard, you should also provide
\r
957 installation script for this product. See the next section for more
\r
962 <h3><a name="new_products"></a>Implementing <font color="#ff0000">installation
\r
963 scripts</font> for the new products</h3>
\r
964 When you want some product to be installed with the Installation
\r
965 Wizard, you should add it's description it <a href="#xml_files">in
\r
967 configuration file</a> and create the installation script,
\r
969 rules described in this section. <br>
\r
971 There are some obligatory functions which should be implemented in this
\r
973 script. These functions are automatically called by master installation
\r
975 or/and its GUI shell when it is necessary.<br>
\r
976 <font color="#000000">File <b>common.sh</b>
\r
977 contains some service
\r
979 which can be used in your installation script, like <b>make_env()</b>,<b>
\r
980 make_dir()</b>, <b>try_existing()</b>, <b>sort_path()</b>,<b>
\r
981 find_in_path()</b>,
\r
984 <li> <b>check_version()</b></li>
\r
986 This function allows to check the
\r
987 version of the product already installed on the computer. It should try
\r
988 to find product (native or preinstalled in the target directory) and
\r
990 its version. This helps to avoid unnecessary reinstallation. This is
\r
992 function and is not called from the master installation script.<br>
\r
994 <li><font color="#000000"><b>install_binary()</b></font></li>
\r
996 <font color="#000000">This function is
\r
997 called when <i>'Install binaries'</i> installation mode is
\r
999 the user. The function is responsible for the extracting of the product
\r
1000 from the binaries package. It should create environment for the product
\r
1002 the temporary directory (see also the description of <b>print_env()</b>
\r
1003 function). It is not necessary to implement this function if you do not
\r
1004 provide binaries mode
\r
1005 installation for the current product. <br>
\r
1008 <li> <font color="#000000"><b>install_source()</b></font></li>
\r
1010 <font color="#000000">This function is
\r
1011 called to install SALOME modules sources, if <i>'Install binaries</i>'
\r
1012 installation mode is selected by the user, and to install prerequisite
\r
1013 products sources, in <i>'Install sources</i>' case (see <a href="#Installation_type_page">Fig.2</a> above). The
\r
1014 function is responsible for the building of the product from
\r
1015 the sources package. It should create the environment file for the
\r
1017 in the temporary directory (see also the description of <b>print_env()</b>
\r
1018 function). It is not necessary to implement this function if you do not
\r
1019 provide a sources mode installation for the current product.</font>
\r
1022 <li> <font color="#000000"><b>install_source_and_build()</b></font></li>
\r
1024 <font color="#000000">This function is
\r
1025 called when <i>'Install sources and make a compilation'</i>
\r
1026 installation mode is selected. This function should be used to unpack
\r
1027 SALOME or prerequisite sources package and then call build/install
\r
1028 procedure for it.<br>
\r
1029 For more details please refer to <a href="#gui_mode">this</a>
\r
1030 section for more details.<br>
\r
1033 <li> <b>try_preinstalled()</b></li>
\r
1035 <font color="#000000">This function
\r
1036 is used to parse the target directory to try to find an already
\r
1037 installed product, to pick up and to check the environment from
\r
1038 there. See <a href="#pick_up_env">here</a> for more
\r
1041 <li> <font color="#000000"><b>print_env_bin()
\r
1042 </b> & <b> print_env_src()</b></font></li>
\r
1044 <font color="#000000">These functions are in charge of the
\r
1045 creation of the environment scripts. They should create in the
\r
1046 temporary directory two files with <b>env_<product_name>.sh</b>
\r
1047 and <b>env_<product_name>_src.sh</b>
\r
1048 names and then copy them into the binary and sources product
\r
1049 installation directories correspondingly. The file should contain all
\r
1051 environment variable settings for the product. It will be collected
\r
1052 during the 'pick-up-environment' procedure.</font>
\r
1054 <li><b>pickup_env()</b></li>
\r
1056 This procedure corresponds to <b>pickupenv</b> tag
\r
1057 of the configuration xml file (see the previous section). It should
\r
1058 call <b>make_env</b>
\r
1059 procedure to perform the pick-up environment procedure for the product.<br>
\r
1061 <font color="#000000">The calling signature of the product
\r
1063 script is the following:</font> <br>
\r
1064 <b><font color="#000000">
\r
1065 <product_script_name>
\r
1066 <function_name>
\r
1067 <temp_folder>
\r
1068 <products_directory>
\r
1069 <target_directory>
\r
1070 <all_products>
\r
1071 <product_name>
\r
1072 <install_products>
\r
1073 <sources_directory>
\r
1074 <remove_sources_flag>
\r
1075 <binaries_directory>
\r
1076 <single_directory_flag> </font></b>
\r
1077 <p><font color="#000000">where</font> <br>
\r
1079 <p><font color="#000000"><b><product_script_name></b>
\r
1081 the name of the installation script (described in the configuration XML
\r
1082 file);</font> <br>
\r
1083 <font color="#000000"><b><function_name></b>
\r
1085 the function, corresponding to the selected installation type and
\r
1086 currently installed product; </font> <br>
\r
1087 <font color="#000000"><b>
\r
1088 <temp_folder> </b> - the directory for the
\r
1089 temporary files; </font> <br>
\r
1090 <font color="#000000"><b><products_directory></b>
\r
1092 where the sources/binaries package can be found. You should provide
\r
1093 sources package in the <i><Install_Wizard_root_directory>/Products/SOURCES</i>
\r
1094 directory and binaries package in the <i><InstallWizard_root_directory>/Products/BINARIES/<os_version></i>,
\r
1095 where <os_version> is the target platform description,
\r
1097 in the corresponding section of the <a href="#xml_files">configuration
\r
1099 file</a>.</font> <br>
\r
1100 <font color="#000000"><b>
\r
1101 <target_directory> </b> - the root target
\r
1102 directory where the product should be installed to;</font> <br>
\r
1103 <font color="#000000"><b>
\r
1104 <all_products> </b> - single-quoted list
\r
1105 of all products, separated by space;</font> <br>
\r
1106 <font color="#000000"><b>
\r
1107 <product_name> </b>- product name
\r
1108 itself;</font> <br>
\r
1109 <font color="#000000"><b>
\r
1110 <install_products> </b> - single-quoted list
\r
1111 of all products to be installed, separated by space;</font> <br>
\r
1112 <font color="#000000"><b>
\r
1113 <sources_directory> </b> - the directory
\r
1114 where the sources package can be found (it is usable if the
\r
1115 <products_directory> parameter gives the binaries
\r
1116 directory path); </font> <br>
\r
1117 <font color="#000000"><b>
\r
1118 <remove_sources_flag> </b> - bool parameter, that
\r
1119 is equal to 'TRUE' if 'Remove sources and temporary files after
\r
1120 compilation' option has been selected by the user (see <a href="#Installation_type_page">Fig.2</a> in the <a href="#gui_mode">GUI part</a>);</font> <br>
\r
1121 <font color="#000000"><b>
\r
1122 <binaries_directory> </b> - the directory
\r
1123 where the binaries package can be found (it is usable if the
\r
1124 <products_directory> parameter gives the sources
\r
1125 directory path); </font> <br>
\r
1126 <font color="#000000"><b>
\r
1127 <single_directory_flag> </b> - bool parameter,
\r
1128 that is equal to 'TRUE' if 'Install modules to a single directory'
\r
1129 option is selected by the user (see <a href="#Products_page1">Fig.5</a>
\r
1130 above). </font> <br>
\r
1132 <p><font color="#000000">Example:</font> <br>
\r
1133 <i><font color="#000000">med-2.3.3.sh install_binary
\r
1134 /tmp/INSTALLWORK21797
\r
1135 ./Products/BINARIES/Mandriva2006.0
\r
1136 'gcc tcltk tcltk_src Python Python_src Qt Qt_src ... DOCUMENTATION
\r
1137 DOCUMENTATION_src'
\r
1140 ./Products/SOURCES
\r
1142 ./Products/BINARIES/Mandriva2006.0
\r
1144 <p><font color="#000000">Copy the created script
\r
1146 the <i><Install_Wizard_root_directory>/config_files</i>
\r
1147 sub-directory where all installation scripts are stored. The Installation
\r
1148 Wizard will automatically search and call your script during the
\r
1153 <h3><a name="finish_buttons"></a>Customizing <font color="#ff0000">Readme
\r
1154 page</font> buttons</h3>
\r
1155 The Installation Wizard allows customizing the layout of the last
\r
1156 <i>"Finish installation"</i> page. If you want to add one
\r
1158 buttons in this page to perform some specific actions at the
\r
1159 end of the installation (for example, show the 'Release Notes' file by using
\r
1160 Open Office) you can put an additional section to the XML
\r
1161 configuration file. This is the <b><button></b>
\r
1162 section (see <a href="#xml_files">here</a> for more
\r
1165 To implement the action which will be performed when the user clicks on
\r
1166 the button, you need to create a script and to put it into the
\r
1167 <i><Install_Wizard_root_directory>/config_files</i>
\r
1169 There are some obligatory functions which should be implemented in this
\r
1170 script. These functions are automatically called by the Installation
\r
1173 <li><b>check_enabled()</b></li>
\r
1175 This procedure is called by the Installation Wizard when the
\r
1176 <i>"Finish installation"</i> page is displayed and the
\r
1178 buttons should be modified according to the installation options. This
\r
1179 procedure should return <b>0</b> if the corresponding
\r
1181 performed and, thus, the button should be enabled. Otherwise, it
\r
1182 should return <b>1</b> - in this case the corresponding
\r
1186 <li><b>execute()</b></li>
\r
1188 This procedure is invoked when the user clicks the button. This
\r
1189 procedure should return <b>0</b> if the corresponding
\r
1190 action is carried out
\r
1191 successfully and <b>1</b> if any error occurs.<br>
\r
1193 The calling signature of the script is the following:<br>
\r
1194 <b><font color="#000000"><product_script_name>
\r
1195 <function_name> <target_directory>
\r
1196 <temp_folder></font></b>
\r
1197 <p><font color="#000000">where</font> <br>
\r
1199 <p><font color="#000000"><b><product_script_name></b>
\r
1201 the script name itself (retrieved from the XML configuration xml
\r
1202 file);</font> <br>
\r
1203 <font color="#000000"><b><function_name></b>
\r
1204 - the name of the function;</font> <br>
\r
1205 <font color="#000000"><b><target_directory></b>
\r
1207 directory where the product is
\r
1208 installed to;</font> <br>
\r
1209 <font color="#000000"><b><temp_folder>
\r
1210 </b> - the directory for the temporary files.</font> <br>
\r
1212 <b>Note:</b> The standard Installation Wizard buttons
\r
1214 SALOME" and "Release Notes" are implemented with this
\r
1215 feature. Refer to the scripts <b>start_salome.sh</b> and
\r
1216 <b>release_notes.sh</b> for the sample implementation.<br>
\r
1218 <b>Note:</b> Any button (even standard) can be ignored by
\r
1220 Installation Wizard if the attribute <b><disable></b>
\r
1222 configuration file is set to the "true" value.
\r
