Re: [6.1] TUI in doco?

Andrew Cagney
2004-03-22T21:30:28Z

[-- Attachment #1: Type: text/plain, Size: 461 bytes --]

>>> Date: Tue, 16 Mar 2004 17:54:21 -0500
>>> From: Andrew Cagney <cagney@gnu.org>
>>>
>>> Any ideas on how to introduce "gdbtui" into the doco?
>
>
> I think we already discussed that; my suggestions are in this message:
>
> http://sources.redhat.com/ml/gdb-patches/2004-02/msg00278.html

The attached is hopefully getting there. I also noticed an
inconsistency in its name. "Terminal User Interface" is what HP use, it
fixes that as well.

Andrew

[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 3121 bytes --]

2004-03-22 Andrew Cagney <cagney@redhat.com>

* gdb.texinfo (TUI): Delete reference to --enable-tui. Mention
"gdbtui".
(Mode Options): Mention "gdbtui".
(TUI): Rename chapter to "Terminal User Interface".

Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.200
diff -u -r1.200 gdb.texinfo
--- doc/gdb.texinfo 9 Mar 2004 16:16:35 -0000 1.200
+++ doc/gdb.texinfo 22 Mar 2004 21:27:30 -0000
@@ -142,7 +142,7 @@
* Configurations:: Configuration-specific information
* Controlling GDB:: Controlling @value{GDBN}
* Sequences:: Canned sequences of commands
-* TUI:: @value{GDBN} Text User Interface
+* TUI:: @value{GDBN} Terminal User Interface
* Interpreters:: Command Interpreters
* Emacs:: Using @value{GDBN} under @sc{gnu} Emacs
* Annotations:: @value{GDBN}'s annotation interface.
@@ -1112,12 +1112,14 @@
@c resolve the situation of these eventually
@item -tui
@cindex @code{--tui}
-Activate the Terminal User Interface when starting.
-The Terminal User Interface manages several text windows on the terminal,
-showing source, assembly, registers and @value{GDBN} command outputs
-(@pxref{TUI, ,@value{GDBN} Text User Interface}).
-Do not use this option if you run @value{GDBN} from Emacs
-(@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).
+@pindex @code{gdbtui}
+Activate the Terminal User Interface when starting. The Terminal User
+Interface manages several text windows on the terminal, showing
+source, assembly, registers and @value{GDBN} command outputs
+(@pxref{TUI, ,@value{GDBN} Terminal User Interface}). Alternatively,
+the Terminal User Interface can be enabled by invoking the program
+@samp{gdbtui}. Do not use this option if you run @value{GDBN} from
+Emacs (@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).

@c @item -xdb
@c @cindex @code{--xdb}
@@ -13886,7 +13888,7 @@
@value{GDBN} which support @sc{gdb/mi} version 2 (or greater).

@node TUI
-@chapter @value{GDBN} Text User Interface
+@chapter @value{GDBN} Terminal User Interface
@cindex TUI

@menu
@@ -13897,12 +13899,14 @@
* TUI Configuration:: TUI configuration variables
@end menu

-The @value{GDBN} Text User Interface, TUI in short,
-is a terminal interface which uses the @code{curses} library
-to show the source file, the assembly output, the program registers
-and @value{GDBN} commands in separate text windows.
-The TUI is available only when @value{GDBN} is configured
-with the @code{--enable-tui} configure option (@pxref{Configure Options}).
+The @value{GDBN} Terminal User Interface, TUI in short, is a terminal
+interface which uses the @code{curses} library to show the source
+file, the assembly output, the program registers and @value{GDBN}
+commands in separate text windows.
+
+The TUI is enabled by invoking @value{GDBN} using either
+@pindex gdbtui
+@samp{gdbtui} or @samp{gdb -tui}.

@node TUI Overview
@section TUI overview