test/data/vclamp_jpk/README: Document sample versions

[hooke.git] / doc / config.txt

diff --git a/doc/config.txt b/doc/config.txt
index d2b8d14d267c8b0d327575a9340269397fa29b86..4d7540bb47d9d91c7f28a70b77a30eb2d6bb9266 100644 (file)
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -22,9 +22,13 @@ 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
@@ -40,6 +44,11 @@ default path list is
 * :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/
+
+.. 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.