[climacs-cvs] CVS update: climacs/Doc/climacs-internals.texi climacs/Doc/climacs-user.texi

[Robert Strandh]

Update of /project/climacs/cvsroot/climacs/Doc
In directory common-lisp.net:/tmp/cvs-serv26214

Modified Files:
	climacs-internals.texi climacs-user.texi 
Log Message:
Chapter on getting help.

Date: Wed Sep 14 01:42:17 2005
Author: rstrandh

Index: climacs/Doc/climacs-internals.texi
diff -u climacs/Doc/climacs-internals.texi:1.17 climacs/Doc/climacs-internals.texi:1.18
--- climacs/Doc/climacs-internals.texi:1.17	Tue Mar 15 07:19:21 2005
+++ climacs/Doc/climacs-internals.texi	Wed Sep 14 01:42:17 2005
@@ -1833,11 +1833,12 @@
 @section Suggested CLIM gadget
 
 Undo might be presented in a CLIM gadget in the form of a tree where
-branches are added to the right over time, in @xref{figundo}.
+branches are added to the right over time, in 
+ at c @xref{figundo}.
 
 
- at image{undo}
- at anchor{figundo} 
+ at c @image{undo}
+ at c @anchor{figundo} 
 
 where the bigger black circle indicates the current state.  The tree
 will be fairly tall and skinny, so the gadget should probably be a


Index: climacs/Doc/climacs-user.texi
diff -u climacs/Doc/climacs-user.texi:1.3 climacs/Doc/climacs-user.texi:1.4
--- climacs/Doc/climacs-user.texi:1.3	Tue Sep 13 01:35:55 2005
+++ climacs/Doc/climacs-user.texi	Wed Sep 14 01:42:17 2005
@@ -43,6 +43,7 @@
 * Different editing modes::
 * Kill ring::
 * Advanced editing commands::
+* Getting help::
 * Key Index::
 * Concept Index::
 @end menu
@@ -552,6 +553,56 @@
 
 @node Searching and replacing
 @section Searching and replacing
+
+ at node Getting help
+ at chapter Getting help
+
+In addition to this manual, @climacs{} contains an online help
+facility.  There are several different topics that you can get help
+with.  Most of these topics are obtained by some order using the
+ at kbd{C-h}
+ at kindex C-h
+prefex key.  The key following @kbd{C-h} determines what kind of help
+information is displayed. 
+
+ at menu 
+* Help with a key binding::
+* Help with a particular key sequence::
+* Help finding an order for a command::
+ at end menu
+
+ at node Help with a key binding
+ at section Help with a key binding
+
+To obtain a list of all orders and the associated commands that are
+valid in a particular context, use the order @kbd{C-h b}
+ at kindex C-h b
+(@command{Describe Bindings}).  A table with each command name and
+associated order (if any) is displayed in a new window. 
+
+ at node Help with a particular key sequence
+ at section Help with a particular key sequence
+
+To obtain a description of what some putative order will do, use the
+order @kbd{C-h c}
+ at kindex C-h c
+(@command{Describe Key Briefly}.  You will be prompted for a key
+sequence.  If the key sequence you type is bound to a command, the
+command name will be displayed in the minibuffer.  Otherwise a message
+indicating that the key is not bound to a command will be displayed.
+
+ at node Help finding an order for a command
+ at section Help finding an order for a command
+
+Sometimes, you know the name of a command, and would like to find out
+whether it is bound to any order, and if so, which one(s).  For that,
+you can use the order @kbd{C-h w}
+ at kindex C-h w
+(@command{Where Is}).  You will be prompted for a command name
+(completion can be used as usual), and if the command name given is
+bound to an order, that order will displayed in the minibuffer.
+Otherwise, a message indicating that the command is not bound to any
+order will be displayed. 
 
 @node Key Index
 @unnumbered Key Index