*** empty log message ***
[emacs.git] / man / building.texi
blob239a5b5a43c060addd352615ad56478d3e02777d
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000 Free Software Foundation, Inc.
3 @c See file emacs.texi for copying conditions.
4 @node Building, Abbrevs, 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 * Interaction: Lisp Interaction.  Executing Lisp in an Emacs buffer.
27 * Eval: Lisp Eval.      Executing a single Lisp expression in Emacs.
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 to
46 @samp{*compilation*} buffer.
47 @item M-x grep
48 Run @code{grep} asynchronously under Emacs, with matching lines
49 listed in the buffer named @samp{*grep*}.
50 @item M-x grep-find
51 Run @code{grep} via @code{find}, with user-specified arguments, and
52 collect output in the buffer named @samp{*grep*}.
53 @item M-x kill-compilation
54 @itemx M-x kill-grep
55 Kill the running compilation or @code{grep} subprocess.
56 @end table
58 @findex compile
59   To run @code{make} or another compilation command, do @kbd{M-x
60 compile}.  This command reads a shell command line using the minibuffer,
61 and then executes the command in an inferior shell, putting output in
62 the buffer named @samp{*compilation*}.  The current buffer's default
63 directory is used as the working directory for the execution of the
64 command; normally, therefore, the compilation happens in this
65 directory.
67 @vindex compile-command
68   When the shell command line is read, the minibuffer appears containing
69 a default command line, which is the command you used the last time you
70 did @kbd{M-x compile}.  If you type just @key{RET}, the same command
71 line is used again.  For the first @kbd{M-x compile}, the default is
72 @samp{make -k}.  The default compilation command comes from the variable
73 @code{compile-command}; if the appropriate compilation command for a
74 file is something other than @samp{make -k}, it can be useful for the
75 file to specify a local value for @code{compile-command} (@pxref{File
76 Variables}).
78   Starting a compilation displays the buffer @samp{*compilation*} in
79 another window but does not select it.  The buffer's mode line tells you
80 whether compilation is finished, with the word @samp{run} or @samp{exit}
81 inside the parentheses.  You do not have to keep this buffer visible;
82 compilation continues in any case.  While a compilation is going on, the
83 string @samp{Compiling} appears in the mode lines of all windows.  When
84 this string disappears, the compilation is finished.
86   If you want to watch the compilation transcript as it appears, switch
87 to the @samp{*compilation*} buffer and move point to the end of the
88 buffer.  When point is at the end, new compilation output is inserted
89 above point, which remains at the end.  If point is not at the end of
90 the buffer, it remains fixed while more compilation output is added at
91 the end of the buffer.
93 @cindex compilation buffer, keeping current position at the end
94 @vindex compilation-scroll-output
95   If you set the variable @code{compilation-scroll-output} to a
96 non-@code{nil} value, then the compilation buffer always scrolls to
97 follow output as it comes in.
99 @findex kill-compilation
100   To kill the compilation process, do @kbd{M-x kill-compilation}.  When
101 the compiler process terminates, the mode line of the
102 @samp{*compilation*} buffer changes to say @samp{signal} instead of
103 @samp{run}.  Starting a new compilation also kills any running
104 compilation, as only one can exist at any time.  However, @kbd{M-x
105 compile} asks for confirmation before actually killing a compilation
106 that is running.
108 @node Grep Searching
109 @section Searching with Grep under Emacs
111 @findex grep
112   Just as you can run a compiler from Emacs and then visit the lines
113 where there were compilation errors, you can also run @code{grep} and
114 then visit the lines on which matches were found.  This works by
115 treating the matches reported by @code{grep} as if they were ``errors.''
117   To do this, type @kbd{M-x grep}, then enter a command line that
118 specifies how to run @code{grep}.  Use the same arguments you would give
119 @code{grep} when running it normally: a @code{grep}-style regexp
120 (usually in single-quotes to quote the shell's special characters)
121 followed by file names, which may use wildcards.  The output from
122 @code{grep} goes in the @samp{*grep*} buffer.  You can find the
123 corresponding lines in the original files using @kbd{C-x `} and
124 @key{RET}, as with compilation errors.
126   If you specify a prefix argument for @kbd{M-x grep}, it figures out
127 the tag (@pxref{Tags}) around point, and puts that into the default
128 @code{grep} command.
130 @findex grep-find
131   The command @kbd{M-x grep-find} is similar to @kbd{M-x grep}, but it
132 supplies a different initial default for the command---one that runs
133 both @code{find} and @code{grep}, so as to search every file in a
134 directory tree.  See also the @code{find-grep-dired} command,
135 in @ref{Dired and Find}.
137 @node Compilation Mode
138 @section Compilation Mode
140 @findex compile-goto-error
141 @cindex Compilation mode
142 @cindex mode, Compilation
143   The @samp{*compilation*} buffer uses a special major mode, Compilation
144 mode, whose main feature is to provide a convenient way to look at the
145 source line where the error happened.
147   If you set the variable @code{compilation-scroll-output} to a
148 non-@code{nil} value, then the compilation buffer always scrolls to
149 follow output as it comes in.
151 @table @kbd
152 @item C-x `
153 Visit the locus of the next compiler error message or @code{grep} match.
154 @item @key{RET}
155 Visit the locus of the error message that point is on.
156 This command is used in the compilation buffer.
157 @item Mouse-2
158 Visit the locus of the error message that you click on.
159 @end table
161 @kindex C-x `
162 @findex next-error
163   You can visit the source for any particular error message by moving
164 point in @samp{*compilation*} to that error message and typing @key{RET}
165 (@code{compile-goto-error}).  Or click @kbd{Mouse-2} on the error message;
166 you need not switch to the @samp{*compilation*} buffer first.
168   To parse the compiler error messages sequentially, type @kbd{C-x `}
169 (@code{next-error}).  The character following the @kbd{C-x} is the
170 backquote or ``grave accent,'' not the single-quote.  This command is
171 available in all buffers, not just in @samp{*compilation*}; it displays
172 the next error message at the top of one window and source location of
173 the error in another window.
175   The first time @kbd{C-x `} is used after the start of a compilation,
176 it moves to the first error's location.  Subsequent uses of @kbd{C-x `}
177 advance down to subsequent errors.  If you visit a specific error
178 message with @key{RET} or @kbd{Mouse-2}, subsequent @kbd{C-x `}
179 commands advance from there.  When @kbd{C-x `} gets to the end of the
180 buffer and finds no more error messages to visit, it fails and signals
181 an Emacs error.
183   @kbd{C-u C-x `} starts scanning from the beginning of the compilation
184 buffer.  This is one way to process the same set of errors again.
186   Compilation mode also redefines the keys @key{SPC} and @key{DEL} to
187 scroll by screenfuls, and @kbd{M-n} and @kbd{M-p} to move to the next or
188 previous error message.  You can also use @kbd{M-@{} and @kbd{M-@}} to
189 move up or down to an error message for a different source file.
191   The features of Compilation mode are also available in a minor mode
192 called Compilation Minor mode.  This lets you parse error messages in
193 any buffer, not just a normal compilation output buffer.  Type @kbd{M-x
194 compilation-minor-mode} to enable the minor mode.  This defines the keys
195 @key{RET} and @kbd{Mouse-2}, as in the Compilation major mode.
197   Compilation minor mode works in any buffer, as long as the contents
198 are in a format that it understands.  In an Rlogin buffer (@pxref{Remote
199 Host}), Compilation minor mode automatically accesses remote source
200 files by FTP (@pxref{File Names}).
202 @node Compilation Shell
203 @section Subshells for Compilation
205   Emacs uses a shell to run the compilation command, but specifies
206 the option for a noninteractive shell.  This means, in particular, that
207 the shell should start with no prompt.  If you find your usual shell
208 prompt making an unsightly appearance in the @samp{*compilation*}
209 buffer, it means you have made a mistake in your shell's init file by
210 setting the prompt unconditionally.  (This init file's name may be
211 @file{.bashrc}, @file{.profile}, @file{.cshrc}, @file{.shrc}, or various
212 other things, depending on the shell you use.)  The shell init file
213 should set the prompt only if there already is a prompt.  In csh, here
214 is how to do it:
216 @example
217 if ($?prompt) set prompt = @dots{}
218 @end example
220 @noindent
221 And here's how to do it in bash:
223 @example
224 if [ "$@{PS1+set@}" = set ]
225 then PS1=@dots{}
227 @end example
229   There may well be other things that your shell's init file
230 ought to do only for an interactive shell.  You can use the same
231 method to conditionalize them.
233   The MS-DOS ``operating system'' does not support asynchronous
234 subprocesses; to work around this lack, @kbd{M-x compile} runs the
235 compilation command synchronously on MS-DOS.  As a consequence, you must
236 wait until the command finishes before you can do anything else in
237 Emacs.  @xref{MS-DOS}.
239 @node Debuggers
240 @section Running Debuggers Under Emacs
241 @cindex debuggers
242 @cindex GUD library
243 @cindex GDB
244 @cindex DBX
245 @cindex SDB
246 @cindex XDB
247 @cindex Perldb
248 @cindex JDB
249 @cindex PDB
251 @c Do you believe in GUD?
252 The GUD (Grand Unified Debugger) library provides an interface to
253 various symbolic debuggers from within Emacs.  We recommend the debugger
254 GDB, which is free software, but you can also run DBX, SDB or XDB if you
255 have them.  GUD can also serve as an interface to the Perl's debugging
256 mode, the Python debugger PDB, and to JDB, the Java Debugger.
258 @menu
259 * Starting GUD::        How to start a debugger subprocess.
260 * Debugger Operation::  Connection between the debugger and source buffers.
261 * Commands of GUD::     Key bindings for common commands.
262 * GUD Customization::   Defining your own commands for GUD.
263 * GUD Tooltips::        Showing variable values by pointing with the mouse.
264 @end menu
266 @node Starting GUD
267 @subsection Starting GUD
269   There are several commands for starting a debugger, each corresponding
270 to a particular debugger program.
272 @table @kbd
273 @item M-x gdb @key{RET} @var{file} @key{RET}
274 @findex gdb
275 Run GDB as a subprocess of Emacs.  This command creates a buffer for
276 input and output to GDB, and switches to it.  If a GDB buffer already
277 exists, it just switches to that buffer.
279 @item M-x dbx @key{RET} @var{file} @key{RET}
280 @findex dbx
281 Similar, but run DBX instead of GDB.
283 @item M-x xdb @key{RET} @var{file} @key{RET}
284 @findex xdb
285 @vindex gud-xdb-directories
286 Similar, but run XDB instead of GDB.  Use the variable
287 @code{gud-xdb-directories} to specify directories to search for source
288 files.
290 @item M-x sdb @key{RET} @var{file} @key{RET}
291 @findex sdb
292 Similar, but run SDB instead of GDB.
294   Some versions of SDB do not mention source file names in their
295 messages.  When you use them, you need to have a valid tags table
296 (@pxref{Tags}) in order for GUD to find functions in the source code.
297 If you have not visited a tags table or the tags table doesn't list one
298 of the functions, you get a message saying @samp{The sdb support
299 requires a valid tags table to work}.  If this happens, generate a valid
300 tags table in the working directory and try again.
302 @item M-x perldb @key{RET} @var{file} @key{RET}
303 @findex perldb
304 Run the Perl interpreter in debug mode to debug @var{file}, a Perl program.
306 @item M-x jdb @key{RET} @var{file} @key{RET}
307 @findex jdb
308 Run the Java debugger to debug @var{file}.
310 @item M-x pdb @key{RET} @var{file} @key{RET}
311 @findex pdb
312 Run the Python debugger to debug @var{file}.
313 @end table
315   Each of these commands takes one argument: a command line to invoke
316 the debugger.  In the simplest case, specify just the name of the
317 executable file you want to debug.  You may also use options that the
318 debugger supports.  However, shell wildcards and variables are not
319 allowed.  GUD assumes that the first argument not starting with a
320 @samp{-} is the executable file name.
322   Emacs can only run one debugger process at a time.
324 @node Debugger Operation
325 @subsection Debugger Operation
327   When you run a debugger with GUD, the debugger uses an Emacs buffer
328 for its ordinary input and output.  This is called the GUD buffer.  The
329 debugger displays the source files of the program by visiting them in
330 Emacs buffers.  An arrow (@samp{=>}) in one of these buffers indicates
331 the current execution line.@footnote{Under a window system the arrow is
332 displayed in the marginal area of the Emacs window.}  Moving point in
333 this buffer does not move the arrow.
335   You can start editing these source files at any time in the buffers
336 that were made to display them.  The arrow is not part of the file's
337 text; it appears only on the screen.  If you do modify a source file,
338 keep in mind that inserting or deleting lines will throw off the arrow's
339 positioning; GUD has no way of figuring out which line corresponded
340 before your changes to the line number in a debugger message.  Also,
341 you'll typically have to recompile and restart the program for your
342 changes to be reflected in the debugger's tables.
344   If you wish, you can control your debugger process entirely through the
345 debugger buffer, which uses a variant of Shell mode.  All the usual
346 commands for your debugger are available, and you can use the Shell mode
347 history commands to repeat them.  @xref{Shell Mode}.
349 @node Commands of GUD
350 @subsection Commands of GUD
352   The GUD interaction buffer uses a variant of Shell mode, so the
353 commands of Shell mode are available (@pxref{Shell Mode}).  GUD mode
354 also provides commands for setting and clearing breakpoints, for
355 selecting stack frames, and for stepping through the program.  These
356 commands are available both in the GUD buffer and globally, but with
357 different key bindings.
359   The breakpoint commands are usually used in source file buffers,
360 because that is the way to specify where to set or clear the breakpoint.
361 Here's the global command to set a breakpoint:
363 @table @kbd
364 @item C-x @key{SPC}
365 @kindex C-x SPC
366 Set a breakpoint on the source line that point is on.
367 @end table
369 @kindex C-x C-a @r{(GUD)}
370   Here are the other special commands provided by GUD.  The keys
371 starting with @kbd{C-c} are available only in the GUD interaction
372 buffer.  The key bindings that start with @kbd{C-x C-a} are available in
373 the GUD interaction buffer and also in source files.
375 @table @kbd
376 @item C-c C-l
377 @kindex C-c C-l @r{(GUD)}
378 @itemx C-x C-a C-l
379 @findex gud-refresh
380 Display in another window the last line referred to in the GUD
381 buffer (that is, the line indicated in the last location message).
382 This runs the command @code{gud-refresh}.
384 @item C-c C-s
385 @kindex C-c C-s @r{(GUD)}
386 @itemx C-x C-a C-s
387 @findex gud-step
388 Execute a single line of code (@code{gud-step}).  If the line contains
389 a function call, execution stops after entering the called function.
391 @item C-c C-n
392 @kindex C-c C-n @r{(GUD)}
393 @itemx C-x C-a C-n
394 @findex gud-next
395 Execute a single line of code, stepping across entire function calls
396 at full speed (@code{gud-next}).
398 @item C-c C-i
399 @kindex C-c C-i @r{(GUD)}
400 @itemx C-x C-a C-i
401 @findex gud-stepi
402 Execute a single machine instruction (@code{gud-stepi}).
404 @need 3000
405 @item C-c C-r
406 @kindex C-c C-r @r{(GUD)}
407 @itemx C-x C-a C-r
408 @findex gud-cont
409 Continue execution without specifying any stopping point.  The program
410 will run until it hits a breakpoint, terminates, or gets a signal that
411 the debugger is checking for (@code{gud-cont}).
413 @need 1000
414 @item C-c C-d
415 @kindex C-c C-d @r{(GUD)}
416 @itemx C-x C-a C-d
417 @findex gud-remove
418 Delete the breakpoint(s) on the current source line, if any
419 (@code{gud-remove}).  If you use this command in the GUD interaction
420 buffer, it applies to the line where the program last stopped.
422 @item C-c C-t
423 @kindex C-c C-t @r{(GUD)}
424 @itemx C-x C-a C-t
425 @findex gud-tbreak
426 Set a temporary breakpoint on the current source line, if any.
427 If you use this command in the GUD interaction buffer,
428 it applies to the line where the program last stopped.
429 @end table
431   The above commands are common to all supported debuggers.  If you are
432 using GDB or (some versions of) DBX, these additional commands are available:
434 @table @kbd
435 @item C-c <
436 @kindex C-c < @r{(GUD)}
437 @itemx C-x C-a <
438 @findex gud-up
439 Select the next enclosing stack frame (@code{gud-up}).  This is
440 equivalent to the @samp{up} command.
442 @item C-c >
443 @kindex C-c > @r{(GUD)}
444 @itemx C-x C-a >
445 @findex gud-down
446 Select the next inner stack frame (@code{gud-down}).  This is
447 equivalent to the @samp{down} command.
448 @end table
450   If you are using GDB, these additional key bindings are available:
452 @table @kbd
453 @item @key{TAB}
454 @kindex TAB @r{(GUD)}
455 @findex gud-gdb-complete-command
456 With GDB, complete a symbol name (@code{gud-gdb-complete-command}).
457 This key is available only in the GUD interaction buffer, and requires
458 GDB versions 4.13 and later.
460 @item C-c C-f
461 @kindex C-c C-f @r{(GUD)}
462 @itemx C-x C-a C-f
463 @findex gud-finish
464 Run the program until the selected stack frame returns (or until it
465 stops for some other reason).
466 @end table
468   These commands interpret a numeric argument as a repeat count, when
469 that makes sense.
471   Because @key{TAB} serves as a completion command, you can't use it to
472 enter a tab as input to the program you are debugging with GDB.
473 Instead, type @kbd{C-q @key{TAB}} to enter a tab.
475 @node GUD Customization
476 @subsection GUD Customization
478 @vindex gdb-mode-hook
479 @vindex dbx-mode-hook
480 @vindex sdb-mode-hook
481 @vindex xdb-mode-hook
482 @vindex perldb-mode-hook
483 @vindex pdb-mode-hook
484 @vindex jdb-mode-hook
485   On startup, GUD runs one of the following hooks: @code{gdb-mode-hook},
486 if you are using GDB; @code{dbx-mode-hook}, if you are using DBX;
487 @code{sdb-mode-hook}, if you are using SDB; @code{xdb-mode-hook}, if you
488 are using XDB; @code{perldb-mode-hook}, for Perl debugging mode;
489 @code{jdb-mode-hook}, for PDB; @code{jdb-mode-hook}, for JDB.  You can
490 use these hooks to define custom key bindings for the debugger
491 interaction buffer.  @xref{Hooks}.
493   Here is a convenient way to define a command that sends a particular
494 command string to the debugger, and set up a key binding for it in the
495 debugger interaction buffer:
497 @findex gud-def
498 @example
499 (gud-def @var{function} @var{cmdstring} @var{binding} @var{docstring})
500 @end example
502   This defines a command named @var{function} which sends
503 @var{cmdstring} to the debugger process, and gives it the documentation
504 string @var{docstring}.  You can use the command thus defined in any
505 buffer.  If @var{binding} is non-@code{nil}, @code{gud-def} also binds
506 the command to @kbd{C-c @var{binding}} in the GUD buffer's mode and to
507 @kbd{C-x C-a @var{binding}} generally.
509   The command string @var{cmdstring} may contain certain
510 @samp{%}-sequences that stand for data to be filled in at the time
511 @var{function} is called:
513 @table @samp
514 @item %f
515 The name of the current source file.  If the current buffer is the GUD
516 buffer, then the ``current source file'' is the file that the program
517 stopped in.
518 @c This said, ``the name of the file the program counter was in at the last breakpoint.''
519 @c But I suspect it is really the last stop file.
521 @item %l
522 The number of the current source line.  If the current buffer is the GUD
523 buffer, then the ``current source line'' is the line that the program
524 stopped in.
526 @item %e
527 The text of the C lvalue or function-call expression at or adjacent to point.
529 @item %a
530 The text of the hexadecimal address at or adjacent to point.
532 @item %p
533 The numeric argument of the called function, as a decimal number.  If
534 the command is used without a numeric argument, @samp{%p} stands for the
535 empty string.
537 If you don't use @samp{%p} in the command string, the command you define
538 ignores any numeric argument.
539 @end table
541 @node GUD Tooltips
542 @subsection GUD Tooltips
544 @cindex tooltips with GUD
545 The Tooltip facility (@pxref{Tooltips}) provides support for GUD@.  If
546 GUD support is activated by customizing the @code{tooltip} group,
547 variable values can be displayed in tooltips by pointing at them with
548 the mouse in the GUD buffer or in source buffers with major modes in the
549 customizable list @code{tooltip-gud-modes}.
551 @node Executing Lisp
552 @section Executing Lisp Expressions
554   Emacs has several different major modes for Lisp and Scheme.  They are
555 the same in terms of editing commands, but differ in the commands for
556 executing Lisp expressions.  Each mode has its own purpose.
558 @table @asis
559 @item Emacs-Lisp mode
560 The mode for editing source files of programs to run in Emacs Lisp.
561 This mode defines @kbd{C-M-x} to evaluate the current defun.
562 @xref{Lisp Libraries}.
563 @item Lisp Interaction mode
564 The mode for an interactive session with Emacs Lisp.  It defines
565 @kbd{C-j} to evaluate the sexp before point and insert its value in the
566 buffer.  @xref{Lisp Interaction}.
567 @item Lisp mode
568 The mode for editing source files of programs that run in Lisps other
569 than Emacs Lisp.  This mode defines @kbd{C-M-x} to send the current defun
570 to an inferior Lisp process.  @xref{External Lisp}.
571 @item Inferior Lisp mode
572 The mode for an interactive session with an inferior Lisp process.
573 This mode combines the special features of Lisp mode and Shell mode
574 (@pxref{Shell Mode}).
575 @item Scheme mode
576 Like Lisp mode but for Scheme programs.
577 @item Inferior Scheme mode
578 The mode for an interactive session with an inferior Scheme process.
579 @end table
581   Most editing commands for working with Lisp programs are in fact
582 available globally.  @xref{Programs}.
584 @node Lisp Libraries
585 @section Libraries of Lisp Code for Emacs
586 @cindex libraries
587 @cindex loading Lisp code
589   Lisp code for Emacs editing commands is stored in files whose names
590 conventionally end in @file{.el}.  This ending tells Emacs to edit them in
591 Emacs-Lisp mode (@pxref{Executing Lisp}).
593 @findex load-file
594   To execute a file of Emacs Lisp code, use @kbd{M-x load-file}.  This
595 command reads a file name using the minibuffer and then executes the
596 contents of that file as Lisp code.  It is not necessary to visit the
597 file first; in any case, this command reads the file as found on disk,
598 not text in an Emacs buffer.
600 @findex load
601 @findex load-library
602   Once a file of Lisp code is installed in the Emacs Lisp library
603 directories, users can load it using @kbd{M-x load-library}.  Programs can
604 load it by calling @code{load-library}, or with @code{load}, a more primitive
605 function that is similar but accepts some additional arguments.
607   @kbd{M-x load-library} differs from @kbd{M-x load-file} in that it
608 searches a sequence of directories and tries three file names in each
609 directory.  Suppose your argument is @var{lib}; the three names are
610 @file{@var{lib}.elc}, @file{@var{lib}.el}, and lastly just
611 @file{@var{lib}}.  If @file{@var{lib}.elc} exists, it is by convention
612 the result of compiling @file{@var{lib}.el}; it is better to load the
613 compiled file, since it will load and run faster.
615   If @code{load-library} finds that @file{@var{lib}.el} is newer than
616 @file{@var{lib}.elc} file, it prints a warning, because it's likely that
617 somebody made changes to the @file{.el} file and forgot to recompile
620   Because the argument to @code{load-library} is usually not in itself
621 a valid file name, file name completion is not available.  Indeed, when
622 using this command, you usually do not know exactly what file name
623 will be used.
625 @vindex load-path
626   The sequence of directories searched by @kbd{M-x load-library} is
627 specified by the variable @code{load-path}, a list of strings that are
628 directory names.  The default value of the list contains the directory where
629 the Lisp code for Emacs itself is stored.  If you have libraries of
630 your own, put them in a single directory and add that directory
631 to @code{load-path}.  @code{nil} in this list stands for the current default
632 directory, but it is probably not a good idea to put @code{nil} in the
633 list.  If you find yourself wishing that @code{nil} were in the list,
634 most likely what you really want to do is use @kbd{M-x load-file}
635 this once.
637 @cindex autoload
638   Often you do not have to give any command to load a library, because
639 the commands defined in the library are set up to @dfn{autoload} that
640 library.  Trying to run any of those commands calls @code{load} to load
641 the library; this replaces the autoload definitions with the real ones
642 from the library.
644 @cindex byte code
645   Emacs Lisp code can be compiled into byte-code which loads faster,
646 takes up less space when loaded, and executes faster.  @xref{Byte
647 Compilation,, Byte Compilation, elisp, the Emacs Lisp Reference Manual}.
648 By convention, the compiled code for a library goes in a separate file
649 whose name consists of the library source file with @samp{c} appended.
650 Thus, the compiled code for @file{foo.el} goes in @file{foo.elc}.
651 That's why @code{load-library} searches for @samp{.elc} files first.
653 @vindex load-dangerous-libraries
654 @cindex Lisp files byte-compiled by XEmacs
655   By default, Emacs refuses to load compiled Lisp files which were
656 compiled with XEmacs, a modified versions of Emacs---they can cause
657 Emacs to crash.  Set the variable @code{load-dangerous-libraries} to
658 @code{t} if you want to try loading them.
660 @node Lisp Eval
661 @section Evaluating Emacs-Lisp Expressions
662 @cindex Emacs-Lisp mode
663 @cindex mode, Emacs-Lisp
665 @findex emacs-lisp-mode
666   Lisp programs intended to be run in Emacs should be edited in
667 Emacs-Lisp mode; this happens automatically for file names ending in
668 @file{.el}.  By contrast, Lisp mode itself is used for editing Lisp
669 programs intended for other Lisp systems.  To switch to Emacs-Lisp mode
670 explicitly, use the command @kbd{M-x emacs-lisp-mode}.
672   For testing of Lisp programs to run in Emacs, it is often useful to
673 evaluate part of the program as it is found in the Emacs buffer.  For
674 example, after changing the text of a Lisp function definition,
675 evaluating the definition installs the change for future calls to the
676 function.  Evaluation of Lisp expressions is also useful in any kind of
677 editing, for invoking noninteractive functions (functions that are
678 not commands).
680 @table @kbd
681 @item M-:
682 Read a single Lisp expression in the minibuffer, evaluate it, and print
683 the value in the echo area (@code{eval-expression}).
684 @item C-x C-e
685 Evaluate the Lisp expression before point, and print the value in the
686 echo area (@code{eval-last-sexp}).
687 @item C-M-x
688 Evaluate the defun containing or after point, and print the value in
689 the echo area (@code{eval-defun}).
690 @item M-x eval-region
691 Evaluate all the Lisp expressions in the region.
692 @item M-x eval-current-buffer
693 Evaluate all the Lisp expressions in the buffer.
694 @end table
696 @kindex M-:
697 @findex eval-expression
698   @kbd{M-:} (@code{eval-expression}) is the most basic command for evaluating
699 a Lisp expression interactively.  It reads the expression using the
700 minibuffer, so you can execute any expression on a buffer regardless of
701 what the buffer contains.  When the expression is evaluated, the current
702 buffer is once again the buffer that was current when @kbd{M-:} was
703 typed.
705 @kindex C-M-x @r{(Emacs-Lisp mode)}
706 @findex eval-defun
707   In Emacs-Lisp mode, the key @kbd{C-M-x} is bound to the command
708 @code{eval-defun}, which parses the defun containing or following point
709 as a Lisp expression and evaluates it.  The value is printed in the echo
710 area.  This command is convenient for installing in the Lisp environment
711 changes that you have just made in the text of a function definition.
713   @kbd{C-M-x} treats @code{defvar} expressions specially.  Normally,
714 evaluating a @code{defvar} expression does nothing if the variable it
715 defines already has a value.  But @kbd{C-M-x} unconditionally resets the
716 variable to the initial value specified in the @code{defvar} expression.
717 @code{defcustom} expressions are treated similarly.
718 This special feature is convenient for debugging Lisp programs.
720 @kindex C-x C-e
721 @findex eval-last-sexp
722   The command @kbd{C-x C-e} (@code{eval-last-sexp}) evaluates the Lisp
723 expression preceding point in the buffer, and displays the value in the
724 echo area.  It is available in all major modes, not just Emacs-Lisp
725 mode.  It does not treat @code{defvar} specially.
727   If @kbd{C-M-x}, @kbd{C-x C-e}, or @kbd{M-:} is given a numeric
728 argument, it inserts the value into the current buffer at point, rather
729 than displaying it in the echo area.  The argument's value does not
730 matter.
732 @findex eval-region
733 @findex eval-current-buffer
734   The most general command for evaluating Lisp expressions from a buffer
735 is @code{eval-region}.  @kbd{M-x eval-region} parses the text of the
736 region as one or more Lisp expressions, evaluating them one by one.
737 @kbd{M-x eval-current-buffer} is similar but evaluates the entire
738 buffer.  This is a reasonable way to install the contents of a file of
739 Lisp code that you are just ready to test.  Later, as you find bugs and
740 change individual functions, use @kbd{C-M-x} on each function that you
741 change.  This keeps the Lisp world in step with the source file.
743 @vindex eval-expression-print-level
744 @vindex eval-expression-print-length
745 @vindex eval-expression-debug-on-error
746 The customizable variables @code{eval-expression-print-level} and
747 @code{eval-expression-print-length} control the maximum depth and length
748 of lists to print in the result of the evaluation commands before
749 abbreviating them.  @code{eval-expression-debug-on-error} controls
750 whether evaluation errors invoke the debugger when these commands are
751 used.
753 @node Lisp Interaction
754 @section Lisp Interaction Buffers
756   The buffer @samp{*scratch*} which is selected when Emacs starts up is
757 provided for evaluating Lisp expressions interactively inside Emacs.
759   The simplest way to use the @samp{*scratch*} buffer is to insert Lisp
760 expressions and type @kbd{C-j} after each expression.  This command
761 reads the Lisp expression before point, evaluates it, and inserts the
762 value in printed representation before point.  The result is a complete
763 typescript of the expressions you have evaluated and their values.
765   The @samp{*scratch*} buffer's major mode is Lisp Interaction mode, which
766 is the same as Emacs-Lisp mode except for the binding of @kbd{C-j}.
768 @findex lisp-interaction-mode
769   The rationale for this feature is that Emacs must have a buffer when
770 it starts up, but that buffer is not useful for editing files since a
771 new buffer is made for every file that you visit.  The Lisp interpreter
772 typescript is the most useful thing I can think of for the initial
773 buffer to do.  Type @kbd{M-x lisp-interaction-mode} to put the current
774 buffer in Lisp Interaction mode.
776 @findex ielm
777   An alternative way of evaluating Emacs Lisp expressions interactively
778 is to use Inferior Emacs-Lisp mode, which provides an interface rather
779 like Shell mode (@pxref{Shell Mode}) for evaluating Emacs Lisp
780 expressions.  Type @kbd{M-x ielm} to create an @samp{*ielm*} buffer
781 which uses this mode.
783 @node External Lisp
784 @section Running an External Lisp
786   Emacs has facilities for running programs in other Lisp systems.  You can
787 run a Lisp process as an inferior of Emacs, and pass expressions to it to
788 be evaluated.  You can also pass changed function definitions directly from
789 the Emacs buffers in which you edit the Lisp programs to the inferior Lisp
790 process.
792 @findex run-lisp
793 @vindex inferior-lisp-program
794 @kindex C-x C-z
795   To run an inferior Lisp process, type @kbd{M-x run-lisp}.  This runs
796 the program named @code{lisp}, the same program you would run by typing
797 @code{lisp} as a shell command, with both input and output going through
798 an Emacs buffer named @samp{*lisp*}.  That is to say, any ``terminal
799 output'' from Lisp will go into the buffer, advancing point, and any
800 ``terminal input'' for Lisp comes from text in the buffer.  (You can
801 change the name of the Lisp executable file by setting the variable
802 @code{inferior-lisp-program}.)
804   To give input to Lisp, go to the end of the buffer and type the input,
805 terminated by @key{RET}.  The @samp{*lisp*} buffer is in Inferior Lisp
806 mode, which combines the special characteristics of Lisp mode with most
807 of the features of Shell mode (@pxref{Shell Mode}).  The definition of
808 @key{RET} to send a line to a subprocess is one of the features of Shell
809 mode.
811 @findex lisp-mode
812   For the source files of programs to run in external Lisps, use Lisp
813 mode.  This mode can be selected with @kbd{M-x lisp-mode}, and is used
814 automatically for files whose names end in @file{.l}, @file{.lsp}, or
815 @file{.lisp}, as most Lisp systems usually expect.
817 @kindex C-M-x @r{(Lisp mode)}
818 @findex lisp-eval-defun
819   When you edit a function in a Lisp program you are running, the easiest
820 way to send the changed definition to the inferior Lisp process is the key
821 @kbd{C-M-x}.  In Lisp mode, this runs the function @code{lisp-eval-defun},
822 which finds the defun around or following point and sends it as input to
823 the Lisp process.  (Emacs can send input to any inferior process regardless
824 of what buffer is current.)
826   Contrast the meanings of @kbd{C-M-x} in Lisp mode (for editing programs
827 to be run in another Lisp system) and Emacs-Lisp mode (for editing Lisp
828 programs to be run in Emacs): in both modes it has the effect of installing
829 the function definition that point is in, but the way of doing so is
830 different according to where the relevant Lisp environment is found.
831 @xref{Executing Lisp}.