*** empty log message ***
[emacs.git] / man / building.texi
blob2ec96b0f6bf064aeb4a78bf21cb53b299a4bad8c
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985,86,87,93,94,95,97,2000,2001 Free Software Foundation, Inc.
3 @c See file emacs.texi for copying conditions.
4 @node Building, Maintaining, Programs, Top
5 @chapter Compiling and Testing Programs
6 @cindex building programs
7 @cindex program building
8 @cindex running Lisp functions
10   The previous chapter discusses the Emacs commands that are useful for
11 making changes in programs.  This chapter deals with commands that assist
12 in the larger process of developing and maintaining programs.
14 @menu
15 * Compilation::         Compiling programs in languages other
16                           than Lisp (C, Pascal, etc.).
17 * Grep Searching::      Running grep as if it were a compiler.
18 * Compilation Mode::    The mode for visiting compiler errors.
19 * Compilation Shell::   Customizing your shell properly
20                           for use in the compilation buffer.
21 * Debuggers::           Running symbolic debuggers for non-Lisp programs.
22 * Executing Lisp::      Various modes for editing Lisp programs,
23                           with different facilities for running
24                           the Lisp programs.
25 * Libraries: Lisp Libraries.      Creating Lisp programs to run in Emacs.
26 * Eval: Lisp Eval.      Executing a single Lisp expression in Emacs.
27 * Interaction: Lisp Interaction.  Executing Lisp in an Emacs buffer.
28 * External Lisp::         Communicating through Emacs with a separate Lisp.
29 @end menu
31 @node Compilation
32 @section Running Compilations under Emacs
33 @cindex inferior process
34 @cindex make
35 @cindex compilation errors
36 @cindex error log
38   Emacs can run compilers for noninteractive languages such as C and
39 Fortran as inferior processes, feeding the error log into an Emacs buffer.
40 It can also parse the error messages and show you the source lines where
41 compilation errors occurred.
43 @table @kbd
44 @item M-x compile
45 Run a compiler asynchronously under Emacs, with error messages going to
46 the @samp{*compilation*} buffer.
47 @item M-x recompile
48 Invoke a compiler with the same command as in the last invocation of
49 @kbd{M-x compile}.
50 @item M-x grep
51 Run @code{grep} asynchronously under Emacs, with matching lines
52 listed in the buffer named @samp{*grep*}.
53 @item M-x grep-find
54 Run @code{grep} via @code{find}, with user-specified arguments, and
55 collect output in the buffer named @samp{*grep*}.
56 @item M-x kill-compilation
57 @itemx M-x kill-grep
58 Kill the running compilation or @code{grep} subprocess.
59 @end table
61 @findex compile
62   To run @code{make} or another compilation command, do @kbd{M-x
63 compile}.  This command reads a shell command line using the minibuffer,
64 and then executes the command in an inferior shell, putting output in
65 the buffer named @samp{*compilation*}.  The current buffer's default
66 directory is used as the working directory for the execution of the
67 command; normally, therefore, the compilation happens in this
68 directory.
70 @vindex compile-command
71   When the shell command line is read, the minibuffer appears
72 containing a default command line, which is the command you used the
73 last time you did @kbd{M-x compile}.  If you type just @key{RET}, the
74 same command line is used again.  For the first @kbd{M-x compile}, the
75 default is @samp{make -k}, which is correct most of the time for
76 nontrivial programs.  (@xref{Top,, Make, make, GNU Make Manual}.)
77 The default compilation command comes from the variable
78 @code{compile-command}; if the appropriate compilation command for a
79 file is something other than @samp{make -k}, it can be useful for the
80 file to specify a local value for @code{compile-command} (@pxref{File
81 Variables}).
83   Starting a compilation displays the buffer @samp{*compilation*} in
84 another window but does not select it.  The buffer's mode line tells you
85 whether compilation is finished, with the word @samp{run} or @samp{exit}
86 inside the parentheses.  You do not have to keep this buffer visible;
87 compilation continues in any case.  While a compilation is going on, the
88 string @samp{Compiling} appears in the mode lines of all windows.  When
89 this string disappears, the compilation is finished.
91   If you want to watch the compilation transcript as it appears, switch
92 to the @samp{*compilation*} buffer and move point to the end of the
93 buffer.  When point is at the end, new compilation output is inserted
94 above point, which remains at the end.  If point is not at the end of
95 the buffer, it remains fixed while more compilation output is added at
96 the end of the buffer.
98 @cindex compilation buffer, keeping current position at the end
99 @vindex compilation-scroll-output
100   If you set the variable @code{compilation-scroll-output} to a
101 non-@code{nil} value, then the compilation buffer always scrolls to
102 follow output as it comes in.
104 @findex kill-compilation
105   When the compiler process terminates, for whatever reason, the mode
106 line of the @samp{*compilation*} buffer changes to say @samp{signal}
107 instead of @samp{run}.  Starting a new compilation also kills any
108 running compilation, as only one can exist at any time.  However,
109 @kbd{M-x compile} asks for confirmation before actually killing a
110 compilation that is running.  You can also kill the compilation
111 process with @kbd{M-x kill-compilation}.
113 @findex recompile
114   To rerun the last compilation with the same command, type @kbd{M-x
115 recompile}.  This automatically reuses the compilation command from the
116 last invocation of @kbd{M-x compile}.
118   Emacs does not expect a compiler process to launch asynchronous
119 subprocesses; if it does, and they keep running after the main
120 compiler process has terminated, Emacs may kill them or their output
121 may not arrive in Emacs.  To avoid this problem, make the main process
122 wait for its subprocesses to finish.  In a shell script, you can do this
123 using @samp{$!} and @samp{wait}, like this:
125 @example
126 (sleep 10; echo 2nd)& pid=$!  # @r{Record pid of subprocess}
127 echo first message
128 wait $pid                     # @r{Wait for subprocess}
129 @end example
131   If the background process does not output to the compilation buffer,
132 so you only need to prevent it from being killed when the main
133 compilation process terminates, this is sufficient:
135 @example
136 nohup @var{command}; sleep 1
137 @end example
139 @vindex compilation-environment
140   You can control the environment passed to the compilation command
141 with the variable @code{compilation-environment}.  Its value is a list
142 of environment variable settings; each element should be a string of
143 the form @code{"@var{envvarname}=@var{value}"}.  These environment
144 variable settings override the usual ones.
146 @node Grep Searching
147 @section Searching with Grep under Emacs
149 @findex grep
150   Just as you can run a compiler from Emacs and then visit the lines
151 where there were compilation errors, you can also run @code{grep} and
152 then visit the lines on which matches were found.  This works by
153 treating the matches reported by @code{grep} as if they were ``errors.''
155   To do this, type @kbd{M-x grep}, then enter a command line that
156 specifies how to run @code{grep}.  Use the same arguments you would give
157 @code{grep} when running it normally: a @code{grep}-style regexp
158 (usually in single-quotes to quote the shell's special characters)
159 followed by file names, which may use wildcards.  The output from
160 @code{grep} goes in the @samp{*grep*} buffer.  You can find the
161 corresponding lines in the original files using @kbd{C-x `} and
162 @key{RET}, as with compilation errors.
164   If you specify a prefix argument for @kbd{M-x grep}, it figures out
165 the tag (@pxref{Tags}) around point, and puts that into the default
166 @code{grep} command.
168 @findex grep-find
169   The command @kbd{M-x grep-find} is similar to @kbd{M-x grep}, but it
170 supplies a different initial default for the command---one that runs
171 both @code{find} and @code{grep}, so as to search every file in a
172 directory tree.  See also the @code{find-grep-dired} command,
173 in @ref{Dired and Find}.
175 @node Compilation Mode
176 @section Compilation Mode
178 @findex compile-goto-error
179 @cindex Compilation mode
180 @cindex mode, Compilation
181   The @samp{*compilation*} buffer uses a special major mode, Compilation
182 mode, whose main feature is to provide a convenient way to look at the
183 source line where the error happened.
185   If you set the variable @code{compilation-scroll-output} to a
186 non-@code{nil} value, then the compilation buffer always scrolls to
187 follow output as it comes in.
189 @table @kbd
190 @item C-x `
191 Visit the locus of the next compiler error message or @code{grep} match.
192 @item @key{RET}
193 Visit the locus of the error message that point is on.
194 This command is used in the compilation buffer.
195 @item Mouse-2
196 Visit the locus of the error message that you click on.
197 @end table
199 @kindex C-x `
200 @findex next-error
201   You can visit the source for any particular error message by moving
202 point in the @samp{*compilation*} buffer to that error message and
203 typing @key{RET} (@code{compile-goto-error}).  Alternatively, you can
204 click @kbd{Mouse-2} on the error message; you need not switch to the
205 @samp{*compilation*} buffer first.
207   To parse the compiler error messages sequentially, type @kbd{C-x `}
208 (@code{next-error}).  The character following the @kbd{C-x} is the
209 backquote or ``grave accent,'' not the single-quote.  This command is
210 available in all buffers, not just in @samp{*compilation*}; it displays
211 the next error message at the top of one window and source location of
212 the error in another window.
214   The first time @kbd{C-x `} is used after the start of a compilation,
215 it moves to the first error's location.  Subsequent uses of @kbd{C-x `}
216 advance down to subsequent errors.  If you visit a specific error
217 message with @key{RET} or @kbd{Mouse-2}, subsequent @kbd{C-x `}
218 commands advance from there.  When @kbd{C-x `} gets to the end of the
219 buffer and finds no more error messages to visit, it fails and signals
220 an Emacs error.
222   You don't have to be in the compilation buffer in order to use
223 @code{next-error}.  If one window on the selected frame can be the
224 target of the @code{next-error} call, it is used.  Else, if a buffer
225 previously had @code{next-error} called on it, it is used.  Else,
226 if the current buffer can be the target of @code{next-error}, it is
227 used.  Else, all the buffers Emacs manages are tried for
228 @code{next-error} support.
230   @kbd{C-u C-x `} starts scanning from the beginning of the compilation
231 buffer.  This is one way to process the same set of errors again.
233 @vindex compilation-error-regexp-alist
234 @vindex grep-regexp-alist
235   To parse messages from the compiler, Compilation mode uses the
236 variable @code{compilation-error-regexp-alist} which lists various
237 formats of error messages and tells Emacs how to extract the source file
238 and the line number from the text of a message.  If your compiler isn't
239 supported, you can tailor Compilation mode to it by adding elements to
240 that list.  A similar variable @code{grep-regexp-alist} tells Emacs how
241 to parse output of a @code{grep} command.
243   Compilation mode also redefines the keys @key{SPC} and @key{DEL} to
244 scroll by screenfuls, and @kbd{M-n} and @kbd{M-p} to move to the next or
245 previous error message.  You can also use @kbd{M-@{} and @kbd{M-@}} to
246 move up or down to an error message for a different source file.
248   The features of Compilation mode are also available in a minor mode
249 called Compilation Minor mode.  This lets you parse error messages in
250 any buffer, not just a normal compilation output buffer.  Type @kbd{M-x
251 compilation-minor-mode} to enable the minor mode.  This defines the keys
252 @key{RET} and @kbd{Mouse-2}, as in the Compilation major mode.
254   Compilation minor mode works in any buffer, as long as the contents
255 are in a format that it understands.  In an Rlogin buffer (@pxref{Remote
256 Host}), Compilation minor mode automatically accesses remote source
257 files by FTP (@pxref{File Names}).
259 @node Compilation Shell
260 @section Subshells for Compilation
262   Emacs uses a shell to run the compilation command, but specifies
263 the option for a noninteractive shell.  This means, in particular, that
264 the shell should start with no prompt.  If you find your usual shell
265 prompt making an unsightly appearance in the @samp{*compilation*}
266 buffer, it means you have made a mistake in your shell's init file by
267 setting the prompt unconditionally.  (This init file's name may be
268 @file{.bashrc}, @file{.profile}, @file{.cshrc}, @file{.shrc}, or various
269 other things, depending on the shell you use.)  The shell init file
270 should set the prompt only if there already is a prompt.  In csh, here
271 is how to do it:
273 @example
274 if ($?prompt) set prompt = @dots{}
275 @end example
277 @noindent
278 And here's how to do it in bash:
280 @example
281 if [ "$@{PS1+set@}" = set ]
282 then PS1=@dots{}
284 @end example
286   There may well be other things that your shell's init file
287 ought to do only for an interactive shell.  You can use the same
288 method to conditionalize them.
290   The MS-DOS ``operating system'' does not support asynchronous
291 subprocesses; to work around this lack, @kbd{M-x compile} runs the
292 compilation command synchronously on MS-DOS.  As a consequence, you must
293 wait until the command finishes before you can do anything else in
294 Emacs.  @xref{MS-DOS}.
296 @node Debuggers
297 @section Running Debuggers Under Emacs
298 @cindex debuggers
299 @cindex GUD library
300 @cindex GDB
301 @cindex DBX
302 @cindex SDB
303 @cindex XDB
304 @cindex Perldb
305 @cindex JDB
306 @cindex PDB
308 @c Do you believe in GUD?
309 The GUD (Grand Unified Debugger) library provides an interface to
310 various symbolic debuggers from within Emacs.  We recommend the debugger
311 GDB, which is free software, but you can also run DBX, SDB or XDB if you
312 have them.  GUD can also serve as an interface to Perl's debugging
313 mode, the Python debugger PDB, and to JDB, the Java Debugger.
314 @xref{Debugging,, The Lisp Debugger, elisp, the Emacs Lisp Reference Manual},
315 for information on debugging Emacs Lisp programs.
317 @menu
318 * Starting GUD::        How to start a debugger subprocess.
319 * Debugger Operation::  Connection between the debugger and source buffers.
320 * Commands of GUD::     Key bindings for common commands.
321 * GUD Customization::   Defining your own commands for GUD.
322 * GUD Tooltips::        Showing variable values by pointing with the mouse.
323 * GDB Graphical Interface::  An enhanced mode that uses GDB features to
324                         implement a graphical debugging environment through
325                         Emacs.
326 @end menu
328 @node Starting GUD
329 @subsection Starting GUD
331   There are several commands for starting a debugger, each corresponding
332 to a particular debugger program.
334 @table @kbd
335 @item M-x gdb @key{RET} @var{file} @key{RET}
336 @findex gdb
337 Run GDB as a subprocess of Emacs.  If the variable
338 @code{gud-gdb-command-name} is ``gdb --annotate=3'' (the default
339 value) then GDB starts as for @kbd{M-x gdba} below.  If you want GDB
340 to start as in Emacs 21.3 and earlier then edit the string in the
341 minibuffer or set @code{gud-gdb-command-name} to ``gdb --fullname''.
342 You need to do this if you want to run multiple debugging sessions
343 within one Emacs session.  In this case, the command creates a buffer
344 for input and output to GDB, and switches to it.  If a GDB buffer
345 already exists, it just switches to that buffer.
347 @item M-x gdba @key{RET} @var{file} @key{RET}
348 Run GDB as a subprocess of Emacs, providing a graphical interface
349 to GDB features through Emacs.  @xref{GDB Graphical Interface}.
351 @item M-x dbx @key{RET} @var{file} @key{RET}
352 @findex dbx
353 Similar, but run DBX instead of GDB.
355 @item M-x xdb @key{RET} @var{file} @key{RET}
356 @findex xdb
357 @vindex gud-xdb-directories
358 Similar, but run XDB instead of GDB.  Use the variable
359 @code{gud-xdb-directories} to specify directories to search for source
360 files.
362 @item M-x sdb @key{RET} @var{file} @key{RET}
363 @findex sdb
364 Similar, but run SDB instead of GDB.
366   Some versions of SDB do not mention source file names in their
367 messages.  When you use them, you need to have a valid tags table
368 (@pxref{Tags}) in order for GUD to find functions in the source code.
369 If you have not visited a tags table or the tags table doesn't list one
370 of the functions, you get a message saying @samp{The sdb support
371 requires a valid tags table to work}.  If this happens, generate a valid
372 tags table in the working directory and try again.
374 @item M-x perldb @key{RET} @var{file} @key{RET}
375 @findex perldb
376 Run the Perl interpreter in debug mode to debug @var{file}, a Perl program.
378 @item M-x jdb @key{RET} @var{file} @key{RET}
379 @findex jdb
380 Run the Java debugger to debug @var{file}.
382 @item M-x pdb @key{RET} @var{file} @key{RET}
383 @findex pdb
384 Run the Python debugger to debug @var{file}.
385 @end table
387   Each of these commands takes one argument: a command line to invoke
388 the debugger.  In the simplest case, specify just the name of the
389 executable file you want to debug.  You may also use options that the
390 debugger supports.  However, shell wildcards and variables are not
391 allowed.  GUD assumes that the first argument not starting with a
392 @samp{-} is the executable file name.
394   Emacs can only run one debugger process at a time.
396 @node Debugger Operation
397 @subsection Debugger Operation
399 @cindex fringes, and current execution line in GUD
400   When you run a debugger with GUD, the debugger uses an Emacs buffer
401 for its ordinary input and output.  This is called the GUD buffer.  The
402 debugger displays the source files of the program by visiting them in
403 Emacs buffers.  An arrow (@samp{=>}) in one of these buffers indicates
404 the current execution line.@footnote{Under a window system, the arrow
405 appears in the left fringe of the Emacs window.}  Moving point in this
406 buffer does not move the arrow.
408   You can start editing these source files at any time in the buffers
409 that display them.  The arrow is not part of the file's
410 text; it appears only on the screen.  If you do modify a source file,
411 keep in mind that inserting or deleting lines will throw off the arrow's
412 positioning; GUD has no way of figuring out which line corresponded
413 before your changes to the line number in a debugger message.  Also,
414 you'll typically have to recompile and restart the program for your
415 changes to be reflected in the debugger's tables.
417   If you wish, you can control your debugger process entirely through the
418 debugger buffer, which uses a variant of Shell mode.  All the usual
419 commands for your debugger are available, and you can use the Shell mode
420 history commands to repeat them.  @xref{Shell Mode}.
422 @node Commands of GUD
423 @subsection Commands of GUD
425   The GUD interaction buffer uses a variant of Shell mode, so the
426 commands of Shell mode are available (@pxref{Shell Mode}).  GUD mode
427 also provides commands for setting and clearing breakpoints, for
428 selecting stack frames, and for stepping through the program.  These
429 commands are available both in the GUD buffer and globally, but with
430 different key bindings.  It also has its own toolbar from which you
431 can invoke the more common commands by clicking on the appropriate
432 icon.  This is particularly useful for repetitive commands like
433 gud-next and gud-step and allows the user to hide the GUD buffer.
435   The breakpoint commands are normally used in source file buffers,
436 because that is the easiest way to specify where to set or clear the
437 breakpoint.  Here's the global command to set a breakpoint:
439 @table @kbd
440 @item C-x @key{SPC}
441 @kindex C-x SPC
442 Set a breakpoint on the source line that point is on.
443 @end table
445 @kindex C-x C-a @r{(GUD)}
446   Here are the other special commands provided by GUD.  The keys
447 starting with @kbd{C-c} are available only in the GUD interaction
448 buffer.  The key bindings that start with @kbd{C-x C-a} are available in
449 the GUD interaction buffer and also in source files.
451 @table @kbd
452 @item C-c C-l
453 @kindex C-c C-l @r{(GUD)}
454 @itemx C-x C-a C-l
455 @findex gud-refresh
456 Display in another window the last line referred to in the GUD
457 buffer (that is, the line indicated in the last location message).
458 This runs the command @code{gud-refresh}.
460 @item C-c C-s
461 @kindex C-c C-s @r{(GUD)}
462 @itemx C-x C-a C-s
463 @findex gud-step
464 Execute a single line of code (@code{gud-step}).  If the line contains
465 a function call, execution stops after entering the called function.
467 @item C-c C-n
468 @kindex C-c C-n @r{(GUD)}
469 @itemx C-x C-a C-n
470 @findex gud-next
471 Execute a single line of code, stepping across entire function calls
472 at full speed (@code{gud-next}).
474 @item C-c C-i
475 @kindex C-c C-i @r{(GUD)}
476 @itemx C-x C-a C-i
477 @findex gud-stepi
478 Execute a single machine instruction (@code{gud-stepi}).
480 @need 3000
481 @item C-c C-r
482 @kindex C-c C-r @r{(GUD)}
483 @itemx C-x C-a C-r
484 @findex gud-cont
485 Continue execution without specifying any stopping point.  The program
486 will run until it hits a breakpoint, terminates, or gets a signal that
487 the debugger is checking for (@code{gud-cont}).
489 @need 1000
490 @item C-c C-d
491 @kindex C-c C-d @r{(GUD)}
492 @itemx C-x C-a C-d
493 @findex gud-remove
494 Delete the breakpoint(s) on the current source line, if any
495 (@code{gud-remove}).  If you use this command in the GUD interaction
496 buffer, it applies to the line where the program last stopped.
498 @item C-c C-t
499 @kindex C-c C-t @r{(GUD)}
500 @itemx C-x C-a C-t
501 @findex gud-tbreak
502 Set a temporary breakpoint on the current source line, if any.
503 If you use this command in the GUD interaction buffer,
504 it applies to the line where the program last stopped.
505 @end table
507   The above commands are common to all supported debuggers.  If you are
508 using GDB or (some versions of) DBX, these additional commands are available:
510 @table @kbd
511 @item C-c <
512 @kindex C-c < @r{(GUD)}
513 @itemx C-x C-a <
514 @findex gud-up
515 Select the next enclosing stack frame (@code{gud-up}).  This is
516 equivalent to the @samp{up} command.
518 @item C-c >
519 @kindex C-c > @r{(GUD)}
520 @itemx C-x C-a >
521 @findex gud-down
522 Select the next inner stack frame (@code{gud-down}).  This is
523 equivalent to the @samp{down} command.
524 @end table
526   If you are using GDB, these additional key bindings are available:
528 @table @kbd
529 @item C-c C-r
530 @kindex C-c C-r @r{(GUD)}
531 @itemx C-x C-a C-r
532 @findex gud-run
533 Start execution of the program (@code{gud-run}).
535 @item C-c C-u
536 @kindex C-c C-u @r{(GUD)}
537 @itemx C-x C-a C-u
538 @findex gud-until
539 Continue execution to the current line. The program will run until
540 it hits a breakpoint, terminates, gets a signal that the debugger is
541 checking for, or reaches the line on which the cursor currently sits
542 (@code{gud-until}).
544 @item @key{TAB}
545 @kindex TAB @r{(GUD)}
546 @findex gud-gdb-complete-command
547 With GDB, complete a symbol name (@code{gud-gdb-complete-command}).
548 This key is available only in the GUD interaction buffer, and requires
549 GDB versions 4.13 and later.
551 @item C-c C-f
552 @kindex C-c C-f @r{(GUD)}
553 @itemx C-x C-a C-f
554 @findex gud-finish
555 Run the program until the selected stack frame returns (or until it
556 stops for some other reason).
558 @item C-x C-a C-j
559 @kindex C-x C-a C-j @r{(GUD)}
560 @findex gud-jump
561 Only useful in a source buffer, (@code{gud-jump}) transfers the
562 program's execution point to the current line.  In other words, the
563 next line that the program executes will be the one where you gave the
564 command.  If the new execution line is in a different function from
565 the previously one, GDB prompts for confirmation since the results may
566 be bizarre.  See the GDB manual entry regarding @code{jump} for
567 details.
568 @end table
570 If you started GDB with the command @code{gdba}, you can click
571 @kbd{Mouse-1} on a line of the source buffer, in the fringe or display
572 margin, to set a breakpoint there.  If a breakpoint already exists on
573 that line, this action will remove it.
574 (@code{gdb-mouse-toggle-breakpoint}).
576   These commands interpret a numeric argument as a repeat count, when
577 that makes sense.
579   Because @key{TAB} serves as a completion command, you can't use it to
580 enter a tab as input to the program you are debugging with GDB.
581 Instead, type @kbd{C-q @key{TAB}} to enter a tab.
583 @node GUD Customization
584 @subsection GUD Customization
586 @vindex gdb-mode-hook
587 @vindex dbx-mode-hook
588 @vindex sdb-mode-hook
589 @vindex xdb-mode-hook
590 @vindex perldb-mode-hook
591 @vindex pdb-mode-hook
592 @vindex jdb-mode-hook
593   On startup, GUD runs one of the following hooks: @code{gdb-mode-hook},
594 if you are using GDB; @code{dbx-mode-hook}, if you are using DBX;
595 @code{sdb-mode-hook}, if you are using SDB; @code{xdb-mode-hook}, if you
596 are using XDB; @code{perldb-mode-hook}, for Perl debugging mode;
597 @code{pdb-mode-hook}, for PDB; @code{jdb-mode-hook}, for JDB.  You can
598 use these hooks to define custom key bindings for the debugger
599 interaction buffer.  @xref{Hooks}.
601   Here is a convenient way to define a command that sends a particular
602 command string to the debugger, and set up a key binding for it in the
603 debugger interaction buffer:
605 @findex gud-def
606 @example
607 (gud-def @var{function} @var{cmdstring} @var{binding} @var{docstring})
608 @end example
610   This defines a command named @var{function} which sends
611 @var{cmdstring} to the debugger process, and gives it the documentation
612 string @var{docstring}.  You can then use the command @var{function} in any
613 buffer.  If @var{binding} is non-@code{nil}, @code{gud-def} also binds
614 the command to @kbd{C-c @var{binding}} in the GUD buffer's mode and to
615 @kbd{C-x C-a @var{binding}} generally.
617   The command string @var{cmdstring} may contain certain
618 @samp{%}-sequences that stand for data to be filled in at the time
619 @var{function} is called:
621 @table @samp
622 @item %f
623 The name of the current source file.  If the current buffer is the GUD
624 buffer, then the ``current source file'' is the file that the program
625 stopped in.
626 @c This said, ``the name of the file the program counter was in at the last breakpoint.''
627 @c But I suspect it is really the last stop file.
629 @item %l
630 The number of the current source line.  If the current buffer is the GUD
631 buffer, then the ``current source line'' is the line that the program
632 stopped in.
634 @item %e
635 The text of the C lvalue or function-call expression at or adjacent to point.
637 @item %a
638 The text of the hexadecimal address at or adjacent to point.
640 @item %p
641 The numeric argument of the called function, as a decimal number.  If
642 the command is used without a numeric argument, @samp{%p} stands for the
643 empty string.
645 If you don't use @samp{%p} in the command string, the command you define
646 ignores any numeric argument.
647 @end table
649 @node GUD Tooltips
650 @subsection GUD Tooltips
652 @cindex tooltips with GUD
653 The Tooltip facility (@pxref{Tooltips}) provides support for GUD@.  If
654 GUD support is activated by customizing the @code{tooltip} group,
655 variable values can be displayed in tooltips by pointing at them with
656 the mouse in the GUD buffer or in source buffers with major modes in the
657 customizable list @code{tooltip-gud-modes}.
659 @node GDB Graphical Interface
660 @subsection GDB Graphical Interface
662 @findex gdba
663 The command @code{gdba} starts GDB using a graphical interface where
664 you view and control the program's data using Emacs windows.  You can
665 still interact with GDB through the GUD buffer, but the point of this
666 mode is that you can do it through menus and clicks, without needing
667 to know GDB commands.
669 @menu
670 * Layout::               Control the number of displayed buffers.
671 * Breakpoints Buffer::   A breakpoint control panel.
672 * Stack Buffer::         Select a frame from the call stack.
673 * Watch Expressions::    Monitor variable values in the speedbar.
674 * Other Buffers::        Input/output, locals, registers and assembler buffers.
675 @end menu
677 @node Layout
678 @subsubsection Layout
679 @cindex GDB User Interface layout
681 @findex gdb-many-windows
682 @vindex gdb-many-windows
684 If the variable @code{gdb-many-windows} is @code{nil} (the default
685 value) then gdb just pops up the GUD buffer unless the variable
686 @code{gdb-show-main} is non-@code{nil}.  In this case it starts with
687 two windows: one displaying the GUD buffer and the other with the
688 source file with the main routine of the inferior.
690 If @code{gdb-many-windows} is non-@code{nil}, regardless of the value of
691 @code{gdb-show-main}, the layout below will appear unless
692 @code{gdb-use-inferior-io-buffer} is @code{nil}.  In this case the
693 source buffer occupies the full width of the frame.
695 @multitable @columnfractions .5 .5
696 @item GUD buffer (I/O of GDB)
697 @tab Locals buffer
698 @item
699 @tab
700 @item Source buffer
701 @tab Input/Output (of inferior) buffer
702 @item
703 @tab
704 @item Stack buffer
705 @tab Breakpoints buffer
706 @end multitable
708 To toggle this layout, do @kbd{M-x gdb-many-windows}.
710 @findex gdb-restore-windows
711 If you change the window layout, for example, while editing and
712 re-compiling your program, then you can restore it with the command
713 @code{gdb-restore-windows}.
715 You may also choose which additional buffers you want to display,
716 either in the same frame or a different one.  Select GDB-windows or
717 GDB-Frames from the menu-bar under the heading GUD.  If the menu-bar
718 is unavailable, type @code{M-x
719 gdb-display-@var{buffertype}-buffer} or @code{M-x
720 gdb-frame-@var{buffertype}-buffer} respectively, where @var{buffertype}
721 is the relevant buffer type e.g breakpoints.
723 @node Breakpoints Buffer
724 @subsubsection Breakpoints Buffer
726 The breakpoints buffer shows the existing breakpoints and watchpoints
727 (@pxref{Breakpoints,,, gdb, The GNU debugger}).  It has three special
728 commands:
730 @table @kbd
731 @item @key{SPC}
732 @kindex SPC @r{(GDB breakpoints buffer)}
733 @findex gdb-toggle-breakpoint
734 Enable/disable the breakpoint at the current line
735 (@code{gdb-toggle-breakpoint}).  On a graphical display, this changes
736 the color of a bullet in the margin of the source buffer at the
737 relevant line.  This is red when the breakpoint is enabled and grey
738 when it is disabled.  Text-only terminals correspondingly display
739 a @samp{B} or @samp{b}.
741 @item @kbd{d}
742 @kindex d @r{(GDB breakpoints buffer)}
743 @findex gdb-delete-breakpoint
744 Delete the breakpoint at the current line (@code{gdb-delete-breakpoint}).
746 @item @key{RET}
747 @kindex RET @r{(GDB breakpoints buffer)}
748 @findex gdb-goto-breakpoint
749 Display the file in the source buffer at the breakpoint specified at
750 the current line (@code{gdb-goto-breakpoint}).  Alternatively, click @kbd{Mouse-2} on the breakpoint that you wish to visit.
751 @end table
753 @node Stack Buffer
754 @subsubsection Stack Buffer
756 The stack buffer displays a @dfn{call stack}, with one line for each
757 of the nested subroutine calls (@dfn{stack frames}) now active in the
758 program.  @xref{Backtrace,,info stack, gdb, The GNU debugger}.
760 Move point to any frame in the stack and type @key{RET} to make it
761 become the current frame (@code{gdb-frames-select}) and display the
762 associated source in the source buffer.  Alternatively, click
763 @kbd{Mouse-2} to make the selected frame become the current one.  If the
764 locals buffer is displayed then its contents update to display the
765 variables that are local to the new frame.
767 @node Watch Expressions
768 @subsubsection Watch Expressions
769 @cindex Watching expressions in GDB
771 If you want to see how a variable changes each time your program stops
772 then place the cursor over the variable name and click on the watch
773 icon in the toolbar (@code{gud-watch}).
775 Each watch expression is displayed in the speedbar.  Complex data
776 types, such as arrays, structures and unions are represented in a tree
777 format.  To expand or contract a complex data type, click @kbd{Mouse-2}
778 on the tag to the left of the expression.
780 @kindex RET @r{(GDB speedbar)}
781 @findex gdb-var-delete
782 With the cursor over the root expression of a complex data type, type
783 @kbd{D} to delete it from the speedbar
784 (@code{gdb-var-delete}).
786 @findex gdb-edit-value
787 With the cursor over a simple data type or an element of a complex
788 data type which holds a value, type @key{RET} or click @kbd{Mouse-2} to edit
789 its value.  A prompt for a new value appears in the mini-buffer
790 (@code{gdb-edit-value}).
792 If you set the variable @code{gdb-show-changed-values} to
793 non-@code{nil} (the default value), then Emacs will use
794 font-lock-warning-face to display values that have recently changed in
795 the speedbar.
797 If you set the variable @code{gdb-use-colon-colon-notation} to a
798 non-@code{nil} value, then, in C, Emacs will use the
799 FUNCTION::VARIABLE format to display variables in the speedbar.
800 Since this does not work for variables defined in compound statements,
801 the default value is @code{nil}.
803 @node Other Buffers
804 @subsubsection Other Buffers
806 @table @asis
807 @item Input/Output Buffer
808 If the variable @code{gdb-use-inferior-io-buffer} is non-@code{nil},
809 the executable program that is being debugged takes its input and
810 displays its output here.  Some of the commands from shell mode are
811 available here.  @xref{Shell Mode}.
813 @item Locals Buffer
814 The locals buffer displays the values of local variables of the
815 current frame for simple data types (@pxref{Frame Info,,, gdb, The GNU
816 debugger}).
818 Arrays and structures display their type only.  You must display them
819 separately to examine their values.  @ref{Watch Expressions}.
821 @item Registers Buffer
822 The registers buffer displays the values held by the registers
823 (@pxref{Registers,,, gdb, The GNU debugger}).
825 @item Assembler Buffer
826 The assembler buffer displays the current frame as machine code.  An
827 overlay arrow points to the current instruction and you can set and
828 remove breakpoints as with the source buffer.  Breakpoints also
829 appear in the margin.
831 @item Threads Buffer
833 The threads buffer displays a summary of all threads currently in your
834 program.(@pxref{Threads,,, gdb, The GNU debugger}).  Move point to
835 any thread in the list and type @key{RET} to make it become the
836 current thread (@code{gdb-threads-select}) and display the associated
837 source in the source buffer.  Alternatively, click @kbd{Mouse-2} to
838 make the selected thread become the current one.
840 @end table
842 @node Executing Lisp
843 @section Executing Lisp Expressions
845   Emacs has several different major modes for Lisp and Scheme.  They are
846 the same in terms of editing commands, but differ in the commands for
847 executing Lisp expressions.  Each mode has its own purpose.
849 @table @asis
850 @item Emacs-Lisp mode
851 The mode for editing source files of programs to run in Emacs Lisp.
852 This mode defines @kbd{C-M-x} to evaluate the current defun.
853 @xref{Lisp Libraries}.
854 @item Lisp Interaction mode
855 The mode for an interactive session with Emacs Lisp.  It defines
856 @kbd{C-j} to evaluate the sexp before point and insert its value in the
857 buffer.  @xref{Lisp Interaction}.
858 @item Lisp mode
859 The mode for editing source files of programs that run in Lisps other
860 than Emacs Lisp.  This mode defines @kbd{C-M-x} to send the current defun
861 to an inferior Lisp process.  @xref{External Lisp}.
862 @item Inferior Lisp mode
863 The mode for an interactive session with an inferior Lisp process.
864 This mode combines the special features of Lisp mode and Shell mode
865 (@pxref{Shell Mode}).
866 @item Scheme mode
867 Like Lisp mode but for Scheme programs.
868 @item Inferior Scheme mode
869 The mode for an interactive session with an inferior Scheme process.
870 @end table
872   Most editing commands for working with Lisp programs are in fact
873 available globally.  @xref{Programs}.
875 @node Lisp Libraries
876 @section Libraries of Lisp Code for Emacs
877 @cindex libraries
878 @cindex loading Lisp code
880   Lisp code for Emacs editing commands is stored in files whose names
881 conventionally end in @file{.el}.  This ending tells Emacs to edit them in
882 Emacs-Lisp mode (@pxref{Executing Lisp}).
884 @findex load-file
885   To execute a file of Emacs Lisp code, use @kbd{M-x load-file}.  This
886 command reads a file name using the minibuffer and then executes the
887 contents of that file as Lisp code.  It is not necessary to visit the
888 file first; in any case, this command reads the file as found on disk,
889 not text in an Emacs buffer.
891 @findex load
892 @findex load-library
893   Once a file of Lisp code is installed in the Emacs Lisp library
894 directories, users can load it using @kbd{M-x load-library}.  Programs can
895 load it by calling @code{load-library}, or with @code{load}, a more primitive
896 function that is similar but accepts some additional arguments.
898   @kbd{M-x load-library} differs from @kbd{M-x load-file} in that it
899 searches a sequence of directories and tries three file names in each
900 directory.  Suppose your argument is @var{lib}; the three names are
901 @file{@var{lib}.elc}, @file{@var{lib}.el}, and lastly just
902 @file{@var{lib}}.  If @file{@var{lib}.elc} exists, it is by convention
903 the result of compiling @file{@var{lib}.el}; it is better to load the
904 compiled file, since it will load and run faster.
906   If @code{load-library} finds that @file{@var{lib}.el} is newer than
907 @file{@var{lib}.elc} file, it issues a warning, because it's likely that
908 somebody made changes to the @file{.el} file and forgot to recompile
911   Because the argument to @code{load-library} is usually not in itself
912 a valid file name, file name completion is not available.  Indeed, when
913 using this command, you usually do not know exactly what file name
914 will be used.
916 @vindex load-path
917   The sequence of directories searched by @kbd{M-x load-library} is
918 specified by the variable @code{load-path}, a list of strings that are
919 directory names.  The default value of the list contains the directory where
920 the Lisp code for Emacs itself is stored.  If you have libraries of
921 your own, put them in a single directory and add that directory
922 to @code{load-path}.  @code{nil} in this list stands for the current default
923 directory, but it is probably not a good idea to put @code{nil} in the
924 list.  If you find yourself wishing that @code{nil} were in the list,
925 most likely what you really want to do is use @kbd{M-x load-file}
926 this once.
928 @cindex autoload
929   Often you do not have to give any command to load a library, because
930 the commands defined in the library are set up to @dfn{autoload} that
931 library.  Trying to run any of those commands calls @code{load} to load
932 the library; this replaces the autoload definitions with the real ones
933 from the library.
935 @cindex byte code
936   Emacs Lisp code can be compiled into byte-code which loads faster,
937 takes up less space when loaded, and executes faster.  @xref{Byte
938 Compilation,, Byte Compilation, elisp, the Emacs Lisp Reference Manual}.
939 By convention, the compiled code for a library goes in a separate file
940 whose name consists of the library source file with @samp{c} appended.
941 Thus, the compiled code for @file{foo.el} goes in @file{foo.elc}.
942 That's why @code{load-library} searches for @samp{.elc} files first.
944 @vindex load-dangerous-libraries
945 @cindex Lisp files byte-compiled by XEmacs
946   By default, Emacs refuses to load compiled Lisp files which were
947 compiled with XEmacs, a modified versions of Emacs---they can cause
948 Emacs to crash.  Set the variable @code{load-dangerous-libraries} to
949 @code{t} if you want to try loading them.
951 @node Lisp Eval
952 @section Evaluating Emacs-Lisp Expressions
953 @cindex Emacs-Lisp mode
954 @cindex mode, Emacs-Lisp
956 @findex emacs-lisp-mode
957   Lisp programs intended to be run in Emacs should be edited in
958 Emacs-Lisp mode; this happens automatically for file names ending in
959 @file{.el}.  By contrast, Lisp mode itself is used for editing Lisp
960 programs intended for other Lisp systems.  To switch to Emacs-Lisp mode
961 explicitly, use the command @kbd{M-x emacs-lisp-mode}.
963   For testing of Lisp programs to run in Emacs, it is often useful to
964 evaluate part of the program as it is found in the Emacs buffer.  For
965 example, after changing the text of a Lisp function definition,
966 evaluating the definition installs the change for future calls to the
967 function.  Evaluation of Lisp expressions is also useful in any kind of
968 editing, for invoking noninteractive functions (functions that are
969 not commands).
971 @table @kbd
972 @item M-:
973 Read a single Lisp expression in the minibuffer, evaluate it, and print
974 the value in the echo area (@code{eval-expression}).
975 @item C-x C-e
976 Evaluate the Lisp expression before point, and print the value in the
977 echo area (@code{eval-last-sexp}).
978 @item C-M-x
979 Evaluate the defun containing or after point, and print the value in
980 the echo area (@code{eval-defun}).
981 @item M-x eval-region
982 Evaluate all the Lisp expressions in the region.
983 @item M-x eval-current-buffer
984 Evaluate all the Lisp expressions in the buffer.
985 @end table
987 @ifinfo
988 @c This uses ``colon'' instead of a literal `:' because Info cannot
989 @c cope with a `:' in a menu
990 @kindex M-@key{colon}
991 @end ifinfo
992 @ifnotinfo
993 @kindex M-:
994 @end ifnotinfo
995 @findex eval-expression
996   @kbd{M-:} (@code{eval-expression}) is the most basic command for evaluating
997 a Lisp expression interactively.  It reads the expression using the
998 minibuffer, so you can execute any expression on a buffer regardless of
999 what the buffer contains.  When the expression is evaluated, the current
1000 buffer is once again the buffer that was current when @kbd{M-:} was
1001 typed.
1003 @kindex C-M-x @r{(Emacs-Lisp mode)}
1004 @findex eval-defun
1005   In Emacs-Lisp mode, the key @kbd{C-M-x} is bound to the command
1006 @code{eval-defun}, which parses the defun containing or following point
1007 as a Lisp expression and evaluates it.  The value is printed in the echo
1008 area.  This command is convenient for installing in the Lisp environment
1009 changes that you have just made in the text of a function definition.
1011   @kbd{C-M-x} treats @code{defvar} expressions specially.  Normally,
1012 evaluating a @code{defvar} expression does nothing if the variable it
1013 defines already has a value.  But @kbd{C-M-x} unconditionally resets the
1014 variable to the initial value specified in the @code{defvar} expression.
1015 @code{defcustom} expressions are treated similarly.
1016 This special feature is convenient for debugging Lisp programs.
1017 Typing @kbd{C-M-x} on a @code{defface} expression reinitializes
1018 the face according to the @code{defface} specification.
1020 @kindex C-x C-e
1021 @findex eval-last-sexp
1022   The command @kbd{C-x C-e} (@code{eval-last-sexp}) evaluates the Lisp
1023 expression preceding point in the buffer, and displays the value in the
1024 echo area.  It is available in all major modes, not just Emacs-Lisp
1025 mode.  It does not treat @code{defvar} specially.
1027   If @kbd{C-M-x}, @kbd{C-x C-e}, or @kbd{M-:} is given a numeric
1028 argument, it inserts the value into the current buffer at point, rather
1029 than displaying it in the echo area.  The argument's value does not
1030 matter.
1032 @findex eval-region
1033 @findex eval-current-buffer
1034   The most general command for evaluating Lisp expressions from a buffer
1035 is @code{eval-region}.  @kbd{M-x eval-region} parses the text of the
1036 region as one or more Lisp expressions, evaluating them one by one.
1037 @kbd{M-x eval-current-buffer} is similar but evaluates the entire
1038 buffer.  This is a reasonable way to install the contents of a file of
1039 Lisp code that you are ready to test.  Later, as you find bugs and
1040 change individual functions, use @kbd{C-M-x} on each function that you
1041 change.  This keeps the Lisp world in step with the source file.
1043 @vindex eval-expression-print-level
1044 @vindex eval-expression-print-length
1045 @vindex eval-expression-debug-on-error
1046 The customizable variables @code{eval-expression-print-level} and
1047 @code{eval-expression-print-length} control the maximum depth and length
1048 of lists to print in the result of the evaluation commands before
1049 abbreviating them.  @code{eval-expression-debug-on-error} controls
1050 whether evaluation errors invoke the debugger when these commands are
1051 used.
1053 @node Lisp Interaction
1054 @section Lisp Interaction Buffers
1056   The buffer @samp{*scratch*} which is selected when Emacs starts up is
1057 provided for evaluating Lisp expressions interactively inside Emacs.
1059   The simplest way to use the @samp{*scratch*} buffer is to insert Lisp
1060 expressions and type @kbd{C-j} after each expression.  This command
1061 reads the Lisp expression before point, evaluates it, and inserts the
1062 value in printed representation before point.  The result is a complete
1063 typescript of the expressions you have evaluated and their values.
1065   The @samp{*scratch*} buffer's major mode is Lisp Interaction mode, which
1066 is the same as Emacs-Lisp mode except for the binding of @kbd{C-j}.
1068 @findex lisp-interaction-mode
1069   The rationale for this feature is that Emacs must have a buffer when
1070 it starts up, but that buffer is not useful for editing files since a
1071 new buffer is made for every file that you visit.  The Lisp interpreter
1072 typescript is the most useful thing I can think of for the initial
1073 buffer to do.  Type @kbd{M-x lisp-interaction-mode} to put the current
1074 buffer in Lisp Interaction mode.
1076 @findex ielm
1077   An alternative way of evaluating Emacs Lisp expressions interactively
1078 is to use Inferior Emacs-Lisp mode, which provides an interface rather
1079 like Shell mode (@pxref{Shell Mode}) for evaluating Emacs Lisp
1080 expressions.  Type @kbd{M-x ielm} to create an @samp{*ielm*} buffer
1081 which uses this mode.
1083 @node External Lisp
1084 @section Running an External Lisp
1086   Emacs has facilities for running programs in other Lisp systems.  You can
1087 run a Lisp process as an inferior of Emacs, and pass expressions to it to
1088 be evaluated.  You can also pass changed function definitions directly from
1089 the Emacs buffers in which you edit the Lisp programs to the inferior Lisp
1090 process.
1092 @findex run-lisp
1093 @vindex inferior-lisp-program
1094 @kindex C-x C-z
1095   To run an inferior Lisp process, type @kbd{M-x run-lisp}.  This runs
1096 the program named @code{lisp}, the same program you would run by typing
1097 @code{lisp} as a shell command, with both input and output going through
1098 an Emacs buffer named @samp{*lisp*}.  That is to say, any ``terminal
1099 output'' from Lisp will go into the buffer, advancing point, and any
1100 ``terminal input'' for Lisp comes from text in the buffer.  (You can
1101 change the name of the Lisp executable file by setting the variable
1102 @code{inferior-lisp-program}.)
1104   To give input to Lisp, go to the end of the buffer and type the input,
1105 terminated by @key{RET}.  The @samp{*lisp*} buffer is in Inferior Lisp
1106 mode, which combines the special characteristics of Lisp mode with most
1107 of the features of Shell mode (@pxref{Shell Mode}).  The definition of
1108 @key{RET} to send a line to a subprocess is one of the features of Shell
1109 mode.
1111 @findex lisp-mode
1112   For the source files of programs to run in external Lisps, use Lisp
1113 mode.  This mode can be selected with @kbd{M-x lisp-mode}, and is used
1114 automatically for files whose names end in @file{.l}, @file{.lsp}, or
1115 @file{.lisp}, as most Lisp systems usually expect.
1117 @kindex C-M-x @r{(Lisp mode)}
1118 @findex lisp-eval-defun
1119   When you edit a function in a Lisp program you are running, the easiest
1120 way to send the changed definition to the inferior Lisp process is the key
1121 @kbd{C-M-x}.  In Lisp mode, this runs the function @code{lisp-eval-defun},
1122 which finds the defun around or following point and sends it as input to
1123 the Lisp process.  (Emacs can send input to any inferior process regardless
1124 of what buffer is current.)
1126   Contrast the meanings of @kbd{C-M-x} in Lisp mode (for editing programs
1127 to be run in another Lisp system) and Emacs-Lisp mode (for editing Lisp
1128 programs to be run in Emacs): in both modes it has the effect of installing
1129 the function definition that point is in, but the way of doing so is
1130 different according to where the relevant Lisp environment is found.
1131 @xref{Executing Lisp}.
1133 @ignore
1134    arch-tag: 9c3c2f71-b332-4144-8500-3ff9945a50ed
1135 @end ignore