-_dnl__ -*-Texinfo-*-
-_dnl__ Copyright (c) 1988 1989 1990 1991 1992 Free Software Foundation, Inc.
-_dnl__ $Id$
\input texinfo @c -*-texinfo-*-
-@c Copyright (c) 1988 1989 1990 1991 1992 Free Software Foundation, Inc.
+@c Copyright (c) 1988 1989 1990 1991 1992 1993 Free Software Foundation, Inc.
+@c
@c %**start of header
-@setfilename _GDBP__.info
-_if__(_GENERIC__)
-@settitle _GDBN__, The GNU Debugger
-_fi__(_GENERIC__)
-_if__(!_GENERIC__)
-@settitle _GDB__, The GNU Debugger (_HOST__)
-_fi__(!_GENERIC__)
+@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.
+@setfilename gdb.info
+@c
+@include gdb-cfg.texi
+@c
+@ifset GENERIC
+@settitle Debugging with @value{GDBN}
+@end ifset
+@ifclear GENERIC
+@settitle Debugging with @value{GDBN} (@value{TARGET})
+@end ifclear
@setchapternewpage odd
+@c %**end of header
+
+@iftex
@c @smallbook
@c @cropmarks
-@c %**end of header
+@end iftex
@finalout
@syncodeindex ky cp
-_0__@c ===> NOTE! <==_1__
-@c Determine the edition number in *three* places by hand:
-@c 1. First ifinfo section 2. title page 3. top node
-@c To find the locations, search for !!set
+@c readline appendices use @vindex
+@syncodeindex vr cp
-@c The following is for Pesch for his RCS system.
-@c This revision number *not* the same as the Edition number.
-@tex
-\def\$#1${{#1}} % Kluge: collect RCS revision info without $...$
-\xdef\manvers{\$Revision$} % For use in headers, footers too
-@end tex
+@c !!set GDB manual's edition---not the same as GDB version!
+@set EDITION 4.10
+
+@c !!set GDB manual's revision date
+@set DATE November 1993
@c GDB CHANGELOG CONSULTED BETWEEN:
@c Fri Oct 11 23:27:06 1991 John Gilmore (gnu at cygnus.com)
@c THIS MANUAL REQUIRES TEXINFO-2 macros and info-makers to format properly.
@ifinfo
+@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.
@format
START-INFO-DIR-ENTRY
-* Gdb: (gdb). The GNU debugger.
+* Gdb:: The GNU debugger.
END-INFO-DIR-ENTRY
@end format
@end ifinfo
-_if__(0)
-
-NOTE: this manual is marked up for preprocessing with a collection
-of m4 macros called "pretex.m4".
-
-THIS IS THE SOURCE PRIOR TO PREPROCESSING. The full source needs to
-be run through m4 before either tex- or info- formatting: for example,
-_0__
- m4 pretex.m4 none.m4 all.m4 gdb.texinfo >gdb-all.texinfo
-will produce (assuming your path finds either GNU m4 >= 0.84, or SysV
-m4; Berkeley will not do) a file suitable for formatting. See the text in
-"pretex.m4" for a fuller explanation (and the macro definitions).
-_1__
-
-_fi__(0)
+@c
@c
@ifinfo
-This file documents the GNU debugger _GDBN__.
+This file documents the GNU debugger @value{GDBN}.
+
-@c !!set edition, date, version
-This is Edition 4.04, March 1992,
-of @cite{Using GDB: A Guide to the GNU Source-Level Debugger}
-for GDB Version _GDB_VN__.
+This is Edition @value{EDITION}, @value{DATE},
+of @cite{Debugging with @value{GDBN}: the GNU Source-Level Debugger}
+for GDB Version @value{GDBVN}.
-Copyright (C) 1988, 1989, 1990, 1991, 1992 Free Software Foundation, Inc.
+Copyright (C) 1988, '89, '90, '91, '92, '93 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@end ignore
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
-section entitled ``GNU General Public License'' is included exactly as
-in the original, and provided that the entire resulting derived work is
-distributed under the terms of a permission notice identical to this
-one.
+entire resulting derived work is distributed under the terms of a
+permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual
-into another language, under the above conditions for modified versions,
-except that the section entitled ``GNU General Public License'' may be
-included in a translation approved by the Free Software Foundation
-instead of in the original English.
+into another language, under the above conditions for modified versions.
@end ifinfo
@titlepage
-@title Using _GDBN__
+@title Debugging with @value{GDBN}
@subtitle The GNU Source-Level Debugger
-_if__(!_GENERIC__)
-@subtitle on _HOST__ Systems
-_fi__(!_GENERIC__)
+@ifclear GENERIC
+@subtitle (@value{TARGET})
+@end ifclear
@sp 1
-@c !!set edition, date, version
-@subtitle Edition 4.04, for _GDBN__ version _GDB_VN__
-@subtitle March 1992
-@author by Richard M. Stallman and Roland H. Pesch
+@subtitle Edition @value{EDITION}, for @value{GDBN} version @value{GDBVN}
+@subtitle @value{DATE}
+@author Richard M. Stallman and Roland H. Pesch
@page
@tex
{\parskip=0pt
-\hfill pesch\@cygnus.com\par
-\hfill {\it Using _GDBN__}, \manvers\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 \TeX{}info \texinfoversion\par
+\hfill pesch\@cygnus.com\par
}
@end tex
@vskip 0pt plus 1filll
-Copyright @copyright{} 1988, 1989, 1990, 1991, 1992 Free Software Foundation, Inc.
+Copyright @copyright{} 1988, '89, '90, '91, '92, '93 Free Software
+Foundation, Inc.
+@sp 2
+Published by the Free Software Foundation @*
+675 Massachusetts Avenue, @*
+Cambridge, MA 02139 USA @*
+Printed copies are available for $20 each. @*
+ISBN 1-882114-11-6 @*
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
-section entitled ``GNU General Public License'' is included exactly as
-in the original, and provided that the entire resulting derived work is
-distributed under the terms of a permission notice identical to this
-one.
+entire resulting derived work is distributed under the terms of a
+permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual
-into another language, under the above conditions for modified versions,
-except that the section entitled ``GNU General Public License'' may be
-included in a translation approved by the Free Software Foundation
-instead of in the original English.
+into another language, under the above conditions for modified versions.
@end titlepage
@page
@ifinfo
-@node Top, Summary, (dir), (dir)
-@top _GDBN__, the GNU symbolic debugger
+@node Top
+@top Debugging with @value{GDBN}
-This file describes _GDBN__, the GNU symbolic debugger.
+This file describes @value{GDBN}, the GNU symbolic debugger.
-@c !!set edition, date, version
-This is Edition 4.04, March 1992, for GDB Version _GDB_VN__.
-@end ifinfo
+This is Edition @value{EDITION}, @value{DATE}, for GDB Version @value{GDBVN}.
@menu
-* Summary:: Summary of _GDBN__
+* Summary:: Summary of @value{GDBN}
+@ifset NOVEL
* New Features:: New features since GDB version 3.5
-* Sample Session:: A sample _GDBN__ session
-* Invocation:: Getting in and out of _GDBN__
-* Commands:: _GDBN__ commands
-* Running:: Running programs under _GDBN__
+@end ifset
+@ifclear BARETARGET
+* Sample Session:: A sample @value{GDBN} session
+@end ifclear
+
+* Invocation:: Getting in and out of @value{GDBN}
+* Commands:: @value{GDBN} commands
+* Running:: Running programs under @value{GDBN}
* Stopping:: Stopping and continuing
* Stack:: Examining the stack
* Source:: Examining source files
* Data:: Examining data
-* Languages:: Using _GDBN__ with different languages
+@ifclear CONLY
+* Languages:: Using @value{GDBN} with different languages
+@end ifclear
+@ifset CONLY
+* C:: C language support
+@end ifset
+@c remnant makeinfo bug, blank line needed after two end-ifs?
+
* Symbols:: Examining the symbol table
* Altering:: Altering execution
-* _GDBN__ Files:: _GDBN__'s files
+* GDB Files:: @value{GDBN} files
* Targets:: Specifying a debugging target
-* Controlling _GDBN__:: Controlling _GDBN__
+* Controlling GDB:: Controlling @value{GDBN}
* Sequences:: Canned sequences of commands
-* Emacs:: Using _GDBN__ under GNU Emacs
-* _GDBN__ Bugs:: Reporting bugs in _GDBN__
+@ifclear DOSHOST
+* Emacs:: Using @value{GDBN} under GNU Emacs
+@end ifclear
+
+* GDB Bugs:: Reporting bugs in @value{GDBN}
+* Command Line Editing:: Facilities of the readline library
+* Using History Interactively::
+@ifset NOVEL
* Renamed Commands::
+@end ifset
+@ifclear PRECONFIGURED
* Formatting Documentation:: How to format and print GDB documentation
* Installing GDB:: Installing GDB
-* Copying:: GNU GENERAL PUBLIC LICENSE
-* Index:: Index
-
- --- The Detailed Node Listing ---
-
-Summary of _GDBN__
-
-* Free Software:: Freely redistributable software
-* Contributors:: Contributors to _GDBN__
-
-Getting In and Out of _GDBN__
-
-* Invoking _GDBN__:: How to start _GDBN__
-* Leaving _GDBN__:: How to quit _GDBN__
-* Shell Commands:: How to use shell commands inside _GDBN__
-
-Starting _GDBN__
-
-* File Options:: Choosing Files
-* Mode Options:: Choosing Modes
-
-_GDBN__ Commands
-
-* Command Syntax:: Command Syntax
-* Help:: Getting Help
-
-Running Programs Under _GDBN__
-
-* Compilation:: Compiling for Debugging
-* Starting:: Starting your Program
-* Arguments:: Your Program's Arguments
-* Environment:: Your Program's Environment
-* Working Directory:: Your Program's Working Directory
-* Input/Output:: Your Program's Input and Output
-* Attach:: Debugging an Already-Running Process
-* Kill Process:: Killing the Child Process
-* Process Information:: Additional Process Information
-
-Stopping and Continuing
-
-* Breakpoints:: Breakpoints, Watchpoints, and Exceptions
-* Continuing and Stepping:: Resuming Execution
-* Signals:: Signals
-
-Breakpoints, Watchpoints, and Exceptions
-
-* Set Breaks:: Setting Breakpoints
-* Set Watchpoints:: Setting Watchpoints
-* Exception Handling:: Breakpoints and Exceptions
-* Delete Breaks:: Deleting Breakpoints
-* Disabling:: Disabling Breakpoints
-* Conditions:: Break Conditions
-* Break Commands:: Breakpoint Command Lists
-* Breakpoint Menus:: Breakpoint Menus
-* Error in Breakpoints:: ``Cannot insert breakpoints''
-
-Examining the Stack
-
-* Frames:: Stack Frames
-* Backtrace:: Backtraces
-* Selection:: Selecting a Frame
-* Frame Info:: Information on a Frame
-
-Examining Source Files
-
-* List:: Printing Source Lines
-* Search:: Searching Source Files
-* Source Path:: Specifying Source Directories
-* Machine Code:: Source and Machine Code
-
-Examining Data
-
-* Expressions:: Expressions
-* Variables:: Program Variables
-* Arrays:: Artificial Arrays
-* Output formats:: Output formats
-* Memory:: Examining Memory
-* Auto Display:: Automatic Display
-* Print Settings:: Print Settings
-* Value History:: Value History
-* Convenience Vars:: Convenience Variables
-* Registers:: Registers
-* Floating Point Hardware:: Floating Point Hardware
-
-Using GDB with Different Languages
-
-* Setting:: Switching between source languages
-* Show:: Displaying the language
-* Checks:: Type and Range checks
-* Support:: Supported languages
-
-Switching between source languages
-
-* Manually:: Setting the working language manually
-* Automatically:: Having GDB infer the source language
-
-Type and range Checking
-
-* Type Checking:: An overview of type checking
-* Range Checking:: An overview of range checking
-
-Supported Languages
-
-* C:: C and C++
-* Modula-2:: Modula-2
-
-C and C++
-
-* C Operators:: C and C++ Operators
-* C Constants:: C and C++ Constants
-* Cplusplus expressions:: C++ Expressions
-* C Defaults:: Default settings for C and C++
-* C Checks:: C and C++ Type and Range Checks
-* Debugging C:: _GDBN__ and C
-* Debugging C plus plus:: Special features for C++
-
-Modula-2
-
-* M2 Operators:: Built-in operators
-* Built-In Func/Proc:: Built-in Functions and Procedures
-* M2 Constants:: Modula-2 Constants
-* M2 Defaults:: Default settings for Modula-2
-* Deviations:: Deviations from standard Modula-2
-* M2 Checks:: Modula-2 Type and Range Checks
-* M2 Scope:: The scope operators @code{::} and @code{.}
-* GDB/M2:: GDB and Modula-2
-
-Altering Execution
-
-* Assignment:: Assignment to Variables
-* Jumping:: Continuing at a Different Address
-* Signaling:: Giving your program a Signal
-* Returning:: Returning from a Function
-* Calling:: Calling your Program's Functions
-* Patching:: Patching your Program
-
-_GDBN__'s Files
-
-* Files:: Commands to Specify Files
-* Symbol Errors:: Errors Reading Symbol Files
-
-Specifying a Debugging Target
-
-* Active Targets:: Active Targets
-* Target Commands:: Commands for Managing Targets
-* Remote:: Remote Debugging
-
-Remote Debugging
-
-* i960-Nindy Remote:: _GDBN__ with a Remote i960 (Nindy)
-* EB29K Remote:: _GDBN__ with a Remote EB29K
-* VxWorks Remote:: _GDBN__ and VxWorks
-
-_GDBN__ with a Remote i960 (Nindy)
-
-* Nindy Startup:: Startup with Nindy
-* Nindy Options:: Options for Nindy
-* Nindy reset:: Nindy Reset Command
-
-_GDBN__ with a Remote EB29K
-
-* Comms (EB29K):: Communications Setup
-* gdb-EB29K:: EB29K cross-debugging
-* Remote Log:: Remote Log
-
-_GDBN__ and VxWorks
-
-* VxWorks connection:: Connecting to VxWorks
-* VxWorks download:: VxWorks Download
-* VxWorks attach:: Running Tasks
-
-Controlling _GDBN__
-
-* Prompt:: Prompt
-* Editing:: Command Editing
-* History:: Command History
-* Screen Size:: Screen Size
-* Numbers:: Numbers
-* Messages/Warnings:: Optional Warnings and Messages
-
-Canned Sequences of Commands
-
-* Define:: User-Defined Commands
-* Command Files:: Command Files
-* Output:: Commands for Controlled Output
+@end ifclear
-Reporting Bugs in _GDBN__
-
-* Bug Criteria:: Have You Found a Bug?
-* Bug Reporting:: How to Report Bugs
-
-Installing GDB
-
-* Separate Objdir:: Compiling _GDBN__ in another directory
-* Config Names:: Specifying names for hosts and targets
-* configure Options:: Summary of options for configure
+* Index:: Index
@end menu
+@end ifinfo
-@node Summary, New Features, Top, Top
-@unnumbered Summary of _GDBN__
+@node Summary
+@unnumbered Summary of @value{GDBN}
-The purpose of a debugger such as _GDBN__ is to allow you to see what is
+The purpose of a debugger such as @value{GDBN} is to allow you to see what is
going on ``inside'' another program while it executes---or what another
program was doing at the moment it crashed.
-_GDBN__ can do four main kinds of things (plus other things in support of
+@value{GDBN} can do four main kinds of things (plus other things in support of
these) to help you catch bugs in the act:
@itemize @bullet
effects of one bug and go on to learn about another.
@end itemize
-You can use _GDBN__ to debug programs written in C, C++, and Modula-2.
-Fortran support will be added when a GNU Fortran compiler is ready.
+@ifclear CONLY
+You can use @value{GDBN} to debug programs written in C or C++. For
+more information, see @ref{C,,C and C++}.
+
+@ifset MOD2
+@c "MOD2" used as a "miscellaneous languages" flag here.
+@c This is acceptable while there is no real doc for Chill and Pascal.
+Support for Modula-2 and Chill is partial. For information on Modula-2,
+see @ref{Modula-2,,Modula-2}; there is no further documentation on Chill yet.
+
+Debugging pascal programs which use sets, subranges, file variables, or nested
+functions does not currently work. @value{GDBN} does not support
+entering expressions, printing values, etc. using Pascal syntax.
+@end ifset
+@ifset FORTRAN
+@cindex Fortran
+@value{GDBN} can be used to debug programs written in Fortran, although
+it does not yet support entering expressions, printing values, etc.
+using Fortran syntax. It may be necessary to refer to some variables
+with a trailing underscore.
+@end ifset
+@end ifclear
@menu
-* Free Software:: Free Software
+* Free Software:: Freely redistributable software
* Contributors:: Contributors to GDB
@end menu
-@node Free Software, Contributors, Summary, Summary
-@unnumberedsec Free Software
+@node Free Software
+@unnumberedsec Free software
-_GDBN__ is @dfn{free software}, protected by the GNU General Public License
+@value{GDBN} is @dfn{free software}, protected by the GNU General Public License
(GPL). The GPL gives you the freedom to copy or adapt a licensed
program---but every person getting a copy also gets with it the
freedom to modify that copy (which means that they must get access to
you have these freedoms and that you cannot take these freedoms away
from anyone else.
-For full details, @pxref{Copying, ,GNU GENERAL PUBLIC LICENSE}.
-
-@node Contributors, , Free Software, Summary
+@node Contributors
@unnumberedsec Contributors to GDB
Richard Stallman was the original author of GDB, and of many other GNU
@quotation
@emph{Plea:} Additions to this section are particularly welcome. If you
-or your friends (or enemies; let's be evenhanded) have been unfairly
+or your friends (or enemies, to be evenhanded) have been unfairly
omitted from this list, we would like to add your names!
@end quotation
So that they may not regard their long labor as thankless, we
-particularly thank those who shepherded GDB through major releases: Stu
-Grossman and John Gilmore (releases 4.5, 4.4), John Gilmore (releases 4.3, 4.2,
-4.1, 4.0, and 3.9); Jim Kingdon (releases 3.5, 3.4, 3.3); and Randy
-Smith (releases 3.2, 3.1, 3.0). As major maintainer of GDB for some
-period, each contributed significantly to the structure, stability, and
-capabilities of the entire debugger.
-
-Richard Stallman, assisted at various times by Pete TerMaat, Chris
+particularly thank those who shepherded GDB through major releases: Fred
+Fish (releases 4.11, 4.10, 4.9), Stu Grossman and John Gilmore (releases
+4.8, 4.7, 4.6, 4.5, 4.4), John Gilmore (releases 4.3, 4.2, 4.1, 4.0, and
+3.9); Jim Kingdon (releases 3.5, 3.4, 3.3); and Randy Smith (releases
+3.2, 3.1, 3.0). As major maintainer of GDB for some period, each
+contributed significantly to the structure, stability, and capabilities
+of the entire debugger.
+
+Richard Stallman, assisted at various times by Peter TerMaat, Chris
Hanson, and Richard Mlynarik, handled releases through 2.8.
+@ifclear CONLY
Michael Tiemann is the author of most of the GNU C++ support in GDB,
with significant additional contributions from Per Bothner. James
Clark wrote the GNU C++ demangler. Early work on C++ was by Peter
TerMaat (who also did much general update work leading to release 3.0).
+@end ifclear
GDB 4 uses the BFD subroutine library to examine multiple
object-file formats; BFD was a joint project of David V.
Brian Fox is the author of the readline libraries providing
command-line editing and command history.
-Andrew Beers of SUNY Buffalo wrote the language-switching code and
-the Modula-2 support, and contributed the Languages chapter of this
-manual.
+Andrew Beers of SUNY Buffalo wrote the language-switching code,
+@ifset MOD2
+the Modula-2 support,
+@end ifset
+and contributed the Languages chapter of this manual.
+
+Fred Fish wrote most of the support for Unix System Vr4.
+@ifclear CONLY
+He also enhanced the command-completion support to cover C++ overloaded
+symbols.
+@end ifclear
-Fred Fish wrote most of the support for Unix System Vr4.
+Hitachi America, Ltd. sponsored the support for Hitachi microprocessors.
-@node New Features, Sample Session, Summary, Top
-@unnumbered New Features since GDB version 3.5
+@ifset NOVEL
+@node New Features
+@unnumbered New Features since GDB Version 3.5
@table @emph
@item Targets
you are debugging local files, local processes, standalone systems over
a serial port, realtime systems over a TCP/IP connection, etc. The
command @code{load} can download programs into a remote system. Serial
-stubs are available for Motorola 680x0 and Intel 80386 remote systems;
-GDB also supports debugging realtime processes running under
+stubs are available for Motorola 680x0, Intel 80386, and Sparc remote
+systems; GDB also supports debugging realtime processes running under
VxWorks, using SunRPC Remote Procedure Calls over TCP/IP to talk to a
-debugger stub on the target system. Internally, GDB now uses a
-function vector to mediate access to different targets; if you need to
-add your own support for a remote protocol, this makes it much easier.
+debugger stub on the target system. Internally, GDB now uses a function
+vector to mediate access to different targets; if you need to add your
+own support for a remote protocol, this makes it much easier.
@item Watchpoints
GDB now sports watchpoints as well as breakpoints. You can use a
to make the output more readable.
@item Object Code Formats
-GDB uses a new library called the Binary File Descriptor (BFD)
-Library to permit it to switch dynamically, without reconfiguration or
+GDB uses a new library called the Binary File Descriptor (BFD) Library
+to permit it to switch dynamically, without reconfiguration or
recompilation, between different object-file formats. Formats currently
-supported are COFF, a.out, and the Intel 960 b.out; files may be read as
-.o's, archive libraries, or core dumps. BFD is available as a
-subroutine library so that other programs may take advantage of it, and
-the other GNU binary utilities are being converted to use it.
+supported are COFF, ELF, a.out, Intel 960 b.out, MIPS ECOFF, HPPA SOM
+(with stabs debugging), and S-records; files may be read as .o files,
+archive libraries, or core dumps. BFD is available as a subroutine
+library so that other programs may take advantage of it, and the other
+GNU binary utilities are being converted to use it.
@item Configuration and Ports
Compile-time configuration (to select a particular architecture and
operating system) is much easier. The script @code{configure} now
allows you to configure GDB as either a native debugger or a
cross-debugger. @xref{Installing GDB}, for details on how to
-configure and on what architectures are now available.
+configure.
@item Interaction
-The user interface to GDB's control variables has been simplified
-and consolidated in two commands, @code{set} and @code{show}. Output
+The user interface to the GDB control variables is simpler,
+and is consolidated in two commands, @code{set} and @code{show}. Output
lines are now broken at readable places, rather than overflowing onto
the next line. You can suppress output of machine-level addresses,
displaying only source language information.
can break when an exception is raised, before the stack is peeled back
to the exception handler's context.
+@ifset MOD2
@item Modula-2
-GDB now has preliminary support for the GNU Modula-2 compiler,
-currently under development at the State University of New York at
-Buffalo. Coordinated development of both GDB and the GNU Modula-2
-compiler will continue into 1992. Other Modula-2 compilers are
-currently not supported, and attempting to debug programs compiled with
-them will likely result in an error as the symbol table of the
-executable is read in.
+GDB now has preliminary support for the GNU Modula-2 compiler, currently
+under development at the State University of New York at Buffalo.
+Coordinated development of both GDB and the GNU Modula-2 compiler will
+continue. Other Modula-2 compilers are currently not supported, and
+attempting to debug programs compiled with them will likely result in an
+error as the symbol table of the executable is read in.
+@end ifset
@item Command Rationalization
Many GDB commands have been renamed to make them easier to remember
GDB 4 can debug programs and core files that use SunOS, SVR4, or IBM RS/6000
shared libraries.
-@item Reference Card
-GDB 4 has a reference card. @xref{Formatting Documentation} for
-instructions on printing it.
+@item Threads
+On some systems, GDB 4 has facilities to debug multi-thread programs.
-@item Work in Progress
-Kernel debugging for BSD and Mach systems; Tahoe and HPPA architecture
-support.
+@item Reference Card
+GDB 4 has a reference card. @xref{Formatting Documentation,,Formatting
+the Documentation}, for instructions about how to print it.
@end table
+@end ifset
-@node Sample Session, Invocation, New Features, Top
-@chapter A Sample _GDBN__ Session
+@ifclear BARETARGET
+@node Sample Session
+@chapter A Sample @value{GDBN} Session
-You can use this manual at your leisure to read all about _GDBN__.
+You can use this manual at your leisure to read all about @value{GDBN}.
However, a handful of commands are enough to get started using the
-debugger. This chapter illustrates these commands.
+debugger. This chapter illustrates those commands.
@iftex
In this sample session, we emphasize user input like this: @b{input},
@c FIXME: this example may not be appropriate for some configs, where
@c FIXME...primary interest is in remote use.
-_0__
+
One of the preliminary versions of GNU @code{m4} (a generic macro
processor) exhibits the following bug: sometimes, when we change its
-quote strings from the default, the commands used to capture one macro's
-definition in another stop working. In the following short @code{m4}
+quote strings from the default, the commands used to capture one macro
+definition within another stop working. In the following short @code{m4}
session, we define a macro @code{foo} which expands to @code{0000}; we
then use the @code{m4} built-in @code{defn} to define @code{bar} as the
same thing. However, when we change the open quote string to
@end smallexample
@noindent
-Let's use _GDBN__ to try to see what's going on.
+Let us use @value{GDBN} to try to see what is going on.
@smallexample
-$ @b{_GDBP__ m4}
+$ @b{@value{GDBP} m4}
@c FIXME: this falsifies the exact text played out, to permit smallbook
@c FIXME... format to come out better.
GDB is free software and you are welcome to distribute copies
of it under certain conditions; type "show copying" to see
the conditions.
There is absolutely no warranty for GDB; type "show warranty"
-for details.
-GDB _GDB_VN__, Copyright 1992 Free Software Foundation, Inc...
-(_GDBP__)
+ for details.
+GDB @value{GDBVN}, Copyright 1993 Free Software Foundation, Inc...
+(@value{GDBP})
@end smallexample
@noindent
-_GDBN__ reads only enough symbol data to know where to find the rest when
+@value{GDBN} reads only enough symbol data to know where to find the rest when
needed; as a result, the first prompt comes up very quickly. We now
-tell _GDBN__ to use a narrower display width than usual, so that examples
+tell @value{GDBN} to use a narrower display width than usual, so that examples
will fit in this manual.
@smallexample
-(_GDBP__) @b{set width 70}
+(@value{GDBP}) @b{set width 70}
@end smallexample
@noindent
-Let's see how the @code{m4} built-in @code{changequote} works.
+We need to see how the @code{m4} built-in @code{changequote} works.
Having looked at the source, we know the relevant subroutine is
-@code{m4_changequote}, so we set a breakpoint there with _GDBN__'s
+@code{m4_changequote}, so we set a breakpoint there with the @value{GDBN}
@code{break} command.
@smallexample
-(_GDBP__) @b{break m4_changequote}
+(@value{GDBP}) @b{break m4_changequote}
Breakpoint 1 at 0x62f4: file builtin.c, line 879.
@end smallexample
@noindent
-Using the @code{run} command, we start @code{m4} running under _GDBN__
+Using the @code{run} command, we start @code{m4} running under @value{GDBN}
control; as long as control does not reach the @code{m4_changequote}
subroutine, the program runs as usual:
@smallexample
-(_GDBP__) @b{run}
+(@value{GDBP}) @b{run}
Starting program: /work/Editorial/gdb/gnu/m4/m4
@b{define(foo,0000)}
@end smallexample
@noindent
-To trigger the breakpoint, we call @code{changequote}. _GDBN__
+To trigger the breakpoint, we call @code{changequote}. @value{GDBN}
suspends execution of @code{m4}, displaying information about the
context where it stops.
the next line of the current function.
@smallexample
-(_GDBP__) @b{n}
+(@value{GDBP}) @b{n}
882 set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\
: nil,
@end smallexample
subroutine, so it steps into @code{set_quotes}.
@smallexample
-(_GDBP__) @b{s}
+(@value{GDBP}) @b{s}
set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
at input.c:530
530 if (lquote != def_lquote)
stack frame for each active subroutine.
@smallexample
-(_GDBP__) @b{bt}
+(@value{GDBP}) @b{bt}
#0 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
at input.c:530
#1 0x6344 in m4_changequote (argc=3, argv=0x33c70)
@end smallexample
@noindent
-Let's step through a few more lines to see what happens. The first two
+We will step through a few more lines to see what happens. The first two
times, we can use @samp{s}; the next two times we use @code{n} to avoid
falling into the @code{xstrdup} subroutine.
@smallexample
-(_GDBP__) @b{s}
+(@value{GDBP}) @b{s}
0x3b5c 532 if (rquote != def_rquote)
-(_GDBP__) @b{s}
+(@value{GDBP}) @b{s}
0x3b80 535 lquote = (lq == nil || *lq == '\0') ? \
def_lquote : xstrdup(lq);
-(_GDBP__) @b{n}
+(@value{GDBP}) @b{n}
536 rquote = (rq == nil || *rq == '\0') ? def_rquote\
: xstrdup(rq);
-(_GDBP__) @b{n}
+(@value{GDBP}) @b{n}
538 len_lquote = strlen(rquote);
@end smallexample
@noindent
-The last line displayed looks a little odd; let's examine the variables
+The last line displayed looks a little odd; we can examine the variables
@code{lquote} and @code{rquote} to see if they are in fact the new left
-and right quotes we specified. We can use the command @code{p}
+and right quotes we specified. We use the command @code{p}
(@code{print}) to see their values.
@smallexample
-(_GDBP__) @b{p lquote}
+(@value{GDBP}) @b{p lquote}
$1 = 0x35d40 "<QUOTE>"
-(_GDBP__) @b{p rquote}
+(@value{GDBP}) @b{p rquote}
$2 = 0x35d50 "<UNQUOTE>"
@end smallexample
@noindent
@code{lquote} and @code{rquote} are indeed the new left and right quotes.
-Let's look at some context; we can display ten lines of source
-surrounding the current line, with the @code{l} (@code{list}) command.
+To look at some context, we can display ten lines of source
+surrounding the current line with the @code{l} (@code{list}) command.
@smallexample
-(_GDBP__) @b{l}
+(@value{GDBP}) @b{l}
533 xfree(rquote);
534
535 lquote = (lq == nil || *lq == '\0') ? def_lquote\
@end smallexample
@noindent
-Let's step past the two lines that set @code{len_lquote} and
+Let us step past the two lines that set @code{len_lquote} and
@code{len_rquote}, and then examine the values of those variables.
@smallexample
-(_GDBP__) @b{n}
+(@value{GDBP}) @b{n}
539 len_rquote = strlen(lquote);
-(_GDBP__) @b{n}
+(@value{GDBP}) @b{n}
540 @}
-(_GDBP__) @b{p len_lquote}
+(@value{GDBP}) @b{p len_lquote}
$3 = 9
-(_GDBP__) @b{p len_rquote}
+(@value{GDBP}) @b{p len_rquote}
$4 = 7
@end smallexample
@noindent
That certainly looks wrong, assuming @code{len_lquote} and
@code{len_rquote} are meant to be the lengths of @code{lquote} and
-@code{rquote} respectively. Let's try setting them to better values.
-We can use the @code{p} command for this, since it'll print the value of
+@code{rquote} respectively. We can set them to better values using
+the @code{p} command, since it can print the value of
any expression---and that expression can include subroutine calls and
assignments.
@smallexample
-(_GDBP__) @b{p len_lquote=strlen(lquote)}
+(@value{GDBP}) @b{p len_lquote=strlen(lquote)}
$5 = 7
-(_GDBP__) @b{p len_rquote=strlen(rquote)}
+(@value{GDBP}) @b{p len_rquote=strlen(rquote)}
$6 = 9
@end smallexample
@noindent
-Let's see if that fixes the problem of using the new quotes with the
-@code{m4} built-in @code{defn}. We can allow @code{m4} to continue
+Is that enough to fix the problem of using the new quotes with the
+@code{m4} built-in @code{defn}? We can allow @code{m4} to continue
executing with the @code{c} (@code{continue}) command, and then try the
example that caused trouble initially:
@smallexample
-(_GDBP__) @b{c}
+(@value{GDBP}) @b{c}
Continuing.
@b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
@noindent
Success! The new quotes now work just as well as the default ones. The
problem seems to have been just the two typos defining the wrong
-lengths. We'll let @code{m4} exit by giving it an EOF as input.
+lengths. We allow @code{m4} exit by giving it an EOF as input:
@smallexample
@b{C-d}
@end smallexample
@noindent
-The message @samp{Program exited normally.} is from _GDBN__; it
-indicates @code{m4} has finished executing. We can end our _GDBN__
-session with the _GDBN__ @code{quit} command.
+The message @samp{Program exited normally.} is from @value{GDBN}; it
+indicates @code{m4} has finished executing. We can end our @value{GDBN}
+session with the @value{GDBN} @code{quit} command.
@smallexample
-(_GDBP__) @b{quit}
-_1__@end smallexample
+(@value{GDBP}) @b{quit}
+@end smallexample
+@end ifclear
-@node Invocation, Commands, Sample Session, Top
-@chapter Getting In and Out of _GDBN__
+@node Invocation
+@chapter Getting In and Out of @value{GDBN}
-This chapter discusses how to start _GDBN__, and how to get out of it.
-(The essentials: type @samp{_GDBP__} to start GDB, and type @kbd{quit}
+This chapter discusses how to start @value{GDBN}, and how to get out of it.
+(The essentials: type @samp{@value{GDBP}} to start GDB, and type @kbd{quit}
or @kbd{C-d} to exit.)
@menu
-* Invoking _GDBN__:: Starting _GDBN__
-* Leaving _GDBN__:: Leaving _GDBN__
-* Shell Commands:: Shell Commands
+* Invoking GDB:: How to start @value{GDBN}
+* Quitting GDB:: How to quit @value{GDBN}
+* Shell Commands:: How to use shell commands inside @value{GDBN}
@end menu
-@node Invoking _GDBN__, Leaving _GDBN__, Invocation, Invocation
-@section Starting _GDBN__
+@node Invoking GDB
+@section Invoking @value{GDBN}
+
+@ifset H8EXCLUSIVE
+For details on starting up @value{GDBP} as a
+remote debugger attached to a Hitachi microprocessor, see @ref{Hitachi
+Remote,,@value{GDBN} and Hitachi Microprocessors}.
+@end ifset
-Start _GDBN__ with the shell command @code{_GDBP__}. Once it's running,
-_GDBN__ reads commands from the terminal until you tell it to exit.
+Invoke @value{GDBN} by running the program @code{@value{GDBP}}. Once started,
+@value{GDBN} reads commands from the terminal until you tell it to exit.
-You can also run @code{_GDBP__} with a variety of arguments and options,
+You can also run @code{@value{GDBP}} with a variety of arguments and options,
to specify more of your debugging environment at the outset.
+@ifset GENERIC
The command-line options described here are designed
to cover a variety of situations; in some environments, some of these
options may effectively be unavailable.
+@end ifset
-_if__(_H8__)
-For details on starting up _GDBP__ as a
-remote debugger attached to a Hitachi H8/300 board, see @ref{Hitachi
-H8/300 Remote,,_GDBN__ and the Hitachi H8/300}.
-_fi__(_H8__)
-
-The most usual way to start _GDBN__ is with one argument or two,
-specifying an executable program as the argument:
+The most usual way to start @value{GDBN} is with one argument,
+specifying an executable program:
@example
-_GDBP__ @var{program}
+@value{GDBP} @var{program}
@end example
+@ifclear BARETARGET
@noindent
You can also start with both an executable program and a core file
specified:
@example
-_GDBP__ @var{program} @var{core}
+@value{GDBP} @var{program} @var{core}
@end example
You can, instead, specify a process ID as a second argument, if you want
to debug a running process:
@example
-_GDBP__ @var{program} 1234
+@value{GDBP} @var{program} 1234
@end example
@noindent
-would attach _GDBN__ to process @code{1234} (unless you also have a file
-named @file{1234}; _GDBN__ does check for a core file first).
+would attach @value{GDBN} to process @code{1234} (unless you also have a file
+named @file{1234}; @value{GDBN} does check for a core file first).
Taking advantage of the second command-line argument requires a fairly
-complete operating system; when you use _GDBN__ as a remote debugger
+complete operating system; when you use @value{GDBN} as a remote debugger
attached to a bare board, there may not be any notion of ``process'',
and there is often no way to get a core dump.
+@end ifclear
@noindent
-You can further control how _GDBN__ starts up by using command-line
-options. _GDBN__ itself can remind you of the options available.
+You can further control how @value{GDBN} starts up by using command-line
+options. @value{GDBN} itself can remind you of the options available.
@noindent
Type
@example
-_GDBP__ -help
+@value{GDBP} -help
@end example
@noindent
to display all available options and briefly describe their use
-(@samp{_GDBP__ -h} is a shorter equivalent).
+(@samp{@value{GDBP} -h} is a shorter equivalent).
All options and command line arguments you give are processed
in sequential order. The order makes a difference when the
@samp{-x} option is used.
+
@menu
-* File Options:: Choosing Files
-* Mode Options:: Choosing Modes
-_if__(!_GENERIC__)
-_include__(gdbinv-m.m4)_dnl__
-_fi__(!_GENERIC__)
+@ifclear GENERIC
+@ifset REMOTESTUB
+* Remote Serial:: @value{GDBN} remote serial protocol
+@end ifset
+@ifset I960
+* i960-Nindy Remote:: @value{GDBN} with a remote i960 (Nindy)
+@end ifset
+@ifset AMD29K
+* UDI29K Remote:: @value{GDBN} and the UDI protocol for AMD29K
+* EB29K Remote:: @value{GDBN} with a remote EB29K
+@end ifset
+@ifset VXWORKS
+* VxWorks Remote:: @value{GDBN} and VxWorks
+@end ifset
+@ifset ST2000
+* ST2000 Remote:: @value{GDBN} with a Tandem ST2000
+@end ifset
+@ifset H8
+* Hitachi Remote:: @value{GDBN} and Hitachi Microprocessors
+@end ifset
+@ifset MIPS
+* MIPS Remote:: @value{GDBN} and MIPS boards
+@end ifset
+@ifset SIMS
+* Simulator:: Simulated CPU target
+@end ifset
+@end ifclear
+@c remnant makeinfo bug requires this blank line after *two* end-ifblahs:
+
+* File Options:: Choosing files
+* Mode Options:: Choosing modes
@end menu
-@node File Options, Mode Options, Invoking _GDBN__, Invoking _GDBN__
-@subsection Choosing Files
+@ifclear GENERIC
+@include remote.texi
+@end ifclear
-When _GDBN__ starts, it reads any arguments other than options as
+@node File Options
+@subsection Choosing files
+
+@ifclear BARETARGET
+When @value{GDBN} starts, it reads any arguments other than options as
specifying an executable file and core file (or process ID). This is
the same as if the arguments were specified by the @samp{-se} and
-@samp{-c} options respectively. (_GDBN__ reads the first argument
+@samp{-c} options respectively. (@value{GDBN} reads the first argument
that does not have an associated option flag as equivalent to the
@samp{-se} option followed by that argument; and the second argument
that does not have an associated option flag, if any, as equivalent to
the @samp{-c} option followed by that argument.)
+@end ifclear
+@ifset BARETARGET
+When @value{GDBN} starts, it reads any argument other than options as
+specifying an executable file. This is the same as if the argument was
+specified by the @samp{-se} option.
+@end ifset
Many options have both long and short forms; both are shown in the
-following list. _GDBN__ also recognizes the long forms if you truncate
+following list. @value{GDBN} also recognizes the long forms if you truncate
them, so long as enough of the option is present to be unambiguous.
(If you prefer, you can flag option arguments with @samp{--} rather
than @samp{-}, though we illustrate the more usual convention.)
@table @code
-@item -symbols=@var{file}
+@item -symbols @var{file}
@itemx -s @var{file}
Read symbol table from file @var{file}.
-@item -exec=@var{file}
+@item -exec @var{file}
@itemx -e @var{file}
Use file @var{file} as the executable file to execute when
+@ifset BARETARGET
+appropriate.
+@end ifset
+@ifclear BARETARGET
appropriate, and for examining pure data in conjunction with a core
dump.
+@end ifclear
-@item -se=@var{file}
+@item -se @var{file}
Read symbol table from file @var{file} and use it as the executable
file.
-@item -core=@var{file}
+@ifclear BARETARGET
+@item -core @var{file}
@itemx -c @var{file}
Use file @var{file} as a core dump to examine.
-@item -command=@var{file}
+@item -c @var{number}
+Connect to process ID @var{number}, as with the @code{attach} command
+(unless there is a file in core-dump format named @var{number}, in which
+case @samp{-c} specifies that file as a core dump to read).
+@end ifclear
+
+@item -command @var{file}
@itemx -x @var{file}
-Execute _GDBN__ commands from file @var{file}. @xref{Command Files}.
+Execute @value{GDBN} commands from file @var{file}. @xref{Command
+Files,, Command files}.
-@item -directory=@var{directory}
+@item -directory @var{directory}
@itemx -d @var{directory}
Add @var{directory} to the path to search for source files.
+@ifclear BARETARGET
@item -m
@itemx -mapped
@emph{Warning: this option depends on operating system facilities that are not
supported on all systems.}@*
If memory-mapped files are available on your system through the @code{mmap}
system call, you can use this option
-to cause _GDBN__ to write the symbols from your
+to have @value{GDBN} write the symbols from your
program into a reusable file in the current directory. If the program you are debugging is
called @file{/tmp/fred}, the mapped symbol file will be @file{./fred.syms}.
-Future _GDBN__ debugging sessions will notice the presence of this file,
+Future @value{GDBN} debugging sessions will notice the presence of this file,
and will quickly map in symbol information from it, rather than reading
the symbol table from the executable program.
-The @file{.syms} file is specific to the host machine on which _GDBN__ is run.
-It holds an exact image of _GDBN__'s internal symbol table. It cannot be
-shared across multiple host platforms.
+@c FIXME! Really host, not target?
+The @file{.syms} file is specific to the host machine where @value{GDBN}
+is run. It holds an exact image of the internal @value{GDBN} symbol
+table. It cannot be shared across multiple host platforms.
+@end ifclear
@item -r
@itemx -readnow
This makes startup slower, but makes future operations faster.
@end table
-The @code{-mapped} and @code{-readnow} options are typically combined in order to
-build a @file{.syms} file that contains complete symbol information.
-A simple GDB invocation to do nothing but build a @file{.syms} file for future
-use is:
+@ifclear BARETARGET
+The @code{-mapped} and @code{-readnow} options are typically combined in
+order to build a @file{.syms} file that contains complete symbol
+information. (@xref{Files,,Commands to specify files}, for information
+on @file{.syms} files.) A simple GDB invocation to do nothing but build
+a @file{.syms} file for future use is:
@example
gdb -batch -nx -mapped -readnow programname
@end example
+@end ifclear
-_if__(!_GENERIC__)
-@node Mode Options, Mode Options, File Options, Invoking _GDBN__
-_fi__(!_GENERIC__)
-_if__(_GENERIC__)
-@node Mode Options, , File Options, Invoking _GDBN__
-_fi__(_GENERIC__)
-@subsection Choosing Modes
+@node Mode Options
+@subsection Choosing modes
-You can run _GDBN__ in various alternative modes---for example, in
+You can run @value{GDBN} in various alternative modes---for example, in
batch mode or quiet mode.
@table @code
@item -nx
@itemx -n
-Do not execute commands from any @file{_GDBINIT__} initialization files.
-Normally, the commands in these files are executed after all the
-command options and arguments have been processed.
-@xref{Command Files}.
+Do not execute commands from any initialization files (normally called
+@file{@value{GDBINIT}}). Normally, the commands in these files are
+executed after all the command options and arguments have been
+processed. @xref{Command Files,,Command files}.
@item -quiet
@itemx -q
messages are also suppressed in batch mode.
@item -batch
-Run in batch mode. Exit with status @code{0} after processing all the command
-files specified with @samp{-x} (and @file{_GDBINIT__}, if not inhibited).
-Exit with nonzero status if an error occurs in executing the _GDBN__
-commands in the command files.
+Run in batch mode. Exit with status @code{0} after processing all the
+command files specified with @samp{-x} (and all commands from
+initialization files, if not inhibited with @samp{-n}). Exit with
+nonzero status if an error occurs in executing the @value{GDBN} commands
+in the command files.
-Batch mode may be useful for running _GDBN__ as a filter, for example to
+Batch mode may be useful for running @value{GDBN} as a filter, for example to
download and run a program on another computer; in order to make this
more useful, the message
@end example
@noindent
-(which is ordinarily issued whenever a program running under _GDBN__ control
+(which is ordinarily issued whenever a program running under @value{GDBN} control
terminates) is not issued when running in batch mode.
-@item -cd=@var{directory}
-Run _GDBN__ using @var{directory} as its working directory,
+@item -cd @var{directory}
+Run @value{GDBN} using @var{directory} as its working directory,
instead of the current directory.
-_if__(_LUCID__)
+@ifset LUCID
@item -context @var{authentication}
-When the Energize programming system starts up _GDBN__, it uses this
+When the Energize programming system starts up @value{GDBN}, it uses this
option to trigger an alternate mode of interaction.
-@var{authentication} is a pair of numeric codes that identify _GDBN__
+@var{authentication} is a pair of numeric codes that identify @value{GDBN}
as a client in the Energize environment. Avoid this option when you run
-_GDBN__ directly from the command line. See @ref{Energize,,Using
-_GDBN__ with Energize} for more discussion of using _GDBN__ with Energize.
-_fi__(_LUCID__)
+@value{GDBN} directly from the command line. See @ref{Energize,,Using
+@value{GDBN} with Energize} for more discussion of using @value{GDBN} with Energize.
+@end ifset
+@ifclear DOSHOST
@item -fullname
@itemx -f
-Emacs sets this option when it runs _GDBN__ as a subprocess. It tells _GDBN__
+Emacs sets this option when it runs @value{GDBN} as a subprocess. It tells @value{GDBN}
to output the full file name and line number in a standard,
recognizable fashion each time a stack frame is displayed (which
includes each time your program stops). This recognizable format looks
like two @samp{\032} characters, followed by the file name, line number
and character position separated by colons, and a newline. The
-Emacs-to-_GDBN__ interface program uses the two @samp{\032} characters as
+Emacs-to-@value{GDBN} interface program uses the two @samp{\032} characters as
a signal to display the source code for the frame.
+@end ifclear
+@ifset SERIAL
@item -b @var{bps}
Set the line speed (baud rate or bits per second) of any serial
-interface used by _GDBN__ for remote debugging.
+interface used by @value{GDBN} for remote debugging.
-@item -tty=@var{device}
+@item -tty @var{device}
Run using @var{device} for your program's standard input and output.
@c FIXME: kingdon thinks there is more to -tty. Investigate.
+@end ifset
@end table
-_if__(!_GENERIC__)
-_include__(gdbinv-s.m4)
-_fi__(!_GENERIC__)
-@node Leaving _GDBN__, Shell Commands, Invoking _GDBN__, Invocation
-@section Leaving _GDBN__
-@cindex exiting _GDBN__
+@node Quitting GDB
+@section Quitting @value{GDBN}
+@cindex exiting @value{GDBN}
+@cindex leaving @value{GDBN}
@table @code
@item quit
@kindex quit
@kindex q
-To exit _GDBN__, use the @code{quit} command (abbreviated @code{q}), or type
+To exit @value{GDBN}, use the @code{quit} command (abbreviated @code{q}), or type
an end-of-file character (usually @kbd{C-d}).
@end table
@cindex interrupt
-An interrupt (often @kbd{C-c}) will not exit from _GDBN__, but rather
-will terminate the action of any _GDBN__ command that is in progress and
-return to _GDBN__ command level. It is safe to type the interrupt
-character at any time because _GDBN__ does not allow it to take effect
+An interrupt (often @kbd{C-c}) will not exit from @value{GDBN}, but rather
+will terminate the action of any @value{GDBN} command that is in progress and
+return to @value{GDBN} command level. It is safe to type the interrupt
+character at any time because @value{GDBN} does not allow it to take effect
until a time when it is safe.
-If you have been using _GDBN__ to control an attached process or device, you
-can release it with the @code{detach} command; @pxref{Attach,
-,Debugging an Already-Running Process}..
+@ifclear BARETARGET
+If you have been using @value{GDBN} to control an attached process or
+device, you can release it with the @code{detach} command
+(@pxref{Attach, ,Debugging an already-running process}).
+@end ifclear
-@node Shell Commands, , Leaving _GDBN__, Invocation
-@section Shell Commands
+@node Shell Commands
+@section Shell commands
If you need to execute occasional shell commands during your
-debugging session, there is no need to leave or suspend _GDBN__; you can
+debugging session, there is no need to leave or suspend @value{GDBN}; you can
just use the @code{shell} command.
@table @code
@item shell @var{command string}
@kindex shell
@cindex shell escape
-Directs _GDBN__ to invoke an inferior shell to execute @var{command
-string}. If it exists, the environment variable @code{SHELL} is used
-for the name of the shell to run. Otherwise _GDBN__ uses
-@code{/bin/sh}.
+Invoke a the standard shell to execute @var{command string}.
+@ifclear DOSHOST
+If it exists, the environment variable @code{SHELL} determines which
+shell to run. Otherwise @value{GDBN} uses @code{/bin/sh}.
+@end ifclear
@end table
The utility @code{make} is often needed in development environments.
-You do not have to use the @code{shell} command for this purpose in _GDBN__:
+You do not have to use the @code{shell} command for this purpose in
+@value{GDBN}:
@table @code
@item make @var{make-args}
@kindex make
@cindex calling make
-Causes _GDBN__ to execute an inferior @code{make} program with the specified
+Execute the @code{make} program with the specified
arguments. This is equivalent to @samp{shell make @var{make-args}}.
@end table
-@node Commands, Running, Invocation, Top
-@chapter _GDBN__ Commands
+@node Commands
+@chapter @value{GDBN} Commands
-You can abbreviate GDB command if that abbreviation is unambiguous;
-and you can repeat certain GDB commands by typing just @key{RET}.
+You can abbreviate a @value{GDBN} command to the first few letters of the command
+name, if that abbreviation is unambiguous; and you can repeat certain
+@value{GDBN} commands by typing just @key{RET}. You can also use the @key{TAB}
+key to get @value{GDBN} to fill out the rest of a word in a command (or to
+show you the alternatives available, if there is more than one possibility).
@menu
-* Command Syntax:: Command Syntax
-* Help:: Getting Help
+* Command Syntax:: How to give commands to @value{GDBN}
+* Completion:: Command completion
+* Help:: How to ask @value{GDBN} for help
@end menu
-@node Command Syntax, Help, Commands, Commands
-@section Command Syntax
+@node Command Syntax
+@section Command syntax
-A _GDBN__ command is a single line of input. There is no limit on how long
-it can be. It starts with a command name, which is followed by arguments
-whose meaning depends on the command name. For example, the command
-@code{step} accepts an argument which is the number of times to step,
-as in @samp{step 5}. You can also use the @code{step} command with
-no arguments. Some command names do not allow any arguments.
+A @value{GDBN} command is a single line of input. There is no limit on
+how long it can be. It starts with a command name, which is followed by
+arguments whose meaning depends on the command name. For example, the
+command @code{step} accepts an argument which is the number of times to
+step, as in @samp{step 5}. You can also use the @code{step} command
+with no arguments. Some command names do not allow any arguments.
@cindex abbreviation
-_GDBN__ command names may always be truncated if that abbreviation is
+@value{GDBN} command names may always be truncated if that abbreviation is
unambiguous. Other possible command abbreviations are listed in the
documentation for individual commands. In some cases, even ambiguous
abbreviations are allowed; for example, @code{s} is specially defined as
@cindex repeating commands
@kindex RET
-A blank line as input to _GDBN__ (typing just @key{RET}) means to
+A blank line as input to @value{GDBN} (typing just @key{RET}) means to
repeat the previous command. Certain commands (for example, @code{run})
will not repeat this way; these are commands for which unintentional
repetition might cause trouble and which you are unlikely to want to
@key{RET}, construct new arguments rather than repeating
exactly as typed. This permits easy scanning of source or memory.
-_GDBN__ can also use @key{RET} in another way: to partition lengthy
+@value{GDBN} can also use @key{RET} in another way: to partition lengthy
output, in a way similar to the common utility @code{more}
-(@pxref{Screen Size}). Since it is easy to press one @key{RET} too many
-in this situation, _GDBN__ disables command repetition after any command
-that generates this sort of display.
+(@pxref{Screen Size,,Screen size}). Since it is easy to press one
+@key{RET} too many in this situation, @value{GDBN} disables command
+repetition after any command that generates this sort of display.
@kindex #
@cindex comment
-A line of input starting with @kbd{#} is a comment; it does nothing.
-This is useful mainly in command files (@pxref{Command Files}).
+Any text from a @kbd{#} to the end of the line is a comment; it does
+nothing. This is useful mainly in command files (@pxref{Command
+Files,,Command files}).
+
+@node Completion
+@section Command completion
+
+@cindex completion
+@cindex word completion
+@value{GDBN} can fill in the rest of a word in a command for you, if there is
+only one possibility; it can also show you what the valid possibilities
+are for the next word in a command, at any time. This works for @value{GDBN}
+commands, @value{GDBN} subcommands, and the names of symbols in your program.
+
+Press the @key{TAB} key whenever you want @value{GDBN} to fill out the rest
+of a word. If there is only one possibility, @value{GDBN} will fill in the
+word, and wait for you to finish the command (or press @key{RET} to
+enter it). For example, if you type
+
+@c FIXME "@key" does not distinguish its argument sufficiently to permit
+@c complete accuracy in these examples; space introduced for clarity.
+@c If texinfo enhancements make it unnecessary, it would be nice to
+@c replace " @key" by "@key" in the following...
+@example
+(@value{GDBP}) info bre @key{TAB}
+@end example
+
+@noindent
+@value{GDBN} fills in the rest of the word @samp{breakpoints}, since that is
+the only @code{info} subcommand beginning with @samp{bre}:
+
+@example
+(@value{GDBP}) info breakpoints
+@end example
+
+@noindent
+You can either press @key{RET} at this point, to run the @code{info
+breakpoints} command, or backspace and enter something else, if
+@samp{breakpoints} does not look like the command you expected. (If you
+were sure you wanted @code{info breakpoints} in the first place, you
+might as well just type @key{RET} immediately after @samp{info bre},
+to exploit command abbreviations rather than command completion).
+
+If there is more than one possibility for the next word when you press
+@key{TAB}, @value{GDBN} will sound a bell. You can either supply more
+characters and try again, or just press @key{TAB} a second time, and
+@value{GDBN} will display all the possible completions for that word. For
+example, you might want to set a breakpoint on a subroutine whose name
+begins with @samp{make_}, but when you type @kbd{b make_@key{TAB}} @value{GDBN}
+just sounds the bell. Typing @key{TAB} again will display all the
+function names in your program that begin with those characters, for
+example:
+
+@example
+(@value{GDBP}) b make_ @key{TAB}
+@exdent @value{GDBN} sounds bell; press @key{TAB} again, to see:
+make_a_section_from_file make_environ
+make_abs_section make_function_type
+make_blockvector make_pointer_type
+make_cleanup make_reference_type
+make_command make_symbol_completion_list
+(@value{GDBP}) b make_
+@end example
+
+@noindent
+After displaying the available possibilities, @value{GDBN} copies your
+partial input (@samp{b make_} in the example) so you can finish the
+command.
+
+If you just want to see the list of alternatives in the first place, you
+can press @kbd{M-?} rather than pressing @key{TAB} twice. @kbd{M-?}
+means @kbd{@key{META} ?}. You can type this
+@ifclear DOSHOST
+either by holding down a
+key designated as the @key{META} shift on your keyboard (if there is
+one) while typing @kbd{?}, or
+@end ifclear
+as @key{ESC} followed by @kbd{?}.
+
+@cindex quotes in commands
+@cindex completion of quoted strings
+Sometimes the string you need, while logically a ``word'', may contain
+parentheses or other characters that @value{GDBN} normally excludes from its
+notion of a word. To permit word completion to work in this situation,
+you may enclose words in @code{'} (single quote marks) in @value{GDBN} commands.
+
+@ifclear CONLY
+The most likely situation where you might need this is in typing the
+name of a C++ function. This is because C++ allows function overloading
+(multiple definitions of the same function, distinguished by argument
+type). For example, when you want to set a breakpoint you may need to
+distinguish whether you mean the version of @code{name} that takes an
+@code{int} parameter, @code{name(int)}, or the version that takes a
+@code{float} parameter, @code{name(float)}. To use the word-completion
+facilities in this situation, type a single quote @code{'} at the
+beginning of the function name. This alerts @value{GDBN} that it may need to
+consider more information than usual when you press @key{TAB} or
+@kbd{M-?} to request word completion:
+
+@example
+(@value{GDBP}) b 'bubble( @key{M-?}
+bubble(double,double) bubble(int,int)
+(@value{GDBP}) b 'bubble(
+@end example
+
+In some cases, @value{GDBN} can tell that completing a name will require
+quotes. When this happens, @value{GDBN} will insert the quote for you (while
+completing as much as it can) if you do not type the quote in the first
+place:
+
+@example
+(@value{GDBP}) b bub @key{TAB}
+@exdent @value{GDBN} alters your input line to the following, and rings a bell:
+(@value{GDBP}) b 'bubble(
+@end example
+
+@noindent
+In general, @value{GDBN} can tell that a quote is needed (and inserts it) if
+you have not yet started typing the argument list when you ask for
+completion on an overloaded symbol.
+@end ifclear
+
-@node Help, , Command Syntax, Commands
-@section Getting Help
+@node Help
+@section Getting help
@cindex online documentation
@kindex help
-You can always ask _GDBN__ itself for information on its commands, using the
+You can always ask @value{GDBN} itself for information on its commands, using the
command @code{help}.
@table @code
display a short list of named classes of commands:
@smallexample
-(_GDBP__) help
+(@value{GDBP}) help
List of classes of commands:
running -- Running the program
Type "help" followed by command name for full
documentation.
Command name abbreviations are allowed if unambiguous.
-(_GDBP__)
+(@value{GDBP})
@end smallexample
@item help @var{class}
help display for the class @code{status}:
@smallexample
-(_GDBP__) help status
+(@value{GDBP}) help status
Status inquiries.
List of commands:
-show -- Generic command for showing things set with "set"
+@c Line break in "show" line falsifies real output, but needed
+@c to fit in smallbook page size.
+show -- Generic command for showing things set
+ with "set"
info -- Generic command for printing status
Type "help" followed by command name for full
documentation.
Command name abbreviations are allowed if unambiguous.
-(_GDBP__)
+(@value{GDBP})
@end smallexample
@item help @var{command}
-With a command name as @code{help} argument, _GDBN__ will display a
+With a command name as @code{help} argument, @value{GDBN} will display a
short paragraph on how to use that command.
@end table
-In addition to @code{help}, you can use the _GDBN__ commands @code{info}
+In addition to @code{help}, you can use the @value{GDBN} commands @code{info}
and @code{show} to inquire about the state of your program, or the state
-of _GDBN__ itself. Each command supports many topics of inquiry; this
+of @value{GDBN} itself. Each command supports many topics of inquiry; this
manual introduces each of them in the appropriate context. The listings
under @code{info} and under @code{show} in the Index point to
all the sub-commands. @xref{Index}.
@kindex info
@kindex i
This command (abbreviated @code{i}) is for describing the state of your
-program; for example, it can list the arguments given to your program
-(@code{info args}), the registers currently in use (@code{info
-registers}), or the breakpoints you have set (@code{info breakpoints}).
+program. For example, you can list the arguments given to your program
+with @code{info args}, list the registers currently in use with @code{info
+registers}, or list the breakpoints you have set with @code{info breakpoints}.
You can get a complete list of the @code{info} sub-commands with
@w{@code{help info}}.
@kindex show
@item show
-In contrast, @code{show} is for describing the state of _GDBN__ itself.
+In contrast, @code{show} is for describing the state of @value{GDBN} itself.
You can change most of the things you can @code{show}, by using the
related command @code{set}; for example, you can control what number
system is used for displays with @code{set radix}, or simply inquire
@kindex show version
@cindex version number
@item show version
-Show what version of _GDBN__ is running. You should include this
-information in _GDBN__ bug-reports. If multiple versions of _GDBN__ are in
-use at your site, you may occasionally want to make sure what version
-of _GDBN__ you are running; as _GDBN__ evolves, new commands are introduced,
+Show what version of @value{GDBN} is running. You should include this
+information in @value{GDBN} bug-reports. If multiple versions of @value{GDBN} are in
+use at your site, you may occasionally want to determine which version
+of @value{GDBN} you are running; as @value{GDBN} evolves, new commands are introduced,
and old ones may wither away. The version number is also announced
-when you start _GDBN__ with no arguments.
+when you start @value{GDBN}.
@kindex show copying
@item show copying
-Display information about permission for copying _GDBN__.
+Display information about permission for copying @value{GDBN}.
@kindex show warranty
@item show warranty
Display the GNU ``NO WARRANTY'' statement.
@end table
-@node Running, Stopping, Commands, Top
-@chapter Running Programs Under _GDBN__
+@node Running
+@chapter Running Programs Under @value{GDBN}
-To debug a program, you must run it under _GDBN__.
+When you run a program under @value{GDBN}, you must first generate
+debugging information when you compile it.
+@ifclear BARETARGET
+You may start it with its arguments, if any, in an environment of your
+choice. You may redirect your program's input and output, debug an
+already running process, or kill a child process.
+@end ifclear
@menu
-* Compilation:: Compiling for Debugging
-* Starting:: Starting your Program
-* Arguments:: Your Program's Arguments
-* Environment:: Your Program's Environment
-* Working Directory:: Your Program's Working Directory
-* Input/Output:: Your Program's Input and Output
-* Attach:: Debugging an Already-Running Process
-* Kill Process:: Killing the Child Process
-* Process Information:: Additional Process Information
+* Compilation:: Compiling for debugging
+* Starting:: Starting your program
+@ifclear BARETARGET
+* Arguments:: Your program's arguments
+* Environment:: Your program's environment
+* Working Directory:: Your program's working directory
+* Input/Output:: Your program's input and output
+* Attach:: Debugging an already-running process
+* Kill Process:: Killing the child process
+* Process Information:: Additional process information
+* Threads:: Debugging programs with multiple threads
+@end ifclear
@end menu
-@node Compilation, Starting, Running, Running
-@section Compiling for Debugging
+@node Compilation
+@section Compiling for debugging
In order to debug a program effectively, you need to generate
debugging information when you compile it. This debugging information
options together. Using those compilers, you cannot generate optimized
executables containing debugging information.
-_GCC__, the GNU C compiler, supports @samp{-g} with or without
+@value{NGCC}, the GNU C compiler, supports @samp{-g} with or without
@samp{-O}, making it possible to debug optimized code. We recommend
that you @emph{always} use @samp{-g} whenever you compile a program.
You may think your program is correct, but there is no sense in pushing
@cindex optimized code, debugging
@cindex debugging optimized code
When you debug a program compiled with @samp{-g -O}, remember that the
-optimizer is rearranging your code; the debugger will show you what's
-really there. Don't be too surprised when the execution path doesn't
+optimizer is rearranging your code; the debugger will show you what is
+really there. Do not be too surprised when the execution path does not
exactly match your source file! An extreme example: if you define a
-variable, but never use it, _GDBN__ will never see that
+variable, but never use it, @value{GDBN} will never see that
variable---because the compiler optimizes it out of existence.
Some things do not work as well with @samp{-g -O} as with just
please report it as a bug (including a test case!).
Older versions of the GNU C compiler permitted a variant option
-@w{@samp{-gg}} for debugging information. _GDBN__ no longer supports this
+@w{@samp{-gg}} for debugging information. @value{GDBN} no longer supports this
format; if your GNU C compiler has this option, do not use it.
-@ignore
-@comment As far as I know, there are no cases in which _GDBN__ will
-@comment produce strange output in this case. (but no promises).
-If your program includes archives made with the @code{ar} program, and
-if the object files used as input to @code{ar} were compiled without the
-@samp{-g} option and have names longer than 15 characters, _GDBN__ will get
-confused reading your program's symbol table. No error message will be
-given, but _GDBN__ may behave strangely. The reason for this problem is a
-deficiency in the Unix archive file format, which cannot represent file
-names longer than 15 characters.
-
-To avoid this problem, compile the archive members with the @samp{-g}
-option or use shorter file names. Alternatively, use a version of GNU
-@code{ar} dated more recently than August 1989.
-@end ignore
-
-@node Starting, Arguments, Compilation, Running
-@section Starting your Program
+@need 2000
+@node Starting
+@section Starting your program
@cindex starting
@cindex running
@item run
@itemx r
@kindex run
-Use the @code{run} command to start your program under _GDBN__. You must
+Use the @code{run} command to start your program under @value{GDBN}. You must
first specify the program name
-_if__(_VXWORKS__)
+@ifset VXWORKS
(except on VxWorks)
-_fi__(_VXWORKS__)
-with an argument to
-_GDBN__ (@pxref{Invocation, ,Getting In and Out of _GDBN__}), or by using the
-@code{file} or @code{exec-file} command (@pxref{Files, ,Commands to
-Specify Files}).
+@end ifset
+with an argument to @value{GDBN} (@pxref{Invocation, ,Getting In and
+Out of @value{GDBN}}), or by using the @code{file} or @code{exec-file}
+command (@pxref{Files, ,Commands to specify files}).
@end table
+@ifclear BARETARGET
If you are running your program in an execution environment that
supports processes, @code{run} creates an inferior process and makes
that process run your program. (In environments without processes,
@code{run} jumps to the start of your program.)
The execution of a program is affected by certain information it
-receives from its superior. _GDBN__ provides ways to specify this
+receives from its superior. @value{GDBN} provides ways to specify this
information, which you must do @emph{before} starting your program. (You
can change it after starting your program, but such changes will only affect
your program the next time you start it.) This information may be
(such as wildcard expansion or variable substitution) in describing
the arguments. In Unix systems, you can control which shell is used
with the @code{SHELL} environment variable. @xref{Arguments, ,Your
-Program's Arguments}.
+program's arguments}.
@item The @emph{environment.}
-Your program normally inherits its environment from _GDBN__, but you can
-use the _GDBN__ commands @code{set environment} and @code{unset
+Your program normally inherits its environment from @value{GDBN}, but you can
+use the @value{GDBN} commands @code{set environment} and @code{unset
environment} to change parts of the environment that will be given to
-your program. @xref{Environment, ,Your Program's Environment}.
+your program. @xref{Environment, ,Your program's environment}.
@item The @emph{working directory.}
-Your program inherits its working directory from _GDBN__. You can set
-_GDBN__'s working directory with the @code{cd} command in _GDBN__.
-@xref{Working Directory, ,Your Program's Working Directory}.
+Your program inherits its working directory from @value{GDBN}. You can set
+the @value{GDBN} working directory with the @code{cd} command in @value{GDBN}.
+@xref{Working Directory, ,Your program's working directory}.
@item The @emph{standard input and output.}
Your program normally uses the same device for standard input and
-standard output as _GDBN__ is using. You can redirect input and output
+standard output as @value{GDBN} is using. You can redirect input and output
in the @code{run} command line, or you can use the @code{tty} command to
set a different device for your program.
-@xref{Input/Output, ,Your Program's Input and Output}.
+@xref{Input/Output, ,Your program's input and output}.
@cindex pipes
@emph{Warning:} While input and output redirection work, you cannot use
pipes to pass the output of the program you are debugging to another
-program; if you attempt this, _GDBN__ is likely to wind up debugging the
+program; if you attempt this, @value{GDBN} is likely to wind up debugging the
wrong program.
@end table
+@end ifclear
-@c FIXME: Rewrite following paragraph, especially its third sentence.
When you issue the @code{run} command, your program begins to execute
-immediately. @xref{Stopping, ,Stopping and Continuing}, for
-discussion of how to arrange for your program to stop. Once your
-program has been started by the @code{run} command (and then stopped),
-you may evaluate expressions that involve calls to functions in your
-program, using the @code{print} or @code{call} commands. @xref{Data,
-,Examining Data}.
+immediately. @xref{Stopping, ,Stopping and continuing}, for discussion
+of how to arrange for your program to stop. Once your program has
+stopped, you may call functions in your program, using the @code{print}
+or @code{call} commands. @xref{Data, ,Examining Data}.
If the modification time of your symbol file has changed since the
-last time _GDBN__ read its symbols, _GDBN__ will discard its symbol table and
-re-read it. When it does this, _GDBN__ tries to retain your current
+last time @value{GDBN} read its symbols, @value{GDBN} will discard its symbol table and
+re-read it. When it does this, @value{GDBN} tries to retain your current
breakpoints.
-@node Arguments, Environment, Starting, Running
-@section Your Program's Arguments
+@ifclear BARETARGET
+@node Arguments
+@section Your program's arguments
@cindex arguments (to your program)
The arguments to your program can be specified by the arguments of the
@code{run} command. They are passed to a shell, which expands wildcard
characters and performs redirection of I/O, and thence to your program.
-_GDBN__ uses the shell indicated by your environment variable
-@code{SHELL} if it exists; otherwise, _GDBN__ uses @code{/bin/sh}.
+Your @code{SHELL} environment variable (if it exists) specifies what
+shell @value{GDBN} if you do not define @code{SHELL}, @value{GDBN} uses
+@code{/bin/sh}.
@code{run} with no arguments uses the same arguments used by the previous
@code{run}, or those set by the @code{set args} command.
Show the arguments to give your program when it is started.
@end table
-@node Environment, Working Directory, Arguments, Running
-@section Your Program's Environment
+@node Environment
+@section Your program's environment
@cindex environment (of your program)
The @dfn{environment} consists of a set of environment variables and
path for programs to run. Usually you set up environment variables with
the shell and they are inherited by all the other programs you run. When
debugging, it can be useful to try running your program with a modified
-environment without having to start _GDBN__ over again.
+environment without having to start @value{GDBN} over again.
@table @code
@item path @var{directory}
@kindex path
Add @var{directory} to the front of the @code{PATH} environment variable
-(the search path for executables), for both _GDBN__ and your program.
+(the search path for executables), for both @value{GDBN} and your program.
You may specify several directory names, separated by @samp{:} or
whitespace. If @var{directory} is already in the path, it is moved to
the front, so it will be searched sooner.
You can use the string @samp{$cwd} to refer to whatever is the current
-working directory at the time _GDBN__ searches the path. If you use
-@samp{.} instead, it refers to the directory where you executed the
-@code{path} command. _GDBN__ fills in the current path where needed in
-the @var{directory} argument, before adding it to the search path.
+working directory at the time @value{GDBN} searches the path. If you
+use @samp{.} instead, it refers to the directory where you executed the
+@code{path} command. @value{GDBN} replaces @samp{.} in the
+@var{directory} argument (with the current path) before adding
+@var{directory} to the search path.
@c 'path' is explicitly nonrepeatable, but RMS points out it is silly to
@c document that, since repeating it would be a no-op.
@item set environment @var{varname} @r{[}=@r{]} @var{value}
@kindex set environment
-Sets environment variable @var{varname} to @var{value}. The value
-changes for your program only, not for _GDBN__ itself. @var{value} may
+Set environment variable @var{varname} to @var{value}. The value
+changes for your program only, not for @value{GDBN} itself. @var{value} may
be any string; the values of environment variables are just strings, and
any interpretation is supplied by your program itself. The @var{value}
parameter is optional; if it is eliminated, the variable is set to a
rather than assigning it an empty value.
@end table
-@node Working Directory, Input/Output, Environment, Running
-@section Your Program's Working Directory
+@emph{Warning:} @value{GDBN} runs your program using the shell indicated
+by your @code{SHELL} environment variable if it exists (or
+@code{/bin/sh} if not). If your @code{SHELL} variable names a shell
+that runs an initialization file---such as @file{.cshrc} for C-shell, or
+@file{.bashrc} for BASH---any variables you set in that file will affect
+your program. You may wish to move setting of environment variables to
+files that are only run when you sign on, such as @file{.login} or
+@file{.profile}.
+
+@node Working Directory
+@section Your program's working directory
@cindex working directory (of your program)
Each time you start your program with @code{run}, it inherits its
-working directory from the current working directory of _GDBN__. _GDBN__'s
-working directory is initially whatever it inherited from its parent
-process (typically the shell), but you can specify a new working
-directory in _GDBN__ with the @code{cd} command.
+working directory from the current working directory of @value{GDBN}.
+The @value{GDBN} working directory is initially whatever it inherited
+from its parent process (typically the shell), but you can specify a new
+working directory in @value{GDBN} with the @code{cd} command.
-The _GDBN__ working directory also serves as a default for the commands
-that specify files for _GDBN__ to operate on. @xref{Files, ,Commands to
-Specify Files}.
+The @value{GDBN} working directory also serves as a default for the commands
+that specify files for @value{GDBN} to operate on. @xref{Files, ,Commands to
+specify files}.
@table @code
@item cd @var{directory}
@kindex cd
-Set _GDBN__'s working directory to @var{directory}.
+Set the @value{GDBN} working directory to @var{directory}.
@item pwd
@kindex pwd
-Print _GDBN__'s working directory.
+Print the @value{GDBN} working directory.
@end table
-@node Input/Output, Attach, Working Directory, Running
-@section Your Program's Input and Output
+@node Input/Output
+@section Your program's input and output
@cindex redirection
@cindex i/o
@cindex terminal
-By default, the program you run under _GDBN__ does input and output to
-the same terminal that _GDBN__ uses. _GDBN__ switches the terminal to
+By default, the program you run under @value{GDBN} does input and output to
+the same terminal that @value{GDBN} uses. @value{GDBN} switches the terminal to
its own terminal modes to interact with you, but it records the terminal
modes your program was using and switches back to them when you continue
running your program.
@table @code
@item info terminal
@kindex info terminal
-Displays _GDBN__'s recorded information about the terminal modes your
+Displays information recorded by @value{GDBN} about the terminal modes your
program is using.
@end table
You can redirect your program's input and/or output using shell
redirection with the @code{run} command. For example,
-_0__@example
+@example
run > outfile
-_1__@end example
+@end example
@noindent
starts your program, diverting its output to the file @file{outfile}.
When you use the @code{tty} command or redirect input in the @code{run}
command, only the input @emph{for your program} is affected. The input
-for _GDBN__ still comes from your terminal.
+for @value{GDBN} still comes from your terminal.
-@node Attach, Kill Process, Input/Output, Running
-@section Debugging an Already-Running Process
+@node Attach
+@section Debugging an already-running process
@kindex attach
@cindex attach
@table @code
@item attach @var{process-id}
-This command
-attaches to a running process---one that was started outside _GDBN__.
-(@code{info files} will show your active targets.) The command takes as
-argument a process ID. The usual way to find out the process-id of
-a Unix process is with the @code{ps} utility, or with the @samp{jobs -l}
-shell command.
+This command attaches to a running process---one that was started
+outside @value{GDBN}. (@code{info files} will show your active
+targets.) The command takes as argument a process ID. The usual way to
+find out the process-id of a Unix process is with the @code{ps} utility,
+or with the @samp{jobs -l} shell command.
@code{attach} will not repeat if you press @key{RET} a second time after
executing the command.
@end table
-To use @code{attach}, you must be debugging in an environment which
-supports processes. You must also have permission to send the process a
-signal, and it must have the same effective user ID as the _GDBN__
-process.
+To use @code{attach}, your program must be running in an environment
+which supports processes; for example, @code{attach} does not work for
+programs on bare-board targets that lack an operating system. You must
+also have permission to send the process a signal.
When using @code{attach}, you should first use the @code{file} command
to specify the program running in the process and load its symbol table.
@xref{Files, ,Commands to Specify Files}.
-The first thing _GDBN__ does after arranging to debug the specified
+The first thing @value{GDBN} does after arranging to debug the specified
process is to stop it. You can examine and modify an attached process
-with all the _GDBN__ commands that are ordinarily available when you start
+with all the @value{GDBN} commands that are ordinarily available when you start
processes with @code{run}. You can insert breakpoints; you can step and
continue; you can modify storage. If you would rather the process
continue running, you may use the @code{continue} command after
-attaching _GDBN__ to the process.
+attaching @value{GDBN} to the process.
@table @code
@item detach
@kindex detach
When you have finished debugging the attached process, you can use the
-@code{detach} command to release it from _GDBN__'s control. Detaching
+@code{detach} command to release it from @value{GDBN} control. Detaching
the process continues its execution. After the @code{detach} command,
-that process and _GDBN__ become completely independent once more, and you
+that process and @value{GDBN} become completely independent once more, and you
are ready to @code{attach} another process or start one with @code{run}.
@code{detach} will not repeat if you press @key{RET} again after
executing the command.
@end table
-If you exit _GDBN__ or use the @code{run} command while you have an attached
+If you exit @value{GDBN} or use the @code{run} command while you have an attached
process, you kill that process. By default, you will be asked for
confirmation if you try to do either of these things; you can control
whether or not you need to confirm by using the @code{set confirm} command
-(@pxref{Messages/Warnings, ,Optional Warnings and Messages}).
+(@pxref{Messages/Warnings, ,Optional warnings and messages}).
-@node Kill Process, Process Information, Attach, Running
+@node Kill Process
@c @group
-@section Killing the Child Process
+@section Killing the child process
@table @code
@item kill
@kindex kill
-Kill the child process in which your program is running under _GDBN__.
+Kill the child process in which your program is running under @value{GDBN}.
@end table
This command is useful if you wish to debug a core dump instead of a
-running process. _GDBN__ ignores any core dump file while your program
+running process. @value{GDBN} ignores any core dump file while your program
is running.
@c @end group
-On some operating systems, a program cannot be executed outside _GDBN__
-while you have breakpoints set on it inside _GDBN__. You can use the
+On some operating systems, a program cannot be executed outside @value{GDBN}
+while you have breakpoints set on it inside @value{GDBN}. You can use the
@code{kill} command in this situation to permit running your program
outside the debugger.
The @code{kill} command is also useful if you wish to recompile and
relink your program, since on many systems it is impossible to modify an
executable file while it is running in a process. In this case, when you
-next type @code{run}, _GDBN__ will notice that the file has changed, and
+next type @code{run}, @value{GDBN} will notice that the file has changed, and
will re-read the symbol table (while trying to preserve your current
breakpoint settings).
-@node Process Information, , Kill Process, Running
-@section Additional Process Information
+@node Process Information
+@section Additional process information
@kindex /proc
@cindex process image
Some operating systems provide a facility called @samp{/proc} that can
be used to examine the image of a running process using file-system
-subroutines. If _GDBN__ is configured for an operating system with this
+subroutines. If @value{GDBN} is configured for an operating system with this
facility, the command @code{info proc} is available to report on several
kinds of information about the process running your program.
@item info proc id
@kindex info proc id
-Report on the process ID's related to your program: its own process id,
-the id of its parent, the process group id, and the session id.
+Report on the process IDs related to your program: its own process ID,
+the ID of its parent, the process group ID, and the session ID.
@item info proc status
@kindex info proc status
Show all the above information about the process.
@end table
-@node Stopping, Stack, Running, Top
+@node Threads
+@section Debugging programs with multiple threads
+
+@cindex threads of execution
+@cindex multiple threads
+@cindex switching threads
+In some operating systems, a single program may have more than one
+@dfn{thread} of execution. The precise semantics of threads differ from
+one operating system to another, but in general the threads of a single
+program are akin to multiple processes---except that they share one
+address space (that is, they can all examine and modify the same
+variables). On the other hand, each thread has its own registers and
+execution stack, and perhaps private memory.
+
+@value{GDBN} provides these facilities for debugging multi-thread
+programs:
+
+@itemize @bullet
+@item automatic notification of new threads
+@item @samp{thread @var{threadno}}, a command to switch among threads
+@item @samp{info threads}, a command to inquire about existing threads
+@item thread-specific breakpoints
+@end itemize
+
+@quotation
+@emph{Warning:} These facilities are not yet available on every
+@value{GDBN} configuration where the operating system supports threads.
+If your @value{GDBN} does not support threads, these commands have no
+effect. For example, a system without thread support shows no output
+from @samp{info threads}, and always rejects the @code{thread} command,
+like this:
+
+@smallexample
+(@value{GDBP}) info threads
+(@value{GDBP}) thread 1
+Thread ID 1 not known. Use the "info threads" command to
+see the IDs of currently known threads.
+@end smallexample
+@c FIXME to implementors: how hard would it be to say "sorry, this GDB
+@c doesn't support threads"?
+@end quotation
+
+@cindex focus of debugging
+@cindex current thread
+The @value{GDBN} thread debugging facility allows you to observe all
+threads while your program runs---but whenever @value{GDBN} takes
+control, one thread in particular is always the focus of debugging.
+This thread is called the @dfn{current thread}. Debugging commands show
+program information from the perspective of the current thread.
+
+@kindex New @var{systag}
+@cindex thread identifier (system)
+@c FIXME-implementors!! It would be more helpful if the [New...] message
+@c included GDB's numeric thread handle, so you could just go to that
+@c thread without first checking `info threads'.
+Whenever @value{GDBN} detects a new thread in your program, it displays
+the target system's identification for the thread with a message in the
+form @samp{[New @var{systag}]}. @var{systag} is a thread identifier
+whose form varies depending on the particular system. For example, on
+LynxOS, you might see
+
+@example
+[New process 35 thread 27]
+@end example
+
+@noindent
+when @value{GDBN} notices a new thread. In contrast, on an SGI system,
+the @var{systag} is simply something like @samp{process 368}, with no
+further qualifier.
+
+@c FIXME!! (1) Does the [New...] message appear even for the very first
+@c thread of a program, or does it only appear for the
+@c second---i.e., when it becomes obvious we have a multithread
+@c program?
+@c (2) *Is* there necessarily a first thread always? Or do some
+@c multithread systems permit starting a program with multiple
+@c threads ab initio?
+
+@cindex thread number
+@cindex thread identifier (GDB)
+For debugging purposes, @value{GDBN} associates its own thread
+number---always a single integer---with each thread in your program.
+
+@table @code
+@item info threads
+@kindex info threads
+Display a summary of all threads currently in your
+program. @value{GDBN} displays for each thread (in this order):
+
+@enumerate
+@item the thread number assigned by @value{GDBN}
+
+@item the target system's thread identifier (@var{systag})
+
+@item the current stack frame summary for that thread
+@end enumerate
+
+@noindent
+An asterisk @samp{*} to the left of the @value{GDBN} thread number
+indicates the current thread.
+
+For example,
+@end table
+@c end table here to get a little more width for example
+
+@smallexample
+(@value{GDBP}) info threads
+ 3 process 35 thread 27 0x34e5 in sigpause ()
+ 2 process 35 thread 23 0x34e5 in sigpause ()
+* 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8)
+ at threadtest.c:68
+@end smallexample
+
+@table @code
+@item thread @var{threadno}
+@kindex thread @var{threadno}
+Make thread number @var{threadno} the current thread. The command
+argument @var{threadno} is the internal @value{GDBN} thread number, as
+shown in the first field of the @samp{info threads} display.
+@value{GDBN} responds by displaying the system identifier of the thread
+you selected, and its current stack frame summary:
+
+@smallexample
+@c FIXME!! This example made up; find a GDB w/threads and get real one
+(@value{GDBP}) thread 2
+[Switching to process 35 thread 23]
+0x34e5 in sigpause ()
+@end smallexample
+
+@noindent
+As with the @samp{[New @dots{}]} message, the form of the text after
+@samp{Switching to} depends on your system's conventions for identifying
+threads.
+@end table
+
+@cindex automatic thread selection
+@cindex switching threads automatically
+@cindex threads, automatic switching
+Whenever @value{GDBN} stops your program, due to a breakpoint or a
+signal, it automatically selects the thread where that breakpoint or
+signal happened. @value{GDBN} alerts you to the context switch with a
+message of the form @samp{[Switching to @var{systag}]} to identify the
+thread.
+
+@xref{Thread Stops,,Stopping and starting multi-thread programs}, for
+more information about how @value{GDBN} behaves when you stop and start
+programs with multiple threads.
+
+@xref{Set Watchpoints,,Setting watchpoints}, for information about
+watchpoints in programs with multiple threads.
+@end ifclear
+
+@node Stopping
@chapter Stopping and Continuing
-The principal purpose of using a debugger is so that you can stop your
+The principal purposes of using a debugger are so that you can stop your
program before it terminates; or so that, if your program runs into
trouble, you can investigate and find out why.
-Inside _GDBN__, your program may stop for any of several reasons, such
-as a signal, a breakpoint, or reaching a new line after a _GDBN__
+Inside @value{GDBN}, your program may stop for any of several reasons, such
+as
+@ifclear BARETARGET
+a signal,
+@end ifclear
+a breakpoint, or reaching a new line after a @value{GDBN}
command such as @code{step}. You may then examine and change
variables, set new breakpoints or remove old ones, and then continue
-execution. Usually, the messages shown by _GDBN__ provide ample
+execution. Usually, the messages shown by @value{GDBN} provide ample
explanation of the status of your program---but you can also explicitly
request this information at any time.
@item info program
@kindex info program
Display information about the status of your program: whether it is
-running or not, what process it is, and why it stopped.
+running or not,
+@ifclear BARETARGET
+what process it is,
+@end ifclear
+and why it stopped.
@end table
@menu
-* Breakpoints:: Breakpoints, Watchpoints, and Exceptions
-* Continuing and Stepping:: Resuming Execution
+@ifclear CONLY
+* Breakpoints:: Breakpoints, watchpoints, and exceptions
+@end ifclear
+@ifset CONLY
+* Breakpoints:: Breakpoints and watchpoints
+@end ifset
+@c Remnant makeinfo bug requires blank line after *successful* end-if in menu:
+
+* Continuing and Stepping:: Resuming execution
+@ifset POSIX
* Signals:: Signals
+@end ifset
+@ifclear BARETARGET
+* Thread Stops:: Stopping and starting multi-thread programs
+@end ifclear
@end menu
-@node Breakpoints, Continuing and Stepping, Stopping, Stopping
-@section Breakpoints, Watchpoints, and Exceptions
+@c makeinfo node-defaulting requires adjacency of @node and sectioning cmds
+@c ...hence distribute @node Breakpoints over two possible @if expansions.
+@c
+@ifclear CONLY
+@node Breakpoints
+@section Breakpoints, watchpoints, and exceptions
+@end ifclear
+@ifset CONLY
+@node Breakpoints
+@section Breakpoints and watchpoints
+@end ifset
@cindex breakpoints
A @dfn{breakpoint} makes your program stop whenever a certain point in
the program is reached. For each breakpoint, you can add various
conditions to control in finer detail whether your program will stop.
You can set breakpoints with the @code{break} command and its variants
-(@pxref{Set Breaks, ,Setting Breakpoints}), to specify the place where
+(@pxref{Set Breaks, ,Setting breakpoints}), to specify the place where
your program should stop by line number, function name or exact address
-in the program. In languages with exception handling (such as GNU
-C++), you can also set breakpoints where an exception is raised
-(@pxref{Exception Handling, ,Breakpoints and Exceptions}).
+in the program.
+@ifclear CONLY
+In languages with exception handling (such as GNU C++), you can also set
+breakpoints where an exception is raised (@pxref{Exception Handling,,
+Breakpoints and exceptions}).
+@end ifclear
@cindex watchpoints
@cindex memory tracing
A @dfn{watchpoint} is a special breakpoint that stops your program
when the value of an expression changes. You must use a different
command to set watchpoints (@pxref{Set Watchpoints, ,Setting
-Watchpoints}), but aside from that, you can manage a watchpoint like
+watchpoints}), but aside from that, you can manage a watchpoint like
any other breakpoint: you enable, disable, and delete both breakpoints
and watchpoints using the same commands.
+You can arrange to have values from your program displayed automatically
+whenever @value{GDBN} stops at a breakpoint. @xref{Auto Display,,
+Automatic display}.
+
@cindex breakpoint numbers
@cindex numbers for breakpoints
-_GDBN__ assigns a number to each breakpoint or watchpoint when you
+@value{GDBN} assigns a number to each breakpoint or watchpoint when you
create it; these numbers are successive integers starting with one. In
many of the commands for controlling various features of breakpoints you
use the breakpoint number to say which breakpoint you want to change.
no effect on your program until you enable it again.
@menu
-* Set Breaks:: Setting Breakpoints
-* Set Watchpoints:: Setting Watchpoints
-* Exception Handling:: Breakpoints and Exceptions
-* Delete Breaks:: Deleting Breakpoints
-* Disabling:: Disabling Breakpoints
-* Conditions:: Break Conditions
-* Break Commands:: Breakpoint Command Lists
-* Breakpoint Menus:: Breakpoint Menus
-* Error in Breakpoints::
+* Set Breaks:: Setting breakpoints
+* Set Watchpoints:: Setting watchpoints
+@ifclear CONLY
+* Exception Handling:: Breakpoints and exceptions
+@end ifclear
+
+* Delete Breaks:: Deleting breakpoints
+* Disabling:: Disabling breakpoints
+* Conditions:: Break conditions
+* Break Commands:: Breakpoint command lists
+@ifclear CONLY
+* Breakpoint Menus:: Breakpoint menus
+@end ifclear
+@ifclear BARETARGET
+* Error in Breakpoints:: ``Cannot insert breakpoints''
+@end ifclear
@end menu
-@node Set Breaks, Set Watchpoints, Breakpoints, Breakpoints
-@subsection Setting Breakpoints
+@node Set Breaks
+@subsection Setting breakpoints
@c FIXME LMB what does GDB do if no code on line of breakpt?
@c consider in particular declaration with/without initialization.
Breakpoints are set with the @code{break} command (abbreviated
@code{b}). The debugger convenience variable @samp{$bpnum} records the
number of the beakpoint you've set most recently; see @ref{Convenience
-Vars,, Convenience Variables}, for a discussion of what you can do with
+Vars,, Convenience variables}, for a discussion of what you can do with
convenience variables.
You have several ways to say where the breakpoint should go.
@table @code
@item break @var{function}
-Set a breakpoint at entry to function @var{function}. When using source
-languages that permit overloading of symbols, such as C++,
-@var{function} may refer to more than one possible place to break.
-@xref{Breakpoint Menus}, for a discussion of that situation.
+Set a breakpoint at entry to function @var{function}.
+@ifclear CONLY
+When using source languages that permit overloading of symbols, such as
+C++, @var{function} may refer to more than one possible place to break.
+@xref{Breakpoint Menus,,Breakpoint menus}, for a discussion of that situation.
+@end ifclear
@item break +@var{offset}
@itemx break -@var{offset}
returns to that frame. This is similar to the effect of a
@code{finish} command in the frame inside the selected frame---except
that @code{finish} does not leave an active breakpoint. If you use
-@code{break} without an argument in the innermost frame, _GDBN__ will stop
+@code{break} without an argument in the innermost frame, @value{GDBN} will stop
the next time it reaches the current location; this may be useful
inside loops.
-_GDBN__ normally ignores breakpoints when it resumes execution, until at
+@value{GDBN} normally ignores breakpoints when it resumes execution, until at
least one instruction has been executed. If it did not do this, you
would be unable to proceed past a breakpoint without first disabling the
breakpoint. This rule applies whether or not the breakpoint already
value is nonzero---that is, if @var{cond} evaluates as true.
@samp{@dots{}} stands for one of the possible arguments described
above (or no argument) specifying where to break. @xref{Conditions,
-,Break Conditions}, for more information on breakpoint conditions.
+,Break conditions}, for more information on breakpoint conditions.
@item tbreak @var{args}
@kindex tbreak
Set a breakpoint enabled only for one stop. @var{args} are the
same as for the @code{break} command, and the breakpoint is set in the same
way, but the breakpoint is automatically disabled after the first time your
-program stops there. @xref{Disabling, ,Disabling Breakpoints}.
+program stops there. @xref{Disabling, ,Disabling breakpoints}.
@item rbreak @var{regex}
@kindex rbreak
just like the breakpoints set with the @code{break} command. They can
be deleted, disabled, made conditional, etc., in the standard ways.
+@ifclear CONLY
When debugging C++ programs, @code{rbreak} is useful for setting
breakpoints on overloaded functions that are not members of any special
classes.
+@end ifclear
@kindex info breakpoints
@cindex @code{$_} and @code{info breakpoints}
@end table
@noindent
-Breakpoint commands, if any, are listed after the line for the
-corresponding breakpoint.
+If a breakpoint is conditional, @code{info break} shows the condition on
+the line following the affected breakpoint; breakpoint commands, if any,
+are listed after that.
@noindent
@code{info break} with a breakpoint
number @var{n} as argument lists only that breakpoint. The
convenience variable @code{$_} and the default examining-address for
the @code{x} command are set to the address of the last breakpoint
-listed (@pxref{Memory, ,Examining Memory}).
+listed (@pxref{Memory, ,Examining memory}).
@end table
-_GDBN__ allows you to set any number of breakpoints at the same place in
+@value{GDBN} allows you to set any number of breakpoints at the same place in
your program. There is nothing silly or meaningless about this. When
the breakpoints are conditional, this is even useful
-(@pxref{Conditions, ,Break Conditions}).
+(@pxref{Conditions, ,Break conditions}).
@cindex negative breakpoint numbers
-@cindex internal _GDBN__ breakpoints
-_GDBN__ itself sometimes sets breakpoints in your program for special
+@cindex internal @value{GDBN} breakpoints
+@value{GDBN} itself sometimes sets breakpoints in your program for special
purposes, such as proper handling of @code{longjmp} (in C programs).
These internal breakpoints are assigned negative numbers, starting with
-@code{-1}; @samp{info breakpoints} does not display them, but the
-similar command @samp{info all-breakpoints} does.
+@code{-1}; @samp{info breakpoints} does not display them.
+
+You can see these breakpoints with the @value{GDBN} maintenance command
+@samp{maint info breakpoints}.
@table @code
-@kindex all-breakpoints
-@item info all-breakpoints
+@kindex maint info breakpoints
+@item maint info breakpoints
Using the same format as @samp{info breakpoints}, display both the
-breakpoints you've set explicitly, and those _GDBN__ is using for
+breakpoints you've set explicitly, and those @value{GDBN} is using for
internal purposes. Internal breakpoints are shown with negative
breakpoint numbers. The type column identifies what kind of breakpoint
is shown:
Internal breakpoint at the target of a @code{longjmp}.
@item until
-Temporary internal breakpoint used by the _GDBN__ @code{until} command.
+Temporary internal breakpoint used by the @value{GDBN} @code{until} command.
@item finish
-Temporary internal breakpoint used by the _GDBN__ @code{finish} command.
+Temporary internal breakpoint used by the @value{GDBN} @code{finish} command.
@end table
@end table
-@node Set Watchpoints, Exception Handling, Set Breaks, Breakpoints
-@subsection Setting Watchpoints
+@node Set Watchpoints
+@subsection Setting watchpoints
@cindex setting watchpoints
You can use a watchpoint to stop execution whenever the value of an
where this may happen.
Watchpoints currently execute two orders of magnitude more slowly than
-other breakpoints, but this can well be worth it to catch errors where
+other breakpoints, but this can be well worth it to catch errors where
you have no clue what part of your program is the culprit. Some
processors provide special hardware to support watchpoint evaluation; future
-releases of _GDBN__ will use such hardware if it is available.
+releases of @value{GDBN} will use such hardware if it is available.
@table @code
@kindex watch
same as @code{info break}.
@end table
-@node Exception Handling, Delete Breaks, Set Watchpoints, Breakpoints
-@subsection Breakpoints and Exceptions
+@ifclear BARETARGET
+@quotation
+@cindex watchpoints and threads
+@cindex threads and watchpoints
+@emph{Warning:} in multi-thread programs, watchpoints have only limited
+usefulness. With the current watchpoint implementation, @value{GDBN}
+can only watch the value of an expression @emph{in a single thread}. If
+you are confident that the expression can only change due to the current
+thread's activity (and if you are also confident that the same thread
+will remain current), then you can use watchpoints as usual. However,
+@value{GDBN} may not notice when a non-current thread's activity changes
+the expression.
+@end quotation
+@end ifclear
+
+@ifclear CONLY
+@node Exception Handling
+@subsection Breakpoints and exceptions
@cindex exception handlers
Some languages, such as GNU C++, implement exception handling. You can
-use _GDBN__ to examine what caused your program to raise an exception,
+use @value{GDBN} to examine what caused your program to raise an exception,
and to list the exceptions your program is prepared to handle at a
given point in time.
@end table
You can use @code{info catch} to list active exception handlers.
-@xref{Frame Info, ,Information About a Frame}.
+@xref{Frame Info, ,Information about a frame}.
-There are currently some limitations to exception handling in _GDBN__.
+There are currently some limitations to exception handling in @value{GDBN}.
These will be corrected in a future release.
@itemize @bullet
@item
-If you call a function interactively, _GDBN__ normally returns
+If you call a function interactively, @value{GDBN} normally returns
control to you when the function has finished executing. If the call
raises an exception, however, the call may bypass the mechanism that
returns control to you and cause your program to simply continue
-running until it hits a breakpoint, catches a signal that _GDBN__ is
+running until it hits a breakpoint, catches a signal that @value{GDBN} is
listening for, or exits.
@item
You cannot raise an exception interactively.
@noindent
To make the debugger catch all exceptions before any stack
unwinding takes place, set a breakpoint on @code{__raise_exception}
-(@pxref{Breakpoints, ,Breakpoints Watchpoints and Exceptions}).
+(@pxref{Breakpoints, ,Breakpoints; watchpoints; and exceptions}).
-With a conditional breakpoint (@pxref{Conditions, ,Break Conditions})
+With a conditional breakpoint (@pxref{Conditions, ,Break conditions})
that depends on the value of @var{id}, you can stop your program when
a specific exception is raised. You can use multiple conditional
breakpoints to stop your program when any of a number of exceptions are
raised.
+@end ifclear
-@node Delete Breaks, Disabling, Exception Handling, Breakpoints
-@subsection Deleting Breakpoints
+@node Delete Breaks
+@subsection Deleting breakpoints
@cindex clearing breakpoints, watchpoints
@cindex deleting breakpoints, watchpoints
delete individual breakpoints or watchpoints by specifying their
breakpoint numbers.
-It is not necessary to delete a breakpoint to proceed past it. _GDBN__
+It is not necessary to delete a breakpoint to proceed past it. @value{GDBN}
automatically ignores breakpoints on the first instruction to be executed
when you continue execution without changing the execution address.
@item clear
@kindex clear
Delete any breakpoints at the next instruction to be executed in the
-selected stack frame (@pxref{Selection, ,Selecting a Frame}). When
+selected stack frame (@pxref{Selection, ,Selecting a frame}). When
the innermost frame is selected, this is a good way to delete a
breakpoint where your program just stopped.
@kindex delete
@kindex d
Delete the breakpoints or watchpoints of the numbers specified as
-arguments. If no argument is specified, delete all breakpoints (_GDBN__
+arguments. If no argument is specified, delete all breakpoints (@value{GDBN}
asks confirmation, unless you have @code{set confirm off}). You
can abbreviate this command as @code{d}.
@end table
-@node Disabling, Conditions, Delete Breaks, Breakpoints
-@subsection Disabling Breakpoints
+@node Disabling
+@subsection Disabling breakpoints
@cindex disabled breakpoints
@cindex enabled breakpoints
@end table
Save for a breakpoint set with @code{tbreak} (@pxref{Set Breaks,
-,Setting Breakpoints}), breakpoints that you set are initially
-enabled; subsequently, they become disabled or enabled only when you
-use one of the commands above. (The command @code{until} can set and
-delete a breakpoint of its own, but it will not change the state of
-your other breakpoints; see @ref{Continuing and Stepping, ,Continuing and Stepping}.)
-
-@node Conditions, Break Commands, Disabling, Breakpoints
-@subsection Break Conditions
+,Setting breakpoints}), breakpoints that you set are initially enabled;
+subsequently, they become disabled or enabled only when you use one of
+the commands above. (The command @code{until} can set and delete a
+breakpoint of its own, but it will not change the state of your other
+breakpoints; see @ref{Continuing and Stepping, ,Continuing and
+stepping}.)
+
+@node Conditions
+@subsection Break conditions
@cindex conditional breakpoints
@cindex breakpoint conditions
that log program progress, or to use your own print functions to
format special data structures. The effects are completely predictable
unless there is another enabled breakpoint at the same address. (In
-that case, _GDBN__ might see the other breakpoint first and stop your
+that case, @value{GDBN} might see the other breakpoint first and stop your
program without checking the condition of this one.) Note that
breakpoint commands are usually more convenient and flexible for the
purpose of performing side effects when a breakpoint is reached
-(@pxref{Break Commands, ,Breakpoint Command Lists}).
+(@pxref{Break Commands, ,Breakpoint command lists}).
Break conditions can be specified when a breakpoint is set, by using
@samp{if} in the arguments to the @code{break} command. @xref{Set
-Breaks, ,Setting Breakpoints}. They can also be changed at any time
+Breaks, ,Setting breakpoints}. They can also be changed at any time
with the @code{condition} command. The @code{watch} command does not
recognize the @code{if} keyword; @code{condition} is the only way to
impose a further condition on a watchpoint.
Specify @var{expression} as the break condition for breakpoint or
watchpoint number @var{bnum}. From now on, this breakpoint will stop
your program only if the value of @var{expression} is true (nonzero, in
-C). When you use @code{condition}, _GDBN__ checks @var{expression}
+C). When you use @code{condition}, @value{GDBN} checks @var{expression}
immediately for syntactic correctness, and to determine whether symbols
in it have referents in the context of your breakpoint.
@c FIXME so what does GDB do if there is no referent? Moreover, what
@c about watchpoints?
-_GDBN__ does
+@value{GDBN} does
not actually evaluate @var{expression} at the time the @code{condition}
command is given, however. @xref{Expressions, ,Expressions}.
@kindex ignore
Set the ignore count of breakpoint number @var{bnum} to @var{count}.
The next @var{count} times the breakpoint is reached, your program's
-execution will not stop; other than to decrement the ignore count, _GDBN__
+execution will not stop; other than to decrement the ignore count, @value{GDBN}
takes no action.
To make the breakpoint stop the next time it is reached, specify
a count of zero.
-@item continue @var{count}
-@itemx c @var{count}
-@itemx fg @var{count}
-@kindex continue @var{count}
-Continue execution of your program, setting the ignore count of the
-breakpoint where your program stopped to @var{count} minus one.
-Thus, your program will not stop at this breakpoint until the
-@var{count}'th time it is reached.
-
-An argument to this command is meaningful only when your program stopped
-due to a breakpoint. At other times, the argument to @code{continue} is
-ignored.
-
-The synonym @code{fg} is provided purely for convenience, and has
-exactly the same behavior as other forms of the command.
-@end table
+When you use @code{continue} to resume execution of your program from a
+breakpoint, you can specify an ignore count directly as an argument to
+@code{continue}, rather than using @code{ignore}. @xref{Continuing and
+Stepping,,Continuing and stepping}.
If a breakpoint has a positive ignore count and a condition, the condition
is not checked. Once the ignore count reaches zero, the condition will
be checked.
You could achieve the effect of the ignore count with a condition such
-as _0__@w{@samp{$foo-- <= 0}}_1__ using a debugger convenience variable that
+as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that
is decremented each time. @xref{Convenience Vars, ,Convenience
-Variables}.
+variables}.
+@end table
-@node Break Commands, Breakpoint Menus, Conditions, Breakpoints
-@subsection Breakpoint Command Lists
+@node Break Commands
+@subsection Breakpoint command lists
@cindex breakpoint commands
You can give any breakpoint (or watchpoint) a series of commands to
encountered).
@end table
-Pressing @key{RET} as a means of repeating the last _GDBN__ command is
+Pressing @key{RET} as a means of repeating the last @value{GDBN} command is
disabled within a @var{command-list}.
You can use breakpoint commands to start your program up again. Simply
use the @code{continue} command, or @code{step}, or any other command
-that resumes execution. Subsequent commands in the command list are
-ignored.
+that resumes execution.
+
+Any other commands in the command list, after a command that resumes
+execution, are ignored. This is because any time you resume execution
+(even with a simple @code{next} or @code{step}), you may encounter
+another breakpoint---which could have its own command list, leading to
+ambiguities about which list to execute.
@kindex silent
-If the first command specified is @code{silent}, the usual message about
-stopping at a breakpoint is not printed. This may be desirable for
-breakpoints that are to print a specific message and then continue.
-If the remaining commands too print nothing, you will see no sign that
-the breakpoint was reached at all. @code{silent} is meaningful only
-at the beginning of a breakpoint command list.
+If the first command you specify in a command list is @code{silent}, the
+usual message about stopping at a breakpoint is not printed. This may
+be desirable for breakpoints that are to print a specific message and
+then continue. If none of the remaining commands print anything, you
+will see no sign that the breakpoint was reached. @code{silent} is
+meaningful only at the beginning of a breakpoint command list.
-The commands @code{echo} and @code{output} that allow you to print
-precisely controlled output are often useful in silent breakpoints.
-@xref{Output, ,Commands for Controlled Output}.
+The commands @code{echo}, @code{output}, and @code{printf} allow you to
+print precisely controlled output, and are often useful in silent
+breakpoints. @xref{Output, ,Commands for controlled output}.
For example, here is how you could use breakpoint commands to print the
value of @code{x} at entry to @code{foo} whenever @code{x} is positive.
-_0__@example
+@example
break foo if x>0
commands
silent
-echo x is\040
-output x
-echo \n
+printf "x is %d\n",x
cont
end
-_1__@end example
+@end example
One application for breakpoint commands is to compensate for one bug so
you can test for another. Put a breakpoint just after the erroneous line
end
@end example
-@cindex lost output
-One deficiency in the operation of automatically continuing breakpoints
-under Unix appears when your program uses raw mode for the terminal.
-_GDBN__ switches back to its own terminal modes (not raw) before executing
-commands, and then must switch back to raw mode when your program is
-continued. This causes any pending terminal input to be lost.
-@c FIXME: revisit below when GNU sys avail.
-@c In the GNU system, this will be fixed by changing the behavior of
-@c terminal modes.
-
-Under Unix, you can get around this problem by writing actions into
-the breakpoint condition rather than in commands. For example
-
-@example
-condition 5 (x = y + 4), 0
-@end example
-
-@noindent
-specifies a condition expression (@pxref{Expressions, ,Expressions}) that will
-change @code{x} as needed, then always have the value zero so your
-program will not stop. No input is lost here, because _GDBN__ evaluates
-break conditions without changing the terminal modes. When you want
-to have nontrivial conditions for performing the side effects, the
-operators @samp{&&}, @samp{||} and @samp{?@dots{}:} may be useful.
-
-@node Breakpoint Menus, Error in Breakpoints, Break Commands, Breakpoints
-@subsection Breakpoint Menus
+@ifclear CONLY
+@node Breakpoint Menus
+@subsection Breakpoint menus
@cindex overloading
@cindex symbol overloading
Some programming languages (notably C++) permit a single function name
to be defined several times, for application in different contexts.
This is called @dfn{overloading}. When a function name is overloaded,
-@samp{break @var{function}} is not enough to tell _GDBN__ where you
-want a breakpoint. _GDBN__ offers you a menu of numbered choices for
-different possible breakpoints, and waits for your selection with the
-prompt @samp{>}. The first two options are always @samp{[0] cancel}
-and @samp{[1] all}. Typing @kbd{1} sets a breakpoint at each
-definition of @var{function}, and typing @kbd{0} aborts the
-@code{break} command without setting any new breakpoints.
+@samp{break @var{function}} is not enough to tell @value{GDBN} where you want
+a breakpoint. If you realize this will be a problem, you can use
+something like @samp{break @var{function}(@var{types})} to specify which
+particular version of the function you want. Otherwise, @value{GDBN} offers
+you a menu of numbered choices for different possible breakpoints, and
+waits for your selection with the prompt @samp{>}. The first two
+options are always @samp{[0] cancel} and @samp{[1] all}. Typing @kbd{1}
+sets a breakpoint at each definition of @var{function}, and typing
+@kbd{0} aborts the @code{break} command without setting any new
+breakpoints.
For example, the following session excerpt shows an attempt to set a
breakpoint at the overloaded symbol @code{String::after}.
We choose three particular definitions of that function name:
-@example
-(_GDBP__) b String::after
+@c FIXME! This is likely to change to show arg type lists, at least
+@smallexample
+(@value{GDBP}) b String::after
[0] cancel
[1] all
[2] file:String.cc; line number:867
Breakpoint 2 at 0xb344: file String.cc, line 875.
Breakpoint 3 at 0xafcc: file String.cc, line 846.
Multiple breakpoints were set.
-Use the "delete" command to delete unwanted breakpoints.
-(_GDBP__)
-@end example
+Use the "delete" command to delete unwanted
+ breakpoints.
+(@value{GDBP})
+@end smallexample
+@end ifclear
-@node Error in Breakpoints, , Breakpoint Menus, Breakpoints
-@subsection ``Cannot Insert Breakpoints''
+@ifclear BARETARGET
+@node Error in Breakpoints
+@subsection ``Cannot insert breakpoints''
@c FIXME: "cannot insert breakpoints" error, v unclear.
@c Q in pending mail to Gilmore. ---pesch@cygnus.com, 26mar91
@c too. pesch, 20sep91
Under some operating systems, breakpoints cannot be used in a program if
any other process is running that program. In this situation,
-attempting to run or continue a program with a breakpoint causes _GDBN__
+attempting to run or continue a program with a breakpoint causes @value{GDBN}
to stop the other process.
When this happens, you have three ways to proceed:
Remove or disable the breakpoints, then continue.
@item
-Suspend _GDBN__, and copy the file containing your program to a new name.
-Resume _GDBN__ and use the @code{exec-file} command to specify that _GDBN__
+Suspend @value{GDBN}, and copy the file containing your program to a new name.
+Resume @value{GDBN} and use the @code{exec-file} command to specify that @value{GDBN}
should run your program under that name. Then start your program again.
@c FIXME: RMS commented here "Show example". Maybe when someone
linker option @samp{-N}. The operating system limitation may not apply
to nonsharable executables.
@end enumerate
+@end ifclear
-@node Continuing and Stepping, Signals, Breakpoints, Stopping
-@section Continuing and Stepping
+@node Continuing and Stepping
+@section Continuing and stepping
@cindex stepping
@cindex continuing
one more ``step'' of your program, where ``step'' may mean either one
line of source code, or one machine instruction (depending on what
particular command you use). Either when continuing
-or when stepping, your program may stop even sooner, due to a breakpoint
-or to a signal. (If due to a signal, you may want to use @code{handle},
-or use @samp{signal 0} to resume execution. @xref{Signals, ,Signals}.)
+or when stepping, your program may stop even sooner, due to
+@ifset BARETARGET
+a breakpoint.
+@end ifset
+@ifclear BARETARGET
+a breakpoint or a signal. (If due to a signal, you may want to use
+@code{handle}, or use @samp{signal 0} to resume execution.
+@xref{Signals, ,Signals}.)
+@end ifclear
@table @code
@item continue @r{[}@var{ignore-count}@r{]}
+@itemx c @r{[}@var{ignore-count}@r{]}
+@itemx fg @r{[}@var{ignore-count}@r{]}
@kindex continue
+@kindex c
+@kindex fg
Resume program execution, at the address where your program last stopped;
any breakpoints set at that address are bypassed. The optional argument
@var{ignore-count} allows you to specify a further number of times to
ignore a breakpoint at this location; its effect is like that of
-@code{ignore} (@pxref{Conditions, ,Break Conditions}).
+@code{ignore} (@pxref{Conditions, ,Break conditions}).
+
+The argument @var{ignore-count} is meaningful only when your program
+stopped due to a breakpoint. At other times, the argument to
+@code{continue} is ignored.
+
+The synonyms @code{c} and @code{fg} are provided purely for convenience,
+and have exactly the same behavior as @code{continue}.
+@end table
To resume execution at a different place, you can use @code{return}
-(@pxref{Returning, ,Returning from a Function}) to go back to the
+(@pxref{Returning, ,Returning from a function}) to go back to the
calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a
-Different Address}) to go to an arbitrary location in your program.
-@end table
+different address}) to go to an arbitrary location in your program.
A typical technique for using stepping is to set a breakpoint
-(@pxref{Breakpoints, ,Breakpoints Watchpoints and Exceptions}) at the
+@ifclear CONLY
+(@pxref{Breakpoints, ,Breakpoints; watchpoints; and exceptions})
+@end ifclear
+@ifset CONLY
+(@pxref{Breakpoints, ,Breakpoints and watchpoints})
+@end ifset
+at the
beginning of the function or the section of your program where a
problem is believed to lie, run your program until it stops at that
breakpoint, and then step through the suspect area, examining the
@kindex step
@kindex s
Continue running your program until control reaches a different source
-line, then stop it and return control to _GDBN__. This command is
+line, then stop it and return control to @value{GDBN}. This command is
abbreviated @code{s}.
@quotation
@emph{Warning:} If you use the @code{step} command while control is
within a function that was compiled without debugging information,
-execution will proceed until control reaches another function.
+execution proceeds until control reaches a function that does have
+debugging information.
@end quotation
@item step @var{count}
Continue running as in @code{step}, but do so @var{count} times. If a
-breakpoint is reached or a signal not related to stepping occurs before
-@var{count} steps, stepping stops right away.
+breakpoint is reached,
+@ifclear BARETARGET
+or a signal not related to stepping occurs before @var{count} steps,
+@end ifclear
+stepping stops right away.
@item next @r{[}@var{count}@r{]}
@kindex next
returns. Print the returned value (if any).
Contrast this with the @code{return} command (@pxref{Returning,
-,Returning from a Function}).
+,Returning from a function}).
@item until
@kindex until
-@item u
+@itemx u
@kindex u
Continue running until a source line past the current line, in the
current stack frame, is reached. This command is used to avoid single
@code{206}; yet when we use @code{until}, we get to line @code{195}:
@example
-(_GDBP__) f
+(@value{GDBP}) f
#0 main (argc=4, argv=0xf7fffae8) at m4.c:206
206 expand_input();
-(_GDBP__) until
+(@value{GDBP}) until
195 for ( ; argc > 0; NEXTARG) @{
@end example
argument.
@item until @var{location}
-@item u @var{location}
+@itemx u @var{location}
Continue running your program until either the specified location is
reached, or the current stack frame returns. @var{location} is any of
the forms of argument acceptable to @code{break} (@pxref{Set Breaks,
-,Setting Breakpoints}). This form of the command uses breakpoints,
+,Setting breakpoints}). This form of the command uses breakpoints,
and hence is quicker than @code{until} without an argument.
@item stepi
It is often useful to do @samp{display/i $pc} when stepping by machine
instructions. This will cause the next instruction to be executed to
be displayed automatically at each stop. @xref{Auto Display,
-,Automatic Display}.
+,Automatic display}.
An argument is a repeat count, as in @code{step}.
+@need 750
@item nexti
@itemx ni
@kindex nexti
An argument is a repeat count, as in @code{next}.
@end table
-@node Signals, , Continuing and Stepping, Stopping
+@ifset POSIX
+@node Signals
@section Signals
@cindex signals
@code{SIGINT} does not indicate an error in your program, but it is normally
fatal so it can carry out the purpose of the interrupt: to kill the program.
-_GDBN__ has the ability to detect any occurrence of a signal in your
-program. You can tell _GDBN__ in advance what to do for each kind of
+@value{GDBN} has the ability to detect any occurrence of a signal in your
+program. You can tell @value{GDBN} in advance what to do for each kind of
signal.
@cindex handling signals
-Normally, _GDBN__ is set up to ignore non-erroneous signals like @code{SIGALRM}
+Normally, @value{GDBN} is set up to ignore non-erroneous signals like @code{SIGALRM}
(so as not to interfere with their role in the functioning of your program)
but to stop your program immediately whenever an error signal happens.
You can change these settings with the @code{handle} command.
@table @code
@item info signals
@kindex info signals
-Print a table of all the kinds of signals and how _GDBN__ has been told to
+Print a table of all the kinds of signals and how @value{GDBN} has been told to
handle each one. You can use this to see the signal numbers of all
the defined types of signals.
@item handle @var{signal} @var{keywords}@dots{}
@kindex handle
-Change the way _GDBN__ handles signal @var{signal}. @var{signal} can be the
+Change the way @value{GDBN} handles signal @var{signal}. @var{signal} can be the
number of a signal or its name (with or without the @samp{SIG} at the
beginning). The @var{keywords} say what change to make.
@end table
@table @code
@item nostop
-_GDBN__ should not stop your program when this signal happens. It may
+@value{GDBN} should not stop your program when this signal happens. It may
still print a message telling you that the signal has come in.
@item stop
-_GDBN__ should stop your program when this signal happens. This implies
+@value{GDBN} should stop your program when this signal happens. This implies
the @code{print} keyword as well.
@item print
-_GDBN__ should print a message when this signal happens.
+@value{GDBN} should print a message when this signal happens.
@item noprint
-_GDBN__ should not mention the occurrence of the signal at all. This
+@value{GDBN} should not mention the occurrence of the signal at all. This
implies the @code{nostop} keyword as well.
@item pass
-_GDBN__ should allow your program to see this signal; your program will be
+@value{GDBN} should allow your program to see this signal; your program will be
able to handle the signal, or may be terminated if the signal is fatal
and not handled.
@item nopass
-_GDBN__ should not allow your program to see this signal.
+@value{GDBN} should not allow your program to see this signal.
@end table
@c @end group
-When a signal has been set to stop your program, your program cannot see the
-signal until you continue. It will see the signal then, if @code{pass} is
-in effect for the signal in question @emph{at that time}. In other words,
-after _GDBN__ reports a signal, you can use the @code{handle} command with
-@code{pass} or @code{nopass} to control whether that signal will be seen by
-your program when you later continue it.
+When a signal stops your program, the signal is not visible until you
+continue. Your program will see the signal then, if @code{pass} is in
+effect for the signal in question @emph{at that time}. In other words,
+after @value{GDBN} reports a signal, you can use the @code{handle}
+command with @code{pass} or @code{nopass} to control whether that
+signal will be seen by your program when you later continue it.
You can also use the @code{signal} command to prevent your program from
seeing a signal, or cause it to see a signal it normally would not see,
execution; but your program would probably terminate immediately as
a result of the fatal signal once it saw the signal. To prevent this,
you can continue with @samp{signal 0}. @xref{Signaling, ,Giving your
-Program a Signal}.
+program a signal}.
+@end ifset
+
+@ifclear BARETARGET
+@node Thread Stops
+@section Stopping and starting multi-thread programs
+
+When your program has multiple threads (@pxref{Threads,, Debugging
+programs with multiple threads}), you can choose whether to set
+breakpoints on all threads, or on a particular thread.
-@node Stack, Source, Stopping, Top
+@table @code
+@cindex breakpoints and threads
+@cindex thread breakpoints
+@kindex break @dots{} thread @var{threadno}
+@item break @var{linespec} thread @var{threadno}
+@itemx break @var{linespec} thread @var{threadno} if @dots{}
+Use the qualifier @samp{thread @var{threadno}} with a breakpoint command
+to specify that you only want @value{GDBN} to stop the program when a
+particular thread reaches this breakpoint. @var{threadno} is one of the
+numeric thread identifiers assigned by @value{GDBN}, shown in the first
+column of the @samp{info threads} display.
+
+If you do not specify @samp{thread @var{threadno}} when you set a
+breakpoint, the breakpoint applies to @emph{all} threads of your
+program.
+
+You can use the @code{thread} qualifier on conditional breakpoints as
+well; in this case, place @samp{thread @var{threadno}} before the
+breakpoint condition, like this:
+
+@smallexample
+(gdb) break frik.c:13 thread 28 if bartab > lim
+@end smallexample
+@end table
+
+@cindex stopped threads
+@cindex threads, stopped
+Whenever your program stops under @value{GDBN} for any reason,
+@emph{all} threads of execution stop, not just the current thread. This
+allows you to examine the overall state of the program, including
+switching between threads, without worrying that things may change
+underfoot.
+
+@cindex continuing threads
+@cindex threads, continuing
+Conversely, whenever you restart the program, @emph{all} threads start
+executing. @emph{This is true even when single-stepping} with commands
+like @code{step} or @code{next}.
+
+In particular, @value{GDBN} cannot single-step all threads in lockstep.
+Since thread scheduling is up to your debugging target's operating
+system (not controlled by @value{GDBN}), other threads may
+execute more than one statement while the current thread completes a
+single step. Moreover, in general other threads stop in the middle of a
+statement, rather than at a clean statement boundary, when the program
+stops.
+
+You might even find your program stopped in another thread after
+continuing or even single-stepping. This happens whenever some other
+thread runs into a breakpoint, a signal, or an exception before the
+first thread completes whatever you requested.
+@end ifclear
+
+@node Stack
@chapter Examining the Stack
When your program has stopped, the first thing you need to know is where it
stack frames are allocated in a region of memory called the @dfn{call
stack}.
-When your program stops, the _GDBN__ commands for examining the stack allow you
-to see all of this information.
+When your program stops, the @value{GDBN} commands for examining the
+stack allow you to see all of this information.
@cindex selected frame
-One of the stack frames is @dfn{selected} by _GDBN__ and many _GDBN__ commands
-refer implicitly to the selected frame. In particular, whenever you ask
-_GDBN__ for the value of a variable in your program, the value is found in the
-selected frame. There are special _GDBN__ commands to select whichever frame
-you are interested in.
+One of the stack frames is @dfn{selected} by @value{GDBN} and many
+@value{GDBN} commands refer implicitly to the selected frame. In
+particular, whenever you ask @value{GDBN} for the value of a variable in
+your program, the value is found in the selected frame. There are
+special @value{GDBN} commands to select whichever frame you are
+interested in.
-When your program stops, _GDBN__ automatically selects the currently executing
-frame and describes it briefly as the @code{frame} command does
-(@pxref{Frame Info, ,Information About a Frame}).
+When your program stops, @value{GDBN} automatically selects the
+currently executing frame and describes it briefly as the @code{frame}
+command does (@pxref{Frame Info, ,Information about a frame}).
@menu
-* Frames:: Stack Frames
+* Frames:: Stack frames
* Backtrace:: Backtraces
-* Selection:: Selecting a Frame
-* Frame Info:: Information on a Frame
+* Selection:: Selecting a frame
+* Frame Info:: Information on a frame
+@ifset MIPS
+* MIPS Stack:: MIPS machines and the function stack
+@end ifset
@end menu
-@node Frames, Backtrace, Stack, Stack
-@section Stack Frames
+@node Frames
+@section Stack frames
@cindex frame
@cindex stack frame
going on in that frame.
@cindex frame number
-_GDBN__ assigns numbers to all existing stack frames, starting with
+@value{GDBN} assigns numbers to all existing stack frames, starting with
zero for the innermost frame, one for the frame that called it,
and so on upward. These numbers do not really exist in your program;
-they are assigned by _GDBN__ to give you a way of designating stack
-frames in _GDBN__ commands.
+they are assigned by @value{GDBN} to give you a way of designating stack
+frames in @value{GDBN} commands.
+@c below produces an acceptable overful hbox. --mew 13aug1993
@cindex frameless execution
-Some compilers allow functions to be compiled so that they operate
-without stack frames. (For example, the @code{_GCC__} option
+Some compilers provide a way to compile functions so that they operate
+without stack frames. (For example, the @code{@value{GCC}} option
@samp{-fomit-frame-pointer} will generate functions without a frame.)
This is occasionally done with heavily used library functions to save
-the frame setup time. _GDBN__ has limited facilities for dealing with
-these function invocations. If the innermost function invocation has no
-stack frame, _GDBN__ will nevertheless regard it as though it had a
-separate frame, which is numbered zero as usual, allowing correct
-tracing of the function call chain. However, _GDBN__ has no provision
-for frameless functions elsewhere in the stack.
-
-@node Backtrace, Selection, Frames, Stack
+the frame setup time. @value{GDBN} has limited facilities for dealing
+with these function invocations. If the innermost function invocation
+has no stack frame, @value{GDBN} will nevertheless regard it as though
+it had a separate frame, which is numbered zero as usual, allowing
+correct tracing of the function call chain. However, @value{GDBN} has
+no provision for frameless functions elsewhere in the stack.
+
+@node Backtrace
@section Backtraces
A backtrace is a summary of how your program got where it is. It shows one
value, indicating that your program has stopped at the beginning of the
code for line @code{993} of @code{builtin.c}.
-@node Selection, Frame Info, Backtrace, Stack
-@section Selecting a Frame
+@node Selection
+@section Selecting a frame
Most commands for examining the stack and other data in your program work on
whichever stack frame is selected at the moment. Here are the commands for
@kindex f
Select frame number @var{n}. Recall that frame zero is the innermost
(currently executing) frame, frame one is the frame that called the
-innermost one, and so on. The highest-numbered frame is @code{main}'s
-frame.
+innermost one, and so on. The highest-numbered frame is the one for
+@code{main}.
@item frame @var{addr}
@itemx f @var{addr}
Select the frame at address @var{addr}. This is useful mainly if the
chaining of stack frames has been damaged by a bug, making it
-impossible for _GDBN__ to assign numbers properly to all frames. In
+impossible for @value{GDBN} to assign numbers properly to all frames. In
addition, this can be useful when your program has multiple stacks and
switches between them.
-_if__(_SPARC__)
+@ifset SPARC
On the SPARC architecture, @code{frame} needs two addresses to
select an arbitrary frame: a frame pointer and a stack pointer.
@c note to future updaters: this is conditioned on a flag
@c FRAME_SPECIFICATION_DYADIC in the tm-*.h files, currently only used
@c by SPARC, hence the specific attribution. Generalize or list all
@c possibilities if more supported machines start doing this.
-_fi__(_SPARC__)
+@end ifset
@item up @var{n}
@kindex up
All of these commands end by printing two lines of output describing the
frame. The first line shows the frame number, the function name, the
arguments, and the source file and line number of execution in that
-frame. The second line shows the text of that source line. For
-example:
+frame. The second line shows the text of that source line.
+For example:
@smallexample
@group
-(_GDBP__) up
+(@value{GDBP}) up
#1 0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc)
at env.c:10
10 read_input_file (argv[i]);
After such a printout, the @code{list} command with no arguments will
print ten lines centered on the point of execution in the frame.
-@xref{List, ,Printing Source Lines}.
+@xref{List, ,Printing source lines}.
@table @code
@item up-silently @var{n}
These two commands are variants of @code{up} and @code{down},
respectively; they differ in that they do their work silently, without
causing display of the new frame. They are intended primarily for use
-in _GDBN__ command scripts, where the output might be unnecessary and
+in @value{GDBN} command scripts, where the output might be unnecessary and
distracting.
@end table
-@node Frame Info, , Selection, Stack
-@section Information About a Frame
+@node Frame Info
+@section Information about a frame
There are several other commands to print information about the selected
stack frame.
When used without any argument, this command does not change which
frame is selected, but prints a brief description of the currently
selected stack frame. It can be abbreviated @code{f}. With an
-argument, this command is used to select a stack frame
-(@pxref{Selection, ,Selecting a Frame}).
+argument, this command is used to select a stack frame.
+@xref{Selection, ,Selecting a frame}.
@item info frame
@itemx info f
@item info locals
@kindex info locals
Print the local variables of the selected frame, each on a separate
-line. These are all variables declared static or automatic within all
-program blocks that execution in this frame is currently inside of.
+line. These are all variables (declared either static or automatic)
+accessible at the point of execution of the selected frame.
+@ifclear CONLY
@item info catch
@kindex info catch
@cindex catch exceptions
current stack frame at the current point of execution. To see other
exception handlers, visit the associated frame (using the @code{up},
@code{down}, or @code{frame} commands); then type @code{info catch}.
-@xref{Exception Handling, ,Breakpoints and Exceptions}.
+@xref{Exception Handling, ,Breakpoints and exceptions}.
+@end ifclear
+@end table
+
+@ifset MIPS
+@node MIPS Stack
+@section MIPS machines and the function stack
+
+@cindex stack on MIPS
+@cindex MIPS stack
+MIPS based computers use an unusual stack frame, which sometimes
+requires @value{GDBN} to search backward in the object code to find the
+beginning of a function.
+
+@cindex response time, MIPS debugging
+To improve response time (especially for embedded applications, where
+@value{GDBN} may be restricted to a slow serial line for this search)
+you may want to limit the size of this search, using one of these
+commands:
+@c FIXME! So what happens when GDB does *not* find the beginning of a
+@c function?
+
+@cindex @code{heuristic-fence-post} (MIPS)
+@table @code
+@item set heuristic-fence-post @var{limit}
+Restrict @value{GDBN} to examining at most @var{limit} bytes in its search
+for the beginning of a function. A value of @code{0} (the default)
+means there is no limit.
+
+@item show heuristic-fence-post
+Display the current limit.
@end table
-@node Source, Data, Stack, Top
+@noindent
+These commands are available @emph{only} when @value{GDBN} is configured
+for debugging programs on MIPS processors.
+@end ifset
+
+@node Source
@chapter Examining Source Files
-_GDBN__ can print parts of your program's source, since the debugging
-information recorded in your program tells _GDBN__ what source files were
-used to build it. When your program stops, _GDBN__ spontaneously prints
+@value{GDBN} can print parts of your program's source, since the debugging
+information recorded in the program tells @value{GDBN} what source files were
+used to build it. When your program stops, @value{GDBN} spontaneously prints
the line where it stopped. Likewise, when you select a stack frame
-(@pxref{Selection, ,Selecting a Frame}), _GDBN__ prints the line where
+(@pxref{Selection, ,Selecting a frame}), @value{GDBN} prints the line where
execution in that frame has stopped. You can print other portions of
source files by explicit command.
-If you use _GDBN__ through its GNU Emacs interface, you may prefer to use
-Emacs facilities to view source; @pxref{Emacs, ,Using _GDBN__ under GNU
+@ifclear DOSHOST
+If you use @value{GDBN} through its GNU Emacs interface, you may prefer to use
+Emacs facilities to view source; @pxref{Emacs, ,Using @value{GDBN} under GNU
Emacs}.
+@end ifclear
@menu
-* List:: Printing Source Lines
-* Search:: Searching Source Files
-* Source Path:: Specifying Source Directories
-* Machine Code:: Source and Machine Code
+* List:: Printing source lines
+@ifclear DOSHOST
+* Search:: Searching source files
+@end ifclear
+
+* Source Path:: Specifying source directories
+* Machine Code:: Source and machine code
@end menu
-@node List, Search, Source, Source
-@section Printing Source Lines
+@node List
+@section Printing source lines
@kindex list
@kindex l
Print lines just before the lines last printed.
@end table
-By default, _GDBN__ prints ten source lines with any of these forms of
+By default, @value{GDBN} prints ten source lines with any of these forms of
the @code{list} command. You can change this using @code{set listsize}:
@table @code
@var{address} may be any expression.
@end table
-@node Search, Source Path, List, Source
-@section Searching Source Files
+@ifclear DOSHOST
+@node Search
+@section Searching source files
@cindex searching
@kindex reverse-search
for @var{regexp}. It lists the line that is found. You can abbreviate
this command as @code{rev}.
@end table
+@end ifclear
-@node Source Path, Machine Code, Search, Source
-@section Specifying Source Directories
+@node Source Path
+@section Specifying source directories
@cindex source path
@cindex directories for source files
Executable programs sometimes do not record the directories of the source
files from which they were compiled, just the names. Even when they do,
the directories could be moved between the compilation and your debugging
-session. _GDBN__ has a list of directories to search for source files;
-this is called the @dfn{source path}. Each time _GDBN__ wants a source file,
+session. @value{GDBN} has a list of directories to search for source files;
+this is called the @dfn{source path}. Each time @value{GDBN} wants a source file,
it tries all the directories in the list, in the order they are present
in the list, until it finds a file with the desired name. Note that
the executable search path is @emph{not} used for this purpose. Neither is
the current working directory, unless it happens to be in the source
path.
-If _GDBN__ cannot find a source file in the source path, and the object
-program records a directory, _GDBN__ tries that directory too. If the
+If @value{GDBN} cannot find a source file in the source path, and the object
+program records a directory, @value{GDBN} tries that directory too. If the
source path is empty, and there is no record of the compilation
-directory, _GDBN__ will, as a last resort, look in the current
+directory, @value{GDBN} will, as a last resort, look in the current
directory.
-Whenever you reset or rearrange the source path, _GDBN__ will clear out
+Whenever you reset or rearrange the source path, @value{GDBN} will clear out
any information it has cached about where source files are found, where
each line is in the file, etc.
@kindex directory
-When you start _GDBN__, its source path is empty.
+When you start @value{GDBN}, its source path is empty.
To add other directories, use the @code{directory} command.
@table @code
whitespace. You may specify a directory that is already in the source
path; this moves it forward, so it will be searched sooner.
+@kindex cdir
+@kindex cwd
+@kindex $cdir
+@kindex $cwd
+@cindex compilation directory
+@cindex current directory
+@cindex working directory
+@cindex directory, current
+@cindex directory, compilation
You can use the string @samp{$cdir} to refer to the compilation
directory (if one is recorded), and @samp{$cwd} to refer to the current
working directory. @samp{$cwd} is not the same as @samp{.}---the former
-tracks the current working directory as it changes during your _GDBN__
+tracks the current working directory as it changes during your @value{GDBN}
session, while the latter is immediately expanded to the current
directory at the time you add an entry to the source path.
@end table
If your source path is cluttered with directories that are no longer of
-interest, _GDBN__ may sometimes cause confusion by finding the wrong
+interest, @value{GDBN} may sometimes cause confusion by finding the wrong
versions of source. You can correct the situation as follows:
@enumerate
directories in one command.
@end enumerate
-@node Machine Code, , Source Path, Source
-@section Source and Machine Code
+@node Machine Code
+@section Source and machine code
You can use the command @code{info line} to map source lines to program
-addresses (and viceversa), and the command @code{disassemble} to display
+addresses (and vice versa), and the command @code{disassemble} to display
a range of addresses as machine instructions.
@table @code
Print the starting and ending addresses of the compiled code for
source line @var{linespec}. You can specify source lines in any of
the ways understood by the @code{list} command (@pxref{List, ,Printing
-Source Lines}).
+source lines}).
@end table
For example, we can use @code{info line} to discover the location of
@code{m4_changequote}:
@smallexample
-(_GDBP__) info line m4_changecom
+(@value{GDBP}) info line m4_changecom
Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350.
@end smallexample
We can also inquire (using @code{*@var{addr}} as the form for
@var{linespec}) what source line covers a particular address:
@smallexample
-(_GDBP__) info line *0x63ff
+(@value{GDBP}) info line *0x63ff
Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404.
@end smallexample
After @code{info line}, the default address for the @code{x} command
is changed to the starting address of the line, so that @samp{x/i} is
sufficient to begin examining the machine code (@pxref{Memory,
-,Examining Memory}). Also, this address is saved as the value of the
+,Examining memory}). Also, this address is saved as the value of the
convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience
-Variables}).
+variables}).
@table @code
@kindex disassemble
@item disassemble
+@cindex assembly instructions
+@cindex instructions, assembly
+@cindex machine instructions
+@cindex listing machine instructions
This specialized command dumps a range of memory as machine
instructions. The default memory range is the function surrounding the
program counter of the selected frame. A single argument to this
inclusive, second exclusive) to dump.
@end table
+@ifclear H8EXCLUSIVE
We can use @code{disassemble} to inspect the object code
-range shown in the last @code{info line} example:
+range shown in the last @code{info line} example (the example
+shows SPARC machine instructions):
+
@smallexample
-(_GDBP__) disas 0x63e4 0x6404
+(@value{GDBP}) disas 0x63e4 0x6404
Dump of assembler code from 0x63e4 to 0x6404:
0x63e4 <builtin_init+5340>: ble 0x63f8 <builtin_init+5360>
0x63e8 <builtin_init+5344>: sethi %hi(0x4c00), %o0
0x6400 <builtin_init+5368>: nop
End of assembler dump.
@end smallexample
+@end ifclear
+
+@ifset H8EXCLUSIVE
+For example, here is the beginning of the output for the
+disassembly of a function @code{fact}:
+
+
+@smallexample
+(@value{GDBP}) disas fact
+Dump of assembler code for function fact:
+to 0x808c:
+0x802c <fact>: 6d f2 mov.w r2,@@-r7
+0x802e <fact+2>: 6d f3 mov.w r3,@@-r7
+0x8030 <fact+4>: 6d f6 mov.w r6,@@-r7
+0x8032 <fact+6>: 0d 76 mov.w r7,r6
+0x8034 <fact+8>: 6f 70 00 08 mov.w @@(0x8,r7),r0
+0x8038 <fact+12> 19 11 sub.w r1,r1
+ .
+ .
+ .
+@end smallexample
+@end ifset
-@node Data, Languages, Source, Top
+@node Data
@chapter Examining Data
@cindex printing data
@c document because it is nonstandard... Under Epoch it displays in a
@c different window or something like that.
The usual way to examine data in your program is with the @code{print}
-command (abbreviated @code{p}), or its synonym @code{inspect}. It
-evaluates and prints the value of an expression of the language your
-program is written in (@pxref{Languages, ,Using _GDBN__ with Different
-Languages}).
+command (abbreviated @code{p}), or its synonym @code{inspect}.
+@ifclear CONLY
+It evaluates and prints the value of an expression of the language your
+program is written in (@pxref{Languages, ,Using @value{GDBN} with Different
+Languages}).
+@end ifclear
@table @code
@item print @var{exp}
@itemx print /@var{f} @var{exp}
-@var{exp} is an expression (in the source language). By default
-the value of @var{exp} is printed in a format appropriate to its data
-type; you can choose a different format by specifying @samp{/@var{f}},
-where @var{f} is a letter specifying the format; @pxref{Output formats}.
+@var{exp} is an expression (in the source language). By default the
+value of @var{exp} is printed in a format appropriate to its data type;
+you can choose a different format by specifying @samp{/@var{f}}, where
+@var{f} is a letter specifying the format; @pxref{Output Formats,,Output
+formats}.
@item print
@itemx print /@var{f}
-If you omit @var{exp}, _GDBN__ displays the last value again (from the
-@dfn{value history}; @pxref{Value History, ,Value History}). This allows you to
+If you omit @var{exp}, @value{GDBN} displays the last value again (from the
+@dfn{value history}; @pxref{Value History, ,Value history}). This allows you to
conveniently inspect the same value in an alternative format.
@end table
A more low-level way of examining data is with the @code{x} command.
It examines data in memory at a specified address and prints it in a
-specified format. @xref{Memory, ,Examining Memory}.
+specified format. @xref{Memory, ,Examining memory}.
If you are interested in information about types, or about how the fields
-of a struct or class are declared, use the @code{ptype @var{exp}}
+of a struct
+@ifclear CONLY
+or class
+@end ifclear
+are declared, use the @code{ptype @var{exp}}
command rather than @code{print}. @xref{Symbols, ,Examining the Symbol Table}.
@menu
* Expressions:: Expressions
-* Variables:: Program Variables
-* Arrays:: Artificial Arrays
-* Output formats:: Output formats
-* Memory:: Examining Memory
-* Auto Display:: Automatic Display
-* Print Settings:: Print Settings
-* Value History:: Value History
-* Convenience Vars:: Convenience Variables
+* Variables:: Program variables
+* Arrays:: Artificial arrays
+* Output Formats:: Output formats
+* Memory:: Examining memory
+* Auto Display:: Automatic display
+* Print Settings:: Print settings
+* Value History:: Value history
+* Convenience Vars:: Convenience variables
* Registers:: Registers
-* Floating Point Hardware:: Floating Point Hardware
+@ifclear HAVE-FLOAT
+* Floating Point Hardware:: Floating point hardware
+@end ifclear
@end menu
-@node Expressions, Variables, Data, Data
+@node Expressions
@section Expressions
@cindex expressions
-@code{print} and many other _GDBN__ commands accept an expression and
+@code{print} and many other @value{GDBN} commands accept an expression and
compute its value. Any kind of constant, variable or operator defined
-by the programming language you are using is legal in an expression in
-_GDBN__. This includes conditional expressions, function calls, casts
+by the programming language you are using is valid in an expression in
+@value{GDBN}. This includes conditional expressions, function calls, casts
and string constants. It unfortunately does not include symbols defined
by preprocessor @code{#define} commands.
+@ifclear CONLY
Because C is so widespread, most of the expressions shown in examples in
-this manual are in C. @xref{Languages, , Using _GDBN__ with Different
+this manual are in C. @xref{Languages, , Using @value{GDBN} with Different
Languages}, for information on how to use expressions in other
languages.
-In this section, we discuss operators that you can use in _GDBN__
+In this section, we discuss operators that you can use in @value{GDBN}
expressions regardless of your programming language.
Casts are supported in all languages, not just in C, because it is so
useful to cast a number into a pointer so as to examine a structure
at that address in memory.
@c FIXME: casts supported---Mod2 true?
+@end ifclear
-_GDBN__ supports these operators in addition to those of programming
+@value{GDBN} supports these operators in addition to those of programming
languages:
@table @code
@item @@
@samp{@@} is a binary operator for treating parts of memory as arrays.
-@xref{Arrays, ,Artificial Arrays}, for more information.
+@xref{Arrays, ,Artificial arrays}, for more information.
@item ::
@samp{::} allows you to specify a variable in terms of the file or
-function where it is defined. @xref{Variables, ,Program Variables}.
+function where it is defined. @xref{Variables, ,Program variables}.
@item @{@var{type}@} @var{addr}
+@cindex @{@var{type}@}
+@cindex type casting memory
+@cindex memory, viewing as typed object
+@cindex casts, to view memory
Refers to an object of type @var{type} stored at address @var{addr} in
memory. @var{addr} may be any expression whose value is an integer or
pointer (but parentheses are required around binary operators, just as in
normally supposed to reside at @var{addr}.
@end table
-@node Variables, Arrays, Expressions, Data
-@section Program Variables
+@node Variables
+@section Program variables
The most common kind of expression to use is the name of a variable
in your program.
Variables in expressions are understood in the selected stack frame
-(@pxref{Selection, ,Selecting a Frame}); they must either be global
+(@pxref{Selection, ,Selecting a frame}); they must either be global
(or static) or be visible according to the scope rules of the
programming language from the point of execution in that frame. This
means that in the function
@end example
@noindent
-the variable @code{a} is usable whenever your program is executing
-within the function @code{foo}, but the variable @code{b} is visible
-only while your program is executing inside the block in which @code{b}
-is declared.
+you can examine and use the variable @code{a} whenever your program is
+executing within the function @code{foo}, but you can only use or
+examine the variable @code{b} while your program is executing inside
+the block where @code{b} is declared.
@cindex variable name conflict
There is an exception: you can refer to a variable or function whose
@noindent
Here @var{file} or @var{function} is the name of the context for the
-static @var{variable}.
+static @var{variable}. In the case of file names, you can use quotes to
+make sure @value{GDBN} parses the file name as a single word---for example,
+to print a global value of @code{x} defined in @file{f2.c}:
+@example
+(@value{GDBP}) p 'f2.c'::x
+@end example
+
+@ifclear CONLY
@cindex C++ scope resolution
This use of @samp{::} is very rarely in conflict with the very similar
-use of the same notation in C++. _GDBN__ also supports use of the C++
-scope resolution operator in _GDBN__ expressions.
+use of the same notation in C++. @value{GDBN} also supports use of the C++
+scope resolution operator in @value{GDBN} expressions.
+@c FIXME: Um, so what happens in one of those rare cases where it's in
+@c conflict?? --mew
+@end ifclear
@cindex wrong values
@cindex variable values, wrong
@quotation
@emph{Warning:} Occasionally, a local variable may appear to have the
-wrong value at certain points in a function---just after entry to the
-function, and just before exit. You may see this problem when you are
-stepping by machine instructions. This is because on most machines, it
-takes more than one instruction to set up a stack frame (including local
-variable definitions); if you are stepping by machine instructions,
-variables may appear to have the wrong values until the stack frame is
-completely built. On function exit, it usually also takes more than one
-machine instruction to destroy a stack frame; after you begin stepping
-through that group of instructions, local variable definitions may be
-gone.
+wrong value at certain points in a function---just after entry to a new
+scope, and just before exit.
@end quotation
-
-@node Arrays, Output formats, Variables, Data
-@section Artificial Arrays
+You may see this problem when you are stepping by machine instructions.
+This is because on most machines, it takes more than one instruction to
+set up a stack frame (including local variable definitions); if you are
+stepping by machine instructions, variables may appear to have the wrong
+values until the stack frame is completely built. On exit, it usually
+also takes more than one machine instruction to destroy a stack frame;
+after you begin stepping through that group of instructions, local
+variable definitions may be gone.
+
+@node Arrays
+@section Artificial arrays
@cindex artificial array
@kindex @@
dynamically determined size for which only a pointer exists in the
program.
-This can be done by constructing an @dfn{artificial array} with the
-binary operator @samp{@@}. The left operand of @samp{@@} should be
-the first element of the desired array, as an individual object.
-The right operand should be the desired length of the array. The result is
-an array value whose elements are all of the type of the left argument.
-The first element is actually the left argument; the second element
-comes from bytes of memory immediately following those that hold the
-first element, and so on. Here is an example. If a program says
+You can do this by referring to a contiguous span of memory as an
+@dfn{artificial array}, using the binary operator @samp{@@}. The left
+operand of @samp{@@} should be the first element of the desired array,
+as an individual object. The right operand should be the desired length
+of the array. The result is an array value whose elements are all of
+the type of the left argument. The first element is actually the left
+argument; the second element comes from bytes of memory immediately
+following those that hold the first element, and so on. Here is an
+example. If a program says
@example
int *array = (int *) malloc (len * sizeof (int));
with @samp{@@} in this way behave just like other arrays in terms of
subscripting, and are coerced to pointers when used in expressions.
Artificial arrays most often appear in expressions via the value history
-(@pxref{Value History, ,Value History}), after printing one out.)
+(@pxref{Value History, ,Value history}), after printing one out.
Sometimes the artificial array mechanism is not quite enough; in
moderately complex data structures, the elements of interest may not
actually be adjacent---for example, if you are interested in the values
of pointers in an array. One useful work-around in this situation is
to use a convenience variable (@pxref{Convenience Vars, ,Convenience
-Variables}) as a counter in an expression that prints the first
+variables}) as a counter in an expression that prints the first
interesting value, and then repeat that expression via @key{RET}. For
instance, suppose you have an array @code{dtab} of pointers to
structures, and you are interested in the values of a field @code{fv}
@dots{}
@end example
-@node Output formats, Memory, Arrays, Data
+@node Output Formats
@section Output formats
@cindex formatted output
@cindex output formats
-By default, _GDBN__ prints a value according to its data type. Sometimes
+By default, @value{GDBN} prints a value according to its data type. Sometimes
this is not what you want. For example, you might want to print a number
in hex, or a pointer in decimal. Or you might want to view data in memory
at a certain address as a character string or as an instruction. To do
@item t
Print as integer in binary. The letter @samp{t} stands for ``two''.
+@footnote{@samp{b} cannot be used because these format letters are also
+used with the @code{x} command, where @samp{b} stands for ``byte'';
+@pxref{Memory,,Examining memory}.}
@item a
Print as an address, both absolute in hex and as an offset from the
what function) an unknown address is located:
@example
-(_GDBP__) p/a 0x54320
-_0__$3 = 0x54320 <_initialize_vx+396>_1__
+(@value{GDBP}) p/a 0x54320
+$3 = 0x54320 <_initialize_vx+396>
@end example
@item c
@noindent
Note that no space is required before the slash; this is because command
-names in _GDBN__ cannot contain a slash.
+names in @value{GDBN} cannot contain a slash.
To reprint the last value in the value history with a different format,
you can use the @code{print} command with just a format and no
expression. For example, @samp{p/x} reprints the last value in hex.
-@node Memory, Auto Display, Output formats, Data
-@section Examining Memory
+@node Memory
+@section Examining memory
You can use the command @code{x} (for ``examine'') to examine memory in
any of several formats, independently of your program's data types.
@item x/@var{nfu} @var{addr}
@itemx x @var{addr}
@itemx x
-Use the command @code{x} to examine memory.
+Use the @code{x} command to examine memory.
@end table
@var{n}, @var{f}, and @var{u} are all optional parameters that specify how
@item @var{u}, the unit size
The unit size is any of
+
@table @code
@item b
Bytes.
@samp{i} formats, the unit size is ignored and is normally not written.)
@item @var{addr}, starting display address
-@var{addr} is the address where you want _GDBN__ to begin displaying
+@var{addr} is the address where you want @value{GDBN} to begin displaying
memory. The expression need not have a pointer value (though it may);
it is always interpreted as an integer address of a byte of memory.
@xref{Expressions, ,Expressions}, for more information on expressions. The default for
@samp{3i} specifies that you want to see three machine instructions,
including any operands. The command @code{disassemble} gives an
alternative way of inspecting machine instructions; @pxref{Machine
-Code}.
+Code,,Source and machine code}.
All the defaults for the arguments to @code{x} are designed to make it
easy to continue scanning memory with minimal specifications each time
@cindex @code{$_}, @code{$__}, and value history
The addresses and contents printed by the @code{x} command are not saved
in the value history because there is often too much of them and they
-would get in the way. Instead, _GDBN__ makes these values available for
+would get in the way. Instead, @value{GDBN} makes these values available for
subsequent use in expressions as values of the convenience variables
@code{$_} and @code{$__}. After an @code{x} command, the last address
examined is available for use in expressions in the convenience variable
are from the last memory unit printed; this is not the same as the last
address printed if several units were printed on the last line of output.
-@node Auto Display, Print Settings, Memory, Data
-@section Automatic Display
+@node Auto Display
+@section Automatic display
@cindex automatic display
@cindex display of expressions
If you find that you want to print the value of an expression frequently
(to see how it changes), you might want to add it to the @dfn{automatic
-display list} so that _GDBN__ will print its value each time your program stops.
+display list} so that @value{GDBN} will print its value each time your program stops.
Each expression added to the list is given a number to identify it;
to remove an expression from the list, you specify that number.
The automatic display looks like this:
@end example
@noindent
-showing item numbers, expressions and their current values. As with
+This display shows item numbers, expressions and their current values. As with
displays you request manually using @code{x} or @code{print}, you can
specify the output format you prefer; in fact, @code{display} decides
whether to use @code{print} or @code{x} depending on how elaborate your
@item display/@var{fmt} @var{exp}
For @var{fmt} specifying only a display format and not a size or
count, add the expression @var{exp} to the auto-display list but
-arranges to display it each time in the specified format @var{fmt}.
-@xref{Output formats}.
+arrange to display it each time in the specified format @var{fmt}.
+@xref{Output Formats,,Output formats}.
@item display/@var{fmt} @var{addr}
For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a
number of units, add the expression @var{addr} as a memory address to
be examined each time your program stops. Examining means in effect
-doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining Memory}.
+doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining memory}.
@end table
For example, @samp{display/i $pc} can be helpful, to see the machine
your program stops where @code{last_char} is meaningful, you can enable the
display expression once again.
-@node Print Settings, Value History, Auto Display, Data
-@section Print Settings
+@node Print Settings
+@section Print settings
@cindex format options
@cindex print settings
-_GDBN__ provides the following ways to control how arrays, structures,
+@value{GDBN} provides the following ways to control how arrays, structures,
and symbols are printed.
@noindent
@table @code
@item set print address
-@item set print address on
+@itemx set print address on
@kindex set print address
-_GDBN__ will print memory addresses showing the location of stack
+@value{GDBN} will print memory addresses showing the location of stack
traces, structure values, pointer values, breakpoints, and so forth,
even when it also displays the contents of those addresses. The default
is on. For example, this is what a stack frame display looks like, with
@smallexample
@group
-(_GDBP__) f
+(@value{GDBP}) f
#0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>")
at input.c:530
530 if (lquote != def_lquote)
Do not print addresses when displaying their contents. For example,
this is the same stack frame displayed with @code{set print address off}:
-@example
+@smallexample
@group
-(_GDBP__) set print addr off
-(_GDBP__) f
+(@value{GDBP}) set print addr off
+(@value{GDBP}) f
#0 set_quotes (lq="<<", rq=">>") at input.c:530
530 if (lquote != def_lquote)
@end group
-@end example
+@end smallexample
+
+You can use @samp{set print address off} to eliminate all machine
+dependent displays from the @value{GDBN} interface. For example, with
+@code{print address off}, you should get the same text for backtraces on
+all machines---whether or not they involve pointer arguments.
@item show print address
@kindex show print address
Show whether or not addresses are to be printed.
+@end table
+
+When @value{GDBN} prints a symbolic address, it normally prints the
+closest earlier symbol plus an offset. If that symbol does not uniquely
+identify the address (for example, it is a name whose scope is a single
+source file), you may need to disambiguate. One way to do this is with
+@code{info line}, for example @code{info line *0x4537}. Alternately,
+you can set @value{GDBN} to print the source file and line number when
+it prints a symbolic address:
+
+@table @code
+@item set print symbol-filename on
+@kindex set print symbol-filename
+Tell @value{GDBN} to print the source file name and line number of a
+symbol in the symbolic form of an address.
+
+@item set print symbol-filename off
+Do not print source file name and line number of a symbol. This is the
+default.
+@item show print symbol-filename
+@kindex show print symbol-filename
+Show whether or not @value{GDBN} will print the source file name and
+line number of a symbol in the symbolic form of an address.
+@end table
+
+Also, you may wish to see the symbolic form only if the address being
+printed is reasonably close to the closest earlier symbol:
+
+@table @code
+@item set print max-symbolic-offset @var{max-offset}
+@kindex set print max-symbolic-offset
+Tell @value{GDBN} to only display the symbolic form of an address if the
+offset between the closest earlier symbol and the address is less than
+@var{max-offset}. The default is 0, which means to always print the
+symbolic form of an address, if any symbol precedes it.
+
+@item show print max-symbolic-offset
+@kindex show print max-symbolic-offset
+Ask how large the maximum offset is that @value{GDBN} will print in a
+symbolic address.
+@end table
+
+@table @code
@item set print array
@itemx set print array on
@kindex set print array
-_GDBN__ will pretty print arrays. This format is more convenient to read,
+@value{GDBN} will pretty-print arrays. This format is more convenient to read,
but uses more space. The default is off.
-@item set print array off.
+@item set print array off
Return to compressed format for arrays.
@item show print array
@item set print elements @var{number-of-elements}
@kindex set print elements
-If _GDBN__ is printing a large array, it will stop printing after it has
+If @value{GDBN} is printing a large array, it will stop printing after it has
printed the number of elements set by the @code{set print elements} command.
This limit also applies to the display of strings.
+Setting the number of elements to zero means that the printing is unlimited.
@item show print elements
@kindex show print elements
-Display the number of elements of a large array that _GDBN__ will print
+Display the number of elements of a large array that @value{GDBN} will print
before losing patience.
@item set print pretty on
@kindex set print pretty
-Cause _GDBN__ to print structures in an indented format with one member per
+Cause @value{GDBN} to print structures in an indented format with one member per
line, like this:
-@example
+@smallexample
@group
$1 = @{
next = 0x0,
meat = 0x54 "Pork"
@}
@end group
-@end example
+@end smallexample
@item set print pretty off
-Cause _GDBN__ to print structures in a compact format, like this:
+Cause @value{GDBN} to print structures in a compact format, like this:
@smallexample
@group
@item show print pretty
@kindex show print pretty
-Show which format _GDBN__ will use to print structures.
+Show which format @value{GDBN} will use to print structures.
@item set print sevenbit-strings on
@kindex set print sevenbit-strings
Print using only seven-bit characters; if this option is set,
-_GDBN__ will display any eight-bit characters (in strings or character
+@value{GDBN} will display any eight-bit characters (in strings or character
values) using the notation @code{\}@var{nnn}. For example, @kbd{M-a} is
displayed as @code{\341}.
@item show print sevenbit-strings
@kindex show print sevenbit-strings
-Show whether or not _GDBN__ will print only seven-bit characters.
+Show whether or not @value{GDBN} will print only seven-bit characters.
@item set print union on
@kindex set print union
-Tell _GDBN__ to print unions which are contained in structures. This is the
+Tell @value{GDBN} to print unions which are contained in structures. This is the
default setting.
@item set print union off
-Tell _GDBN__ not to print unions which are contained in structures.
+Tell @value{GDBN} not to print unions which are contained in structures.
@item show print union
@kindex show print union
-Ask _GDBN__ whether or not it will print unions which are contained in
+Ask @value{GDBN} whether or not it will print unions which are contained in
structures.
For example, given the declarations
@end smallexample
@end table
+@ifclear CONLY
+@need 1000
@noindent
These settings are of interest when debugging C++ programs:
@item set print demangle
@itemx set print demangle on
@kindex set print demangle
-Print C++ names in their source form rather than in the mangled form
-in which they are passed to the assembler and linker for type-safe linkage.
-The default is on.
+Print C++ names in their source form rather than in the encoded
+(``mangled'') form passed to the assembler and linker for type-safe
+linkage. The default is @samp{on}.
@item show print demangle
@kindex show print demangle
Show whether C++ names in assembly listings will be printed in mangled
or demangled form.
+@item set demangle-style @var{style}
+@kindex set demangle-style
+@cindex C++ symbol decoding style
+@cindex symbol decoding style, C++
+Choose among several encoding schemes used by different compilers to
+represent C++ names. The choices for @var{style} are currently:
+
+@table @code
+@item auto
+Allow @value{GDBN} to choose a decoding style by inspecting your program.
+
+@item gnu
+Decode based on the GNU C++ compiler (@code{g++}) encoding algorithm.
+
+@item lucid
+Decode based on the Lucid C++ compiler (@code{lcc}) encoding algorithm.
+
+@item arm
+Decode using the algorithm in the @cite{C++ Annotated Reference Manual}.
+@strong{Warning:} this setting alone is not sufficient to allow
+debugging @code{cfront}-generated executables. @value{GDBN} would
+require further enhancement to permit that.
+@end table
+
+@item show demangle-style
+@kindex show demangle-style
+Display the encoding style currently in use for decoding C++ symbols.
+
@item set print object
@itemx set print object on
@kindex set print object
@kindex show print vtbl
Show whether C++ virtual function tables are pretty printed, or not.
@end table
+@end ifclear
-@node Value History, Convenience Vars, Print Settings, Data
-@section Value History
+@node Value History
+@section Value history
@cindex value history
-Values printed by the @code{print} command are saved in _GDBN__'s @dfn{value
+Values printed by the @code{print} command are saved in the @value{GDBN} @dfn{value
history} so that you can refer to them in other expressions. Values are
kept until the symbol table is re-read or discarded (for example with
the @code{file} or @code{symbol-file} commands). When the symbol table
@cindex @code{$}
@cindex @code{$$}
@cindex history number
-The values printed are given @dfn{history numbers} for you to refer to them
-by. These are successive integers starting with one. @code{print} shows you
-the history number assigned to a value by printing @samp{$@var{num} = }
-before the value; here @var{num} is the history number.
+The values printed are given @dfn{history numbers} by which you can
+refer to them. These are successive integers starting with one.
+@code{print} shows you the history number assigned to a value by
+printing @samp{$@var{num} = } before the value; here @var{num} is the
+history number.
To refer to any previous value, use @samp{$} followed by the value's
history number. The way @code{print} labels its output is designed to
Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the
same effect as @samp{show values +}.
-@node Convenience Vars, Registers, Value History, Data
-@section Convenience Variables
+@node Convenience Vars
+@section Convenience variables
@cindex convenience variables
-_GDBN__ provides @dfn{convenience variables} that you can use within
-_GDBN__ to hold on to a value and refer to it later. These variables
-exist entirely within _GDBN__; they are not part of your program, and
+@value{GDBN} provides @dfn{convenience variables} that you can use within
+@value{GDBN} to hold on to a value and refer to it later. These variables
+exist entirely within @value{GDBN}; they are not part of your program, and
setting a convenience variable has no direct effect on further execution
of your program. That is why you can use them freely.
@samp{$} can be used for a convenience variable, unless it is one of
the predefined machine-specific register names (@pxref{Registers}).
(Value history references, in contrast, are @emph{numbers} preceded
-by @samp{$}. @xref{Value History, ,Value History}.)
+by @samp{$}. @xref{Value History, ,Value history}.)
You can save a value in a convenience variable with an assignment
-expression, just as you would set a variable in your program. Example:
+expression, just as you would set a variable in your program.
+For example:
@example
set $foo = *object_ptr
would save in @code{$foo} the value contained in the object pointed to by
@code{object_ptr}.
-Using a convenience variable for the first time creates it; but its value
-is @code{void} until you assign a new value. You can alter the value with
-another assignment at any time.
+Using a convenience variable for the first time creates it, but its
+value is @code{void} until you assign a new value. You can alter the
+value with another assignment at any time.
Convenience variables have no fixed types. You can assign a convenience
variable any type of value, including structures and arrays, even if
incremented or a pointer to be advanced. For example, to print
a field from successive elements of an array of structures:
-_0__@example
+@example
set $i = 0
print bar[$i++]->contents
@i{@dots{} repeat that command by typing @key{RET}.}
-_1__@end example
+@end example
-Some convenience variables are created automatically by _GDBN__ and given
+Some convenience variables are created automatically by @value{GDBN} and given
values likely to be useful.
@table @code
@item $_
@kindex $_
The variable @code{$_} is automatically set by the @code{x} command to
-the last address examined (@pxref{Memory, ,Examining Memory}). Other
+the last address examined (@pxref{Memory, ,Examining memory}). Other
commands which provide a default address for @code{x} to examine also
set @code{$_} to that address; these commands include @code{info line}
and @code{info breakpoint}. The type of @code{$_} is @code{void *}
to match the format in which the data was printed.
@end table
-@node Registers, Floating Point Hardware, Convenience Vars, Data
+@node Registers
@section Registers
@cindex registers
Print the names and values of all registers, including floating-point
registers.
-@item info registers @var{regname}
-Print the relativized value of register @var{regname}. @var{regname}
-may be any register name valid on the machine you are using, with
+@item info registers @var{regname} @dots{}
+Print the relativized value of each specified register @var{regname}.
+@var{regname} may be any register name valid on the machine you are using, with
or without the initial @samp{$}.
@end table
-_GDBN__ has four ``standard'' register names that are available (in
+@value{GDBN} has four ``standard'' register names that are available (in
expressions) on most machines---whenever they do not conflict with an
architecture's canonical mnemonics for registers. The register names
@code{$pc} and @code{$sp} are used for the program counter register and
@end example
@noindent
-or add four to the stack pointer @footnote{This is a way of removing
+or add four to the stack pointer@footnote{This is a way of removing
one word from the stack, on machines where stacks grow downward in
memory (most machines, nowadays). This assumes that the innermost
stack frame is selected; setting @code{$sp} is not allowed when other
stack frames are selected. To pop entire frames off the stack,
regardless of machine architecture, use @code{return};
-@pxref{Returning, ,Returning from a Function}.} with
+@pxref{Returning, ,Returning from a function}.} with
@example
set $sp += 4
registers} displays the processor status register as @code{$psr} but you
can also refer to it as @code{$ps}.
-_GDBN__ always considers the contents of an ordinary register as an
+@value{GDBN} always considers the contents of an ordinary register as an
integer when the register is examined in this way. Some machines have
special registers which can hold nothing but floating point; these
registers are considered to have floating point values. There is no way
sees. For example, the registers of the 68881 floating point
coprocessor are always saved in ``extended'' (raw) format, but all C
programs expect to work with ``double'' (virtual) format. In such
-cases, _GDBN__ normally works with the virtual format only (the format that
+cases, @value{GDBN} normally works with the virtual format only (the format that
makes sense for your program), but the @code{info registers} command
prints the data in both formats.
Normally, register values are relative to the selected stack frame
-(@pxref{Selection, ,Selecting a Frame}). This means that you get the
+(@pxref{Selection, ,Selecting a frame}). This means that you get the
value that the register would contain if all stack frames farther in
were exited and their saved registers restored. In order to see the
true contents of hardware registers, you must select the innermost
frame (with @samp{frame 0}).
-However, _GDBN__ must deduce where registers are saved, from the machine
+However, @value{GDBN} must deduce where registers are saved, from the machine
code generated by your compiler. If some registers are not saved, or if
-_GDBN__ is unable to locate the saved registers, the selected stack
+@value{GDBN} is unable to locate the saved registers, the selected stack
frame will make no difference.
-_if__(_AMD29K__)
+@ifset AMD29K
+@table @code
@item set rstack_high_address @var{address}
@kindex set rstack_high_address
-@cindex AMD 29K
-On AMD 29000 family processors, registers are saved in a separate ``register
-stack''. There is no way for GDB to determine the extent of this stack.
-Normally, GDB just assumes that the stack is ``large enough''.
-This may result in GDB referencing memory locations that don't
-exist, you can specify the ending address of the register stack with the
-@code{set rstack_high_address} command. The argument should be an address,
-which you will probably want to precede with 0x and specify in hexadecimal.
+@cindex AMD 29K register stack
+@cindex register stack, AMD29K
+On AMD 29000 family processors, registers are saved in a separate
+``register stack''. There is no way for @value{GDBN} to determine the extent
+of this stack. Normally, @value{GDBN} just assumes that the stack is ``large
+enough''. This may result in @value{GDBN} referencing memory locations that
+do not exist. If necessary, you can get around this problem by
+specifying the ending address of the register stack with the @code{set
+rstack_high_address} command. The argument should be an address, which
+you will probably want to precede with @samp{0x} to specify in
+hexadecimal.
@item show rstack_high_address
@kindex show rstack_high_address
-@cindex AMD 29K
-Display the current limit of the register stack.
-_fi__(_AMD29K__)
+Display the current limit of the register stack, on AMD 29000 family
+processors.
+@end table
+@end ifset
-@node Floating Point Hardware, , Registers, Data
-@section Floating Point Hardware
+@ifclear HAVE-FLOAT
+@node Floating Point Hardware
+@section Floating point hardware
@cindex floating point
-Depending on the host machine architecture, _GDBN__ may be able to give
+@c FIXME! Really host, not target?
+Depending on the host machine architecture, @value{GDBN} may be able to give
you more information about the status of the floating point hardware.
@table @code
@item info float
@kindex info float
-If available, provides hardware-dependent information about the floating
+Display hardware-dependent information about the floating
point unit. The exact contents and layout vary depending on the
-floating point chip.
+floating point chip; on some platforms, @samp{info float} is not
+available at all.
@end table
@c FIXME: this is a cop-out. Try to get examples, explanations. Only
@c FIXME...supported currently on arm's and 386's. Mark properly with
@c FIXME... m4 macros to isolate general statements from hardware-dep,
@c FIXME... at that point.
+@end ifclear
-@node Languages, Symbols, Data, Top
-@chapter Using _GDBN__ with Different Languages
+@ifclear CONLY
+@node Languages
+@chapter Using @value{GDBN} with Different Languages
@cindex languages
+@ifset MOD2
Although programming languages generally have common aspects, they are
rarely expressed in the same manner. For instance, in ANSI C,
dereferencing a pointer @code{p} is accomplished by @code{*p}, but in
Modula-2, it is accomplished by @code{p^}. Values can also be
represented (and displayed) differently. Hex numbers in C are written
like @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}.
+@end ifset
@cindex working language
-Language-specific information is built into _GDBN__ for some languages,
+Language-specific information is built into @value{GDBN} for some languages,
allowing you to express operations like the above in your program's
-native language, and allowing _GDBN__ to output values in a manner
+native language, and allowing @value{GDBN} to output values in a manner
consistent with the syntax of your program's native language. The
language you use to build expressions, called the @dfn{working
-language}, can be selected manually, or _GDBN__ can set it
+language}, can be selected manually, or @value{GDBN} can set it
automatically.
@menu
* Setting:: Switching between source languages
* Show:: Displaying the language
-* Checks:: Type and Range checks
+@ifset MOD2
+* Checks:: Type and range checks
+@end ifset
+
* Support:: Supported languages
@end menu
-@node Setting, Show, Languages, Languages
+@node Setting
@section Switching between source languages
-There are two ways to control the working language---either have _GDBN__
+There are two ways to control the working language---either have @value{GDBN}
set it automatically, or select it manually yourself. You can use the
-@code{set language} command for either purpose. On startup, _GDBN__
+@code{set language} command for either purpose. On startup, @value{GDBN}
defaults to setting the language automatically.
@menu
* Manually:: Setting the working language manually
-* Automatically:: Having _GDBN__ infer the source language
+* Automatically:: Having @value{GDBN} infer the source language
@end menu
-@node Manually, Automatically, Setting, Setting
+@node Manually
@subsection Setting the working language
+If you allow @value{GDBN} to set the language automatically,
+expressions are interpreted the same way in your debugging session and
+your program.
+
@kindex set language
-To set the language, issue the command @samp{set language @var{lang}},
-where @var{lang} is the name of a language: @code{c} or @code{modula-2}.
+If you wish, you may set the language manually. To do this, issue the
+command @samp{set language @var{lang}}, where @var{lang} is the name of
+a language, such as
+@ifclear MOD2
+@code{c}.
+@end ifclear
+@ifset MOD2
+@code{c} or @code{modula-2}.
+@end ifset
For a list of the supported languages, type @samp{set language}.
+@c FIXME: rms: eventually this command should be "help set language".
-Setting the language manually prevents _GDBN__ from updating the working
+@ifset MOD2
+Setting the language manually prevents @value{GDBN} from updating the working
language automatically. This can lead to confusion if you try
to debug a program when the working language is not the same as the
source language, when an expression is acceptable to both
languages---but means different things. For instance, if the current
-source file were written in C, and _GDBN__ was parsing Modula-2, a
+source file were written in C, and @value{GDBN} was parsing Modula-2, a
command such as:
@example
@code{b} and @code{c} and place the result in @code{a}. The result
printed would be the value of @code{a}. In Modula-2, this means to compare
@code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value.
+@end ifset
-If you allow _GDBN__ to set the language automatically, then
-you can count on expressions evaluating the same way in your debugging
-session and in your program.
-
-@node Automatically, , Manually, Setting
-@subsection Having _GDBN__ infer the source language
+@node Automatically
+@subsection Having @value{GDBN} infer the source language
-To have _GDBN__ set the working language automatically, use @samp{set
-language local} or @samp{set language auto}. _GDBN__ then infers the
+To have @value{GDBN} set the working language automatically, use @samp{set
+language local} or @samp{set language auto}. @value{GDBN} then infers the
language that a program was written in by looking at the name of its
source files, and examining their extensions:
@table @file
+@ifset MOD2
@item *.mod
Modula-2 source file
+@end ifset
@item *.c
+C source file
+
+@item *.C
@itemx *.cc
-C or C++ source file.
+C++ source file
@end table
This information is recorded for each function or procedure in a source
file. When your program stops in a frame (usually by encountering a
-breakpoint), _GDBN__ sets the working language to the language recorded
+breakpoint), @value{GDBN} sets the working language to the language recorded
for the function in that frame. If the language for a frame is unknown
(that is, if the function or block corresponding to the frame was
defined in a source file that does not have a recognized extension), the
-current working language is not changed, and _GDBN__ issues a warning.
+current working language is not changed, and @value{GDBN} issues a warning.
This may not seem necessary for most programs, which are written
entirely in one source language. However, program modules and libraries
a different source language. Using @samp{set language auto} in this
case frees you from having to set the working language manually.
-@node Show, Checks, Setting, Languages
+@node Show
@section Displaying the language
The following commands will help you find out which language is the
@item info frame
Among the other information listed here (@pxref{Frame Info, ,Information
-about a Frame}) is the source language for this frame. This is the
+about a frame}) is the source language for this frame. This is the
language that will become the working language if you ever use an
identifier that is in this frame.
Symbol Table}) is the source language of this source file.
@end table
-@node Checks, Support, Show, Languages
-@section Type and range Checking
+@ifset MOD2
+@node Checks
+@section Type and range checking
@quotation
-@emph{Warning:} In this release, the _GDBN__ commands for type and range
+@emph{Warning:} In this release, the @value{GDBN} commands for type and range
checking are included, but they do not yet have any effect. This
section documents the intended facilities.
@end quotation
by eliminating type mismatches, and providing active checks for range
errors when your program is running.
-_GDBN__ can check for conditions like the above if you wish.
-Although _GDBN__ will not check the statements in your program, it
-can check expressions entered directly into _GDBN__ for evaluation via
+@value{GDBN} can check for conditions like the above if you wish.
+Although @value{GDBN} will not check the statements in your program, it
+can check expressions entered directly into @value{GDBN} for evaluation via
the @code{print} command, for example. As with the working language,
-_GDBN__ can also decide whether or not to check automatically based on
-your program's source language. @xref{Support, ,Supported Languages},
+@value{GDBN} can also decide whether or not to check automatically based on
+your program's source language. @xref{Support, ,Supported languages},
for the default settings of supported languages.
@menu
@cindex type checking
@cindex checks, type
-@node Type Checking, Range Checking, Checks, Checks
+@node Type Checking
@subsection An overview of type checking
Some languages, such as Modula-2, are strongly typed, meaning that the
The second example fails because the @code{CARDINAL} 1 is not
type-compatible with the @code{REAL} 2.3.
-For expressions you use in _GDBN__ commands, you can tell the _GDBN__
+For expressions you use in @value{GDBN} commands, you can tell the @value{GDBN}
type checker to skip checking; to treat any mismatches as errors and
abandon the expression; or only issue warnings when type mismatches
occur, but evaluate the expression anyway. When you choose the last of
-these, _GDBN__ evaluates expressions like the second example above, but
+these, @value{GDBN} evaluates expressions like the second example above, but
also issues a warning.
Even though you may turn type checking off, other type-based reasons may
-prevent _GDBN__ from evaluating an expression. For instance, _GDBN__ does not
+prevent @value{GDBN} from evaluating an expression. For instance, @value{GDBN} does not
know how to add an @code{int} and a @code{struct foo}. These particular
type errors have nothing to do with the language in use, and usually
arise from expressions, such as the one described above, which make
instance, both Modula-2 and C require the arguments to arithmetical
operators to be numbers. In C, enumerated types and pointers can be
represented as numbers, so that they are valid arguments to mathematical
-operators. @xref{Support, ,Supported Languages}, for further
+operators. @xref{Support, ,Supported languages}, for further
details on specific languages.
-_GDBN__ provides some additional commands for controlling the type checker:
+@value{GDBN} provides some additional commands for controlling the type checker:
@kindex set check
@kindex set check type
@table @code
@item set check type auto
Set type checking on or off based on the current working language.
-@xref{Support, ,Supported Languages}, for the default settings for
+@xref{Support, ,Supported languages}, for the default settings for
each language.
@item set check type on
@itemx set check type off
Set type checking on or off, overriding the default setting for the
current working language. Issue a warning if the setting does not
-match the language's default. If any type mismatches occur in
-evaluating an expression while typechecking is on, _GDBN__ prints a
+match the language default. If any type mismatches occur in
+evaluating an expression while typechecking is on, @value{GDBN} prints a
message and aborts evaluation of the expression.
@item set check type warn
Cause the type checker to issue warnings, but to always attempt to
evaluate the expression. Evaluating the expression may still
-be impossible for other reasons. For example, _GDBN__ cannot add
+be impossible for other reasons. For example, @value{GDBN} cannot add
numbers and structures.
@item show type
-Show the current setting of the type checker, and whether or not _GDBN__ is
+Show the current setting of the type checker, and whether or not @value{GDBN} is
setting it automatically.
@end table
@cindex range checking
@cindex checks, range
-@node Range Checking, , Type Checking, Checks
-@subsection An overview of Range Checking
+@node Range Checking
+@subsection An overview of range checking
In some languages (such as Modula-2), it is an error to exceed the
bounds of a type; this is enforced with run-time checks. Such range
computations do not overflow, or indices on an array element access do
not exceed the bounds of the array.
-For expressions you use in _GDBN__ commands, you can tell _GDBN__ to
-ignore range errors; to always treat them as errors and abandon the
-expression; or to issue warnings when a range error occurs but evaluate
-the expression anyway.
+For expressions you use in @value{GDBN} commands, you can tell
+@value{GDBN} to treat range errors in one of three ways: ignore them,
+always treat them as errors and abandon the expression, or issue
+warnings but evaluate the expression anyway.
A range error can result from numerical overflow, from exceeding an
-array index bound, or when you type in a constant that is not a member
+array index bound, or when you type a constant that is not a member
of any type. Some languages, however, do not treat overflows as an
error. In many implementations of C, mathematical overflow causes the
result to ``wrap around'' to lower values---for example, if @var{m} is
This, too, is specific to individual languages, and in some cases
specific to individual compilers or machines. @xref{Support, ,
-Supported Languages}, for further details on specific languages.
+Supported languages}, for further details on specific languages.
-_GDBN__ provides some additional commands for controlling the range checker:
+@value{GDBN} provides some additional commands for controlling the range checker:
@kindex set check
@kindex set check range
@table @code
@item set check range auto
Set range checking on or off based on the current working language.
-@xref{Support, ,Supported Languages}, for the default settings for
+@xref{Support, ,Supported languages}, for the default settings for
each language.
@item set check range on
@itemx set check range off
Set range checking on or off, overriding the default setting for the
current working language. A warning is issued if the setting does not
-match the language's default. If a range error occurs, then a message
+match the language default. If a range error occurs, then a message
is printed and evaluation of the expression is aborted.
@item set check range warn
-Output messages when the _GDBN__ range checker detects a range error,
+Output messages when the @value{GDBN} range checker detects a range error,
but attempt to evaluate the expression anyway. Evaluating the
expression may still be impossible for other reasons, such as accessing
-memory that the process does not own (a typical example from many UNIX
+memory that the process does not own (a typical example from many Unix
systems).
@item show range
Show the current setting of the range checker, and whether or not it is
-being set automatically by _GDBN__.
+being set automatically by @value{GDBN}.
@end table
-
-@node Support, , Checks, Languages
-@section Supported Languages
-
-_GDBN__ 4 supports C, C++, and Modula-2. The syntax for C and C++ is so
-closely related that _GDBN__ does not distinguish the two. Some _GDBN__
-features may be used in expressions regardless of the language you
-use: the _GDBN__ @code{@@} and @code{::} operators, and the
-@samp{@{type@}addr} construct (@pxref{Expressions, ,Expressions}) can be
-used with the constructs of any of the supported languages.
-
-The following sections detail to what degree each of these
-source languages is supported by _GDBN__. These sections are
-not meant to be language tutorials or references, but serve only as a
-reference guide to what the _GDBN__ expression parser will accept, and
-what input and output formats should look like for different languages.
-There are many good books written on each of these languages; please
-look to these for a language reference or tutorial.
-
+@end ifset
+
+@node Support
+@section Supported languages
+
+@ifset MOD2
+@value{GDBN} 4 supports C, C++, and Modula-2.
+@end ifset
+@ifclear MOD2
+@value{GDBN} 4 supports C, and C++.
+@end ifclear
+Some @value{GDBN} features may be used in expressions regardless of the
+language you use: the @value{GDBN} @code{@@} and @code{::} operators,
+and the @samp{@{type@}addr} construct (@pxref{Expressions,
+,Expressions}) can be used with the constructs of any supported
+language.
+
+The following sections detail to what degree each source language is
+supported by @value{GDBN}. These sections are not meant to be language
+tutorials or references, but serve only as a reference guide to what the
+@value{GDBN} expression parser will accept, and what input and output
+formats should look like for different languages. There are many good
+books written on each of these languages; please look to these for a
+language reference or tutorial.
+
+@ifset MOD2
@menu
* C:: C and C++
* Modula-2:: Modula-2
@end menu
-@node C, Modula-2, Support, Support
+@node C
@subsection C and C++
@cindex C and C++
-
@cindex expressions in C or C++
-Since C and C++ are so closely related, _GDBN__ does not distinguish
-between them when interpreting the expressions recognized in _GDBN__
-commands.
+
+Since C and C++ are so closely related, many features of @value{GDBN} apply
+to both languages. Whenever this is the case, we discuss both languages
+together.
+@end ifset
+@ifclear MOD2
+@c Cancel this below, under same condition, at end of this chapter!
+@raisesections
+@end ifclear
@cindex C++
@kindex g++
@cindex GNU C++
The C++ debugging facilities are jointly implemented by the GNU C++
-compiler and _GDBN__. Therefore, to debug your C++ code effectively,
-you must compile your C++ programs with the GNU C++ compiler,
-@code{g++}.
+compiler and @value{GDBN}. Therefore, to debug your C++ code
+effectively, you must compile your C++ programs with the GNU C++
+compiler, @code{g++}.
+
+For best results when debugging C++ programs, use the stabs debugging
+format. You can select that format explicitly with the @code{g++}
+command-line options @samp{-gstabs} or @samp{-gstabs+}. See
+@ref{Debugging Options,,Options for Debugging Your Program or GNU CC,
+gcc.info, Using GNU CC}, for more information.
+@end ifclear
+@ifset CONLY
+@node C
+@chapter C Language Support
+@cindex C language
+@cindex expressions in C
+
+Information specific to the C language is built into @value{GDBN} so that you
+can use C expressions while degugging. This also permits @value{GDBN} to
+output values in a manner consistent with C conventions.
@menu
-* C Operators:: C and C++ Operators
-* C Constants:: C and C++ Constants
-* Cplusplus expressions:: C++ Expressions
+* C Operators:: C operators
+* C Constants:: C constants
+* Debugging C:: @value{GDBN} and C
+@end menu
+@end ifset
+@ifclear CONLY
+@menu
+* C Operators:: C and C++ operators
+* C Constants:: C and C++ constants
+* Cplus expressions:: C++ expressions
* C Defaults:: Default settings for C and C++
-* C Checks:: C and C++ Type and Range Checks
-* Debugging C:: _GDBN__ and C
+@ifset MOD2
+* C Checks:: C and C++ type and range checks
+@end ifset
+
+* Debugging C:: @value{GDBN} and C
* Debugging C plus plus:: Special features for C++
@end menu
+@end ifclear
+@ifclear CONLY
@cindex C and C++ operators
-@node C Operators, C Constants, C, C
-@subsubsection C and C++ Operators
+@node C Operators
+@subsubsection C and C++ operators
+@end ifclear
+@ifset CONLY
+@cindex C operators
+@node C Operators
+@section C operators
+@end ifset
Operators must be defined on values of specific types. For instance,
@code{+} is defined on numbers, but not on structures. Operators are
-often defined on groups of types. For the purposes of C and C++, the
-following definitions hold:
+often defined on groups of types.
+
+@ifclear CONLY
+For the purposes of C and C++, the following definitions hold:
+@end ifclear
@itemize @bullet
@item
@emph{Integral types} include @code{int} with any of its storage-class
-specifiers, @code{char}, and @code{enum}s.
+specifiers; @code{char}; and @code{enum}.
@item
@emph{Floating-point types} include @code{float} and @code{double}.
in order of increasing precedence:
@table @code
-_0__@item ,
+@item ,
The comma or sequencing operator. Expressions in a comma-separated list
are evaluated from left to right, with the result of the entire
expression being the last expression evaluated.
left shift, and right shift. Defined on integral types.
@item @@
-The _GDBN__ ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
+The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
@item +@r{, }-
Addition and subtraction. Defined on integral types, floating-point types and
@item &
Address operator. Defined on variables. Same precedence as @code{++}.
-For debugging C++, _GDBN__ implements a use of @samp{&} beyond what's
+@ifclear CONLY
+For debugging C++, @value{GDBN} implements a use of @samp{&} beyond what is
allowed in the C++ language itself: you can use @samp{&(&@var{ref})}
-(or, if you prefer, simply @samp{&&@var{ref}} to examine the address
+(or, if you prefer, simply @samp{&&@var{ref}}) to examine the address
where a C++ reference variable (declared with @samp{&@var{ref}}) is
stored.
+@end ifclear
@item -
Negative. Defined on integral and floating-point types. Same
Bitwise complement operator. Defined on integral types. Same precedence as
@code{++}.
+
@item .@r{, }->
Structure member, and pointer-to-structure member. For convenience,
-_GDBN__ regards the two as equivalent, choosing whether to dereference a
+@value{GDBN} regards the two as equivalent, choosing whether to dereference a
pointer based on the stored type information.
-Defined on @code{struct}s and @code{union}s.
+Defined on @code{struct} and @code{union} data.
@item []
Array indexing. @code{@var{a}[@var{i}]} is defined as
@item ()
Function parameter list. Same precedence as @code{->}.
+@ifclear CONLY
@item ::
C++ scope resolution operator. Defined on
@code{struct}, @code{union}, and @code{class} types.
+@end ifclear
@item ::
-The _GDBN__ scope operator (@pxref{Expressions, ,Expressions}). Same precedence as
-@code{::}, above._1__
+Doubled colons
+@ifclear CONLY
+also
+@end ifclear
+represent the @value{GDBN} scope operator (@pxref{Expressions,
+,Expressions}).
+@ifclear CONLY
+Same precedence as @code{::}, above.
+@end ifclear
@end table
+@ifclear CONLY
@cindex C and C++ constants
-@node C Constants, Cplusplus expressions, C Operators, C
-@subsubsection C and C++ Constants
+@node C Constants
+@subsubsection C and C++ constants
+
+@value{GDBN} allows you to express the constants of C and C++ in the
+following ways:
+@end ifclear
+@ifset CONLY
+@cindex C constants
+@node C Constants
+@section C constants
-_GDBN__ allows you to express the constants of C and C++ in the
+@value{GDBN} allows you to express the constants of C in the
following ways:
+@end ifset
@itemize @bullet
@item
by double quotes (@code{"}).
@item
-Pointer constants are an integral value.
+Pointer constants are an integral value. You can also write pointers
+to constants using the C operator @samp{&}.
+
+@item
+Array constants are comma-separated lists surrounded by braces @samp{@{}
+and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of
+integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array,
+and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers.
@end itemize
-@node Cplusplus expressions, C Defaults, C Constants, C
-@subsubsection C++ Expressions
+@ifclear CONLY
+@node Cplus expressions
+@subsubsection C++ expressions
@cindex expressions in C++
-_GDBN__'s expression handling has the following extensions to
-interpret a significant subset of C++ expressions:
+@value{GDBN} expression handling has a number of extensions to
+interpret a significant subset of C++ expressions.
+
+@cindex C++ support, not in @sc{coff}
+@cindex @sc{coff} versus C++
+@cindex C++ and object formats
+@cindex object formats and C++
+@cindex a.out and C++
+@cindex @sc{ecoff} and C++
+@cindex @sc{xcoff} and C++
+@cindex @sc{elf}/stabs and C++
+@cindex @sc{elf}/@sc{dwarf} and C++
+@quotation
+@emph{Warning:} Most of these extensions depend on the use of additional
+debugging information in the symbol table, and thus require a rich,
+extendable object code format. In particular, if your system uses
+a.out, MIPS @sc{ecoff}, RS/6000 @sc{xcoff}, or Sun @sc{elf} with stabs
+extensions to the symbol table, these facilities are all available.
+Where the object code format is standard @sc{coff}, on the other hand,
+most of the C++ support in @value{GDBN} will @emph{not} work, nor can it.
+For the standard SVr4 debugging format, @sc{dwarf} in @sc{elf}, the
+standard is still evolving, so the C++ support in @value{GDBN} is still
+fragile; when this debugging format stabilizes, however, C++ support
+will also be available on systems that use it.
+@end quotation
@enumerate
@item
While a member function is active (in the selected stack frame), your
expressions have the same namespace available as the member function;
-that is, _GDBN__ allows implicit references to the class instance
+that is, @value{GDBN} allows implicit references to the class instance
pointer @code{this} following the same rules as C++.
@cindex call overloaded functions
@cindex type conversions in C++
@item
-You can call overloaded functions; _GDBN__ will resolve the function
+You can call overloaded functions; @value{GDBN} will resolve the function
call to the right definition, with one restriction---you must use
arguments of the type required by the function that you want to call.
-_GDBN__ will not perform conversions requiring constructors or
+@value{GDBN} will not perform conversions requiring constructors or
user-defined type operators.
@cindex reference declarations
@item
-_GDBN__ understands variables declared as C++ references; you can use them in
+@value{GDBN} understands variables declared as C++ references; you can use them in
expressions just as you do in C++ source---they are automatically
dereferenced.
-In the parameter list shown when _GDBN__ displays a frame, the values of
+In the parameter list shown when @value{GDBN} displays a frame, the values of
reference variables are not displayed (unlike other variables); this
avoids clutter, since references are often used for large structures.
The @emph{address} of a reference variable is always shown, unless
you have specified @samp{set print address off}.
@item
-_GDBN__ supports the C++ name resolution operator @code{::}---your
+@value{GDBN} supports the C++ name resolution operator @code{::}---your
expressions can use it just as expressions in your program do. Since
one scope may be defined in another, you can use @code{::} repeatedly if
necessary, for example in an expression like
-@samp{@var{scope1}::@var{scope2}::@var{name}}. _GDBN__ also allows
+@samp{@var{scope1}::@var{scope2}::@var{name}}. @value{GDBN} also allows
resolving name scope by reference to source files, in both C and C++
-debugging (@pxref{Variables, ,Program Variables}).
+debugging (@pxref{Variables, ,Program variables}).
@end enumerate
-@node C Defaults, C Checks, Cplusplus expressions, C
-@subsubsection C and C++ Defaults
+@node C Defaults
+@subsubsection C and C++ defaults
@cindex C and C++ defaults
-If you allow _GDBN__ to set type and range checking automatically, they
+If you allow @value{GDBN} to set type and range checking automatically, they
both default to @code{off} whenever the working language changes to
-C/C++. This happens regardless of whether you, or _GDBN__,
+C or C++. This happens regardless of whether you, or @value{GDBN},
selected the working language.
-If you allow _GDBN__ to set the language automatically, it sets the
-working language to C/C++ on entering code compiled from a source file
-whose name ends with @file{.c} or @file{.cc}.
-@xref{Automatically, ,Having _GDBN__ infer the source language}, for
+If you allow @value{GDBN} to set the language automatically, it sets the
+working language to C or C++ on entering code compiled from a source file
+whose name ends with @file{.c}, @file{.C}, or @file{.cc}.
+@xref{Automatically, ,Having @value{GDBN} infer the source language}, for
further details.
-@node C Checks, Debugging C, C Defaults, C
-@subsubsection C and C++ Type and Range Checks
+@ifset MOD2
+@c Type checking is (a) primarily motivated by Modula-2, and (b)
+@c unimplemented. If (b) changes, it might make sense to let this node
+@c appear even if Mod-2 does not, but meanwhile ignore it. pesch 16jul93.
+@node C Checks
+@subsubsection C and C++ type and range checks
@cindex C and C++ checks
-@quotation
-@emph{Warning:} in this release, _GDBN__ does not yet perform type or
-range checking.
-@end quotation
-@c FIXME remove warning when type/range checks added
-
-By default, when _GDBN__ parses C or C++ expressions, type checking
-is not used. However, if you turn type checking on, _GDBN__ will
+By default, when @value{GDBN} parses C or C++ expressions, type checking
+is not used. However, if you turn type checking on, @value{GDBN} will
consider two variables type equivalent if:
@itemize @bullet
Range checking, if turned on, is done on mathematical operations. Array
indices are not checked, since they are often used to index a pointer
that is not itself an array.
-
-@node Debugging C, Debugging C plus plus, C Checks, C
-@subsubsection _GDBN__ and C
+@end ifset
+@end ifclear
+
+@ifclear CONLY
+@node Debugging C
+@subsubsection @value{GDBN} and C
+@end ifclear
+@ifset CONLY
+@node Debugging C
+@section @value{GDBN} and C
+@end ifset
The @code{set print union} and @code{show print union} commands apply to
the @code{union} type. When set to @samp{on}, any @code{union} that is
-inside a @code{struct} or @code{class} will also be printed.
+inside a @code{struct}
+@ifclear CONLY
+or @code{class}
+@end ifclear
+will also be printed.
Otherwise, it will appear as @samp{@{...@}}.
The @code{@@} operator aids in the debugging of dynamic arrays, formed
-with pointers and a memory allocation function. (@pxref{Expressions, ,Expressions})
+with pointers and a memory allocation function. @xref{Expressions,
+,Expressions}.
-@node Debugging C plus plus, , Debugging C, C
-@subsubsection _GDBN__ Commands for C++
+@ifclear CONLY
+@node Debugging C plus plus
+@subsubsection @value{GDBN} features for C++
@cindex commands for C++
-Some _GDBN__ commands are particularly useful with C++, and some are
+Some @value{GDBN} commands are particularly useful with C++, and some are
designed specifically for use with C++. Here is a summary:
@table @code
@cindex break in overloaded functions
@item @r{breakpoint menus}
When you want a breakpoint in a function whose name is overloaded,
-_GDBN__'s breakpoint menus help you specify which function definition
-you want. @xref{Breakpoint Menus}.
+@value{GDBN} breakpoint menus help you specify which function definition
+you want. @xref{Breakpoint Menus,,Breakpoint menus}.
@cindex overloading in C++
@item rbreak @var{regex}
Setting breakpoints using regular expressions is helpful for setting
breakpoints on overloaded functions that are not members of any special
classes.
-@xref{Set Breaks, ,Setting Breakpoints}.
+@xref{Set Breaks, ,Setting breakpoints}.
@cindex C++ exception handling
@item catch @var{exceptions}
@itemx info catch
Debug C++ exception handling using these commands. @xref{Exception
-Handling, ,Breakpoints and Exceptions}.
+Handling, ,Breakpoints and exceptions}.
@cindex inheritance
@item ptype @var{typename}
@itemx show print asm-demangle
Control whether C++ symbols display in their source form, both when
displaying code as C++ source and when displaying disassemblies.
-@xref{Print Settings, ,Print Settings}.
+@xref{Print Settings, ,Print settings}.
@item set print object
@itemx show print object
Choose whether to print derived (actual) or declared types of objects.
-@xref{Print Settings, ,Print Settings}.
+@xref{Print Settings, ,Print settings}.
@item set print vtbl
@itemx show print vtbl
Control the format for printing virtual function tables.
-@xref{Print Settings, ,Print Settings}.
+@xref{Print Settings, ,Print settings}.
+
+@item @r{Overloaded symbol names}
+You can specify a particular definition of an overloaded symbol, using
+the same notation that is used to declare such symbols in C++: type
+@code{@var{symbol}(@var{types})} rather than just @var{symbol}. You can
+also use the @value{GDBN} command-line word completion facilities to list the
+available choices, or to finish the type list for you.
+@xref{Completion,, Command completion}, for details on how to do this.
@end table
+@ifclear MOD2
+@c cancels "raisesections" under same conditions near bgn of chapter
+@lowersections
+@end ifclear
-@node Modula-2, , C, Support
+@ifset MOD2
+@node Modula-2
@subsection Modula-2
@cindex Modula-2
-The extensions made to _GDBN__ to support Modula-2 support output
-from the GNU Modula-2 compiler (which is currently being developed).
-Other Modula-2 compilers are not currently supported, and attempting to
-debug executables produced by them will most likely result in an error
-as _GDBN__ reads in the executable's symbol table.
+The extensions made to @value{GDBN} to support Modula-2 only support
+output from the GNU Modula-2 compiler (which is currently being
+developed). Other Modula-2 compilers are not currently supported, and
+attempting to debug executables produced by them will most likely
+result in an error as @value{GDBN} reads in the executable's symbol
+table.
@cindex expressions in Modula-2
@menu
* M2 Operators:: Built-in operators
-* Built-In Func/Proc:: Built-in Functions and Procedures
-* M2 Constants:: Modula-2 Constants
+* Built-In Func/Proc:: Built-in functions and procedures
+* M2 Constants:: Modula-2 constants
* M2 Defaults:: Default settings for Modula-2
* Deviations:: Deviations from standard Modula-2
-* M2 Checks:: Modula-2 Type and Range Checks
+* M2 Checks:: Modula-2 type and range checks
* M2 Scope:: The scope operators @code{::} and @code{.}
-* GDB/M2:: _GDBN__ and Modula-2
+* GDB/M2:: @value{GDBN} and Modula-2
@end menu
-@node M2 Operators, Built-In Func/Proc, Modula-2, Modula-2
+@node M2 Operators
@subsubsection Operators
@cindex Modula-2 operators
@emph{Scalar types} consist of all of the above.
@item
-@emph{Set types} consist of @code{SET}s and @code{BITSET}s.
+@emph{Set types} consist of @code{SET} and @code{BITSET} types.
@item
@emph{Boolean types} consist of @code{BOOLEAN}.
@table @code
@item ,
Function argument or array index separator.
-_0__
+
@item :=
Assignment. The value of @var{var} @code{:=} @var{value} is
@var{value}.
@item =@r{, }<>@r{, }#
Equality and two ways of expressing inequality, valid on scalar types.
-Same precedence as @code{<}. In _GDBN__ scripts, only @code{<>} is
+Same precedence as @code{<}. In @value{GDBN} scripts, only @code{<>} is
available for inequality, since @code{#} conflicts with the script
comment character.
Boolean conjuction. Defined on boolean types.
@item @@
-The _GDBN__ ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
+The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
@item +@r{, }-
Addition and subtraction on integral and floating-point types, or union
precedence as @code{*}.
@item -
-Negative. Defined on @code{INTEGER}s and @code{REAL}s.
+Negative. Defined on @code{INTEGER} and @code{REAL} data.
@item ^
Pointer dereferencing. Defined on pointer types.
@code{^}.
@item .
-@code{RECORD} field selector. Defined on @code{RECORD}s. Same
+@code{RECORD} field selector. Defined on @code{RECORD} data. Same
precedence as @code{^}.
@item []
-Array indexing. Defined on @code{ARRAY}s. Same precedence as @code{^}.
+Array indexing. Defined on @code{ARRAY} data. Same precedence as @code{^}.
@item ()
-Procedure argument list. Defined on @code{PROCEDURE}s. Same precedence
+Procedure argument list. Defined on @code{PROCEDURE} objects. Same precedence
as @code{^}.
@item ::@r{, }.
-_GDBN__ and Modula-2 scope operators.
+@value{GDBN} and Modula-2 scope operators.
@end table
@quotation
-@emph{Warning:} Sets and their operations are not yet supported, so _GDBN__
+@emph{Warning:} Sets and their operations are not yet supported, so @value{GDBN}
will treat the use of the operator @code{IN}, or the use of operators
@code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#},
@code{<=}, and @code{>=} on sets as an error.
@end quotation
-_1__
+
@cindex Modula-2 built-ins
-@node Built-In Func/Proc, M2 Constants, M2 Operators, Modula-2
-@subsubsection Built-in Functions and Procedures
+@node Built-In Func/Proc
+@subsubsection Built-in functions and procedures
Modula-2 also makes available several built-in procedures and functions.
In describing these, the following metavariables are used:
@item m
represents an identifier that belongs to a set. Generally used in the
same function with the metavariable @var{s}. The type of @var{s} should
-be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}.
+be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}).
@item n
represents a variable or constant of integral or floating-point type.
@quotation
@emph{Warning:} Sets and their operations are not yet supported, so
-_GDBN__ will treat the use of procedures @code{INCL} and @code{EXCL} as
+@value{GDBN} will treat the use of procedures @code{INCL} and @code{EXCL} as
an error.
@end quotation
@cindex Modula-2 constants
-@node M2 Constants, M2 Defaults, Built-In Func/Proc, Modula-2
+@node M2 Constants
@subsubsection Constants
-_GDBN__ allows you to express the constants of Modula-2 in the following
+@value{GDBN} allows you to express the constants of Modula-2 in the following
ways:
@itemize @bullet
String constants consist of a sequence of characters enclosed by a
pair of like quotes, either single (@code{'}) or double (@code{"}).
Escape sequences in the style of C are also allowed. @xref{C
-Constants, ,C and C++ Constants}, for a brief explanation of escape
+Constants, ,C and C++ constants}, for a brief explanation of escape
sequences.
@item
Set constants are not yet supported.
@end itemize
-@node M2 Defaults, Deviations, M2 Constants, Modula-2
-@subsubsection Modula-2 Defaults
+@node M2 Defaults
+@subsubsection Modula-2 defaults
@cindex Modula-2 defaults
-If type and range checking are set automatically by _GDBN__, they
+If type and range checking are set automatically by @value{GDBN}, they
both default to @code{on} whenever the working language changes to
-Modula-2. This happens regardless of whether you, or _GDBN__,
+Modula-2. This happens regardless of whether you, or @value{GDBN},
selected the working language.
-If you allow _GDBN__ to set the language automatically, then entering
+If you allow @value{GDBN} to set the language automatically, then entering
code compiled from a file whose name ends with @file{.mod} will set the
-working language to Modula-2. @xref{Automatically, ,Having _GDBN__ set
+working language to Modula-2. @xref{Automatically, ,Having @value{GDBN} set
the language automatically}, for further details.
-@node Deviations, M2 Checks, M2 Defaults, Modula-2
-@subsubsection Deviations from Standard Modula-2
+@node Deviations
+@subsubsection Deviations from standard Modula-2
@cindex Modula-2, deviations from
A few changes have been made to make Modula-2 programs easier to debug.
@item
C escape sequences can be used in strings and characters to represent
-non-printable characters. _GDBN__ will print out strings with these
+non-printable characters. @value{GDBN} will print out strings with these
escape sequences embedded. Single non-printable characters are
printed using the @samp{CHR(@var{nnn})} format.
All built-in procedures both modify @emph{and} return their argument.
@end itemize
-@node M2 Checks, M2 Scope, Deviations, Modula-2
-@subsubsection Modula-2 Type and Range Checks
+@node M2 Checks
+@subsubsection Modula-2 type and range checks
@cindex Modula-2 checks
@quotation
-@emph{Warning:} in this release, _GDBN__ does not yet perform type or
+@emph{Warning:} in this release, @value{GDBN} does not yet perform type or
range checking.
@end quotation
@c FIXME remove warning when type/range checks added
-_GDBN__ considers two Modula-2 variables type equivalent if:
+@value{GDBN} considers two Modula-2 variables type equivalent if:
@itemize @bullet
@item
Range checking is done on all mathematical operations, assignment, array
index bounds, and all built-in functions and procedures.
-@node M2 Scope, GDB/M2, M2 Checks, Modula-2
+@node M2 Scope
@subsubsection The scope operators @code{::} and @code{.}
@cindex scope
@kindex .
@cindex colon, doubled as scope operator
@ifinfo
@kindex colon-colon
-@c Info cannot handoe :: but TeX can.
+@c Info cannot handle :: but TeX can.
@end ifinfo
@iftex
@kindex ::
@end iftex
There are a few subtle differences between the Modula-2 scope operator
-(@code{.}) and the _GDBN__ scope operator (@code{::}). The two have
+(@code{.}) and the @value{GDBN} scope operator (@code{::}). The two have
similar syntax:
@example
@var{module} the name of a module, and @var{id} is any declared
identifier within your program, except another module.
-Using the @code{::} operator makes _GDBN__ search the scope
+Using the @code{::} operator makes @value{GDBN} search the scope
specified by @var{scope} for the identifier @var{id}. If it is not
-found in the specified scope, then _GDBN__ will search all scopes
+found in the specified scope, then @value{GDBN} will search all scopes
enclosing the one specified by @var{scope}.
-Using the @code{.} operator makes _GDBN__ search the current scope for
+Using the @code{.} operator makes @value{GDBN} search the current scope for
the identifier specified by @var{id} that was imported from the
definition module specified by @var{module}. With this operator, it is
an error if the identifier @var{id} was not imported from definition
module @var{module}, or if @var{id} is not an identifier in
@var{module}.
-@node GDB/M2, , M2 Scope, Modula-2
-@subsubsection _GDBN__ and Modula-2
+@node GDB/M2
+@subsubsection @value{GDBN} and Modula-2
-Some _GDBN__ commands have little use when debugging Modula-2 programs.
+Some @value{GDBN} commands have little use when debugging Modula-2 programs.
Five subcommands of @code{set print} and @code{show print} apply
specifically to C and C++: @samp{vtbl}, @samp{demangle},
@samp{asm-demangle}, @samp{object}, and @samp{union}. The first four
-apply to C++, and the last to C's @code{union} type, which has no direct
+apply to C++, and the last to the C @code{union} type, which has no direct
analogue in Modula-2.
The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available
created in Modula-2 as they can in C or C++. However, because an
address can be specified by an integral constant, the construct
@samp{@{@var{type}@}@var{adrexp}} is still useful. (@pxref{Expressions, ,Expressions})
-_0__
+
@cindex @code{#} in Modula-2
-In _GDBN__ scripts, the Modula-2 inequality operator @code{#} is
+In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is
interpreted as the beginning of a comment. Use @code{<>} instead.
-_1__
-@node Symbols, Altering, Languages, Top
+
+@end ifset
+@end ifclear
+
+@node Symbols
@chapter Examining the Symbol Table
The commands described in this section allow you to inquire about the
symbols (names of variables, functions and types) defined in your
program. This information is inherent in the text of your program and
-does not change as your program executes. _GDBN__ finds it in your
-program's symbol table, in the file indicated when you started _GDBN__
-(@pxref{File Options, ,Choosing Files}), or by one of the
-file-management commands (@pxref{Files, ,Commands to Specify Files}).
+does not change as your program executes. @value{GDBN} finds it in your
+program's symbol table, in the file indicated when you started @value{GDBN}
+(@pxref{File Options, ,Choosing files}), or by one of the
+file-management commands (@pxref{Files, ,Commands to specify files}).
+
+@c FIXME! This might be intentionally specific to C and C++; if so, move
+@c to someplace in C section of lang chapter.
+@cindex symbol names
+@cindex names of symbols
+@cindex quoting names
+Occasionally, you may need to refer to symbols that contain unusual
+characters, which @value{GDBN} ordinarily treats as word delimiters. The
+most frequent case is in referring to static variables in other
+source files (@pxref{Variables,,Program variables}). File names
+are recorded in object files as debugging symbols, but @value{GDBN} would
+ordinarily parse a typical file name, like @file{foo.c}, as the three words
+@samp{foo} @samp{.} @samp{c}. To allow @value{GDBN} to recognize
+@samp{foo.c} as a single symbol, enclose it in single quotes; for example,
+
+@example
+p 'foo.c'::x
+@end example
+
+@noindent
+looks up the value of @code{x} in the scope of the file @file{foo.c}.
@table @code
@item info address @var{symbol}
is always stored.
Note the contrast with @samp{print &@var{symbol}}, which does not work
-at all for a register variables, and for a stack local variable prints
+at all for a register variable, and for a stack local variable prints
the exact address of the current instantiation of the variable.
@item whatis @var{exp}
@kindex ptype
Print a description of data type @var{typename}. @var{typename} may be
the name of a type, or for C code it may have the form
+@ifclear CONLY
+@samp{class @var{class-name}},
+@end ifclear
@samp{struct @var{struct-tag}}, @samp{union @var{union-tag}} or
@samp{enum @var{enum-tag}}.
@itemx ptype
Print a description of the type of expression @var{exp}. @code{ptype}
differs from @code{whatis} by printing a detailed description, instead
-of just the name of the type. For example, if your program declares a
-variable as
+of just the name of the type.
+
+For example, for this variable declaration:
@example
struct complex @{double real; double imag;@} v;
@end example
@noindent
-compare the output of the two commands:
+the two commands give this output:
@example
@group
-(_GDBP__) whatis v
+(@value{GDBP}) whatis v
type = struct complex
-(_GDBP__) ptype v
+(@value{GDBP}) ptype v
type = struct complex @{
double real;
double imag;
which match the regular-expression @var{regexp}.
@end ignore
-@item printsyms @var{filename}
-@itemx printpsyms @var{filename}
-@itemx printmsyms @var{filename}
-@kindex printsyms
+@item maint print symbols @var{filename}
+@itemx maint print psymbols @var{filename}
+@itemx maint print msymbols @var{filename}
+@kindex maint print symbols
@cindex symbol dump
-@kindex printsyms
+@kindex maint print psymbols
@cindex partial symbol dump
Write a dump of debugging symbol data into the file @var{filename}.
-These commands are used to debug the _GDBN__ symbol-reading code. Only
-symbols with debugging data are included. If you use @code{printsyms},
-_GDBN__ includes all the symbols for which it has already collected full
-details: that is, @var{filename} reflects symbols for only those files
-whose symbols _GDBN__ has read. You can use the command @code{info
-sources} to find out which files these are. If you use
-@code{printpsyms} instead, the dump shows information about symbols that
-_GDBN__ only knows partially---that is, symbols defined in files that
-_GDBN__ has skimmed, but not yet read completely. Finally,
-@code{printmsyms} dumps just the minimal symbol information required for
-each object file from which _GDBN__ has read some symbols. The description of
-@code{symbol-file} explains how _GDBN__ reads symbols; both @code{info
-source} and @code{symbol-file} are described in @ref{Files, ,Commands
-to Specify Files}.
+These commands are used to debug the @value{GDBN} symbol-reading code. Only
+symbols with debugging data are included. If you use @samp{maint print
+symbols}, @value{GDBN} includes all the symbols for which it has already
+collected full details: that is, @var{filename} reflects symbols for
+only those files whose symbols @value{GDBN} has read. You can use the
+command @code{info sources} to find out which files these are. If you
+use @samp{maint print psymbols} instead, the dump shows information about
+symbols that @value{GDBN} only knows partially---that is, symbols defined in
+files that @value{GDBN} has skimmed, but not yet read completely. Finally,
+@samp{maint print msymbols} dumps just the minimal symbol information
+required for each object file from which @value{GDBN} has read some symbols.
+@xref{Files, ,Commands to specify files}, for a discussion of how
+@value{GDBN} reads symbols (in the description of @code{symbol-file}).
@end table
-@node Altering, _GDBN__ Files, Symbols, Top
+@node Altering
@chapter Altering Execution
Once you think you have found an error in your program, you might want to
find out for certain whether correcting the apparent error would lead to
correct results in the rest of the run. You can find the answer by
-experiment, using the _GDBN__ features for altering execution of the
+experiment, using the @value{GDBN} features for altering execution of the
program.
For example, you can store new values into variables or memory
-locations, give your program a signal, restart it at a different address,
-or even return prematurely from a function to its caller.
+locations,
+@ifclear BARETARGET
+give your program a signal, restart it
+@end ifclear
+@ifset BARETARGET
+restart your program
+@end ifset
+at a different address, or even return prematurely from a function to
+its caller.
@menu
-* Assignment:: Assignment to Variables
-* Jumping:: Continuing at a Different Address
-* Signaling:: Giving your program a Signal
-* Returning:: Returning from a Function
-* Calling:: Calling your Program's Functions
-* Patching:: Patching your Program
+* Assignment:: Assignment to variables
+* Jumping:: Continuing at a different address
+@ifclear BARETARGET
+* Signaling:: Giving your program a signal
+@end ifclear
+
+* Returning:: Returning from a function
+* Calling:: Calling your program's functions
+* Patching:: Patching your program
@end menu
-@node Assignment, Jumping, Altering, Altering
-@section Assignment to Variables
+@node Assignment
+@section Assignment to variables
@cindex assignment
@cindex setting variables
@noindent
stores the value 4 into the variable @code{x}, and then prints the
-value of the assignment expression (which is 4). @xref{Languages,
-,Using _GDBN__ with Different Languages}, for more information on
-operators in supported languages.
+value of the assignment expression (which is 4).
+@ifclear CONLY
+@xref{Languages, ,Using @value{GDBN} with Different Languages}, for more
+information on operators in supported languages.
+@end ifclear
@kindex set variable
@cindex variables, setting
If you are not interested in seeing the value of the assignment, use the
@code{set} command instead of the @code{print} command. @code{set} is
-really the same as @code{print} except that the expression's value is not
-printed and is not put in the value history (@pxref{Value History, ,Value History}). The
-expression is evaluated only for its effects.
+really the same as @code{print} except that the expression's value is
+not printed and is not put in the value history (@pxref{Value History,
+,Value history}). The expression is evaluated only for its effects.
If the beginning of the argument string of the @code{set} command
appears identical to a @code{set} subcommand, use the @code{set
variable} command instead of just @code{set}. This command is identical
-to @code{set} except for its lack of subcommands. For example, a
-program might well have a variable @code{width}---which leads to
-an error if we try to set a new value with just @samp{set width=13}, as
-we might if @code{set width} did not happen to be a _GDBN__ command:
+to @code{set} except for its lack of subcommands. For example, if
+your program has a variable @code{width}, you get
+an error if you try to set a new value with just @samp{set width=13},
+because @value{GDBN} has the command @code{set width}:
@example
-(_GDBP__) whatis width
+(@value{GDBP}) whatis width
type = double
-(_GDBP__) p width
+(@value{GDBP}) p width
$4 = 13
-(_GDBP__) set width=47
+(@value{GDBP}) set width=47
Invalid syntax in expression.
@end example
@noindent
-The invalid expression, of course, is @samp{=47}. What we can do in
-order to actually set our program's variable @code{width} is
+The invalid expression, of course, is @samp{=47}. In
+order to actually set the program's variable @code{width}, use
@example
-(_GDBP__) set var width=47
+(@value{GDBP}) set var width=47
@end example
-_GDBN__ allows more implicit conversions in assignments than C; you can
+@value{GDBN} allows more implicit conversions in assignments than C; you can
freely store an integer value into a pointer variable or vice versa,
-and any structure can be converted to any other structure that is the
+and you can convert any structure to any other structure that is the
same length or shorter.
@comment FIXME: how do structs align/pad in these conversions?
@comment /pesch@cygnus.com 18dec1990
@noindent
stores the value 4 into that memory location.
-@node Jumping, Signaling, Assignment, Altering
-@section Continuing at a Different Address
+@node Jumping
+@section Continuing at a different address
Ordinarily, when you continue your program, you do so at the place where
it stopped, with the @code{continue} command. You can instead continue at
@kindex jump
Resume execution at line @var{linespec}. Execution will stop
immediately if there is a breakpoint there. @xref{List, ,Printing
-Source Lines}, for a description of the different forms of
+source lines}, for a description of the different forms of
@var{linespec}.
The @code{jump} command does not change the current stack frame, or
@noindent
causes the next @code{continue} command or stepping command to execute at
address @code{0x485}, rather than at the address where your program stopped.
-@xref{Continuing and Stepping, ,Continuing and Stepping}.
+@xref{Continuing and Stepping, ,Continuing and stepping}.
The most common occasion to use the @code{jump} command is to back up,
perhaps with more breakpoints set, over a portion of a program that has
already executed, in order to examine its execution in more detail.
-@node Signaling, Returning, Jumping, Altering
+@ifclear BARETARGET
@c @group
-@section Giving your program a Signal
+@node Signaling
+@section Giving your program a signal
@table @code
-@item signal @var{signalnum}
+@item signal @var{signal}
@kindex signal
-Resume execution where your program stopped, but give it immediately the
-signal number @var{signalnum}.
+Resume execution where your program stopped, but immediately give it the
+signal @var{signal}. @var{signal} can be the name or the number of a
+signal. For example, on many systems @code{signal 2} and @code{signal
+SIGINT} are both ways of sending an interrupt signal.
-Alternatively, if @var{signalnum} is zero, continue execution without
+Alternatively, if @var{signal} is zero, continue execution without
giving a signal. This is useful when your program stopped on account of
a signal and would ordinary see the signal when resumed with the
@code{continue} command; @samp{signal 0} causes it to resume without a
@end table
@c @end group
-@node Returning, Calling, Signaling, Altering
-@section Returning from a Function
+Invoking the @code{signal} command is not the same as invoking the
+@code{kill} utility from the shell. Sending a signal with @code{kill}
+causes @value{GDBN} to decide what to do with the signal depending on
+the signal handling tables (@pxref{Signals}). The @code{signal} command
+passes the signal directly to your program.
+
+@end ifclear
+
+@node Returning
+@section Returning from a function
@table @code
@item return
value.
@end table
-When you use @code{return}, _GDBN__ discards the selected stack frame
+When you use @code{return}, @value{GDBN} discards the selected stack frame
(and all frames within it). You can think of this as making the
discarded frame return prematurely. If you wish to specify a value to
be returned, give that value as the argument to @code{return}.
This pops the selected stack frame (@pxref{Selection, ,Selecting a
-Frame}), and any other frames inside of it, leaving its caller as the
+frame}), and any other frames inside of it, leaving its caller as the
innermost remaining frame. That frame becomes selected. The
specified value is stored in the registers used for returning values
of functions.
The @code{return} command does not resume execution; it leaves the
program stopped in the state that would exist if the function had just
returned. In contrast, the @code{finish} command (@pxref{Continuing
-and Stepping, ,Continuing and Stepping}) resumes execution until the
+and Stepping, ,Continuing and stepping}) resumes execution until the
selected stack frame returns naturally.
-@node Calling, Patching, Returning, Altering
-@section Calling your Program's Functions
+@node Calling
+@section Calling program functions
@cindex calling functions
@kindex call
with @code{void} returned values. The result is printed and saved in
the value history, if it is not void.
-@node Patching, , Calling, Altering
-@section Patching your Program
+@node Patching
+@section Patching programs
@cindex patching binaries
@cindex writing into executables
+@ifclear BARETARGET
@cindex writing into corefiles
-
-By default, _GDBN__ opens the file containing your program's executable
-code (or the corefile) read-only. This prevents accidental alterations
+@end ifclear
+
+By default, @value{GDBN} opens the file containing your program's executable
+code
+@ifclear BARETARGET
+(or the corefile)
+@end ifclear
+read-only. This prevents accidental alterations
to machine code; but it also prevents you from intentionally patching
your program's binary.
@item set write on
@itemx set write off
@kindex set write
-If you specify @samp{set write on}, _GDBN__ will open executable and
-core files for both reading and writing; if you specify @samp{set write
-off} (the default), _GDBN__ will open them read-only.
-
-If you have already loaded a file, you must load it
-again (using the @code{exec-file} or @code{core-file} command) after
-changing @code{set write}, for your new setting to take effect.
+If you specify @samp{set write on}, @value{GDBN} will open executable
+@ifclear BARETARGET
+and core
+@end ifclear
+files for both reading and writing; if you specify @samp{set write
+off} (the default), @value{GDBN} will open them read-only.
+
+If you have already loaded a file, you must load it again (using the
+@code{exec-file}
+@ifclear BARETARGET
+or @code{core-file}
+@end ifclear
+command) after changing @code{set write}, for your new setting to take
+effect.
@item show write
@kindex show write
-Display whether executable files and core files will be opened for
-writing as well as reading.
+Display whether executable files
+@ifclear BARETARGET
+and core files
+@end ifclear
+will be opened for writing as well as reading.
@end table
-@node _GDBN__ Files, Targets, Altering, Top
-@chapter _GDBN__'s Files
+@node GDB Files
+@chapter @value{GDBN} Files
-_GDBN__ needs to know the file name of the program to be debugged, both in
-order to read its symbol table and in order to start your program. To
-debug a core dump of a previous run, _GDBN__ must be told the file name of
-the core dump.
+@value{GDBN} needs to know the file name of the program to be debugged, both in
+order to read its symbol table and in order to start your program.
+@ifclear BARETARGET
+To debug a core dump of a previous run, you must also tell @value{GDBN}
+the name of the core dump file.
+@end ifclear
@menu
-* Files:: Commands to Specify Files
-* Symbol Errors:: Errors Reading Symbol Files
+* Files:: Commands to specify files
+* Symbol Errors:: Errors reading symbol files
@end menu
-@node Files, Symbol Errors, _GDBN__ Files, _GDBN__ Files
-@section Commands to Specify Files
-@cindex core dump file
+@node Files
+@section Commands to specify files
@cindex symbol table
+@ifclear BARETARGET
+@cindex core dump file
The usual way to specify executable and core dump file names is with
-the command arguments given when you start _GDBN__, (@pxref{Invocation,
-,Getting In and Out of _GDBN__}.
+the command arguments given when you start @value{GDBN} (@pxref{Invocation,
+,Getting In and Out of @value{GDBN}}.
+@end ifclear
+@ifset BARETARGET
+The usual way to specify an executable file name is with
+the command argument given when you start @value{GDBN}, (@pxref{Invocation,
+,Getting In and Out of @value{GDBN}}.
+@end ifset
Occasionally it is necessary to change to a different file during a
-_GDBN__ session. Or you may run _GDBN__ and forget to specify the files you
-want to use. In these situations the _GDBN__ commands to specify new files
-are useful.
+@value{GDBN} session. Or you may run @value{GDBN} and forget to specify
+a file you want to use. In these situations the @value{GDBN} commands
+to specify new files are useful.
@table @code
@item file @var{filename}
Use @var{filename} as the program to be debugged. It is read for its
symbols and for the contents of pure memory. It is also the program
executed when you use the @code{run} command. If you do not specify a
-directory and the file is not found in _GDBN__'s working directory, _GDBN__
+directory and the file is not found in the @value{GDBN} working directory, @value{GDBN}
uses the environment variable @code{PATH} as a list of directories to
search, just as the shell does when looking for a program to run. You
-can change the value of this variable, for both _GDBN__ and your program,
+can change the value of this variable, for both @value{GDBN} and your program,
using the @code{path} command.
On systems with memory-mapped files, an auxiliary symbol table file
@file{@var{filename}.syms} may be available for @var{filename}. If it
-is, _GDBN__ will map in the symbol table from
+is, @value{GDBN} will map in the symbol table from
@file{@var{filename}.syms}, starting up more quickly. See the
descriptions of the options @samp{-mapped} and @samp{-readnow} (available
on the command line, and with the commands @code{file}, @code{symbol-file},
or @code{add-symbol-file}), for more information.
@item file
-@code{file} with no argument makes _GDBN__ discard any information it
+@code{file} with no argument makes @value{GDBN} discard any information it
has on both executable file and the symbol table.
@item exec-file @r{[} @var{filename} @r{]}
@kindex exec-file
Specify that the program to be run (but not the symbol table) is found
-in @var{filename}. _GDBN__ will search the environment variable @code{PATH}
+in @var{filename}. @value{GDBN} will search the environment variable @code{PATH}
if necessary to locate your program. Omitting @var{filename} means to
discard information on the executable file.
searched when necessary. Use the @code{file} command to get both symbol
table and program to run from the same file.
-@code{symbol-file} with no argument clears out _GDBN__'s information on your
+@code{symbol-file} with no argument clears out @value{GDBN} information on your
program's symbol table.
-The @code{symbol-file} command causes _GDBN__ to forget the contents of its
+The @code{symbol-file} command causes @value{GDBN} to forget the contents of its
convenience variables, the value history, and all breakpoints and
auto-display expressions. This is because they may contain pointers to
the internal data recording symbols and data types, which are part of
-the old symbol table data being discarded inside _GDBN__.
+the old symbol table data being discarded inside @value{GDBN}.
@code{symbol-file} will not repeat if you press @key{RET} again after
executing it once.
-When _GDBN__ is configured for a particular environment, it will
+When @value{GDBN} is configured for a particular environment, it will
understand debugging information in whatever format is the standard
generated for that environment; you may use either a GNU compiler, or
other compilers that adhere to the local conventions. Best results are
-usually obtained from GNU compilers; for example, using @code{_GCC__}
+usually obtained from GNU compilers; for example, using @code{@value{GCC}}
you can generate debugging information for optimized code.
On some kinds of object files, the @code{symbol-file} command does not
are present. The details are read later, one source file at a time,
as they are needed.
-The purpose of this two-stage reading strategy is to make _GDBN__ start up
+The purpose of this two-stage reading strategy is to make @value{GDBN} start up
faster. For the most part, it is invisible except for occasional
pauses while the symbol table details for a particular source file are
being read. (The @code{set verbose} command can turn these pauses
-into messages if desired. @xref{Messages/Warnings, ,Optional Warnings
-and Messages}.)
+into messages if desired. @xref{Messages/Warnings, ,Optional warnings
+and messages}.)
-When the symbol table is stored in COFF format, @code{symbol-file} does
-read the symbol table data in full right away. We have not implemented
-the two-stage strategy for COFF yet.
+We have not implemented the two-stage strategy for COFF yet. When the
+symbol table is stored in COFF format, @code{symbol-file} reads the
+symbol table data in full right away.
@item symbol-file @var{filename} @r{[} -readnow @r{]} @r{[} -mapped @r{]}
@itemx file @var{filename} @r{[} -readnow @r{]} @r{[} -mapped @r{]}
@kindex mapped
@cindex memory-mapped symbol file
@cindex saving symbol table
-You can override the _GDBN__ two-stage strategy for reading symbol
+You can override the @value{GDBN} two-stage strategy for reading symbol
tables by using the @samp{-readnow} option with any of the commands that
-load symbol table information, if you want to be sure _GDBN__ has the
+load symbol table information, if you want to be sure @value{GDBN} has the
entire symbol table available.
+@ifclear BARETARGET
If memory-mapped files are available on your system through the
@code{mmap} system call, you can use another option, @samp{-mapped}, to
-cause _GDBN__ to write the symbols for your program into a reusable
-file. Future _GDBN__ debugging sessions will map in symbol information
-from this auxiliary symbol file (if the program hasn't changed), rather
+cause @value{GDBN} to write the symbols for your program into a reusable
+file. Future @value{GDBN} debugging sessions will map in symbol information
+from this auxiliary symbol file (if the program has not changed), rather
than spending time reading the symbol table from the executable
program. Using the @samp{-mapped} option has the same effect as
-starting _GDBN__ with the @samp{-mapped} command-line option.
+starting @value{GDBN} with the @samp{-mapped} command-line option.
You can use both options together, to make sure the auxiliary symbol
file has all the symbol information for your program.
-The @code{.syms} file is specific to the host machine on which GDB is run.
-It holds an exact image of GDB's internal symbol table. It cannot be
-shared across multiple host platforms.
-
The auxiliary symbol file for a program called @var{myprog} is called
@samp{@var{myprog}.syms}. Once this file exists (so long as it is newer
-than the corresponding executable), _GDBN__ will always attempt to use
+than the corresponding executable), @value{GDBN} will always attempt to use
it when you debug @var{myprog}; no special options or commands are
needed.
+
+The @file{.syms} file is specific to the host machine where you run
+@value{GDBN}. It holds an exact image of the internal @value{GDBN}
+symbol table. It cannot be shared across multiple host platforms.
+
@c FIXME: for now no mention of directories, since this seems to be in
@c flux. 13mar1992 status is that in theory GDB would look either in
@c current dir or in same dir as myprog; but issues like competing
@kindex core-file
Specify the whereabouts of a core dump file to be used as the ``contents
of memory''. Traditionally, core files contain only some parts of the
-address space of the process that generated them; _GDBN__ can access the
+address space of the process that generated them; @value{GDBN} can access the
executable file itself for other parts.
@code{core-file} with no argument specifies that no core file is
to be used.
Note that the core file is ignored when your program is actually running
-under _GDBN__. So, if you have been running your program and you wish to
+under @value{GDBN}. So, if you have been running your program and you wish to
debug a core file instead, you must kill the subprocess in which the
program is running. To do this, use the @code{kill} command
-(@pxref{Kill Process, ,Killing the Child Process}).
+(@pxref{Kill Process, ,Killing the child process}).
+@end ifclear
@item load @var{filename}
@kindex load
-_if__(_GENERIC__)
+@ifset GENERIC
Depending on what remote debugging facilities are configured into
-_GDBN__, the @code{load} command may be available. Where it exists, it
+@value{GDBN}, the @code{load} command may be available. Where it exists, it
is meant to make @var{filename} (an executable) available for debugging
on the remote system---by downloading, or dynamic linking, for example.
-@code{load} also records @var{filename}'s symbol table in _GDBN__, like
+@code{load} also records the @var{filename} symbol table in @value{GDBN}, like
the @code{add-symbol-file} command.
-If @code{load} is not available on your _GDBN__, attempting to execute
-it gets the error message ``@code{You can't do that when your target is
-@dots{}}''
-_fi__(_GENERIC__)
+If your @value{GDBN} does not have a @code{load} command, attempting to
+execute it gets the error message ``@code{You can't do that when your
+target is @dots{}}''
+@end ifset
-_if__(_VXWORKS__)
+The file is loaded at whatever address is specified in the executable.
+For some object file formats, you can specify the load address when you
+link the program; for other formats, like a.out, the object file format
+specifies a fixed address.
+@c FIXME! This would be a good place for an xref to the GNU linker doc.
+
+@ifset VXWORKS
On VxWorks, @code{load} will dynamically link @var{filename} on the
-current target system as well as adding its symbols in _GDBN__.
-_fi__(_VXWORKS__)
+current target system as well as adding its symbols in @value{GDBN}.
+@end ifset
-_if__(_I960__)
+@ifset I960
@cindex download to Nindy-960
With the Nindy interface to an Intel 960 board, @code{load} will
download @var{filename} to the 960 as well as adding its symbols in
-_GDBN__.
-_fi__(_I960__)
-
-_if__(_H8__)
-@cindex download to H8/300
-@cindex H8/300 download
-When you select remote debugging to a Hitachi H8/300 board (@pxref{Hitachi
-H8/300 Remote,,_GDBN__ and the Hitachi H8/300}), the
-@code{load} command downloads your program to the H8/300 and also opens
-it as the current executable target for _GDBN__ on your host (like the
-@code{file} command).
-_fi__(_H8__)
+@value{GDBN}.
+@end ifset
+
+@ifset H8
+@cindex download to H8/300 or H8/500
+@cindex H8/300 or H8/500 download
+@cindex download to Hitachi SH
+@cindex Hitachi SH download
+When you select remote debugging to a Hitachi SH, H8/300, or H8/500 board
+(@pxref{Hitachi Remote,,@value{GDBN} and Hitachi Microprocessors}),
+the @code{load} command downloads your program to the Hitachi board and also
+opens it as the current executable target for @value{GDBN} on your host
+(like the @code{file} command).
+@end ifset
@code{load} will not repeat if you press @key{RET} again after using it.
+@ifclear BARETARGET
@item add-symbol-file @var{filename} @var{address}
@itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{]} @r{[} -mapped @r{]}
@kindex add-symbol-file
from the file @var{filename}. You would use this command when @var{filename}
has been dynamically loaded (by some other means) into the program that
is running. @var{address} should be the memory address at which the
-file has been loaded; _GDBN__ cannot figure this out for itself.
+file has been loaded; @value{GDBN} cannot figure this out for itself.
+You can specify @var{address} as an expression.
The symbol table of the file @var{filename} is added to the symbol table
originally read with the @code{symbol-file} command. You can use the
@code{add-symbol-file} will not repeat if you press @key{RET} after using it.
You can use the @samp{-mapped} and @samp{-readnow} options just as with
-the @code{symbol-file} command, to change how _GDBN__ manages the symbol
-tabl einformation for @var{filename}.
+the @code{symbol-file} command, to change how @value{GDBN} manages the symbol
+table information for @var{filename}.
+@end ifclear
@item info files
@itemx info target
@kindex info files
@kindex info target
@code{info files} and @code{info target} are synonymous; both print
-the current targets (@pxref{Targets, ,Specifying a Debugging Target}),
-including the names of the executable and core dump files currently in
-use by _GDBN__, and the files from which symbols were loaded. The command
-@code{help targets} lists all possible targets rather than current
-ones.
-
+the current target (@pxref{Targets, ,Specifying a Debugging Target}),
+including the
+@ifclear BARETARGET
+names of the executable and core dump files
+@end ifclear
+@ifset BARETARGET
+name of the executable file
+@end ifset
+currently in use by @value{GDBN}, and the files from which symbols were
+loaded. The command @code{help targets} lists all possible targets
+rather than current ones.
@end table
All file-specifying commands allow both absolute and relative file names
-as arguments. _GDBN__ always converts the file name to an absolute path
+as arguments. @value{GDBN} always converts the file name to an absolute path
name and remembers it that way.
+@ifclear BARETARGET
@cindex shared libraries
-
-_GDBN__ supports SunOS, SVR4, and IBM RS/6000 shared libraries.
-_GDBN__ automatically loads symbol definitions from shared libraries
+@value{GDBN} supports SunOS, SVR4, and IBM RS/6000 shared libraries.
+@value{GDBN} automatically loads symbol definitions from shared libraries
when you use the @code{run} command, or when you examine a core file.
-(Before you issue the @code{run} command, _GDBN__ will not understand
+(Before you issue the @code{run} command, @value{GDBN} will not understand
references to a function in a shared library, however---unless you are
debugging a core file).
-@c FIXME: next _GDBN__ release should permit some refs to undef
+@c FIXME: next @value{GDBN} release should permit some refs to undef
@c FIXME...symbols---eg in a break cmd---assuming they are from a shared lib
@table @code
@itemx share @var{regex}
@kindex sharedlibrary
@kindex share
-This is an obsolescent command; you can use it to explicitly
-load shared object library symbols for files matching a UNIX regular
-expression, but as with files loaded automatically, it will only load
-shared libraries required by your program for a core file or after
-typing @code{run}. If @var{regex} is omitted all shared libraries
-required by your program are loaded.
+This is an obsolescent command; you can use it to explicitly load shared
+object library symbols for files matching a Unix regular expression, but
+as with files loaded automatically, it will only load shared libraries
+required by your program for a core file or after typing @code{run}. If
+@var{regex} is omitted all shared libraries required by your program are
+loaded.
@end table
+@end ifclear
-@node Symbol Errors, , Files, _GDBN__ Files
-@section Errors Reading Symbol Files
+@node Symbol Errors
+@section Errors reading symbol files
-While reading a symbol file, _GDBN__ will occasionally encounter problems,
+While reading a symbol file, @value{GDBN} will occasionally encounter problems,
such as symbol types it does not recognize, or known bugs in compiler
-output. By default, _GDBN__ does not notify you of such problems, since
+output. By default, @value{GDBN} does not notify you of such problems, since
they are relatively common and primarily of interest to people
debugging compilers. If you are interested in seeing information
-about ill-constructed symbol tables, you can either ask _GDBN__ to print
+about ill-constructed symbol tables, you can either ask @value{GDBN} to print
only one message about each such type of problem, no matter how many
-times the problem occurs; or you can ask _GDBN__ to print more messages,
+times the problem occurs; or you can ask @value{GDBN} to print more messages,
to see how many times the problems occur, with the @code{set
-complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and
-Messages}).
+complaints} command (@pxref{Messages/Warnings, ,Optional warnings and
+messages}).
-The messages currently printed, and their meanings, are:
+The messages currently printed, and their meanings, include:
@table @code
@item inner block not inside outer block in @var{symbol}
error indicates that an inner scope block is not fully contained
in its outer scope blocks.
-_GDBN__ circumvents the problem by treating the inner block as if it had
+@value{GDBN} circumvents the problem by treating the inner block as if it had
the same scope as the outer block. In the error message, @var{symbol}
may be shown as ``@code{(don't know)}'' if the outer block is not a
function.
order of increasing addresses. This error indicates that it does not
do so.
-_GDBN__ does not circumvent this problem, and will have trouble locating
-symbols in the source file whose symbols being read. (You can often
-determine what source file is affected by specifying @code{set verbose
-on}. @xref{Messages/Warnings, ,Optional Warnings and Messages}.)
+@value{GDBN} does not circumvent this problem, and will have trouble
+locating symbols in the source file whose symbols it is reading. (You
+can often determine what source file is affected by specifying
+@code{set verbose on}. @xref{Messages/Warnings, ,Optional warnings and
+messages}.)
@item bad block start address patched
smaller than the address of the preceding source line. This is known
to occur in the SunOS 4.1.1 (and earlier) C compiler.
-_GDBN__ circumvents the problem by treating the symbol scope block as
+@value{GDBN} circumvents the problem by treating the symbol scope block as
starting on the previous source line.
@item bad string table offset in symbol @var{n}
Symbol number @var{n} contains a pointer into the string table which is
larger than the size of the string table.
-_GDBN__ circumvents the problem by considering the symbol to have the
+@value{GDBN} circumvents the problem by considering the symbol to have the
name @code{foo}, which may cause other problems if many symbols end up
with this name.
@item unknown symbol type @code{0x@var{nn}}
-The symbol information contains new data types that _GDBN__ does not yet
+The symbol information contains new data types that @value{GDBN} does not yet
know how to read. @code{0x@var{nn}} is the symbol type of the misunderstood
information, in hexadecimal.
-_GDBN__ circumvents the error by ignoring this symbol information. This
+@value{GDBN} circumvents the error by ignoring this symbol information. This
will usually allow your program to be debugged, though certain symbols
will not be accessible. If you encounter such a problem and feel like
-debugging it, you can debug @code{_GDBP__} with itself, breakpoint on
+debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint on
@code{complain}, then go up to the function @code{read_dbx_symtab} and
examine @code{*bufp} to see the symbol.
@item stub type has NULL name
-_GDBN__ could not find the full definition for a struct or class.
-
+@value{GDBN} could not find the full definition for
+@ifclear CONLY
+a struct or class.
+@end ifclear
+@ifset CONLY
+a struct.
+@end ifset
+
+@ifclear CONLY
@item const/volatile indicator missing (ok if using g++ v1.x), got@dots{}
The symbol information for a C++ member function is missing some
information that recent versions of the compiler should have output
for it.
+@end ifclear
@item info mismatch between compiler and debugger
-_GDBN__ could not parse a type specification output by the compiler.
+@value{GDBN} could not parse a type specification output by the compiler.
@end table
-@node Targets, Controlling _GDBN__, _GDBN__ Files, Top
+@node Targets
@chapter Specifying a Debugging Target
@cindex debugging target
@kindex target
A @dfn{target} is the execution environment occupied by your program.
-Often, _GDBN__ runs in the same host environment as your program; in
+@ifclear BARETARGET
+Often, @value{GDBN} runs in the same host environment as your program; in
that case, the debugging target is specified as a side effect when you
use the @code{file} or @code{core} commands. When you need more
-flexibility---for example, running _GDBN__ on a physically separate
+flexibility---for example, running @value{GDBN} on a physically separate
host, or controlling a standalone system over a serial port or a
-realtime system over a TCP/IP connection---you can use the @code{target}
-command to specify one of the target types configured for _GDBN__
-(@pxref{Target Commands, ,Commands for Managing Targets}).
+realtime system over a TCP/IP connection---you
+@end ifclear
+@ifset BARETARGET
+You
+@end ifset
+can use the @code{target} command to specify one of the target types
+configured for @value{GDBN} (@pxref{Target Commands, ,Commands for managing
+targets}).
@menu
-* Active Targets:: Active Targets
-* Target Commands:: Commands for Managing Targets
-* Remote:: Remote Debugging
+* Active Targets:: Active targets
+* Target Commands:: Commands for managing targets
+* Remote:: Remote debugging
@end menu
-@node Active Targets, Target Commands, Targets, Targets
-@section Active Targets
+@node Active Targets
+@section Active targets
@cindex stacking targets
@cindex active targets
@cindex multiple targets
+@ifclear BARETARGET
There are three classes of targets: processes, core files, and
-executable files. _GDBN__ can work concurrently on up to three active
+executable files. @value{GDBN} can work concurrently on up to three active
targets, one in each class. This allows you to (for example) start a
process and inspect its activity without abandoning your work on a core
file.
-If, for example, you execute @samp{gdb a.out}, then the executable file
+For example, if you execute @samp{gdb a.out}, then the executable file
@code{a.out} is the only active target. If you designate a core file as
well---presumably from a prior run that crashed and coredumped---then
-_GDBN__ has two active targets and will use them in tandem, looking
+@value{GDBN} has two active targets and will use them in tandem, looking
first in the corefile target, then in the executable file, to satisfy
requests for memory addresses. (Typically, these two classes of target
are complementary, since core files contain only a program's
read-write memory---variables and so on---plus machine status, while
executable files contain only the program text and initialized data.)
+@end ifclear
When you type @code{run}, your executable file becomes an active process
-target as well. When a process target is active, all _GDBN__ commands
-requesting memory addresses refer to that target; addresses in an active
-core file or executable file target are obscured while the process
+target as well. When a process target is active, all @value{GDBN} commands
+requesting memory addresses refer to that target; addresses in an
+@ifclear BARETARGET
+active core file or
+@end ifclear
+executable file target are obscured while the process
target is active.
+@ifset BARETARGET
+Use the @code{exec-file} command to select a
+new executable target (@pxref{Files, ,Commands to specify
+files}).
+@end ifset
+@ifclear BARETARGET
Use the @code{core-file} and @code{exec-file} commands to select a
-new core file or executable target (@pxref{Files, ,Commands to Specify
-Files}). To specify as a target a process that is already running, use
+new core file or executable target (@pxref{Files, ,Commands to specify
+files}). To specify as a target a process that is already running, use
the @code{attach} command (@pxref{Attach, ,Debugging an
-Already-Running Process}.).
+already-running process}).
+@end ifclear
-@node Target Commands, Remote, Active Targets, Targets
-@section Commands for Managing Targets
+@node Target Commands
+@section Commands for managing targets
@table @code
@item target @var{type} @var{parameters}
-Connects the _GDBN__ host environment to a target machine or process. A
-target is typically a protocol for talking to debugging facilities. You
-use the argument @var{type} to specify the type or protocol of the
-target machine.
+Connects the @value{GDBN} host environment to a target
+@ifset BARETARGET
+machine.
+@end ifset
+@ifclear BARETARGET
+machine or process. A target is typically a protocol for talking to
+debugging facilities. You use the argument @var{type} to specify the
+type or protocol of the target machine.
Further @var{parameters} are interpreted by the target protocol, but
typically include things like device names or host names to connect
with, process numbers, and baud rates.
+@end ifclear
The @code{target} command will not repeat if you press @key{RET} again
after executing the command.
@kindex help target
Displays the names of all targets available. To display targets
currently selected, use either @code{info target} or @code{info files}
-(@pxref{Files, ,Commands to Specify Files}).
+(@pxref{Files, ,Commands to specify files}).
@item help target @var{name}
Describe a particular target, including any parameters necessary to
configuration):
@table @code
-@item target exec @var{prog}
+@item target exec @var{program}
@kindex target exec
-An executable file. @samp{target exec @var{prog}} is the same as
-@samp{exec-file @var{prog}}.
+An executable file. @samp{target exec @var{program}} is the same as
+@samp{exec-file @var{program}}.
+@ifclear BARETARGET
@item target core @var{filename}
@kindex target core
A core dump file. @samp{target core @var{filename}} is the same as
@samp{core-file @var{filename}}.
+@end ifclear
+@ifset REMOTESTUB
@item target remote @var{dev}
@kindex target remote
Remote serial target in GDB-specific protocol. The argument @var{dev}
specifies what serial device to use for the connection (e.g.
-@file{/dev/ttya}). @xref{Remote, ,Remote Debugging}.
+@file{/dev/ttya}). @xref{Remote, ,Remote debugging}.
+@end ifset
+
+@ifset SIMS
+@item target sim
+@kindex target sim
+CPU simulator. @xref{Simulator,,Simulated CPU Target}.
+@end ifset
+
+@ifset AMD29K
+@item target udi @var{keyword}
+@kindex target udi
+Remote AMD29K target, using the AMD UDI protocol. The @var{keyword}
+argument specifies which 29K board or simulator to use. @xref{UDI29K
+Remote,,@value{GDBN} and the UDI protocol for AMD29K}.
-_if__(_AMD29K__)
@item target amd-eb @var{dev} @var{speed} @var{PROG}
@kindex target amd-eb
@cindex AMD EB29K
@var{dev} is the serial device, as for @code{target remote};
@var{speed} allows you to specify the linespeed; and @var{PROG} is the
name of the program to be debugged, as it appears to DOS on the PC.
-@xref{EB29K Remote, ,GDB with a Remote EB29K}.
+@xref{EB29K Remote, ,@value{GDBN} with a remote EB29K}.
-_fi__(_AMD29K__)
-_if__(_H8__)
+@end ifset
+@ifset H8
@item target hms
@kindex target hms
-A Hitachi H8/300 board, attached via serial line to your host. Use
-special commands @code{device} and @code{speed} to control the serial
-line and the communications speed used. @xref{Hitachi H8/300
-Remote,,_GDBN__ and the Hitachi H8/300}.
-
-_fi__(_H8__)
-_if__(_I960__)
+A Hitachi SH, H8/300, or H8/500 board, attached via serial line to your host.
+@ifclear H8EXCLUSIVE
+@c Unix only, not currently of interest for H8-only manual
+Use special commands @code{device} and @code{speed} to control the serial
+line and the communications speed used.
+@end ifclear
+@xref{Hitachi Remote,,@value{GDBN} and Hitachi Microprocessors}.
+
+@end ifset
+@ifset I960
@item target nindy @var{devicename}
@kindex target nindy
An Intel 960 board controlled by a Nindy Monitor. @var{devicename} is
the name of the serial device to use for the connection, e.g.
-@file{/dev/ttya}. @xref{i960-Nindy Remote, ,_GDBN__ with a Remote i960 (Nindy)}.
-
-_fi__(_I960__)
-_if__(_VXWORKS__)
+@file{/dev/ttya}. @xref{i960-Nindy Remote, ,@value{GDBN} with a remote i960 (Nindy)}.
+
+@end ifset
+@ifset ST2000
+@item target st2000 @var{dev} @var{speed}
+@kindex target st2000
+A Tandem ST2000 phone switch, running Tandem's STDBUG protocol. @var{dev}
+is the name of the device attached to the ST2000 serial line;
+@var{speed} is the communication line speed. The arguments are not used
+if @value{GDBN} is configured to connect to the ST2000 using TCP or Telnet.
+@xref{ST2000 Remote,,@value{GDBN} with a Tandem ST2000}.
+
+@end ifset
+@ifset VXWORKS
@item target vxworks @var{machinename}
@kindex target vxworks
A VxWorks system, attached via TCP/IP. The argument @var{machinename}
is the target system's machine name or IP address.
-@xref{VxWorks Remote, ,_GDBN__ and VxWorks}.
-_fi__(_VXWORKS__)
+@xref{VxWorks Remote, ,@value{GDBN} and VxWorks}.
+@end ifset
@end table
-_if__(_GENERIC__)
-Different targets are available on different configurations of _GDBN__; your
+@ifset GENERIC
+Different targets are available on different configurations of @value{GDBN}; your
configuration may have more or fewer targets.
-_fi__(_GENERIC__)
+@end ifset
-@node Remote, , Target Commands, Targets
-@section Remote Debugging
+@node Remote
+@section Remote debugging
@cindex remote debugging
If you are trying to debug a program running on a machine that cannot run
write the remote stubs---the code that will run on the remote system to
communicate with GDB.
-To use the GDB remote serial protocol, the program to be debugged on
-the remote machine needs to contain a debugging stub which talks to
-GDB over the serial line. Several working remote stubs are
-distributed with GDB; see the @file{README} file in the GDB
-distribution for more information.
-
-For details of this communication protocol, see the comments in the
-GDB source file @file{remote.c}.
-
-To start remote debugging, first run GDB and specify as an executable file
-the program that is running in the remote machine. This tells GDB how
-to find your program's symbols and the contents of its pure text. Then
-establish communication using the @code{target remote} command with a device
-name as an argument. For example:
-
-@example
-target remote /dev/ttyb
-@end example
-
-@noindent
-if the serial line is connected to the device named @file{/dev/ttyb}. This
-will stop the remote machine if it is not already stopped.
-
-Now you can use all the usual commands to examine and change data and to
-step and continue the remote program.
-
-To resume the remote program and stop debugging it, use the @code{detach}
-command.
-
-@kindex set remotedebug
-@kindex show remotedebug
-If you have trouble with the serial connection, you can use the
-command @code{set remotedebug}. This causes all packets sent back
-and forth across the serial line to be reported to GDB's standard output.
-@code{set remotedebug off} turns it off, and @code{show remotedebug} will
-show you its current state.
-
Other remote targets may be available in your
configuration of GDB; use @code{help targets} to list them.
-_if__(_GENERIC__)
-_dnl__ Text on starting up GDB in various specific cases; it goes up front
-_dnl__ in manuals configured for any of those particular situations, here
-_dnl__ otherwise.
+@ifset GENERIC
+@c Text on starting up GDB in various specific cases; it goes up front
+@c in manuals configured for any of those particular situations, here
+@c otherwise.
@menu
-_include__(gdbinv-m.m4)<>_dnl__
+@ifset REMOTESTUB
+* Remote Serial:: @value{GDBN} remote serial protocol
+@end ifset
+@ifset I960
+* i960-Nindy Remote:: @value{GDBN} with a remote i960 (Nindy)
+@end ifset
+@ifset AMD29K
+* UDI29K Remote:: @value{GDBN} and the UDI protocol for AMD29K
+* EB29K Remote:: @value{GDBN} with a remote EB29K
+@end ifset
+@ifset VXWORKS
+* VxWorks Remote:: @value{GDBN} and VxWorks
+@end ifset
+@ifset ST2000
+* ST2000 Remote:: @value{GDBN} with a Tandem ST2000
+@end ifset
+@ifset H8
+* Hitachi Remote:: @value{GDBN} and Hitachi Microprocessors
+@end ifset
+@ifset MIPS
+* MIPS Remote:: @value{GDBN} and MIPS boards
+@end ifset
+@ifset SIMS
+* Simulator:: Simulated CPU target
+@end ifset
@end menu
-_include__(gdbinv-s.m4)
-_fi__(_GENERIC__)
-@node Controlling _GDBN__, Sequences, Targets, Top
-@chapter Controlling _GDBN__
+@include remote.texi
+@end ifset
-You can alter many aspects of _GDBN__'s interaction with you by using
-the @code{set} command. For commands controlling how _GDBN__ displays
-data, @pxref{Print Settings, ,Print Settings}; other settings are described here.
+@node Controlling GDB
+@chapter Controlling @value{GDBN}
+
+You can alter the way @value{GDBN} interacts with you by using
+the @code{set} command. For commands controlling how @value{GDBN} displays
+data, @pxref{Print Settings, ,Print settings}; other settings are described here.
@menu
* Prompt:: Prompt
-* Editing:: Command Editing
-* History:: Command History
-* Screen Size:: Screen Size
+* Editing:: Command editing
+* History:: Command history
+* Screen Size:: Screen size
* Numbers:: Numbers
-* Messages/Warnings:: Optional Warnings and Messages
+* Messages/Warnings:: Optional warnings and messages
@end menu
-@node Prompt, Editing, Controlling _GDBN__, Controlling _GDBN__
+@node Prompt
@section Prompt
@cindex prompt
-_GDBN__ indicates its readiness to read a command by printing a string
-called the @dfn{prompt}. This string is normally @samp{(_GDBP__)}. You
+@value{GDBN} indicates its readiness to read a command by printing a string
+called the @dfn{prompt}. This string is normally @samp{(@value{GDBP})}. You
can change the prompt string with the @code{set prompt} command. For
-instance, when debugging _GDBN__ with _GDBN__, it is useful to change
-the prompt in one of the _GDBN__<>s so that you can always tell which
+instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change
+the prompt in one of the @value{GDBN} sessions so that you can always tell which
one you are talking to.
@table @code
@item set prompt @var{newprompt}
@kindex set prompt
-Directs _GDBN__ to use @var{newprompt} as its prompt string henceforth.
+Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth.
@kindex show prompt
@item show prompt
Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}}
@end table
-@node Editing, History, Prompt, Controlling _GDBN__
-@section Command Editing
+@node Editing
+@section Command editing
@cindex readline
@cindex command line editing
-_GDBN__ reads its input commands via the @dfn{readline} interface. This
+@value{GDBN} reads its input commands via the @dfn{readline} interface. This
GNU library provides consistent behavior for programs which provide a
command line interface to the user. Advantages are @code{emacs}-style
or @code{vi}-style inline editing of commands, @code{csh}-like history
substitution, and a storage and recall of command history across
debugging sessions.
-You may control the behavior of command line editing in _GDBN__ with the
+You may control the behavior of command line editing in @value{GDBN} with the
command @code{set}.
@table @code
Show whether command line editing is enabled.
@end table
-@node History, Screen Size, Editing, Controlling _GDBN__
-@section Command History
+@node History
+@section Command history
+
+@value{GDBN} can keep track of the commands you type during your
+debugging sessions, so that you can be certain of precisely what
+happened. Use these commands to manage the @value{GDBN} command
+history facility.
@table @code
@cindex history substitution
@cindex history file
@kindex set history filename
@item set history filename @var{fname}
-Set the name of the _GDBN__ command history file to @var{fname}. This is
-the file from which _GDBN__ will read an initial command history
+Set the name of the @value{GDBN} command history file to @var{fname}. This is
+the file from which @value{GDBN} will read an initial command history
list or to which it will write this list when it exits. This list is
accessed through history expansion or through the history
command editing characters listed below. This file defaults to the
@cindex history size
@kindex set history size
@item set history size @var{size}
-Set the number of commands which _GDBN__ will keep in its history list.
+Set the number of commands which @value{GDBN} will keep in its history list.
This defaults to the value of the environment variable
@code{HISTSIZE}, or to 256 if this variable is not set.
@end table
@cindex history expansion
History expansion assigns special meaning to the character @kbd{!}.
-@iftex
+@ifset have-readline-appendices
@xref{Event Designators}.
-@end iftex
+@end ifset
+
Since @kbd{!} is also the logical not operator in C, history expansion
is off by default. If you decide to enable history expansion with the
@code{set history expansion on} command, you may sometimes need to
The readline code comes with more complete documentation of
editing and history expansion features. Users unfamiliar with @code{emacs}
or @code{vi} may wish to read it.
-@iftex
+@ifset have-readline-appendices
@xref{Command Line Editing}.
-@end iftex
+@end ifset
@c @group
@kindex show history
@itemx show history save
@itemx show history size
@itemx show history expansion
-These commands display the state of the _GDBN__ history parameters.
+These commands display the state of the @value{GDBN} history parameters.
@code{show history} by itself displays all four states.
@c @end group
@end table
Print ten commands just after the commands last printed.
@end table
-@node Screen Size, Numbers, History, Controlling _GDBN__
-@section Screen Size
+@node Screen Size
+@section Screen size
@cindex size of screen
@cindex pauses in output
-Certain commands to _GDBN__ may produce large amounts of information
-output to the screen. To help you read all of it, _GDBN__ pauses and
-asks you for input at the end of each page of output. Type @key{RET}
-when you want to continue the output. _GDBN__ also uses the screen
-width setting to determine when to wrap lines of output. Depending on
-what is being printed, it tries to break the line at a readable place,
+Certain commands to @value{GDBN} may produce large amounts of
+information output to the screen. To help you read all of it,
+@value{GDBN} pauses and asks you for input at the end of each page of
+output. Type @key{RET} when you want to continue the output, or @kbd{q}
+to discard the remaining output. Also, the screen width setting
+determines when to wrap lines of output. Depending on what is being
+printed, @value{GDBN} tries to break the line at a readable place,
rather than simply letting it overflow onto the following line.
-Normally _GDBN__ knows the size of the screen from the termcap data base
+Normally @value{GDBN} knows the size of the screen from the termcap data base
together with the value of the @code{TERM} environment variable and the
@code{stty rows} and @code{stty cols} settings. If this is not correct,
you can override it with the @code{set height} and @code{set
a screen width of @var{cpl} characters. The associated @code{show}
commands display the current settings.
-If you specify a height of zero lines, _GDBN__ will not pause during output
+If you specify a height of zero lines, @value{GDBN} will not pause during output
no matter how long the output is. This is useful if output is to a file
or to an editor buffer.
+
+Likewise, you can specify @samp{set width 0} to prevent @value{GDBN}
+from wrapping its output.
@end table
-@node Numbers, Messages/Warnings, Screen Size, Controlling _GDBN__
+@node Numbers
@section Numbers
@cindex number representation
@cindex entering numbers
-You can always enter numbers in octal, decimal, or hexadecimal in _GDBN__ by
+You can always enter numbers in octal, decimal, or hexadecimal in @value{GDBN} by
the usual conventions: octal numbers begin with @samp{0}, decimal
numbers end with @samp{.}, and hexadecimal numbers begin with @samp{0x}.
Numbers that begin with none of these are, by default, entered in base
@kindex set radix
@item set radix @var{base}
Set the default base for numeric input and display. Supported choices
-for @var{base} are decimal 2, 8, 10, 16. @var{base} must itself be
+for @var{base} are decimal 8, 10, or 16. @var{base} must itself be
specified either unambiguously or using the current default radix; for
example, any of
@example
-set radix 1010
set radix 012
set radix 10.
set radix 0xa
Display the current default base for numeric input and display.
@end table
-@node Messages/Warnings, , Numbers, Controlling _GDBN__
-@section Optional Warnings and Messages
+@node Messages/Warnings
+@section Optional warnings and messages
-By default, _GDBN__ is silent about its inner workings. If you are running
+By default, @value{GDBN} is silent about its inner workings. If you are running
on a slow machine, you may want to use the @code{set verbose} command.
-It will make _GDBN__ tell you when it does a lengthy internal operation, so
+It will make @value{GDBN} tell you when it does a lengthy internal operation, so
you will not think it has crashed.
Currently, the messages controlled by @code{set verbose} are those
-which announce that the symbol table for a source file is being read
-(@pxref{Files, ,Commands to Specify Files}, in the description of the
-command @code{symbol-file}).
-@c The following is the right way to do it, but emacs 18.55 does not support
-@c @ref, and neither the emacs lisp manual version of texinfmt or makeinfo
-@c is released.
-@ignore
-see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}).
-@end ignore
+which announce that the symbol table for a source file is being read;
+see @code{symbol-file} in @ref{Files, ,Commands to specify files}.
@table @code
@kindex set verbose
@item set verbose on
-Enables _GDBN__'s output of certain informational messages.
+Enables @value{GDBN} output of certain informational messages.
@item set verbose off
-Disables _GDBN__'s output of certain informational messages.
+Disables @value{GDBN} output of certain informational messages.
@kindex show verbose
@item show verbose
Displays whether @code{set verbose} is on or off.
@end table
-By default, if _GDBN__ encounters bugs in the symbol table of an object
+By default, if @value{GDBN} encounters bugs in the symbol table of an object
file, it is silent; but if you are debugging a compiler, you may find
-this information useful (@pxref{Symbol Errors, ,Errors Reading Symbol Files}).
+this information useful (@pxref{Symbol Errors, ,Errors reading symbol files}).
@table @code
@kindex set complaints
@item set complaints @var{limit}
-Permits _GDBN__ to output @var{limit} complaints about each type of unusual
+Permits @value{GDBN} to output @var{limit} complaints about each type of unusual
symbols before becoming silent about the problem. Set @var{limit} to
zero to suppress all complaints; set it to a large number to prevent
complaints from being suppressed.
@kindex show complaints
@item show complaints
-Displays how many symbol complaints _GDBN__ is permitted to produce.
+Displays how many symbol complaints @value{GDBN} is permitted to produce.
@end table
-By default, _GDBN__ is cautious, and asks what sometimes seem to be a
+By default, @value{GDBN} is cautious, and asks what sometimes seems to be a
lot of stupid questions to confirm certain commands. For example, if
you try to run a program which is already running:
@example
-(_GDBP__) run
+(@value{GDBP}) run
The program being debugged has been started already.
Start it from the beginning? (y or n)
@end example
@cindex reloading symbols
Some systems allow individual object files that make up your program to
be replaced without stopping and restarting your program.
-_if__(_VXWORKS__)
+@ifset VXWORKS
For example, in VxWorks you can simply recompile a defective object file
and keep on running.
-_fi__(_VXWORKS__)
-If you are running on one of these systems, you can allow _GDBN__ to
+@end ifset
+If you are running on one of these systems, you can allow @value{GDBN} to
reload the symbols for automatically relinked modules:
@table @code
Do not replace symbol definitions when re-encountering object files of
the same name. This is the default state; if you are not running on a
system that permits automatically relinking modules, you should leave
-@code{symbol-reloading} off, since otherwise _GDBN__ may discard symbols
+@code{symbol-reloading} off, since otherwise @value{GDBN} may discard symbols
when linking large programs, that may contain several modules (from
different directories or libraries) with the same name.
Show the current @code{on} or @code{off} setting.
@end table
-@node Sequences, Emacs, Controlling _GDBN__, Top
+@node Sequences
@chapter Canned Sequences of Commands
Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint
-Command Lists}), _GDBN__ provides two ways to store sequences of commands
+command lists}), @value{GDBN} provides two ways to store sequences of commands
for execution as a unit: user-defined commands and command files.
@menu
-* Define:: User-Defined Commands
-* Command Files:: Command Files
-* Output:: Commands for Controlled Output
+* Define:: User-defined commands
+* Hooks:: User-defined command hooks
+* Command Files:: Command files
+* Output:: Commands for controlled output
@end menu
-@node Define, Command Files, Sequences, Sequences
-@section User-Defined Commands
+@node Define
+@section User-defined commands
@cindex user-defined command
-A @dfn{user-defined command} is a sequence of _GDBN__ commands to which you
+A @dfn{user-defined command} is a sequence of @value{GDBN} commands to which you
assign a new name as a command. This is done with the @code{define}
command.
Define a command named @var{commandname}. If there is already a command
by that name, you are asked to confirm that you want to redefine it.
-The definition of the command is made up of other _GDBN__ command lines,
+The definition of the command is made up of other @value{GDBN} command lines,
which are given following the @code{define} command. The end of these
commands is marked by a line containing @code{end}.
@item show user
@itemx show user @var{commandname}
@kindex show user
-Display the _GDBN__ commands used to define @var{commandname} (but not its
+Display the @value{GDBN} commands used to define @var{commandname} (but not its
documentation). If no @var{commandname} is given, display the
definitions for all user-defined commands.
@end table
stops execution of the user-defined command.
Commands that would ask for confirmation if used interactively proceed
-without asking when used inside a user-defined command. Many _GDBN__ commands
+without asking when used inside a user-defined command. Many @value{GDBN} commands
that normally print messages to say what they are doing omit the messages
when used in a user-defined command.
-@node Command Files, Output, Define, Sequences
-@section Command Files
+@node Hooks
+@section User-defined command hooks
+@cindex command files
+
+You may define @emph{hooks}, which are a special kind of user-defined
+command. Whenever you run the command @samp{foo}, if the user-defined
+command @samp{hook-foo} exists, it is executed (with no arguments)
+before that command.
+
+In addition, a pseudo-command, @samp{stop} exists. Defining
+(@samp{hook-stop}) makes the associated commands execute every time
+execution stops in your program: before breakpoint commands are run,
+displays are printed, or the stack frame is printed.
+
+@ifclear BARETARGET
+For example, to ignore @code{SIGALRM} signals while
+single-stepping, but treat them normally during normal execution,
+you could define:
+
+@example
+define hook-stop
+handle SIGALRM nopass
+end
+
+define hook-run
+handle SIGALRM pass
+end
+
+define hook-continue
+handle SIGLARM pass
+end
+@end example
+@end ifclear
+
+You can define a hook for any single-word command in @value{GDBN}, but
+not for command aliases; you should define a hook for the basic command
+name, e.g. @code{backtrace} rather than @code{bt}.
+@c FIXME! So how does Joe User discover whether a command is an alias
+@c or not?
+If an error occurs during the execution of your hook, execution of
+@value{GDBN} commands stops and @value{GDBN} issues a prompt
+(before the command that you actually typed had a chance to run).
+
+If you try to define a hook which does not match any known command, you
+will get a warning from the @code{define} command.
+
+@node Command Files
+@section Command files
@cindex command files
-A command file for _GDBN__ is a file of lines that are _GDBN__ commands. Comments
+A command file for @value{GDBN} is a file of lines that are @value{GDBN} commands. Comments
(lines starting with @kbd{#}) may also be included. An empty line in a
command file does nothing; it does not mean to repeat the last command, as
it would from the terminal.
@cindex init file
-@cindex @file{_GDBINIT__}
-When you start _GDBN__, it automatically executes commands from its
-@dfn{init files}. These are files named @file{_GDBINIT__}. _GDBN__ reads
-the init file (if any) in your home directory and then the init file
-(if any) in the current working directory. (The init files are not
-executed if you use the @samp{-nx} option; @pxref{Mode Options,
-,Choosing Modes}.) You can also request the execution of a command
-file with the @code{source} command:
+@cindex @file{@value{GDBINIT}}
+When you start @value{GDBN}, it automatically executes commands from its
+@dfn{init files}. These are files named @file{@value{GDBINIT}}.
+@value{GDBN} reads the init file (if any) in your home directory, then
+processes command line options and operands, and then reads the init
+file (if any) in the current working directory. This is so the init
+file in your home directory can set options (such as @code{set
+complaints}) which affect the processing of the command line options and
+operands. The init files are not executed if you use the @samp{-nx}
+option; @pxref{Mode Options, ,Choosing modes}.
+
+@ifset GENERIC
+@cindex init file name
+On some configurations of @value{GDBN}, the init file is known by a
+different name (these are typically environments where a specialized
+form of GDB may need to coexist with other forms, hence a different name
+for the specialized version's init file). These are the environments
+with special init file names:
+
+@itemize @bullet
+@kindex .vxgdbinit
+@item
+VxWorks (Wind River Systems real-time OS): @samp{.vxgdbinit}
+
+@kindex .os68gdbinit
+@item
+OS68K (Enea Data Systems real-time OS): @samp{.os68gdbinit}
+
+@kindex .esgdbinit
+@item
+ES-1800 (Ericsson Telecom AB M68000 emulator): @samp{.esgdbinit}
+@end itemize
+@end ifset
+
+You can also request the execution of a command file with the
+@code{source} command:
@table @code
@item source @var{filename}
of the command file.
Commands that would ask for confirmation if used interactively proceed
-without asking when used in a command file. Many _GDBN__ commands that
+without asking when used in a command file. Many @value{GDBN} commands that
normally print messages to say what they are doing omit the messages
when called from command files.
-@node Output, , Command Files, Sequences
-@section Commands for Controlled Output
+@node Output
+@section Commands for controlled output
During the execution of a command file or a user-defined command, normal
-_GDBN__ output is suppressed; the only output that appears is what is
+@value{GDBN} output is suppressed; the only output that appears is what is
explicitly printed by the commands in the definition. This section
describes three commands useful for generating exactly the output you
want.
@var{text} using C escape sequences, such as @samp{\n} to print a
newline. @strong{No newline will be printed unless you specify one.}
In addition to the standard C escape sequences, a backslash followed
-by a space stands for a space. This is useful for outputting a
+by a space stands for a space. This is useful for displaying a
string with spaces at the beginning or the end, since leading and
trailing spaces are otherwise trimmed from all arguments.
To print @samp{@w{ }and foo =@w{ }}, use the command
@item output/@var{fmt} @var{expression}
Print the value of @var{expression} in format @var{fmt}. You can use
-the same formats as for @code{print}; @pxref{Output formats}, for more
-information.
+the same formats as for @code{print}. @xref{Output Formats,,Output
+formats}, for more information.
@item printf @var{string}, @var{expressions}@dots{}
@kindex printf
Print the values of the @var{expressions} under the control of
-@var{string}. The @var{expressions} are separated by commas and may
-be either numbers or pointers. Their values are printed as specified
-by @var{string}, exactly as if your program were to execute
+@var{string}. The @var{expressions} are separated by commas and may be
+either numbers or pointers. Their values are printed as specified by
+@var{string}, exactly as if your program were to execute the C
+subroutine
@example
printf (@var{string}, @var{expressions}@dots{});
For example, you can print two values in hex like this:
-@example
+@smallexample
printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo
-@end example
+@end smallexample
The only backslash-escape sequences that you can use in the format
string are the simple ones that consist of backslash followed by a
letter.
@end table
-_if__(_LUCID__)
-@node Emacs, Energize, Sequences, Top
-_fi__(_LUCID__)
-_if__(!_LUCID__)
-@node Emacs, _GDBN__ Bugs, Sequences, Top
-_fi__(!_LUCID__)
-@chapter Using _GDBN__ under GNU Emacs
+@ifclear DOSHOST
+@node Emacs
+@chapter Using @value{GDBN} under GNU Emacs
@cindex emacs
A special interface allows you to use GNU Emacs to view (and
edit) the source files for the program you are debugging with
-_GDBN__.
+@value{GDBN}.
To use this interface, use the command @kbd{M-x gdb} in Emacs. Give the
executable file you want to debug as an argument. This command starts
-_GDBN__ as a subprocess of Emacs, with input and output through a newly
+@value{GDBN} as a subprocess of Emacs, with input and output through a newly
created Emacs buffer.
-Using _GDBN__ under Emacs is just like using _GDBN__ normally except for two
+Using @value{GDBN} under Emacs is just like using @value{GDBN} normally except for two
things:
@itemize @bullet
All ``terminal'' input and output goes through the Emacs buffer.
@end itemize
-This applies both to _GDBN__ commands and their output, and to the input
+This applies both to @value{GDBN} commands and their output, and to the input
and output done by the program you are debugging.
This is useful because it means that you can copy the text of previous
@itemize @bullet
@item
-_GDBN__ displays source code through Emacs.
+@value{GDBN} displays source code through Emacs.
@end itemize
-Each time _GDBN__ displays a stack frame, Emacs automatically finds the
-source file for that frame and puts an arrow (_0__@samp{=>}_1__) at the
+Each time @value{GDBN} displays a stack frame, Emacs automatically finds the
+source file for that frame and puts an arrow (@samp{=>}) at the
left margin of the current line. Emacs uses a separate buffer for
-source display, and splits the window to show both your _GDBN__ session
+source display, and splits the screen to show both your @value{GDBN} session
and the source.
-Explicit _GDBN__ @code{list} or search commands still produce output as
+Explicit @value{GDBN} @code{list} or search commands still produce output as
usual, but you probably will have no reason to use them.
@quotation
@emph{Warning:} If the directory where your program resides is not your
current directory, it can be easy to confuse Emacs about the location of
the source files, in which case the auxiliary display buffer will not
-appear to show your source. _GDBN__ can find programs by searching your
-environment's @code{PATH} variable, so the _GDBN__ input and output
+appear to show your source. @value{GDBN} can find programs by searching your
+environment's @code{PATH} variable, so the @value{GDBN} input and output
session will proceed normally; but Emacs does not get enough information
-back from _GDBN__ to locate the source files in this situation. To
-avoid this problem, either start _GDBN__ mode from the directory where
+back from @value{GDBN} to locate the source files in this situation. To
+avoid this problem, either start @value{GDBN} mode from the directory where
your program resides, or specify a full path name when prompted for the
@kbd{M-x gdb} argument.
-A similar confusion can result if you use the _GDBN__ @code{file} command to
+A similar confusion can result if you use the @value{GDBN} @code{file} command to
switch to debugging a program in some other location, from an existing
-_GDBN__ buffer in Emacs.
+@value{GDBN} buffer in Emacs.
@end quotation
By default, @kbd{M-x gdb} calls the program called @file{gdb}. If
-you need to call _GDBN__ by a different name (for example, if you keep
+you need to call @value{GDBN} by a different name (for example, if you keep
several configurations around, with different names) you can set the
Emacs variable @code{gdb-command-name}; for example,
in your @file{.emacs} file) will make Emacs call the program named
``@code{mygdb}'' instead.
-In the _GDBN__ I/O buffer, you can use these special Emacs commands in
+In the @value{GDBN} I/O buffer, you can use these special Emacs commands in
addition to the standard Shell mode commands:
@table @kbd
@item C-h m
-Describe the features of Emacs' _GDBN__ Mode.
+Describe the features of Emacs' @value{GDBN} Mode.
@item M-s
-Execute to another source line, like the _GDBN__ @code{step} command; also
+Execute to another source line, like the @value{GDBN} @code{step} command; also
update the display window to show the current file and location.
@item M-n
Execute to next source line in this function, skipping all function
-calls, like the _GDBN__ @code{next} command. Then update the display window
+calls, like the @value{GDBN} @code{next} command. Then update the display window
to show the current file and location.
@item M-i
-Execute one instruction, like the _GDBN__ @code{stepi} command; update
+Execute one instruction, like the @value{GDBN} @code{stepi} command; update
display window accordingly.
@item M-x gdb-nexti
-Execute to next instruction, using the _GDBN__ @code{nexti} command; update
+Execute to next instruction, using the @value{GDBN} @code{nexti} command; update
display window accordingly.
@item C-c C-f
-Execute until exit from the selected stack frame, like the _GDBN__
+Execute until exit from the selected stack frame, like the @value{GDBN}
@code{finish} command.
@item M-c
-Continue execution of your program, like the _GDBN__ @code{continue}
+Continue execution of your program, like the @value{GDBN} @code{continue}
command.
@emph{Warning:} In Emacs v19, this command is @kbd{C-c C-p}.
@item M-u
Go up the number of frames indicated by the numeric argument
(@pxref{Arguments, , Numeric Arguments, emacs, The GNU Emacs Manual}),
-like the _GDBN__ @code{up} command.
+like the @value{GDBN} @code{up} command.
@emph{Warning:} In Emacs v19, this command is @kbd{C-c C-u}.
@item M-d
Go down the number of frames indicated by the numeric argument, like the
-_GDBN__ @code{down} command.
+@value{GDBN} @code{down} command.
@emph{Warning:} In Emacs v19, this command is @kbd{C-c C-d}.
@item C-x &
Read the number where the cursor is positioned, and insert it at the end
-of the _GDBN__ I/O buffer. For example, if you wish to disassemble code
+of the @value{GDBN} I/O buffer. For example, if you wish to disassemble code
around an address that was displayed earlier, type @kbd{disassemble};
then move the cursor to the address display, and pick up the
argument for @code{disassemble} by typing @kbd{C-x &}.
-You can customize this further on the fly by defining elements of the list
+You can customize this further by defining elements of the list
@code{gdb-print-command}; once it is defined, you can format or
otherwise process numbers picked up by @kbd{C-x &} before they are
inserted. A numeric argument to @kbd{C-x &} will both indicate that you
@end table
In any source file, the Emacs command @kbd{C-x SPC} (@code{gdb-break})
-tells _GDBN__ to set a breakpoint on the source line point is on.
+tells @value{GDBN} to set a breakpoint on the source line point is on.
If you accidentally delete the source-display buffer, an easy way to get
-it back is to type the command @code{f} in the _GDBN__ buffer, to
+it back is to type the command @code{f} in the @value{GDBN} buffer, to
request a frame display; when you run under Emacs, this will recreate
the source buffer if necessary to show you the context of the current
frame.
The source files displayed in Emacs are in ordinary Emacs buffers
which are visiting the source files in the usual way. You can edit
-the files with these buffers if you wish; but keep in mind that _GDBN__
+the files with these buffers if you wish; but keep in mind that @value{GDBN}
communicates with Emacs in terms of line numbers. If you add or
-delete lines from the text, the line numbers that _GDBN__ knows will cease
-to correspond properly to the code.
+delete lines from the text, the line numbers that @value{GDBN} knows will cease
+to correspond properly with the code.
@c The following dropped because Epoch is nonstandard. Reactivate
@c if/when v19 does something similar. ---pesch@cygnus.com 19dec1990
@code{inspect} which performs identically to @code{print} except that
each value is printed in its own window.
@end ignore
+@end ifclear
-_if__(_LUCID__)
-@node Energize, _GDBN__ Bugs, Emacs, Top
-@chapter Using _GDBN__ with Energize
+@ifset LUCID
+@node Energize
+@chapter Using @value{GDBN} with Energize
@cindex Energize
The Energize Programming System is an integrated development environment
that includes a point-and-click interface to many programming tools.
-When you use _GDBN__ in this environment, you can use the standard
-Energize graphical interface to drive _GDBN__; you can also, if you
-choose, type _GDBN__ commands as usual in a debugging window. Even if
+When you use @value{GDBN} in this environment, you can use the standard
+Energize graphical interface to drive @value{GDBN}; you can also, if you
+choose, type @value{GDBN} commands as usual in a debugging window. Even if
you use the graphical interface, the debugging window (which uses Emacs,
-and resembles the standard Emacs interface to _GDBN__) displays the
+and resembles the standard Emacs interface to @value{GDBN}) displays the
equivalent commands, so that the history of your debugging session is
properly reflected.
-When Energize starts up a _GDBN__ session, it uses one of the
+When Energize starts up a @value{GDBN} session, it uses one of the
command-line options @samp{-energize} or @samp{-cadillac} (``cadillac''
is the name of the communications protocol used by the Energize system).
-This option makes _GDBN__ run as one of the tools in the Energize Tool
+This option makes @value{GDBN} run as one of the tools in the Energize Tool
Set: it sends all output to the Energize kernel, and accept input from
it as well.
See the user manual for the Energize Programming System for
information on how to use the Energize graphical interface and the other
-development tools that Energize integrates with _GDBN__.
+development tools that Energize integrates with @value{GDBN}.
-@node _GDBN__ Bugs, Renamed Commands, Energize, Top
-_fi__(_LUCID__)
-_if__(!_LUCID__)
-@node _GDBN__ Bugs, Renamed Commands, Emacs, Top
-_fi__(!_LUCID__)
-@chapter Reporting Bugs in _GDBN__
-@cindex Bugs in _GDBN__
-@cindex Reporting Bugs in _GDBN__
+@end ifset
-Your bug reports play an essential role in making _GDBN__ reliable.
+@node GDB Bugs
+@chapter Reporting Bugs in @value{GDBN}
+@cindex bugs in @value{GDBN}
+@cindex reporting bugs in @value{GDBN}
+
+Your bug reports play an essential role in making @value{GDBN} reliable.
Reporting a bug may help you by bringing a solution to your problem, or it
may not. But in any case the principal function of a bug report is to help
-the entire community by making the next version of _GDBN__ work better. Bug
-reports are your contribution to the maintenance of _GDBN__.
+the entire community by making the next version of @value{GDBN} work better. Bug
+reports are your contribution to the maintenance of @value{GDBN}.
In order for a bug report to serve its purpose, you must include the
information that enables us to fix the bug.
@menu
-* Bug Criteria:: Have You Found a Bug?
-* Bug Reporting:: How to Report Bugs
+* Bug Criteria:: Have you found a bug?
+* Bug Reporting:: How to report bugs
@end menu
-@node Bug Criteria, Bug Reporting, _GDBN__ Bugs, _GDBN__ Bugs
-@section Have You Found a Bug?
-@cindex Bug Criteria
+@node Bug Criteria
+@section Have you found a bug?
+@cindex bug criteria
If you are not sure whether you have found a bug, here are some guidelines:
@itemize @bullet
@item
-@cindex Fatal Signal
-@cindex Core Dump
+@cindex fatal signal
+@cindex debugger crash
+@cindex crash of debugger
If the debugger gets a fatal signal, for any input whatever, that is a
-_GDBN__ bug. Reliable debuggers never crash.
+@value{GDBN} bug. Reliable debuggers never crash.
@item
-@cindex error on Valid Input
-If _GDBN__ produces an error message for valid input, that is a bug.
+@cindex error on valid input
+If @value{GDBN} produces an error message for valid input, that is a bug.
@item
-@cindex Invalid Input
-If _GDBN__ does not produce an error message for invalid input,
+@cindex invalid input
+If @value{GDBN} does not produce an error message for invalid input,
that is a bug. However, you should note that your idea of
``invalid input'' might be our idea of ``an extension'' or ``support
for traditional practice''.
@item
If you are an experienced user of debugging tools, your suggestions
-for improvement of _GDBN__ are welcome in any case.
+for improvement of @value{GDBN} are welcome in any case.
@end itemize
-@node Bug Reporting, , Bug Criteria, _GDBN__ Bugs
-@section How to Report Bugs
-@cindex Bug Reports
-@cindex _GDBN__ Bugs, Reporting
+@node Bug Reporting
+@section How to report bugs
+@cindex bug reports
+@cindex @value{GDBN} bugs, reporting
A number of companies and individuals offer support for GNU products.
-If you obtained _GDBN__ from a support organization, we recommend you
+If you obtained @value{GDBN} from a support organization, we recommend you
contact that organization first.
-Contact information for many support companies and individuals is
-available in the file @file{etc/SERVICE} in the GNU Emacs distribution.
+You can find contact information for many support companies and
+individuals in the file @file{etc/SERVICE} in the GNU Emacs
+distribution.
-In any event, we also recommend that you send bug reports for _GDBN__ to one
+In any event, we also recommend that you send bug reports for @value{GDBN} to one
of these addresses:
@example
@end example
@strong{Do not send bug reports to @samp{info-gdb}, or to
-@samp{help-gdb}, or to any newsgroups.} Most users of _GDBN__ do not want to
+@samp{help-gdb}, or to any newsgroups.} Most users of @value{GDBN} do not want to
receive bug reports. Those that do, have arranged to receive @samp{bug-gdb}.
The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which
@itemize @bullet
@item
-The version of _GDBN__. _GDBN__ announces it if you start with no
+The version of @value{GDBN}. @value{GDBN} announces it if you start with no
arguments; you can also print it at any time using @code{show version}.
Without this, we will not know whether there is any point in looking for
-the bug in the current version of _GDBN__.
+the bug in the current version of @value{GDBN}.
@item
The type of machine you are using, and the operating system name and
version number.
@item
-What compiler (and its version) was used to compile _GDBN__---e.g.
-``_GCC__-2.0''.
+What compiler (and its version) was used to compile @value{GDBN}---e.g.
+``@value{GCC}--2.0''.
@item
What compiler (and its version) was used to compile the program you
-are debugging---e.g. ``_GCC__-2.0''.
+are debugging---e.g. ``@value{GCC}--2.0''.
@item
The command arguments you gave the compiler to compile your example and
A description of what behavior you observe that you believe is
incorrect. For example, ``It gets a fatal signal.''
-Of course, if the bug is that _GDBN__ gets a fatal signal, then we will
+Of course, if the bug is that @value{GDBN} gets a fatal signal, then we will
certainly notice it. But if the bug is incorrect output, we might not
notice unless it is glaringly wrong. We are human, after all. You
might as well not give us a chance to make a mistake.
Even if the problem you experience is a fatal signal, you should still
say so explicitly. Suppose something strange is going on, such as,
-your copy of _GDBN__ is out of synch, or you have encountered a
+your copy of @value{GDBN} is out of synch, or you have encountered a
bug in the C library on your system. (This has happened!) Your copy
might crash and ours would not. If you told us to expect a crash,
then when ours fails to crash, we would know that the bug was not
would not be able to draw any conclusion from our observations.
@item
-If you wish to suggest changes to the _GDBN__ source, send us context
-diffs. If you even discuss something in the _GDBN__ source, refer to
+If you wish to suggest changes to the @value{GDBN} source, send us context
+diffs. If you even discuss something in the @value{GDBN} source, refer to
it by context, not by line number.
The line numbers in our development sources will not match those in your
a patch is all we need. We might see problems with your patch and decide
to fix the problem another way, or we might not understand it at all.
-Sometimes with a program as complicated as _GDBN__ it is very hard to
+Sometimes with a program as complicated as @value{GDBN} it is very hard to
construct an example that will make the program follow a certain path
through the code. If you do not send us the example, we will not be able
to construct one, so we will not be able to verify that the bug is fixed.
things without first using the debugger to find the facts.
@end itemize
-@c Note: no need to update nodes for rdl-apps.texi since it appears
-@c *only* in the TeX version of the manual.
-@c Note: eventually, make a cross reference to the readline Info nodes.
-@iftex
-@c appendices describing GNU readline. Distributed with readline code.
+@c The readline documentation is distributed with the readline code
+@c and consists of the two following files:
+@c rluser.texinfo
+@c inc-hist.texi
+@c Use -I with makeinfo to point to the appropriate directory,
+@c environment var TEXINPUTS with TeX.
@include rluser.texinfo
@include inc-hist.texi
-@end iftex
-@node Renamed Commands, Formatting Documentation, _GDBN__ Bugs, Top
+@ifset NOVEL
+@node Renamed Commands
@appendix Renamed Commands
The following commands were renamed in GDB 4, in order to make the
}
@end tex
@c END TEXI2ROFF-KILL
+@end ifset
-@node Formatting Documentation, Installing GDB, Renamed Commands, Top
-@appendix Formatting the Documentation
+@ifclear PRECONFIGURED
+@node Formatting Documentation
+@appendix Formatting Documentation
@cindex GDB reference card
@cindex reference card
The GDB 4 release includes an already-formatted reference card, ready
-for printing on a PostScript or GhostScript printer, in the @file{gdb}
-subdirectory of the main source directory---in
-@file{gdb-_GDB_VN__/gdb/refcard.ps} of the version _GDB_VN__ release. If you have
-a PostScript or GhostScript printer, you can print the reference card
-by just sending @file{refcard.ps} to the printer.
+for printing with PostScript or GhostScript, in the @file{gdb}
+subdirectory of the main source directory@footnote{In
+@file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN}
+release.}. If you can use PostScript or GhostScript with your printer,
+you can print the reference card immediately with @file{refcard.ps}.
The release also includes the source for the reference card. You
can format it, using @TeX{}, by typing:
@code{makeinfo}.
If you have @code{makeinfo} installed, and are in the top level GDB
-source directory (@file{gdb-_GDB_VN__}, in the case of version _GDB_VN__), you can
+source directory (@file{gdb-@value{GDBVN}}, in the case of version @value{GDBVN}), you can
make the Info file by typing:
@example
make gdb.info
@end example
-If you want to typeset and print copies of this manual, you need
-@TeX{}, a printing program such as @code{lpr}, and @file{texinfo.tex},
-the Texinfo definitions file.
+If you want to typeset and print copies of this manual, you need @TeX{},
+a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the
+Texinfo definitions file.
-@TeX{} is typesetting program; it does not print files directly, but
+@TeX{} is a typesetting program; it does not print files directly, but
produces output files called @sc{dvi} files. To print a typeset
document, you need a program to print @sc{dvi} files. If your system
has @TeX{} installed, chances are it has such a program. The precise
command to use depends on your system; @kbd{lpr -d} is common; another
-is @kbd{dvips}. The @sc{dvi} print command may require a file name
-without any extension or a @samp{.dvi} extension.
+(for PostScript devices) is @kbd{dvips}. The @sc{dvi} print command may
+require a file name without any extension or a @samp{.dvi} extension.
@TeX{} also requires a macro definitions file called
@file{texinfo.tex}. This file tells @TeX{} how to typeset a document
If you have @TeX{} and a @sc{dvi} printer program installed, you can
typeset and print this manual. First switch to the the @file{gdb}
subdirectory of the main source directory (for example, to
-@file{gdb-_GDB_VN__/gdb}) and then type:
+@file{gdb-@value{GDBVN}/gdb}) and then type:
@example
make gdb.dvi
@end example
-@node Installing GDB, Copying, Formatting Documentation, Top
+@node Installing GDB
@appendix Installing GDB
@cindex configuring GDB
@cindex installation
+GDB comes with a @code{configure} script that automates the process
+of preparing GDB for installation; you can then use @code{make} to
+build the @code{gdb} program.
@iftex
@c irrelevant in info file; it's as current as the code it lives with.
-@quotation
-@emph{Warning:} These installation instructions are current as of
-GDB version _GDB_VN__. If you're installing a more recent release
-of GDB, we may have improved the installation procedures since
-printing this manual; see the @file{README} file included in your
-release for the most recent instructions.
-@end quotation
+@footnote{If you have a more recent version of GDB than @value{GDBVN},
+look at the @file{README} file in the sources; we may have improved the
+installation procedures since publishing this manual.}
@end iftex
-GDB comes with a @code{configure} script that automates the process
-of preparing GDB for installation; you can then use @code{make} to
-build the program.
-
The GDB distribution includes all the source code you need for GDB in
a single directory, whose name is usually composed by appending the
version number to @samp{gdb}.
-For example, the GDB version _GDB_VN__ distribution is in the @file{gdb-_GDB_VN__}
-directory. That directory contains:
+For example, the GDB version @value{GDBVN} distribution is in the
+@file{gdb-@value{GDBVN}} directory. That directory contains:
@table @code
-@item gdb-_GDB_VN__/configure @r{(and supporting files)}
+@item gdb-@value{GDBVN}/configure @r{(and supporting files)}
script for configuring GDB and all its supporting libraries.
-@item gdb-_GDB_VN__/gdb
+@item gdb-@value{GDBVN}/gdb
the source specific to GDB itself
-@item gdb-_GDB_VN__/bfd
+@item gdb-@value{GDBVN}/bfd
source for the Binary File Descriptor library
-@item gdb-_GDB_VN__/include
+@item gdb-@value{GDBVN}/include
GNU include files
-@item gdb-_GDB_VN__/libiberty
+@item gdb-@value{GDBVN}/libiberty
source for the @samp{-liberty} free software library
-@item gdb-_GDB_VN__/readline
+@item gdb-@value{GDBVN}/opcodes
+source for the library of opcode tables and disassemblers
+
+@item gdb-@value{GDBVN}/readline
source for the GNU command-line interface
-@item gdb-_GDB_VN__/glob
+@item gdb-@value{GDBVN}/glob
source for the GNU filename pattern-matching subroutine
-@item gdb-_GDB_VN__/mmalloc
+@item gdb-@value{GDBVN}/mmalloc
source for the GNU memory-mapped malloc package
@end table
The simplest way to configure and build GDB is to run @code{configure}
from the @file{gdb-@var{version-number}} source directory, which in
-this example is the @file{gdb-_GDB_VN__} directory.
+this example is the @file{gdb-@value{GDBVN}} directory.
First switch to the @file{gdb-@var{version-number}} source directory
if you are not already in it; then run @code{configure}. Pass the
For example:
@example
-cd gdb-_GDB_VN__
+cd gdb-@value{GDBVN}
./configure @var{host}
make
@end example
@noindent
where @var{host} is an identifier such as @samp{sun4} or
@samp{decstation}, that identifies the platform where GDB will run.
+(You can often leave off @var{host}; @code{configure} tries to guess the
+correct value by examining your system.)
-Running @samp{configure @var{host}} followed by @code{make} builds the
+Running @samp{configure @var{host}} and then running @code{make} builds the
@file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty}
libraries, then @code{gdb} itself. The configured source files, and the
binaries, are left in the corresponding source directories.
If you run @code{configure} from a directory that contains source
directories for multiple libraries or programs, such as the
-@file{gdb-_GDB_VN__} source directory for version _GDB_VN__, @code{configure}
+@file{gdb-@value{GDBVN}} source directory for version @value{GDBVN}, @code{configure}
creates configuration files for every directory level underneath (unless
you tell it not to, with the @samp{--norecursion} option).
You can run the @code{configure} script from any of the
-subordinate directories in the GDB distribution, if you only want to
-configure that subdirectory; but be sure to specify a path to it.
+subordinate directories in the GDB distribution if you only want to
+configure that subdirectory, but be sure to specify a path to it.
-For example, with version _GDB_VN__, type the following to configure only
+For example, with version @value{GDBVN}, type the following to configure only
the @code{bfd} subdirectory:
@example
@group
-cd gdb-_GDB_VN__/bfd
+cd gdb-@value{GDBVN}/bfd
../configure @var{host}
@end group
@end example
-You can install @code{_GDBP__} anywhere; it has no hardwired paths.
+You can install @code{@value{GDBP}} anywhere; it has no hardwired paths.
However, you should make sure that the shell on your path (named by
the @samp{SHELL} environment variable) is publicly readable. Remember
that GDB uses the shell to start your program---some systems refuse to
* configure Options:: Summary of options for configure
@end menu
-@node Separate Objdir, Config Names, Installing GDB, Installing GDB
-@section Compiling GDB in Another Directory
+@node Separate Objdir
+@section Compiling GDB in another directory
If you want to run GDB versions for several host or target machines,
-you'll need a different @code{gdb} compiled for each combination of
+you need a different @code{gdb} compiled for each combination of
host and target. @code{configure} is designed to make this easy by
allowing you to generate each configuration in a separate subdirectory,
rather than in the source directory. If your @code{make} program
handles the @samp{VPATH} feature (GNU @code{make} does), running
-@code{make} in each of these directories then builds the @code{gdb}
+@code{make} in each of these directories builds the @code{gdb}
program specified there.
To build @code{gdb} in a separate directory, run @code{configure}
with the @samp{--srcdir} option to specify where to find the source.
-(You'll also need to specify a path to find @code{configure}
+(You also need to specify a path to find @code{configure}
itself from your working directory. If the path to @code{configure}
would be the same as the argument to @samp{--srcdir}, you can leave out
the @samp{--srcdir} option; it will be assumed.)
-For example, with version _GDB_VN__, you can build GDB in a separate
+For example, with version @value{GDBVN}, you can build GDB in a separate
directory for a Sun 4 like this:
@example
@group
-cd gdb-_GDB_VN__
+cd gdb-@value{GDBVN}
mkdir ../gdb-sun4
cd ../gdb-sun4
-../gdb-_GDB_VN__/configure sun4
+../gdb-@value{GDBVN}/configure sun4
make
@end group
@end example
it in a configured directory---whatever directory you were in when you
called @code{configure} (or one of its subdirectories).
-The @code{Makefile} generated by @code{configure} for each source
+The @code{Makefile} that @code{configure} generates in each source
directory also runs recursively. If you type @code{make} in a source
-directory such as @file{gdb-_GDB_VN__} (or in a separate configured
-directory configured with @samp{--srcdir=@var{path}/gdb-_GDB_VN__}), you
-will build all the required libraries, then build GDB.
+directory such as @file{gdb-@value{GDBVN}} (or in a separate configured
+directory configured with @samp{--srcdir=@var{path}/gdb-@value{GDBVN}}), you
+will build all the required libraries, and then build GDB.
When you have multiple hosts or targets configured in separate
directories, you can run @code{make} on them in parallel (for example,
if they are NFS-mounted on each of the hosts); they will not interfere
with each other.
-@node Config Names, configure Options, Separate Objdir, Installing GDB
-@section Specifying Names for Hosts and Targets
+@node Config Names
+@section Specifying names for hosts and targets
The specifications used for hosts and targets in the @code{configure}
script are based on a three-part naming scheme, but some short predefined
@var{architecture}-@var{vendor}-@var{os}
@end example
-For example, you can use the alias @code{sun4} as a @var{host} argument
-or in a @code{--target=@var{target}} option, but the equivalent full name
-is @samp{sparc-sun-sunos4}.
-
-@c @group would be better, if it worked
-@page
-The following table shows all the architectures, hosts, and OS
-prefixes that @code{configure} recognizes in GDB version _GDB_VN__. Entries
-in the ``OS prefix'' column ending in a @samp{*} may be followed by a
-release number.
-
-@c FIXME! Update for most recent gdb
-@c TEXI2ROFF-KILL
-@ifinfo
-@c END TEXI2ROFF-KILL
-@example
-
-ARCHITECTURE VENDOR OS prefix
-@c TEXI2ROFF-KILL
-------------+--------------------------+---------------------------
-@c END TEXI2ROFF-KILL
- | |
- 580 | altos hp | aix* msdos*
- a29k | amd ibm | amigados newsos*
- alliant | amdahl intel | aout nindy*
- arm | aout isi | bout osf*
- c1 | apollo little | bsd* sco*
- c2 | att mips | coff sunos*
- cray2 | bcs motorola | ctix* svr4
- h8300 | bout ncr | dgux* sym*
- i386 | bull next | dynix* sysv*
- i860 | cbm nyu | ebmon ultrix*
- i960 | coff sco | esix* unicos*
- m68000 | convergent sequent | hds unos*
- m68k | convex sgi | hpux* uts
- m88k | cray sony | irix* v88r*
- mips | dec sun | isc* vms*
- ns32k | encore unicom | kern vxworks*
- pyramid | gould utek | mach*
- romp | hitachi wrs |
- rs6000 | |
- sparc | |
- tahoe | |
- tron | |
- vax | |
- xmp | |
- ymp | |
-@end example
-
-@c TEXI2ROFF-KILL
-@end ifinfo
-@tex
-%\vskip\parskip
-\vskip \baselineskip
-\hfil\vbox{\offinterlineskip
-\halign{\strut\tt #\hfil\ &\vrule#&\strut\ \tt #\hfil\ &\strut\ \tt #\hfil
-\ &\vrule#&\strut\ \tt #\hfil\ &\strut\ \tt #\hfil \cr
-{\bf Architecture} &&{\bf Vendor} &&&{\bf OS prefix}\cr
-\multispan7\hrulefill\cr
- 580 && altos & hp && aix* & msdos* \cr
- a29k && amd & ibm && amigados & newsos* \cr
- alliant && amdahl & intel && aout & nindy* \cr
- arm && aout & isi && bout & osf* \cr
- c1 && apollo & little && bsd* & sco* \cr
- c2 && att & mips && coff & sunos* \cr
- cray2 && bcs & motorola && ctix* & svr4 \cr
- h8300 && bout & ncr && dgux* & sym* \cr
- i386 && bull & next && dynix* & sysv* \cr
- i860 && cbm & nyu && ebmon & ultrix* \cr
- i960 && coff & sco && esix* & unicos* \cr
- m68000 && convergent& sequent && hds & unos* \cr
- m68k && convex & sgi && hpux* & uts \cr
- m88k && cray & sony && irix* & v88r* \cr
- mips && dec & sun && isc* & vms* \cr
- ns32k && encore & unicom && kern & vxworks* \cr
- pyramid && gould & utek && mach* & \cr
- romp && hitachi & wrs && & \cr
- rs6000 && & && & \cr
- sparc && & && & \cr
- tahoe && & && & \cr
- tron && & && & \cr
- vax && & && & \cr
- xmp && & && & \cr
- ymp && & && & \cr
-}\hfil}
-@end tex
-@c END TEXI2ROFF-KILL
-
-@quotation
-@emph{Warning:} @code{configure} can represent a very large number of
-combinations of architecture, vendor, and OS. There is by no means
-support available for all possible combinations!
-@end quotation
+For example, you can use the alias @code{sun4} as a @var{host} argument,
+or as the value for @var{target} in a @code{--target=@var{target}}
+option. The equivalent full name is @samp{sparc-sun-sunos4}.
The @code{configure} script accompanying GDB does not provide
any query facility to list all supported host and target names or
script, if you wish, or you can use it to test your guesses on
abbreviations---for example:
-@example
+@smallexample
% sh config.sub sun4
-sparc-sun-sunos4
+sparc-sun-sunos4.1.1
% sh config.sub sun3
-m68k-sun-sunos4
+m68k-sun-sunos4.1.1
% sh config.sub decstation
-mips-dec-ultrix
+mips-dec-ultrix4.2
% sh config.sub hp300bsd
m68k-hp-bsd
% sh config.sub i386v
-i386-none-sysv
+i386-unknown-sysv
% sh config.sub i786v
-*** Configuration "i786v" not recognized
-@end example
+Invalid configuration `i786v': machine `i786v' not recognized
+@end smallexample
@noindent
@code{config.sub} is also distributed in the GDB source
-directory (@file{gdb-_GDB_VN__}, for version _GDB_VN__).
+directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}).
-@node configure Options, , Config Names, Installing GDB
-@section @code{configure} Options
+@node configure Options
+@section @code{configure} options
-Here is a summary of all the @code{configure} options and arguments that
-you might use for building GDB:
+Here is a summary of the @code{configure} options and arguments that
+are most often useful for building @value{GDBN}. @code{configure} also has
+several other options not listed here. @inforef{What Configure
+Does,,configure.info}, for a full explanation of @code{configure}.
+@c FIXME: Would this be more, or less, useful as an xref (ref to printed
+@c manual in the printed manual, ref to info file only from the info file)?
@example
-configure @r{[}--srcdir=@var{path}@r{]}
+configure @r{[}--help@r{]}
+ @r{[}--prefix=@var{dir}@r{]}
+ @r{[}--srcdir=@var{path}@r{]}
@r{[}--norecursion@r{]} @r{[}--rm@r{]}
@r{[}--target=@var{target}@r{]} @var{host}
@end example
@samp{--}.
@table @code
+@item --help
+Display a quick summary of how to invoke @code{configure}.
+
+@item -prefix=@var{dir}
+Configure the source to install programs and files under directory
+@file{@var{dir}}.
+
@item --srcdir=@var{path}
@strong{Warning: using this option requires GNU @code{make}, or another
@code{make} that implements the @code{VPATH} feature.}@*
propagate configuration to subdirectories.
@item --rm
-Remove the configuration that the other arguments specify.
+@emph{Remove} files otherwise built during configuration.
@c This does not work (yet if ever). FIXME.
@c @item --parse=@var{lang} @dots{}
@code{configure} accepts other options, for compatibility with
configuring other GNU tools recursively; but these are the only
options that affect GDB or its supporting libraries.
+@end ifclear
-@node Copying, Index, Installing GDB, Top
-@unnumbered GNU GENERAL PUBLIC LICENSE
-@center Version 2, June 1991
-
-@display
-Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
-675 Mass Ave, Cambridge, MA 02139, USA
-
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-@end display
-
-@unnumberedsec Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software---to make sure the software is free for all its users. This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it. (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.) You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
- To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have. You must make sure that they, too, receive or can get the
-source code. And you must show them these terms so they know their
-rights.
-
- We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
- Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
- Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
-@iftex
-@unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-@end iftex
-@ifinfo
-@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-@end ifinfo
-
-@enumerate
-@item
-This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License. The ``Program'', below,
-refers to any such program or work, and a ``work based on the Program''
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language. (Hereinafter, translation is included without limitation in
-the term ``modification''.) Each licensee is addressed as ``you''.
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
-@item
-You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
-@item
-You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
-@enumerate a
-@item
-You must cause the modified files to carry prominent notices
-stating that you changed the files and the date of any change.
-
-@item
-You must cause any work that you distribute or publish, that in
-whole or in part contains or is derived from the Program or any
-part thereof, to be licensed as a whole at no charge to all third
-parties under the terms of this License.
-
-@item
-If the modified program normally reads commands interactively
-when run, you must cause it, when started running for such
-interactive use in the most ordinary way, to print or display an
-announcement including an appropriate copyright notice and a
-notice that there is no warranty (or else, saying that you provide
-a warranty) and that users may redistribute the program under
-these conditions, and telling the user how to view a copy of this
-License. (Exception: if the Program itself is interactive but
-does not normally print such an announcement, your work based on
-the Program is not required to print an announcement.)
-@end enumerate
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-@item
-You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
-@enumerate a
-@item
-Accompany it with the complete corresponding machine-readable
-source code, which must be distributed under the terms of Sections
-1 and 2 above on a medium customarily used for software interchange; or,
-
-@item
-Accompany it with a written offer, valid for at least three
-years, to give any third party, for a charge no more than your
-cost of physically performing source distribution, a complete
-machine-readable copy of the corresponding source code, to be
-distributed under the terms of Sections 1 and 2 above on a medium
-customarily used for software interchange; or,
-
-@item
-Accompany it with the information you received as to the offer
-to distribute corresponding source code. (This alternative is
-allowed only for noncommercial distribution and only if you
-received the program in object code or executable form with such
-an offer, in accord with Subsection b above.)
-@end enumerate
-
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable. However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-@item
-You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-@item
-You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Program or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
-@item
-Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
-@item
-If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all. For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-@item
-If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded. In such case, this License incorporates
-the limitation as if written in the body of this License.
-
-@item
-The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and ``any
-later version'', you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation. If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
-@item
-If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission. For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
-@iftex
-@heading NO WARRANTY
-@end iftex
-@ifinfo
-@center NO WARRANTY
-@end ifinfo
-
-@item
-BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
-@item
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-@end enumerate
-
-@iftex
-@heading END OF TERMS AND CONDITIONS
-@end iftex
-@ifinfo
-@center END OF TERMS AND CONDITIONS
-@end ifinfo
-
-@page
-@unnumberedsec Applying These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the ``copyright'' line and a pointer to where the full notice is found.
-
-@smallexample
-@var{one line to give the program's name and an idea of what it does.}
-Copyright (C) 19@var{yy} @var{name of author}
-
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the
-Free Software Foundation, Inc., 675 Mass Ave,
-Cambridge, MA 02139, USA.
-@end smallexample
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
-@smallexample
-Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
-Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
-type `show w'. This is free software, and you are welcome
-to redistribute it under certain conditions; type `show c'
-for details.
-@end smallexample
-
-The hypothetical commands @samp{show w} and @samp{show c} should show
-the appropriate parts of the General Public License. Of course, the
-commands you use may be called something other than @samp{show w} and
-@samp{show c}; they could even be mouse-clicks or menu items---whatever
-suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a ``copyright disclaimer'' for the program, if
-necessary. Here is a sample; alter the names:
-
-@example
-Yoyodyne, Inc., hereby disclaims all copyright
-interest in the program `Gnomovision'
-(which makes passes at compilers) written
-by James Hacker.
-
-@var{signature of Ty Coon}, 1 April 1989
-Ty Coon, President of Vice
-@end example
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Library General
-Public License instead of this License.
-
-@node Index, , Copying, Top
+@node Index
@unnumbered Index
@printindex cp
projects / deliverable / binutils-gdb.git / blobdiff