+Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
+
+Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+
+=======================================
Set of scripts for a SALOME application
=======================================
-# - A SALOME application distributed on several computers needs APPLI
-# directories on the same path ($APPLI) relative to $HOME directory
-# of the user, on each computer.
+This document corresponds to SALOME 6.4.0
+
+SALOME Application concept
+--------------------------
+
+See the documentation of KERNEL module for more information on SALOME
+Application concept and to learn how to define your own configuration of
+SALOME and run it on one or several computers. The recommended way to create
+a new application is with the script appli_gen.py that can be found in KERNEL
+installation. An application has probably already been generated for you if
+you downloaded a binary version of SALOME.
+
+To find all the files described below, please refer to a generated
+application as some of them are generated automatically and thus are not
+present in this appliskel directory.
+
+User run scripts
+----------------
+
+The SALOME user can use the following scripts:
+
+runAppli [DEPRECATED]
+ Launches a SALOME Session
+ (similar to ${KERNEL_ROOT_DIR}/bin/salome/runSalome but with a different
+ name to avoid confusions).
+
+runSession [DEPRECATED]
+ Launches a shell script in the SALOME application environment, with access
+ to the current SALOME session (naming service), if any.
+ Without arguments, the script is interactive. With arguments, the script
+ executes the command in the SALOME application environment.
+
+runConsole [DEPRECATED]
+ Gives a python console connected to the current SALOME Session.
+ It is also possible to use runSession, then python.
+
+salome [NEW]
+ A single Python command to start SALOME:
+ salome [start]: replace runAppli
+ salome shell: replace runSession
+ salome console: replace runConsole
+
+
+SALOME internal run scripts
+---------------------------
+
+envd
+ Sets SALOME application environment, envd is sourced by other scripts.
+
+getAppliPath.py
+ Used by other scripts to define the Application Path.
+
+For remote calls, SALOME uses one script.
+
+runRemote.sh
+ This script is mainly used to launch containers. The first 2 arguments
+ define the hostname and port userd for naming service, the remaining
+ arguments define the command to execute.
+
+
+The following files can be adapted to your environment and SALOME Application
+------------------------------------------------------------------------------
-user scripts:
--------------
+- CatalogResources.xml
+- SalomeApp.xml
+- env.d/atFirst.sh
+- env.d/envProducts.sh
+- env.d/envSalome.sh
-runAppli : SALOME launch (idem runSalome but different name to avoid
- confusion with ${KERNEL_ROOT_DIR}/bin/salome/runSalome
+CatalogResources.xml
+ This files describes all the computers the application can use. The default
+ file is minimal. A specific application directory can be set on a
+ particular computer with a line::
-runConsole : a python console in the current SALOME session environment
+ appliPath="my/specific/path/on/this/computer"
-runSession : a shell in SALOME environment, either interactive (without args)
- or used to run a program (defined by given args)
+SalomeApp.xml
+ This file is similar to the default given
+ in ${GUI_ROOT_DIR}/share/salome/resources/gui
-internal application scripts:
------------------------------
-runRemote.sh : called from remote computer, via ssh, rsh...
- used for instance to create container
+Proposal for env.d scripts
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Each user can define his own configuration for these scripts, following
+the above rules. The generated files are good examples to start with.
-envd : sets SALOME application environment
- sourced by other scripts
+envProducts.sh
+ Sets the SALOME prerequisites.
-The following files must be adapted to your environment and SALOME Application:
--------------------------------------------------------------------------------
+configSalome.sh
+ Sets all the MODULE_ROOT_DIR that can be used in the SALOME application.
-SalomeApp.xml - list of modules, options on server launch and resources...
-CatalogResources.xml - configuration of machines used in SALOME application
- (no need of modules list and path here)
+configGUI.sh
+ Sets variables necessary for SALOME GUI.
+ SalomeAppConfig is defined by::
-env.d directory must contain the necessary files to source, to define
-the SALOME Application environment :
- ( envd script source these files in alphanumeric order )
+ export SalomeAppConfig=${HOME}/${APPLI}
-For instance,
- atFirst.sh - general presets
- envProducts.sh - prerequisite SALOME environment
- envSalome.sh - list of MODULE_ROOT_DIR
+ where SalomeAppConfig designates the directory containing SalomeApp.xml.
+ Note that ${APPLI} is already defined by the calling scripts when
+ env.d/configGUI.sh is sourced.
