[RFC]: Document TUI breakpoints and SingleKey mode

[Stephane Carrez <stcarrez at nerim dot fr>]

Hi!

I suggest the following patch to document the TUI breakpoint markers and
the new TUI fast key mode which I name 'SingleKey' in the doc (wanted OneTouch
but it's a TM...).  It's a single patch for now but I can split it in two if you prefer.

I changed the SingleKey activation from 'C-X C-O' to 'C-X C-S' because
in the future we may have a 'C-X C-O' that could be a change active window (cf Emacs).
Also changed SingleKey to exit this mode from 'x' to 'q' because it's more natural.

	Stephane

2002-08-28  Stephane Carrez  <stcarrez@nerim.fr>

	* gdb.texinfo (TUI Single Key Mode): Document new SingleKey mode.
	(TUI Overview): Document breakpoint markers.
	(TUI Keys): Document new SingleKey mode.
Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.115
diff -u -p -r1.115 gdb.texinfo
--- gdb.texinfo	25 Aug 2002 19:10:15 -0000	1.115
+++ gdb.texinfo	27 Aug 2002 20:12:13 -0000
@@ -13101,6 +13101,7 @@ letter.
 @menu
 * TUI Overview::                TUI overview
 * TUI Keys::                    TUI key bindings
+* TUI Single Key Mode::         TUI single key mode
 * TUI Commands::                TUI specific commands
 * TUI Configuration::           TUI configuration variables
 @end menu
@@ -13141,8 +13142,6 @@ window is always visible.
 @item source
 The source window shows the source file of the program.  The current
 line as well as active breakpoints are displayed in this window.
-The current program position is shown with the @samp{>} marker and
-active breakpoints are shown with @samp{*} markers.
 
 @item assembly
 The assembly window shows the disassembly output of the program.
@@ -13154,6 +13153,37 @@ changed are highlighted.
 
 @end table
 
+The source and assembly windows show the current program position
+by highlighting the current line and marking them with the @samp{>} marker.
+Breakpoints are also indicated with two markers.  A first one
+indicates the breakpoint type:
+
+@table @emph
+@item B
+Breakpoint which was hit at least once.
+
+@item b
+Breakpoint which was never hit.
+
+@item H
+Hardware breakpoint which was hit at least once.
+
+@item h
+Hardware breakpoint which was never hit.
+
+@end table
+
+The second marker indicates whether the breakpoint is enabled or not:
+
+@table @emph
+@item +
+Breakpoint is enabled.
+
+@item -
+Breakpoint is disabled.
+
+@end table
+
 The source, assembly and register windows are attached to the thread
 and the frame position.  They are updated when the current thread
 changes, when the frame changes or when the program counter changes.
@@ -13186,7 +13216,9 @@ assembly and registers
 The TUI installs several key bindings in the readline keymaps
 (@pxref{Command Line Editing}).
 They allow to leave or enter in the TUI mode or they operate
-directly on the TUI layout and windows.  The following key bindings
+directly on the TUI layout and windows.  The TUI also provides
+a @emph{SingleKey} keymap which binds several keys directly to
+@value{GDBN} commands.  The following key bindings
 are installed for both TUI mode and the @value{GDBN} standard mode.
 
 @table @kbd
@@ -13219,6 +13251,11 @@ previous layout and the new one.
 
 Think of it as the Emacs @kbd{C-x 2} binding.
 
+@kindex C-x C-s
+@item C-x C-s
+Use the TUI @emph{SingleKey} keymap that binds single key to gdb commands
+(@pxref{TUI Single Key Mode}).
+
 @end table
 
 The following key bindings are handled only by the TUI mode:
@@ -13258,6 +13295,65 @@ In the TUI mode, the arrow keys are used
 for scrolling.  This means they are not available for readline.  It is
 necessary to use other readline key bindings such as @key{C-p}, @key{C-n},
 @key{C-b} and @key{C-f}.
+
+@node TUI Single Key Mode
+@section TUI Single Key Mode
+@cindex TUI single key mode
+
+The TUI provides a @emph{SingleKey} mode in which it installs a particular
+key binding in the readline keymaps to connect single keys to
+some gdb commands. 
+
+@table @kbd
+@kindex c
+@item c
+continue
+
+@kindex d
+@item d
+down
+
+@kindex f
+@item f
+finish
+
+@kindex n
+@item n
+next
+
+@kindex q
+@item q
+exit the @emph{SingleKey} mode.
+
+@kindex r
+@item r
+run
+
+@kindex s
+@item s
+step
+
+@kindex u
+@item u
+up
+
+@kindex v
+@item v
+info locals
+
+@kindex w
+@item w
+where
+
+@end table
+
+Other keys temporarily switch to the @value{GDBN} command prompt.
+The key that was pressed is inserted in the editing buffer so that
+it is possible to type most @value{GDBN} commands without interaction
+with the TUI @emph{SingleKey} mode.  Once the command is entered the TUI
+@emph{SingleKey} mode is restored.  The only way to permanently leave
+this mode is by hitting @key{q}.
+
 
 @node TUI Commands
 @section TUI specific commands