doc/src/configuration.rst

   1 *************
   2 Configuration
   3 *************
   4
   5 *salomeTools* uses files to store its configuration parameters.
   6
   7 There are several configuration files which are loaded by salomeTools in a specific order.
   8 When all the files are loaded a *config* object is created.
   9 Then, this object is passed to all command scripts.
  10
  11
  12 Syntax
  13 ======
  14 The configuration files use a python-like structure format
  15 (see `config module <http://www.red-dove.com/config-doc/>`_ for a complete description).
  16
  17 * **{}** define a dictionary,
  18 * **[]** define a list,
  19 * **@** can be used to include a file,
  20 * **$prefix** reference to another parameter (ex: ``$PRODUCT.name``),
  21 * **#** comments.
  22
  23 .. note:: in this documentation a reference to a configuration parameter will be noted ``$XXX.YYY``.
  24
  25 Description
  26 ===========
  27
  28 .. _VARS-Section:
  29
  30 VARS section
  31 -------------
  32 | This section is dynamically created by salomeTools at run time.
  33 | It contains information about the environment: date, time, OS, architecture etc.
  34
  35 .. note:: use this command to get the current setting: *sat config -v VARS*
  36
  37
  38 PRODUCTS section
  39 ------------------
  40 | This section is defined in the product file.
  41 | It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
  42
  43 .. note:: use this command to get the current setting: *sat config SALOME-xx -v PRODUCTS*
  44
  45 APPLICATION section
  46 ---------------------
  47 | This section is optional, it is also defined in the product file.
  48 | It gives additional parameters to create an application based on SALOME, as versions of products to use.
  49
  50 .. note:: use this command to get the current setting: *sat config SALOME-xx -v APPLICATION*
  51
  52 .. _USER-Section:
  53
  54 USER section
  55 --------------
  56 This section is defined by the user configuration file
  57 which is located in *~/.salomeTools/salomeTools.pyconf*.
  58
  59 The USER section defines parameters (not exhaustive):
  60
  61 * **workDir** the working directory. Each product will be usually installed here (in sub-directories).
  62 * and other users preferences.
  63
  64 .. note:: use this command to get the current setting: *sat config SALOME-xx -v USER*.
  65
  66
  67
  68