From: W. Trevor King <wking@drexel.edu>
Date: Sat, 14 Aug 2010 15:49:54 +0000 (-0400)
Subject: Bring doc/config.txt up to speed
X-Git-Url: http://git.tremily.us/?p=hooke.git;a=commitdiff_plain;h=6265e6905c447824251a4ed30dac9f14a4736953;hp=643629fa189f2bc8d05a6d9903ccd22637bc563d

Bring doc/config.txt up to speed
---

diff --git a/doc/config.txt b/doc/config.txt
index d2b8d14..d2a8d0a 100644
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -22,9 +22,9 @@ 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
@@ -43,3 +43,12 @@ but alternatives can be specified from the command line launching
 Hooke.
 
 .. _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.