Mercurial > emacs
annotate man/building.texi @ 62666:51db72745571
(Debugger Operation): Simplify last sentence.
author | Nick Roberts <nickrob@snap.net.nz> |
---|---|
date | Tue, 24 May 2005 04:42:37 +0000 |
parents | 39bedd779f48 |
children | 718dc622c12e 5b029ff3b08d |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
39287 | 2 @c Copyright (C) 1985,86,87,93,94,95,97,2000,2001 Free Software Foundation, Inc. |
25829 | 3 @c See file emacs.texi for copying conditions. |
38202 | 4 @node Building, Maintaining, Programs, Top |
25829 | 5 @chapter Compiling and Testing Programs |
6 @cindex building programs | |
7 @cindex program building | |
8 @cindex running Lisp functions | |
9 | |
10 The previous chapter discusses the Emacs commands that are useful for | |
11 making changes in programs. This chapter deals with commands that assist | |
12 in the larger process of developing and maintaining programs. | |
13 | |
14 @menu | |
15 * Compilation:: Compiling programs in languages other | |
16 than Lisp (C, Pascal, etc.). | |
17 * Compilation Mode:: The mode for visiting compiler errors. | |
18 * Compilation Shell:: Customizing your shell properly | |
19 for use in the compilation buffer. | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
20 * Grep Searching:: Searching with grep. |
61050 | 21 * Flymake:: Finding syntax errors on the fly. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49062
diff
changeset
|
22 * Debuggers:: Running symbolic debuggers for non-Lisp programs. |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49062
diff
changeset
|
23 * Executing Lisp:: Various modes for editing Lisp programs, |
25829 | 24 with different facilities for running |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49062
diff
changeset
|
25 the Lisp programs. |
25829 | 26 * Libraries: Lisp Libraries. Creating Lisp programs to run in Emacs. |
56808
00b9078008ef
(Building): Interchange nodes (for correct numbering).
Luc Teirlinck <teirllm@auburn.edu>
parents:
56007
diff
changeset
|
27 * Eval: Lisp Eval. Executing a single Lisp expression in Emacs. |
25829 | 28 * Interaction: Lisp Interaction. Executing Lisp in an Emacs buffer. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49062
diff
changeset
|
29 * External Lisp:: Communicating through Emacs with a separate Lisp. |
25829 | 30 @end menu |
31 | |
32 @node Compilation | |
33 @section Running Compilations under Emacs | |
34 @cindex inferior process | |
35 @cindex make | |
36 @cindex compilation errors | |
37 @cindex error log | |
38 | |
39 Emacs can run compilers for noninteractive languages such as C and | |
40 Fortran as inferior processes, feeding the error log into an Emacs buffer. | |
41 It can also parse the error messages and show you the source lines where | |
42 compilation errors occurred. | |
43 | |
44 @table @kbd | |
45 @item M-x compile | |
37482
4b43d9f652aa
Correct typo on pdb-mode-hook.
Richard M. Stallman <rms@gnu.org>
parents:
37346
diff
changeset
|
46 Run a compiler asynchronously under Emacs, with error messages going to |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
47 the @samp{*compilation*} buffer. |
39820
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
48 @item M-x recompile |
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
49 Invoke a compiler with the same command as in the last invocation of |
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
50 @kbd{M-x compile}. |
25829 | 51 @item M-x grep |
52 Run @code{grep} asynchronously under Emacs, with matching lines | |
53 listed in the buffer named @samp{*grep*}. | |
54 @item M-x grep-find | |
59688
3761d1e2619d
* NEWS: Mention alias `find-grep' for `grep-find'.
David Kastrup <dak@gnu.org>
parents:
58369
diff
changeset
|
55 @item M-x find-grep |
25829 | 56 Run @code{grep} via @code{find}, with user-specified arguments, and |
57 collect output in the buffer named @samp{*grep*}. | |
58 @item M-x kill-compilation | |
59 @itemx M-x kill-grep | |
60 Kill the running compilation or @code{grep} subprocess. | |
61 @end table | |
62 | |
63 @findex compile | |
64 To run @code{make} or another compilation command, do @kbd{M-x | |
65 compile}. This command reads a shell command line using the minibuffer, | |
66 and then executes the command in an inferior shell, putting output in | |
67 the buffer named @samp{*compilation*}. The current buffer's default | |
68 directory is used as the working directory for the execution of the | |
69 command; normally, therefore, the compilation happens in this | |
70 directory. | |
71 | |
72 @vindex compile-command | |
48071
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
73 When the shell command line is read, the minibuffer appears |
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
74 containing a default command line, which is the command you used the |
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
75 last time you did @kbd{M-x compile}. If you type just @key{RET}, the |
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
76 same command line is used again. For the first @kbd{M-x compile}, the |
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
77 default is @samp{make -k}, which is correct most of the time for |
50475
b65aa1d740eb
Fix cross references.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
78 nontrivial programs. (@xref{Top,, Make, make, GNU Make Manual}.) |
48071
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
79 The default compilation command comes from the variable |
25829 | 80 @code{compile-command}; if the appropriate compilation command for a |
81 file is something other than @samp{make -k}, it can be useful for the | |
82 file to specify a local value for @code{compile-command} (@pxref{File | |
83 Variables}). | |
84 | |
85 Starting a compilation displays the buffer @samp{*compilation*} in | |
60278
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
86 another window but does not select it. The buffer's mode line tells |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
87 you whether compilation is finished, with the word @samp{run}, |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
88 @samp{signal} or @samp{exit} inside the parentheses. You do not have |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
89 to keep this buffer visible; compilation continues in any case. While |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
90 a compilation is going on, the string @samp{Compiling} appears in the |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
91 mode lines of all windows. When this string disappears, the |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
92 compilation is finished. |
25829 | 93 |
94 If you want to watch the compilation transcript as it appears, switch | |
95 to the @samp{*compilation*} buffer and move point to the end of the | |
96 buffer. When point is at the end, new compilation output is inserted | |
97 above point, which remains at the end. If point is not at the end of | |
98 the buffer, it remains fixed while more compilation output is added at | |
99 the end of the buffer. | |
100 | |
34935
390058c38d27
Add a cindex entry for compilation-scroll-output. Duplicate the variable's
Eli Zaretskii <eliz@gnu.org>
parents:
31027
diff
changeset
|
101 @cindex compilation buffer, keeping current position at the end |
25829 | 102 @vindex compilation-scroll-output |
103 If you set the variable @code{compilation-scroll-output} to a | |
104 non-@code{nil} value, then the compilation buffer always scrolls to | |
105 follow output as it comes in. | |
106 | |
107 @findex kill-compilation | |
51791
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
108 When the compiler process terminates, for whatever reason, the mode |
60278
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
109 line of the @samp{*compilation*} buffer changes to say @samp{exit} |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
110 (followed by the exit code, @samp{[0]} for a normal exit), or |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
111 @samp{signal} (if a signal terminated the process), instead of |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
112 @samp{run}. Starting a new compilation also kills any running |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
113 compilation, as only one can exist at any time. However, @kbd{M-x |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
114 compile} asks for confirmation before actually killing a compilation |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
115 that is running. You can also kill the compilation process with |
f69c04fae9ff
(Compilation): Update mode line status info.
Richard M. Stallman <rms@gnu.org>
parents:
59825
diff
changeset
|
116 @kbd{M-x kill-compilation}. |
25829 | 117 |
39820
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
118 @findex recompile |
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
119 To rerun the last compilation with the same command, type @kbd{M-x |
62221
ebb9e325798e
(Compilation): Clarify recompile's directory choice.
Richard M. Stallman <rms@gnu.org>
parents:
62171
diff
changeset
|
120 recompile}. This automatically reuses the compilation command from |
ebb9e325798e
(Compilation): Clarify recompile's directory choice.
Richard M. Stallman <rms@gnu.org>
parents:
62171
diff
changeset
|
121 the last invocation of @kbd{M-x compile}. It also reuses the |
ebb9e325798e
(Compilation): Clarify recompile's directory choice.
Richard M. Stallman <rms@gnu.org>
parents:
62171
diff
changeset
|
122 @samp{*compilation*} buffer and starts the compilation in its default |
ebb9e325798e
(Compilation): Clarify recompile's directory choice.
Richard M. Stallman <rms@gnu.org>
parents:
62171
diff
changeset
|
123 directory, which is the directory in which the previous compilation |
ebb9e325798e
(Compilation): Clarify recompile's directory choice.
Richard M. Stallman <rms@gnu.org>
parents:
62171
diff
changeset
|
124 was started. |
39820
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
125 |
51791
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
126 Emacs does not expect a compiler process to launch asynchronous |
46362
36ac28961e4f
Say that output from asynch subprocesses of a compiler may be lost.
Richard M. Stallman <rms@gnu.org>
parents:
46238
diff
changeset
|
127 subprocesses; if it does, and they keep running after the main |
51791
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
128 compiler process has terminated, Emacs may kill them or their output |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
129 may not arrive in Emacs. To avoid this problem, make the main process |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
130 wait for its subprocesses to finish. In a shell script, you can do this |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
131 using @samp{$!} and @samp{wait}, like this: |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
132 |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
133 @example |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
134 (sleep 10; echo 2nd)& pid=$! # @r{Record pid of subprocess} |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
135 echo first message |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
136 wait $pid # @r{Wait for subprocess} |
2488d95d6eaa
(Compilation): Document what happens with asynch children of compiler process.
Richard M. Stallman <rms@gnu.org>
parents:
51296
diff
changeset
|
137 @end example |
46362
36ac28961e4f
Say that output from asynch subprocesses of a compiler may be lost.
Richard M. Stallman <rms@gnu.org>
parents:
46238
diff
changeset
|
138 |
57154
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
139 If the background process does not output to the compilation buffer, |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
140 so you only need to prevent it from being killed when the main |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
141 compilation process terminates, this is sufficient: |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
142 |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
143 @example |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
144 nohup @var{command}; sleep 1 |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
145 @end example |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
146 |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
147 @vindex compilation-environment |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
148 You can control the environment passed to the compilation command |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
149 with the variable @code{compilation-environment}. Its value is a list |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
150 of environment variable settings; each element should be a string of |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
151 the form @code{"@var{envvarname}=@var{value}"}. These environment |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
152 variable settings override the usual ones. |
fe97fe43464a
(Compilation): Explain how to make a silent subprocess that won't be
Richard M. Stallman <rms@gnu.org>
parents:
56873
diff
changeset
|
153 |
25829 | 154 @node Compilation Mode |
155 @section Compilation Mode | |
156 | |
157 @findex compile-goto-error | |
158 @cindex Compilation mode | |
159 @cindex mode, Compilation | |
160 The @samp{*compilation*} buffer uses a special major mode, Compilation | |
161 mode, whose main feature is to provide a convenient way to look at the | |
162 source line where the error happened. | |
163 | |
34935
390058c38d27
Add a cindex entry for compilation-scroll-output. Duplicate the variable's
Eli Zaretskii <eliz@gnu.org>
parents:
31027
diff
changeset
|
164 If you set the variable @code{compilation-scroll-output} to a |
390058c38d27
Add a cindex entry for compilation-scroll-output. Duplicate the variable's
Eli Zaretskii <eliz@gnu.org>
parents:
31027
diff
changeset
|
165 non-@code{nil} value, then the compilation buffer always scrolls to |
390058c38d27
Add a cindex entry for compilation-scroll-output. Duplicate the variable's
Eli Zaretskii <eliz@gnu.org>
parents:
31027
diff
changeset
|
166 follow output as it comes in. |
390058c38d27
Add a cindex entry for compilation-scroll-output. Duplicate the variable's
Eli Zaretskii <eliz@gnu.org>
parents:
31027
diff
changeset
|
167 |
25829 | 168 @table @kbd |
61652
91e895711c2e
(Compilation Mode): Add M-g M-n and M-g M-p bindings.
Kim F. Storm <storm@cua.dk>
parents:
61050
diff
changeset
|
169 @item M-g M-n |
91e895711c2e
(Compilation Mode): Add M-g M-n and M-g M-p bindings.
Kim F. Storm <storm@cua.dk>
parents:
61050
diff
changeset
|
170 @itemx M-g n |
91e895711c2e
(Compilation Mode): Add M-g M-n and M-g M-p bindings.
Kim F. Storm <storm@cua.dk>
parents:
61050
diff
changeset
|
171 @itemx C-x ` |
25829 | 172 Visit the locus of the next compiler error message or @code{grep} match. |
61652
91e895711c2e
(Compilation Mode): Add M-g M-n and M-g M-p bindings.
Kim F. Storm <storm@cua.dk>
parents:
61050
diff
changeset
|
173 @item M-g M-p |
91e895711c2e
(Compilation Mode): Add M-g M-n and M-g M-p bindings.
Kim F. Storm <storm@cua.dk>
parents:
61050
diff
changeset
|
174 @itemx M-g p |
91e895711c2e
(Compilation Mode): Add M-g M-n and M-g M-p bindings.
Kim F. Storm <storm@cua.dk>
parents:
61050
diff
changeset
|
175 Visit the locus of the previous compiler error message or @code{grep} match. |
25829 | 176 @item @key{RET} |
177 Visit the locus of the error message that point is on. | |
178 This command is used in the compilation buffer. | |
179 @item Mouse-2 | |
180 Visit the locus of the error message that you click on. | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
181 @item M-n |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
182 Find and highlight the locus of the next error message, without |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
183 selecting the source buffer. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
184 @item M-p |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
185 Find and highlight the locus of the previous error message, without |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
186 selecting the source buffer. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
187 @item M-@} |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
188 Move point to the next error for a different file than the current |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
189 one. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
190 @item M-@{ |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
191 Move point to the previous error for a different file than the current |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
192 one. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
193 @item C-c C-f |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
194 Toggle Next Error Follow minor mode, which makes cursor motion in the |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
195 compilation buffer produce automatic source display. |
25829 | 196 @end table |
197 | |
61652
91e895711c2e
(Compilation Mode): Add M-g M-n and M-g M-p bindings.
Kim F. Storm <storm@cua.dk>
parents:
61050
diff
changeset
|
198 @kindex M-g M-n |
91e895711c2e
(Compilation Mode): Add M-g M-n and M-g M-p bindings.
Kim F. Storm <storm@cua.dk>
parents:
61050
diff
changeset
|
199 @kindex M-g n |
25829 | 200 @kindex C-x ` |
201 @findex next-error | |
202 You can visit the source for any particular error message by moving | |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
203 point in the @samp{*compilation*} buffer to that error message and |
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
204 typing @key{RET} (@code{compile-goto-error}). Alternatively, you can |
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
205 click @kbd{Mouse-2} on the error message; you need not switch to the |
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
206 @samp{*compilation*} buffer first. |
25829 | 207 |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
208 @vindex next-error-highlight |
25829 | 209 To parse the compiler error messages sequentially, type @kbd{C-x `} |
210 (@code{next-error}). The character following the @kbd{C-x} is the | |
211 backquote or ``grave accent,'' not the single-quote. This command is | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
212 available in all buffers, not just in @samp{*compilation*}; it |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
213 displays the next error message at the top of one window and source |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
214 location of the error in another window. It also momentarily |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
215 highlights the relevant source line. You can change the behavior of |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
216 this highlighting with the variable @code{next-error-highlight}. |
25829 | 217 |
218 The first time @kbd{C-x `} is used after the start of a compilation, | |
219 it moves to the first error's location. Subsequent uses of @kbd{C-x `} | |
220 advance down to subsequent errors. If you visit a specific error | |
221 message with @key{RET} or @kbd{Mouse-2}, subsequent @kbd{C-x `} | |
222 commands advance from there. When @kbd{C-x `} gets to the end of the | |
223 buffer and finds no more error messages to visit, it fails and signals | |
224 an Emacs error. | |
225 | |
62384
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
226 When the left fringe is displayed, an arrow points to the |
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
227 current message in the compilation buffer. The variable |
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
228 @code{compilation-context-lines} controls the number of lines of |
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
229 leading context in the window before the current message. If it is |
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
230 @code{nil} and the left fringe is displayed, the window doesn't |
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
231 scroll. If there is no left fringe, no arrow is displayed and a value |
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
232 of @code{nil} means display the message at the top of the window. |
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
233 |
56873
875c4c833a38
(Compilation Mode): Add a paragraph about rules
Juri Linkov <juri@jurta.org>
parents:
56808
diff
changeset
|
234 You don't have to be in the compilation buffer in order to use |
875c4c833a38
(Compilation Mode): Add a paragraph about rules
Juri Linkov <juri@jurta.org>
parents:
56808
diff
changeset
|
235 @code{next-error}. If one window on the selected frame can be the |
875c4c833a38
(Compilation Mode): Add a paragraph about rules
Juri Linkov <juri@jurta.org>
parents:
56808
diff
changeset
|
236 target of the @code{next-error} call, it is used. Else, if a buffer |
875c4c833a38
(Compilation Mode): Add a paragraph about rules
Juri Linkov <juri@jurta.org>
parents:
56808
diff
changeset
|
237 previously had @code{next-error} called on it, it is used. Else, |
875c4c833a38
(Compilation Mode): Add a paragraph about rules
Juri Linkov <juri@jurta.org>
parents:
56808
diff
changeset
|
238 if the current buffer can be the target of @code{next-error}, it is |
875c4c833a38
(Compilation Mode): Add a paragraph about rules
Juri Linkov <juri@jurta.org>
parents:
56808
diff
changeset
|
239 used. Else, all the buffers Emacs manages are tried for |
875c4c833a38
(Compilation Mode): Add a paragraph about rules
Juri Linkov <juri@jurta.org>
parents:
56808
diff
changeset
|
240 @code{next-error} support. |
875c4c833a38
(Compilation Mode): Add a paragraph about rules
Juri Linkov <juri@jurta.org>
parents:
56808
diff
changeset
|
241 |
25829 | 242 @kbd{C-u C-x `} starts scanning from the beginning of the compilation |
243 buffer. This is one way to process the same set of errors again. | |
244 | |
37983
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
245 @vindex compilation-error-regexp-alist |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
246 @vindex grep-regexp-alist |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
247 To parse messages from the compiler, Compilation mode uses the |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
248 variable @code{compilation-error-regexp-alist} which lists various |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
249 formats of error messages and tells Emacs how to extract the source file |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
250 and the line number from the text of a message. If your compiler isn't |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
251 supported, you can tailor Compilation mode to it by adding elements to |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
252 that list. A similar variable @code{grep-regexp-alist} tells Emacs how |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
253 to parse output of a @code{grep} command. |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
254 |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
255 @findex compilation-next-error |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
256 @findex compilation-previous-error |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
257 @findex compilation-next-file |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
258 @findex compilation-previous-file |
25829 | 259 Compilation mode also redefines the keys @key{SPC} and @key{DEL} to |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
260 scroll by screenfuls, and @kbd{M-n} (@code{compilation-next-error}) |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
261 and @kbd{M-p} (@code{compilation-previous-error}) to move to the next |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
262 or previous error message. You can also use @kbd{M-@{} |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
263 (@code{compilation-next-file} and @kbd{M-@}} |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
264 (@code{compilation-previous-file}) to move up or down to an error |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
265 message for a different source file. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
266 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
267 @cindex Next Error Follow mode |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
268 @findex next-error-follow-minor-mode |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
269 You can type @kbd{C-c C-f} to toggle Next Error Follow mode. In |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
270 this minor mode, ordinary cursor motion in the compilation buffer |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
271 automatically updates the source buffer. For instance, moving the |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
272 cursor to the next error message causes the location of that error to |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
273 be displayed immediately. |
25829 | 274 |
275 The features of Compilation mode are also available in a minor mode | |
276 called Compilation Minor mode. This lets you parse error messages in | |
277 any buffer, not just a normal compilation output buffer. Type @kbd{M-x | |
278 compilation-minor-mode} to enable the minor mode. This defines the keys | |
279 @key{RET} and @kbd{Mouse-2}, as in the Compilation major mode. | |
280 | |
281 Compilation minor mode works in any buffer, as long as the contents | |
282 are in a format that it understands. In an Rlogin buffer (@pxref{Remote | |
283 Host}), Compilation minor mode automatically accesses remote source | |
284 files by FTP (@pxref{File Names}). | |
285 | |
286 @node Compilation Shell | |
287 @section Subshells for Compilation | |
288 | |
289 Emacs uses a shell to run the compilation command, but specifies | |
290 the option for a noninteractive shell. This means, in particular, that | |
291 the shell should start with no prompt. If you find your usual shell | |
292 prompt making an unsightly appearance in the @samp{*compilation*} | |
293 buffer, it means you have made a mistake in your shell's init file by | |
294 setting the prompt unconditionally. (This init file's name may be | |
295 @file{.bashrc}, @file{.profile}, @file{.cshrc}, @file{.shrc}, or various | |
296 other things, depending on the shell you use.) The shell init file | |
297 should set the prompt only if there already is a prompt. In csh, here | |
298 is how to do it: | |
299 | |
300 @example | |
301 if ($?prompt) set prompt = @dots{} | |
302 @end example | |
303 | |
304 @noindent | |
305 And here's how to do it in bash: | |
306 | |
307 @example | |
308 if [ "$@{PS1+set@}" = set ] | |
309 then PS1=@dots{} | |
310 fi | |
311 @end example | |
312 | |
313 There may well be other things that your shell's init file | |
314 ought to do only for an interactive shell. You can use the same | |
315 method to conditionalize them. | |
316 | |
317 The MS-DOS ``operating system'' does not support asynchronous | |
318 subprocesses; to work around this lack, @kbd{M-x compile} runs the | |
319 compilation command synchronously on MS-DOS. As a consequence, you must | |
320 wait until the command finishes before you can do anything else in | |
321 Emacs. @xref{MS-DOS}. | |
322 | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
323 @node Grep Searching |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
324 @section Searching with Grep under Emacs |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
325 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
326 @findex grep |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
327 Just as you can run a compiler from Emacs and then visit the lines |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
328 where there were compilation errors, you can also run @code{grep} and |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
329 then visit the lines on which matches were found. This works by |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
330 treating the matches reported by @code{grep} as if they were ``errors.'' |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
331 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
332 To do this, type @kbd{M-x grep}, then enter a command line that |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
333 specifies how to run @code{grep}. Use the same arguments you would give |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
334 @code{grep} when running it normally: a @code{grep}-style regexp |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
335 (usually in single-quotes to quote the shell's special characters) |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
336 followed by file names, which may use wildcards. If you specify a |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
337 prefix argument for @kbd{M-x grep}, it figures out the tag |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
338 (@pxref{Tags}) around point, and puts that into the default |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
339 @code{grep} command. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
340 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
341 The output from @code{grep} goes in the @samp{*grep*} buffer. You |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
342 can find the corresponding lines in the original files using @kbd{C-x |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
343 `}, @key{RET}, and so forth, just like compilation errors. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
344 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
345 Some grep programs accept a @samp{--color} option to output special |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
346 markers around matches for the purpose of highlighting. You can make |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
347 use of this feature by setting @code{grep-highlight-matches} to t. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
348 When displaying a match in the source buffer, the exact match will be |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
349 highlighted, instead of the entire source line. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
350 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
351 @findex grep-find |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
352 @findex find-grep |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
353 The command @kbd{M-x grep-find} (also available as @kbd{M-x |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
354 find-grep}) is similar to @kbd{M-x grep}, but it supplies a different |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
355 initial default for the command---one that runs both @code{find} and |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
356 @code{grep}, so as to search every file in a directory tree. See also |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
357 the @code{find-grep-dired} command, in @ref{Dired and Find}. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
358 |
61050 | 359 @node Flymake |
360 @section Finding Syntax Errors On The Fly | |
361 @cindex checking syntax | |
362 | |
363 Flymake mode is a minor mode that performs on-the-fly syntax | |
364 checking for many programming and markup languages, including C, C++, | |
365 Perl, HTML, and @TeX{}/La@TeX{}. It is somewhat analogous to Flyspell | |
366 mode, which performs spell checking for ordinary human languages in a | |
367 similar fashion (@pxref{Spelling}). As you edit a file, Flymake mode | |
368 runs an appropriate syntax checking tool in the background, using a | |
369 temporary copy of the buffer. It then parses the error and warning | |
370 messages, and highlights the erroneous lines in the buffer. The | |
371 syntax checking tool used depends on the language; for example, for | |
372 C/C++ files this is usually the C compiler. Flymake can also use | |
373 build tools such as @code{make} for checking complicated projects. | |
374 | |
375 To activate Flymake mode, type @kbd{M-x flymake-mode}. You can move | |
376 to the errors spotted by Flymake mode with @kbd{M-x | |
377 flymake-goto-next-error} and @kbd{M-x flymake-goto-prev-error}. To | |
378 display any error messages associated with the current line, use | |
379 @kbd{M-x flymake-display-err-menu-for-current-line}. | |
380 | |
381 For more details about using Flymake, see @ref{Top, Flymake, | |
382 Flymake, flymake, The Flymake Manual}. | |
383 | |
25829 | 384 @node Debuggers |
385 @section Running Debuggers Under Emacs | |
386 @cindex debuggers | |
387 @cindex GUD library | |
388 @cindex GDB | |
389 @cindex DBX | |
390 @cindex SDB | |
391 @cindex XDB | |
392 @cindex Perldb | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
393 @cindex bashdb |
25829 | 394 @cindex JDB |
395 @cindex PDB | |
396 | |
397 @c Do you believe in GUD? | |
398 The GUD (Grand Unified Debugger) library provides an interface to | |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
399 various symbolic debuggers from within Emacs. We recommend the |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
400 debugger GDB, which is free software, but you can also run DBX, SDB or |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
401 XDB if you have them. GUD can also serve as an interface to Perl's |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
402 debugging mode, the Python debugger PDB, the bash debugger, and to |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
403 JDB, the Java Debugger. @xref{Debugging,, The Lisp Debugger, elisp, |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
404 the Emacs Lisp Reference Manual}, for information on debugging Emacs |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
405 Lisp programs. |
25829 | 406 |
407 @menu | |
408 * Starting GUD:: How to start a debugger subprocess. | |
409 * Debugger Operation:: Connection between the debugger and source buffers. | |
410 * Commands of GUD:: Key bindings for common commands. | |
411 * GUD Customization:: Defining your own commands for GUD. | |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
412 * GDB Graphical Interface:: An enhanced mode that uses GDB features to |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
413 implement a graphical debugging environment through |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
414 Emacs. |
25829 | 415 @end menu |
416 | |
417 @node Starting GUD | |
418 @subsection Starting GUD | |
419 | |
420 There are several commands for starting a debugger, each corresponding | |
421 to a particular debugger program. | |
422 | |
423 @table @kbd | |
424 @item M-x gdb @key{RET} @var{file} @key{RET} | |
425 @findex gdb | |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
426 Run GDB as a subprocess of Emacs. By default, this operates in |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
427 graphical mode; @xref{GDB Graphical Interface}. Graphical mode |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
428 does not support any other debuggers. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
429 |
25829 | 430 @item M-x dbx @key{RET} @var{file} @key{RET} |
431 @findex dbx | |
38490 | 432 Similar, but run DBX instead of GDB. |
25829 | 433 |
434 @item M-x xdb @key{RET} @var{file} @key{RET} | |
435 @findex xdb | |
436 @vindex gud-xdb-directories | |
38490 | 437 Similar, but run XDB instead of GDB. Use the variable |
25829 | 438 @code{gud-xdb-directories} to specify directories to search for source |
439 files. | |
440 | |
441 @item M-x sdb @key{RET} @var{file} @key{RET} | |
442 @findex sdb | |
38490 | 443 Similar, but run SDB instead of GDB. |
25829 | 444 |
445 Some versions of SDB do not mention source file names in their | |
446 messages. When you use them, you need to have a valid tags table | |
447 (@pxref{Tags}) in order for GUD to find functions in the source code. | |
448 If you have not visited a tags table or the tags table doesn't list one | |
449 of the functions, you get a message saying @samp{The sdb support | |
450 requires a valid tags table to work}. If this happens, generate a valid | |
451 tags table in the working directory and try again. | |
452 | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
453 @item M-x bashdb @key{RET} @var{file} @key{RET} |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
454 @findex bashdb |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
455 Run the bash debugger to debug @var{file}, a shell script. |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
456 |
25829 | 457 @item M-x perldb @key{RET} @var{file} @key{RET} |
458 @findex perldb | |
459 Run the Perl interpreter in debug mode to debug @var{file}, a Perl program. | |
460 | |
461 @item M-x jdb @key{RET} @var{file} @key{RET} | |
462 @findex jdb | |
463 Run the Java debugger to debug @var{file}. | |
464 | |
465 @item M-x pdb @key{RET} @var{file} @key{RET} | |
466 @findex pdb | |
467 Run the Python debugger to debug @var{file}. | |
468 @end table | |
469 | |
470 Each of these commands takes one argument: a command line to invoke | |
471 the debugger. In the simplest case, specify just the name of the | |
472 executable file you want to debug. You may also use options that the | |
473 debugger supports. However, shell wildcards and variables are not | |
474 allowed. GUD assumes that the first argument not starting with a | |
475 @samp{-} is the executable file name. | |
476 | |
477 @node Debugger Operation | |
478 @subsection Debugger Operation | |
479 | |
42904
0e87fd2f82b4
(Debugger Operation): Add index entries for fringe usage.
Eli Zaretskii <eliz@gnu.org>
parents:
39820
diff
changeset
|
480 @cindex fringes, and current execution line in GUD |
25829 | 481 When you run a debugger with GUD, the debugger uses an Emacs buffer |
482 for its ordinary input and output. This is called the GUD buffer. The | |
483 debugger displays the source files of the program by visiting them in | |
484 Emacs buffers. An arrow (@samp{=>}) in one of these buffers indicates | |
42913 | 485 the current execution line.@footnote{Under a window system, the arrow |
486 appears in the left fringe of the Emacs window.} Moving point in this | |
487 buffer does not move the arrow. | |
25829 | 488 |
489 You can start editing these source files at any time in the buffers | |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
490 that display them. The arrow is not part of the file's |
25829 | 491 text; it appears only on the screen. If you do modify a source file, |
492 keep in mind that inserting or deleting lines will throw off the arrow's | |
493 positioning; GUD has no way of figuring out which line corresponded | |
494 before your changes to the line number in a debugger message. Also, | |
495 you'll typically have to recompile and restart the program for your | |
496 changes to be reflected in the debugger's tables. | |
497 | |
498 If you wish, you can control your debugger process entirely through the | |
499 debugger buffer, which uses a variant of Shell mode. All the usual | |
500 commands for your debugger are available, and you can use the Shell mode | |
501 history commands to repeat them. @xref{Shell Mode}. | |
502 | |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
503 @cindex tooltips with GUD |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
504 @vindex tooltip-gud-modes |
62171
83608278e922
(Debugger Operation): Describe gud-tooltip-echo-area.
Nick Roberts <nickrob@snap.net.nz>
parents:
62143
diff
changeset
|
505 @vindex gud-tooltip-mode |
83608278e922
(Debugger Operation): Describe gud-tooltip-echo-area.
Nick Roberts <nickrob@snap.net.nz>
parents:
62143
diff
changeset
|
506 @vindex gud-tooltip-echo-area |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
507 The Tooltip facility (@pxref{Tooltips}) provides support for GUD@. |
62143
892a16c3b886
(Debugger Operation): Update to reflect changes
Nick Roberts <nickrob@snap.net.nz>
parents:
61951
diff
changeset
|
508 You activate this feature by turning on the minor mode |
892a16c3b886
(Debugger Operation): Update to reflect changes
Nick Roberts <nickrob@snap.net.nz>
parents:
61951
diff
changeset
|
509 @code{gud-tooltip-mode}. Then you can display a variable's value in a |
892a16c3b886
(Debugger Operation): Update to reflect changes
Nick Roberts <nickrob@snap.net.nz>
parents:
61951
diff
changeset
|
510 tooltip simply by pointing at it with the mouse. In graphical mode, |
892a16c3b886
(Debugger Operation): Update to reflect changes
Nick Roberts <nickrob@snap.net.nz>
parents:
61951
diff
changeset
|
511 with a C program, you can also display the @code{#define} directive |
892a16c3b886
(Debugger Operation): Update to reflect changes
Nick Roberts <nickrob@snap.net.nz>
parents:
61951
diff
changeset
|
512 associated with an identifier when the program is not executing. This |
892a16c3b886
(Debugger Operation): Update to reflect changes
Nick Roberts <nickrob@snap.net.nz>
parents:
61951
diff
changeset
|
513 operates in the GUD buffer and in source buffers with major modes in |
62171
83608278e922
(Debugger Operation): Describe gud-tooltip-echo-area.
Nick Roberts <nickrob@snap.net.nz>
parents:
62143
diff
changeset
|
514 the list @code{gud-tooltip-modes}. If the variable |
62384
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
515 @code{gud-tooltip-echo-area} is non-@code{nil} then the variable's |
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
516 value is displayed in the echo area. |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
517 |
62405
39bedd779f48
(Debugger Operation): Mention GUD tooltips are disabled with GDB in text
Nick Roberts <nickrob@snap.net.nz>
parents:
62384
diff
changeset
|
518 With GDB in text command mode (@pxref{GDB Graphical Interface}), |
39bedd779f48
(Debugger Operation): Mention GUD tooltips are disabled with GDB in text
Nick Roberts <nickrob@snap.net.nz>
parents:
62384
diff
changeset
|
519 it is possible that use of GUD tooltips can cause a function to be |
39bedd779f48
(Debugger Operation): Mention GUD tooltips are disabled with GDB in text
Nick Roberts <nickrob@snap.net.nz>
parents:
62384
diff
changeset
|
520 called with harmful side-effects. In this case, Emacs disables |
62666
51db72745571
(Debugger Operation): Simplify last sentence.
Nick Roberts <nickrob@snap.net.nz>
parents:
62405
diff
changeset
|
521 them. |
62405
39bedd779f48
(Debugger Operation): Mention GUD tooltips are disabled with GDB in text
Nick Roberts <nickrob@snap.net.nz>
parents:
62384
diff
changeset
|
522 |
25829 | 523 @node Commands of GUD |
524 @subsection Commands of GUD | |
525 | |
526 The GUD interaction buffer uses a variant of Shell mode, so the | |
527 commands of Shell mode are available (@pxref{Shell Mode}). GUD mode | |
528 also provides commands for setting and clearing breakpoints, for | |
529 selecting stack frames, and for stepping through the program. These | |
530 commands are available both in the GUD buffer and globally, but with | |
62384
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
531 different key bindings. It also has its own tool bar from which you |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
532 can invoke the more common commands by clicking on the appropriate |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
533 icon. This is particularly useful for repetitive commands like |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
534 gud-next and gud-step and allows the user to hide the GUD buffer. |
25829 | 535 |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
536 The breakpoint commands are normally used in source file buffers, |
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
537 because that is the easiest way to specify where to set or clear the |
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
538 breakpoint. Here's the global command to set a breakpoint: |
25829 | 539 |
540 @table @kbd | |
541 @item C-x @key{SPC} | |
542 @kindex C-x SPC | |
543 Set a breakpoint on the source line that point is on. | |
544 @end table | |
545 | |
546 @kindex C-x C-a @r{(GUD)} | |
547 Here are the other special commands provided by GUD. The keys | |
548 starting with @kbd{C-c} are available only in the GUD interaction | |
549 buffer. The key bindings that start with @kbd{C-x C-a} are available in | |
550 the GUD interaction buffer and also in source files. | |
551 | |
552 @table @kbd | |
553 @item C-c C-l | |
554 @kindex C-c C-l @r{(GUD)} | |
555 @itemx C-x C-a C-l | |
556 @findex gud-refresh | |
557 Display in another window the last line referred to in the GUD | |
558 buffer (that is, the line indicated in the last location message). | |
559 This runs the command @code{gud-refresh}. | |
560 | |
561 @item C-c C-s | |
562 @kindex C-c C-s @r{(GUD)} | |
563 @itemx C-x C-a C-s | |
564 @findex gud-step | |
565 Execute a single line of code (@code{gud-step}). If the line contains | |
566 a function call, execution stops after entering the called function. | |
567 | |
568 @item C-c C-n | |
569 @kindex C-c C-n @r{(GUD)} | |
570 @itemx C-x C-a C-n | |
571 @findex gud-next | |
572 Execute a single line of code, stepping across entire function calls | |
573 at full speed (@code{gud-next}). | |
574 | |
575 @item C-c C-i | |
576 @kindex C-c C-i @r{(GUD)} | |
577 @itemx C-x C-a C-i | |
578 @findex gud-stepi | |
579 Execute a single machine instruction (@code{gud-stepi}). | |
580 | |
581 @need 3000 | |
582 @item C-c C-r | |
583 @kindex C-c C-r @r{(GUD)} | |
584 @itemx C-x C-a C-r | |
585 @findex gud-cont | |
586 Continue execution without specifying any stopping point. The program | |
587 will run until it hits a breakpoint, terminates, or gets a signal that | |
588 the debugger is checking for (@code{gud-cont}). | |
589 | |
590 @need 1000 | |
591 @item C-c C-d | |
592 @kindex C-c C-d @r{(GUD)} | |
593 @itemx C-x C-a C-d | |
594 @findex gud-remove | |
595 Delete the breakpoint(s) on the current source line, if any | |
596 (@code{gud-remove}). If you use this command in the GUD interaction | |
597 buffer, it applies to the line where the program last stopped. | |
598 | |
599 @item C-c C-t | |
600 @kindex C-c C-t @r{(GUD)} | |
601 @itemx C-x C-a C-t | |
602 @findex gud-tbreak | |
603 Set a temporary breakpoint on the current source line, if any. | |
604 If you use this command in the GUD interaction buffer, | |
605 it applies to the line where the program last stopped. | |
606 @end table | |
607 | |
608 The above commands are common to all supported debuggers. If you are | |
609 using GDB or (some versions of) DBX, these additional commands are available: | |
610 | |
611 @table @kbd | |
612 @item C-c < | |
613 @kindex C-c < @r{(GUD)} | |
614 @itemx C-x C-a < | |
615 @findex gud-up | |
616 Select the next enclosing stack frame (@code{gud-up}). This is | |
617 equivalent to the @samp{up} command. | |
618 | |
619 @item C-c > | |
620 @kindex C-c > @r{(GUD)} | |
621 @itemx C-x C-a > | |
622 @findex gud-down | |
623 Select the next inner stack frame (@code{gud-down}). This is | |
624 equivalent to the @samp{down} command. | |
625 @end table | |
626 | |
627 If you are using GDB, these additional key bindings are available: | |
628 | |
629 @table @kbd | |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
630 @item C-c C-r |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
631 @kindex C-c C-r @r{(GUD)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
632 @itemx C-x C-a C-r |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
633 @findex gud-run |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
634 Start execution of the program (@code{gud-run}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
635 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
636 @item C-c C-u |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
637 @kindex C-c C-u @r{(GUD)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
638 @itemx C-x C-a C-u |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
639 @findex gud-until |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
640 Continue execution to the current line. The program will run until |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
641 it hits a breakpoint, terminates, gets a signal that the debugger is |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
642 checking for, or reaches the line on which the cursor currently sits |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
643 (@code{gud-until}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
644 |
25829 | 645 @item @key{TAB} |
646 @kindex TAB @r{(GUD)} | |
647 @findex gud-gdb-complete-command | |
648 With GDB, complete a symbol name (@code{gud-gdb-complete-command}). | |
649 This key is available only in the GUD interaction buffer, and requires | |
650 GDB versions 4.13 and later. | |
651 | |
652 @item C-c C-f | |
653 @kindex C-c C-f @r{(GUD)} | |
654 @itemx C-x C-a C-f | |
655 @findex gud-finish | |
656 Run the program until the selected stack frame returns (or until it | |
657 stops for some other reason). | |
43137
bc055bf06a94
(Commands of GUD): Add gud-jump.
Richard M. Stallman <rms@gnu.org>
parents:
42913
diff
changeset
|
658 |
46238
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
659 @item C-x C-a C-j |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
660 @kindex C-x C-a C-j @r{(GUD)} |
43137
bc055bf06a94
(Commands of GUD): Add gud-jump.
Richard M. Stallman <rms@gnu.org>
parents:
42913
diff
changeset
|
661 @findex gud-jump |
46238
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
662 Only useful in a source buffer, (@code{gud-jump}) transfers the |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
663 program's execution point to the current line. In other words, the |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
664 next line that the program executes will be the one where you gave the |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
665 command. If the new execution line is in a different function from |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
666 the previously one, GDB prompts for confirmation since the results may |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
667 be bizarre. See the GDB manual entry regarding @code{jump} for |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
668 details. |
25829 | 669 @end table |
670 | |
671 These commands interpret a numeric argument as a repeat count, when | |
672 that makes sense. | |
673 | |
674 Because @key{TAB} serves as a completion command, you can't use it to | |
675 enter a tab as input to the program you are debugging with GDB. | |
676 Instead, type @kbd{C-q @key{TAB}} to enter a tab. | |
677 | |
678 @node GUD Customization | |
679 @subsection GUD Customization | |
680 | |
681 @vindex gdb-mode-hook | |
682 @vindex dbx-mode-hook | |
683 @vindex sdb-mode-hook | |
684 @vindex xdb-mode-hook | |
685 @vindex perldb-mode-hook | |
686 @vindex pdb-mode-hook | |
687 @vindex jdb-mode-hook | |
688 On startup, GUD runs one of the following hooks: @code{gdb-mode-hook}, | |
689 if you are using GDB; @code{dbx-mode-hook}, if you are using DBX; | |
690 @code{sdb-mode-hook}, if you are using SDB; @code{xdb-mode-hook}, if you | |
691 are using XDB; @code{perldb-mode-hook}, for Perl debugging mode; | |
37482
4b43d9f652aa
Correct typo on pdb-mode-hook.
Richard M. Stallman <rms@gnu.org>
parents:
37346
diff
changeset
|
692 @code{pdb-mode-hook}, for PDB; @code{jdb-mode-hook}, for JDB. You can |
25829 | 693 use these hooks to define custom key bindings for the debugger |
694 interaction buffer. @xref{Hooks}. | |
695 | |
696 Here is a convenient way to define a command that sends a particular | |
697 command string to the debugger, and set up a key binding for it in the | |
698 debugger interaction buffer: | |
699 | |
700 @findex gud-def | |
701 @example | |
702 (gud-def @var{function} @var{cmdstring} @var{binding} @var{docstring}) | |
703 @end example | |
704 | |
705 This defines a command named @var{function} which sends | |
706 @var{cmdstring} to the debugger process, and gives it the documentation | |
38743 | 707 string @var{docstring}. You can then use the command @var{function} in any |
25829 | 708 buffer. If @var{binding} is non-@code{nil}, @code{gud-def} also binds |
709 the command to @kbd{C-c @var{binding}} in the GUD buffer's mode and to | |
710 @kbd{C-x C-a @var{binding}} generally. | |
711 | |
712 The command string @var{cmdstring} may contain certain | |
713 @samp{%}-sequences that stand for data to be filled in at the time | |
714 @var{function} is called: | |
715 | |
716 @table @samp | |
717 @item %f | |
718 The name of the current source file. If the current buffer is the GUD | |
719 buffer, then the ``current source file'' is the file that the program | |
720 stopped in. | |
721 @c This said, ``the name of the file the program counter was in at the last breakpoint.'' | |
722 @c But I suspect it is really the last stop file. | |
723 | |
724 @item %l | |
725 The number of the current source line. If the current buffer is the GUD | |
726 buffer, then the ``current source line'' is the line that the program | |
727 stopped in. | |
728 | |
729 @item %e | |
730 The text of the C lvalue or function-call expression at or adjacent to point. | |
731 | |
732 @item %a | |
733 The text of the hexadecimal address at or adjacent to point. | |
734 | |
735 @item %p | |
736 The numeric argument of the called function, as a decimal number. If | |
737 the command is used without a numeric argument, @samp{%p} stands for the | |
738 empty string. | |
739 | |
740 If you don't use @samp{%p} in the command string, the command you define | |
741 ignores any numeric argument. | |
742 @end table | |
743 | |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
744 @node GDB Graphical Interface |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
745 @subsection GDB Graphical Interface |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
746 |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
747 By default, the command @code{gdb} starts GDB using a graphical |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
748 interface where you view and control the program's data using Emacs |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
749 windows. You can still interact with GDB through the GUD buffer, but |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
750 the point of this mode is that you can do it through menus and clicks, |
60594
362e4cd2e9f8
(Commands of GUD): Move paragraph on setting
Nick Roberts <nickrob@snap.net.nz>
parents:
60493
diff
changeset
|
751 without needing to know GDB commands. For example, you can click |
362e4cd2e9f8
(Commands of GUD): Move paragraph on setting
Nick Roberts <nickrob@snap.net.nz>
parents:
60493
diff
changeset
|
752 @kbd{Mouse-1} on a line of the source buffer, in the fringe or display |
362e4cd2e9f8
(Commands of GUD): Move paragraph on setting
Nick Roberts <nickrob@snap.net.nz>
parents:
60493
diff
changeset
|
753 margin, to set a breakpoint there. If a breakpoint already exists on |
362e4cd2e9f8
(Commands of GUD): Move paragraph on setting
Nick Roberts <nickrob@snap.net.nz>
parents:
60493
diff
changeset
|
754 that line, this action will remove it |
362e4cd2e9f8
(Commands of GUD): Move paragraph on setting
Nick Roberts <nickrob@snap.net.nz>
parents:
60493
diff
changeset
|
755 (@code{gdb-mouse-set-clear-breakpoint}). Where Emacs uses the margin |
362e4cd2e9f8
(Commands of GUD): Move paragraph on setting
Nick Roberts <nickrob@snap.net.nz>
parents:
60493
diff
changeset
|
756 to display breakpoints, it is also possible to enable or disable them |
362e4cd2e9f8
(Commands of GUD): Move paragraph on setting
Nick Roberts <nickrob@snap.net.nz>
parents:
60493
diff
changeset
|
757 when you click @kbd{Mouse-3} there |
62384
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
758 (@code{gdb-mouse-toggle-breakpoint}). |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
759 |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
760 @vindex gud-gdb-command-name |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
761 @findex gdba |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
762 You can also run GDB in text command mode, which creates a buffer |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
763 for input and output to GDB. To do this, set |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
764 @code{gud-gdb-command-name} to @code{"gdb --fullname"} or edit the |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
765 startup command in the minibuffer to say that. You need to do use |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
766 text command mode to run multiple debugging sessions within one Emacs |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
767 session. If you have customised @code{gud-gdb-command-name} in that |
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
768 way, then you can use @kbd{M-x gdba} to invoke GDB in graphical mode. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
769 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
770 @menu |
55577
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
771 * Layout:: Control the number of displayed buffers. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
772 * Breakpoints Buffer:: A breakpoint control panel. |
56808
00b9078008ef
(Building): Interchange nodes (for correct numbering).
Luc Teirlinck <teirllm@auburn.edu>
parents:
56007
diff
changeset
|
773 * Stack Buffer:: Select a frame from the call stack. |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
774 * Watch Expressions:: Monitor variable values in the speedbar. |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
775 * Other Buffers:: Input/output, locals, registers, assembler, threads |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
776 and memory buffers. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
777 @end menu |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
778 |
55577
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
779 @node Layout |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
780 @subsubsection Layout |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
781 @cindex GDB User Interface layout |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
782 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
783 @findex gdb-many-windows |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
784 @vindex gdb-many-windows |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
785 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
786 If the variable @code{gdb-many-windows} is @code{nil} (the default |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
787 value) then gdb just pops up the GUD buffer unless the variable |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
788 @code{gdb-show-main} is non-@code{nil}. In this case it starts with |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
789 two windows: one displaying the GUD buffer and the other with the |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
790 source file with the main routine of the inferior. |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
791 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
792 If @code{gdb-many-windows} is non-@code{nil}, regardless of the value of |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
793 @code{gdb-show-main}, the layout below will appear unless |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
794 @code{gdb-use-inferior-io-buffer} is @code{nil}. In this case the |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
795 source buffer occupies the full width of the frame. |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
796 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
797 @multitable @columnfractions .5 .5 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
798 @item GUD buffer (I/O of GDB) |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
799 @tab Locals buffer |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
800 @item |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
801 @tab |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
802 @item Source buffer |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
803 @tab Input/Output (of inferior) buffer |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
804 @item |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
805 @tab |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
806 @item Stack buffer |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
807 @tab Breakpoints buffer |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
808 @end multitable |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
809 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
810 To toggle this layout, do @kbd{M-x gdb-many-windows}. |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
811 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
812 @findex gdb-restore-windows |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
813 If you change the window layout, for example, while editing and |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
814 re-compiling your program, then you can restore it with the command |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
815 @code{gdb-restore-windows}. |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
816 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
817 You may also choose which additional buffers you want to display, |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
818 either in the same frame or a different one. Select GDB-windows or |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
819 GDB-Frames from the menu-bar under the heading GUD. If the menu-bar |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
820 is unavailable, type @code{M-x |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
821 gdb-display-@var{buffertype}-buffer} or @code{M-x |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
822 gdb-frame-@var{buffertype}-buffer} respectively, where @var{buffertype} |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
823 is the relevant buffer type e.g breakpoints. |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
824 |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
825 When you finish debugging then kill the GUD buffer with @kbd{C-x k}, |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
826 which will also kill all the buffers associated with the session. |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
827 However you need not do this if, after editing and re-compiling your |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
828 source code within Emacs, you wish continue debugging. When you |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
829 restart execution, GDB will automatically find your new executable. |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
830 Keeping the GUD buffer has the advantage of keeping the shell history |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
831 as well as GDB's breakpoints. You need to check, however, that the |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
832 breakpoints in the recently edited code are still where you want them. |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
833 |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
834 @node Breakpoints Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
835 @subsubsection Breakpoints Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
836 |
56808
00b9078008ef
(Building): Interchange nodes (for correct numbering).
Luc Teirlinck <teirllm@auburn.edu>
parents:
56007
diff
changeset
|
837 The breakpoints buffer shows the existing breakpoints and watchpoints |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
838 (@pxref{Breakpoints,,, gdb, The GNU debugger}). It has three special |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
839 commands: |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
840 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
841 @table @kbd |
56808
00b9078008ef
(Building): Interchange nodes (for correct numbering).
Luc Teirlinck <teirllm@auburn.edu>
parents:
56007
diff
changeset
|
842 @item @key{SPC} |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
843 @kindex SPC @r{(GDB breakpoints buffer)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
844 @findex gdb-toggle-breakpoint |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
845 Enable/disable the breakpoint at the current line |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
846 (@code{gdb-toggle-breakpoint}). On a graphical display, this changes |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
847 the color of a bullet in the margin of the source buffer at the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
848 relevant line. This is red when the breakpoint is enabled and grey |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
849 when it is disabled. Text-only terminals correspondingly display |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
850 a @samp{B} or @samp{b}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
851 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
852 @item @kbd{d} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
853 @kindex d @r{(GDB breakpoints buffer)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
854 @findex gdb-delete-breakpoint |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
855 Delete the breakpoint at the current line (@code{gdb-delete-breakpoint}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
856 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
857 @item @key{RET} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
858 @kindex RET @r{(GDB breakpoints buffer)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
859 @findex gdb-goto-breakpoint |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
860 Display the file in the source buffer at the breakpoint specified at |
60843
4e549a9044e1
(Stack Buffer): Mention reverse contrast for
Nick Roberts <nickrob@snap.net.nz>
parents:
60789
diff
changeset
|
861 the current line (@code{gdb-goto-breakpoint}). Alternatively, click |
4e549a9044e1
(Stack Buffer): Mention reverse contrast for
Nick Roberts <nickrob@snap.net.nz>
parents:
60789
diff
changeset
|
862 @kbd{Mouse-2} on the breakpoint that you wish to visit. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
863 @end table |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
864 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
865 @node Stack Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
866 @subsubsection Stack Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
867 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
868 The stack buffer displays a @dfn{call stack}, with one line for each |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
869 of the nested subroutine calls (@dfn{stack frames}) now active in the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
870 program. @xref{Backtrace,,info stack, gdb, The GNU debugger}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
871 |
60843
4e549a9044e1
(Stack Buffer): Mention reverse contrast for
Nick Roberts <nickrob@snap.net.nz>
parents:
60789
diff
changeset
|
872 The selected frame is displayed in reverse contrast. Move point to |
4e549a9044e1
(Stack Buffer): Mention reverse contrast for
Nick Roberts <nickrob@snap.net.nz>
parents:
60789
diff
changeset
|
873 any frame in the stack and type @key{RET} to select it (@code{gdb-frames-select}) |
4e549a9044e1
(Stack Buffer): Mention reverse contrast for
Nick Roberts <nickrob@snap.net.nz>
parents:
60789
diff
changeset
|
874 and display the associated source in the source buffer. Alternatively, |
4e549a9044e1
(Stack Buffer): Mention reverse contrast for
Nick Roberts <nickrob@snap.net.nz>
parents:
60789
diff
changeset
|
875 click @kbd{Mouse-2} to make the selected frame become the current one. |
4e549a9044e1
(Stack Buffer): Mention reverse contrast for
Nick Roberts <nickrob@snap.net.nz>
parents:
60789
diff
changeset
|
876 If the locals buffer is displayed then its contents update to display |
4e549a9044e1
(Stack Buffer): Mention reverse contrast for
Nick Roberts <nickrob@snap.net.nz>
parents:
60789
diff
changeset
|
877 the variables that are local to the new frame. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
878 |
52907
d1707faf8297
(Watch Expressions): Update section on data display
Nick Roberts <nickrob@snap.net.nz>
parents:
52401
diff
changeset
|
879 @node Watch Expressions |
d1707faf8297
(Watch Expressions): Update section on data display
Nick Roberts <nickrob@snap.net.nz>
parents:
52401
diff
changeset
|
880 @subsubsection Watch Expressions |
d1707faf8297
(Watch Expressions): Update section on data display
Nick Roberts <nickrob@snap.net.nz>
parents:
52401
diff
changeset
|
881 @cindex Watching expressions in GDB |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
882 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
883 If you want to see how a variable changes each time your program stops |
52907
d1707faf8297
(Watch Expressions): Update section on data display
Nick Roberts <nickrob@snap.net.nz>
parents:
52401
diff
changeset
|
884 then place the cursor over the variable name and click on the watch |
62384
035f76eff1bc
Replace toolbar with "tool bar" for consistency.
Nick Roberts <nickrob@snap.net.nz>
parents:
62221
diff
changeset
|
885 icon in the tool bar (@code{gud-watch}). |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
886 |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
887 Each watch expression is displayed in the speedbar. Complex data |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
888 types, such as arrays, structures and unions are represented in a tree |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
889 format. To expand or contract a complex data type, click @kbd{Mouse-2} |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
890 on the tag to the left of the expression. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
891 |
52907
d1707faf8297
(Watch Expressions): Update section on data display
Nick Roberts <nickrob@snap.net.nz>
parents:
52401
diff
changeset
|
892 @kindex RET @r{(GDB speedbar)} |
d1707faf8297
(Watch Expressions): Update section on data display
Nick Roberts <nickrob@snap.net.nz>
parents:
52401
diff
changeset
|
893 @findex gdb-var-delete |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
894 With the cursor over the root expression of a complex data type, type |
55577
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
895 @kbd{D} to delete it from the speedbar |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
896 (@code{gdb-var-delete}). |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
897 |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
898 @findex gdb-edit-value |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
899 With the cursor over a simple data type or an element of a complex |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
900 data type which holds a value, type @key{RET} or click @kbd{Mouse-2} to edit |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
901 its value. A prompt for a new value appears in the mini-buffer |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
902 (@code{gdb-edit-value}). |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
903 |
54131
6534ec3bbe32
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
53254
diff
changeset
|
904 If you set the variable @code{gdb-show-changed-values} to |
6534ec3bbe32
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
53254
diff
changeset
|
905 non-@code{nil} (the default value), then Emacs will use |
6534ec3bbe32
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
53254
diff
changeset
|
906 font-lock-warning-face to display values that have recently changed in |
6534ec3bbe32
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
53254
diff
changeset
|
907 the speedbar. |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
908 |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
909 If you set the variable @code{gdb-use-colon-colon-notation} to a |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
910 non-@code{nil} value, then, in C, Emacs will use the |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
911 FUNCTION::VARIABLE format to display variables in the speedbar. |
54131
6534ec3bbe32
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
53254
diff
changeset
|
912 Since this does not work for variables defined in compound statements, |
6534ec3bbe32
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
53254
diff
changeset
|
913 the default value is @code{nil}. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
914 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
915 @node Other Buffers |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
916 @subsubsection Other Buffers |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
917 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
918 @table @asis |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
919 @item Input/Output Buffer |
55577
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
920 If the variable @code{gdb-use-inferior-io-buffer} is non-@code{nil}, |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
921 the executable program that is being debugged takes its input and |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
922 displays its output here. Some of the commands from shell mode are |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
923 available here. @xref{Shell Mode}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
924 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
925 @item Locals Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
926 The locals buffer displays the values of local variables of the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
927 current frame for simple data types (@pxref{Frame Info,,, gdb, The GNU |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
928 debugger}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
929 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
930 Arrays and structures display their type only. You must display them |
61900
cdd3e3ac3b37
(Debugger Operation): Add description for
Nick Roberts <nickrob@snap.net.nz>
parents:
61652
diff
changeset
|
931 separately to examine their values. @xref{Watch Expressions}. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
932 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
933 @item Registers Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
934 The registers buffer displays the values held by the registers |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
935 (@pxref{Registers,,, gdb, The GNU debugger}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
936 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
937 @item Assembler Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
938 The assembler buffer displays the current frame as machine code. An |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
939 overlay arrow points to the current instruction and you can set and |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
940 remove breakpoints as with the source buffer. Breakpoint icons also |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
941 appear in the fringe or margin. |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
942 |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
943 @item Threads Buffer |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
944 |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
945 The threads buffer displays a summary of all threads currently in your |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
946 program (@pxref{Threads,,, gdb, The GNU debugger}). Move point to |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
947 any thread in the list and type @key{RET} to make it become the |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
948 current thread (@code{gdb-threads-select}) and display the associated |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
949 source in the source buffer. Alternatively, click @kbd{Mouse-2} to |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
950 make the selected thread become the current one. |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
951 |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
952 @item Memory Buffer |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
953 |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
954 The memory buffer allows the user to examine sections of program |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
955 memory (@pxref{Memory,,, gdb, The GNU debugger}). Click @kbd{Mouse-1} |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
956 on the appropriate part of the header line to change the starting |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
957 address or number of data items that the buffer displays. |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
958 Click @kbd{Mouse-3} on the header line to select the display format |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
959 or unit size for these data items. |
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
960 |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
961 @end table |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
962 |
25829 | 963 @node Executing Lisp |
964 @section Executing Lisp Expressions | |
965 | |
966 Emacs has several different major modes for Lisp and Scheme. They are | |
967 the same in terms of editing commands, but differ in the commands for | |
968 executing Lisp expressions. Each mode has its own purpose. | |
969 | |
970 @table @asis | |
971 @item Emacs-Lisp mode | |
972 The mode for editing source files of programs to run in Emacs Lisp. | |
973 This mode defines @kbd{C-M-x} to evaluate the current defun. | |
974 @xref{Lisp Libraries}. | |
975 @item Lisp Interaction mode | |
976 The mode for an interactive session with Emacs Lisp. It defines | |
977 @kbd{C-j} to evaluate the sexp before point and insert its value in the | |
978 buffer. @xref{Lisp Interaction}. | |
979 @item Lisp mode | |
980 The mode for editing source files of programs that run in Lisps other | |
981 than Emacs Lisp. This mode defines @kbd{C-M-x} to send the current defun | |
982 to an inferior Lisp process. @xref{External Lisp}. | |
983 @item Inferior Lisp mode | |
984 The mode for an interactive session with an inferior Lisp process. | |
985 This mode combines the special features of Lisp mode and Shell mode | |
986 (@pxref{Shell Mode}). | |
987 @item Scheme mode | |
988 Like Lisp mode but for Scheme programs. | |
989 @item Inferior Scheme mode | |
990 The mode for an interactive session with an inferior Scheme process. | |
991 @end table | |
992 | |
993 Most editing commands for working with Lisp programs are in fact | |
994 available globally. @xref{Programs}. | |
995 | |
996 @node Lisp Libraries | |
997 @section Libraries of Lisp Code for Emacs | |
998 @cindex libraries | |
999 @cindex loading Lisp code | |
1000 | |
1001 Lisp code for Emacs editing commands is stored in files whose names | |
1002 conventionally end in @file{.el}. This ending tells Emacs to edit them in | |
1003 Emacs-Lisp mode (@pxref{Executing Lisp}). | |
1004 | |
1005 @findex load-file | |
1006 To execute a file of Emacs Lisp code, use @kbd{M-x load-file}. This | |
1007 command reads a file name using the minibuffer and then executes the | |
1008 contents of that file as Lisp code. It is not necessary to visit the | |
1009 file first; in any case, this command reads the file as found on disk, | |
1010 not text in an Emacs buffer. | |
1011 | |
1012 @findex load | |
1013 @findex load-library | |
1014 Once a file of Lisp code is installed in the Emacs Lisp library | |
1015 directories, users can load it using @kbd{M-x load-library}. Programs can | |
1016 load it by calling @code{load-library}, or with @code{load}, a more primitive | |
1017 function that is similar but accepts some additional arguments. | |
1018 | |
1019 @kbd{M-x load-library} differs from @kbd{M-x load-file} in that it | |
1020 searches a sequence of directories and tries three file names in each | |
1021 directory. Suppose your argument is @var{lib}; the three names are | |
1022 @file{@var{lib}.elc}, @file{@var{lib}.el}, and lastly just | |
1023 @file{@var{lib}}. If @file{@var{lib}.elc} exists, it is by convention | |
1024 the result of compiling @file{@var{lib}.el}; it is better to load the | |
1025 compiled file, since it will load and run faster. | |
1026 | |
1027 If @code{load-library} finds that @file{@var{lib}.el} is newer than | |
38943
4dd9aeae2f84
Don't use "prints" except for printers.
Richard M. Stallman <rms@gnu.org>
parents:
38743
diff
changeset
|
1028 @file{@var{lib}.elc} file, it issues a warning, because it's likely that |
25829 | 1029 somebody made changes to the @file{.el} file and forgot to recompile |
1030 it. | |
1031 | |
1032 Because the argument to @code{load-library} is usually not in itself | |
1033 a valid file name, file name completion is not available. Indeed, when | |
1034 using this command, you usually do not know exactly what file name | |
1035 will be used. | |
1036 | |
1037 @vindex load-path | |
1038 The sequence of directories searched by @kbd{M-x load-library} is | |
1039 specified by the variable @code{load-path}, a list of strings that are | |
1040 directory names. The default value of the list contains the directory where | |
1041 the Lisp code for Emacs itself is stored. If you have libraries of | |
1042 your own, put them in a single directory and add that directory | |
1043 to @code{load-path}. @code{nil} in this list stands for the current default | |
1044 directory, but it is probably not a good idea to put @code{nil} in the | |
1045 list. If you find yourself wishing that @code{nil} were in the list, | |
1046 most likely what you really want to do is use @kbd{M-x load-file} | |
1047 this once. | |
1048 | |
1049 @cindex autoload | |
1050 Often you do not have to give any command to load a library, because | |
1051 the commands defined in the library are set up to @dfn{autoload} that | |
1052 library. Trying to run any of those commands calls @code{load} to load | |
1053 the library; this replaces the autoload definitions with the real ones | |
1054 from the library. | |
1055 | |
1056 @cindex byte code | |
1057 Emacs Lisp code can be compiled into byte-code which loads faster, | |
1058 takes up less space when loaded, and executes faster. @xref{Byte | |
1059 Compilation,, Byte Compilation, elisp, the Emacs Lisp Reference Manual}. | |
1060 By convention, the compiled code for a library goes in a separate file | |
1061 whose name consists of the library source file with @samp{c} appended. | |
1062 Thus, the compiled code for @file{foo.el} goes in @file{foo.elc}. | |
1063 That's why @code{load-library} searches for @samp{.elc} files first. | |
1064 | |
31027
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
1065 @vindex load-dangerous-libraries |
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
1066 @cindex Lisp files byte-compiled by XEmacs |
36144
22f75550e788
Rewrite discussion of load-dangerous-libraries.
Richard M. Stallman <rms@gnu.org>
parents:
34935
diff
changeset
|
1067 By default, Emacs refuses to load compiled Lisp files which were |
22f75550e788
Rewrite discussion of load-dangerous-libraries.
Richard M. Stallman <rms@gnu.org>
parents:
34935
diff
changeset
|
1068 compiled with XEmacs, a modified versions of Emacs---they can cause |
22f75550e788
Rewrite discussion of load-dangerous-libraries.
Richard M. Stallman <rms@gnu.org>
parents:
34935
diff
changeset
|
1069 Emacs to crash. Set the variable @code{load-dangerous-libraries} to |
22f75550e788
Rewrite discussion of load-dangerous-libraries.
Richard M. Stallman <rms@gnu.org>
parents:
34935
diff
changeset
|
1070 @code{t} if you want to try loading them. |
31027
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
1071 |
25829 | 1072 @node Lisp Eval |
58369
a54b2a5402d6
(Lisp Eval): Delete hyphen in section name.
Richard M. Stallman <rms@gnu.org>
parents:
57348
diff
changeset
|
1073 @section Evaluating Emacs Lisp Expressions |
25829 | 1074 @cindex Emacs-Lisp mode |
1075 @cindex mode, Emacs-Lisp | |
1076 | |
1077 @findex emacs-lisp-mode | |
1078 Lisp programs intended to be run in Emacs should be edited in | |
1079 Emacs-Lisp mode; this happens automatically for file names ending in | |
1080 @file{.el}. By contrast, Lisp mode itself is used for editing Lisp | |
1081 programs intended for other Lisp systems. To switch to Emacs-Lisp mode | |
1082 explicitly, use the command @kbd{M-x emacs-lisp-mode}. | |
1083 | |
1084 For testing of Lisp programs to run in Emacs, it is often useful to | |
1085 evaluate part of the program as it is found in the Emacs buffer. For | |
1086 example, after changing the text of a Lisp function definition, | |
1087 evaluating the definition installs the change for future calls to the | |
1088 function. Evaluation of Lisp expressions is also useful in any kind of | |
1089 editing, for invoking noninteractive functions (functions that are | |
1090 not commands). | |
1091 | |
1092 @table @kbd | |
1093 @item M-: | |
1094 Read a single Lisp expression in the minibuffer, evaluate it, and print | |
1095 the value in the echo area (@code{eval-expression}). | |
1096 @item C-x C-e | |
1097 Evaluate the Lisp expression before point, and print the value in the | |
1098 echo area (@code{eval-last-sexp}). | |
1099 @item C-M-x | |
1100 Evaluate the defun containing or after point, and print the value in | |
1101 the echo area (@code{eval-defun}). | |
1102 @item M-x eval-region | |
1103 Evaluate all the Lisp expressions in the region. | |
1104 @item M-x eval-current-buffer | |
1105 Evaluate all the Lisp expressions in the buffer. | |
1106 @end table | |
1107 | |
44116
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1108 @ifinfo |
43889
c5ea7e769ffd
(Electric C, Lisp Eval): Avoid makeinfo warnings about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents:
43151
diff
changeset
|
1109 @c This uses ``colon'' instead of a literal `:' because Info cannot |
c5ea7e769ffd
(Electric C, Lisp Eval): Avoid makeinfo warnings about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents:
43151
diff
changeset
|
1110 @c cope with a `:' in a menu |
c5ea7e769ffd
(Electric C, Lisp Eval): Avoid makeinfo warnings about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents:
43151
diff
changeset
|
1111 @kindex M-@key{colon} |
44116
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1112 @end ifinfo |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1113 @ifnotinfo |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1114 @kindex M-: |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1115 @end ifnotinfo |
25829 | 1116 @findex eval-expression |
1117 @kbd{M-:} (@code{eval-expression}) is the most basic command for evaluating | |
1118 a Lisp expression interactively. It reads the expression using the | |
1119 minibuffer, so you can execute any expression on a buffer regardless of | |
1120 what the buffer contains. When the expression is evaluated, the current | |
1121 buffer is once again the buffer that was current when @kbd{M-:} was | |
1122 typed. | |
1123 | |
1124 @kindex C-M-x @r{(Emacs-Lisp mode)} | |
1125 @findex eval-defun | |
1126 In Emacs-Lisp mode, the key @kbd{C-M-x} is bound to the command | |
1127 @code{eval-defun}, which parses the defun containing or following point | |
1128 as a Lisp expression and evaluates it. The value is printed in the echo | |
1129 area. This command is convenient for installing in the Lisp environment | |
1130 changes that you have just made in the text of a function definition. | |
1131 | |
1132 @kbd{C-M-x} treats @code{defvar} expressions specially. Normally, | |
1133 evaluating a @code{defvar} expression does nothing if the variable it | |
1134 defines already has a value. But @kbd{C-M-x} unconditionally resets the | |
1135 variable to the initial value specified in the @code{defvar} expression. | |
28431
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1136 @code{defcustom} expressions are treated similarly. |
25829 | 1137 This special feature is convenient for debugging Lisp programs. |
56007
8446511392c6
(Lisp Eval): Add C-M-x on defface.
Juri Linkov <juri@jurta.org>
parents:
55577
diff
changeset
|
1138 Typing @kbd{C-M-x} on a @code{defface} expression reinitializes |
8446511392c6
(Lisp Eval): Add C-M-x on defface.
Juri Linkov <juri@jurta.org>
parents:
55577
diff
changeset
|
1139 the face according to the @code{defface} specification. |
25829 | 1140 |
1141 @kindex C-x C-e | |
1142 @findex eval-last-sexp | |
1143 The command @kbd{C-x C-e} (@code{eval-last-sexp}) evaluates the Lisp | |
1144 expression preceding point in the buffer, and displays the value in the | |
1145 echo area. It is available in all major modes, not just Emacs-Lisp | |
1146 mode. It does not treat @code{defvar} specially. | |
1147 | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
1148 When the result of an evaluation is an integer, you can type |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
1149 @kbd{C-x C-e} a second time to display the value of the integer result |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
1150 in additional formats (octal, hexadecimal, and character). |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
1151 |
25829 | 1152 If @kbd{C-M-x}, @kbd{C-x C-e}, or @kbd{M-:} is given a numeric |
1153 argument, it inserts the value into the current buffer at point, rather | |
1154 than displaying it in the echo area. The argument's value does not | |
1155 matter. | |
1156 | |
1157 @findex eval-region | |
1158 @findex eval-current-buffer | |
1159 The most general command for evaluating Lisp expressions from a buffer | |
1160 is @code{eval-region}. @kbd{M-x eval-region} parses the text of the | |
1161 region as one or more Lisp expressions, evaluating them one by one. | |
1162 @kbd{M-x eval-current-buffer} is similar but evaluates the entire | |
1163 buffer. This is a reasonable way to install the contents of a file of | |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
1164 Lisp code that you are ready to test. Later, as you find bugs and |
25829 | 1165 change individual functions, use @kbd{C-M-x} on each function that you |
1166 change. This keeps the Lisp world in step with the source file. | |
1167 | |
28431
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1168 @vindex eval-expression-print-level |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1169 @vindex eval-expression-print-length |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1170 @vindex eval-expression-debug-on-error |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1171 The customizable variables @code{eval-expression-print-level} and |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1172 @code{eval-expression-print-length} control the maximum depth and length |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1173 of lists to print in the result of the evaluation commands before |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1174 abbreviating them. @code{eval-expression-debug-on-error} controls |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1175 whether evaluation errors invoke the debugger when these commands are |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1176 used. |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1177 |
25829 | 1178 @node Lisp Interaction |
1179 @section Lisp Interaction Buffers | |
1180 | |
1181 The buffer @samp{*scratch*} which is selected when Emacs starts up is | |
1182 provided for evaluating Lisp expressions interactively inside Emacs. | |
1183 | |
1184 The simplest way to use the @samp{*scratch*} buffer is to insert Lisp | |
1185 expressions and type @kbd{C-j} after each expression. This command | |
1186 reads the Lisp expression before point, evaluates it, and inserts the | |
1187 value in printed representation before point. The result is a complete | |
1188 typescript of the expressions you have evaluated and their values. | |
1189 | |
1190 The @samp{*scratch*} buffer's major mode is Lisp Interaction mode, which | |
1191 is the same as Emacs-Lisp mode except for the binding of @kbd{C-j}. | |
1192 | |
1193 @findex lisp-interaction-mode | |
1194 The rationale for this feature is that Emacs must have a buffer when | |
1195 it starts up, but that buffer is not useful for editing files since a | |
1196 new buffer is made for every file that you visit. The Lisp interpreter | |
1197 typescript is the most useful thing I can think of for the initial | |
1198 buffer to do. Type @kbd{M-x lisp-interaction-mode} to put the current | |
1199 buffer in Lisp Interaction mode. | |
1200 | |
1201 @findex ielm | |
1202 An alternative way of evaluating Emacs Lisp expressions interactively | |
1203 is to use Inferior Emacs-Lisp mode, which provides an interface rather | |
1204 like Shell mode (@pxref{Shell Mode}) for evaluating Emacs Lisp | |
1205 expressions. Type @kbd{M-x ielm} to create an @samp{*ielm*} buffer | |
1206 which uses this mode. | |
1207 | |
1208 @node External Lisp | |
1209 @section Running an External Lisp | |
1210 | |
1211 Emacs has facilities for running programs in other Lisp systems. You can | |
1212 run a Lisp process as an inferior of Emacs, and pass expressions to it to | |
1213 be evaluated. You can also pass changed function definitions directly from | |
1214 the Emacs buffers in which you edit the Lisp programs to the inferior Lisp | |
1215 process. | |
1216 | |
1217 @findex run-lisp | |
1218 @vindex inferior-lisp-program | |
1219 @kindex C-x C-z | |
1220 To run an inferior Lisp process, type @kbd{M-x run-lisp}. This runs | |
1221 the program named @code{lisp}, the same program you would run by typing | |
1222 @code{lisp} as a shell command, with both input and output going through | |
1223 an Emacs buffer named @samp{*lisp*}. That is to say, any ``terminal | |
1224 output'' from Lisp will go into the buffer, advancing point, and any | |
1225 ``terminal input'' for Lisp comes from text in the buffer. (You can | |
1226 change the name of the Lisp executable file by setting the variable | |
1227 @code{inferior-lisp-program}.) | |
1228 | |
1229 To give input to Lisp, go to the end of the buffer and type the input, | |
1230 terminated by @key{RET}. The @samp{*lisp*} buffer is in Inferior Lisp | |
1231 mode, which combines the special characteristics of Lisp mode with most | |
1232 of the features of Shell mode (@pxref{Shell Mode}). The definition of | |
1233 @key{RET} to send a line to a subprocess is one of the features of Shell | |
1234 mode. | |
1235 | |
1236 @findex lisp-mode | |
1237 For the source files of programs to run in external Lisps, use Lisp | |
1238 mode. This mode can be selected with @kbd{M-x lisp-mode}, and is used | |
1239 automatically for files whose names end in @file{.l}, @file{.lsp}, or | |
1240 @file{.lisp}, as most Lisp systems usually expect. | |
1241 | |
1242 @kindex C-M-x @r{(Lisp mode)} | |
1243 @findex lisp-eval-defun | |
1244 When you edit a function in a Lisp program you are running, the easiest | |
1245 way to send the changed definition to the inferior Lisp process is the key | |
1246 @kbd{C-M-x}. In Lisp mode, this runs the function @code{lisp-eval-defun}, | |
1247 which finds the defun around or following point and sends it as input to | |
1248 the Lisp process. (Emacs can send input to any inferior process regardless | |
1249 of what buffer is current.) | |
1250 | |
1251 Contrast the meanings of @kbd{C-M-x} in Lisp mode (for editing programs | |
1252 to be run in another Lisp system) and Emacs-Lisp mode (for editing Lisp | |
1253 programs to be run in Emacs): in both modes it has the effect of installing | |
1254 the function definition that point is in, but the way of doing so is | |
1255 different according to where the relevant Lisp environment is found. | |
1256 @xref{Executing Lisp}. | |
52401 | 1257 |
1258 @ignore | |
1259 arch-tag: 9c3c2f71-b332-4144-8500-3ff9945a50ed | |
1260 @end ignore |