X-Git-Url: http://git.tremily.us/?p=hooke.git;a=blobdiff_plain;f=doc%2Fconfig.txt;h=4d7540bb47d9d91c7f28a70b77a30eb2d6bb9266;hp=c5d594fb8c4df10c12516ab6fb0b9fb1bd3f2fd6;hb=HEAD;hpb=7ba5f553f8344edb31a72576d5fbade55516e9b4 diff --git a/doc/config.txt b/doc/config.txt index c5d594f..4d7540b 100644 --- a/doc/config.txt +++ b/doc/config.txt @@ -22,23 +22,33 @@ Examples 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 +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.