Bring doc/config.txt up to speed

[hooke.git] / doc / config.txt

diff --git a/doc/config.txt b/doc/config.txt
index 6f0359b638d72502d5d93362cc62c2d6d1612bde..d2a8d0ac8e25050a3229cd6774a52a253725454f 100644 (file)
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -22,23 +22,33 @@ Examples
 
 Run::
 
-    $ hooke --example-config-file
+    $ hooke --save-config -c ''
 
-To print a well commented example config file to stdout.
+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.
 
-_ ..Filesystem Hierarchy Standard: http://www.pathname.com/fhs/
+.. _Filesystem Hierarchy Standard: http://www.pathname.com/fhs/
+
+.. todo:: Implement command-line specified config file.
+
+.. 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.
+
+.. todo:: Implement `save config` command.