doc/salome/gui/input/running_salome.doc

   1 /*!
   2
   3 \page running_salome_page Running SALOME
   4
   5 <em>To launch SALOME:</em>
   6 <ol>
   7 <li>Install the SALOME package into a definite directory (ex. \b SALOME)
   8 on your hard disk. It is preferable if you use the special
   9 installation procedure allowing to install the  SALOME platform and
  10 all corresponding applications.</li>
  11 <li>The installation shell script will create a special file:
  12 <b>salome.csh</b> (CShell file) in your SALOME/KERNEL directory. This file
  13 contains all environment variables necessary for launching SALOME
  14 platform with other application products provided with SALOME
  15 installation package. You have a possibility to add one of them into
  16 your profile if you enter in the command console the following: <br><br>
  17 <tt>source salome.csh</tt>
  18
  19 <b>Tip:</b> During the installation procedure you have a possibility to set your profile automatically.</li>
  20
  21 <li> Launch SALOME platform, using the following Python script located
  22 in the <b>SALOME/KERNEL/bin/salome</b> directory:<br><br>
  23 <ul>
  24 <li>\b runSalome.py [command line options]
  25 </ul>
  26 </li>
  27 </ol>
  28
  29 \anchor batch_mode_run
  30
  31 <table>
  32 <tr>
  33 <td><h2>Options</h2></td>
  34 <td><h2>Description</h2></td>
  35 </tr>
  36 <tr>
  37 <td>--\b help or -\b h</td>
  38 <td>print this help</td>
  39 </tr>
  40 <tr>
  41 <td>--\b gui or -\b g</td>
  42 <td>launch with GUI</td>
  43 </tr>
  44 <tr>
  45 <td> --\b terminal or -\b t</td>
  46 <td>launch without GUI in batch mode</td>
  47 </tr>
  48 <tr>
  49 <td>--\b logger or -\b l</td>
  50 <td>redirects log messages in the file <em>logger.log</em></td>
  51 </tr>
  52 <tr>
  53 <td>--\b file=<b>\<FILE\></b> or -\b f=<b>\<FILE\></b></td>
  54 <td>redirects  log messages in a custom file</td>
  55 </tr>
  56 <tr>
  57 <td>--\b xterm or -\b x</td>
  58 <td>the servers open an xterm window and log messages are displayed in this window</td>
  59 </tr>
  60 <tr>
  61 <td>--\b modules=\b module1,\b module2,... or -\b m=\b module1,\b module2,...</td>
  62 <td>list of SALOME modules which will be loaded into the module catalogue</td>
  63 </tr>
  64 <tr>
  65 <td>--\b embedded=<b>registry,study,moduleCatalog,cppContainer</b>,
  66 or -\b e=<b>registry,study,moduleCatalog,cppContainer</b></td>
  67 <td>embedded CORBA servers (default: registry,study,moduleCatalog,cppContainer)
  68 note that logger,pyContainer,supervContainer can't be embedded</td>
  69 </tr>
  70 <tr>
  71 <td>--\b standalone=<b>registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer</b>, or
  72 -\b s=<b>registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer</b></td>
  73 <td>standalone CORBA servers (default: pyContainer,supervContainer)</td>
  74 </tr>
  75 <tr>
  76 <td>--\b containers=<b>cpp,python,superv</b>
  77 or -\b c=<b>cpp,python,superv</b></td>
  78 <td>launch of cpp, python and supervision containers</td>
  79 </tr>
  80 <tr>
  81 <td>--\b portkill or -\b p</td>
  82 <td>kill SALOME launched with the current port</td>
  83 </tr>
  84 <tr>
  85 <td>--\b killall or -\b k</td>
  86 <td>kill SALOME</td>
  87 </tr>
  88 <tr>
  89 <td>--<b>interp</b>=<b>n</b> or -<b>i</b>=<b>n</b></td>
  90 <td>number of additional xterm to open, with session environment</td>
  91 </tr>
  92 <tr>
  93 <td>-\b z</td>
  94 <td>display splash screen</td>
  95 </tr>
  96 <tr>
  97 <td>-\b r</td>
  98 <td>disable centralized exception handling mechanism</td>
  99 </tr>
 100 </table>
 101
 102 <b>Tip:</b> If the \b runSalome.py script is launched without prompting
 103 any options, they will be taken by default from the file <b>SalomeApp.xml
 104 (SALOME/GUI/share/salome/resources/SalomeApp.xml)</b>. If you are
 105 constantly launching SALOME with some specific options which are
 106 different from the defaults, you can edit this file according to your
 107 requirements. So the next time you run SALOME, you won't have to enter
 108 these numerous command console options.
 109
 110 */