Salome HOME
Join modifications from BR_Dev_For_4_0 tag V4_1_1.
[modules/gui.git] / doc / salome / gui / GUI / kernel / running_salome_pro.htm
1 <!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">\r
2 \r
3 <html>\r
4 \r
5 <head>\r
6 <title>Running SALOME</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 type="text/css">\r
16 <!--\r
17 h1.whs1 { font-family:'Times New Roman' , serif; }\r
18 p.whs2 { margin-left:0px; font-style:italic; color:#000000; font-family:'Arial Black' , sans-serif; }\r
19 p.whs3 { font-family:'Times New Roman' , serif; margin-left:0px; }\r
20 p.whs4 { font-family:'Times New Roman' , serif; margin-left:40px; font-style:normal; color:#000000; }\r
21 p.whs5 { font-family:'Times New Roman' , serif; color:#ff0000; font-style:italic; margin-left:40px; }\r
22 p.whs6 { font-family:'Times New Roman' , serif; margin-left:40px; color:#000000; font-style:normal; }\r
23 p.whs7 { font-family:'Courier New'  , monospace; margin-left:0px; background-image:url('../texture_horiz_ltbluebubbles.jpg'); }\r
24 img_whs8 { border:none; width:35px; height:37px; float:none; border-style:none; }\r
25 p.whs9 { margin-left:0px; }\r
26 p.whs10 { margin-left:40px; }\r
27 p.whs11 { margin-left:40px; font-style:normal; color:#000000; font-weight:normal; font-family:'Times New Roman' , serif; }\r
28 ul.whs12 { list-style:disc; }\r
29 table.whs13 { x-cell-content-align:top; width:96.029%; 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; border-spacing:0px; }\r
30 col.whs14 { width:645px; }\r
31 col.whs15 { width:421px; }\r
32 tr.whs16 { x-cell-content-align:top; height:41px; }\r
33 td.whs17 { width:645px; padding-right:10px; padding-left:10px; background-color:#400080; 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
34 p.whs18 { color:#ffffff; }\r
35 td.whs19 { width:421px; padding-right:10px; padding-left:10px; background-color:#400080; 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
36 td.whs20 { width:645px; 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
37 td.whs21 { width:421px; 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
38 p.whs22 { font-weight:bold; }\r
39 td.whs23 { width:645px; 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
40 td.whs24 { width:421px; 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
41 td.whs25 { width:645px; padding-right:10px; padding-left:10px; border-left-style:Solid; border-left-width:1px; border-left-color:#c0c0c0; border-right-style:Solid; border-right-width:1px; border-right-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; border-bottom-color:#c0c0c0; }\r
42 td.whs26 { width:421px; padding-right:10px; padding-left:10px; border-right-width:1px; border-right-style:Solid; border-right-color:#c0c0c0; border-bottom-width:1px; border-bottom-style:Solid; border-bottom-color:#c0c0c0; }\r
43 td.whs27 { width:645px; padding-right:10px; padding-left:10px; border-left-color:#c0c0c0; border-left-width:1px; border-left-style:Solid; border-right-color:#c0c0c0; border-right-width:1px; border-right-style:Solid; border-bottom-color:#c0c0c0; border-bottom-style:Solid; border-bottom-width:1px; }\r
44 td.whs28 { width:421px; padding-right:10px; padding-left:10px; border-right-color:#c0c0c0; border-right-style:Solid; border-right-width:1px; border-bottom-color:#c0c0c0; border-bottom-style:Solid; border-bottom-width:1px; }\r
45 p.whs29 { font-weight:bold; margin-left:0px; font-family:'Courier New'  , monospace; background-image:url('../texture_horiz_ltbluebubbles.jpg'); }\r
46 p.whs30 { font-family:'Times New Roman' , serif; margin-left:80px; }\r
47 p.whs31 { font-family:'Courier New' , monospace; margin-left:0px; }\r
48 -->\r
49 </style><script type="text/javascript" language="JavaScript">\r
50 <!--\r
51 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4))\r
52 {\r
53   var strNSS = "<style type='text/css'>";\r
54   strNSS += "p.whs2 {margin-left:1pt; }";\r
55   strNSS += "p.whs3 {margin-left:1pt; }";\r
56   strNSS += "p.whs7 {margin-left:1pt; }";\r
57   strNSS += "p.whs9 {margin-left:1pt; }";\r
58   strNSS += "p.whs29 {margin-left:1pt; }";\r
59   strNSS += "p.whs31 {margin-left:1pt; }";\r
60   strNSS +="</style>";\r
61   document.write(strNSS);\r
62 }\r
63 //-->\r
64 </script>\r
65 <script type="text/javascript" language="JavaScript" title="BSSC Special Effects" src="../ehlpdhtm.js"></script><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
66 <!--\r
67 function reDo() {\r
68   if (innerWidth != origWidth || innerHeight != origHeight)\r
69      location.reload();\r
70 }\r
71 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
72         origWidth = innerWidth;\r
73         origHeight = innerHeight;\r
74         onresize = reDo;\r
75 }\r
76 onerror = null; \r
77 //-->\r
78 </script>\r
79 <style type="text/css">\r
80 <!--\r
81 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
82 p.WebHelpNavBar { text-align:right; }\r
83 -->\r
84 </style><script type="text/javascript" language="javascript1.2" src="../whmsg.js"></script>\r
85 <script type="text/javascript" language="javascript" src="../whver.js"></script>\r
86 <script type="text/javascript" language="javascript1.2" src="../whproxy.js"></script>\r
87 <script type="text/javascript" language="javascript1.2" src="../whutils.js"></script>\r
88 <script type="text/javascript" language="javascript1.2" src="../whtopic.js"></script>\r
89 <script type="text/javascript" language="javascript1.2">\r
90 <!--\r
91 if (window.gbWhTopic)\r
92 {\r
93         if (window.setRelStartPage)\r
94         {\r
95         addTocInfo("About SALOME\nRunning SALOME");\r
96 addButton("show",BTN_IMG,"Show","","","","",0,0,"../whd_show0.gif","../whd_show2.gif","../whd_show1.gif");\r
97 addButton("hide",BTN_IMG,"Hide","","","","",0,0,"../whd_hide0.gif","../whd_hide2.gif","../whd_hide1.gif");\r
98 \r
99         }\r
100 \r
101 \r
102         if (window.setRelStartPage)\r
103         {\r
104         setRelStartPage("../index.htm");\r
105 \r
106                 autoSync(1);\r
107                 sendSyncInfo();\r
108                 sendAveInfoOut();\r
109         }\r
110 \r
111 }\r
112 else\r
113         if (window.gbIE4)\r
114                 document.location.reload();\r
115 //-->\r
116 </script>\r
117 </head>\r
118 <body><script type="text/javascript" language="javascript1.2">\r
119 <!--\r
120 if (window.writeIntopicBar)\r
121         writeIntopicBar(4);\r
122 //-->\r
123 </script>\r
124 <h1 class="whs1">Running SALOME</h1>\r
125 \r
126 <p class="whs2">To launch SALOME:</p>\r
127 \r
128 <p class="whs3">&nbsp;</p>\r
129 \r
130 <p class="whs4">1. Install the SALOME package into a definite \r
131  directory (ex. <span style="font-weight: bold;"><B>SALOME</B></span>) on your \r
132  hard disk. It is preferable if you use the special installation procedure \r
133  allowing to install the &nbsp;SALOME \r
134  platform and all corresponding applications. </p>\r
135 \r
136 <p class="whs5">&nbsp;</p>\r
137 \r
138 <p class="whs6">2.<span style="font-family: 'Courier New', monospace;"> \r
139  </span>The installation shell script will create a special file: <b>salome.csh</b> \r
140  (CShell file) in your <b><i><span style="font-style: normal; font-weight: bold;"><B>SALOME/KERNEL</B></span><span \r
141  style="font-weight: normal; font-style: normal;"> </span></i></b>directory. \r
142  This file contains all environment variables necessary for launching SALOME \r
143  platform with other application products provided with SALOME installation \r
144  package. You have a possibility to add one of them into your profile if \r
145  you enter in the command console the following:</p>\r
146 \r
147 <p class="whs6">&nbsp;</p>\r
148 \r
149 <p class="whs6"><span style="font-family: 'Courier New', monospace;">source \r
150  salome.csh </span></p>\r
151 \r
152 <p class="whs6">&nbsp;</p>\r
153 \r
154 <p class="whs7"><img src="../tip1.gif" x-maintain-ratio="TRUE" width="35px" height="37px" border="0" class="img_whs8"> <span style="font-family: 'Times New Roman', serif;">During \r
155  the installation procedure you have a possibility to set your profile \r
156  automatically. </span>&nbsp;</p>\r
157 \r
158 <p class="whs9">&nbsp;</p>\r
159 \r
160 <p>&nbsp;</p>\r
161 \r
162 <p class="whs10">3. Launch SALOME platform, using the following \r
163  Python script located in the <span style="font-weight: bold;"><B>SALOME/KERNEL/bin/salome</B></span> \r
164  directory:</p>\r
165 \r
166 <p class="whs11">&nbsp;</p>\r
167 \r
168 <ul type="disc" class="whs12">\r
169         \r
170         <li class=kadov-p><p class="whs10"><span style="font-weight: bold;"><B>runSalome.py</B></span> \r
171  [command line options]</p></li>\r
172 </ul>\r
173 \r
174 <p class="whs10">&nbsp;</p>\r
175 \r
176 <table x-use-null-cells resizable="no" cellspacing="0" width="96.029%" class="whs13">\r
177 <script language='JavaScript'><!--\r
178 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4)) document.write("</table><table x-use-null-cells resizable='no' cellspacing='0' width='96.029%' border='1' bordercolor='silver' bordercolorlight='silver' bordercolordark='silver'>");\r
179 //--></script>\r
180 <col class="whs14">\r
181 <col class="whs15">\r
182 \r
183 <tr valign="top" class="whs16">\r
184 <td bgcolor="#400080" width="645px" class="whs17">\r
185 <p class="whs18">Options</td>\r
186 <td bgcolor="#400080" width="421px" class="whs19">\r
187 <p class="whs18">Description</td></tr>\r
188 \r
189 <tr valign="top" class="whs16">\r
190 <td width="645px" class="whs20">\r
191 <p><span style="font-weight: bold;"><B>--help</B></span> <span style="font-style: italic;"><I>or</I></span> \r
192  <span style="font-weight: bold;"><B>-h</B></span> &nbsp;&nbsp;</td>\r
193 <td width="421px" class="whs21">\r
194 <p>print this help</p>\r
195 <p>&nbsp;</td></tr>\r
196 \r
197 <tr valign="top" class="whs16">\r
198 <td width="645px" class="whs20">\r
199 <p><span style="font-weight: bold;"><B>--gui</B></span> <span style="font-style: italic;"><I>or</I></span> \r
200  <span style="font-weight: bold;"><B>-g</B></span> &nbsp;&nbsp;</td>\r
201 <td width="421px" class="whs21">\r
202 <p>launch with GUI</td></tr>\r
203 \r
204 <tr valign="top" class="whs16">\r
205 <td width="645px" class="whs20">\r
206 <p>&nbsp;<span style="font-weight: bold;"><B><a \r
207  name=batchmode></a>--terminal</B></span> <span style="font-style: italic;"><I>or \r
208  </I></span><span style="font-weight: bold;"><B>-t</B></span> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>\r
209 <td width="421px" class="whs21">\r
210 <p>launch without GUI in batch mode</td></tr>\r
211 \r
212 <tr valign="top" class="whs16">\r
213 <td colspan="1" rowspan="1" width="645px" class="whs20">\r
214 <p><span style="font-weight: bold;"><B>--logger</B></span> <span style="font-style: italic;"><I>or</I></span> \r
215  <span style="font-weight: bold;"><B>-l</B></span> &nbsp;&nbsp;</td>\r
216 <td colspan="1" rowspan="1" width="421px" class="whs21">\r
217 <p>redirects &nbsp;log \r
218  messages in the file <span style="font-style: italic;"><I>logger.log</I></span></td></tr>\r
219 \r
220 <tr valign="top" class="whs16">\r
221 <td colspan="1" rowspan="1" width="645px" class="whs20">\r
222 <p class="whs22">--file=&lt;FILE&gt; <span style="font-weight: normal; font-style: italic;"><I>or</I></span> \r
223  -f=&lt;FILE&gt;</td>\r
224 <td colspan="1" rowspan="1" width="421px" class="whs21">\r
225 <p>redirects &nbsp;log \r
226  messages in a custom file</td></tr>\r
227 \r
228 <tr valign="top" class="whs16">\r
229 <td colspan="1" rowspan="1" width="645px" class="whs20">\r
230 <p><span style="font-weight: bold;"><B>--xterm</B></span> <span style="font-style: italic;"><I>or</I></span> \r
231  <span style="font-weight: bold;"><B>-x</B></span> </td>\r
232 <td colspan="1" rowspan="1" width="421px" class="whs21">\r
233 <p>the servers open an xterm window and log messages are displayed in this \r
234  window</td></tr>\r
235 \r
236 <tr valign="top" class="whs16">\r
237 <td colspan="1" rowspan="1" width="645px" class="whs20">\r
238 <p><span style="font-weight: bold;"><B>--modules=module1,module2,...</B></span> \r
239  <span style="font-style: italic;"><I>or</I></span> <span style="font-weight: bold;"><B>-m=module1,module2,...</B></span></td>\r
240 <td colspan="1" rowspan="1" width="421px" class="whs21">\r
241 <p>list of SALOME modules which will be loaded into the module catalogue</td></tr>\r
242 \r
243 <tr valign="top" class="whs16">\r
244 <td colspan="1" rowspan="1" width="645px" class="whs23">\r
245 <p class="whs22">--embedded=registry,study,moduleCatalog,cppContainer,</p>\r
246 <p><span style="font-style: italic;"><I>or</I></span> &nbsp;<span \r
247  style="font-weight: bold;"><B>-e=registry,study,moduleCatalog,cppContainer</B></span> \r
248  </td>\r
249 <td colspan="1" rowspan="1" width="421px" class="whs24">\r
250 <p>embedded CORBA servers (default: registry,study,moduleCatalog,cppContainer)</p>\r
251 <p>note that logger,pyContainer,supervContainer can't be embedded </td></tr>\r
252 \r
253 <tr valign="top" class="whs16">\r
254 <td colspan="1" rowspan="1" width="645px" class="whs23">\r
255 <p><span style="font-weight: bold;"><B>--standalone=registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer</B></span>, \r
256  or</p>\r
257 <p><span style="font-weight: bold;"><B>-s=registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer</B></span> \r
258  </td>\r
259 <td colspan="1" rowspan="1" width="421px" class="whs24">\r
260 <p>standalone CORBA servers (default: pyContainer,supervContainer) </td></tr>\r
261 \r
262 <tr valign="top" class="whs16">\r
263 <td colspan="1" rowspan="1" width="645px" class="whs23">\r
264 <p><span style="font-weight: bold;"><B>--containers=cpp,python,superv</B></span></p>\r
265 <p><span style="font-style: italic;"><I>or</I></span> <span style="font-weight: bold;"><B>-c=cpp,python,superv</B></span></td>\r
266 <td colspan="1" rowspan="1" width="421px" class="whs24">\r
267 <p>launch of cpp, python and supervision containers</td></tr>\r
268 \r
269 <tr valign="top" class="whs16">\r
270 <td colspan="1" rowspan="1" width="645px" class="whs25">\r
271 <p><span style="font-weight: bold;"><B>--portkill</B></span> <span style="font-style: italic;"><I>or</I></span> \r
272  <span style="font-weight: bold;"><B>-p</B></span></td>\r
273 <td colspan="1" rowspan="1" width="421px" class="whs26">\r
274 <p>kill SALOME launched with the current port</td></tr>\r
275 \r
276 <tr valign="top" class="whs16">\r
277 <td colspan="1" rowspan="1" width="645px" class="whs27">\r
278 <p><span style="font-weight: bold;"><B>--killall</B></span> <span style="font-style: italic;"><I>or</I></span> \r
279  <span style="font-weight: bold;"><B>-k</B></span> &nbsp;&nbsp;&nbsp;</p>\r
280 <p>&nbsp;</td>\r
281 <td colspan="1" rowspan="1" width="421px" class="whs28">\r
282 <p>kill SALOME</p>\r
283 <p>&nbsp;</td></tr>\r
284 \r
285 <tr valign="top" class="whs16">\r
286 <td colspan="1" rowspan="1" width="645px" class="whs27">\r
287 <p><span style="font-weight: bold;"><B>--interp=n</B></span> <span style="font-style: italic;"><I>or</I></span> \r
288  <span style="font-weight: bold;"><B>-i=n</B></span> &nbsp;&nbsp;&nbsp;</td>\r
289 <td colspan="1" rowspan="1" width="421px" class="whs28">\r
290 <p>number of additional xterm to open, with session environment </td></tr>\r
291 \r
292 <tr valign="top" class="whs16">\r
293 <td colspan="1" rowspan="1" width="645px" class="whs27">\r
294 <p class="whs22">-z</td>\r
295 <td colspan="1" rowspan="1" width="421px" class="whs28">\r
296 <p>display splash screen</td></tr>\r
297 \r
298 <tr valign="top" class="whs16">\r
299 <td colspan="1" rowspan="1" width="645px" class="whs27">\r
300 <p class="whs22">-r</td>\r
301 <td colspan="1" rowspan="1" width="421px" class="whs28">\r
302 <p>disable centralized exception handling mechanism </td></tr>\r
303 <script language='JavaScript'><!--\r
304 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4)) document.write("</table></table><table>");\r
305 //--></script>\r
306 </table>\r
307 \r
308 <p class="whs10">&nbsp;</p>\r
309 \r
310 <p class="whs29"><img src="../tip1.gif" x-maintain-ratio="TRUE" width="35px" height="37px" border="0" class="img_whs8"><span style="font-weight: normal; font-family: 'Times New Roman', serif;"> \r
311  If the </span><span style="font-family: 'Times New Roman', serif;">runSalome.py \r
312  </span><span style="font-family: 'Times New Roman', serif; font-weight: normal;">script \r
313  is launched without prompting any options, they will be taken by default \r
314  from the file </span><span style="font-family: 'Times New Roman', serif;">SalomeApp.xml \r
315  (SALOME/GUI/share/salome/resources/SalomeApp.xml)</span><span style="font-family: 'Times New Roman', serif; font-weight: normal;">. \r
316  If you are constantly launching SALOME with some specific options which \r
317  are different from the defaults, you can edit this file according to your \r
318  requirements. So the next time you run SALOME, you won't have to enter \r
319  these numerous command console options. </span>&nbsp;&nbsp;&nbsp;</p>\r
320 \r
321 <p class="whs30">&nbsp;</p>\r
322 \r
323 <p class="whs31">\r
324 <a href="javascript:void(0);" onClick="var e; if (parseInt(navigator.appVersion)>=4){e=event;}  if (parseInt(navigator.appVersion) >=2 && typeof(PickupDialog_Invoke) == 'function') PickupDialog_Invoke(e,'','About SALOME architecture','about_salome_pro_architecture.htm','Introduction to SALOME ','introduction_to_salome_pro.htm');return false;" title="Related Topics"><img src="../ss_btn_related_topics.gif" border=0 height=17 width=82 alt="Related Topics"></a>\r
325 \r
326  </p>\r
327 \r
328 <p class="whs31">&nbsp;</p>\r
329 \r
330 <p class="whs31">&nbsp;</p>\r
331 \r
332 <p class="whs31">&nbsp;</p>\r
333 \r
334 <script type="text/javascript" language="JavaScript" title="WebHelpRelatedTopics"><!--\r
335 if (parseInt(navigator.appVersion) >= 3 && typeof (WritePopupMenuLayer) == "function")\r
336   WritePopupMenuLayer();\r
337 //--></script><script type="text/javascript" language="javascript1.2">\r
338 <!--\r
339 if (window.writeIntopicBar)\r
340         writeIntopicBar(0);\r
341 //-->\r
342 </script>\r
343 </body>\r
344 </html>\r