gdb: gdb man
gdb man
=======
gdb ['-help'] ['-nh'] ['-nx'] ['-q'] ['-batch'] ['-cd='DIR] ['-f']
['-b' BPS] ['-tty='DEV] ['-s' SYMFILE] ['-e' PROG] ['-se' PROG]
['-c' CORE] ['-p' PROCID] ['-x' CMDS] ['-d' DIR] [PROG|PROG PROCID|PROG
CORE]
The purpose of a debugger such as GDB 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.
GDB can do four main kinds of things (plus other things in support of
these) to help you catch bugs in the act:
* Start your program, specifying anything that might affect its
behavior.
* Make your program stop on specified conditions.
* Examine what has happened, when your program has stopped.
* Change things in your program, so you can experiment with
correcting the effects of one bug and go on to learn about another.
You can use GDB to debug programs written in C, C++, Fortran and
Modula-2.
GDB is invoked with the shell command 'gdb'. Once started, it reads
commands from the terminal until you tell it to exit with the GDB
command 'quit'. You can get online help from GDB itself by using the
command 'help'.
You can run 'gdb' with no arguments or options; but the most usual
way to start GDB is with one argument or two, specifying an executable
program as the argument:
gdb program
You can also start with both an executable program and a core file
specified:
gdb program core
You can, instead, specify a process ID as a second argument, if you
want to debug a running process:
gdb program 1234
gdb -p 1234
would attach GDB to process '1234' (unless you also have a file named
'1234'; GDB does check for a core file first). With option '-p' you can
omit the PROGRAM filename.
Here are some of the most frequently needed GDB commands:
'break [FILE:]FUNCTION'
Set a breakpoint at FUNCTION (in FILE).
'run [ARGLIST]'
Start your program (with ARGLIST, if specified).
'bt'
Backtrace: display the program stack.
'print EXPR'
Display the value of an expression.
'c'
Continue running your program (after stopping, e.g. at a
breakpoint).
'next'
Execute next program line (after stopping); step _over_ any
function calls in the line.
'edit [FILE:]FUNCTION'
look at the program line where it is presently stopped.
'list [FILE:]FUNCTION'
type the text of the program in the vicinity of where it is
presently stopped.
'step'
Execute next program line (after stopping); step _into_ any
function calls in the line.
'help [NAME]'
Show information about GDB command NAME, or general information
about using GDB.
'quit'
Exit from GDB.
Any arguments other than options specify an executable file and core
file (or process ID); that is, the first argument encountered with no
associated option flag is equivalent to a '-se' option, and the second,
if any, is equivalent to a '-c' option if it's the name of a file. Many
options have both long and short forms; both are shown here. The long
forms are also recognized 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 '+' rather than '-', though we illustrate the more
usual convention.)
All the options and command line arguments you give are processed in
sequential order. The order makes a difference when the '-x' option is
used.
'-help'
'-h'
List all options, with brief explanations.
'-symbols=FILE'
'-s FILE'
Read symbol table from file FILE.
'-write'
Enable writing into executable and core files.
'-exec=FILE'
'-e FILE'
Use file FILE as the executable file to execute when appropriate,
and for examining pure data in conjunction with a core dump.
'-se=FILE'
Read symbol table from file FILE and use it as the executable file.
'-core=FILE'
'-c FILE'
Use file FILE as a core dump to examine.
'-command=FILE'
'-x FILE'
Execute GDB commands from file FILE.
'-ex COMMAND'
Execute given GDB COMMAND.
'-directory=DIRECTORY'
'-d DIRECTORY'
Add DIRECTORY to the path to search for source files.
'-nh'
Do not execute commands from '~/.gdbinit'.
'-nx'
'-n'
Do not execute commands from any '.gdbinit' initialization files.
'-quiet'
'-q'
"Quiet". Do not print the introductory and copyright messages.
These messages are also suppressed in batch mode.
'-batch'
Run in batch mode. Exit with status '0' after processing all the
command files specified with '-x' (and '.gdbinit', if not
inhibited). Exit with nonzero status if an error occurs in
executing the GDB commands in the command files.
Batch mode may be useful for running GDB as a filter, for example
to download and run a program on another computer; in order to make
this more useful, the message
Program exited normally.
(which is ordinarily issued whenever a program running under GDB
control terminates) is not issued when running in batch mode.
'-cd=DIRECTORY'
Run GDB using DIRECTORY as its working directory, instead of the
current directory.
'-fullname'
'-f'
Emacs sets this option when it runs GDB as a subprocess. It tells
GDB 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 the program stops). This recognizable format
looks like two '\032' characters, followed by the file name, line
number and character position separated by colons, and a newline.
The Emacs-to-GDB interface program uses the two '\032' characters
as a signal to display the source code for the frame.
'-b BPS'
Set the line speed (baud rate or bits per second) of any serial
interface used by GDB for remote debugging.
'-tty=DEVICE'
Run using DEVICE for your program's standard input and output.