0021670: EDF 2265 GUI: Update GUI documentation

Move documentation on SALOME running from GUI to KERNEL module.

diff --git a/doc/salome/main.dox b/doc/salome/main.dox
index 20bbff44337e2fbd3893be0121ef3f008cdfa292..eea5b33e946dc0658174f982db18773f453d61f3 100644 (file)
--- a/doc/salome/main.dox
+++ b/doc/salome/main.dox
@@ -15,8 +15,9 @@ introductory documentation, listed below.
     application on several computers. 
     See \subpage SALOME_Application to define your own configuration of %SALOME and run it  
     on one or several computers. This is the recommended way of configuration.
--# <b>How to launch %SALOME in a %SALOME application</b>\n
-    See \ref SALOME_Application.
+-# <b>How to launch %SALOME</b>:
+    - In a %SALOME application, see \ref SALOME_Application.
+    - Using \c runSalome script, see \subpage running_salome_page
 -# <b>How to use KERNEL services in Python scripts</b>\n
     The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services.
 -# <b>How to use KERNEL services from a C++ context</b>\n

diff --git a/doc/salome/running_salome.dox b/doc/salome/running_salome.dox
new file mode 100644 (file)
index 0000000..d6713a3
--- /dev/null
+++ b/doc/salome/running_salome.dox
@@ -0,0 +1,115 @@
+/*!
+
+\page running_salome_page Running Salome
+
+There are two ways to run %SALOME:
+
+1) Using <b>Salome Application Concept</b> approach.
+
+For more details see \ref SALOME_Application.
+
+2) Using <b>\c %runSalome</b> script supplied with %SALOME KERNEL module distribution.
+
+To launch %SALOME using \c %runSalome script, you have first to
+set-up proper environment for %SALOME. If you installed %SALOME using
+%SALOME Installation Wizard (Linux), you can use \c salome.sh or
+\c salome.csh script (that is located in the \c KERNEL_&lt;version&gt;
+directory of your %SALOME installation), for example:
+
+\code
+cd /home/user/salome_6.5.0/KERNEL_6.5.0
+source salome.csh
+\endcode
+
+Launch %SALOME session using the \c %runSalome script located
+in the \c SALOME/KERNEL/bin/salome directory:
+
+\code
+runSalome [options] [STUDY_FILE] [PYTHON_FILE [PYTHON_FILE ...]]
+\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.
+
+The \c %runSalome script 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
+runSalome --help
+\endcode
+
+Here below is a description of most important options:
+
+- \c --help or \c -h
+
+Print detail help information on the \c %runSalome script.
+
+- \c --version
+
+Print version of %SALOME platform.
+
+- \c --gui or \c -g
+
+Launch %SALOME sesssion in GUI mode (with GUI desktop).
+
+- \c --terminal or \c -t
+
+Launch %SALOME session in terminal mode (without GUI).
+
+- \c --resources=&lt;file&gt; or \c -r \c &lt;file&gt;
+
+Parse application settings from the &lt;file&gt; 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.
+
+- <code>--embedded=registry,study,moduleCatalog,cppContainer/</code> or
+  <code>-e=registry,study,moduleCatalog,cppContainer</code>
+
+Run listed %SALOME servers in the GUI embedded mode (default value is
+<code>registry,study,moduleCatalog,cppContainer</code>). Note that logger,
+pyContainer, and supervContainer servers 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.
+
+- <code>--standalone=registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer</code> or
+  <code>-s=registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer</code>
+
+Standalone CORBA servers (default: <code>pyContainer,supervContainer</code>).
+
+- \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=&lt;1/0&gt; or \c -z &lt;1/0&gt;
+
+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.
+
+- <code>--interp=n</code> or <code>-i=n</code>
+
+Number of additional Python interpreters to open, with session
+environment propely set-up.
+
+*/