annotate man/building.texi @ 71822:7b7a32c8c767

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