X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=3e275c3a0a93303549f478ccfe9027ce64155d4e;hb=53e3ff5fd2fe76b48edb73b2adae61b33697ede9;hp=6525ddfb8839b0a12a05f6ad3f86b831fadb502b;hpb=0a5bfb9be4f4c36b4016c9fb032ea738a0b84dbb;p=tools%2Finstall.git diff --git a/README b/README index 6525ddf..3e275c3 100644 --- a/README +++ b/README @@ -24,42 +24,62 @@ 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 ] [-t ] [-tmp ] - - -g - Runs the Installation Wizard in the GUI mode. In this case - only key is taken into account. - This option is used by default. - - -b - Runs the Installation Wizard in the batch mode. - - -f - 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 - The target directory SALOME products to be installed to. - If used, overloads target directory, given in the - configuration xml file (usually /salome). - - -tmp - 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 [] + + 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_, 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. @@ -77,10 +97,12 @@ 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). @@ -93,13 +115,13 @@ source salome.csh where is KERNEL binaries directory, e.g. - KERNEL_3.0.0 for the 3.0.0 version. + KERNEL_3.2.4 for the 3.2.4 version. 2.2. Launching of SALOME After you set environment you can start SALOME. Go to the KERNEL - module's binaries directory (KERNEL_3.0.0/bin/salome for the version - 3.0.0) by using of 'cd' command and then type: + module's binaries directory (KERNEL_3.2.4/bin/salome for the version + 3.2.4) by using of 'cd' command and then type: runSalome [] @@ -228,7 +250,7 @@ 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_3.0.0 for KERNEL module of SALOME version 3.0.0. + KERNEL_SRC_3.2.4 for KERNEL module of SALOME version 3.2.4. The order of compilation and installation should be performed according to the dependancies between modules: @@ -286,12 +308,12 @@ - create a configuration script by typing - ../KERNEL_SRC_3.0.0/build_configure + ../KERNEL_SRC_3.2.4/build_configure - run configure script which will check the environment and create Makefile files: - ../KERNEL_SRC_3.0.0/configure --prefix=/home/salome/KERNEL_install + ../KERNEL_SRC_3.2.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 @@ -341,7 +363,7 @@ setenv MODULE_ROOT_DIR /home/salome/ where 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 @@ -384,4 +406,10 @@ 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. + ================================================================================