Run::
- $ hooke --example-config-file
+ $ ./bin/hk.py --save-config -c ''
-To print a well commented example config file to stdout.
+or::
+
+ $ ./bin/hk.py -c 'save_config --output .hooke.cfg'
+
+To write a well commented example config file to :file:`.hooke.cfg`.
Finding configuration files
---------------------------
-The default search path follows the `Filesystem Hierarchy
-Standard`_, and so will probably need adjustment for non-*nix systems.
-The default path list is
+The default search path follows the `Filesystem Hierarchy Standard`_,
+and so will probably need adjustment for non-\*nix systems. The
+default path list is
-* /usr/share/hooke/hooke.cfg
-* /etc/hooke/hooke.cfg
-* ~/.hooke.cfg
+* :file:`/usr/share/hooke/hooke.cfg`
+* :file:`/etc/hooke/hooke.cfg`
+* :file:`~/.hooke.cfg`
+* :file:`./.hooke.cfg`
but alternatives can be specified from the command line launching
-Hooke.
+Hooke (``--config FILE``).
+
+.. _Filesystem Hierarchy Standard: http://www.pathname.com/fhs/
-_ ..Filesystem Hierarchy Standard: http://www.pathname.com/fhs/
+.. warning:: Any changes you make to the configuration during a Hooke
+ run will *not be saved* when Hooke exits. To save the changes,
+ either run the `save config` command before closing Hooke, or start
+ Hooke with the ``--save-config`` option.