doc/config.txt

   1 *****************
   2 Configuring Hooke
   3 *****************
   4
   5 Hooke initializes a number of variables by reading configuration
   6 files.
   7
   8 Syntax
   9 ------
  10
  11 Hooke uses Python's configparser_ library to read the config files.
  12 The format is similar to MS Windows' INI (initialization) format::
  13
  14     [My Section]
  15     foo = bar
  16     baz = 5
  17
  18 .. _configparser: http://docs.python.org/library/configparser.html
  19
  20 Examples
  21 --------
  22
  23 Run::
  24
  25     $ hooke --example-config-file
  26
  27 To print a well commented example config file to stdout.
  28
  29
  30 Finding configuration files
  31 ---------------------------
  32
  33 The default search path follows the `Filesystem Hierarchy Standard`_,
  34 and so will probably need adjustment for non-\*nix systems.  The
  35 default path list is
  36
  37 * :file:`/usr/share/hooke/hooke.cfg`
  38 * :file:`/etc/hooke/hooke.cfg`
  39 * :file:`~/.hooke.cfg`
  40 * :file:`./.hooke.cfg`
  41
  42 but alternatives can be specified from the command line launching
  43 Hooke.
  44
  45 .. _Filesystem Hierarchy Standard: http://www.pathname.com/fhs/