doc/salome/running_salome.dox

   1 /*!
   2
   3 \page running_salome_page Running Salome
   4
   5 There are two ways to run %SALOME:
   6
   7 1) Using <b>Salome Application Concept</b> approach.
   8
   9 For more details see \ref SALOME_Application.
  10
  11 2) Using <b>\c %runSalome</b> script supplied with %SALOME KERNEL module distribution.
  12
  13 To launch %SALOME using \c %runSalome script, you have first to
  14 set-up proper environment for %SALOME. If you installed %SALOME using
  15 %SALOME Installation Wizard (Linux), you can use \c salome.sh or
  16 \c salome.csh script (that is located in the \c KERNEL_&lt;version&gt;
  17 directory of your %SALOME installation), for example:
  18
  19 \code
  20 cd /home/user/salome_6.5.0/KERNEL_6.5.0
  21 source salome.csh
  22 \endcode
  23
  24 Launch %SALOME session using the \c %runSalome script located
  25 in the \c SALOME/KERNEL/bin/salome directory:
  26
  27 \code
  28 runSalome [options] [STUDY_FILE] [PYTHON_FILE [PYTHON_FILE ...]]
  29 \endcode
  30
  31 Optionally, you can specify in the command line:
  32 - Study (document) file to be opened in %SALOME session passing;
  33 - One or more Python scripts to be executed after %SALOME
  34   start-up. Python scripts will be executed in the new or opened study
  35   in the order they appear in the command line.
  36
  37 The \c %runSalome script supports large set of options that allow
  38 specifying the way to launch %SALOME session. Complete description of
  39 all options can be obtained using \c --help or -h option:
  40
  41 \code
  42 runSalome --help
  43 \endcode
  44
  45 Here below is a description of most important options:
  46
  47 - \c --help or \c -h
  48
  49 Print detail help information on the \c %runSalome script.
  50
  51 - \c --version
  52
  53 Print version of %SALOME platform.
  54
  55 - \c --gui or \c -g
  56
  57 Launch %SALOME sesssion in GUI mode (with GUI desktop).
  58
  59 - \c --terminal or \c -t
  60
  61 Launch %SALOME session in terminal mode (without GUI).
  62
  63 - \c --resources=&lt;file&gt; or \c -r \c &lt;file&gt;
  64
  65 Parse application settings from the &lt;file&gt; instead of default resource
  66 file. Default resource file is situated in user's home directory; for
  67 example, for %SALOME version 6.5.0, the file is ${HOME}/.config/salome/.SalomeApprc.6.5.0
  68
  69 - \c --modules=module1,module2,... or \c -m=module1,module2,...
  70
  71 Specify the list of modules which will be used in the %SALOME session
  72 being launched. Note, that list of modules is separated be comma
  73 symbols, with no any spaces.
  74
  75 - \c --xterm or \c -x
  76
  77 The servers open in separate terminal window and log messages are displayed in this window.
  78
  79 - <code>--embedded=registry,study,moduleCatalog,cppContainer/</code> or
  80   <code>-e=registry,study,moduleCatalog,cppContainer</code>
  81
  82 Run listed %SALOME servers in the GUI embedded mode (default value is
  83 <code>registry,study,moduleCatalog,cppContainer</code>). Note that logger
  84 server cannot be embedded to GUI. Note, that this option implies running %SALOME in GUI mode (\c -g
  85 option); in terminal mode all servers are running in standalone mode.
  86
  87 - <code>--standalone=registry,study,moduleCatalog,cppContainerr</code> or
  88   <code>-s=registry,study,moduleCatalog,cppContainer</code>
  89
  90 Standalone CORBA servers (default: none).
  91
  92 - \c --portkill or \c -p
  93
  94 Kill %SALOME session launched with the current port.
  95
  96 - \c --killall or \c -k
  97
  98 Kill (stop) all running %SALOME sessions before launching new session.
  99
 100 - \c --splash=&lt;1/0&gt; or \c -z &lt;1/0&gt;
 101
 102 Use 1 to display splash screen [default] at start-up, 0 to disable
 103 splash screen. This option is ignored in the terminal mode.
 104
 105 - \c --pinter
 106
 107 Launch with interactive Python console.
 108
 109 - <code>--interp=n</code> or <code>-i=n</code>
 110
 111 Number of additional Python interpreters to open, with session
 112 environment propely set-up.
 113
 114 */