gdb-2.8
[external/binutils.git] / gdb / gdb.1
1 .TH GDB 1 "13 April 1987"
2 .UC 4
3 .SH NAME
4 gdb \- Project GNU's DeBugger
5 .SH SYNOPSIS
6 \fBgdb\fP [ \fBoptions\fP ]   See documentation mentioned below.
7 .SH DESCRIPTION
8 \fIgdb\fP is a source level symbolic debugger for C programs, created by
9 Richard M. Stallman (rms) for the GNU Project, and distributed by the
10 Free Software Foundation.  Eventually GNU (Gnu's Not Unix) will be a
11 complete replacement for Berkeley Unix, all of which everyone will be
12 able to use freely.  See the \fIGNU Emacs\fP man page for pointers to more
13 information.
14 .PP
15 \fIgdb\fP has something of the flavor of \fIdbx\fP,
16 but has more features and power.  It can also be used to debug o/s
17 kernels, but needs to be configured differently for that task.
18 .PP
19 Project GNU isn't using Unix man pages.  Its style of complete
20 documentation can be found by:
21 .PP
22 The help and info commands inside \fIgdb\fP.
23 .PP
24 In the Info system in \fIGNU Emacs\fP.  Type C-h i, and follow the
25 directions.  This is equivalent to the reference manual for 
26 \fIgdb\fP, and has about 55 pages of text.
27 .PP
28 \fIgdb\fP could be extended to work with other languages (e.g. Pascal) and
29 machines (e.g. encores).  If you like, copy the sources and give it a
30 try.  When you have it working send \fIdiff -c\fP's of the changed files to
31 bug-gdb@prep.ai.mit.edu (fuller details below), so they can benefit everyone.
32 .SH DISTRIBUTION
33 \fIgdb\fP is free; anyone may redistribute copies of
34 \fIgdb\fP to anyone under the terms stated in the
35 \fIgdb\fP General Public License, a copy of which accompanies each copy of
36 \fIgdb\fP, is readable with the info command inside \fIgdb\fP,
37 and which also appears in the \fIgdb\fP reference manual.
38 .PP
39 Copies of \fIgdb\fP may sometimes be received packaged with
40 distributions of Unix systems, but it is never included in the scope
41 of any license covering those systems.  Such inclusion would violate
42 the terms on which distribution is permitted.  In fact, the primary
43 purpose of the General Public License is to prohibit anyone from
44 attaching any other restrictions to redistribution of \fIgdb\fP.
45 .PP
46 You can order printed copies of the \fIgdb\fP reference manual for $10.00/copy
47 postpaid from the Free Software Foundation, which develops GNU software
48 (contact them for quantity prices on the manual).  Their address is:
49 .nf
50     Free Software Foundation
51     1000 Mass Ave.
52     Cambridge, MA  02138
53 .fi
54 As with all software and publications from FSF, everyone is permitted to
55 make and distribute copies of the \fIgdb\fP reference manual.
56 The TeX source to the \fIgdb\fP reference
57 manual is also included in the \fIGNU Emacs\fP source distribution.
58 .PP
59 .SH OPTIONS
60 See documentation.
61 .SH EXAMPLES
62 See documentation.
63 .SH "SEE ALSO"
64 adb(1), sdb(1), dbx(1)
65 .SH BUGS
66 There is a mailing list, bug-gdb@prep.ai.mit.edu on the internet
67 (ucbvax!prep.ai.mit.edu!bug-gdb on UUCPnet), for reporting \fIgdb\fP
68 bugs and fixes.  But before reporting something as a bug, please try
69 to be sure that it really is a bug, not a misunderstanding or a
70 deliberate feature.  We ask you to read the section ``Reporting Emacs
71 Bugs'' near the end of the \fIGNU Emacs\fP reference manual
72 (or Info system) for hints
73 on how and when to report bugs.  Also, include the version number of
74 the \fIgdb\fP you are running in \fIevery\fR bug report that you send in.
75 .PP
76 Do not expect a personal answer to a bug report.  The purpose of reporting
77 bugs is to get them fixed for everyone in the next release, if possible.
78 For personal assistance, look in the SERVICE file
79 (see the \fIGNU Emacs\fP man page) for
80 a list of people who offer it.
81 .PP
82 Please do not send anything but bug reports to this mailing list.
83 Send other stuff to gnu@prep.ai.mit.edu (or the
84 corresponding UUCP address).  For more information about GNU mailing
85 lists, see the file MAILINGLISTS (see the \fIGNU Emacs\fP man page).  Bugs tend
86 actually to be fixed if they can be isolated, so it is in your
87 interest to report them in such a way that they can be easily
88 reproduced.
89 .PP
90 No bugs are known at this time.
91