doc/salome/running_salome.dox

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