/*!
\page running_salome_page Running Salome
To run %SALOME, use the python \ref salome_command.
Using this command, you DO NOT need to first set-up proper environment for %SALOME; all is done by the command itself.
Launch %SALOME session using the following command:
\code
salome start [options] [STUDY_FILE] [PYTHON_FILE [args] [PYTHON_FILE [args]...]]
\endcode
Optionally, you can specify in the command line:
- Study (document) file to be opened in %SALOME session passing;
- One or more Python scripts to be executed after %SALOME
start-up. Python scripts will be executed in the new or opened study
in the order they appear in the command line. Passing args to these scripts
is possible but require a specific \c args: syntax (see \ref salome_command).
This command supports large set of options that allow
specifying the way to launch %SALOME session. Complete description of
all options can be obtained using \c --help or -h option:
\code
salome start --help
\endcode
Here below is a description of most important options:
- \c --help or \c -h
Print detail help information on the command.
- \c --version
Print version of %SALOME platform.
- \c --gui or \c -g
Launch %SALOME session in GUI mode (with GUI desktop).
- \c --terminal or \c -t
Launch %SALOME session in terminal mode (without GUI).
- \c --resources=<file> or \c -r \c <file>
Parse application settings from the <file> instead of default resource
file. Default resource file is situated in user's home directory; for
example, for %SALOME version 6.5.0, the file is ${HOME}/.config/salome/.SalomeApprc.6.5.0
- \c --modules=module1,module2,... or \c -m=module1,module2,...
Specify the list of modules which will be used in the %SALOME session
being launched. Note, that list of modules is separated be comma
symbols, with no any spaces.
- \c --xterm or \c -x
The servers open in separate terminal window and log messages are displayed in this window.
- --embedded=registry,study,moduleCatalog,cppContainer/
or
-e=registry,study,moduleCatalog,cppContainer
Run listed %SALOME servers in the GUI embedded mode (default value is
registry,study,moduleCatalog,cppContainer
). Note that logger
server cannot be embedded to GUI. Note, that this option implies running %SALOME in GUI mode (\c -g
option); in terminal mode all servers are running in standalone mode.
- --standalone=registry,study,moduleCatalog,cppContainerr
or
-s=registry,study,moduleCatalog,cppContainer
Standalone CORBA servers (default: none).
- \c --portkill or \c -p
Kill %SALOME session launched with the current port.
- \c --killall or \c -k
Kill (stop) all running %SALOME sessions before launching new session.
- \c --splash=<1/0> or \c -z <1/0>
Use 1 to display splash screen [default] at start-up, 0 to disable
splash screen. This option is ignored in the terminal mode.
- \c --pinter
Launch with interactive Python console.
- --interp=n
or -i=n
Number of additional Python interpreters to open, with session
environment properly set-up.
*/