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