Salome HOME
To print user friendly message at Python modules import error.
[tools/install.git] / README
diff --git a/README b/README
index 966c0b22812b9ed0bd99671c454986caf5cbec5e..db48ff26efccacd66c04df87f08938d6be8d14cf 100644 (file)
--- a/README
+++ b/README
@@ -27,9 +27,9 @@
      The Installation Wizard can be launched in two modes: GUI and batch.
      The root directory of the Installation Wizard contains Python
      script runInstall. To run the Installation Wizard just type
-     runInstall in the terminal window: 
+     ./runInstall in the terminal window: 
 
-     [ python ] runInstall [<options>]
+     [ python ] ./runInstall [<options>]
 
      Without any option this script will launch the SALOME Installation
      Wizard in the default mode (GUI) with the default installation 
                source salome.csh
 
           where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g. 
-          KERNEL_4.1.3 for the 4.1.3 version.
+          KERNEL_4.1.4 for the 4.1.4 version.
 
      2.2. Launching of SALOME
        
           After you set environment you can start SALOME. Go to the KERNEL 
-          module's binaries directory (KERNEL_4.1.3/bin/salome for the version 
-          4.1.3) by using of 'cd' command and then type:
+          module's binaries directory (KERNEL_4.1.4/bin/salome for the version 
+          4.1.4) by using of 'cd' command and then type:
 
                runSalome [<parameters>]
 
           Some parameters described in configuration file can be overridden by 
           using of corresponding command-line options for runSalome script:
 
-          --gui
-                Launch GUI desktop
-          --logger
-                Use logger server
-          --xterm
-                Start each server in its own xterm console window
-          --portkill
-                Kill SALOME, running on the current port
-          --killall
-                Kill SALOME, running on all ports
-          --modules=<module>,<module>,...,<module>
-                Use module(s), possible values are GEOM,SMESH,VISU,MED,SUPERV,etc.
-          --embedded=<server>,<server>,...<server>
-                Start specified server/container(s) embedded in SALOME Session server 
-                (i.e. running in the same process), possible values are registry, 
-                study, moduleCatalog, cppContainer, registry
-          --standalone=<server>,<server>,...<server>
-                Start standalone server/container(s), possible values are registry, 
-                study, registry, moduleCatalog, cppContainer, pyContainer, supervContainer.
+         -t, --terminal
+               Launch without GUI (in the terminal mode).
+         -g, --gui             
+               Launch in GUI mode [default].
+         -d <1/0>, --show-desktop=<1/0>
+                1 to activate GUI desktop [default], 0 to not activate
+                GUI desktop (Session_Server starts, but GUI is not
+                shown). Ignored in the terminal mode.
+         -o, --hide-desktop    
+               Do not activate GUI desktop (Session_Server starts,
+                but GUI is not shown). The same as --show-desktop=0.
+         -b, --batch           
+               Launch in Batch Mode. (Without GUI on batch machine)
+         -l, --logger          
+               Redirect messages to the CORBA collector.
+         -f <log-file>, --log-file=<log-file>
+                Redirect messages to the <log-file>
+         -u <script1,script2,...>, --execute=<script1,script2,...>
+                Python script(s) to be imported. Python scripts are
+                imported in the order of their appearance. In GUI mode
+                python scripts are imported in the embedded python
+                interpreter of current study, otherwise in an external
+                python interpreter
+         -r <file>, --resources=<file>
+                Parse application settings from the <file> instead of
+                default $(HOME)/.SalomeApprc.$(version)
+         -x, --xterm           
+               Launch each SALOME server in own xterm console
+         -m <module1,module2,...>, --modules=<module1,module2,...>
+               SALOME modules list (where <module1>, <module2> are
+               the names of SALOME modules which should be available
+               in the SALOME session)
+         -e <server1,server2,...>, --embedded=<server1,server2,...>
+               CORBA servers to be launched in the Session embedded
+               mode. Valid values for <serverN>: registry, study,
+               moduleCatalog, cppContainer, SalomeAppEngine [by
+               default the value from the configuration files is
+               used]
+         -s <server1,server2,...>, --standalone=<server1,server2,...>
+                CORBA servers to be launched in the standalone mode
+                (as separate processes). Valid values for <serverN>:
+                registry, study, moduleCatalog, cppContainer,
+                pyContainer, supervContainer [by default the value
+                from the configuration files is used]
+         -p, --portkill        
+               Kill SALOME with the current port
+         -k, --killall         
+               Kill all running SALOME sessions
+         -i <N>, --interp=<N>  
+               The number of additional external python interpreters
+                to run. Each additional python interpreter is run in
+                separate xterm session with properly set SALOME 
+               environment
+         -z <1/0>, --splash=<1/0>
+                1 to display splash screen [default], 0 to disable
+                splash screen. This option is ignored in the terminal
+                mode. It is also ignored if --show-desktop=0 option is
+                used.
+         -c <1/0>, --catch-exceptions=<1/0>
+                1 (yes,true,on,ok) to enable centralized exception
+                handling [default], 0 (no,false,off,cancel) to disable
+                centralized exception handling.
+         --print-port          
+               Print free port and exit
+         --nosave-config       
+               Do not save current configuration
+                        ${HOME}/.omniORB_last.cfg
+         --pinter              
+               Launch with interactive python console.
+         --ns-port-log=<ns_port_log_file>
+                Print Naming Service Port into a user file.
+         --gdb-session         
+               Launch session with gdb
+         --version            
+               Show program's version number and exit
 
           Additional launch settings are given in other sections, which refer to certain
           modules. For example, SMESH plugins which should be used in the SALOME launch 
           In this scenario it is supposed that you have installed SALOME
           modules sources in the /home/salome directory. The name of each module
           sources directory depends on the version of the platform, for example,
-          KERNEL_SRC_4.1.3 for KERNEL module of SALOME version 4.1.3.
+          KERNEL_SRC_4.1.4 for KERNEL module of SALOME version 4.1.4.
 
           Compilation and installation should be performed according to 
           the dependencies between modules:
 
           - create a configuration script by typing
 
-               ../KERNEL_SRC_4.1.3/build_configure
+               ../KERNEL_SRC_4.1.4/build_configure
 
           - run configure script which will check the environment and create 
            Makefile files:
 
-               ../KERNEL_SRC_4.1.3/configure --prefix=/home/salome/KERNEL_install
+               ../KERNEL_SRC_4.1.4/configure --prefix=/home/salome/KERNEL_install
 
           Note, that --prefix option defines the directory where you want to 
           install KERNEL module after 'make install' procedure. configure script