Salome HOME
Update help documentation
authorvsr <vsr@opencascade.com>
Fri, 26 May 2006 15:01:59 +0000 (15:01 +0000)
committervsr <vsr@opencascade.com>
Fri, 26 May 2006 15:01:59 +0000 (15:01 +0000)
README

diff --git a/README b/README
index 6525ddfb8839b0a12a05f6ad3f86b831fadb502b..bbd72b4f964d2ad9f3204da04f3276c3123a4d2f 100644 (file)
--- a/README
+++ b/README
 
   1. Running of the Installation Wizard
 
-     You can run the Installation Wizard in two modes: batch and gui. 
-     It's root directory contains python script runInstall:
-
-     [python] runInstall [-g|b] [-f <xml-file>] [-t <taget-dir>] [-tmp <tmp-dir>]
-
-     -g              
-          Runs the Installation Wizard in the GUI mode. In this case 
-          only <xml-file> key is taken into account. 
-          This option is used by default.
-
-     -b              
-          Runs the Installation Wizard in the batch mode.
-
-     -f <xml-file>   
-          The configuration file to be used by the Installation Wizard.  
-          If this parameter is missed then the script tries to define 
-          automatically the Linux platform and use the corresponding xml file
-          if there is one provided. 
-          For example, for Linux Mandrake 10.1 config_Mandrake_10.1.xml file 
-          will be used by default. If the appropriate file  is not found,
-          default config.xml will be used. This file contains default
-          installation settings. From SALOME version 3.0.0
-          the default target platform is Linux Mandrake 10.1.
-
-     -t <target-dir> 
-          The target directory SALOME products to be installed to. 
-          If used, overloads target directory, given in the 
-          configuration xml file (usually /salome).
-
-     -tmp <tmp-dir>  
-          The directory, which is used to contain temporary files.  
-          If used, overloads temporary directory, given in the 
-          configuration xml file (usually /tmp).
-
-     -h   
-          Prints help information.
+     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: 
+
+     [ python ] runInstall [<options>]
+
+     Without opstions this script will launch the SALOME Installation
+     Wizard in the default mode (GUI). The default mode can be
+     overriden by using command line options. Each option has short
+     and long notations: 
+
+     -g / --gui
+
+     Runs the Installation Wizard in the GUI mode (this is default
+     mode).
+
+     -b / --batch
+
+     Runs the Installation Wizard in command-line mode.
+
+     -f FILE / --file=FILE
+    
+     The XML configuration file to be used by the Installation Wizard.
+     If this option is not used then the installation script tries to
+     define the Linux version and use the corresponding XML file if it
+     is present. For examle, for the Linux Mandrake 10.1  the
+     config_Mandrake_10.1.xml  file will be used by default. If the
+     appropriate file is not found, the file config.xml will be
+     used. This file refers to the basic target platform which is
+     Linux Mandrake 10.1 for SALOME 3.0 and newer. If config.xml file
+     is also not found, the warning message box is shown (in GUI mode)
+     or printed to the console (in batch mode) and the Installation
+     Wizard quits. 
+
+     -d DIR / --target=DIR
+
+     The target directory SALOME platform to be installed to. If used,
+     this option overrides the default target directory, given in the
+     configuration XML file (usually ${HOME}/salome_<version>, see
+     here for more detail). 
+
+     -t DIR / --tmp=DIR
+
+     The directory, which is used for temporary files. If used, this
+     option overrides the default temporary directory, given in the
+     configuration xml file (usually /tmp, see here for more detail). 
+
+     -h / --help
+
+     Prints help information about available options.
+
+     -v / --version
+
+     Prints version information (Note: this is the Installation
+     Wizard's version number, not of SALOME platform). 
 
      For more detailed information about the Installation Wizard refer to the 
      readme.html file in the doc directory.
           the procedure of launching of SALOME. These shell scripts set all 
           necessary environment variables for all products you have installed. 
           These files are: 
-               * salome.csh + salome.sh in the KERNEL module's sources/binaries
-                 root directories; these files can be used for the launching of
-                 SALOME.
                * env_products.csh + env_products.sh in the target directory;
+                 these files can be used for the launching of SALOME.
+               * salome.csh + salome.sh in the KERNEL module's sources/binaries
+                 root directories; these files are the copies of the
+                 corresponding env_products.* files.
+               * env_build.csh + env_build.sh in the target directory;
                  these files contain minimal environment settings necessary
                  to build SALOME packages from sources (see paragraph 4).
 
                setenv MODULE_ROOT_DIR /home/salome/<MODULE_distribution>
 
           where <MODULE_distribution> is a MODULE_build or MODULE_install (see above).
-     
+
      4.2. Automatic build procedure: build.csh script
 
           From version 2.2.0 SALOME Installation Wizard includes the script
           Note: use -d option carefully because in this case the script removes
           existing (previously installed) SALOME modules.
 
+          Note: please, take into account 'make install' step is
+          obligatory for the KERNEL module. Build directory of KERNEL
+          can not be pointed as KERNEL_ROOT_DIR. This is an exception
+          for the SALOME modules. So you should use one of options -i
+          or -p of build.sch script when building KERNEL module.
+
 ================================================================================