projects
/
hooke.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
643629f
)
Bring doc/config.txt up to speed
author
W. Trevor King
<wking@drexel.edu>
Sat, 14 Aug 2010 15:49:54 +0000
(11:49 -0400)
committer
W. Trevor King
<wking@drexel.edu>
Sat, 14 Aug 2010 15:49:54 +0000
(11:49 -0400)
doc/config.txt
patch
|
blob
|
history
diff --git
a/doc/config.txt
b/doc/config.txt
index d2b8d14d267c8b0d327575a9340269397fa29b86..d2a8d0ac8e25050a3229cd6774a52a253725454f 100644
(file)
--- a/
doc/config.txt
+++ b/
doc/config.txt
@@
-22,9
+22,9
@@
Examples
Run::
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
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/
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.