doc/src/commands/config.rst

   1 ******
   2 config
   3 ******
   4
   5 Description
   6 ===========
   7 The **config** command manages sat configuration. It allows display, manipulation and operation on configuration files
   8
   9 Usage
  10 =====
  11 * Edit the user personal configuration file (~/.salomeTools/SAT.pyconf). It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: ::
  12
  13     sat config --edit
  14
  15 * List the available applications (they come from the sat projects defined in data/local.pyconf): ::
  16
  17     sat config --list
  18
  19 * Edit the configuration of an application: ::
  20
  21     sat config <application> --edit
  22
  23 * Copy an application configuration file into the user personal directory: ::
  24
  25     sat config <application> --copy [new_name]
  26
  27 * Print the value of a configuration parameter. Use the automatic completion to get recursively the parameter names. Use -n option to get only the value, not the lable (useful in automatic scripts). Examples: ::
  28
  29     sat config --value <parameter_path>
  30     sat config --value LOCAL
  31     sat config --value LOCAL.workdir
  32
  33     sat config <application> --value <parameter_path>
  34     sat config SALOME-8.4.0  --value  APPLICATION.workdir
  35     sat config SALOME-8.4.0 -n  --value  APPLICATION.workdir
  36
  37 * Print the patches that are applied: ::
  38
  39     sat config SALOME-8.4.0  --show_patchs
  40
  41 * Get information on a product configuration: ::
  42
  43     sat config <application> --info <product>
  44     sat config SALOME-8.4.0 --info KERNEL
  45     sat config SALOME-8.4.0 --info qt
  46
  47 Configuration
  48 =============
  49 * PATH.
  50
  51   * **ARCHIVEPATH** list of directories where to find application files.
  52   * **PRODUCTPATH** list of directories where to find products configuration files.
  53
  54 * USER
  55
  56   * **editor**: command to use to start an editor (by default vi),
  57   * **browser**: command to use to start a browser (by default firefox),
  58   * **pdf_viewer**: command to use to start a pdf viewer (by default evince).