Salome HOME
DCQ : Merge with Ecole_Ete_a6.
[modules/kernel.git] / doc / salome / gui / KERNEL / files / readme.html
1 <!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">\r
2 \r
3 <html>\r
4 \r
5 <head>\r
6 <title>Installation Wizard</title>\r
7 <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">\r
8 <meta name="generator" content="RoboHelp by eHelp Corporation www.ehelp.com">\r
9 <link rel="stylesheet" href="../default_ns.css"><script type="text/javascript" language="JavaScript" title="WebHelpSplitCss">\r
10 <!--\r
11 if (navigator.appName !="Netscape")\r
12 {   document.write("<link rel='stylesheet' href='../default.css'>");}\r
13 //-->\r
14 </script>\r
15 <style>\r
16 <!--\r
17 body {  }\r
18 -->\r
19 </style><style type="text/css">\r
20 <!--\r
21 h1.whs1 { font-size:24pt; }\r
22 hr.whs2 { float:aligncenter; }\r
23 p.whs3 { background-color:#ffffff; }\r
24 table.whs4 { x-cell-content-align:top; width:100%; border-spacing:0px; border-left-width:0px; border-left-color:#c0c0c0; border-left-style:Solid; border-top-width:0px; border-top-color:#c0c0c0; border-top-style:Solid; border-right-width:0px; border-right-color:#c0c0c0; border-right-style:Solid; border-bottom-width:0px; border-bottom-color:#c0c0c0; border-bottom-style:Solid; }\r
25 col.whs5 { width:18.383%; }\r
26 col.whs6 { width:81.617%; }\r
27 tr.whs7 { x-cell-content-align:top; }\r
28 td.whs8 { width:18.383%; padding-right:10px; padding-left:10px; border-left-color:#c0c0c0; border-top-color:#c0c0c0; border-top-style:Solid; border-bottom-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; border-right-color:#c0c0c0; border-right-width:1px; border-right-style:Solid; border-left-width:1px; border-left-style:Solid; border-top-width:1px; }\r
29 p.whs9 { font-weight:bold; }\r
30 td.whs10 { width:81.617%; padding-right:10px; padding-left:10px; border-top-color:#c0c0c0; border-top-style:Solid; border-right-color:#c0c0c0; border-right-style:Solid; border-bottom-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; border-top-width:1px; border-right-width:1px; }\r
31 td.whs11 { width:18.383%; padding-right:10px; padding-left:10px; border-left-color:#c0c0c0; border-bottom-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; border-right-color:#c0c0c0; border-right-width:1px; border-right-style:Solid; border-left-width:1px; border-left-style:Solid; }\r
32 td.whs12 { width:81.617%; padding-right:10px; padding-left:10px; border-right-color:#c0c0c0; border-right-style:Solid; border-bottom-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; border-right-width:1px; }\r
33 td.whs13 { width:81.617%; padding-right:10px; padding-left:10px; border-right-style:Solid; border-right-color:#c0c0c0; border-bottom-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; border-right-width:1px; }\r
34 td.whs14 { width:18.383%; padding-right:10px; padding-left:10px; border-left-color:#c0c0c0; border-bottom-color:#c0c0c0; border-bottom-style:Solid; border-right-color:#c0c0c0; border-right-width:1px; border-right-style:Solid; border-left-width:1px; border-left-style:Solid; border-bottom-width:1px; }\r
35 td.whs15 { width:81.617%; padding-right:10px; padding-left:10px; border-right-color:#c0c0c0; border-right-style:Solid; border-bottom-color:#c0c0c0; border-bottom-style:Solid; border-bottom-width:1px; border-right-width:1px; }\r
36 p.whs16 { text-align:center; }\r
37 img_whs17 { border:none; width:565px; height:525px; float:none; border-style:none; }\r
38 p.whs18 { background-image:url('../texture_horiz_ltbluebubbles.jpg'); }\r
39 img_whs19 { border:none; width:36px; height:38px; float:none; border-style:none; }\r
40 img_whs20 { border:none; width:565px; height:525px; float:none; border-style:none; }\r
41 img_whs21 { border:none; width:35px; height:37px; float:none; border-style:none; }\r
42 table.whs22 { width:100%; border-left-style:Solid; border-left-width:1px; border-right-style:Solid; border-right-width:1px; border-top-style:Solid; border-top-width:1px; border-bottom-style:Solid; border-bottom-width:1px; border-left-color:#c0c0c0; border-right-color:#c0c0c0; border-top-color:#c0c0c0; border-bottom-color:#c0c0c0; }\r
43 th.whs23 { border-left-color:#c0c0c0; border-left-width:1px; border-left-style:Solid; border-top-color:#c0c0c0; border-top-width:1px; border-top-style:Solid; border-right-color:#c0c0c0; border-right-width:1px; border-right-style:Solid; border-bottom-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; }\r
44 p.whs24 { font-size:12pt; }\r
45 td.whs25 { border-left-color:#c0c0c0; border-left-width:1px; border-left-style:Solid; border-top-color:#c0c0c0; border-top-width:1px; border-top-style:Solid; border-right-color:#c0c0c0; border-right-width:1px; border-right-style:Solid; border-bottom-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; }\r
46 td.whs26 { x-cell-content-align:top; border-left-color:#c0c0c0; border-left-width:1px; border-left-style:Solid; border-top-color:#c0c0c0; border-top-width:1px; border-top-style:Solid; border-right-color:#c0c0c0; border-right-width:1px; border-right-style:Solid; border-bottom-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; }\r
47 p.whs27 { margin-right:2px; }\r
48 img_whs28 { border:none; border-style:none; width:36px; height:38px; float:none; }\r
49 -->\r
50 </style><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
51 <!--\r
52 function reDo() {\r
53   if (innerWidth != origWidth || innerHeight != origHeight)\r
54      location.reload();\r
55 }\r
56 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
57         origWidth = innerWidth;\r
58         origHeight = innerHeight;\r
59         onresize = reDo;\r
60 }\r
61 onerror = null; \r
62 //-->\r
63 </script>\r
64 <style type="text/css">\r
65 <!--\r
66 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
67 -->\r
68 </style><script type="text/javascript" language="javascript1.2" src="../whmsg.js"></script>\r
69 <script type="text/javascript" language="javascript" src="../whver.js"></script>\r
70 <script type="text/javascript" language="javascript1.2" src="../whproxy.js"></script>\r
71 <script type="text/javascript" language="javascript1.2" src="../whutils.js"></script>\r
72 <script type="text/javascript" language="javascript1.2" src="../whtopic.js"></script>\r
73 </head>\r
74 <body><script type="text/javascript" language="javascript1.2">\r
75 <!--\r
76 if (window.gbWhTopic)\r
77 {\r
78         if (window.addTocInfo)\r
79         {\r
80         addTocInfo("About SALOME\nInstalling SALOME");\r
81 addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
82 \r
83         }\r
84         if (window.writeBtnStyle)\r
85                 writeBtnStyle();\r
86 \r
87         if (window.writeIntopicBar)\r
88                 writeIntopicBar(1);\r
89 \r
90         if (window.setRelStartPage)\r
91         {\r
92         setRelStartPage("../kernel.html");\r
93 \r
94                 autoSync(1);\r
95                 sendSyncInfo();\r
96                 sendAveInfoOut();\r
97         }\r
98 }\r
99 else\r
100         if (window.gbIE4)\r
101                 document.location.reload();\r
102 //-->\r
103 </script>\r
104 <h1 class="whs1">Installing SALOME</h1>\r
105 \r
106 \r
107 <hr class="whs2">\r
108 \r
109 \r
110 <ul>\r
111         \r
112         <li class=kadov-p\r
113                 class=kadov-p><a href="#install_from_wizard">Installing products \r
114  with the Installation Wizard</a></li>\r
115         \r
116         <li class=kadov-p\r
117                 class=kadov-p><a href="#check_version_proc">Notes on check products \r
118  version procedure</a></li>\r
119         \r
120         <li class=kadov-p\r
121                 class=kadov-p><a href="#pick_up_env">Pick up the environment</a></li>\r
122         \r
123         <li class=kadov-p\r
124                 class=kadov-p><a href="#xml_files">Modifying XML configuration \r
125  file</a></li>\r
126         \r
127         <li class=kadov-p><p class="whs3"><a href="#new_products">Implementing \r
128  installation scripts for the new products</a></p></li>\r
129 </ul>\r
130 \r
131 \r
132 <hr class="whs2">\r
133 \r
134 \r
135 <h3><a name=install_from_wizard></a>Installing products with the <font \r
136  style="color: #ff0000;"\r
137         color=#FF0000>Installation Wizard</font></h3>\r
138 \r
139 <p>You can run the Installation Wizard in two modes. It's root directory \r
140  contains python script runInstall.py: </p>\r
141 \r
142 <p><b style="font-weight: bold;">[ python ] runInstall [ -g | b ] [ -f \r
143  &lt;xml-file&gt; ] [ -t &lt;target-dir&gt; ] [ -tmp &lt;tmp-dir&gt; ]</b> \r
144  </p>\r
145 \r
146 <p>&nbsp;</p>\r
147 \r
148 <table x-use-null-cells cellspacing="0" width="100%" class="whs4">\r
149 <script language='JavaScript'><!--\r
150 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4)) document.write("</table><table x-use-null-cells cellspacing='0' width='100%' border='1' bordercolor='silver' bordercolorlight='silver' bordercolordark='silver'>");\r
151 //--></script>\r
152 <col class="whs5">\r
153 <col class="whs6">\r
154 \r
155 <tr valign="top" class="whs7">\r
156 <td width="18.383%" class="whs8">\r
157 <p class="whs9"><b style="font-weight: bold;">-g</b></td>\r
158 <td width="81.617%" class="whs10">\r
159 <p>Runs the Installation Wizard in the GUI mode. In this case only &lt;xml-file&gt; \r
160  key is taken into account. This option is used by default. </td></tr>\r
161 \r
162 <tr valign="top" class="whs7">\r
163 <td width="18.383%" class="whs11">\r
164 <p><b style="font-weight: bold;">-b</b></td>\r
165 <td width="81.617%" class="whs12">\r
166 <p>Runs the Installation Wizard in the batch mode. </td></tr>\r
167 \r
168 <tr valign="top" class="whs7">\r
169 <td width="18.383%" class="whs11">\r
170 <p><b style="font-weight: bold;">-f &lt;xml-file&gt;</b></td>\r
171 <td width="81.617%" class="whs12">\r
172 <p>The configuration file to be used by the Installation Wizard.&nbsp; \r
173  If this parameter is missed then the script tries to define the <i>Red \r
174  Hat </i>version and uses corresponding xml file. For example, for the \r
175  <i>Red Hat 8.0</i> <b>config_RedHat8_0.xml</b>&nbsp; file is supposed \r
176  to be used by default. If the appropriate file is not found, <b>config.xml</b> \r
177  is used by default. </td></tr>\r
178 \r
179 <tr valign="top" class="whs7">\r
180 <td width="18.383%" class="whs11">\r
181 <p>&nbsp;<b>-t &lt;target-dir&gt;</b></td>\r
182 <td width="81.617%" class="whs12">\r
183 <p>The target directory, SALOME products to be installed to. If used, overloads \r
184  target directory, given in the configuration xml file. </td></tr>\r
185 \r
186 <tr valign="top" class="whs7">\r
187 <td colspan="1" rowspan="1" width="18.383%" class="whs11">\r
188 <p><b style="font-weight: bold;">-tmp &lt;tmp-dir&gt;</b></td>\r
189 <td colspan="1" rowspan="1" width="81.617%" class="whs13">\r
190 <p>The directory, which is used to contain temporary files.&nbsp; If used, \r
191  overloads temporary directory, given in the configuration xml file.</td></tr>\r
192 \r
193 <tr valign="top" class="whs7">\r
194 <td colspan="1" rowspan="1" width="18.383%" class="whs14">\r
195 <p><b style="font-weight: bold;">-h</b></td>\r
196 <td colspan="1" rowspan="1" width="81.617%" class="whs15">\r
197 <p>Prints this help information. </td></tr>\r
198 <script language='JavaScript'><!--\r
199 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4)) document.write("</table></table><table>");\r
200 //--></script>\r
201 </table>\r
202 \r
203 <p>&nbsp;&nbsp; \r
204  &nbsp; &nbsp; &nbsp;<b><br>\r
205 &nbsp;</b></p>\r
206 \r
207 <p>So, to run the Installation Wizard in the GUI mode, just type <b>runInstall</b>. \r
208  </p>\r
209 \r
210 <p>&nbsp;</p>\r
211 \r
212 <p>The installation procedure can support some different Linux platforms \r
213  (currently it provides only configuration scripts for <i>RedHat-8.0</i>) \r
214  and various number of products. The using of configuration xml files gives \r
215  flexible way to modify the list of products to be installed by the Installation \r
216  Wizard without changing program's source code. Just create your own configuration \r
217  file and implement installation scripts for products you want to be provided \r
218  by Wizard. See <a href="#xml_files">modifying XML configuration file</a> \r
219  and <a href="#new_products">implementing installation scripts for the \r
220  new products</a> for more information. </p>\r
221 \r
222 <p>The <font style="color: #ff0000;"\r
223                         color=#FF0000>Installation Wizard</font> was built with using \r
224  of the <b><i>Qt&nbsp; </i></b>library. The program contains several pages. \r
225  To navigate between pages use <i>&quot;Next&quot;</i> and <i>&quot;Back&quot;</i> \r
226  buttons in the lower part of the wizard window. <i>&quot;Cancel&quot;</i> \r
227  button closes dialog window and quits the installation procedure. To invoke \r
228  this help information click <i>&quot;Help&quot;</i> button. </p>\r
229 \r
230 <p>Skip the first <i>&quot;Introduction&quot;</i> page by pressing <i>&quot;Next&quot;</i> \r
231  button. </p>\r
232 \r
233 <p>In the second page you are proposed to enter the target directory where \r
234  all selected products will be installed to. You can also press <i>&quot;Browse...&quot;</i> \r
235  button and choose the folder for installation using standard <b><i>Qt</i></b> \r
236  browse directory dialog box. <br>\r
237 If the directory you want to install products does not exist you will be \r
238  prompted to confirm directory creation. If you type wrong directory path, \r
239  or if you have no permission for the directory you use, the corresponding \r
240  message box will raise. </p>\r
241 \r
242 <p>The Installation Wizard has two modes of the installation: basic and \r
243  advanced. In the basic mode it is necessary just to enter target directory. \r
244  If you want to use advanced mode, click <i>&quot;More...&quot;</i> button. \r
245  </p>\r
246 \r
247 <p>In the advanced mode you have the possibility to select products to \r
248  be installed (see <a href="#ProductPage">Fig.1</a> ). Each product has \r
249  several options of installation: you have a possibility to use native \r
250  products, install already precompiled binaries, build product from the \r
251  sources or not installed at all. Possible options and default choice are \r
252  provided by the configuration file. You can mark the products, you want \r
253  to install, by clicking the corresponding radiobuttons in the list view \r
254  in the left part of the page. Note that some products can be installed \r
255  only together with other products (or these prerequisite products should \r
256  be already installed on your computer). The installation procedure has \r
257  a special feature to automatically mark these products in the list view. \r
258  For example, in order to install <b><i>pyqt</i></b> it's necessary to \r
259  have <b><i>gcc, python</i></b>,<b><i> qt</i></b> and <b><i>sip</i></b> \r
260  installed. Therefore all these products will be marked when you check \r
261  on <b><i>pyqt</i></b>. This feature can be switched off by clicking <i>&quot;Auto \r
262  set prerequisites products&quot;</i> checkbox. <br>\r
263 Special button in the right part of the page - <i>&quot;Unselect All&quot; \r
264  </i>- allows to reset quickly all products to the <i>&quot;not install&quot;</i> \r
265  state. <br>\r
266 If you want to use native Linux Red Hat 8.0 products (these are gcc, tcl, \r
267  Python, Qt, Sip and PyQt), select <i>&quot;use native&quot; </i>option. \r
268  </p>\r
269 \r
270 <p>The box at the right side of the page displays the information about \r
271  currently highlighted product: name, version, short description (if provided), \r
272  required disk space, temporary files disk space, list of prerequisites \r
273  and user choice. </p>\r
274 \r
275 <a name=ProductPage></a>\r
276 \r
277 <p align="center" class="whs16">&nbsp;</p>\r
278 \r
279 <p align="center" class="whs16"><span style="font-style: italic;"><I><img src="../pics/productpage.png" x-maintain-ratio="TRUE" width="565px" height="525px" border="0" class="img_whs17"></I></span> \r
280  </p>\r
281 \r
282 <p align="center" class="whs16"><b style="font-weight: bold;">Figure 1:</b> &quot;Installation \r
283  settings&quot; page in the advanced mode</p>\r
284 \r
285 <p align="center" class="whs16">&nbsp;</p>\r
286 \r
287 <p>The <i>&quot;Total disk space required:&quot;</i> field displays how \r
288  much disk space on the hard drive is required for installation of selected \r
289  products. </p>\r
290 \r
291 <p>&nbsp;</p>\r
292 \r
293 &nbsp;\r
294 \r
295 <p class="whs18"><b \r
296  style="font-weight: bold;"><img src="../note1.gif" x-maintain-ratio="TRUE" width="36px" height="38px" border="0" class="img_whs19"> </b>Please, take into account \r
297  that displayed amount of required disk space is approximate and may differ \r
298  when you install products on your hard drive. </p>\r
299 \r
300 <p>&nbsp;</p>\r
301 \r
302 <p>The installation procedure uses a special directory to store temporary \r
303  files. The <i>&quot;Space for temporary files:&quot;</i> field shows the \r
304  information about required disk space on the hard drive for extracting \r
305  and compiling of the selected products. You can change the default directory \r
306  - just type path to the folder you want to use or click on the corresponding \r
307  <i>&quot;Browse...&quot;</i> button. </p>\r
308 \r
309 <p>&nbsp;</p>\r
310 \r
311 <p>The installation procedure also checks the available disk space on the \r
312  selected directories according to the products selected. If there is no \r
313  enough disk space on your hard drive you will see the corresponding error \r
314  message box. </p>\r
315 \r
316 <p>&nbsp;</p>\r
317 \r
318 <p class="whs18"><span><b \r
319  style="font-weight: bold;"><img src="../note1.gif" x-maintain-ratio="TRUE" width="36px" height="38px" border="0" class="img_whs19"></span> </b>Unfortunately, the \r
320  configure procedure has a very annoying bug under Linux platform. The \r
321  directory should be obligatory entered without spaces. For example, the \r
322  configure procedure for <b><i>gcc</i></b> won't work if you pass the following \r
323  parameter: <i>--prefix=&quot;/New Folder 1&quot;</i>. <b>Therefore you \r
324  are strongly recommended not to use directory names containing spaces.</b> \r
325  </p>\r
326 \r
327 <p>&nbsp;</p>\r
328 \r
329 <p>To proceed further click <i>&quot;Next&quot;</i> button. At this moment \r
330  program will make some tests to check installation settings: if there \r
331  is enough disk space on the hard drive, if native products are preinstalled, \r
332  dependencies (prerequisites) for each product you have selected to be&nbsp; \r
333  installed. If any test fails you will see corresponding warning message \r
334  box. Otherwise wizard will follow to the next page: </p>\r
335 \r
336 <p>&nbsp;</p>\r
337 \r
338 <p align="center" class="whs16"><a name=ChoicePage></a><br>\r
339 <img src="../pics/choicepage.png" x-maintain-ratio="TRUE" width="565px" height="525px" border="0" class="img_whs17"> </p>\r
340 \r
341 <p align="center" class="whs16"><b style="font-weight: bold;">Figure 2:</b> &quot;Check \r
342  your choice&quot; page</p>\r
343 \r
344 <p align="center" class="whs16">&nbsp;</p>\r
345 \r
346 <p>This page summarizes the installation settings you've made on the previous \r
347  pages. You can check again your choice to change it if necessary. </p>\r
348 \r
349 &nbsp;\r
350 \r
351 <p>When you are sure that everything is OK, press <i>&quot;Next&quot;</i> \r
352  button to follow to the <a href="#ProgressPage">next page</a>. </p>\r
353 \r
354 <p>&nbsp;</p>\r
355 \r
356 <a name=ProgressPage></a>\r
357 \r
358 <p align="center" class="whs16"><img src="../pics/progresspage.png" x-maintain-ratio="TRUE" width="565px" height="525px" border="0" class="img_whs20"> </p>\r
359 \r
360 <p align="center" class="whs16"><b style="font-weight: bold;">Figure 3:</b> &quot;Installation \r
361  progress&quot; page</p>\r
362 \r
363 <p align="center" class="whs16">&nbsp;</p>\r
364 \r
365 <p>To start installation of the selected products click <i>&quot;Start&quot;</i> \r
366  button. It launches the shell installation script and you will be able \r
367  to see the output of the script in the topmost dialog's frame. In case \r
368  of any installation problems (for example, you have accidentally removed \r
369  the temporary directory) the script will ask you: <i>&quot;Would you like \r
370  to continue : (Y,N) ?&quot;</i>. You can answer this question by typing \r
371  [Y] or [N] in the middle text edit control frame. </p>\r
372 \r
373 <p>&nbsp;</p>\r
374 \r
375 &nbsp;\r
376 \r
377 <p class="whs18"><b \r
378  style="font-weight: bold;"><img src="../tip1.gif" x-maintain-ratio="TRUE" width="35px" height="37px" border="0" class="img_whs21"></b> press [Enter] when you finish \r
379  typing data. </p>\r
380 \r
381 <p>&nbsp;</p>\r
382 \r
383 <p>The <i>&quot;Installation Status&quot;</i> frame window shows you the \r
384  progress of installation. It contains a list of all selected products \r
385  with brief descriptions. &quot;<font style="color: #ff0000;"\r
386                                                                                 color=#FF0000>Waiting</font>&quot; \r
387  description means that installation of this product have not started yet. \r
388  Currently installing product is marked as &quot;<font style="color: #ff9900;"\r
389                                                                                                                 color=#FF9900>Processing</font>&quot;. \r
390  All installed products have &quot;<font style="color: #33ff33;"\r
391                                                                                 color=#33FF33>Completed</font>&quot; \r
392  description. </p>\r
393 \r
394 <p>You can abort installation and close the installation procedure using \r
395  <i>&quot;Cancel&quot;</i> button. It sends the signal &quot;SIGTERM&quot; \r
396  to the shell script. The script has a signal handler and will try to clear \r
397  all temporary files. The process of removing temporary files can take \r
398  some time, so the installation wizard will wait 3 seconds before closing. \r
399  </p>\r
400 \r
401 <p>&nbsp;</p>\r
402 \r
403 <p>At the end of installation (all selected products have been installed \r
404  successfully) you can go back to the previous pages to start a new installation \r
405  or click <i>&quot;Next&quot;</i> button to go the Readme page: </p>\r
406 \r
407 <p align="center" class="whs16"><a name=readmepage></a><br>\r
408 <img src="../pics/readmepage.png" x-maintain-ratio="TRUE" width="565px" height="525px" border="0" class="img_whs20"></p>\r
409 \r
410 <p align="center" class="whs16"><b style="font-weight: bold;">Figure 4:</b> &quot;Finish \r
411  installation&quot; page</p>\r
412 \r
413 <p align="center" class="whs16">&nbsp;</p>\r
414 \r
415 <p>In this page you can read important information about the Instalation \r
416  Wizard itself and some hints: how to run and test SALOME or how to build \r
417  SALOME from the sources. This is the contents of the README file which \r
418  you can find in the root directory of the Installation Wizard. </p>\r
419 \r
420 &nbsp;\r
421 \r
422 <p>You can also launch SALOME Desktop from this page by clicking <i>&quot;Launch \r
423  SALOME&quot; </i>button. </p>\r
424 \r
425 <p>During the process of installation the script creates some environment \r
426  files to simplify procedure of launching SALOME. These shell scripts set \r
427  all necessary environment variables for all products you have installed. \r
428  To learn how installation scripts collects the environment, see&nbsp;<a \r
429  href="#pick_up_env"> here</a>. These files are: <b>salome.csh</b> + <b>salome.sh</b> \r
430  in the <span style="font-style: italic;"><I><span style="font-weight: bold;"><B>KERNEL \r
431  module</B></span></I></span><b><i> sources</i></b> and <span style="font-style: italic;"><I><span \r
432  style="font-weight: bold;"><B>KERNEL</B></span></I></span><b><i> module binaries</i></b> \r
433  root directories and <b>env_products.csh</b> + <b>env_products.sh </b>in \r
434  the target directory. </p>\r
435 \r
436 \r
437 <hr class="whs2">\r
438 \r
439 \r
440 <h3><a name=check_version_proc></a>Notes on<font style="color: #ff0000;"\r
441                                                                                                 color=#FF0000> check products \r
442  version</font> procedure</h3>\r
443 \r
444 <p>Unfortunately under Linux platform there is no exact algorithm to identify \r
445  the product's version. The table below contains the information relating \r
446  to checking preinstalled products for the Linux.RedHat 8.0 platform <br>\r
447 &nbsp; </p>\r
448 \r
449 <table nosave x-use-null-cells width="100%" class="whs22">\r
450 \r
451 <tr nosave>\r
452 <th nosave class="whs23">\r
453 <p class="whs24">Product </th>\r
454 <th nosave class="whs23">\r
455 <p class="whs24">Algorithm of checking </th>\r
456 <th nosave class="whs23">\r
457 <p class="whs24">Preliminary steps before launching <br>\r
458 of installation procedure </th>\r
459 <th nosave class="whs23">\r
460 <p class="whs24">Notes </th></tr>\r
461 \r
462 <tr>\r
463 <td class="whs25">\r
464 <p>gcc 3.2</td>\r
465 <td class="whs25">\r
466 <p>ver=`/usr/bin/gcc --version | grep 'gcc (GCC) .*' | cut -b 11-13`</td>\r
467 <td class="whs25">\r
468 <p>- </td>\r
469 <td class="whs25">\r
470 <p>ver should be equal 3.2 <br>\r
471 It is recommended to use native gcc on Linux RedHat 8.0</td></tr>\r
472 \r
473 <tr nosave>\r
474 <td class="whs25">\r
475 <p>tcl 8.3</td>\r
476 <td nosave class="whs25">\r
477 <p>existence of TCLHOME <br>\r
478 existence of tclsh8.3 <br>\r
479 existence of wish8.3 <br>\r
480 existence of libtcl8.3.so <br>\r
481 existence of libtk8.3.so <br>\r
482 existence of libtclx8.3.so <br>\r
483 existence of libtkx8.3.so</td>\r
484 <td class="whs25">\r
485 <p>set TCLHOME if you have preinstalled version of tcl. <br>\r
486 set LD_LIBRARY_PATH on a directory where libs can be found.</td>\r
487 <td class="whs25">\r
488 <p>It is recommended to use native tcl on Linux RedHat 8.0</td></tr>\r
489 \r
490 <tr>\r
491 <td valign="top" class="whs26">\r
492 <p>boost 1.30.2</td>\r
493 <td valign="top" class="whs26">\r
494 <p>ver=`egrep 'BOOST_VERSION [0-9]+' ${BOOSTDIR}/boost/version.hpp | sed \r
495  's/.*BOOST_VERSION \([0-9]\+\)/\1/g'`</td>\r
496 <td valign="top" class="whs26">\r
497 <p>set BOOSTDIR if you have preinstalled version of boost</td>\r
498 <td valign="top" class="whs26">\r
499 <p>It is impossible to use native BOOST and to install BOOST from binaries.</td></tr>\r
500 \r
501 <tr>\r
502 <td class="whs25">\r
503 <p>Cascade 5.1.2</td>\r
504 <td class="whs25">\r
505 <p>existence of CASROOT environment variable</td>\r
506 <td class="whs25">\r
507 <p>set CASROOT if you have preinstalled version of CASCADE</td>\r
508 <td class="whs25">\r
509 <p>Unfortunately we can't say anything exactly about CASCADE 5.1.2 and \r
510  we only check CASROOT environment variable. If you have problem with preinstalled \r
511  version of CASCADE reinstall it</td></tr>\r
512 \r
513 <tr>\r
514 <td class="whs25">\r
515 <p>Python 2.2.1</td>\r
516 <td class="whs25">\r
517 <p>existence of PYTHONHOME <br>\r
518 isPython=`which python` <br>\r
519 ver=`python -V`</td>\r
520 <td class="whs25">\r
521 <p>set PYTHONHOME to root Python folder <br>\r
522 set PATH on a directory where python can be found</td>\r
523 <td class="whs25">\r
524 <p>Python should exist and ver should be equal to 2.2.1 <br>\r
525 It is recommended to use native Python on Linux RedHat 8.0</td></tr>\r
526 \r
527 <tr>\r
528 <td class="whs25">\r
529 <p>Mesa 3.4.2</td>\r
530 <td class="whs25">\r
531 <p>existence of libGL.so.1.2.030402</td>\r
532 <td class="whs25">\r
533 <p>set LD_LIBRARY_PATH on a directory where libGL.so.1.2.030402 can be \r
534  found</td>\r
535 <td class="whs25">\r
536 <p>You have a possibility to build products (vtk &amp; qt) with Mesa drivers \r
537  from the package supplied with this installation procedure or to use OpenGL \r
538  drivers installed on your computer locally. This check procedure concerns \r
539  only supplied Mesa driver.</td></tr>\r
540 \r
541 <tr>\r
542 <td class="whs25">\r
543 <p>Swig 1.3.17</td>\r
544 <td class="whs25">\r
545 <p>isSwig=`which swig` <br>\r
546 ver=`swig -version` <br>\r
547 ver=`echo $ver | awk '{print $3}'`</td>\r
548 <td class="whs25">\r
549 <p>set PATH on a directory where swig can be found</td>\r
550 <td class="whs25">\r
551 <p>Swig should exist and ver should be equal to 1.3.17</td></tr>\r
552 \r
553 <tr>\r
554 <td class="whs25">\r
555 <p>Qt 3.0.5</td>\r
556 <td class="whs25">\r
557 <p>existence of QTDIR <br>\r
558 existence of libqt-mt.so.3.0.5</td>\r
559 <td class="whs25">\r
560 <p>set QTDIR if you have preinstalled version of qt</td>\r
561 <td class="whs25">\r
562 <p>We try to find libqt-mt.so.3.0.5 in ${QTDIR}/lib folder. <br>\r
563 You should set MESA_HOME only if you have preinstalled version of Mesa \r
564  3.4.2. <br>\r
565 It is recommended to use native Qt on Linux RedHat 8.0</td></tr>\r
566 \r
567 <tr>\r
568 <td class="whs25">\r
569 <p>Qwt 0.4.1</td>\r
570 <td class="whs25">\r
571 <p>existence of QWTHOME <br>\r
572 existence of libqwt.so.0.4.1</td>\r
573 <td class="whs25">\r
574 <p>set&nbsp; QWTHOME if you have preinstalled version of qwt</td>\r
575 <td class="whs25">\r
576 <p>We try to find libqwt.so.0.4.1 in the ${QWTHOME}/lib folder.&nbsp;</td></tr>\r
577 \r
578 <tr>\r
579 <td class="whs25">\r
580 <p>Hdf 5-1.4.4</td>\r
581 <td class="whs25">\r
582 <p>existence of HDF5HOME <br>\r
583 existence of libhdf5.so.0.0.0 <br>\r
584 existence of libhdf5.settings</td>\r
585 <td class="whs25">\r
586 <p>set HDF5HOME if you have preinstalled version of hdf</td>\r
587 <td class="whs25">\r
588 <p>We try to find libhdf5.so.0.0.0 and libhdf5.settings in ${HDF5HOME}/lib \r
589  folder. <br>\r
590 File libhdf5.settings should contain the following entry: <br>\r
591 HDF5 Version: 1.4.4</td></tr>\r
592 \r
593 <tr>\r
594 <td class="whs25">\r
595 <p>Med 2.1.6</td>\r
596 <td class="whs25">\r
597 <p>existence of MED2HOME <br>\r
598 existence of libmed.so.0.0.0</td>\r
599 <td class="whs25">\r
600 <p>set MED2HOME if you have preinstalled version of med</td>\r
601 <td class="whs25">\r
602 <p>Unfortunately we can't check version number. <br>\r
603 We try to find libmed.so.0.0.0 in ${MED2HOME}/lib folder. <br>\r
604 If you have problem with preinstalled version of med reinstall it.</td></tr>\r
605 \r
606 <tr>\r
607 <td class="whs25">\r
608 <p>Vtk 4.2</td>\r
609 <td class="whs25">\r
610 <p>existence of VTKHOME <br>\r
611 existence of libvtkCommon.so</td>\r
612 <td class="whs25">\r
613 <p>set VTKHOME if you have preinstalled version of vtk</td>\r
614 <td class="whs25">\r
615 <p>Unfortunately we can't check the version number. <br>\r
616 We try to find libvtkCommon.so in ${VTKHOME}/lib/vtk folder. <br>\r
617 If you have problem with preinstalled version of vtk reinstall it.</td></tr>\r
618 \r
619 <tr>\r
620 <td valign="top" class="whs26">\r
621 <p>Netgen 4.3</td>\r
622 <td valign="top" class="whs26">\r
623 <p>existence of NETGENROOT</td>\r
624 <td valign="top" class="whs26">\r
625 <p>set NETGENROOT if you have preinstalled version of Netgen.</td>\r
626 <td valign="top" class="whs26">\r
627 <p>Unfortunarely we can't find anything about netgen version.<br>\r
628 We just check if NETGENROOT environment varible is set.</td></tr>\r
629 \r
630 <tr>\r
631 <td class="whs25">\r
632 <p>OmniORB 3.0.5, <br>\r
633 OmniORBpy 1.5, <br>\r
634 OmniNotify 1.2</td>\r
635 <td class="whs25">\r
636 <p>existence of OMNIORBDIR <br>\r
637 existence of libomniORB3.so.0.5 <br>\r
638 existence of _omnipymodule.so.0.5 <br>\r
639 existence of libCOSNotify3.so.0.5 <br>\r
640 existence of notifd <br>\r
641 existence of THIS_IS_omniORB_3_0_5 <br>\r
642 existence of THIS_IS_omniNotify_1_2 <br>\r
643 existence of THIS_IS_OMNIORBPY_1_5</td>\r
644 <td class="whs25">\r
645 <p>set OMNIORBDIR if you have preinstalled version of omni</td>\r
646 <td class="whs25">\r
647 <p>We try to find libomniORB3.so.0.5, _omnipymodule.so.0.5 and libCOSNotify3.so.0.5 \r
648  in ${OMNIORBDIR}/lib/i586_linux_2.0_glibc2.1 folder. <br>\r
649 We try to find notifd in ${OMNIORBDIR}/bin/i586_linux_2.0_glibc2.1 folder. \r
650  <br>\r
651 Additional checking - omni add special files THIS_IS_... <br>\r
652 We try to find THIS_IS_omniORB_3_0_5 in ${OMNIORBDIR} folder. <br>\r
653 We try to find THIS_IS_omniNotify_1_2 in ${OMNIORBDIR}/src/services/omniNotify. \r
654  <br>\r
655 We try to find THIS_IS_OMNIORBPY_1_5 in ${OMNIORBDIR}/src/lib/omniORBpy \r
656  folder.</td></tr>\r
657 \r
658 <tr>\r
659 <td class="whs25">\r
660 <p>Numeric 22.0</td>\r
661 <td class="whs25">\r
662 <p>existence of Numeric folder <br>\r
663 existence of _numpy.so</td>\r
664 <td class="whs25">\r
665 <p>set PYTHONHOME if you have preinstalled version of python</td>\r
666 <td class="whs25">\r
667 <p>Unfortunately we can't check the version number. <br>\r
668 We try to find Numeric folder in ${PYTHONHOME}/lib/python2.2/site-packages/Numeric \r
669  folder. <br>\r
670 If you have problem with preinstalled version of numeric 22.0 reinstall \r
671  it.</td></tr>\r
672 \r
673 <tr>\r
674 <td class="whs25">\r
675 <p>Sip 3.3.2</td>\r
676 <td class="whs25">\r
677 <p>existence of SIPDIR <br>\r
678 existence of sip <br>\r
679 existence of libsip.so.9.1.0</td>\r
680 <td class="whs25">\r
681 <p>set SIPDIR to directory where you have sip preinstalled</td>\r
682 <td class="whs25">\r
683 <p>We try to find sip and libsip.so.9.1.0 in $SIPDIR folder if you set \r
684  SIPDIR , otherwise searching is done using $PATH and $LD_LIBRARY_PATH \r
685  accordingly. <br>\r
686 It is recommended to use native Sip on Linux RedHat 8.0</td></tr>\r
687 \r
688 <tr>\r
689 <td class="whs25">\r
690 <p>PyQt 3.3.2</td>\r
691 <td class="whs25">\r
692 <p>existence of PYQTDIR <br>\r
693 existence of libqtxmlcmodule.so.1.0.0</td>\r
694 <td class="whs25">\r
695 <p>set PYQTDIR to directory where you have sip preinstalled</td>\r
696 <td class="whs25">\r
697 <p>Unfortunately we can't check the version number. <br>\r
698 We try to find libqtxmlcmodule.so.1.0.0 in $PYQTDIR folder if you set PYQTDIR, \r
699  otherwise searching is done using $LD_LIBRARY_PATH . <br>\r
700 If you have problem with preinstalled version of PyQt 3.3.2 reinstall it. \r
701  <br>\r
702 It is recommended to use native PyQt on Linux RedHat 8.0</td></tr>\r
703 \r
704 <tr>\r
705 <td class="whs25">\r
706 <p>HappyDoc 2.1</td>\r
707 <td class="whs25">\r
708 <p>existence of happydoc <br>\r
709 ver=`happydoc | grep &quot;HappyDoc version 2.1&quot;`</td>\r
710 <td class="whs25">\r
711 <p>set PYTHONHOME if you have preinstalled version of python</td>\r
712 <td class="whs25">\r
713 <p>We try to find happydoc in $PYTHONHOME/bin folder. <br>\r
714 ver should not be empty. <br>\r
715 This product is not obligatory. It was added only for your comfort.</td></tr>\r
716 \r
717 <tr>\r
718 <td class="whs25">\r
719 <p class="whs27">Doxygen 1.3-rc2</td>\r
720 <td class="whs25">\r
721 <p>existence of doxygen <br>\r
722 existence of doxysearch <br>\r
723 existence of doxytag <br>\r
724 existence of doxywizard</td>\r
725 <td class="whs25">\r
726 <p>set QTDIR if you have preinstalled version of qt <br>\r
727 set PATH on a directory where doxygen, doxysearch, doxytag and doxywizard \r
728  can be found</td>\r
729 <td class="whs25">\r
730 <p>Unfortunately we can't check the version number. <br>\r
731 It's necessary to have compiled Qt in order to build doxywizard. <br>\r
732 If you have problem with preinstalled version of doxygen 1.3-rc2 reinstall \r
733  it. <br>\r
734 This product is not obligatory. It was added only for your comfort.</td></tr>\r
735 \r
736 <tr>\r
737 <td class="whs25">\r
738 <p>Graphviz 1.9</td>\r
739 <td class="whs25">\r
740 <p>existence of dot</td>\r
741 <td class="whs25">\r
742 <p>add GraphViz's bin directory to the PATH environment variable</td>\r
743 <td class="whs25">\r
744 <p>Unfortunately we can't check the version number. <br>\r
745 We try to find dot program in the $PATH</td></tr>\r
746 \r
747 <tr>\r
748 <td class="whs25">\r
749 <p>MODULE binaries<br>\r
750 (MODULE=KERNEL,</p>\r
751 <p>GEOM, ...)</td>\r
752 <td class="whs25">\r
753 <p>existence of MODULE_ROOT_DIR <br>\r
754 existence of VERSION file <br>\r
755 ver=`cat $MODULE_ROOT_DIR/bin/salome/VERSION | awk -F: '{print $2}' | tr \r
756  -d '[:space:]'`</td>\r
757 <td class="whs25">\r
758 <p>set MODULE_ROOT_DIR if you have preinstalled binaries of MODULE version \r
759  1.4.x</td>\r
760 <td class="whs25">\r
761 <p>MODULE binaries should exist and ver should be equal to 1.4.x</td></tr>\r
762 \r
763 <tr>\r
764 <td class="whs25">\r
765 <p>MODULE sources<br>\r
766 (MODULE=KERNEL,</p>\r
767 <p>GEOM, ...)</td>\r
768 <td class="whs25">\r
769 <p>existence of MODULE_SRC_DIR <br>\r
770 existence of VERSION file <br>\r
771 ver=`cat $MODULE_SRC/bin/VERSION | awk -F: '{print $2}' | tr -d '[:space:]'`</td>\r
772 <td class="whs25">\r
773 <p>set MODULE_SRC_DIR if you have preinstalled sources of MODULE version \r
774  1.4.x</td>\r
775 <td class="whs25">\r
776 <p>MODULE sources should exist and ver should be equal to 1.4.x</td></tr>\r
777 </table>\r
778 \r
779 <p>&nbsp;</p>\r
780 \r
781 <p class="whs18"><b \r
782  style="font-weight: bold;"><img src="../note1.gif" x-maintain-ratio="TRUE" width="36px" height="38px" border="0" class="img_whs19"></b> For native products installation \r
783  procedure sets proper environment variables itself, and you do not need \r
784  to set such variables like, e.g. <b>TCLHOME</b> or <b>PYTHONHOME</b>. \r
785  <br>\r
786 If you have native products installed to different from default directories \r
787  (not <b>/usr/bin</b>, <b>/usr/lib</b>...), it is recommended to follow \r
788  above description. Or you should set properly $PATH and $LD_LIBRARY_PATH \r
789  variables <b><font style="color: #ff0000;"\r
790                                         color=#FF0000>before</font></b> starting Installation \r
791  Wizard. Otherwise installation script will fail to find preinstalled products. \r
792  </p>\r
793 \r
794 \r
795 <hr class="whs2">\r
796 \r
797 \r
798 <h3><a name=pick_up_env></a>Pick up the <font style="color: #ff0000;"\r
799                                                                                                 color=#FF0000>environment</font></h3>\r
800 \r
801 <p>Please, read carefully the following information. This section describes \r
802  how the installation procedure collects environment. </p>\r
803 \r
804 <p>After installing each product shell script creates in the product root \r
805  folder special environment file. The name of the file is generated from \r
806  the name of product by the following scheme: <b>env_&lt;product_name&gt;.sh.</b> \r
807  This file includes all necessary product settings. For example for Vtk \r
808  the file is <b>env_Vtk.sh</b>. Environment files allows to pick up all \r
809  environment settings which are necessary to build and launch SALOME. When \r
810  installing SALOME sources and/or binaries, installation procedure picks \r
811  up all the settings files and generate two scripts: <b>salome.sh</b> and \r
812  <b>salome.csh </b>for sh and csh correspondingly. Such approach helps \r
813  to save time when reinstalling products and you may not to care about \r
814  setting all environment variables manually to build/launch SALOME. What \r
815  you need is just to use one of these scripts. </p>\r
816 \r
817 <p>This concerns also those products which are not currently installed. \r
818  For example, you install some SALOME binaries to the directory where you \r
819  have previously installed other products.&nbsp; Installation procedure \r
820  still tries to collect environment files from the target directory if \r
821  it find necessary products there. If some product is not found in the \r
822  target directory the corresponding section of <b>salome.sh/salome.csh</b> \r
823  files will be skipped. <br>\r
824 For native products (<i><b>gcc, tcl, python, qt, sip, pyqt </b>for RedHat-8.0<b>)</b></i> \r
825  instal script tries to find them using <b>$PATH</b> / <b>$LD_LIBRARY_PATH</b> \r
826  variables and then in the system default directories (<b>/usr/bin, /usr/lib</b> \r
827  etc., depending on the product). </p>\r
828 \r
829 <p>In any case you may edit <b>salome.*</b> files after installation procedure \r
830  finishes, as you want. </p>\r
831 \r
832 \r
833 <hr class="whs2">\r
834 \r
835 \r
836 <h3><a name=xml_files></a>Modifying <font style="color: #ff0000;"\r
837                                                                                         color=#FF0000>XML</font> configuration \r
838  <font style="color: #ff0000;"\r
839                 color=#FF0000>file</font></h3>\r
840 \r
841 <p>You can create your own configuration. Installation Wizard then can \r
842  take it as command line argument to provide list of products you want \r
843  to install with it. The list of products and some another settings for \r
844  the Installation Wizard are provided in xml file. The default file which \r
845  Installation Wizard looks for if no command line arguments ar given, is \r
846  <b>config.xml</b>. This section describes the format of configuration \r
847  file. <br>\r
848 Xml tags are in bold blue, optional sections/tags are in brackets. </p>\r
849 \r
850 <p>&nbsp;</p>\r
851 \r
852 <p><b style="font-weight: bold;"><font style="color: #000099;"\r
853                                                                                 color=#000099>&lt;document&gt;</font></b> \r
854  <font style="color: #000000;"\r
855                 color=#000000><b><br>\r
856 &nbsp;&nbsp;&nbsp; </b>[</font><b><font style="color: #000099;"\r
857                                                                                 color=#000099>&lt;config</font></b><font \r
858  style="color: #000000;"\r
859         color=#000000> [version=&lt;install_wizard_version&gt;]</font> <font \r
860  style="color: #000000;"\r
861         color=#000000><br>\r
862 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
863  [caption=&lt;install_wizard_caption&gt;]</font> <font style="color: #000000;"\r
864                                                                                                                 color=#000000><br>\r
865 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
866  [copyright=&lt;install_wizard_copyright&gt;]</font> <font style="color: #000000;"\r
867                                                                                                                         color=#000000><br>\r
868 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
869  [license=&lt;install_wizard_license_info&gt;]</font> <font style="color: #000000;"\r
870                                                                                                                         color=#000000><br>\r
871 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
872  [os=&lt;target_paltform&gt;]</font><b><font style="color: #000099;"\r
873                                                                                         color=#000099>/&gt;</font></b><font \r
874  style="color: #000000;"\r
875         color=#000000>]</font> <font style="color: #000000;"\r
876                                                                 color=#000000><b><br>\r
877 &nbsp;&nbsp;&nbsp; </b>[</font><b><font style="color: #000099;"\r
878                                                                                 color=#000099>&lt;path</font></b><font \r
879  style="color: #000000;"\r
880         color=#000000> [targetdir=&lt;target_directory&gt;]</font> <font style="color: #000000;"\r
881         color=#000000><br>\r
882 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
883  [tempdir=&lt;temp_directory&gt;]</font><b><font style="color: #000099;"\r
884                                                                                                 color=#000099>/&gt;</font></b><font \r
885  style="color: #000000;"\r
886         color=#000000>]</font> <font style="color: #000000;"\r
887                                                                 color=#000000><br>\r
888 &nbsp;&nbsp;&nbsp; [</font><b><font style="color: #000099;"\r
889                                                                         color=#000099>&lt;product</font></b><font \r
890  style="color: #000000;"\r
891         color=#000000> name=&lt;product_name&gt;</font> <font style="color: #000000;"\r
892                                                                                                                         color=#000000><br>\r
893 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
894  version=&lt;product_version&gt;</font> <br>\r
895 &nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; \r
896  &nbsp;&nbsp; &nbsp;&nbsp; [description=&lt;product_description&gt;]<font \r
897  style="color: #000000;"\r
898         color=#000000><br>\r
899 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
900  install=&lt;installation_mode&gt;</font> <font style="color: #000000;"\r
901                                                                                                 color=#000000><br>\r
902 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
903  supported=&lt;supported_installation_modes&gt;</font> <font style="color: #000000;"\r
904                                                                                                                         color=#000000><br>\r
905 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
906  disable=&lt;disable_flag&gt;<br>\r
907 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; \r
908  [pickupenv=&lt;pickup_env_flag&gt;]</font><font style="color: #000000;"\r
909                                                                                                 color=#000000><br>\r
910 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
911  dependancies=&lt;list_of_prerequisites&gt;</font>&nbsp;<font style="color: #000000;"\r
912         color=#000000><br>\r
913 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
914  &nbsp;installdiskspace=&lt;install_disk_space&gt;</font> <font style="color: #000000;"\r
915         color=#000000><br>\r
916 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
917  &nbsp;temporarydiskspace=&lt;tmp_disk_space&gt;</font> <font style="color: #000000;"\r
918         color=#000000><br>\r
919 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
920  &nbsp;script=&lt;installation_script_name&gt;</font><font style="color: #000099;"\r
921                                                                                                                         color=#000099>/<b>&gt;</b></font><font \r
922  style="color: #000000;"\r
923         color=#000000>]</font> <font style="color: #000000;"\r
924                                                                 color=#000000><br>\r
925 &nbsp;&nbsp;&nbsp; [</font><b><font style="color: #000099;"\r
926                                                                         color=#000099>&lt;product</font></b><font \r
927  style="color: #000000;"\r
928         color=#000000> ... </font><font style="color: #000099;"\r
929                                                                         color=#000099>/<b>&gt;</b></font><font \r
930  style="color: #000000;"\r
931         color=#000000>]</font> <font style="color: #000000;"\r
932                                                                 color=#000000><br>\r
933 &nbsp;&nbsp;&nbsp;<b> .</b></font><b><font style="color: #000099;"\r
934                                                                                         color=#000099>..</font></b> \r
935  <b><font style="color: #000099;"\r
936                         color=#000099><br>\r
937 &lt;/document&gt;</font></b> </p>\r
938 \r
939 <h4><font style="color: #000000;"\r
940                         color=#000000>&lt;config&gt; section</font></h4>\r
941 \r
942 <p><font style="color: #000000;"\r
943                 color=#000000>This is optional section - contains general information \r
944  Installation Wizard itself.</font> </p>\r
945 \r
946 <ul>\r
947         \r
948         <li style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
949                 class=kadov-p><p><font style="color: #000000;"\r
950                                                                 color=#000000><b style="font-weight: bold;">version</b>: \r
951  Installation Wizard's version number;</font></p></li>\r
952         \r
953         <li style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
954                 class=kadov-p><p><font style="color: #000000;"\r
955                                                                 color=#000000><b style="font-weight: bold;">caption</b>: \r
956  Installation Wizard's main window title - if this string contains '%1' \r
957  text - the title will contain in this place version number (see above);</font></p></li>\r
958         \r
959         <li style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
960                 class=kadov-p><p><font style="color: #000000;"\r
961                                                                 color=#000000><b style="font-weight: bold;">copyright</b>: \r
962  Installation Wizard's copyright information (appears on the first page \r
963  of program);</font></p></li>\r
964         \r
965         <li style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
966                 class=kadov-p><p><font style="color: #000000;"\r
967                                                                 color=#000000><b style="font-weight: bold;">license</b>: \r
968  Installation Wizard's license information (appears on the first page of \r
969  program);</font></p></li>\r
970         \r
971         <li class=kadov-p><p><b style="font-weight: bold;">os</b>: Contains \r
972  directory name (relative from ./Products/BINARIES) where Installation \r
973  Wizard should search precompiled binaries packages. If this tag is skipped, \r
974  binaries are implied to be in the ./Products/BINARIES directory.</p></li>\r
975 </ul>\r
976 \r
977 <p>&nbsp;</p>\r
978 \r
979 <p><b style="font-weight: bold;">&lt;path&gt; section</b></p>\r
980 \r
981 <p>&nbsp;</p>\r
982 \r
983 <p>This is optional section - contains default directories. </p>\r
984 \r
985 <p>&nbsp;</p>\r
986 \r
987 <ul>\r
988         \r
989         <li style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
990                 class=kadov-p><p><font style="color: #000000;"\r
991                                                                 color=#000000><b style="font-weight: bold;">targetdir</b>: \r
992  Starting target directory - path to the directory where products should \r
993  be installed;</font></p></li>\r
994         \r
995         <li class=kadov-p><p><b style="font-weight: bold;">tempdir</b>: Starting \r
996  temp directory - path to the directory for the temporary files.</p></li>\r
997 </ul>\r
998 \r
999 <p>&nbsp;</p>\r
1000 \r
1001 <p><b style="font-weight: bold;">&lt;product&gt; section</b></p>\r
1002 \r
1003 <p>&nbsp;</p>\r
1004 \r
1005 <p>This section describes product to be installed with the Installation \r
1006  Wizard. All tags are obligatory. Products appears in the products tree \r
1007  and are installed in the order they are described in the configuration \r
1008  file. It is recommended to insert native products at the top of the list \r
1009  before all other products. </p>\r
1010 \r
1011 &nbsp;<br>\r
1012 \r
1013 <ul>\r
1014         \r
1015         <li class=kadov-p\r
1016                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1017                 class=kadov-p><font style="color: #000000;"\r
1018                                                         color=#000000><b style="font-weight: bold;">name</b>: \r
1019  Name of the product;</font></li>\r
1020         \r
1021         <li class=kadov-p\r
1022                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1023                 class=kadov-p><font style="color: #000000;"\r
1024                                                         color=#000000><b style="font-weight: bold;">version</b>: \r
1025  Version of the product;</font></li>\r
1026         \r
1027         <li class=kadov-p\r
1028                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1029                 class=kadov-p><font style="color: #000000;"\r
1030                                                         color=#000000><span style="font-weight: bold;"><B>description</B></span>: \r
1031  Description of the product (optional);</font></li>\r
1032         \r
1033         <li class=kadov-p\r
1034                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1035                 class=kadov-p><font style="color: #000000;"\r
1036                                                         color=#000000><b style="font-weight: bold;">supported</b>: \r
1037  Supported modes of installation, should contain one or more of the following \r
1038  options, separated by comma: <i>install sources</i>, <i>install binaries</i>, \r
1039  <i>use native</i>. Installation script should contain corresponding functions \r
1040  for each of supported installation modes;</font></li>\r
1041         \r
1042         <li class=kadov-p\r
1043                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1044                 class=kadov-p><font style="color: #000000;"\r
1045                                                         color=#000000><b style="font-weight: bold;">install</b>: \r
1046  Default (starting) installation mode;</font></li>\r
1047         \r
1048         <li class=kadov-p\r
1049                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1050                 class=kadov-p><font style="color: #000000;"\r
1051                                                         color=#000000><b style="font-weight: bold;">disable</b>: \r
1052  If this flag has 'true' value, corresponding product will not appear in \r
1053  the list of products tree and will not be installed;</font></li>\r
1054         \r
1055         <li class=kadov-p\r
1056                 class=kadov-p><b style="font-weight: bold;">pickupenv</b>: This \r
1057  flag points that pickup environment procedure should be performed for \r
1058  this module. If this flag equal to <b>true</b>, &nbsp;salome.sh and salome.csh \r
1059  files will&nbsp; be created in the product's installation directory. This \r
1060  is optional key, default value is <b>false.</b></li>\r
1061         \r
1062         <li class=kadov-p\r
1063                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1064                 class=kadov-p><font style="color: #000000;"\r
1065                                                         color=#000000><b style="font-weight: bold;">dependancies</b>: \r
1066  list of prerequisite products, which are necessary to build this product, \r
1067  separated by comma;</font></li>\r
1068         \r
1069         <li class=kadov-p\r
1070                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1071                 class=kadov-p><font style="color: #000000;"\r
1072                                                         color=#000000><b style="font-weight: bold;">installdiskspace</b>: \r
1073  Total amount space (integer, in Kbytes), which product occupies on the \r
1074  hard drive after the installation;</font></li>\r
1075         \r
1076         <li class=kadov-p\r
1077                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1078                 class=kadov-p><font style="color: #000000;"\r
1079                                                         color=#000000><b style="font-weight: bold;">temporarydiskspace</b>: \r
1080  Disk space (integer, in Kbytes) for the temporary files, which is necessary \r
1081  to build the product from the sources;</font></li>\r
1082         \r
1083         <li class=kadov-p\r
1084                 class=kadov-p><b style="font-weight: bold;">script</b>: Installation \r
1085  script name. This script is in charge of installation of the product. \r
1086  It is called when necessary from the main program. See <a href="#new_products">next \r
1087  section</a> for more information.</li>\r
1088 </ul>\r
1089 \r
1090 &nbsp; \r
1091 \r
1092 <p class="whs18"><span \r
1093  style="font-weight: bold;"><B><img src="../note1.gif" x-maintain-ratio="TRUE" width="36px" height="38px" border="0" class="img_whs19"></B></span> If you add new products \r
1094  to be installed with Installation Wizard, you should also provide installation \r
1095  script for this product. See next section for more details. </p>\r
1096 \r
1097 \r
1098 <hr class="whs2">\r
1099 \r
1100 \r
1101 <h3><a name=new_products></a>Implementing <font style="color: #ff0000;"\r
1102                                                                                                 color=#FF0000>installation \r
1103  scripts</font> for the new products</h3>\r
1104 \r
1105 <p>When you want some product to be installed with the Installation Wizard, \r
1106  you should add it's description it <a href="#xml_files">in the configuration \r
1107  file</a> and create bash installation script, following described in this \r
1108  section rules. <br>\r
1109 There are some obligatory functions to be provided in this installation \r
1110  script. These functions are automatically called by master installation \r
1111  script or/and GUI shell when it is necessary.<br>\r
1112 File <b>common.sh</b> contains some service functions which can be used \r
1113  in your installation script, like <b>make_env()</b>,<b> make_dir()</b>, \r
1114  <b>try_existing()</b>, <b>sort_path()</b>,<b> find_in_path()</b>, etc. \r
1115  </p>\r
1116 \r
1117 &nbsp;<br>\r
1118 \r
1119 <ul>\r
1120         \r
1121         <li class=kadov-p\r
1122                 class=kadov-p><b style="font-weight: bold;">check_version()</b>:&nbsp; \r
1123  This function allows to check the version of the product already installed \r
1124  on the computer. It should try to find product (native or preinstalled \r
1125  in the target directory) and check it version. This helps to avoid unnecessary \r
1126  reinstallation. This is internal function and is not called</li>\r
1127         \r
1128         <li class=kadov-p\r
1129                 class=kadov-p><b style="font-weight: bold;"><font style="color: #000000;"\r
1130                                                                                                                         color=#000000>try_native()</font></b><font \r
1131  style="color: #000099;"\r
1132         color=#000099>: </font><font style="color: #000000;"\r
1133                                                                 color=#000000>This function is called when \r
1134  <i>'use native' </i>installation mode is selected by the user. The function \r
1135  should try to find native version of the product and define possibility \r
1136  of it usage. Should create environment for the product in the temporary \r
1137  directory (see also description of <b>print_env(</b>) function). If you \r
1138  do not provide native mode installation, you can omit this function.</font></li>\r
1139         \r
1140         <li class=kadov-p\r
1141                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1142                 class=kadov-p><font style="color: #000000;"\r
1143                                                         color=#000000><b style="font-weight: bold;">install_source()</b>: \r
1144  This function is called when <i>'install sources</i>' installation mode \r
1145  is selected by the user. The function is responsible for the building \r
1146  of the product from the sources package. Should create environment for \r
1147  the product in the temporary directory (see also description of <b>print_env(</b>) \r
1148  function). If you do not provide sources mode installation, you can omit \r
1149  this function</font></li>\r
1150         \r
1151         <li class=kadov-p\r
1152                 style="/*begin!kadov{{*/ color: #000000; /*}}end!kadov*/ "\r
1153                 class=kadov-p><font style="color: #000000;"\r
1154                                                         color=#000000><b style="font-weight: bold;">install_binary()</b>: \r
1155  This function is called when <i>'install binaries'</i> installation mode \r
1156  is selected by the user. The function is responsible for the extracting \r
1157  of the product from the binaries package. Should create environment for \r
1158  the product in the temporary directory (see also description of <b>print_env(</b>) \r
1159  function). If you do not provide binaries mode installation, you can omit \r
1160  this function.</font></li>\r
1161         \r
1162         <li class=kadov-p\r
1163                 class=kadov-p><b style="font-weight: bold;">try_preinstalled()</b>: \r
1164  <font style="color: #000000;"\r
1165                 color=#000000>This function is called when<i> 'not install'</i> \r
1166  installation mode is selected by the user. In this case script should \r
1167  inspect target directory to try to find already preinstalled product, \r
1168  pick up and check environment from there. See <a href="#pick_up_env">here</a> \r
1169  for more details.</font></li>\r
1170         \r
1171         <li class=kadov-p\r
1172                 class=kadov-p><font style="color: #000000;"\r
1173                                                         color=#000000><b style="font-weight: bold;">print_env()</b>: \r
1174  This function is in charge of creation environment script. It should create \r
1175  file with name </font><b>env_&lt;product_name&gt;.sh</b> in the temporary \r
1176  directory and then copy it into the product installation directory. The \r
1177  file should contain all necessary environment variables settings for the \r
1178  product. It will be collected during the 'pick-up-environment' procedure.</li>\r
1179         \r
1180         <li class=kadov-p\r
1181                 class=kadov-p><b style="font-weight: bold;">pickup-env()</b>: This \r
1182  procedure corresponds <b>pickupenv</b> tag of the configuration xml file \r
1183  (see previous section). Should call <b>make_env</b> procedure to perform \r
1184  pick-up environment procedure for the product.</li>\r
1185 </ul>\r
1186 \r
1187 &nbsp; \r
1188 \r
1189 <p><font style="color: #000000;"\r
1190                 color=#000000>The calling signature of the product installation \r
1191  script is following:</font> <b><font style="color: #000000;"\r
1192                                                                                 color=#000000><br>\r
1193 &lt;product_script_name&gt; &lt;function_name&gt; &lt;temp_folder&gt; &lt;products_directory&gt; \r
1194  &lt;target_directory&gt; &lt;dependancies&gt; &lt;product_name&gt;</font></b> \r
1195  </p>\r
1196 \r
1197 <p><font style="color: #000000;"\r
1198                 color=#000000>where</font> <font style="color: #000000;"\r
1199                                                                                 color=#000000><b><br>\r
1200 &lt;product_script_name&gt;</b> - installation script name (described in \r
1201  configuration xml file);</font> <font style="color: #000000;"\r
1202                                                                                 color=#000000><b><br>\r
1203 &lt;function_name&gt;</b> - the name of function, corresponding to the \r
1204  selected installation mode: <i>try_native, install_source, install_binary</i> \r
1205  or <i>try_preinstalled</i>;</font> <font style="color: #000000;"\r
1206                                                                                         color=#000000><b><br>\r
1207 &lt;temp_folder&gt;</b> - temporary files directory;</font> <font style="color: #000000;"\r
1208         color=#000000><b><br>\r
1209 &lt;products_directory&gt;</b> - directory where the sources/binaries package \r
1210  can be found. You should provide sources package in the <i>&lt;Install_Wizard_root_directory&gt;/Products/SOURCES</i> \r
1211  directory and binaries package&nbsp; in the <i>&lt;InstallWizard_root_directory&gt;/Products/BINARIES/&lt;os_version&gt;</i>, \r
1212  where &lt;os_version&gt; is target platform description, which appears \r
1213  in the corresponding section of the <a href="#xml_files">configuration \r
1214  xml file</a>.</font> <font style="color: #000000;"\r
1215                                                         color=#000000><b><br>\r
1216 &lt;target_directory&gt;</b> - root target directory where product should \r
1217  be installed to;</font> <font style="color: #000000;"\r
1218                                                                 color=#000000><b><br>\r
1219 &lt;dependancies&gt;</b> - single-quoted list of prerequisite products, \r
1220  separated by space;</font> <font style="color: #000000;"\r
1221                                                                         color=#000000><b><br>\r
1222 &lt;product_name&gt; </b>- product name itself.</font> </p>\r
1223 \r
1224 <p>&nbsp;</p>\r
1225 \r
1226 <p class="whs18"><i><img src="../pics/exemple.gif" x-maintain-ratio="TRUE" width="36px" height="38px" border="0" class="img_whs28">med-2.1.6.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0 \r
1227  /usr/salome 'gcc Hdf' med</i> </p>\r
1228 \r
1229 <p class="whs18"><font \r
1230  style="color: #000000;"\r
1231         color=#000000>Copy created script into the <i>&lt;Install_Wizard_root_directory&gt;/config_files</i> \r
1232  sub-directory where all installation scripts are stored. Installation \r
1233  Wizard will automatically search and call your script during the installation \r
1234  procedure.</font> </p>\r
1235 \r
1236 \r
1237 <hr class="whs2">\r
1238 \r
1239 \r
1240 &nbsp; \r
1241 \r
1242 <br>&nbsp; \r
1243  \r
1244 \r
1245 <script type="text/javascript" language="javascript1.2">\r
1246 <!--\r
1247 if (window.writeIntopicBar)\r
1248         writeIntopicBar(0);\r
1249 //-->\r
1250 </script>\r
1251 </body>\r
1252 </html>\r