doc/src/commands/config.rst

   1
   2 .. include:: ../../rst_prolog.rst
   3
   4 Command config
   5 ******************
   6
   7 Description
   8 ===========
   9 The **config** command manages sat configuration.
  10 It allows display, manipulation and operation on configuration files
  11
  12 Usage
  13 =====
  14 * Edit the user personal configuration file ``$HOME/.salomeTools/SAT.pyconf``. It is used to store the user personal choices, like the favourite editor, browser, pdf viewer: ::
  15
  16     sat config --edit
  17
  18 * List the available applications (they come from the sat projects defined in ``data/local.pyconf``): ::
  19
  20     sat config --list
  21
  22 * Edit the configuration of an application: ::
  23
  24     sat config <application> --edit
  25
  26 * Check the system dependencies (if any) used by the application: ::
  27
  28     sat config <application> --check_system
  29
  30 * Copy an application configuration file into the user personal directory: ::
  31
  32     sat config <application> --copy [new_name]
  33
  34 * | Print the value of a configuration parameter.
  35   | Use the automatic completion to get recursively the parameter names.
  36   | Use *--no_label* option to get *only* the value, *without* label (useful in automatic scripts).
  37   | Examples (with *SALOME-xx* as *SALOME-8.4.0* ):
  38
  39   .. code-block:: bash
  40
  41     # sat config --value <parameter_path>
  42     sat config --value .         # all the configuration
  43     sat config --value LOCAL
  44     sat config --value LOCAL.workdir
  45
  46     # sat config <application> --value <parameter_path>
  47     sat config SALOME-xx --value APPLICATION.workdir
  48     sat config SALOME-xx --no_label --value APPLICATION.workdir
  49
  50 * | Print in one-line-by-value mode the value of a configuration parameter,
  51   | with its source *expression*, if any.
  52   | This is a debug mode, useful for developers.
  53   | Prints the parameter path, the source expression if any, and the final value:
  54
  55   ::
  56
  57     sat config SALOME-xx -g USER
  58
  59   .. note:: And so, *not only for fun*, to get **all expressions** of configuration
  60
  61     .. code-block:: bash
  62
  63       sat config SALOME-xx -g . | grep -e "-->"
  64
  65
  66 * Print the patches that are applied: ::
  67
  68     sat config SALOME-xx --show_patchs
  69
  70 * Print the properties available for an application: ::
  71
  72     sat config SALOME-xx --show_properties
  73
  74 * Print the dependencies of products for an application: ::
  75
  76     # if -p not specified, print dependencies for all products
  77     sat config SALOME-xx --show_dependencies -p GEOM,SMESH
  78
  79
  80 * Get information on a product configuration:
  81
  82 .. code-block:: bash
  83
  84     # sat config <application> --info <product>
  85     sat config SALOME-xx --info KERNEL
  86     sat config SALOME-xx --info qt
  87
  88 Some useful configuration paths
  89 =================================
  90
  91 Exploring a current configuration.
  92
  93 * **PATHS**: To get list of directories where to find files.
  94
  95 * **USER**: To get user preferences (editor, pdf viewer, web browser, default working dir).
  96
  97 sat commands: ::
  98
  99   sat config SALOME-xx -v PATHS
 100   sat config SALOME-xx -v USERS
 101
 102
 103