doc/build/html/_sources/commands/config.txt

   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 favorite 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 * Copy an application configuration file into the user personal directory: ::
  27
  28     sat config <application> --copy [new_name]
  29
  30 * | Print the value of a configuration parameter.
  31   | Use the automatic completion to get recursively the parameter names.
  32   | Use *--no_label* option to get *only* the value, *without* label (useful in automatic scripts).
  33   | Examples (with *SALOME-xx* as *SALOME-8.4.0* ):
  34
  35   .. code-block:: bash
  36
  37     # sat config --value <parameter_path>
  38     sat config --value .         # all the configuration
  39     sat config --value LOCAL
  40     sat config --value LOCAL.workdir
  41
  42     # sat config <application> --value <parameter_path>
  43     sat config SALOME-xx --value APPLICATION.workdir
  44     sat config SALOME-xx --no_label --value APPLICATION.workdir
  45
  46 * | Print in one-line-by-value mode the value of a configuration parameter,
  47   | with its source *expression*, if any.
  48   | This is a debug mode, useful for developers.
  49   | Prints the parameter path, the source expression if any, and the final value:
  50
  51   ::
  52
  53     sat config SALOME-xx -g USER
  54
  55   .. note:: And so, *not only for fun*, to get **all expressions** of configuration
  56
  57     .. code-block:: bash
  58
  59       sat config SALOME-xx -g . | grep -e "-->"
  60
  61
  62 * Print the patches that are applied: ::
  63
  64     sat config SALOME-xx --show_patchs
  65
  66 * Get information on a product configuration:
  67
  68   .. code-block:: bash
  69
  70     # sat config <application> --info <product>
  71     sat config SALOME-xx --info KERNEL
  72     sat config SALOME-xx --info qt
  73
  74 Some useful configuration pathes
  75 =================================
  76
  77 Exploring a current configuration.
  78
  79 * **PATHS**: To get list of directories where to find files.
  80
  81 * **USER**: To get user preferences (editor, pdf viewer, web browser, default working dir).
  82
  83 sat commands: ::
  84
  85   sat config SALOME-xx -v PATHS
  86   sat config SALOME-xx -v USERS
  87
  88
  89