gdb/
Convert man pages to texinfo, new gdbinit.5 texinfo page. * Makefile.in (gdb.z): Remove. (install-only): Remove $(man1dir) and gdb.1 installation. * gdb.1: Remove. gdb/gdbserver/ Convert man pages to texinfo, new gdbinit.5 texinfo page. * Makefile.in (install-only): Remove $(man1dir) and gdbserver.1 installation. * gdbserver.1: Remove. gdb/doc/ Convert man pages to texinfo, new gdbinit.5 texinfo page. * Makefile.in (mandir, man1dir, man5dir, SYSTEM_GDBINIT, MANCONF, (TEXI2POD, POD2MAN1, POD2MAN5, MAN1S, MAN5S, MANS, man): New. (diststuff): Add man. (install-man, install-man1, install-man5, uninstall-man, uninstall-man1) (uninstall-man5): New. (STAGESTUFF): Add *.1 and *.5. (GDBvn.texi): Add SYSTEM_GDBINIT. (gdb.1, gdbserver.1, gdbinit.5): New. (maintainer-clean realclean): Add $(MANS). (install): Add install-man. (uninstall): Add uninstall-man. * gdb.texinfo (@include gdb-cfg.texi): Wrap it by @c man begin INCLUDE. (@copying): Wrap it by @c man begin COPYRIGHT. (Top): Add Man Pages. (Man Pages, gdb man, gdbserver man, gdbinit man): New.
This commit is contained in:
Jan Kratochvil
parent
9ead1b844c
commit
43662968f1
@ -1,3 +1,10 @@
|
|||||||
|
2013-04-05 Jan Kratochvil <jan.kratochvil@redhat.com>
|
||||||
|
|
||||||
|
Convert man pages to texinfo, new gdbinit.5 texinfo page.
|
||||||
|
* Makefile.in (gdb.z): Remove.
|
||||||
|
(install-only): Remove $(man1dir) and gdb.1 installation.
|
||||||
|
* gdb.1: Remove.
|
||||||
|
|
||||||
2013-04-05 Jan Kratochvil <jan.kratochvil@redhat.com>
|
2013-04-05 Jan Kratochvil <jan.kratochvil@redhat.com>
|
||||||
|
|
||||||
Fix compatibility with Linux kernel 3.8.3.
|
Fix compatibility with Linux kernel 3.8.3.
|
||||||
|
|||||||
@ -1019,11 +1019,6 @@ check//%: force
|
|||||||
info install-info clean-info dvi pdf install-pdf html install-html: force
|
info install-info clean-info dvi pdf install-pdf html install-html: force
|
||||||
@$(MAKE) $(FLAGS_TO_PASS) DO=$@ "DODIRS=$(SUBDIRS)" subdir_do
|
@$(MAKE) $(FLAGS_TO_PASS) DO=$@ "DODIRS=$(SUBDIRS)" subdir_do
|
||||||
|
|
||||||
gdb.z:gdb.1
|
|
||||||
nroff -man $(srcdir)/gdb.1 | col -b > gdb.t
|
|
||||||
pack gdb.t ; rm -f gdb.t
|
|
||||||
mv gdb.t.z gdb.z
|
|
||||||
|
|
||||||
# Traditionally "install" depends on "all". But it may be useful
|
# Traditionally "install" depends on "all". But it may be useful
|
||||||
# not to; for example, if the user has made some trivial change to a
|
# not to; for example, if the user has made some trivial change to a
|
||||||
# source file and doesn't care about rebuilding or just wants to save the
|
# source file and doesn't care about rebuilding or just wants to save the
|
||||||
@ -1043,10 +1038,6 @@ install-only: $(CONFIG_INSTALL)
|
|||||||
$(SHELL) $(srcdir)/../mkinstalldirs $(DESTDIR)$(bindir) ; \
|
$(SHELL) $(srcdir)/../mkinstalldirs $(DESTDIR)$(bindir) ; \
|
||||||
$(INSTALL_PROGRAM) gdb$(EXEEXT) \
|
$(INSTALL_PROGRAM) gdb$(EXEEXT) \
|
||||||
$(DESTDIR)$(bindir)/$$transformed_name$(EXEEXT) ; \
|
$(DESTDIR)$(bindir)/$$transformed_name$(EXEEXT) ; \
|
||||||
$(SHELL) $(srcdir)/../mkinstalldirs \
|
|
||||||
$(DESTDIR)$(man1dir) ; \
|
|
||||||
$(INSTALL_DATA) $(srcdir)/gdb.1 \
|
|
||||||
$(DESTDIR)$(man1dir)/$$transformed_name.1 ; \
|
|
||||||
$(SHELL) $(srcdir)/../mkinstalldirs $(DESTDIR)$(includedir)/gdb ; \
|
$(SHELL) $(srcdir)/../mkinstalldirs $(DESTDIR)$(includedir)/gdb ; \
|
||||||
$(INSTALL_DATA) jit-reader.h $(DESTDIR)$(includedir)/gdb/jit-reader.h
|
$(INSTALL_DATA) jit-reader.h $(DESTDIR)$(includedir)/gdb/jit-reader.h
|
||||||
@$(MAKE) DO=install "DODIRS=$(SUBDIRS)" $(FLAGS_TO_PASS) subdir_do
|
@$(MAKE) DO=install "DODIRS=$(SUBDIRS)" $(FLAGS_TO_PASS) subdir_do
|
||||||
|
|||||||
@ -1,3 +1,22 @@
|
|||||||
|
2013-04-05 Jan Kratochvil <jan.kratochvil@redhat.com>
|
||||||
|
|
||||||
|
Convert man pages to texinfo, new gdbinit.5 texinfo page.
|
||||||
|
* Makefile.in (mandir, man1dir, man5dir, SYSTEM_GDBINIT, MANCONF,
|
||||||
|
(TEXI2POD, POD2MAN1, POD2MAN5, MAN1S, MAN5S, MANS, man): New.
|
||||||
|
(diststuff): Add man.
|
||||||
|
(install-man, install-man1, install-man5, uninstall-man, uninstall-man1)
|
||||||
|
(uninstall-man5): New.
|
||||||
|
(STAGESTUFF): Add *.1 and *.5.
|
||||||
|
(GDBvn.texi): Add SYSTEM_GDBINIT.
|
||||||
|
(gdb.1, gdbserver.1, gdbinit.5): New.
|
||||||
|
(maintainer-clean realclean): Add $(MANS).
|
||||||
|
(install): Add install-man.
|
||||||
|
(uninstall): Add uninstall-man.
|
||||||
|
* gdb.texinfo (@include gdb-cfg.texi): Wrap it by @c man begin INCLUDE.
|
||||||
|
(@copying): Wrap it by @c man begin COPYRIGHT.
|
||||||
|
(Top): Add Man Pages.
|
||||||
|
(Man Pages, gdb man, gdbserver man, gdbinit man): New.
|
||||||
|
|
||||||
2013-04-02 Pedro Alves <palves@redhat.com>
|
2013-04-02 Pedro Alves <palves@redhat.com>
|
||||||
|
|
||||||
* gdb.texinfo (Debugging Output): Document "set/show debug
|
* gdb.texinfo (Debugging Output): Document "set/show debug
|
||||||
|
|||||||
@ -26,6 +26,9 @@ datarootdir = @datarootdir@
|
|||||||
docdir = @docdir@
|
docdir = @docdir@
|
||||||
pdfdir = @pdfdir@
|
pdfdir = @pdfdir@
|
||||||
htmldir = @htmldir@
|
htmldir = @htmldir@
|
||||||
|
mandir = @mandir@
|
||||||
|
man1dir = $(mandir)/man1
|
||||||
|
man5dir = $(mandir)/man5
|
||||||
|
|
||||||
SHELL = @SHELL@
|
SHELL = @SHELL@
|
||||||
|
|
||||||
@ -35,6 +38,8 @@ INSTALL = @INSTALL@
|
|||||||
INSTALL_PROGRAM = @INSTALL_PROGRAM@
|
INSTALL_PROGRAM = @INSTALL_PROGRAM@
|
||||||
INSTALL_DATA = @INSTALL_DATA@
|
INSTALL_DATA = @INSTALL_DATA@
|
||||||
|
|
||||||
|
SYSTEM_GDBINIT = @SYSTEM_GDBINIT@
|
||||||
|
|
||||||
mkinstalldirs = $(SHELL) $(srcdir)/../../mkinstalldirs
|
mkinstalldirs = $(SHELL) $(srcdir)/../../mkinstalldirs
|
||||||
|
|
||||||
# main GDB source directory
|
# main GDB source directory
|
||||||
@ -160,6 +165,22 @@ ANNOTATE_DOC_FILES = \
|
|||||||
$(ANNOTATE_DOC_SOURCE_INCLUDES) \
|
$(ANNOTATE_DOC_SOURCE_INCLUDES) \
|
||||||
$(ANNOTATE_DOC_BUILD_INCLUDES)
|
$(ANNOTATE_DOC_BUILD_INCLUDES)
|
||||||
|
|
||||||
|
# Options to extract the man page from gdb.texinfo
|
||||||
|
MANCONF = -Dman
|
||||||
|
|
||||||
|
TEXI2POD = perl $(srcdir)/../../etc/texi2pod.pl \
|
||||||
|
$(MAKEINFOFLAGS) $(MAKEINFO_EXTRA_FLAGS)
|
||||||
|
|
||||||
|
POD2MAN1 = pod2man --center="GNU Development Tools" \
|
||||||
|
--release="gdb-$(VERSION)" --section=1
|
||||||
|
POD2MAN5 = pod2man --center="GNU Development Tools" \
|
||||||
|
--release="gdb-$(VERSION)" --section=5
|
||||||
|
|
||||||
|
# List of man pages generated from gdb.texi
|
||||||
|
MAN1S = gdb.1 gdbserver.1
|
||||||
|
MAN5S = gdbinit.5
|
||||||
|
MANS = $(MAN1S) $(MAN5S)
|
||||||
|
|
||||||
#### Host, target, and site specific Makefile fragments come in here.
|
#### Host, target, and site specific Makefile fragments come in here.
|
||||||
###
|
###
|
||||||
|
|
||||||
@ -170,8 +191,9 @@ dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi annotate.dvi
|
|||||||
ps: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps
|
ps: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps
|
||||||
html: $(HTMLFILES)
|
html: $(HTMLFILES)
|
||||||
pdf: $(PDFFILES)
|
pdf: $(PDFFILES)
|
||||||
|
man: $(MANS)
|
||||||
all-doc: info dvi ps # pdf
|
all-doc: info dvi ps # pdf
|
||||||
diststuff: info
|
diststuff: info man
|
||||||
rm -f gdb-cfg.texi GDBvn.texi
|
rm -f gdb-cfg.texi GDBvn.texi
|
||||||
|
|
||||||
install-info: $(INFO_DEPS)
|
install-info: $(INFO_DEPS)
|
||||||
@ -242,7 +264,49 @@ install-pdf: $(PDFFILES)
|
|||||||
$(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(pdfdir)/$$f"; \
|
$(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(pdfdir)/$$f"; \
|
||||||
done
|
done
|
||||||
|
|
||||||
STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf
|
install-man: install-man1 install-man5
|
||||||
|
|
||||||
|
install-man1: $(MAN1S)
|
||||||
|
test -z "$(man1dir)" || $(mkinstalldirs) "$(DESTDIR)$(man1dir)"
|
||||||
|
@list='$(MANS)'; for p in $$list; do \
|
||||||
|
if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
|
||||||
|
f=`echo $$p | sed -e 's|^.*/||'`; \
|
||||||
|
echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(man1dir)/$$f'"; \
|
||||||
|
$(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(man1dir)/$$f"; \
|
||||||
|
done
|
||||||
|
|
||||||
|
install-man5: $(MAN5S)
|
||||||
|
test -z "$(man5dir)" || $(mkinstalldirs) "$(DESTDIR)$(man5dir)"
|
||||||
|
@list='$(MANS)'; for p in $$list; do \
|
||||||
|
if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
|
||||||
|
f=`echo $$p | sed -e 's|^.*/||'`; \
|
||||||
|
echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(man5dir)/$$f'"; \
|
||||||
|
$(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(man5dir)/$$f"; \
|
||||||
|
done
|
||||||
|
|
||||||
|
uninstall-man: uninstall-man1 uninstall-man5
|
||||||
|
|
||||||
|
uninstall-man1:
|
||||||
|
@test -n "$(man1dir)" || exit 0; \
|
||||||
|
files=`{ l2='$(MANS)'; for i in $$l2; do echo "$$i"; done | \
|
||||||
|
sed -n '/\.1[a-z]*$$/p'; \
|
||||||
|
} | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \
|
||||||
|
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
|
||||||
|
test -z "$$files" || { \
|
||||||
|
echo " ( cd '$(DESTDIR)$(man1dir)' && rm -f" $$files ")"; \
|
||||||
|
cd "$(DESTDIR)$(man1dir)" && rm -f $$files; }
|
||||||
|
|
||||||
|
uninstall-man5:
|
||||||
|
@test -n "$(man5dir)" || exit 0; \
|
||||||
|
files=`{ l2='$(MANS)'; for i in $$l2; do echo "$$i"; done | \
|
||||||
|
sed -n '/\.5[a-z]*$$/p'; \
|
||||||
|
} | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \
|
||||||
|
-e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
|
||||||
|
test -z "$$files" || { \
|
||||||
|
echo " ( cd '$(DESTDIR)$(man5dir)' && rm -f" $$files ")"; \
|
||||||
|
cd "$(DESTDIR)$(man5dir)" && rm -f $$files; }
|
||||||
|
|
||||||
|
STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf *.1 *.5
|
||||||
|
|
||||||
# Copy the object files from a particular stage into a subdirectory.
|
# Copy the object files from a particular stage into a subdirectory.
|
||||||
stage1: force
|
stage1: force
|
||||||
@ -313,6 +377,9 @@ GDBvn.texi : ${gdbdir}/version.in
|
|||||||
if test -z "$(READLINE_TEXI_INCFLAG)"; then \
|
if test -z "$(READLINE_TEXI_INCFLAG)"; then \
|
||||||
echo "@set SYSTEM_READLINE" >> ./GDBvn.new; \
|
echo "@set SYSTEM_READLINE" >> ./GDBvn.new; \
|
||||||
fi
|
fi
|
||||||
|
if [ -n "$(SYSTEM_GDBINIT)" ]; then \
|
||||||
|
echo "@set SYSTEM_GDBINIT $(SYSTEM_GDBINIT)" >> ./GDBvn.new; \
|
||||||
|
fi
|
||||||
mv GDBvn.new GDBvn.texi
|
mv GDBvn.new GDBvn.texi
|
||||||
|
|
||||||
# Updated atomically
|
# Updated atomically
|
||||||
@ -523,6 +590,28 @@ annotate.info: $(ANNOTATE_DOC_FILES)
|
|||||||
annotate/index.html: $(ANNOTATE_DOC_FILES)
|
annotate/index.html: $(ANNOTATE_DOC_FILES)
|
||||||
$(MAKEHTML) $(MAKEHTMLFLAGS) -I $(srcdir) $(srcdir)/annotate.texinfo
|
$(MAKEHTML) $(MAKEHTMLFLAGS) -I $(srcdir) $(srcdir)/annotate.texinfo
|
||||||
|
|
||||||
|
# Man pages
|
||||||
|
gdb.1: $(GDB_DOC_FILES)
|
||||||
|
touch $@
|
||||||
|
-$(TEXI2POD) $(MANCONF) -Dgdb < gdb.texinfo > gdb.pod
|
||||||
|
-($(POD2MAN1) gdb.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \
|
||||||
|
mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1)
|
||||||
|
rm -f gdb.pod
|
||||||
|
|
||||||
|
gdbserver.1: $(GDB_DOC_FILES)
|
||||||
|
touch $@
|
||||||
|
-$(TEXI2POD) $(MANCONF) -Dgdbserver < gdb.texinfo > gdbserver.pod
|
||||||
|
-($(POD2MAN1) gdbserver.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \
|
||||||
|
mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1)
|
||||||
|
rm -f gdbserver.pod
|
||||||
|
|
||||||
|
gdbinit.5: $(GDB_DOC_FILES)
|
||||||
|
touch $@
|
||||||
|
-$(TEXI2POD) $(MANCONF) -Dgdbinit < gdb.texinfo > gdbinit.pod
|
||||||
|
-($(POD2MAN5) gdbinit.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \
|
||||||
|
mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1)
|
||||||
|
rm -f gdbinit.pod
|
||||||
|
|
||||||
force:
|
force:
|
||||||
|
|
||||||
Makefile: Makefile.in $(host_makefile_frag) ../config.status
|
Makefile: Makefile.in $(host_makefile_frag) ../config.status
|
||||||
@ -551,8 +640,8 @@ distclean: clean
|
|||||||
# "clean" or "distclean". Use maintainer-clean to remove them.
|
# "clean" or "distclean". Use maintainer-clean to remove them.
|
||||||
|
|
||||||
maintainer-clean realclean: distclean
|
maintainer-clean realclean: distclean
|
||||||
rm -f GDBvn.texi *.info* *.dvi *.ps *.html *.pdf
|
rm -f GDBvn.texi *.info* *.dvi *.ps *.html *.pdf $(MANS)
|
||||||
|
|
||||||
install: install-info
|
install: install-info install-man
|
||||||
|
|
||||||
uninstall: uninstall-info
|
uninstall: uninstall-info uninstall-man
|
||||||
|
|||||||
@ -6,7 +6,9 @@
|
|||||||
@c of @set vars. However, you can override filename with makeinfo -o.
|
@c of @set vars. However, you can override filename with makeinfo -o.
|
||||||
@setfilename gdb.info
|
@setfilename gdb.info
|
||||||
@c
|
@c
|
||||||
|
@c man begin INCLUDE
|
||||||
@include gdb-cfg.texi
|
@include gdb-cfg.texi
|
||||||
|
@c man end
|
||||||
@c
|
@c
|
||||||
@settitle Debugging with @value{GDBN}
|
@settitle Debugging with @value{GDBN}
|
||||||
@setchapternewpage odd
|
@setchapternewpage odd
|
||||||
@ -46,6 +48,7 @@
|
|||||||
@end direntry
|
@end direntry
|
||||||
|
|
||||||
@copying
|
@copying
|
||||||
|
@c man begin COPYRIGHT
|
||||||
Copyright @copyright{} 1988-2013 Free Software Foundation, Inc.
|
Copyright @copyright{} 1988-2013 Free Software Foundation, Inc.
|
||||||
|
|
||||||
Permission is granted to copy, distribute and/or modify this document
|
Permission is granted to copy, distribute and/or modify this document
|
||||||
@ -58,6 +61,7 @@ and with the Back-Cover Texts as in (a) below.
|
|||||||
(a) The FSF's Back-Cover Text is: ``You are free to copy and modify
|
(a) The FSF's Back-Cover Text is: ``You are free to copy and modify
|
||||||
this GNU Manual. Buying copies from GNU Press supports the FSF in
|
this GNU Manual. Buying copies from GNU Press supports the FSF in
|
||||||
developing GNU and promoting software freedom.''
|
developing GNU and promoting software freedom.''
|
||||||
|
@c man end
|
||||||
@end copying
|
@end copying
|
||||||
|
|
||||||
@ifnottex
|
@ifnottex
|
||||||
@ -179,6 +183,7 @@ software in general. We will miss him.
|
|||||||
the operating system
|
the operating system
|
||||||
* Trace File Format:: GDB trace file format
|
* Trace File Format:: GDB trace file format
|
||||||
* Index Section Format:: .gdb_index section format
|
* Index Section Format:: .gdb_index section format
|
||||||
|
* Man Pages:: Manual pages
|
||||||
* Copying:: GNU General Public License says
|
* Copying:: GNU General Public License says
|
||||||
how you can copy and share GDB
|
how you can copy and share GDB
|
||||||
* GNU Free Documentation License:: The license for this documentation
|
* GNU Free Documentation License:: The license for this documentation
|
||||||
@ -41597,6 +41602,497 @@ switch (die->tag)
|
|||||||
@}
|
@}
|
||||||
@end smallexample
|
@end smallexample
|
||||||
|
|
||||||
|
@node Man Pages
|
||||||
|
@appendix Manual pages
|
||||||
|
@cindex Man pages
|
||||||
|
|
||||||
|
@menu
|
||||||
|
* gdb man:: The GNU Debugger man page
|
||||||
|
* gdbserver man:: Remote Server for the GNU Debugger man page
|
||||||
|
* gdbinit man:: gdbinit scripts
|
||||||
|
@end menu
|
||||||
|
|
||||||
|
@node gdb man
|
||||||
|
@heading gdb man
|
||||||
|
|
||||||
|
@c man title gdb The GNU Debugger
|
||||||
|
|
||||||
|
@c man begin SYNOPSIS gdb
|
||||||
|
gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}]
|
||||||
|
[@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]
|
||||||
|
[@option{-b}@w{ }@var{bps}]
|
||||||
|
[@option{-tty=}@var{dev}] [@option{-s} @var{symfile}]
|
||||||
|
[@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]
|
||||||
|
[@option{-c}@w{ }@var{core}] [@option{-x}@w{ }@var{cmds}]
|
||||||
|
[@option{-d}@w{ }@var{dir}] [@var{prog}|@var{core}|@var{procID}]
|
||||||
|
@c man end
|
||||||
|
|
||||||
|
@c man begin DESCRIPTION gdb
|
||||||
|
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.
|
||||||
|
|
||||||
|
@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
|
||||||
|
@item
|
||||||
|
Start your program, specifying anything that might affect its behavior.
|
||||||
|
|
||||||
|
@item
|
||||||
|
Make your program stop on specified conditions.
|
||||||
|
|
||||||
|
@item
|
||||||
|
Examine what has happened, when your program has stopped.
|
||||||
|
|
||||||
|
@item
|
||||||
|
Change things in your program, so you can experiment with correcting the
|
||||||
|
effects of one bug and go on to learn about another.
|
||||||
|
@end itemize
|
||||||
|
|
||||||
|
You can use @value{GDBN} to debug programs written in C, C@t{++}, and Modula-2.
|
||||||
|
Fortran support will be added when a GNU Fortran compiler is ready.
|
||||||
|
|
||||||
|
@value{GDBN} is invoked with the shell command @code{gdb}. Once started, it reads
|
||||||
|
commands from the terminal until you tell it to exit with the @value{GDBN}
|
||||||
|
command @code{quit}. You can get online help from @value{GDBN} itself
|
||||||
|
by using the command @code{help}.
|
||||||
|
|
||||||
|
You can run @code{gdb} with no arguments or options; but the most
|
||||||
|
usual way to start @value{GDBN} is with one argument or two, specifying an
|
||||||
|
executable program as the argument:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
gdb program
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
You can also start with both an executable program and a core file specified:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
gdb program core
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
You can, instead, specify a process ID as a second argument, if you want
|
||||||
|
to debug a running process:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
gdb program 1234
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
@noindent
|
||||||
|
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).
|
||||||
|
|
||||||
|
Here are some of the most frequently needed @value{GDBN} commands:
|
||||||
|
|
||||||
|
@c pod2man highlights the right hand side of the @item lines.
|
||||||
|
@table @env
|
||||||
|
@item break [@var{file}:]@var{functiop}
|
||||||
|
Set a breakpoint at @var{function} (in @var{file}).
|
||||||
|
|
||||||
|
@item run [@var{arglist}]
|
||||||
|
Start your program (with @var{arglist}, if specified).
|
||||||
|
|
||||||
|
@item bt
|
||||||
|
Backtrace: display the program stack.
|
||||||
|
|
||||||
|
@item print @var{expr}
|
||||||
|
Display the value of an expression.
|
||||||
|
|
||||||
|
@item c
|
||||||
|
Continue running your program (after stopping, e.g. at a breakpoint).
|
||||||
|
|
||||||
|
@item next
|
||||||
|
Execute next program line (after stopping); step @emph{over} any
|
||||||
|
function calls in the line.
|
||||||
|
|
||||||
|
@item edit [@var{file}:]@var{function}
|
||||||
|
look at the program line where it is presently stopped.
|
||||||
|
|
||||||
|
@item list [@var{file}:]@var{function}
|
||||||
|
type the text of the program in the vicinity of where it is presently stopped.
|
||||||
|
|
||||||
|
@item step
|
||||||
|
Execute next program line (after stopping); step @emph{into} any
|
||||||
|
function calls in the line.
|
||||||
|
|
||||||
|
@item help [@var{name}]
|
||||||
|
Show information about @value{GDBN} command @var{name}, or general information
|
||||||
|
about using @value{GDBN}.
|
||||||
|
|
||||||
|
@item quit
|
||||||
|
Exit from @value{GDBN}.
|
||||||
|
@end table
|
||||||
|
|
||||||
|
@ifset man
|
||||||
|
For full details on @value{GDBN},
|
||||||
|
see @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
|
||||||
|
by Richard M. Stallman and Roland H. Pesch. The same text is available online
|
||||||
|
as the @code{gdb} entry in the @code{info} program.
|
||||||
|
@end ifset
|
||||||
|
@c man end
|
||||||
|
|
||||||
|
@c man begin OPTIONS 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 @option{-se} option, and the second,
|
||||||
|
if any, is equivalent to a @option{-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 @option{+} rather than @option{-}, 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 @option{-x}
|
||||||
|
option is used.
|
||||||
|
|
||||||
|
@table @env
|
||||||
|
@item -help
|
||||||
|
@itemx -h
|
||||||
|
List all options, with brief explanations.
|
||||||
|
|
||||||
|
@item -symbols=@var{file}
|
||||||
|
@itemx -s @var{file}
|
||||||
|
Read symbol table from file @var{file}.
|
||||||
|
|
||||||
|
@item -write
|
||||||
|
Enable writing into executable and core files.
|
||||||
|
|
||||||
|
@item -exec=@var{file}
|
||||||
|
@itemx -e @var{file}
|
||||||
|
Use file @var{file} as the executable file to execute when
|
||||||
|
appropriate, and for examining pure data in conjunction with a core
|
||||||
|
dump.
|
||||||
|
|
||||||
|
@item -se=@var{file}
|
||||||
|
Read symbol table from file @var{file} and use it as the executable
|
||||||
|
file.
|
||||||
|
|
||||||
|
@item -core=@var{file}
|
||||||
|
@itemx -c @var{file}
|
||||||
|
Use file @var{file} as a core dump to examine.
|
||||||
|
|
||||||
|
@item -command=@var{file}
|
||||||
|
@itemx -x @var{file}
|
||||||
|
Execute @value{GDBN} commands from file @var{file}.
|
||||||
|
|
||||||
|
@item -ex @var{command}
|
||||||
|
Execute given @value{GDBN} @var{command}.
|
||||||
|
|
||||||
|
@item -directory=@var{directory}
|
||||||
|
@itemx -d @var{directory}
|
||||||
|
Add @var{directory} to the path to search for source files.
|
||||||
|
|
||||||
|
@item -nh
|
||||||
|
Do not execute commands from @file{~/.gdbinit}.
|
||||||
|
|
||||||
|
@item -nx
|
||||||
|
@itemx -n
|
||||||
|
Do not execute commands from any @file{.gdbinit} initialization files.
|
||||||
|
|
||||||
|
@item -quiet
|
||||||
|
@itemx -q
|
||||||
|
``Quiet''. Do not print the introductory and copyright messages. These
|
||||||
|
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 @option{-x} (and @file{.gdbinit}, if not inhibited).
|
||||||
|
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 @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
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
Program exited normally.
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
@noindent
|
||||||
|
(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 @value{GDBN} using @var{directory} as its working directory,
|
||||||
|
instead of the current directory.
|
||||||
|
|
||||||
|
@item -fullname
|
||||||
|
@itemx -f
|
||||||
|
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 the 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-@value{GDBN} interface program uses the two @samp{\032}
|
||||||
|
characters as a signal to display the source code for the frame.
|
||||||
|
|
||||||
|
@item -b @var{bps}
|
||||||
|
Set the line speed (baud rate or bits per second) of any serial
|
||||||
|
interface used by @value{GDBN} for remote debugging.
|
||||||
|
|
||||||
|
@item -tty=@var{device}
|
||||||
|
Run using @var{device} for your program's standard input and output.
|
||||||
|
@end table
|
||||||
|
@c man end
|
||||||
|
|
||||||
|
@c man begin SEEALSO gdb
|
||||||
|
@ifset man
|
||||||
|
The full documentation for @value{GDBN} is maintained as a Texinfo manual.
|
||||||
|
If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
|
||||||
|
documentation are properly installed at your site, the command
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
info gdb
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
@noindent
|
||||||
|
should give you access to the complete manual.
|
||||||
|
|
||||||
|
@cite{Using GDB: A Guide to the GNU Source-Level Debugger},
|
||||||
|
Richard M. Stallman and Roland H. Pesch, July 1991.
|
||||||
|
@end ifset
|
||||||
|
@c man end
|
||||||
|
|
||||||
|
@node gdbserver man
|
||||||
|
@heading gdbserver man
|
||||||
|
|
||||||
|
@c man title gdbserver Remote Server for the GNU Debugger
|
||||||
|
@format
|
||||||
|
@c man begin SYNOPSIS gdbserver
|
||||||
|
gdbserver @var{tty} @var{prog} [@var{args}@dots{}]
|
||||||
|
|
||||||
|
gdbserver @var{tty} --attach @var{PID}
|
||||||
|
@c man end
|
||||||
|
@end format
|
||||||
|
|
||||||
|
@c man begin DESCRIPTION gdbserver
|
||||||
|
@command{gdbserver} is a program that allows you to run @value{GDBN} on a different machine
|
||||||
|
than the one which is running the program being debugged.
|
||||||
|
|
||||||
|
@ifclear man
|
||||||
|
@subheading Usage (server (target) side)
|
||||||
|
@end ifclear
|
||||||
|
@ifset man
|
||||||
|
Usage (server (target) side):
|
||||||
|
@end ifset
|
||||||
|
|
||||||
|
First, you need to have a copy of the program you want to debug put onto
|
||||||
|
the target system. The program can be stripped to save space if needed, as
|
||||||
|
@command{gdbserver} doesn't care about symbols. All symbol handling is taken care of by
|
||||||
|
the @value{GDBN} running on the host system.
|
||||||
|
|
||||||
|
To use the server, you log on to the target system, and run the @command{gdbserver}
|
||||||
|
program. You must tell it (a) how to communicate with @value{GDBN}, (b) the name of
|
||||||
|
your program, and (c) its arguments. The general syntax is:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
target> gdbserver @var{comm} @var{program} [@var{args} ...]
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
For example, using a serial port, you might say:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
@ifset man
|
||||||
|
@c @file would wrap it as F</dev/com1>.
|
||||||
|
target> gdbserver /dev/com1 emacs foo.txt
|
||||||
|
@end ifset
|
||||||
|
@ifclear man
|
||||||
|
target> gdbserver @file{/dev/com1} emacs foo.txt
|
||||||
|
@end ifclear
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
This tells @command{gdbserver} to debug emacs with an argument of foo.txt, and
|
||||||
|
to communicate with @value{GDBN} via @file{/dev/com1}. @command{gdbserver} now
|
||||||
|
waits patiently for the host @value{GDBN} to communicate with it.
|
||||||
|
|
||||||
|
To use a TCP connection, you could say:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
target> gdbserver host:2345 emacs foo.txt
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
This says pretty much the same thing as the last example, except that we are
|
||||||
|
going to communicate with the @code{host} @value{GDBN} via TCP. The @code{host:2345} argument means
|
||||||
|
that we are expecting to see a TCP connection from @code{host} to local TCP port
|
||||||
|
2345. (Currently, the @code{host} part is ignored.) You can choose any number you
|
||||||
|
want for the port number as long as it does not conflict with any existing TCP
|
||||||
|
ports on the target system. This same port number must be used in the host
|
||||||
|
@value{GDBN}s @code{target remote} command, which will be described shortly. Note that if
|
||||||
|
you chose a port number that conflicts with another service, @command{gdbserver} will
|
||||||
|
print an error message and exit.
|
||||||
|
|
||||||
|
On some targets, @command{gdbserver} can also attach to running programs.
|
||||||
|
This is accomplished via the @option{--attach} argument. The syntax is:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
target> gdbserver @var{comm} --attach @var{pid}
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
@var{pid} is the process ID of a currently running process. It isn't
|
||||||
|
necessary to point @command{gdbserver} at a binary for the running process.
|
||||||
|
|
||||||
|
@ifclear man
|
||||||
|
@subheading Usage (host side)
|
||||||
|
@end ifclear
|
||||||
|
@ifset man
|
||||||
|
Usage (host side):
|
||||||
|
@end ifset
|
||||||
|
|
||||||
|
You need an unstripped copy of the target program on your host system, since
|
||||||
|
@value{GDBN} needs to examine it's symbol tables and such. Start up @value{GDBN} as you normally
|
||||||
|
would, with the target program as the first argument. (You may need to use the
|
||||||
|
@option{--baud} option if the serial line is running at anything except 9600 baud.)
|
||||||
|
That is @code{gdb TARGET-PROG}, or @code{gdb --baud BAUD TARGET-PROG}. After that, the only
|
||||||
|
new command you need to know about is @code{target remote}. It's argument is either
|
||||||
|
a device name (usually a serial device, like @file{/dev/ttyb}), or a @code{HOST:PORT}
|
||||||
|
descriptor. For example:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
@ifset man
|
||||||
|
@c @file would wrap it as F</dev/ttyb>.
|
||||||
|
(gdb) target remote /dev/ttyb
|
||||||
|
@end ifset
|
||||||
|
@ifclear man
|
||||||
|
(gdb) target remote @file{/dev/ttyb}
|
||||||
|
@end ifclear
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
@noindent
|
||||||
|
communicates with the server via serial line @file{/dev/ttyb}, and:
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
(gdb) target remote the-target:2345
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
@noindent
|
||||||
|
communicates via a TCP connection to port 2345 on host `the-target', where
|
||||||
|
you previously started up @command{gdbserver} with the same port number. Note that for
|
||||||
|
TCP connections, you must start up @command{gdbserver} prior to using the `target remote'
|
||||||
|
command, otherwise you may get an error that looks something like
|
||||||
|
`Connection refused'.
|
||||||
|
@c man end
|
||||||
|
|
||||||
|
@c man begin OPTIONS gdbserver
|
||||||
|
You have to supply the name of the program to debug
|
||||||
|
and the tty to communicate on; the remote @value{GDBN} will do everything else.
|
||||||
|
Any remaining arguments will be passed to the program verbatim.
|
||||||
|
@c man end
|
||||||
|
|
||||||
|
@c man begin SEEALSO gdbserver
|
||||||
|
@ifset man
|
||||||
|
The full documentation for @value{GDBN} is maintained as a Texinfo manual.
|
||||||
|
If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
|
||||||
|
documentation are properly installed at your site, the command
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
info gdb
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
should give you access to the complete manual.
|
||||||
|
|
||||||
|
@cite{Using GDB: A Guide to the GNU Source-Level Debugger},
|
||||||
|
Richard M. Stallman and Roland H. Pesch, July 1991.
|
||||||
|
@end ifset
|
||||||
|
@c man end
|
||||||
|
|
||||||
|
@node gdbinit man
|
||||||
|
@heading gdbinit
|
||||||
|
|
||||||
|
@c man title gdbinit GDB initialization scripts
|
||||||
|
|
||||||
|
@format
|
||||||
|
@c man begin SYNOPSIS gdbinit
|
||||||
|
@ifset SYSTEM_GDBINIT
|
||||||
|
@value{SYSTEM_GDBINIT}
|
||||||
|
@end ifset
|
||||||
|
|
||||||
|
~/.gdbinit
|
||||||
|
|
||||||
|
./.gdbinit
|
||||||
|
@c man end
|
||||||
|
@end format
|
||||||
|
|
||||||
|
@c man begin DESCRIPTION gdbinit
|
||||||
|
These files contain @value{GDBN} commands to automatically execute during
|
||||||
|
@value{GDBN} startup. The lines of contents are canned sequences of commands,
|
||||||
|
described in
|
||||||
|
@ifset man
|
||||||
|
the @value{GDBN} manual in node @code{Sequences}
|
||||||
|
-- shell command @code{info -f gdb -n Sequences}.
|
||||||
|
@end ifset
|
||||||
|
@ifclear man
|
||||||
|
@ref{Sequences}.
|
||||||
|
@end ifclear
|
||||||
|
|
||||||
|
Please read more in
|
||||||
|
@ifset man
|
||||||
|
the @value{GDBN} manual in node @code{Startup}
|
||||||
|
-- shell command @code{info -f gdb -n Startup}.
|
||||||
|
@end ifset
|
||||||
|
@ifclear man
|
||||||
|
@ref{Startup}.
|
||||||
|
@end ifclear
|
||||||
|
|
||||||
|
@table @env
|
||||||
|
@ifset SYSTEM_GDBINIT
|
||||||
|
@item @value{SYSTEM_GDBINIT}
|
||||||
|
@end ifset
|
||||||
|
@ifclear SYSTEM_GDBINIT
|
||||||
|
@item (not enabled with @code{--with-system-gdbinit} during compilation)
|
||||||
|
@end ifclear
|
||||||
|
System-wide initialization file. It is executed unless user specified
|
||||||
|
@value{GDBN} option @code{-nx} or @code{-n}.
|
||||||
|
See more in
|
||||||
|
@ifset man
|
||||||
|
the @value{GDBN} manual in node @code{System-wide configuration}
|
||||||
|
-- shell command @code{info -f gdb -n 'System-wide configuration'}.
|
||||||
|
@end ifset
|
||||||
|
@ifclear man
|
||||||
|
@ref{System-wide configuration}.
|
||||||
|
@end ifclear
|
||||||
|
|
||||||
|
@item ~/.gdbinit
|
||||||
|
User initialization file. It is executed unless user specified
|
||||||
|
@value{GDBN} options @code{-nx}, @code{-n} or @code{-nh}.
|
||||||
|
|
||||||
|
@item ./.gdbinit
|
||||||
|
Initialization file for current directory. It may need to be enabled with
|
||||||
|
@value{GDBN} security command @code{set auto-load local-gdbinit}.
|
||||||
|
See more in
|
||||||
|
@ifset man
|
||||||
|
the @value{GDBN} manual in node @code{Init File in the Current Directory}
|
||||||
|
-- shell command @code{info -f gdb -n 'Init File in the Current Directory'}.
|
||||||
|
@end ifset
|
||||||
|
@ifclear man
|
||||||
|
@ref{Init File in the Current Directory}.
|
||||||
|
@end ifclear
|
||||||
|
@end table
|
||||||
|
@c man end
|
||||||
|
|
||||||
|
@c man begin SEEALSO gdbinit
|
||||||
|
@ifset man
|
||||||
|
gdb(1), @code{info -f gdb -n Startup}
|
||||||
|
|
||||||
|
The full documentation for @value{GDBN} is maintained as a Texinfo manual.
|
||||||
|
If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
|
||||||
|
documentation are properly installed at your site, the command
|
||||||
|
|
||||||
|
@smallexample
|
||||||
|
info gdb
|
||||||
|
@end smallexample
|
||||||
|
|
||||||
|
should give you access to the complete manual.
|
||||||
|
|
||||||
|
@cite{Using GDB: A Guide to the GNU Source-Level Debugger},
|
||||||
|
Richard M. Stallman and Roland H. Pesch, July 1991.
|
||||||
|
@end ifset
|
||||||
|
@c man end
|
||||||
|
|
||||||
@include gpl.texi
|
@include gpl.texi
|
||||||
|
|
||||||
@node GNU Free Documentation License
|
@node GNU Free Documentation License
|
||||||
|
|||||||
403
gdb/gdb.1
403
gdb/gdb.1
@ -1,403 +0,0 @@
|
|||||||
.\" Copyright (C) 1991-2013 Free Software Foundation, Inc.
|
|
||||||
.\" See section COPYING for conditions for redistribution
|
|
||||||
.\" $Id$
|
|
||||||
.TH gdb 1 "22may2002" "GNU Tools" "GNU Tools"
|
|
||||||
.SH NAME
|
|
||||||
gdb \- The GNU Debugger
|
|
||||||
.SH SYNOPSIS
|
|
||||||
.na
|
|
||||||
.TP
|
|
||||||
.B gdb
|
|
||||||
.RB "[\|" \-help "\|]"
|
|
||||||
.RB "[\|" \-nh "\|]"
|
|
||||||
.RB "[\|" \-nx "\|]"
|
|
||||||
.RB "[\|" \-q "\|]"
|
|
||||||
.RB "[\|" \-batch "\|]"
|
|
||||||
.RB "[\|" \-cd=\c
|
|
||||||
.I dir\c
|
|
||||||
\|]
|
|
||||||
.RB "[\|" \-f "\|]"
|
|
||||||
.RB "[\|" "\-b\ "\c
|
|
||||||
.IR bps "\|]"
|
|
||||||
.RB "[\|" "\-tty="\c
|
|
||||||
.IR dev "\|]"
|
|
||||||
.RB "[\|" "\-s "\c
|
|
||||||
.I symfile\c
|
|
||||||
\&\|]
|
|
||||||
.RB "[\|" "\-e "\c
|
|
||||||
.I prog\c
|
|
||||||
\&\|]
|
|
||||||
.RB "[\|" "\-se "\c
|
|
||||||
.I prog\c
|
|
||||||
\&\|]
|
|
||||||
.RB "[\|" "\-c "\c
|
|
||||||
.I core\c
|
|
||||||
\&\|]
|
|
||||||
.RB "[\|" "\-x "\c
|
|
||||||
.I file\c
|
|
||||||
\&\|]
|
|
||||||
.RB "[\|" "\-ex "\c
|
|
||||||
.I cmd\c
|
|
||||||
\&\|]
|
|
||||||
.RB "[\|" "\-d "\c
|
|
||||||
.I dir\c
|
|
||||||
\&\|]
|
|
||||||
.RB "[\|" \c
|
|
||||||
.I prog\c
|
|
||||||
.RB "[\|" \c
|
|
||||||
.IR core \||\| procID\c
|
|
||||||
\&\|]\&\|]
|
|
||||||
.ad b
|
|
||||||
.SH DESCRIPTION
|
|
||||||
The purpose of a debugger such as GDB is to allow you to see what is
|
|
||||||
going on ``inside'' another program while it executes\(em\&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:
|
|
||||||
|
|
||||||
.TP
|
|
||||||
\ \ \ \(bu
|
|
||||||
Start your program, specifying anything that might affect its behavior.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
\ \ \ \(bu
|
|
||||||
Make your program stop on specified conditions.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
\ \ \ \(bu
|
|
||||||
Examine what has happened, when your program has stopped.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
\ \ \ \(bu
|
|
||||||
Change things in your program, so you can experiment with correcting the
|
|
||||||
effects of one bug and go on to learn about another.
|
|
||||||
.PP
|
|
||||||
|
|
||||||
You can use GDB to debug programs written in C, C++, and Modula-2.
|
|
||||||
Fortran support will be added when a GNU Fortran compiler is ready.
|
|
||||||
|
|
||||||
GDB is invoked with the shell command \c
|
|
||||||
.B gdb\c
|
|
||||||
\&. Once started, it reads
|
|
||||||
commands from the terminal until you tell it to exit with the GDB
|
|
||||||
command \c
|
|
||||||
.B quit\c
|
|
||||||
\&. You can get online help from \c
|
|
||||||
.B gdb\c
|
|
||||||
\& itself
|
|
||||||
by using the command \c
|
|
||||||
.B help\c
|
|
||||||
\&.
|
|
||||||
|
|
||||||
You can run \c
|
|
||||||
.B gdb\c
|
|
||||||
\& 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:
|
|
||||||
.sp
|
|
||||||
.br
|
|
||||||
gdb\ program
|
|
||||||
.br
|
|
||||||
.sp
|
|
||||||
|
|
||||||
You can also start with both an executable program and a core file specified:
|
|
||||||
.sp
|
|
||||||
.br
|
|
||||||
gdb\ program\ core
|
|
||||||
.br
|
|
||||||
.sp
|
|
||||||
|
|
||||||
You can, instead, specify a process ID as a second argument, if you want
|
|
||||||
to debug a running process:
|
|
||||||
.sp
|
|
||||||
.br
|
|
||||||
gdb\ program\ 1234
|
|
||||||
.br
|
|
||||||
.sp
|
|
||||||
|
|
||||||
would attach GDB to process \c
|
|
||||||
.B 1234\c
|
|
||||||
\& (unless you also have a file
|
|
||||||
named `\|\c
|
|
||||||
.B 1234\c
|
|
||||||
\&\|'; GDB does check for a core file first).
|
|
||||||
|
|
||||||
Here are some of the most frequently needed GDB commands:
|
|
||||||
.TP
|
|
||||||
.B break \fR[\|\fIfile\fB:\fR\|]\fIfunction
|
|
||||||
\&
|
|
||||||
Set a breakpoint at \c
|
|
||||||
.I function\c
|
|
||||||
\& (in \c
|
|
||||||
.I file\c
|
|
||||||
\&).
|
|
||||||
.TP
|
|
||||||
.B run \fR[\|\fIarglist\fR\|]
|
|
||||||
Start your program (with \c
|
|
||||||
.I arglist\c
|
|
||||||
\&, if specified).
|
|
||||||
.TP
|
|
||||||
.B bt
|
|
||||||
Backtrace: display the program stack.
|
|
||||||
.TP
|
|
||||||
.BI print " expr"\c
|
|
||||||
\&
|
|
||||||
Display the value of an expression.
|
|
||||||
.TP
|
|
||||||
.B c
|
|
||||||
Continue running your program (after stopping, e.g. at a breakpoint).
|
|
||||||
.TP
|
|
||||||
.B next
|
|
||||||
Execute next program line (after stopping); step \c
|
|
||||||
.I over\c
|
|
||||||
\& any
|
|
||||||
function calls in the line.
|
|
||||||
.TP
|
|
||||||
.B edit \fR[\|\fIfile\fB:\fR\|]\fIfunction
|
|
||||||
look at the program line where it is presently stopped.
|
|
||||||
.TP
|
|
||||||
.B list \fR[\|\fIfile\fB:\fR\|]\fIfunction
|
|
||||||
type the text of the program in the vicinity of where it is presently stopped.
|
|
||||||
.TP
|
|
||||||
.B step
|
|
||||||
Execute next program line (after stopping); step \c
|
|
||||||
.I into\c
|
|
||||||
\& any
|
|
||||||
function calls in the line.
|
|
||||||
.TP
|
|
||||||
.B help \fR[\|\fIname\fR\|]
|
|
||||||
Show information about GDB command \c
|
|
||||||
.I name\c
|
|
||||||
\&, or general information
|
|
||||||
about using GDB.
|
|
||||||
.TP
|
|
||||||
.B quit
|
|
||||||
Exit from GDB.
|
|
||||||
.PP
|
|
||||||
For full details on GDB, see \c
|
|
||||||
.I
|
|
||||||
Using GDB: A Guide to the GNU Source-Level Debugger\c
|
|
||||||
\&, by Richard M. Stallman and Roland H. Pesch. The same text is available online
|
|
||||||
as the \c
|
|
||||||
.B gdb\c
|
|
||||||
\& entry in the \c
|
|
||||||
.B info\c
|
|
||||||
\& program.
|
|
||||||
.SH OPTIONS
|
|
||||||
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 `\|\c
|
|
||||||
.B \-se\c
|
|
||||||
\&\|' option, and the
|
|
||||||
second, if any, is equivalent to a `\|\c
|
|
||||||
.B \-c\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 `\|\c
|
|
||||||
.B +\c
|
|
||||||
\&\|' rather than `\|\c
|
|
||||||
.B \-\c
|
|
||||||
\&\|', 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
|
|
||||||
`\|\c
|
|
||||||
.B \-x\c
|
|
||||||
\&\|' option is used.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B \-help
|
|
||||||
.TP
|
|
||||||
.B \-h
|
|
||||||
List all options, with brief explanations.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-symbols=" "file"\c
|
|
||||||
.TP
|
|
||||||
.BI "\-s " "file"\c
|
|
||||||
\&
|
|
||||||
Read symbol table from file \c
|
|
||||||
.I file\c
|
|
||||||
\&.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B \-write
|
|
||||||
Enable writing into executable and core files.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-exec=" "file"\c
|
|
||||||
.TP
|
|
||||||
.BI "\-e " "file"\c
|
|
||||||
\&
|
|
||||||
Use file \c
|
|
||||||
.I file\c
|
|
||||||
\& as the executable file to execute when
|
|
||||||
appropriate, and for examining pure data in conjunction with a core
|
|
||||||
dump.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-se=" "file"\c
|
|
||||||
\&
|
|
||||||
Read symbol table from file \c
|
|
||||||
.I file\c
|
|
||||||
\& and use it as the executable
|
|
||||||
file.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-core=" "file"\c
|
|
||||||
.TP
|
|
||||||
.BI "\-c " "file"\c
|
|
||||||
\&
|
|
||||||
Use file \c
|
|
||||||
.I file\c
|
|
||||||
\& as a core dump to examine.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-command=" "file"\c
|
|
||||||
.TP
|
|
||||||
.BI "\-x " "file"\c
|
|
||||||
\&
|
|
||||||
Execute GDB commands from file \c
|
|
||||||
.I file\c
|
|
||||||
\&.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-ex " "command"\c
|
|
||||||
\&
|
|
||||||
Execute given GDB \c
|
|
||||||
.I command\c
|
|
||||||
\&.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-directory=" "directory"\c
|
|
||||||
.TP
|
|
||||||
.BI "\-d " "directory"\c
|
|
||||||
\&
|
|
||||||
Add \c
|
|
||||||
.I directory\c
|
|
||||||
\& to the path to search for source files.
|
|
||||||
.PP
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B \-nh
|
|
||||||
Do not execute commands from ~/.gdbinit.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B \-nx
|
|
||||||
.TP
|
|
||||||
.B \-n
|
|
||||||
Do not execute commands from any `\|\c
|
|
||||||
.B .gdbinit\c
|
|
||||||
\&\|' initialization files.
|
|
||||||
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B \-quiet
|
|
||||||
.TP
|
|
||||||
.B \-q
|
|
||||||
``Quiet''. Do not print the introductory and copyright messages. These
|
|
||||||
messages are also suppressed in batch mode.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B \-batch
|
|
||||||
Run in batch mode. Exit with status \c
|
|
||||||
.B 0\c
|
|
||||||
\& after processing all the command
|
|
||||||
files specified with `\|\c
|
|
||||||
.B \-x\c
|
|
||||||
\&\|' (and `\|\c
|
|
||||||
.B .gdbinit\c
|
|
||||||
\&\|', 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
|
|
||||||
.sp
|
|
||||||
.br
|
|
||||||
Program\ exited\ normally.
|
|
||||||
.br
|
|
||||||
.sp
|
|
||||||
|
|
||||||
(which is ordinarily issued whenever a program running under GDB control
|
|
||||||
terminates) is not issued when running in batch mode.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-cd=" "directory"\c
|
|
||||||
\&
|
|
||||||
Run GDB using \c
|
|
||||||
.I directory\c
|
|
||||||
\& as its working directory,
|
|
||||||
instead of the current directory.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B \-fullname
|
|
||||||
.TP
|
|
||||||
.B \-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 `\|\c
|
|
||||||
.B \032\c
|
|
||||||
\&\|' 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 `\|\c
|
|
||||||
.B \032\c
|
|
||||||
\&\|' characters as
|
|
||||||
a signal to display the source code for the frame.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-b " "bps"\c
|
|
||||||
\&
|
|
||||||
Set the line speed (baud rate or bits per second) of any serial
|
|
||||||
interface used by GDB for remote debugging.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.BI "\-tty=" "device"\c
|
|
||||||
\&
|
|
||||||
Run using \c
|
|
||||||
.I device\c
|
|
||||||
\& for your program's standard input and output.
|
|
||||||
.PP
|
|
||||||
|
|
||||||
.SH "SEE ALSO"
|
|
||||||
The full documentation for
|
|
||||||
.B gdb
|
|
||||||
is maintained as a Texinfo manual. If the
|
|
||||||
.B info
|
|
||||||
and
|
|
||||||
.B gdb
|
|
||||||
programs and GDB's Texinfo documentation are properly installed at
|
|
||||||
your site, the command
|
|
||||||
.IP
|
|
||||||
.B info gdb
|
|
||||||
.PP
|
|
||||||
should give you access to the complete manual.
|
|
||||||
|
|
||||||
.I
|
|
||||||
Using GDB: A Guide to the GNU Source-Level Debugger\c
|
|
||||||
, Richard M. Stallman and Roland H. Pesch, July 1991.
|
|
||||||
.SH COPYING
|
|
||||||
Copyright (c) 1991, 2010 Free Software Foundation, Inc.
|
|
||||||
.PP
|
|
||||||
Permission is granted to make and distribute verbatim copies of
|
|
||||||
this manual provided the copyright notice and this permission notice
|
|
||||||
are preserved on all copies.
|
|
||||||
.PP
|
|
||||||
Permission is granted to copy and distribute modified versions of this
|
|
||||||
manual under the conditions for verbatim copying, provided that the
|
|
||||||
entire resulting derived work is distributed under the terms of a
|
|
||||||
permission notice identical to this one.
|
|
||||||
.PP
|
|
||||||
Permission is granted to copy and distribute translations of this
|
|
||||||
manual into another language, under the above conditions for modified
|
|
||||||
versions, except that this permission notice may be included in
|
|
||||||
translations approved by the Free Software Foundation instead of in
|
|
||||||
the original English.
|
|
||||||
@ -1,3 +1,10 @@
|
|||||||
|
2013-04-05 Jan Kratochvil <jan.kratochvil@redhat.com>
|
||||||
|
|
||||||
|
Convert man pages to texinfo, new gdbinit.5 texinfo page.
|
||||||
|
* Makefile.in (install-only): Remove $(man1dir) and gdbserver.1
|
||||||
|
installation.
|
||||||
|
* gdbserver.1: Remove.
|
||||||
|
|
||||||
2013-03-22 Pedro Alves <palves@redhat.com>
|
2013-03-22 Pedro Alves <palves@redhat.com>
|
||||||
|
|
||||||
* linux-low.c (handle_extended_wait): Don't call
|
* linux-low.c (handle_extended_wait): Don't call
|
||||||
|
|||||||
@ -252,8 +252,6 @@ install-only:
|
|||||||
fi; \
|
fi; \
|
||||||
$(SHELL) $(srcdir)/../../mkinstalldirs $(DESTDIR)$(bindir); \
|
$(SHELL) $(srcdir)/../../mkinstalldirs $(DESTDIR)$(bindir); \
|
||||||
$(INSTALL_PROGRAM) gdbserver$(EXEEXT) $(DESTDIR)$(bindir)/$$n$(EXEEXT); \
|
$(INSTALL_PROGRAM) gdbserver$(EXEEXT) $(DESTDIR)$(bindir)/$$n$(EXEEXT); \
|
||||||
$(SHELL) $(srcdir)/../../mkinstalldirs $(DESTDIR)$(man1dir); \
|
|
||||||
$(INSTALL_DATA) $(srcdir)/gdbserver.1 $(DESTDIR)$(man1dir)/$$n.1
|
|
||||||
@$(MAKE) $(FLAGS_TO_PASS) DO=$@ "DODIRS=$(SUBDIRS)" subdir_do
|
@$(MAKE) $(FLAGS_TO_PASS) DO=$@ "DODIRS=$(SUBDIRS)" subdir_do
|
||||||
|
|
||||||
uninstall: force
|
uninstall: force
|
||||||
|
|||||||
@ -1,116 +0,0 @@
|
|||||||
.\" Copyright (C) 1993-2013 Free Software Foundation, Inc.
|
|
||||||
.\" See section COPYING for conditions for redistribution
|
|
||||||
.TH gdbserver 1 "2 November 1993" "Cygnus Support" "GNU Development Tools"
|
|
||||||
.SH NAME
|
|
||||||
gdbserver \- Remote Server for the GNU Debugger
|
|
||||||
.SH SYNOPSIS
|
|
||||||
.na
|
|
||||||
.TP
|
|
||||||
.B gdbserver
|
|
||||||
.RB tty
|
|
||||||
.RB prog
|
|
||||||
.RB "[\|" args... "\|]"
|
|
||||||
.PP
|
|
||||||
.B gdbserver
|
|
||||||
.RB tty
|
|
||||||
.B --attach
|
|
||||||
.RB PID
|
|
||||||
.ad b
|
|
||||||
.SH DESCRIPTION
|
|
||||||
GDBSERVER is a program that allows you to run GDB on a different machine
|
|
||||||
than the one which is running the program being debugged.
|
|
||||||
|
|
||||||
Usage (server (target) side):
|
|
||||||
|
|
||||||
First, you need to have a copy of the program you want to debug put onto
|
|
||||||
the target system. The program can be stripped to save space if needed, as
|
|
||||||
GDBserver doesn't care about symbols. All symbol handling is taken care of by
|
|
||||||
the GDB running on the host system.
|
|
||||||
|
|
||||||
To use the server, you log on to the target system, and run the `gdbserver'
|
|
||||||
program. You must tell it (a) how to communicate with GDB, (b) the name of
|
|
||||||
your program, and (c) its arguments. The general syntax is:
|
|
||||||
|
|
||||||
target> gdbserver COMM PROGRAM [ARGS ...]
|
|
||||||
|
|
||||||
For example, using a serial port, you might say:
|
|
||||||
|
|
||||||
target> gdbserver /dev/com1 emacs foo.txt
|
|
||||||
|
|
||||||
This tells gdbserver to debug emacs with an argument of foo.txt, and to
|
|
||||||
communicate with GDB via /dev/com1. Gdbserver now waits patiently for the
|
|
||||||
host GDB to communicate with it.
|
|
||||||
|
|
||||||
To use a TCP connection, you could say:
|
|
||||||
|
|
||||||
target> gdbserver host:2345 emacs foo.txt
|
|
||||||
|
|
||||||
This says pretty much the same thing as the last example, except that we are
|
|
||||||
going to communicate with the host GDB via TCP. The `host:2345' argument means
|
|
||||||
that we are expecting to see a TCP connection from `host' to local TCP port
|
|
||||||
2345. (Currently, the `host' part is ignored.) You can choose any number you
|
|
||||||
want for the port number as long as it does not conflict with any existing TCP
|
|
||||||
ports on the target system. This same port number must be used in the host
|
|
||||||
GDBs `target remote' command, which will be described shortly. Note that if
|
|
||||||
you chose a port number that conflicts with another service, gdbserver will
|
|
||||||
print an error message and exit.
|
|
||||||
|
|
||||||
On some targets, gdbserver can also attach to running programs.
|
|
||||||
This is accomplished via the --attach argument. The syntax is:
|
|
||||||
|
|
||||||
target> gdbserver COMM --attach PID
|
|
||||||
|
|
||||||
PID is the process ID of a currently running process. It isn't
|
|
||||||
necessary to point gdbserver at a binary for the running process.
|
|
||||||
|
|
||||||
Usage (host side):
|
|
||||||
|
|
||||||
You need an unstripped copy of the target program on your host system, since
|
|
||||||
GDB needs to examine it's symbol tables and such. Start up GDB as you normally
|
|
||||||
would, with the target program as the first argument. (You may need to use the
|
|
||||||
--baud option if the serial line is running at anything except 9600 baud.)
|
|
||||||
Ie: `gdb TARGET-PROG', or `gdb --baud BAUD TARGET-PROG'. After that, the only
|
|
||||||
new command you need to know about is `target remote'. It's argument is either
|
|
||||||
a device name (usually a serial device, like `/dev/ttyb'), or a HOST:PORT
|
|
||||||
descriptor. For example:
|
|
||||||
|
|
||||||
(gdb) target remote /dev/ttyb
|
|
||||||
|
|
||||||
communicates with the server via serial line /dev/ttyb, and:
|
|
||||||
|
|
||||||
(gdb) target remote the-target:2345
|
|
||||||
|
|
||||||
communicates via a TCP connection to port 2345 on host `the-target', where
|
|
||||||
you previously started up gdbserver with the same port number. Note that for
|
|
||||||
TCP connections, you must start up gdbserver prior to using the `target remote'
|
|
||||||
command, otherwise you may get an error that looks something like
|
|
||||||
`Connection refused'.
|
|
||||||
.SH OPTIONS
|
|
||||||
You have to supply the name of the program to debug
|
|
||||||
and the tty to communicate on; the remote GDB will do everything else.
|
|
||||||
Any remaining arguments will be passed to the program verbatim.
|
|
||||||
.SH "SEE ALSO"
|
|
||||||
.RB "`\|" gdb "\|'"
|
|
||||||
entry in
|
|
||||||
.B info\c
|
|
||||||
\&;
|
|
||||||
.I
|
|
||||||
Using GDB: A Guide to the GNU Source-Level Debugger\c
|
|
||||||
, Richard M. Stallman and Roland H. Pesch, July 1991.
|
|
||||||
.SH COPYING
|
|
||||||
Copyright (c) 1993 Free Software Foundation, Inc.
|
|
||||||
.PP
|
|
||||||
Permission is granted to make and distribute verbatim copies of
|
|
||||||
this manual provided the copyright notice and this permission notice
|
|
||||||
are preserved on all copies.
|
|
||||||
.PP
|
|
||||||
Permission is granted to copy and distribute modified versions of this
|
|
||||||
manual under the conditions for verbatim copying, provided that the
|
|
||||||
entire resulting derived work is distributed under the terms of a
|
|
||||||
permission notice identical to this one.
|
|
||||||
.PP
|
|
||||||
Permission is granted to copy and distribute translations of this
|
|
||||||
manual into another language, under the above conditions for modified
|
|
||||||
versions, except that this permission notice may be included in
|
|
||||||
translations approved by the Free Software Foundation instead of in
|
|
||||||
the original English.
|
|
||||||
Loading…
Reference in New Issue
Block a user