\input texinfo @c -*-texinfo-*-
|
\input texinfo @c -*-texinfo-*-
|
@c Copyright 1988 1989 1990 1991 1992 1993 1994 Free Software Foundation, Inc.
|
@c Copyright 1988 1989 1990 1991 1992 1993 1994 Free Software Foundation, Inc.
|
@c
|
@c
|
@c %**start of header
|
@c %**start of header
|
@c makeinfo ignores cmds prev to setfilename, so its arg cannot make use
|
@c makeinfo ignores cmds prev to setfilename, so its arg cannot make use
|
@c of @set vars. However, you can override filename with makeinfo -o.
|
@c of @set vars. However, you can override filename with makeinfo -o.
|
@setfilename gdb.info
|
@setfilename gdb.info
|
@c
|
@c
|
@include gdb-cfg.texi
|
@include gdb-cfg.texi
|
@c
|
@c
|
@ifset GENERIC
|
@ifset GENERIC
|
@settitle Using the Graphical Interface to @value{GDBN}
|
@settitle Using the Graphical Interface to @value{GDBN}
|
@end ifset
|
@end ifset
|
@ifclear GENERIC
|
@ifclear GENERIC
|
@settitle Using the Graphical Interface to @value{GDBN} (@value{TARGET})
|
@settitle Using the Graphical Interface to @value{GDBN} (@value{TARGET})
|
@end ifclear
|
@end ifclear
|
@setchapternewpage odd
|
@setchapternewpage odd
|
@c %**end of header
|
@c %**end of header
|
|
|
@c Since this interface is so new, there is much missing still.
|
@c Since this interface is so new, there is much missing still.
|
@c Desired but unimplemented features are commented out.
|
@c Desired but unimplemented features are commented out.
|
|
|
@iftex
|
@iftex
|
@c @smallbook
|
@c @smallbook
|
@c @cropmarks
|
@c @cropmarks
|
@end iftex
|
@end iftex
|
|
|
@finalout
|
@finalout
|
@syncodeindex ky cp
|
@syncodeindex ky cp
|
|
|
@c readline appendices use @vindex
|
@c readline appendices use @vindex
|
@syncodeindex vr cp
|
@syncodeindex vr cp
|
|
|
@c !!set GDB manual's edition---not the same as GDB version!
|
@c !!set GDB manual's edition---not the same as GDB version!
|
@set EDITION 4.13
|
@set EDITION 4.13
|
|
|
@c !!set GDB manual's revision date
|
@c !!set GDB manual's revision date
|
@set DATE January 1995
|
@set DATE January 1995
|
|
|
@c THIS MANUAL REQUIRES TEXINFO-2 macros and info-makers to format properly.
|
@c THIS MANUAL REQUIRES TEXINFO-2 macros and info-makers to format properly.
|
|
|
@ifinfo
|
@ifinfo
|
@c This is a dir.info fragment to support semi-automated addition of
|
@c This is a dir.info fragment to support semi-automated addition of
|
@c manuals to an info tree. zoo@cygnus.com is developing this facility.
|
@c manuals to an info tree. zoo@cygnus.com is developing this facility.
|
@format
|
@format
|
START-INFO-DIR-ENTRY
|
START-INFO-DIR-ENTRY
|
* Gdb: (gdb). The GNU debugger.
|
* Gdb: (gdb). The GNU debugger.
|
END-INFO-DIR-ENTRY
|
END-INFO-DIR-ENTRY
|
@end format
|
@end format
|
@end ifinfo
|
@end ifinfo
|
@c
|
@c
|
@c
|
@c
|
@ifinfo
|
@ifinfo
|
This file documents the graphical interface to the GNU debugger @value{GDBN}.
|
This file documents the graphical interface to the GNU debugger @value{GDBN}.
|
|
|
|
|
This is Edition @value{EDITION}, @value{DATE},
|
This is Edition @value{EDITION}, @value{DATE},
|
of @cite{Using the Graphical Interface to @value{GDBN}}
|
of @cite{Using the Graphical Interface to @value{GDBN}}
|
for GDB Version @value{GDBVN}.
|
for GDB Version @value{GDBVN}.
|
|
|
Copyright (C) 1994, 1995 Free Software Foundation, Inc.
|
Copyright (C) 1994, 1995 Free Software Foundation, Inc.
|
|
|
Permission is granted to make and distribute verbatim copies of
|
Permission is granted to make and distribute verbatim copies of
|
this manual provided the copyright notice and this permission notice
|
this manual provided the copyright notice and this permission notice
|
are preserved on all copies.
|
are preserved on all copies.
|
|
|
@ignore
|
@ignore
|
Permission is granted to process this file through TeX and print the
|
Permission is granted to process this file through TeX and print the
|
results, provided the printed document carries copying permission
|
results, provided the printed document carries copying permission
|
notice identical to this one except for the removal of this paragraph
|
notice identical to this one except for the removal of this paragraph
|
(this paragraph not being relevant to the printed manual).
|
(this paragraph not being relevant to the printed manual).
|
|
|
@end ignore
|
@end ignore
|
Permission is granted to copy and distribute modified versions of this
|
Permission is granted to copy and distribute modified versions of this
|
manual under the conditions for verbatim copying, provided also that the
|
manual under the conditions for verbatim copying, provided also that the
|
entire resulting derived work is distributed under the terms of a
|
entire resulting derived work is distributed under the terms of a
|
permission notice identical to this one.
|
permission notice identical to this one.
|
|
|
Permission is granted to copy and distribute translations of this manual
|
Permission is granted to copy and distribute translations of this manual
|
into another language, under the above conditions for modified versions.
|
into another language, under the above conditions for modified versions.
|
@end ifinfo
|
@end ifinfo
|
|
|
@titlepage
|
@titlepage
|
@title Using the Graphical Interface to @value{GDBN}
|
@title Using the Graphical Interface to @value{GDBN}
|
@subtitle The GNU Source-Level Debugger
|
@subtitle The GNU Source-Level Debugger
|
@ifclear GENERIC
|
@ifclear GENERIC
|
@subtitle (@value{TARGET})
|
@subtitle (@value{TARGET})
|
@end ifclear
|
@end ifclear
|
@sp 1
|
@sp 1
|
@subtitle Edition @value{EDITION}, for @value{GDBN} version @value{GDBVN}
|
@subtitle Edition @value{EDITION}, for @value{GDBN} version @value{GDBVN}
|
@subtitle @value{DATE}
|
@subtitle @value{DATE}
|
@author Stanley T. Shebs
|
@author Stanley T. Shebs
|
@page
|
@page
|
@tex
|
@tex
|
{\parskip=0pt
|
{\parskip=0pt
|
\hfill (Send bugs and comments on @value{GDBN} to bug-gdb\@prep.ai.mit.edu.)\par
|
\hfill (Send bugs and comments on @value{GDBN} to bug-gdb\@prep.ai.mit.edu.)\par
|
\hfill {\it Debugging with @value{GDBN}}\par
|
\hfill {\it Debugging with @value{GDBN}}\par
|
\hfill \TeX{}info \texinfoversion\par
|
\hfill \TeX{}info \texinfoversion\par
|
\hfill doc\@cygnus.com\par
|
\hfill doc\@cygnus.com\par
|
}
|
}
|
@end tex
|
@end tex
|
|
|
@vskip 0pt plus 1filll
|
@vskip 0pt plus 1filll
|
Copyright @copyright{} 1994, 1995 Free Software Foundation, Inc.
|
Copyright @copyright{} 1994, 1995 Free Software Foundation, Inc.
|
@sp 2
|
@sp 2
|
|
|
Permission is granted to make and distribute verbatim copies of
|
Permission is granted to make and distribute verbatim copies of
|
this manual provided the copyright notice and this permission notice
|
this manual provided the copyright notice and this permission notice
|
are preserved on all copies.
|
are preserved on all copies.
|
|
|
Permission is granted to copy and distribute modified versions of this
|
Permission is granted to copy and distribute modified versions of this
|
manual under the conditions for verbatim copying, provided also that the
|
manual under the conditions for verbatim copying, provided also that the
|
entire resulting derived work is distributed under the terms of a
|
entire resulting derived work is distributed under the terms of a
|
permission notice identical to this one.
|
permission notice identical to this one.
|
|
|
Permission is granted to copy and distribute translations of this manual
|
Permission is granted to copy and distribute translations of this manual
|
into another language, under the above conditions for modified versions.
|
into another language, under the above conditions for modified versions.
|
@end titlepage
|
@end titlepage
|
@page
|
@page
|
|
|
@ifinfo
|
@ifinfo
|
@node Top
|
@node Top
|
@top Using the Graphical Interface to @value{GDBN}
|
@top Using the Graphical Interface to @value{GDBN}
|
@end ifinfo
|
@end ifinfo
|
|
|
This file describes a graphical interface to @value{GDBN},
|
This file describes a graphical interface to @value{GDBN},
|
the GNU symbolic debugger.
|
the GNU symbolic debugger.
|
|
|
@node Invocation
|
@node Invocation
|
@chapter Starting up GUI @value{GDBN}
|
@chapter Starting up GUI @value{GDBN}
|
|
|
If @value{GDBN} has been configured to use the graphical interface,
|
If @value{GDBN} has been configured to use the graphical interface,
|
then you will get the interface automatically upon startup.
|
then you will get the interface automatically upon startup.
|
|
|
When running as a Unix program and using the X11-based interface,
|
When running as a Unix program and using the X11-based interface,
|
you must of course be using an X server and/or workstation,
|
you must of course be using an X server and/or workstation,
|
and your @code{DISPLAY} environment variable must be set correctly.
|
and your @code{DISPLAY} environment variable must be set correctly.
|
If either of these is not true, then @value{GDBN} will still start up,
|
If either of these is not true, then @value{GDBN} will still start up,
|
but will use only the traditional command interface.
|
but will use only the traditional command interface.
|
|
|
The exact layout and appearance of the windows will depend on the host
|
The exact layout and appearance of the windows will depend on the host
|
system type. For instance, GDB under Windows will display its windows
|
system type. For instance, GDB under Windows will display its windows
|
inside a larger window, while under Unix/X, each window is a separate
|
inside a larger window, while under Unix/X, each window is a separate
|
toplevel window. However, general behavior and layout is consistent
|
toplevel window. However, general behavior and layout is consistent
|
across all platforms; omissions or restrictions on particular platforms,
|
across all platforms; omissions or restrictions on particular platforms,
|
if not documented as unavoidable, should be considered bugs and
|
if not documented as unavoidable, should be considered bugs and
|
reported.
|
reported.
|
|
|
All GDB windows have a common structure. Each window has an associated
|
All GDB windows have a common structure. Each window has an associated
|
menu bar, which may be at the top of the window or perhaps elsewhere.
|
menu bar, which may be at the top of the window or perhaps elsewhere.
|
Some of the menus and menu items in the menu bar are common to all GDB
|
Some of the menus and menu items in the menu bar are common to all GDB
|
windows, while others are specific to particular types of windows.
|
windows, while others are specific to particular types of windows.
|
Below the menu bar is the working data area of the window. If the data
|
Below the menu bar is the working data area of the window. If the data
|
is too large to display all at once, the data area will have scroll bars
|
is too large to display all at once, the data area will have scroll bars
|
on its right and bottom sides. Below the data area are two optional
|
on its right and bottom sides. Below the data area are two optional
|
features; a status/data line, and a button box.
|
features; a status/data line, and a button box.
|
|
|
@section Menus
|
@section Menus
|
|
|
@subsection File Menu
|
@subsection File Menu
|
|
|
The standard file menu provides operations that affect the overall state
|
The standard file menu provides operations that affect the overall state
|
of GDB, mainly file operations, but other things as well.
|
of GDB, mainly file operations, but other things as well.
|
|
|
About GDB...
|
About GDB...
|
|
|
Displays the startup window for GDB.
|
Displays the startup window for GDB.
|
|
|
File...
|
File...
|
|
|
Lets you set the combined executable and symbol file that GDB will use.
|
Lets you set the combined executable and symbol file that GDB will use.
|
(Like "file".)
|
(Like "file".)
|
|
|
Target...
|
Target...
|
|
|
Brings up a dialog that you can use to connect GDB to a target program.
|
Brings up a dialog that you can use to connect GDB to a target program.
|
The dialog is described in more depth later.
|
The dialog is described in more depth later.
|
(Like "target".)
|
(Like "target".)
|
|
|
Edit...
|
Edit...
|
|
|
Starts up an editor to modify the source file being displayed.
|
Starts up an editor to modify the source file being displayed.
|
|
|
Exec File...
|
Exec File...
|
|
|
Lets you set the executable file that GDB will use.
|
Lets you set the executable file that GDB will use.
|
(Like "exec-file".)
|
(Like "exec-file".)
|
|
|
Symbol File...
|
Symbol File...
|
|
|
Lets you set the symbol file that GDB will use.
|
Lets you set the symbol file that GDB will use.
|
(Like "symbol-file".)
|
(Like "symbol-file".)
|
|
|
Add Symbol File...
|
Add Symbol File...
|
|
|
Lets you add additional symbol files.
|
Lets you add additional symbol files.
|
(Like "add-symbol-file".)
|
(Like "add-symbol-file".)
|
|
|
Core File...
|
Core File...
|
|
|
Lets you set the core file that GDB will use.
|
Lets you set the core file that GDB will use.
|
(Like "core-file".)
|
(Like "core-file".)
|
|
|
Shared Libraries...
|
Shared Libraries...
|
|
|
(Like "sharedlibrary".)
|
(Like "sharedlibrary".)
|
|
|
Quit
|
Quit
|
|
|
quits GDB.
|
quits GDB.
|
(Like @samp{quit}.)
|
(Like @samp{quit}.)
|
|
|
|
|
@c @subsection Commands Menu
|
@c @subsection Commands Menu
|
|
|
@c The commands menu consists of items that let you run and control the program being
|
@c The commands menu consists of items that let you run and control the program being
|
@c debugged.
|
@c debugged.
|
@c
|
@c
|
@c Run
|
@c Run
|
@c
|
@c
|
@c Step
|
@c Step
|
@c
|
@c
|
@c Next
|
@c Next
|
@c
|
@c
|
@c Finish
|
@c Finish
|
@c
|
@c
|
@c Stepi
|
@c Stepi
|
@c
|
@c
|
@c Nexti
|
@c Nexti
|
|
|
@subsection Windows Menu
|
@subsection Windows Menu
|
|
|
The windows menu allows access to all the windows available in GDB.
|
The windows menu allows access to all the windows available in GDB.
|
The first part of the menu lists all of the predefined individual windows.
|
The first part of the menu lists all of the predefined individual windows.
|
If the window exists already, its item will be marked as such;
|
If the window exists already, its item will be marked as such;
|
selecting the item will cause the window to be put in front if it is
|
selecting the item will cause the window to be put in front if it is
|
obscured. If it does not exist, then it will be created.
|
obscured. If it does not exist, then it will be created.
|
|
|
The second part of the menu lists additional windows that you may have
|
The second part of the menu lists additional windows that you may have
|
created, such as source windows or variable displays.
|
created, such as source windows or variable displays.
|
|
|
Command
|
Command
|
---
|
---
|
Source
|
Source
|
Assembly
|
Assembly
|
---
|
---
|
Registers
|
Registers
|
Variables
|
Variables
|
---
|
---
|
Files
|
Files
|
@c ---
|
@c ---
|
@c <extra windows>
|
@c <extra windows>
|
|
|
@subsection View Menu
|
@subsection View Menu
|
|
|
All windows have a view menu, but its contents are highly specific to
|
All windows have a view menu, but its contents are highly specific to
|
window type. For instance, a source window will have a view menu item
|
window type. For instance, a source window will have a view menu item
|
to control the display of line numbers, but a register window will instead
|
to control the display of line numbers, but a register window will instead
|
have an option to choose the radix in which to display register contents.
|
have an option to choose the radix in which to display register contents.
|
You can find the full description of view options with each window type.
|
You can find the full description of view options with each window type.
|
|
|
@subsection Help Menu
|
@subsection Help Menu
|
|
|
The help menu includes access to GDB's online help.
|
The help menu includes access to GDB's online help.
|
|
|
@section Windows
|
@section Windows
|
|
|
@subsection Command Window
|
@subsection Command Window
|
|
|
The command window provides access to the standard GDB command
|
The command window provides access to the standard GDB command
|
interpreter. In nearly all cases, commands typed into this window
|
interpreter. In nearly all cases, commands typed into this window
|
will behave exactly as for a non-windowing GDB.
|
will behave exactly as for a non-windowing GDB.
|
|
|
Note that not all changes to GDB will be reflected in this window. For instance,
|
Note that not all changes to GDB will be reflected in this window. For instance,
|
if you were to type a "step" command, then click on the "step" menu item in
|
if you were to type a "step" command, then click on the "step" menu item in
|
the source window, then go back, and type another "step" command, the command
|
the source window, then go back, and type another "step" command, the command
|
buffer will only show two steps, when you have actually done three. GDB will
|
buffer will only show two steps, when you have actually done three. GDB will
|
put a "..." into the command buffer when operations in other windows are done,
|
put a "..." into the command buffer when operations in other windows are done,
|
as a reminder that the command buffer is incomplete.
|
as a reminder that the command buffer is incomplete.
|
|
|
@c Also note that as a side effect of having the interface and possibly an
|
@c Also note that as a side effect of having the interface and possibly an
|
@c associated scripting language built in, additional commands may be
|
@c associated scripting language built in, additional commands may be
|
@c available. For instance, if tcl is in GDB, the command ``tcl <tcl code>''
|
@c available. For instance, if tcl is in GDB, the command ``tcl <tcl code>''
|
@c will be available.
|
@c will be available.
|
|
|
The command window has no status line or button box.
|
The command window has no status line or button box.
|
|
|
@subsection Files Window
|
@subsection Files Window
|
|
|
The files window lists all of the files that were used to build the
|
The files window lists all of the files that were used to build the
|
executable.
|
executable.
|
|
|
Clicking on the xxx in the left margin expands/contracts the display of
|
Clicking on the xxx in the left margin expands/contracts the display of
|
included files and symbols defined by the file.
|
included files and symbols defined by the file.
|
|
|
The View menu for this window includes the following items:
|
The View menu for this window includes the following items:
|
Name/Full Pathname
|
Name/Full Pathname
|
@c Sort by Name
|
@c Sort by Name
|
@c Sort by Section&Offset
|
@c Sort by Section&Offset
|
@c Show All Included Files
|
@c Show All Included Files
|
@c Included File Indentation...
|
@c Included File Indentation...
|
|
|
@subsection Source Window
|
@subsection Source Window
|
|
|
A source window displays a single file of source code.
|
A source window displays a single file of source code.
|
|
|
The left margin includes an indicator for the current PC, breakpoints and potential breakpoints,
|
The left margin includes an indicator for the current PC, breakpoints and potential breakpoints,
|
and (optionally) line numbers.
|
and (optionally) line numbers.
|
|
|
The View menu for this window includes the following items:
|
The View menu for this window includes the following items:
|
Show Line Numbers
|
Show Line Numbers
|
Show Breakdots
|
Show Breakdots
|
@c Jump to PC (if pc changes, scroll back so PC is centered)
|
@c Jump to PC (if pc changes, scroll back so PC is centered)
|
@c Tab... (set tabbing)
|
@c Tab... (set tabbing)
|
|
|
@section Extensions
|
@section Extensions
|
|
|
[description of gdbtk details]
|
[description of gdbtk details]
|
|
|
@c
|
@c
|
@c GDBTK Interface Design
|
@c GDBTK Interface Design
|
@c
|
@c
|
@c This is the working document describing the design of the GDBTK
|
@c This is the working document describing the design of the GDBTK
|
@c interface. Note that overall layout applies only to the default setup;
|
@c interface. Note that overall layout applies only to the default setup;
|
@c it is expected that debugger users will be able to customize extensively.
|
@c it is expected that debugger users will be able to customize extensively.
|
@c
|
@c
|
@c Default Startup
|
@c Default Startup
|
@c
|
@c
|
@c One source window, shows source as in "list main", does *not* set a
|
@c One source window, shows source as in "list main", does *not* set a
|
@c break at main or run or anything. No current PC indicator, only put
|
@c break at main or run or anything. No current PC indicator, only put
|
@c in when something runs.
|
@c in when something runs.
|
@c
|
@c
|
@c Source Window
|
@c Source Window
|
@c
|
@c
|
@c For native, "run" button is always the same, for cross, it's actually
|
@c For native, "run" button is always the same, for cross, it's actually
|
@c a "target" button that pops up appropriate dialog to get connected.
|
@c a "target" button that pops up appropriate dialog to get connected.
|
@c Once remote target is active, change button to "run".
|
@c Once remote target is active, change button to "run".
|
@c
|
@c
|
@c Be able to toggle assembly interleaved between source.
|
@c Be able to toggle assembly interleaved between source.
|
@c
|
@c
|
@c Command Window
|
@c Command Window
|
@c
|
@c
|
@c Is an *optional* window.
|
@c Is an *optional* window.
|
@c
|
@c
|
@c Behavior mimics command-line GDB running in an Emacs buffer as much
|
@c Behavior mimics command-line GDB running in an Emacs buffer as much
|
@c as possible.
|
@c as possible.
|
@c
|
@c
|
@c Assembly Window
|
@c Assembly Window
|
@c
|
@c
|
@c Be able to toggle source interleaved between assembly.
|
@c Be able to toggle source interleaved between assembly.
|
@c
|
@c
|
@c Target Info Window
|
@c Target Info Window
|
@c
|
@c
|
@c Contents similar to "info target".
|
@c Contents similar to "info target".
|
@c
|
@c
|
@c Should expand into process and thread info also.
|
@c Should expand into process and thread info also.
|
@c
|
@c
|
@c File Info Window
|
@c File Info Window
|
@c
|
@c
|
@c Contents similar to "info files".
|
@c Contents similar to "info files".
|
@c
|
@c
|
@c Include data shown in "info sources" as well as "info files".
|
@c Include data shown in "info sources" as well as "info files".
|
@c
|
@c
|
@c Register Info Window
|
@c Register Info Window
|
@c
|
@c
|
@c Contents similar to "info registers".
|
@c Contents similar to "info registers".
|
@c
|
@c
|
@c Add view option(s) for classes of registers.
|
@c Add view option(s) for classes of registers.
|
@c
|
@c
|
@c Stack Info Window
|
@c Stack Info Window
|
@c
|
@c
|
@c Combines backtrace, frame, and local var displays.
|
@c Combines backtrace, frame, and local var displays.
|
@c
|
@c
|
@c Signals Dialog
|
@c Signals Dialog
|
@c
|
@c
|
@c Includes all signals whose handling may be controlled, plus
|
@c Includes all signals whose handling may be controlled, plus
|
@c checkboxes for what to do with each.
|
@c checkboxes for what to do with each.
|
@c
|
@c
|
@c Settings Dialog(s)
|
@c Settings Dialog(s)
|
@c
|
@c
|
@c Include all variables that can be "set" and "show"n.
|
@c Include all variables that can be "set" and "show"n.
|
@c
|
@c
|
@c General Principles
|
@c General Principles
|
@c
|
@c
|
@c All windows should have a menu that allows access to other windows.
|
@c All windows should have a menu that allows access to other windows.
|
@c Selection of item either brings up for first time or brings to front.
|
@c Selection of item either brings up for first time or brings to front.
|
@c
|
@c
|
@c All windows should have a "view" menu that controls formatting
|
@c All windows should have a "view" menu that controls formatting
|
@c options for that window.
|
@c options for that window.
|
@c
|
@c
|
@c Windows should usually be scrollable. Windows that display largish
|
@c Windows should usually be scrollable. Windows that display largish
|
@c horizontal things should be horizontal and vertical scrollbars.
|
@c horizontal things should be horizontal and vertical scrollbars.
|
@c
|
@c
|
@c To do standard modification, add commands or tcl code to .gdbtkinit.
|
@c To do standard modification, add commands or tcl code to .gdbtkinit.
|
@c
|
@c
|
@c Be able to record window positions so they come up in the same way
|
@c Be able to record window positions so they come up in the same way
|
@c the next time. Could scribble on .gdbtkinit perhaps, or else an
|
@c the next time. Could scribble on .gdbtkinit perhaps, or else an
|
@c aux file that can be sourced by .gdbtkinit.
|
@c aux file that can be sourced by .gdbtkinit.
|
|
|
@section How to Build
|
@section How to Build
|
|
|
If GDB is configured with --enable-gdbtk, then upon startup, it will
|
If GDB is configured with --enable-gdbtk, then upon startup, it will
|
open windows.
|
open windows.
|
|
|
@node Index
|
@node Index
|
@unnumbered Index
|
@unnumbered Index
|
|
|
@printindex cp
|
@printindex cp
|
|
|
@contents
|
@contents
|
@bye
|
@bye
|
|
|
