From cd4b50a288f0a748afd29b333a30c7111f8ae29a Mon Sep 17 00:00:00 2001 From: vsr Date: Tue, 11 Sep 2012 15:02:48 +0000 Subject: [PATCH] 0021670: EDF 2265 GUI: Update GUI documentation Move documentation on SALOME running from GUI to KERNEL module. --- doc/salome/gui/input/index.doc | 1 - doc/salome/gui/input/running_salome.doc | 110 ------------------- doc/salome/gui/input/salome_architecture.doc | 5 - 3 files changed, 116 deletions(-) delete mode 100644 doc/salome/gui/input/running_salome.doc diff --git a/doc/salome/gui/input/index.doc b/doc/salome/gui/input/index.doc index 74ddfd8a3..c306e7609 100644 --- a/doc/salome/gui/input/index.doc +++ b/doc/salome/gui/input/index.doc @@ -69,7 +69,6 @@ integrated Python console From the point of view of the \subpage salome_architecture_page "Architecture", Salome is composed of several modules. -To run salome (with different options) refer to \subpage running_salome_page page. This part of documentation on Salome also covers \subpage introduction_to_gui_page "general Salome functionalities", diff --git a/doc/salome/gui/input/running_salome.doc b/doc/salome/gui/input/running_salome.doc deleted file mode 100644 index 630c5d254..000000000 --- a/doc/salome/gui/input/running_salome.doc +++ /dev/null @@ -1,110 +0,0 @@ -/*! - -\page running_salome_page Running SALOME - -To launch SALOME: -
    -
  1. Install the SALOME package into a definite directory (ex. \b SALOME) -on your hard disk. It is preferable if you use the special -installation procedure allowing to install the SALOME platform and -all corresponding applications.
    2. -
  2. The installation shell script will create a special file: -salome.csh (CShell file) in your SALOME/KERNEL directory. This file -contains all environment variables necessary for launching SALOME -platform with other application products provided with SALOME -installation package. You have a possibility to add one of them into -your profile if you enter in the command console the following:

    -source salome.csh - -Tip: During the installation procedure you have a possibility to set your profile automatically.
    3. - -
  3. Launch SALOME platform, using the following Python script located -in the SALOME/KERNEL/bin/salome directory:

    -
      -
    • \b runSalome.py [command line options] -
    -
    4. -
- -\anchor batch_mode_run - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Options

Description

--\b help or -\b hprint this help
--\b gui or -\b glaunch with GUI
--\b terminal or -\b tlaunch without GUI in batch mode
--\b logger or -\b lredirects log messages in the file logger.log
--\b file=\ or -\b f=\redirects log messages in a custom file
--\b xterm or -\b xthe servers open an xterm window and log messages are displayed in this window
--\b modules=\b module1,\b module2,... or -\b m=\b module1,\b module2,...list of SALOME modules which will be loaded into the module catalogue
--\b embedded=registry,study,moduleCatalog,cppContainer, -or -\b e=registry,study,moduleCatalog,cppContainerembedded CORBA servers (default: registry,study,moduleCatalog,cppContainer) -note that logger,pyContainer,supervContainer can't be embedded
--\b standalone=registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer, or --\b s=registry,study,moduleCatalog,cppContainer,pyContainer,supervContainerstandalone CORBA servers (default: pyContainer,supervContainer)
--\b containers=cpp,python,superv -or -\b c=cpp,python,supervlaunch of cpp, python and supervision containers
--\b portkill or -\b pkill SALOME launched with the current port
--\b killall or -\b kkill SALOME
--interp=n or -i=nnumber of additional xterm to open, with session environment
-\b zdisplay splash screen
-\b rdisable centralized exception handling mechanism
- -Tip: If the \b runSalome.py script is launched without prompting -any options, they will be taken by default from the file SalomeApp.xml -(SALOME/GUI/share/salome/resources/SalomeApp.xml). If you are -constantly launching SALOME with some specific options which are -different from the defaults, you can edit this file according to your -requirements. So the next time you run SALOME, you won't have to enter -these numerous command console options. - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/salome_architecture.doc b/doc/salome/gui/input/salome_architecture.doc index f12d0e580..387c201a1 100644 --- a/doc/salome/gui/input/salome_architecture.doc +++ b/doc/salome/gui/input/salome_architecture.doc @@ -80,11 +80,6 @@ them. Additional information about CORBA technology is available at http://www.omg.org -\note In \b SALOME there is a possibility to run -definite components in the so-called \ref batch_mode_run "batch mode" without GUI provided -by GUI component. In this case you can work with these components with -the help of Python commands and scripts. -          The architecture of this all-inclusive platform for numerical components responds to the following -- 2.39.2