annotate man/building.texi @ 52712:b84a5201d855

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