Mercurial > emacs
annotate man/building.texi @ 51667:52d50e52438f
(struct buffer_text): Lisp_Object `markers' => Lisp_Marker.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Thu, 26 Jun 2003 23:15:25 +0000 |
parents | 35bdcc98e5b1 |
children | 2488d95d6eaa |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
39287 | 2 @c Copyright (C) 1985,86,87,93,94,95,97,2000,2001 Free Software Foundation, Inc. |
25829 | 3 @c See file emacs.texi for copying conditions. |
38202 | 4 @node Building, Maintaining, Programs, Top |
25829 | 5 @chapter Compiling and Testing Programs |
6 @cindex building programs | |
7 @cindex program building | |
8 @cindex running Lisp functions | |
9 | |
10 The previous chapter discusses the Emacs commands that are useful for | |
11 making changes in programs. This chapter deals with commands that assist | |
12 in the larger process of developing and maintaining programs. | |
13 | |
14 @menu | |
15 * Compilation:: Compiling programs in languages other | |
16 than Lisp (C, Pascal, etc.). | |
17 * Grep Searching:: Running grep as if it were a compiler. | |
18 * Compilation Mode:: The mode for visiting compiler errors. | |
19 * Compilation Shell:: Customizing your shell properly | |
20 for use in the compilation buffer. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49062
diff
changeset
|
21 * Debuggers:: Running symbolic debuggers for non-Lisp programs. |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49062
diff
changeset
|
22 * Executing Lisp:: Various modes for editing Lisp programs, |
25829 | 23 with different facilities for running |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49062
diff
changeset
|
24 the Lisp programs. |
25829 | 25 * Libraries: Lisp Libraries. Creating Lisp programs to run in Emacs. |
26 * Interaction: Lisp Interaction. Executing Lisp in an Emacs buffer. | |
27 * Eval: Lisp Eval. Executing a single Lisp expression in Emacs. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49062
diff
changeset
|
28 * External Lisp:: Communicating through Emacs with a separate Lisp. |
25829 | 29 @end menu |
30 | |
31 @node Compilation | |
32 @section Running Compilations under Emacs | |
33 @cindex inferior process | |
34 @cindex make | |
35 @cindex compilation errors | |
36 @cindex error log | |
37 | |
38 Emacs can run compilers for noninteractive languages such as C and | |
39 Fortran as inferior processes, feeding the error log into an Emacs buffer. | |
40 It can also parse the error messages and show you the source lines where | |
41 compilation errors occurred. | |
42 | |
43 @table @kbd | |
44 @item M-x compile | |
37482
4b43d9f652aa
Correct typo on pdb-mode-hook.
Richard M. Stallman <rms@gnu.org>
parents:
37346
diff
changeset
|
45 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
|
46 the @samp{*compilation*} buffer. |
39820
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
47 @item M-x recompile |
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
48 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
|
49 @kbd{M-x compile}. |
25829 | 50 @item M-x grep |
51 Run @code{grep} asynchronously under Emacs, with matching lines | |
52 listed in the buffer named @samp{*grep*}. | |
53 @item M-x grep-find | |
54 Run @code{grep} via @code{find}, with user-specified arguments, and | |
55 collect output in the buffer named @samp{*grep*}. | |
56 @item M-x kill-compilation | |
57 @itemx M-x kill-grep | |
58 Kill the running compilation or @code{grep} subprocess. | |
59 @end table | |
60 | |
61 @findex compile | |
62 To run @code{make} or another compilation command, do @kbd{M-x | |
63 compile}. This command reads a shell command line using the minibuffer, | |
64 and then executes the command in an inferior shell, putting output in | |
65 the buffer named @samp{*compilation*}. The current buffer's default | |
66 directory is used as the working directory for the execution of the | |
67 command; normally, therefore, the compilation happens in this | |
68 directory. | |
69 | |
70 @vindex compile-command | |
48071
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
71 When the shell command line is read, the minibuffer appears |
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
72 containing a default command line, which is the command you used the |
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
73 last time you did @kbd{M-x compile}. If you type just @key{RET}, the |
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
74 same command line is used again. For the first @kbd{M-x compile}, the |
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
75 default is @samp{make -k}, which is correct most of the time for |
50475
b65aa1d740eb
Fix cross references.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
76 nontrivial programs. (@xref{Top,, Make, make, GNU Make Manual}.) |
48071
6be0f6ca3d49
Add xref to Make manual.
Richard M. Stallman <rms@gnu.org>
parents:
46362
diff
changeset
|
77 The default compilation command comes from the variable |
25829 | 78 @code{compile-command}; if the appropriate compilation command for a |
79 file is something other than @samp{make -k}, it can be useful for the | |
80 file to specify a local value for @code{compile-command} (@pxref{File | |
81 Variables}). | |
82 | |
83 Starting a compilation displays the buffer @samp{*compilation*} in | |
84 another window but does not select it. The buffer's mode line tells you | |
85 whether compilation is finished, with the word @samp{run} or @samp{exit} | |
86 inside the parentheses. You do not have to keep this buffer visible; | |
87 compilation continues in any case. While a compilation is going on, the | |
88 string @samp{Compiling} appears in the mode lines of all windows. When | |
89 this string disappears, the compilation is finished. | |
90 | |
91 If you want to watch the compilation transcript as it appears, switch | |
92 to the @samp{*compilation*} buffer and move point to the end of the | |
93 buffer. When point is at the end, new compilation output is inserted | |
94 above point, which remains at the end. If point is not at the end of | |
95 the buffer, it remains fixed while more compilation output is added at | |
96 the end of the buffer. | |
97 | |
34935
390058c38d27
Add a cindex entry for compilation-scroll-output. Duplicate the variable's
Eli Zaretskii <eliz@gnu.org>
parents:
31027
diff
changeset
|
98 @cindex compilation buffer, keeping current position at the end |
25829 | 99 @vindex compilation-scroll-output |
100 If you set the variable @code{compilation-scroll-output} to a | |
101 non-@code{nil} value, then the compilation buffer always scrolls to | |
102 follow output as it comes in. | |
103 | |
104 @findex kill-compilation | |
105 To kill the compilation process, do @kbd{M-x kill-compilation}. When | |
106 the compiler process terminates, the mode line of the | |
107 @samp{*compilation*} buffer changes to say @samp{signal} instead of | |
108 @samp{run}. Starting a new compilation also kills any running | |
109 compilation, as only one can exist at any time. However, @kbd{M-x | |
110 compile} asks for confirmation before actually killing a compilation | |
111 that is running. | |
112 | |
39820
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
113 @findex recompile |
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
114 To rerun the last compilation with the same command, type @kbd{M-x |
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
115 recompile}. This automatically reuses the compilation command from the |
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
116 last invocation of @kbd{M-x compile}. |
f0947afcdf4c
(Compilation): Document "M-x recompile".
Eli Zaretskii <eliz@gnu.org>
parents:
39287
diff
changeset
|
117 |
46362
36ac28961e4f
Say that output from asynch subprocesses of a compiler may be lost.
Richard M. Stallman <rms@gnu.org>
parents:
46238
diff
changeset
|
118 Emacs does not expect a compiler to launch asynchronous |
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 |
36ac28961e4f
Say that output from asynch subprocesses of a compiler may be lost.
Richard M. Stallman <rms@gnu.org>
parents:
46238
diff
changeset
|
120 compiler process has terminated, their output may not arrive in Emacs. |
36ac28961e4f
Say that output from asynch subprocesses of a compiler may be lost.
Richard M. Stallman <rms@gnu.org>
parents:
46238
diff
changeset
|
121 |
25829 | 122 @node Grep Searching |
123 @section Searching with Grep under Emacs | |
124 | |
125 @findex grep | |
126 Just as you can run a compiler from Emacs and then visit the lines | |
127 where there were compilation errors, you can also run @code{grep} and | |
128 then visit the lines on which matches were found. This works by | |
129 treating the matches reported by @code{grep} as if they were ``errors.'' | |
130 | |
131 To do this, type @kbd{M-x grep}, then enter a command line that | |
132 specifies how to run @code{grep}. Use the same arguments you would give | |
133 @code{grep} when running it normally: a @code{grep}-style regexp | |
134 (usually in single-quotes to quote the shell's special characters) | |
135 followed by file names, which may use wildcards. The output from | |
136 @code{grep} goes in the @samp{*grep*} buffer. You can find the | |
137 corresponding lines in the original files using @kbd{C-x `} and | |
138 @key{RET}, as with compilation errors. | |
139 | |
140 If you specify a prefix argument for @kbd{M-x grep}, it figures out | |
141 the tag (@pxref{Tags}) around point, and puts that into the default | |
142 @code{grep} command. | |
143 | |
144 @findex grep-find | |
145 The command @kbd{M-x grep-find} is similar to @kbd{M-x grep}, but it | |
146 supplies a different initial default for the command---one that runs | |
147 both @code{find} and @code{grep}, so as to search every file in a | |
148 directory tree. See also the @code{find-grep-dired} command, | |
149 in @ref{Dired and Find}. | |
150 | |
151 @node Compilation Mode | |
152 @section Compilation Mode | |
153 | |
154 @findex compile-goto-error | |
155 @cindex Compilation mode | |
156 @cindex mode, Compilation | |
157 The @samp{*compilation*} buffer uses a special major mode, Compilation | |
158 mode, whose main feature is to provide a convenient way to look at the | |
159 source line where the error happened. | |
160 | |
34935
390058c38d27
Add a cindex entry for compilation-scroll-output. Duplicate the variable's
Eli Zaretskii <eliz@gnu.org>
parents:
31027
diff
changeset
|
161 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
|
162 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
|
163 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
|
164 |
25829 | 165 @table @kbd |
166 @item C-x ` | |
167 Visit the locus of the next compiler error message or @code{grep} match. | |
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. | |
173 @end table | |
174 | |
175 @kindex C-x ` | |
176 @findex next-error | |
177 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
|
178 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
|
179 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
|
180 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
|
181 @samp{*compilation*} buffer first. |
25829 | 182 |
183 To parse the compiler error messages sequentially, type @kbd{C-x `} | |
184 (@code{next-error}). The character following the @kbd{C-x} is the | |
185 backquote or ``grave accent,'' not the single-quote. This command is | |
186 available in all buffers, not just in @samp{*compilation*}; it displays | |
187 the next error message at the top of one window and source location of | |
188 the error in another window. | |
189 | |
190 The first time @kbd{C-x `} is used after the start of a compilation, | |
191 it moves to the first error's location. Subsequent uses of @kbd{C-x `} | |
192 advance down to subsequent errors. If you visit a specific error | |
193 message with @key{RET} or @kbd{Mouse-2}, subsequent @kbd{C-x `} | |
194 commands advance from there. When @kbd{C-x `} gets to the end of the | |
195 buffer and finds no more error messages to visit, it fails and signals | |
196 an Emacs error. | |
197 | |
198 @kbd{C-u C-x `} starts scanning from the beginning of the compilation | |
199 buffer. This is one way to process the same set of errors again. | |
200 | |
37983
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
201 @vindex compilation-error-regexp-alist |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
202 @vindex grep-regexp-alist |
081777df34a7
(Compilation Mode): Document compilation-error-regexp-alist.
Eli Zaretskii <eliz@gnu.org>
parents:
37482
diff
changeset
|
203 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
|
204 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
|
205 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
|
206 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
|
207 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
|
208 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
|
209 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
|
210 |
25829 | 211 Compilation mode also redefines the keys @key{SPC} and @key{DEL} to |
212 scroll by screenfuls, and @kbd{M-n} and @kbd{M-p} to move to the next or | |
213 previous error message. You can also use @kbd{M-@{} and @kbd{M-@}} to | |
214 move up or down to an error message for a different source file. | |
215 | |
216 The features of Compilation mode are also available in a minor mode | |
217 called Compilation Minor mode. This lets you parse error messages in | |
218 any buffer, not just a normal compilation output buffer. Type @kbd{M-x | |
219 compilation-minor-mode} to enable the minor mode. This defines the keys | |
220 @key{RET} and @kbd{Mouse-2}, as in the Compilation major mode. | |
221 | |
222 Compilation minor mode works in any buffer, as long as the contents | |
223 are in a format that it understands. In an Rlogin buffer (@pxref{Remote | |
224 Host}), Compilation minor mode automatically accesses remote source | |
225 files by FTP (@pxref{File Names}). | |
226 | |
227 @node Compilation Shell | |
228 @section Subshells for Compilation | |
229 | |
230 Emacs uses a shell to run the compilation command, but specifies | |
231 the option for a noninteractive shell. This means, in particular, that | |
232 the shell should start with no prompt. If you find your usual shell | |
233 prompt making an unsightly appearance in the @samp{*compilation*} | |
234 buffer, it means you have made a mistake in your shell's init file by | |
235 setting the prompt unconditionally. (This init file's name may be | |
236 @file{.bashrc}, @file{.profile}, @file{.cshrc}, @file{.shrc}, or various | |
237 other things, depending on the shell you use.) The shell init file | |
238 should set the prompt only if there already is a prompt. In csh, here | |
239 is how to do it: | |
240 | |
241 @example | |
242 if ($?prompt) set prompt = @dots{} | |
243 @end example | |
244 | |
245 @noindent | |
246 And here's how to do it in bash: | |
247 | |
248 @example | |
249 if [ "$@{PS1+set@}" = set ] | |
250 then PS1=@dots{} | |
251 fi | |
252 @end example | |
253 | |
254 There may well be other things that your shell's init file | |
255 ought to do only for an interactive shell. You can use the same | |
256 method to conditionalize them. | |
257 | |
258 The MS-DOS ``operating system'' does not support asynchronous | |
259 subprocesses; to work around this lack, @kbd{M-x compile} runs the | |
260 compilation command synchronously on MS-DOS. As a consequence, you must | |
261 wait until the command finishes before you can do anything else in | |
262 Emacs. @xref{MS-DOS}. | |
263 | |
264 @node Debuggers | |
265 @section Running Debuggers Under Emacs | |
266 @cindex debuggers | |
267 @cindex GUD library | |
268 @cindex GDB | |
269 @cindex DBX | |
270 @cindex SDB | |
271 @cindex XDB | |
272 @cindex Perldb | |
273 @cindex JDB | |
274 @cindex PDB | |
275 | |
276 @c Do you believe in GUD? | |
277 The GUD (Grand Unified Debugger) library provides an interface to | |
278 various symbolic debuggers from within Emacs. We recommend the debugger | |
279 GDB, which is free software, but you can also run DBX, SDB or XDB if you | |
280 have them. GUD can also serve as an interface to the Perl's debugging | |
281 mode, the Python debugger PDB, and to JDB, the Java Debugger. | |
49062
cbcf1db3b1f0
Reference Debugging, not Debugger, in Lisp ref man.
Richard M. Stallman <rms@gnu.org>
parents:
48071
diff
changeset
|
282 @xref{Debugging,, The Lisp Debugger, elisp, the Emacs Lisp Reference Manual}, |
37346
e80fc3e25af8
Add Lisp Debugger xref.
Richard M. Stallman <rms@gnu.org>
parents:
36144
diff
changeset
|
283 for information on debugging Emacs Lisp programs. |
25829 | 284 |
285 @menu | |
286 * Starting GUD:: How to start a debugger subprocess. | |
287 * Debugger Operation:: Connection between the debugger and source buffers. | |
288 * Commands of GUD:: Key bindings for common commands. | |
289 * GUD Customization:: Defining your own commands for GUD. | |
27223 | 290 * GUD Tooltips:: Showing variable values by pointing with the mouse. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
291 * 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
|
292 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
|
293 Emacs. |
25829 | 294 @end menu |
295 | |
296 @node Starting GUD | |
297 @subsection Starting GUD | |
298 | |
299 There are several commands for starting a debugger, each corresponding | |
300 to a particular debugger program. | |
301 | |
302 @table @kbd | |
303 @item M-x gdb @key{RET} @var{file} @key{RET} | |
304 @findex gdb | |
38490 | 305 Run GDB as a subprocess of Emacs. This command creates a buffer |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
306 for input and output to GDB, and switches to it. If a GDB buffer |
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
307 already exists, it just switches to that buffer. |
25829 | 308 |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
309 @item M-x gdba @key{RET} @var{file} @key{RET} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
310 Run GDB as a subprocess of Emacs, providing a graphical interface |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
311 to GDB features through Emacs. @xref{GDB Graphical Interface}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
312 |
25829 | 313 @item M-x dbx @key{RET} @var{file} @key{RET} |
314 @findex dbx | |
38490 | 315 Similar, but run DBX instead of GDB. |
25829 | 316 |
317 @item M-x xdb @key{RET} @var{file} @key{RET} | |
318 @findex xdb | |
319 @vindex gud-xdb-directories | |
38490 | 320 Similar, but run XDB instead of GDB. Use the variable |
25829 | 321 @code{gud-xdb-directories} to specify directories to search for source |
322 files. | |
323 | |
324 @item M-x sdb @key{RET} @var{file} @key{RET} | |
325 @findex sdb | |
38490 | 326 Similar, but run SDB instead of GDB. |
25829 | 327 |
328 Some versions of SDB do not mention source file names in their | |
329 messages. When you use them, you need to have a valid tags table | |
330 (@pxref{Tags}) in order for GUD to find functions in the source code. | |
331 If you have not visited a tags table or the tags table doesn't list one | |
332 of the functions, you get a message saying @samp{The sdb support | |
333 requires a valid tags table to work}. If this happens, generate a valid | |
334 tags table in the working directory and try again. | |
335 | |
336 @item M-x perldb @key{RET} @var{file} @key{RET} | |
337 @findex perldb | |
338 Run the Perl interpreter in debug mode to debug @var{file}, a Perl program. | |
339 | |
340 @item M-x jdb @key{RET} @var{file} @key{RET} | |
341 @findex jdb | |
342 Run the Java debugger to debug @var{file}. | |
343 | |
344 @item M-x pdb @key{RET} @var{file} @key{RET} | |
345 @findex pdb | |
346 Run the Python debugger to debug @var{file}. | |
347 @end table | |
348 | |
349 Each of these commands takes one argument: a command line to invoke | |
350 the debugger. In the simplest case, specify just the name of the | |
351 executable file you want to debug. You may also use options that the | |
352 debugger supports. However, shell wildcards and variables are not | |
353 allowed. GUD assumes that the first argument not starting with a | |
354 @samp{-} is the executable file name. | |
355 | |
356 Emacs can only run one debugger process at a time. | |
357 | |
358 @node Debugger Operation | |
359 @subsection Debugger Operation | |
360 | |
42904
0e87fd2f82b4
(Debugger Operation): Add index entries for fringe usage.
Eli Zaretskii <eliz@gnu.org>
parents:
39820
diff
changeset
|
361 @cindex fringes, and current execution line in GUD |
25829 | 362 When you run a debugger with GUD, the debugger uses an Emacs buffer |
363 for its ordinary input and output. This is called the GUD buffer. The | |
364 debugger displays the source files of the program by visiting them in | |
365 Emacs buffers. An arrow (@samp{=>}) in one of these buffers indicates | |
42913 | 366 the current execution line.@footnote{Under a window system, the arrow |
367 appears in the left fringe of the Emacs window.} Moving point in this | |
368 buffer does not move the arrow. | |
25829 | 369 |
370 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
|
371 that display them. The arrow is not part of the file's |
25829 | 372 text; it appears only on the screen. If you do modify a source file, |
373 keep in mind that inserting or deleting lines will throw off the arrow's | |
374 positioning; GUD has no way of figuring out which line corresponded | |
375 before your changes to the line number in a debugger message. Also, | |
376 you'll typically have to recompile and restart the program for your | |
377 changes to be reflected in the debugger's tables. | |
378 | |
379 If you wish, you can control your debugger process entirely through the | |
380 debugger buffer, which uses a variant of Shell mode. All the usual | |
381 commands for your debugger are available, and you can use the Shell mode | |
382 history commands to repeat them. @xref{Shell Mode}. | |
383 | |
384 @node Commands of GUD | |
385 @subsection Commands of GUD | |
386 | |
387 The GUD interaction buffer uses a variant of Shell mode, so the | |
388 commands of Shell mode are available (@pxref{Shell Mode}). GUD mode | |
389 also provides commands for setting and clearing breakpoints, for | |
390 selecting stack frames, and for stepping through the program. These | |
391 commands are available both in the GUD buffer and globally, but with | |
392 different key bindings. | |
393 | |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
394 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
|
395 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
|
396 breakpoint. Here's the global command to set a breakpoint: |
25829 | 397 |
398 @table @kbd | |
399 @item C-x @key{SPC} | |
400 @kindex C-x SPC | |
401 Set a breakpoint on the source line that point is on. | |
402 @end table | |
403 | |
404 @kindex C-x C-a @r{(GUD)} | |
405 Here are the other special commands provided by GUD. The keys | |
406 starting with @kbd{C-c} are available only in the GUD interaction | |
407 buffer. The key bindings that start with @kbd{C-x C-a} are available in | |
408 the GUD interaction buffer and also in source files. | |
409 | |
410 @table @kbd | |
411 @item C-c C-l | |
412 @kindex C-c C-l @r{(GUD)} | |
413 @itemx C-x C-a C-l | |
414 @findex gud-refresh | |
415 Display in another window the last line referred to in the GUD | |
416 buffer (that is, the line indicated in the last location message). | |
417 This runs the command @code{gud-refresh}. | |
418 | |
419 @item C-c C-s | |
420 @kindex C-c C-s @r{(GUD)} | |
421 @itemx C-x C-a C-s | |
422 @findex gud-step | |
423 Execute a single line of code (@code{gud-step}). If the line contains | |
424 a function call, execution stops after entering the called function. | |
425 | |
426 @item C-c C-n | |
427 @kindex C-c C-n @r{(GUD)} | |
428 @itemx C-x C-a C-n | |
429 @findex gud-next | |
430 Execute a single line of code, stepping across entire function calls | |
431 at full speed (@code{gud-next}). | |
432 | |
433 @item C-c C-i | |
434 @kindex C-c C-i @r{(GUD)} | |
435 @itemx C-x C-a C-i | |
436 @findex gud-stepi | |
437 Execute a single machine instruction (@code{gud-stepi}). | |
438 | |
439 @need 3000 | |
440 @item C-c C-r | |
441 @kindex C-c C-r @r{(GUD)} | |
442 @itemx C-x C-a C-r | |
443 @findex gud-cont | |
444 Continue execution without specifying any stopping point. The program | |
445 will run until it hits a breakpoint, terminates, or gets a signal that | |
446 the debugger is checking for (@code{gud-cont}). | |
447 | |
448 @need 1000 | |
449 @item C-c C-d | |
450 @kindex C-c C-d @r{(GUD)} | |
451 @itemx C-x C-a C-d | |
452 @findex gud-remove | |
453 Delete the breakpoint(s) on the current source line, if any | |
454 (@code{gud-remove}). If you use this command in the GUD interaction | |
455 buffer, it applies to the line where the program last stopped. | |
456 | |
457 @item C-c C-t | |
458 @kindex C-c C-t @r{(GUD)} | |
459 @itemx C-x C-a C-t | |
460 @findex gud-tbreak | |
461 Set a temporary breakpoint on the current source line, if any. | |
462 If you use this command in the GUD interaction buffer, | |
463 it applies to the line where the program last stopped. | |
464 @end table | |
465 | |
466 The above commands are common to all supported debuggers. If you are | |
467 using GDB or (some versions of) DBX, these additional commands are available: | |
468 | |
469 @table @kbd | |
470 @item C-c < | |
471 @kindex C-c < @r{(GUD)} | |
472 @itemx C-x C-a < | |
473 @findex gud-up | |
474 Select the next enclosing stack frame (@code{gud-up}). This is | |
475 equivalent to the @samp{up} command. | |
476 | |
477 @item C-c > | |
478 @kindex C-c > @r{(GUD)} | |
479 @itemx C-x C-a > | |
480 @findex gud-down | |
481 Select the next inner stack frame (@code{gud-down}). This is | |
482 equivalent to the @samp{down} command. | |
483 @end table | |
484 | |
485 If you are using GDB, these additional key bindings are available: | |
486 | |
487 @table @kbd | |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
488 @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
|
489 @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
|
490 @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
|
491 @findex gud-run |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
492 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
|
493 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
494 @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
|
495 @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
|
496 @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
|
497 @findex gud-until |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
498 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
|
499 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
|
500 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
|
501 (@code{gud-until}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
502 |
25829 | 503 @item @key{TAB} |
504 @kindex TAB @r{(GUD)} | |
505 @findex gud-gdb-complete-command | |
506 With GDB, complete a symbol name (@code{gud-gdb-complete-command}). | |
507 This key is available only in the GUD interaction buffer, and requires | |
508 GDB versions 4.13 and later. | |
509 | |
510 @item C-c C-f | |
511 @kindex C-c C-f @r{(GUD)} | |
512 @itemx C-x C-a C-f | |
513 @findex gud-finish | |
514 Run the program until the selected stack frame returns (or until it | |
515 stops for some other reason). | |
43137
bc055bf06a94
(Commands of GUD): Add gud-jump.
Richard M. Stallman <rms@gnu.org>
parents:
42913
diff
changeset
|
516 |
46238
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
517 @item C-x C-a C-j |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
518 @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
|
519 @findex gud-jump |
46238
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
520 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
|
521 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
|
522 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
|
523 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
|
524 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
|
525 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
|
526 details. |
25829 | 527 @end table |
528 | |
529 These commands interpret a numeric argument as a repeat count, when | |
530 that makes sense. | |
531 | |
532 Because @key{TAB} serves as a completion command, you can't use it to | |
533 enter a tab as input to the program you are debugging with GDB. | |
534 Instead, type @kbd{C-q @key{TAB}} to enter a tab. | |
535 | |
536 @node GUD Customization | |
537 @subsection GUD Customization | |
538 | |
539 @vindex gdb-mode-hook | |
540 @vindex dbx-mode-hook | |
541 @vindex sdb-mode-hook | |
542 @vindex xdb-mode-hook | |
543 @vindex perldb-mode-hook | |
544 @vindex pdb-mode-hook | |
545 @vindex jdb-mode-hook | |
546 On startup, GUD runs one of the following hooks: @code{gdb-mode-hook}, | |
547 if you are using GDB; @code{dbx-mode-hook}, if you are using DBX; | |
548 @code{sdb-mode-hook}, if you are using SDB; @code{xdb-mode-hook}, if you | |
549 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
|
550 @code{pdb-mode-hook}, for PDB; @code{jdb-mode-hook}, for JDB. You can |
25829 | 551 use these hooks to define custom key bindings for the debugger |
552 interaction buffer. @xref{Hooks}. | |
553 | |
554 Here is a convenient way to define a command that sends a particular | |
555 command string to the debugger, and set up a key binding for it in the | |
556 debugger interaction buffer: | |
557 | |
558 @findex gud-def | |
559 @example | |
560 (gud-def @var{function} @var{cmdstring} @var{binding} @var{docstring}) | |
561 @end example | |
562 | |
563 This defines a command named @var{function} which sends | |
564 @var{cmdstring} to the debugger process, and gives it the documentation | |
38743 | 565 string @var{docstring}. You can then use the command @var{function} in any |
25829 | 566 buffer. If @var{binding} is non-@code{nil}, @code{gud-def} also binds |
567 the command to @kbd{C-c @var{binding}} in the GUD buffer's mode and to | |
568 @kbd{C-x C-a @var{binding}} generally. | |
569 | |
570 The command string @var{cmdstring} may contain certain | |
571 @samp{%}-sequences that stand for data to be filled in at the time | |
572 @var{function} is called: | |
573 | |
574 @table @samp | |
575 @item %f | |
576 The name of the current source file. If the current buffer is the GUD | |
577 buffer, then the ``current source file'' is the file that the program | |
578 stopped in. | |
579 @c This said, ``the name of the file the program counter was in at the last breakpoint.'' | |
580 @c But I suspect it is really the last stop file. | |
581 | |
582 @item %l | |
583 The number of the current source line. If the current buffer is the GUD | |
584 buffer, then the ``current source line'' is the line that the program | |
585 stopped in. | |
586 | |
587 @item %e | |
588 The text of the C lvalue or function-call expression at or adjacent to point. | |
589 | |
590 @item %a | |
591 The text of the hexadecimal address at or adjacent to point. | |
592 | |
593 @item %p | |
594 The numeric argument of the called function, as a decimal number. If | |
595 the command is used without a numeric argument, @samp{%p} stands for the | |
596 empty string. | |
597 | |
598 If you don't use @samp{%p} in the command string, the command you define | |
599 ignores any numeric argument. | |
600 @end table | |
601 | |
27223 | 602 @node GUD Tooltips |
603 @subsection GUD Tooltips | |
604 | |
605 @cindex tooltips with GUD | |
606 The Tooltip facility (@pxref{Tooltips}) provides support for GUD@. If | |
607 GUD support is activated by customizing the @code{tooltip} group, | |
608 variable values can be displayed in tooltips by pointing at them with | |
609 the mouse in the GUD buffer or in source buffers with major modes in the | |
610 customizable list @code{tooltip-gud-modes}. | |
611 | |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
612 @node GDB Graphical Interface |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
613 @subsection GDB Graphical Interface |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
614 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
615 @findex gdba |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
616 The command @code{gdba} starts GDB using a graphical interface where |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
617 you view and control the program's data using Emacs windows. You can |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
618 still interact with GDB through the GUD buffer, but the point of this |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
619 mode is that you can do it through menus and clicks, without needing |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
620 to know GDB commands. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
621 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
622 @menu |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
623 * Breakpoints Buffer:: A breakpoint control panel. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
624 * Stack Buffer:: Select a frame from the call stack. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
625 * Data Display:: Display and update expressions in their own buffer. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
626 * Display Buffer:: Control the displayed expressions. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
627 * Other Buffers:: Input/output, locals, registers and assembler buffers. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
628 * Layout:: Control the number of displayed buffers. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
629 @end menu |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
630 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
631 @node Breakpoints Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
632 @subsubsection Breakpoints Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
633 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
634 The breakpoints buffer shows the existing breakpoints and watchpoints |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
635 (@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
|
636 commands: |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
637 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
638 @table @kbd |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
639 @item @key{SPC} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
640 @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
|
641 @findex gdb-toggle-breakpoint |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
642 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
|
643 (@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
|
644 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
|
645 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
|
646 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
|
647 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
|
648 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
649 @item @kbd{d} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
650 @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
|
651 @findex gdb-delete-breakpoint |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
652 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
|
653 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
654 @item @key{RET} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
655 @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
|
656 @findex gdb-goto-breakpoint |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
657 Display the file in the source buffer at the breakpoint specified at |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
658 the current line (@code{gdb-goto-breakpoint}). Alternatively, click @kbd{Mouse-2} on the breakpoint that you wish to visit. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
659 @end table |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
660 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
661 @node Stack Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
662 @subsubsection Stack Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
663 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
664 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
|
665 of the nested subroutine calls (@dfn{stack frames}) now active in the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
666 program. @xref{Backtrace,,info stack, gdb, The GNU debugger}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
667 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
668 Move point to any frame in the stack and type @key{RET} to make it |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
669 become the current frame (@code{gdb-frames-select}) and display the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
670 associated source in the source buffer. Alternatively, click |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
671 @kbd{Mouse-2} to make the selected frame become the current one. If the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
672 locals buffer is displayed then its contents update to display the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
673 variables that are local to the new frame. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
674 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
675 @node Data Display |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
676 @subsubsection Data Display |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
677 @cindex displaying expressions in GDB |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
678 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
679 If you want to see how a variable changes each time your program stops |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
680 then place the cursor over the variable name and click on the display |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
681 icon in the toolbar (@code{gud-display}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
682 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
683 Each displayed expression has its own frame on a graphical display and |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
684 its own buffer on a text-only terminal. Arrays and structures have |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
685 their own display formats. To display an array as a slice, at the top |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
686 of the display window, click @kbd{Mouse-2} on the array index that you |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
687 want to restrict and you will be prompted in the mini-buffer for a |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
688 start and a stop value. Click @kbd{Mouse-2} on a pointer to |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
689 dereference it in the same frame/buffer. Click @kbd{S-Mouse-2} there |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
690 to do the same thing but in a new frame/buffer. There are two special |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
691 commands for these buffers: |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
692 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
693 @table @kbd |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
694 @item @kbd{v} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
695 @kindex v @r{(GDB data buffer)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
696 @findex gdb-array-visualise |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
697 Visualise an array using the graph program from plotutils if this is |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
698 installed. This only works for one dimensional arrays |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
699 (@code{gdb-array-visualise}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
700 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
701 @item @kbd{q} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
702 @kindex q @r{(GDB data buffer)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
703 @findex gdb-delete-expression |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
704 Delete the displayed expression and the associated frame |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
705 (@code{gdb-delete-expression}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
706 @end table |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
707 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
708 @node Display Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
709 @subsubsection Display Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
710 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
711 The display buffer shows the list of displayed expressions |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
712 (@pxref{Auto Display,,, gdb, The GNU debugger}). As with the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
713 breakpoints, you can enable/disable or delete the displayed |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
714 expressions: |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
715 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
716 @table @kbd |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
717 @item @key{SPC} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
718 @kindex SPC @r{(GDB display buffer)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
719 @findex gdb-toggle-display |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
720 Enable/disable the display at the current line |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
721 (@code{gdb-toggle-display}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
722 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
723 @item @kbd{d} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
724 @kindex d @r{(GDB display buffer)} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
725 @findex gdb-delete-display |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
726 Delete the display at the current line (@code{gdb-delete-display}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
727 @end table |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
728 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
729 @node Other Buffers |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
730 @subsubsection Other Buffers |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
731 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
732 @table @asis |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
733 @item Input/Output Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
734 The executable program that is being debugged takes its input and |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
735 displays its output here. Some of the commands from shell mode are |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
736 available here. @xref{Shell Mode}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
737 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
738 @item Locals Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
739 The locals buffer displays the values of local variables of the |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
740 current frame for simple data types (@pxref{Frame Info,,, gdb, The GNU |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
741 debugger}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
742 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
743 Arrays and structures display their type only. You must display them |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
744 separately to examine their values. @ref{Data Display}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
745 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
746 @item Registers Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
747 The registers buffer displays the values held by the registers |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
748 (@pxref{Registers,,, gdb, The GNU debugger}). |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
749 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
750 @item Assembler Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
751 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
|
752 overlay arrow points to the current instruction and you can set and |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
753 remove breakpoints as with the source buffer. Breakpoints also |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
754 appear in the margin. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
755 @end table |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
756 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
757 @node Layout |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
758 @subsubsection Layout |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
759 @cindex GDB User Interface layout |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
760 You may choose to display the additional buffers described previously |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
761 either in the same frame or a different one. Select GDB-windows or |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
762 GDB-Frames from the menu-bar under the heading GUD. If the menu-bar |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
763 is unavailable, type @code{M-x |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
764 gdb-display-@var{buffertype}-buffer} or @code{M-x |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
765 gdb-frame-@var{buffertype}-buffer} respectively, where @var{buffertype} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
766 is the relevant buffer type e.g breakpoints. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
767 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
768 @findex gdb-many-windows |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
769 @vindex gdb-many-windows |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
770 If @code{gdb-many-windows} is @code{nil} (the default value), then GDB starts |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
771 with just two windows: the GUD and the source buffer. If it is @code{t}, then |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
772 six windows with the following layout will appear: |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
773 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
774 @multitable @columnfractions .5 .5 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
775 @item GUD buffer (I/O of GDB) |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
776 @tab Locals buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
777 @item |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
778 @tab |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
779 @item Source buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
780 @tab Input/Output (of debuggee) buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
781 @item |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
782 @tab |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
783 @item Stack buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
784 @tab Breakpoints buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
785 @end multitable |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
786 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
787 To toggle this layout, do @kbd{M-x gdb-many-windows}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
788 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
789 @findex gdb-restore-windows |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
790 If you change the window layout, for example, while editing and |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
791 re-compiling your program, then you can restore it with |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
792 @code{gdb-restore-windows}. |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
793 |
25829 | 794 @node Executing Lisp |
795 @section Executing Lisp Expressions | |
796 | |
797 Emacs has several different major modes for Lisp and Scheme. They are | |
798 the same in terms of editing commands, but differ in the commands for | |
799 executing Lisp expressions. Each mode has its own purpose. | |
800 | |
801 @table @asis | |
802 @item Emacs-Lisp mode | |
803 The mode for editing source files of programs to run in Emacs Lisp. | |
804 This mode defines @kbd{C-M-x} to evaluate the current defun. | |
805 @xref{Lisp Libraries}. | |
806 @item Lisp Interaction mode | |
807 The mode for an interactive session with Emacs Lisp. It defines | |
808 @kbd{C-j} to evaluate the sexp before point and insert its value in the | |
809 buffer. @xref{Lisp Interaction}. | |
810 @item Lisp mode | |
811 The mode for editing source files of programs that run in Lisps other | |
812 than Emacs Lisp. This mode defines @kbd{C-M-x} to send the current defun | |
813 to an inferior Lisp process. @xref{External Lisp}. | |
814 @item Inferior Lisp mode | |
815 The mode for an interactive session with an inferior Lisp process. | |
816 This mode combines the special features of Lisp mode and Shell mode | |
817 (@pxref{Shell Mode}). | |
818 @item Scheme mode | |
819 Like Lisp mode but for Scheme programs. | |
820 @item Inferior Scheme mode | |
821 The mode for an interactive session with an inferior Scheme process. | |
822 @end table | |
823 | |
824 Most editing commands for working with Lisp programs are in fact | |
825 available globally. @xref{Programs}. | |
826 | |
827 @node Lisp Libraries | |
828 @section Libraries of Lisp Code for Emacs | |
829 @cindex libraries | |
830 @cindex loading Lisp code | |
831 | |
832 Lisp code for Emacs editing commands is stored in files whose names | |
833 conventionally end in @file{.el}. This ending tells Emacs to edit them in | |
834 Emacs-Lisp mode (@pxref{Executing Lisp}). | |
835 | |
836 @findex load-file | |
837 To execute a file of Emacs Lisp code, use @kbd{M-x load-file}. This | |
838 command reads a file name using the minibuffer and then executes the | |
839 contents of that file as Lisp code. It is not necessary to visit the | |
840 file first; in any case, this command reads the file as found on disk, | |
841 not text in an Emacs buffer. | |
842 | |
843 @findex load | |
844 @findex load-library | |
845 Once a file of Lisp code is installed in the Emacs Lisp library | |
846 directories, users can load it using @kbd{M-x load-library}. Programs can | |
847 load it by calling @code{load-library}, or with @code{load}, a more primitive | |
848 function that is similar but accepts some additional arguments. | |
849 | |
850 @kbd{M-x load-library} differs from @kbd{M-x load-file} in that it | |
851 searches a sequence of directories and tries three file names in each | |
852 directory. Suppose your argument is @var{lib}; the three names are | |
853 @file{@var{lib}.elc}, @file{@var{lib}.el}, and lastly just | |
854 @file{@var{lib}}. If @file{@var{lib}.elc} exists, it is by convention | |
855 the result of compiling @file{@var{lib}.el}; it is better to load the | |
856 compiled file, since it will load and run faster. | |
857 | |
858 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
|
859 @file{@var{lib}.elc} file, it issues a warning, because it's likely that |
25829 | 860 somebody made changes to the @file{.el} file and forgot to recompile |
861 it. | |
862 | |
863 Because the argument to @code{load-library} is usually not in itself | |
864 a valid file name, file name completion is not available. Indeed, when | |
865 using this command, you usually do not know exactly what file name | |
866 will be used. | |
867 | |
868 @vindex load-path | |
869 The sequence of directories searched by @kbd{M-x load-library} is | |
870 specified by the variable @code{load-path}, a list of strings that are | |
871 directory names. The default value of the list contains the directory where | |
872 the Lisp code for Emacs itself is stored. If you have libraries of | |
873 your own, put them in a single directory and add that directory | |
874 to @code{load-path}. @code{nil} in this list stands for the current default | |
875 directory, but it is probably not a good idea to put @code{nil} in the | |
876 list. If you find yourself wishing that @code{nil} were in the list, | |
877 most likely what you really want to do is use @kbd{M-x load-file} | |
878 this once. | |
879 | |
880 @cindex autoload | |
881 Often you do not have to give any command to load a library, because | |
882 the commands defined in the library are set up to @dfn{autoload} that | |
883 library. Trying to run any of those commands calls @code{load} to load | |
884 the library; this replaces the autoload definitions with the real ones | |
885 from the library. | |
886 | |
887 @cindex byte code | |
888 Emacs Lisp code can be compiled into byte-code which loads faster, | |
889 takes up less space when loaded, and executes faster. @xref{Byte | |
890 Compilation,, Byte Compilation, elisp, the Emacs Lisp Reference Manual}. | |
891 By convention, the compiled code for a library goes in a separate file | |
892 whose name consists of the library source file with @samp{c} appended. | |
893 Thus, the compiled code for @file{foo.el} goes in @file{foo.elc}. | |
894 That's why @code{load-library} searches for @samp{.elc} files first. | |
895 | |
31027
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
896 @vindex load-dangerous-libraries |
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
897 @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
|
898 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
|
899 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
|
900 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
|
901 @code{t} if you want to try loading them. |
31027
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
902 |
25829 | 903 @node Lisp Eval |
904 @section Evaluating Emacs-Lisp Expressions | |
905 @cindex Emacs-Lisp mode | |
906 @cindex mode, Emacs-Lisp | |
907 | |
908 @findex emacs-lisp-mode | |
909 Lisp programs intended to be run in Emacs should be edited in | |
910 Emacs-Lisp mode; this happens automatically for file names ending in | |
911 @file{.el}. By contrast, Lisp mode itself is used for editing Lisp | |
912 programs intended for other Lisp systems. To switch to Emacs-Lisp mode | |
913 explicitly, use the command @kbd{M-x emacs-lisp-mode}. | |
914 | |
915 For testing of Lisp programs to run in Emacs, it is often useful to | |
916 evaluate part of the program as it is found in the Emacs buffer. For | |
917 example, after changing the text of a Lisp function definition, | |
918 evaluating the definition installs the change for future calls to the | |
919 function. Evaluation of Lisp expressions is also useful in any kind of | |
920 editing, for invoking noninteractive functions (functions that are | |
921 not commands). | |
922 | |
923 @table @kbd | |
924 @item M-: | |
925 Read a single Lisp expression in the minibuffer, evaluate it, and print | |
926 the value in the echo area (@code{eval-expression}). | |
927 @item C-x C-e | |
928 Evaluate the Lisp expression before point, and print the value in the | |
929 echo area (@code{eval-last-sexp}). | |
930 @item C-M-x | |
931 Evaluate the defun containing or after point, and print the value in | |
932 the echo area (@code{eval-defun}). | |
933 @item M-x eval-region | |
934 Evaluate all the Lisp expressions in the region. | |
935 @item M-x eval-current-buffer | |
936 Evaluate all the Lisp expressions in the buffer. | |
937 @end table | |
938 | |
44116
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
939 @ifinfo |
43889
c5ea7e769ffd
(Electric C, Lisp Eval): Avoid makeinfo warnings about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents:
43151
diff
changeset
|
940 @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
|
941 @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
|
942 @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
|
943 @end ifinfo |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
944 @ifnotinfo |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
945 @kindex M-: |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
946 @end ifnotinfo |
25829 | 947 @findex eval-expression |
948 @kbd{M-:} (@code{eval-expression}) is the most basic command for evaluating | |
949 a Lisp expression interactively. It reads the expression using the | |
950 minibuffer, so you can execute any expression on a buffer regardless of | |
951 what the buffer contains. When the expression is evaluated, the current | |
952 buffer is once again the buffer that was current when @kbd{M-:} was | |
953 typed. | |
954 | |
955 @kindex C-M-x @r{(Emacs-Lisp mode)} | |
956 @findex eval-defun | |
957 In Emacs-Lisp mode, the key @kbd{C-M-x} is bound to the command | |
958 @code{eval-defun}, which parses the defun containing or following point | |
959 as a Lisp expression and evaluates it. The value is printed in the echo | |
960 area. This command is convenient for installing in the Lisp environment | |
961 changes that you have just made in the text of a function definition. | |
962 | |
963 @kbd{C-M-x} treats @code{defvar} expressions specially. Normally, | |
964 evaluating a @code{defvar} expression does nothing if the variable it | |
965 defines already has a value. But @kbd{C-M-x} unconditionally resets the | |
966 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
|
967 @code{defcustom} expressions are treated similarly. |
25829 | 968 This special feature is convenient for debugging Lisp programs. |
969 | |
970 @kindex C-x C-e | |
971 @findex eval-last-sexp | |
972 The command @kbd{C-x C-e} (@code{eval-last-sexp}) evaluates the Lisp | |
973 expression preceding point in the buffer, and displays the value in the | |
974 echo area. It is available in all major modes, not just Emacs-Lisp | |
975 mode. It does not treat @code{defvar} specially. | |
976 | |
977 If @kbd{C-M-x}, @kbd{C-x C-e}, or @kbd{M-:} is given a numeric | |
978 argument, it inserts the value into the current buffer at point, rather | |
979 than displaying it in the echo area. The argument's value does not | |
980 matter. | |
981 | |
982 @findex eval-region | |
983 @findex eval-current-buffer | |
984 The most general command for evaluating Lisp expressions from a buffer | |
985 is @code{eval-region}. @kbd{M-x eval-region} parses the text of the | |
986 region as one or more Lisp expressions, evaluating them one by one. | |
987 @kbd{M-x eval-current-buffer} is similar but evaluates the entire | |
988 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
|
989 Lisp code that you are ready to test. Later, as you find bugs and |
25829 | 990 change individual functions, use @kbd{C-M-x} on each function that you |
991 change. This keeps the Lisp world in step with the source file. | |
992 | |
28431
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
993 @vindex eval-expression-print-level |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
994 @vindex eval-expression-print-length |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
995 @vindex eval-expression-debug-on-error |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
996 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
|
997 @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
|
998 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
|
999 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
|
1000 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
|
1001 used. |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1002 |
25829 | 1003 @node Lisp Interaction |
1004 @section Lisp Interaction Buffers | |
1005 | |
1006 The buffer @samp{*scratch*} which is selected when Emacs starts up is | |
1007 provided for evaluating Lisp expressions interactively inside Emacs. | |
1008 | |
1009 The simplest way to use the @samp{*scratch*} buffer is to insert Lisp | |
1010 expressions and type @kbd{C-j} after each expression. This command | |
1011 reads the Lisp expression before point, evaluates it, and inserts the | |
1012 value in printed representation before point. The result is a complete | |
1013 typescript of the expressions you have evaluated and their values. | |
1014 | |
1015 The @samp{*scratch*} buffer's major mode is Lisp Interaction mode, which | |
1016 is the same as Emacs-Lisp mode except for the binding of @kbd{C-j}. | |
1017 | |
1018 @findex lisp-interaction-mode | |
1019 The rationale for this feature is that Emacs must have a buffer when | |
1020 it starts up, but that buffer is not useful for editing files since a | |
1021 new buffer is made for every file that you visit. The Lisp interpreter | |
1022 typescript is the most useful thing I can think of for the initial | |
1023 buffer to do. Type @kbd{M-x lisp-interaction-mode} to put the current | |
1024 buffer in Lisp Interaction mode. | |
1025 | |
1026 @findex ielm | |
1027 An alternative way of evaluating Emacs Lisp expressions interactively | |
1028 is to use Inferior Emacs-Lisp mode, which provides an interface rather | |
1029 like Shell mode (@pxref{Shell Mode}) for evaluating Emacs Lisp | |
1030 expressions. Type @kbd{M-x ielm} to create an @samp{*ielm*} buffer | |
1031 which uses this mode. | |
1032 | |
1033 @node External Lisp | |
1034 @section Running an External Lisp | |
1035 | |
1036 Emacs has facilities for running programs in other Lisp systems. You can | |
1037 run a Lisp process as an inferior of Emacs, and pass expressions to it to | |
1038 be evaluated. You can also pass changed function definitions directly from | |
1039 the Emacs buffers in which you edit the Lisp programs to the inferior Lisp | |
1040 process. | |
1041 | |
1042 @findex run-lisp | |
1043 @vindex inferior-lisp-program | |
1044 @kindex C-x C-z | |
1045 To run an inferior Lisp process, type @kbd{M-x run-lisp}. This runs | |
1046 the program named @code{lisp}, the same program you would run by typing | |
1047 @code{lisp} as a shell command, with both input and output going through | |
1048 an Emacs buffer named @samp{*lisp*}. That is to say, any ``terminal | |
1049 output'' from Lisp will go into the buffer, advancing point, and any | |
1050 ``terminal input'' for Lisp comes from text in the buffer. (You can | |
1051 change the name of the Lisp executable file by setting the variable | |
1052 @code{inferior-lisp-program}.) | |
1053 | |
1054 To give input to Lisp, go to the end of the buffer and type the input, | |
1055 terminated by @key{RET}. The @samp{*lisp*} buffer is in Inferior Lisp | |
1056 mode, which combines the special characteristics of Lisp mode with most | |
1057 of the features of Shell mode (@pxref{Shell Mode}). The definition of | |
1058 @key{RET} to send a line to a subprocess is one of the features of Shell | |
1059 mode. | |
1060 | |
1061 @findex lisp-mode | |
1062 For the source files of programs to run in external Lisps, use Lisp | |
1063 mode. This mode can be selected with @kbd{M-x lisp-mode}, and is used | |
1064 automatically for files whose names end in @file{.l}, @file{.lsp}, or | |
1065 @file{.lisp}, as most Lisp systems usually expect. | |
1066 | |
1067 @kindex C-M-x @r{(Lisp mode)} | |
1068 @findex lisp-eval-defun | |
1069 When you edit a function in a Lisp program you are running, the easiest | |
1070 way to send the changed definition to the inferior Lisp process is the key | |
1071 @kbd{C-M-x}. In Lisp mode, this runs the function @code{lisp-eval-defun}, | |
1072 which finds the defun around or following point and sends it as input to | |
1073 the Lisp process. (Emacs can send input to any inferior process regardless | |
1074 of what buffer is current.) | |
1075 | |
1076 Contrast the meanings of @kbd{C-M-x} in Lisp mode (for editing programs | |
1077 to be run in another Lisp system) and Emacs-Lisp mode (for editing Lisp | |
1078 programs to be run in Emacs): in both modes it has the effect of installing | |
1079 the function definition that point is in, but the way of doing so is | |
1080 different according to where the relevant Lisp environment is found. | |
1081 @xref{Executing Lisp}. |