Mercurial > emacs
annotate man/building.texi @ 72143:c72f78a4a1c1
*** empty log message ***
author | Nick Roberts <nickrob@snap.net.nz> |
---|---|
date | Thu, 27 Jul 2006 12:17:38 +0000 |
parents | 88ec0239376a |
children | 423408615aaa 8a8e69664178 |
rev | line source |
---|---|
25829 | 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 | 4 @c See file emacs.texi for copying conditions. |
38202 | 5 @node Building, Maintaining, Programs, Top |
25829 | 6 @chapter Compiling and Testing Programs |
7 @cindex building programs | |
8 @cindex program building | |
9 @cindex running Lisp functions | |
10 | |
11 The previous chapter discusses the Emacs commands that are useful for | |
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 | 14 |
15 @menu | |
16 * Compilation:: Compiling programs in languages other | |
17 than Lisp (C, Pascal, etc.). | |
18 * Compilation Mode:: The mode for visiting compiler errors. | |
19 * Compilation Shell:: Customizing your shell properly | |
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 | 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 | 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 | 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 | 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 | 31 @end menu |
32 | |
33 @node Compilation | |
34 @section Running Compilations under Emacs | |
35 @cindex inferior process | |
36 @cindex make | |
37 @cindex compilation errors | |
38 @cindex error log | |
39 | |
40 Emacs can run compilers for noninteractive languages such as C and | |
41 Fortran as inferior processes, feeding the error log into an Emacs buffer. | |
42 It can also parse the error messages and show you the source lines where | |
43 compilation errors occurred. | |
44 | |
45 @table @kbd | |
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 | 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 | 54 @end table |
55 | |
56 @findex compile | |
57 To run @code{make} or another compilation command, do @kbd{M-x | |
58 compile}. This command reads a shell command line using the minibuffer, | |
59 and then executes the command in an inferior shell, putting output in | |
60 the buffer named @samp{*compilation*}. The current buffer's default | |
61 directory is used as the working directory for the execution of the | |
62 command; normally, therefore, the compilation happens in this | |
63 directory. | |
64 | |
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 | 76 |
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 | 85 |
86 If you want to watch the compilation transcript as it appears, switch | |
87 to the @samp{*compilation*} buffer and move point to the end of the | |
88 buffer. When point is at the end, new compilation output is inserted | |
89 above point, which remains at the end. If point is not at the end of | |
90 the buffer, it remains fixed while more compilation output is added at | |
91 the end of the buffer. | |
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 | 94 @vindex compilation-scroll-output |
95 If you set the variable @code{compilation-scroll-output} to a | |
96 non-@code{nil} value, then the compilation buffer always scrolls to | |
97 follow output as it comes in. | |
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 | 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 | 154 @node Compilation Mode |
155 @section Compilation Mode | |
156 | |
157 @cindex Compilation mode | |
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 | 165 |
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 | 174 @item @key{RET} |
175 Visit the locus of the error message that point is on. | |
176 This command is used in the compilation buffer. | |
177 @item Mouse-2 | |
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 | 194 @end table |
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 | 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 | 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 | 208 To parse the compiler error messages sequentially, type @kbd{C-x `} |
209 (@code{next-error}). The character following the @kbd{C-x} is the | |
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 | 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 | 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 | 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 | 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 | 279 |
280 The features of Compilation mode are also available in a minor mode | |
281 called Compilation Minor mode. This lets you parse error messages in | |
282 any buffer, not just a normal compilation output buffer. Type @kbd{M-x | |
283 compilation-minor-mode} to enable the minor mode. This defines the keys | |
284 @key{RET} and @kbd{Mouse-2}, as in the Compilation major mode. | |
285 | |
286 Compilation minor mode works in any buffer, as long as the contents | |
287 are in a format that it understands. In an Rlogin buffer (@pxref{Remote | |
288 Host}), Compilation minor mode automatically accesses remote source | |
289 files by FTP (@pxref{File Names}). | |
290 | |
291 @node Compilation Shell | |
292 @section Subshells for Compilation | |
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 | 296 the shell should start with no prompt. If you find your usual shell |
297 prompt making an unsightly appearance in the @samp{*compilation*} | |
298 buffer, it means you have made a mistake in your shell's init file by | |
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 | 304 |
305 @example | |
306 if [ "$@{PS1+set@}" = set ] | |
307 then PS1=@dots{} | |
308 fi | |
309 @end example | |
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 | 318 There may well be other things that your shell's init file |
319 ought to do only for an interactive shell. You can use the same | |
320 method to conditionalize them. | |
321 | |
322 The MS-DOS ``operating system'' does not support asynchronous | |
323 subprocesses; to work around this lack, @kbd{M-x compile} runs the | |
324 compilation command synchronously on MS-DOS. As a consequence, you must | |
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 | 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 |
71943
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
362 specify a prefix argument for @kbd{M-x grep}, it finds the tag |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
363 (@pxref{Tags}) in the buffer around point, and puts that into the |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
364 default @code{grep} command. |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
365 |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
366 Your command need not simply run @code{grep}; you can use any shell |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
367 command that produces output in the same format. For instance, you |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
368 can chain @code{grep} commands, like this: |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
369 |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
370 @example |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
371 grep -nH -e foo *.el | grep bar | grep toto |
88ec0239376a
(Grep Searching): Explain about chaining grep commands.
Richard M. Stallman <rms@gnu.org>
parents:
71627
diff
changeset
|
372 @end example |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
373 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
374 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
|
375 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
|
376 `}}, @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
|
377 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
378 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
|
379 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
|
380 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
|
381 @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
|
382 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
|
383 |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
384 @findex grep-find |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
385 @findex find-grep |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
386 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
|
387 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
|
388 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
|
389 @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
|
390 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
|
391 |
70262
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
392 @findex lgrep |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
393 @findex rgrep |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
394 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
|
395 (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
|
396 @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
|
397 to match, the files to search, and the base directory for the search |
70485 | 398 (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
|
399 current value of @code{case-fold-search}. |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
400 |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
401 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
|
402 @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
|
403 (for @code{rgrep}). |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
404 |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
405 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
|
406 @code{grep-files-aliases}. |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
407 |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
408 Subdirectories listed in the variable |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
409 @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
|
410 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
|
411 skipped by @code{rgrep}. |
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
412 |
61050 | 413 @node Flymake |
414 @section Finding Syntax Errors On The Fly | |
415 @cindex checking syntax | |
416 | |
417 Flymake mode is a minor mode that performs on-the-fly syntax | |
418 checking for many programming and markup languages, including C, C++, | |
419 Perl, HTML, and @TeX{}/La@TeX{}. It is somewhat analogous to Flyspell | |
420 mode, which performs spell checking for ordinary human languages in a | |
421 similar fashion (@pxref{Spelling}). As you edit a file, Flymake mode | |
422 runs an appropriate syntax checking tool in the background, using a | |
423 temporary copy of the buffer. It then parses the error and warning | |
424 messages, and highlights the erroneous lines in the buffer. The | |
425 syntax checking tool used depends on the language; for example, for | |
426 C/C++ files this is usually the C compiler. Flymake can also use | |
427 build tools such as @code{make} for checking complicated projects. | |
428 | |
429 To activate Flymake mode, type @kbd{M-x flymake-mode}. You can move | |
430 to the errors spotted by Flymake mode with @kbd{M-x | |
431 flymake-goto-next-error} and @kbd{M-x flymake-goto-prev-error}. To | |
432 display any error messages associated with the current line, use | |
433 @kbd{M-x flymake-display-err-menu-for-current-line}. | |
434 | |
435 For more details about using Flymake, see @ref{Top, Flymake, | |
436 Flymake, flymake, The Flymake Manual}. | |
437 | |
25829 | 438 @node Debuggers |
439 @section Running Debuggers Under Emacs | |
440 @cindex debuggers | |
441 @cindex GUD library | |
442 @cindex GDB | |
443 @cindex DBX | |
444 @cindex SDB | |
445 @cindex XDB | |
446 @cindex Perldb | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
447 @cindex bashdb |
25829 | 448 @cindex JDB |
449 @cindex PDB | |
450 | |
451 @c Do you believe in GUD? | |
452 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
|
453 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
|
454 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
|
455 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
|
456 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
|
457 @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
|
458 Manual}, for information on debugging Emacs Lisp programs. |
25829 | 459 |
460 @menu | |
461 * Starting GUD:: How to start a debugger subprocess. | |
462 * Debugger Operation:: Connection between the debugger and source buffers. | |
463 * Commands of GUD:: Key bindings for common commands. | |
464 * 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
|
465 * 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
|
466 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
|
467 Emacs. |
25829 | 468 @end menu |
469 | |
470 @node Starting GUD | |
471 @subsection Starting GUD | |
472 | |
473 There are several commands for starting a debugger, each corresponding | |
474 to a particular debugger program. | |
475 | |
476 @table @kbd | |
477 @item M-x gdb @key{RET} @var{file} @key{RET} | |
478 @findex gdb | |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
479 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
|
480 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
|
481 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
|
482 |
25829 | 483 @item M-x dbx @key{RET} @var{file} @key{RET} |
484 @findex dbx | |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
485 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
|
486 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
|
487 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
|
488 the other supported debuggers. |
25829 | 489 |
490 @item M-x xdb @key{RET} @var{file} @key{RET} | |
491 @findex xdb | |
492 @vindex gud-xdb-directories | |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
493 Similar, but run XDB. Use the variable |
25829 | 494 @code{gud-xdb-directories} to specify directories to search for source |
495 files. | |
496 | |
497 @item M-x sdb @key{RET} @var{file} @key{RET} | |
498 @findex sdb | |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
499 Similar, but run SDB. |
25829 | 500 |
501 Some versions of SDB do not mention source file names in their | |
502 messages. When you use them, you need to have a valid tags table | |
503 (@pxref{Tags}) in order for GUD to find functions in the source code. | |
504 If you have not visited a tags table or the tags table doesn't list one | |
505 of the functions, you get a message saying @samp{The sdb support | |
506 requires a valid tags table to work}. If this happens, generate a valid | |
507 tags table in the working directory and try again. | |
508 | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
509 @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
|
510 @findex bashdb |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
511 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
|
512 |
25829 | 513 @item M-x perldb @key{RET} @var{file} @key{RET} |
514 @findex perldb | |
515 Run the Perl interpreter in debug mode to debug @var{file}, a Perl program. | |
516 | |
517 @item M-x jdb @key{RET} @var{file} @key{RET} | |
518 @findex jdb | |
519 Run the Java debugger to debug @var{file}. | |
520 | |
521 @item M-x pdb @key{RET} @var{file} @key{RET} | |
522 @findex pdb | |
523 Run the Python debugger to debug @var{file}. | |
524 @end table | |
525 | |
526 Each of these commands takes one argument: a command line to invoke | |
527 the debugger. In the simplest case, specify just the name of the | |
528 executable file you want to debug. You may also use options that the | |
529 debugger supports. However, shell wildcards and variables are not | |
530 allowed. GUD assumes that the first argument not starting with a | |
531 @samp{-} is the executable file name. | |
532 | |
533 @node Debugger Operation | |
534 @subsection Debugger Operation | |
535 | |
42904
0e87fd2f82b4
(Debugger Operation): Add index entries for fringe usage.
Eli Zaretskii <eliz@gnu.org>
parents:
39820
diff
changeset
|
536 @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
|
537 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
|
538 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
|
539 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
|
540 debugging also use this buffer. |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
541 |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
542 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
|
543 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
|
544 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
|
545 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
|
546 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
|
547 of the file's text; it appears only on the screen. |
25829 | 548 |
549 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
|
550 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
|
551 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
|
552 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
|
553 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
|
554 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
|
555 to be reflected in the debugger's tables. |
25829 | 556 |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
557 @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
|
558 @vindex tooltip-gud-modes |
62171
83608278e922
(Debugger Operation): Describe gud-tooltip-echo-area.
Nick Roberts <nickrob@snap.net.nz>
parents:
62143
diff
changeset
|
559 @vindex gud-tooltip-mode |
83608278e922
(Debugger Operation): Describe gud-tooltip-echo-area.
Nick Roberts <nickrob@snap.net.nz>
parents:
62143
diff
changeset
|
560 @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
|
561 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
|
562 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
|
563 @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
|
564 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
|
565 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
|
566 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
|
567 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
|
568 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
|
569 @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
|
570 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
|
571 |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
572 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
|
573 (@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
|
574 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
|
575 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
|
576 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
|
577 effects. |
62405
39bedd779f48
(Debugger Operation): Mention GUD tooltips are disabled with GDB in text
Nick Roberts <nickrob@snap.net.nz>
parents:
62384
diff
changeset
|
578 |
25829 | 579 @node Commands of GUD |
580 @subsection Commands of GUD | |
581 | |
582 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
|
583 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
|
584 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
|
585 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
|
586 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
|
587 |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
588 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
|
589 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
|
590 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
|
591 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
|
592 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
|
593 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
|
594 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
|
595 keep the GUD buffer hidden. |
25829 | 596 |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38202
diff
changeset
|
597 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
|
598 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
|
599 breakpoint. Here's the global command to set a breakpoint: |
25829 | 600 |
601 @table @kbd | |
602 @item C-x @key{SPC} | |
603 @kindex C-x SPC | |
604 Set a breakpoint on the source line that point is on. | |
605 @end table | |
606 | |
607 @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
|
608 Here are the other special commands provided by GUD@. The keys |
25829 | 609 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
|
610 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
|
611 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
|
612 commands are not available to all the supported debuggers. |
25829 | 613 |
614 @table @kbd | |
615 @item C-c C-l | |
616 @kindex C-c C-l @r{(GUD)} | |
617 @itemx C-x C-a C-l | |
618 @findex gud-refresh | |
619 Display in another window the last line referred to in the GUD | |
620 buffer (that is, the line indicated in the last location message). | |
621 This runs the command @code{gud-refresh}. | |
622 | |
623 @item C-c C-s | |
624 @kindex C-c C-s @r{(GUD)} | |
625 @itemx C-x C-a C-s | |
626 @findex gud-step | |
627 Execute a single line of code (@code{gud-step}). If the line contains | |
628 a function call, execution stops after entering the called function. | |
629 | |
630 @item C-c C-n | |
631 @kindex C-c C-n @r{(GUD)} | |
632 @itemx C-x C-a C-n | |
633 @findex gud-next | |
634 Execute a single line of code, stepping across entire function calls | |
635 at full speed (@code{gud-next}). | |
636 | |
637 @item C-c C-i | |
638 @kindex C-c C-i @r{(GUD)} | |
639 @itemx C-x C-a C-i | |
640 @findex gud-stepi | |
641 Execute a single machine instruction (@code{gud-stepi}). | |
642 | |
71223
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
643 @item C-c C-p |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
644 @kindex C-c C-p @r{(GUD)} |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
645 @itemx C-x C-a C-p |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
646 @findex gud-print |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
647 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
|
648 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
|
649 first. |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
650 |
25829 | 651 @need 3000 |
652 @item C-c C-r | |
653 @kindex C-c C-r @r{(GUD)} | |
654 @itemx C-x C-a C-r | |
655 @findex gud-cont | |
656 Continue execution without specifying any stopping point. The program | |
657 will run until it hits a breakpoint, terminates, or gets a signal that | |
658 the debugger is checking for (@code{gud-cont}). | |
659 | |
660 @need 1000 | |
661 @item C-c C-d | |
662 @kindex C-c C-d @r{(GUD)} | |
663 @itemx C-x C-a C-d | |
664 @findex gud-remove | |
665 Delete the breakpoint(s) on the current source line, if any | |
666 (@code{gud-remove}). If you use this command in the GUD interaction | |
667 buffer, it applies to the line where the program last stopped. | |
668 | |
669 @item C-c C-t | |
670 @kindex C-c C-t @r{(GUD)} | |
671 @itemx C-x C-a C-t | |
672 @findex gud-tbreak | |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
673 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
|
674 (@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
|
675 buffer, it applies to the line where the program last stopped. |
25829 | 676 |
677 @item C-c < | |
678 @kindex C-c < @r{(GUD)} | |
679 @itemx C-x C-a < | |
680 @findex gud-up | |
681 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
|
682 equivalent to the GDB command @samp{up}. |
25829 | 683 |
684 @item C-c > | |
685 @kindex C-c > @r{(GUD)} | |
686 @itemx C-x C-a > | |
687 @findex gud-down | |
688 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
|
689 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
|
690 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
691 @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
|
692 @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
|
693 @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
|
694 @findex gud-until |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
695 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
|
696 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
|
697 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
|
698 cursor currently sits. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
699 |
25829 | 700 @item C-c C-f |
701 @kindex C-c C-f @r{(GUD)} | |
702 @itemx C-x C-a C-f | |
703 @findex gud-finish | |
70262
5d647f9d823b
(Grep Searching): Add lgrep and rgrep.
Kim F. Storm <storm@cua.dk>
parents:
70056
diff
changeset
|
704 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
|
705 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
|
706 @end table |
43137
bc055bf06a94
(Commands of GUD): Add gud-jump.
Richard M. Stallman <rms@gnu.org>
parents:
42913
diff
changeset
|
707 |
71223
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
708 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
|
709 |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
710 @table @kbd |
46238
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
711 @item C-x C-a C-j |
f5ac68c7cc15
Clarify gud-jump description.
Richard M. Stallman <rms@gnu.org>
parents:
44116
diff
changeset
|
712 @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
|
713 @findex gud-jump |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
714 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
|
715 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
|
716 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
|
717 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
|
718 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
|
719 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
|
720 details. |
71223
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
721 |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
722 @item @key{TAB} |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
723 @kindex TAB @r{(GUD)} |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
724 @findex gud-gdb-complete-command |
31d9cfc257a4
(GDB Graphical Interface): Update bindings.
Nick Roberts <nickrob@snap.net.nz>
parents:
70630
diff
changeset
|
725 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
|
726 This key is available only in the GUD interaction buffer. |
25829 | 727 @end table |
728 | |
729 These commands interpret a numeric argument as a repeat count, when | |
730 that makes sense. | |
731 | |
732 Because @key{TAB} serves as a completion command, you can't use it to | |
733 enter a tab as input to the program you are debugging with GDB. | |
734 Instead, type @kbd{C-q @key{TAB}} to enter a tab. | |
735 | |
736 @node GUD Customization | |
737 @subsection GUD Customization | |
738 | |
739 @vindex gdb-mode-hook | |
740 @vindex dbx-mode-hook | |
741 @vindex sdb-mode-hook | |
742 @vindex xdb-mode-hook | |
743 @vindex perldb-mode-hook | |
744 @vindex pdb-mode-hook | |
745 @vindex jdb-mode-hook | |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
746 @vindex bashdb-mode-hook |
25829 | 747 On startup, GUD runs one of the following hooks: @code{gdb-mode-hook}, |
748 if you are using GDB; @code{dbx-mode-hook}, if you are using DBX; | |
749 @code{sdb-mode-hook}, if you are using SDB; @code{xdb-mode-hook}, if you | |
750 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
|
751 @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
|
752 @code{bashdb-mode-hook}, for the Bash debugger. You can |
25829 | 753 use these hooks to define custom key bindings for the debugger |
754 interaction buffer. @xref{Hooks}. | |
755 | |
756 Here is a convenient way to define a command that sends a particular | |
757 command string to the debugger, and set up a key binding for it in the | |
758 debugger interaction buffer: | |
759 | |
760 @findex gud-def | |
761 @example | |
762 (gud-def @var{function} @var{cmdstring} @var{binding} @var{docstring}) | |
763 @end example | |
764 | |
765 This defines a command named @var{function} which sends | |
766 @var{cmdstring} to the debugger process, and gives it the documentation | |
38743 | 767 string @var{docstring}. You can then use the command @var{function} in any |
25829 | 768 buffer. If @var{binding} is non-@code{nil}, @code{gud-def} also binds |
769 the command to @kbd{C-c @var{binding}} in the GUD buffer's mode and to | |
770 @kbd{C-x C-a @var{binding}} generally. | |
771 | |
772 The command string @var{cmdstring} may contain certain | |
773 @samp{%}-sequences that stand for data to be filled in at the time | |
774 @var{function} is called: | |
775 | |
776 @table @samp | |
777 @item %f | |
778 The name of the current source file. If the current buffer is the GUD | |
779 buffer, then the ``current source file'' is the file that the program | |
780 stopped in. | |
781 | |
782 @item %l | |
783 The number of the current source line. If the current buffer is the GUD | |
784 buffer, then the ``current source line'' is the line that the program | |
785 stopped in. | |
786 | |
787 @item %e | |
70297
8b21f8434b0f
(GUD Customization): Describe cases %d and %c.
Nick Roberts <nickrob@snap.net.nz>
parents:
70262
diff
changeset
|
788 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
|
789 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
|
790 adjacent to point. |
25829 | 791 |
792 @item %a | |
793 The text of the hexadecimal address at or adjacent to point. | |
794 | |
795 @item %p | |
796 The numeric argument of the called function, as a decimal number. If | |
797 the command is used without a numeric argument, @samp{%p} stands for the | |
798 empty string. | |
799 | |
800 If you don't use @samp{%p} in the command string, the command you define | |
801 ignores any numeric argument. | |
70297
8b21f8434b0f
(GUD Customization): Describe cases %d and %c.
Nick Roberts <nickrob@snap.net.nz>
parents:
70262
diff
changeset
|
802 |
8b21f8434b0f
(GUD Customization): Describe cases %d and %c.
Nick Roberts <nickrob@snap.net.nz>
parents:
70262
diff
changeset
|
803 @item %d |
8b21f8434b0f
(GUD Customization): Describe cases %d and %c.
Nick Roberts <nickrob@snap.net.nz>
parents:
70262
diff
changeset
|
804 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
|
805 |
8b21f8434b0f
(GUD Customization): Describe cases %d and %c.
Nick Roberts <nickrob@snap.net.nz>
parents:
70262
diff
changeset
|
806 @item %c |
8b21f8434b0f
(GUD Customization): Describe cases %d and %c.
Nick Roberts <nickrob@snap.net.nz>
parents:
70262
diff
changeset
|
807 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
|
808 (jdb only). |
25829 | 809 @end table |
810 | |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
811 @node GDB Graphical Interface |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
812 @subsection GDB Graphical Interface |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
813 |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
814 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
|
815 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
|
816 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
|
817 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
|
818 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
|
819 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
|
820 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
|
821 |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
822 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
|
823 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
|
824 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
|
825 |
60440
c82b8f53ded0
(Starting GUD): Don't explain text vs graphical GDB here.
Richard M. Stallman <rms@gnu.org>
parents:
60278
diff
changeset
|
826 @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
|
827 @findex gdba |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
828 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
|
829 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
|
830 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
|
831 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
|
832 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
|
833 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
|
834 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
835 @menu |
65022
af2cce893ff5
(GDB Graphical Interface): Use better node names.
Nick Roberts <nickrob@snap.net.nz>
parents:
64949
diff
changeset
|
836 * 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
|
837 * Breakpoints Buffer:: A breakpoint control panel. |
af2cce893ff5
(GDB Graphical Interface): Use better node names.
Nick Roberts <nickrob@snap.net.nz>
parents:
64949
diff
changeset
|
838 * 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
|
839 * 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
|
840 assembler, threads and memory buffers. |
71253
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
841 * 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
|
842 control your program. |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
843 * 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
|
844 @end menu |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
845 |
65022
af2cce893ff5
(GDB Graphical Interface): Use better node names.
Nick Roberts <nickrob@snap.net.nz>
parents:
64949
diff
changeset
|
846 @node GDB User Interface Layout |
af2cce893ff5
(GDB Graphical Interface): Use better node names.
Nick Roberts <nickrob@snap.net.nz>
parents:
64949
diff
changeset
|
847 @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
|
848 @cindex GDB User Interface layout |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
849 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
850 @vindex gdb-many-windows |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
851 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
|
852 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
|
853 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
|
854 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
|
855 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
|
856 you are debugging. |
55577
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
857 |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
858 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
|
859 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
|
860 |
71593 | 861 @smallexample |
862 @group | |
65974
ef546abd2887
(GDB User Interface Layout): Improve diagram.
Nick Roberts <nickrob@snap.net.nz>
parents:
65881
diff
changeset
|
863 +--------------------------------+--------------------------------+ |
68904
2fb019baf00b
(GDB User Interface Layout): Don't say `inferior' for program being debugged.
Richard M. Stallman <rms@gnu.org>
parents:
68897
diff
changeset
|
864 | 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
|
865 |--------------------------------+--------------------------------+ |
68904
2fb019baf00b
(GDB User Interface Layout): Don't say `inferior' for program being debugged.
Richard M. Stallman <rms@gnu.org>
parents:
68897
diff
changeset
|
866 | 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
|
867 |--------------------------------+--------------------------------+ |
68904
2fb019baf00b
(GDB User Interface Layout): Don't say `inferior' for program being debugged.
Richard M. Stallman <rms@gnu.org>
parents:
68897
diff
changeset
|
868 | Stack buffer | Breakpoints buffer | |
65974
ef546abd2887
(GDB User Interface Layout): Improve diagram.
Nick Roberts <nickrob@snap.net.nz>
parents:
65881
diff
changeset
|
869 +--------------------------------+--------------------------------+ |
71593 | 870 @end group |
871 @end smallexample | |
55577
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
872 |
68897
32dec66a83cf
(GDB Graphical Interface): Replace
Nick Roberts <nickrob@snap.net.nz>
parents:
68824
diff
changeset
|
873 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
|
874 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
|
875 of the frame. |
55577
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
876 |
66ec9893d229
(GDB Graphical Interface): Update and describe layout first.
Nick Roberts <nickrob@snap.net.nz>
parents:
54131
diff
changeset
|
877 @findex gdb-restore-windows |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
878 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
|
879 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
|
880 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
|
881 |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
882 @findex gdb-many-windows |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
883 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
|
884 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
|
885 gdb-many-windows}. |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
886 |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
887 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
|
888 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
|
889 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
|
890 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
|
891 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
|
892 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
|
893 @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
|
894 @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
|
895 @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
|
896 |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
897 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
|
898 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
|
899 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
|
900 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
|
901 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
|
902 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
|
903 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
|
904 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
|
905 places. |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
906 |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
907 @node Breakpoints Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
908 @subsubsection Breakpoints Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
909 |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
910 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
|
911 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
|
912 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
|
913 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
|
914 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
915 @table @kbd |
56808
00b9078008ef
(Building): Interchange nodes (for correct numbering).
Luc Teirlinck <teirllm@auburn.edu>
parents:
56007
diff
changeset
|
916 @item @key{SPC} |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
917 @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
|
918 @findex gdb-toggle-breakpoint |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
919 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
|
920 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
|
921 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
|
922 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
|
923 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
|
924 |
67231
c0926bb237e2
(GDB User Interface Layout): Describe how to kill associated buffers.
Nick Roberts <nickrob@snap.net.nz>
parents:
67074
diff
changeset
|
925 @item D |
c0926bb237e2
(GDB User Interface Layout): Describe how to kill associated buffers.
Nick Roberts <nickrob@snap.net.nz>
parents:
67074
diff
changeset
|
926 @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
|
927 @findex gdb-delete-breakpoint |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
928 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
|
929 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
930 @item @key{RET} |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
931 @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
|
932 @findex gdb-goto-breakpoint |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
933 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
|
934 (@code{gdb-goto-breakpoint}). |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
935 |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
936 @item Mouse-2 |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
937 @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
|
938 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
|
939 @end table |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
940 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
941 @node Stack Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
942 @subsubsection Stack Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
943 |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
944 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
|
945 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
|
946 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
|
947 |
65881
6d77eb5953d0
(GDB Graphical Interface): Add variables and
Nick Roberts <nickrob@snap.net.nz>
parents:
65024
diff
changeset
|
948 @findex gdb-frames-select |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
949 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
|
950 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
|
951 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
|
952 @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
|
953 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
|
954 the new frame. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
955 |
65022
af2cce893ff5
(GDB Graphical Interface): Use better node names.
Nick Roberts <nickrob@snap.net.nz>
parents:
64949
diff
changeset
|
956 @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
|
957 @subsubsection Other Buffers |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
958 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
959 @table @asis |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
960 @item Input/Output Buffer |
68897
32dec66a83cf
(GDB Graphical Interface): Replace
Nick Roberts <nickrob@snap.net.nz>
parents:
68824
diff
changeset
|
961 @vindex gdb-use-separate-io-buffer |
32dec66a83cf
(GDB Graphical Interface): Replace
Nick Roberts <nickrob@snap.net.nz>
parents:
68824
diff
changeset
|
962 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
|
963 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
|
964 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
|
965 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
|
966 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
|
967 restart the program you are debugging. |
66584
9600fc8cfb65
(Other GDB User Interface Buffers): Describe
Nick Roberts <nickrob@snap.net.nz>
parents:
66567
diff
changeset
|
968 |
68821
7e3f2f8237f6
(Other GDB User Interface Buffers): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
68686
diff
changeset
|
969 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
|
970 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
|
971 @xref{Shell Mode}. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
972 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
973 @item Locals Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
974 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
|
975 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
|
976 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
|
977 |
67366
de2840a4a2d9
(GDB Graphical Interface): Explain screen size setting.
Nick Roberts <nickrob@snap.net.nz>
parents:
67231
diff
changeset
|
978 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
|
979 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
|
980 @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
|
981 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
|
982 (@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
|
983 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
984 @item Registers Buffer |
65881
6d77eb5953d0
(GDB Graphical Interface): Add variables and
Nick Roberts <nickrob@snap.net.nz>
parents:
65024
diff
changeset
|
985 @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
|
986 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
|
987 (@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
|
988 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
|
989 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
|
990 @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
|
991 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
|
992 (@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
|
993 |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
994 @item Assembler Buffer |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
995 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
|
996 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
|
997 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
|
998 the fringe or margin. |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
999 |
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
1000 @item Threads Buffer |
65881
6d77eb5953d0
(GDB Graphical Interface): Add variables and
Nick Roberts <nickrob@snap.net.nz>
parents:
65024
diff
changeset
|
1001 @findex gdb-threads-select |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
1002 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
|
1003 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
|
1004 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
|
1005 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
|
1006 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
|
1007 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
|
1008 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
|
1009 in the new thread. |
53254
cc4a96fa8f08
(Watch Expressions): Update.
Nick Roberts <nickrob@snap.net.nz>
parents:
52907
diff
changeset
|
1010 |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
1011 @item Memory Buffer |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
1012 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
|
1013 (@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
|
1014 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
|
1015 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
|
1016 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
|
1017 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
|
1018 @end table |
59825
c20149ca0bba
Update documentation relating to GDB Graphical
Nick Roberts <nickrob@snap.net.nz>
parents:
59688
diff
changeset
|
1019 |
71253
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1020 @node GDB commands in the Fringe |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1021 @subsubsection GDB commands in the Fringe |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1022 @cindex GDB commands in the Fringe |
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 @c @findex gdb-mouse-set-clear-breakpoint |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1025 @c @findex gdb-mouse-toggle-breakpoint |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1026 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
|
1027 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
|
1028 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
|
1029 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
|
1030 source file already has a breakpoint. |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1031 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1032 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
|
1033 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
|
1034 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
|
1035 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
|
1036 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
|
1037 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1038 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
|
1039 (@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
|
1040 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
|
1041 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
|
1042 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
|
1043 (@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
|
1044 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
|
1045 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
|
1046 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
|
1047 execution in more detail. |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1048 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1049 @table @kbd |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1050 @item Mouse-1 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1051 Set or clear a breakpoint. |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1052 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1053 @item C-Mouse-1 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1054 Enable or disable a breakpoint. |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1055 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1056 @item Mouse-3 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1057 Continue execution to here. |
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 @item C-Mouse-3 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1060 Jump to here. |
51296
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
1061 @end table |
35bdcc98e5b1
(GDB Graphical Interface): New node (rewritten somewhat by RMS).
Richard M. Stallman <rms@gnu.org>
parents:
50475
diff
changeset
|
1062 |
71253
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1063 @node Watch Expressions |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1064 @subsubsection Watch Expressions |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1065 @cindex Watching expressions in GDB |
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 @findex gud-watch |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1068 @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
|
1069 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
|
1070 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
|
1071 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
|
1072 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
|
1073 minibuffer. |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1074 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1075 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
|
1076 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
|
1077 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
|
1078 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
|
1079 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
|
1080 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
|
1081 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
|
1082 in which they were defined. |
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 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
|
1085 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
|
1086 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1087 @kindex D @r{(GDB speedbar)} |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1088 @findex gdb-var-delete |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1089 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
|
1090 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
|
1091 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1092 @kindex RET @r{(GDB speedbar)} |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1093 @findex gdb-edit-value |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1094 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
|
1095 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
|
1096 (@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
|
1097 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
|
1098 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1099 @vindex gdb-show-changed-values |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1100 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
|
1101 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
|
1102 @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
|
1103 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
|
1104 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
|
1105 edit its value. |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1106 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1107 @vindex gdb-use-colon-colon-notation |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1108 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
|
1109 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
|
1110 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
|
1111 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
|
1112 |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1113 @vindex gdb-speedbar-auto-raise |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1114 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
|
1115 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
|
1116 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
|
1117 screen Emacs frame. |
72b7de925c8d
(Watch Expressions): Move node to end.
Nick Roberts <nickrob@snap.net.nz>
parents:
71223
diff
changeset
|
1118 |
25829 | 1119 @node Executing Lisp |
1120 @section Executing Lisp Expressions | |
1121 | |
1122 Emacs has several different major modes for Lisp and Scheme. They are | |
1123 the same in terms of editing commands, but differ in the commands for | |
1124 executing Lisp expressions. Each mode has its own purpose. | |
1125 | |
1126 @table @asis | |
1127 @item Emacs-Lisp mode | |
1128 The mode for editing source files of programs to run in Emacs Lisp. | |
1129 This mode defines @kbd{C-M-x} to evaluate the current defun. | |
1130 @xref{Lisp Libraries}. | |
1131 @item Lisp Interaction mode | |
1132 The mode for an interactive session with Emacs Lisp. It defines | |
1133 @kbd{C-j} to evaluate the sexp before point and insert its value in the | |
1134 buffer. @xref{Lisp Interaction}. | |
1135 @item Lisp mode | |
1136 The mode for editing source files of programs that run in Lisps other | |
1137 than Emacs Lisp. This mode defines @kbd{C-M-x} to send the current defun | |
1138 to an inferior Lisp process. @xref{External Lisp}. | |
1139 @item Inferior Lisp mode | |
1140 The mode for an interactive session with an inferior Lisp process. | |
1141 This mode combines the special features of Lisp mode and Shell mode | |
1142 (@pxref{Shell Mode}). | |
1143 @item Scheme mode | |
1144 Like Lisp mode but for Scheme programs. | |
1145 @item Inferior Scheme mode | |
1146 The mode for an interactive session with an inferior Scheme process. | |
1147 @end table | |
1148 | |
1149 Most editing commands for working with Lisp programs are in fact | |
1150 available globally. @xref{Programs}. | |
1151 | |
1152 @node Lisp Libraries | |
1153 @section Libraries of Lisp Code for Emacs | |
1154 @cindex libraries | |
1155 @cindex loading Lisp code | |
1156 | |
1157 Lisp code for Emacs editing commands is stored in files whose names | |
1158 conventionally end in @file{.el}. This ending tells Emacs to edit them in | |
1159 Emacs-Lisp mode (@pxref{Executing Lisp}). | |
1160 | |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
1161 @cindex byte code |
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
1162 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
|
1163 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
|
1164 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
|
1165 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
|
1166 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
|
1167 @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
|
1168 |
25829 | 1169 @findex load-file |
1170 To execute a file of Emacs Lisp code, use @kbd{M-x load-file}. This | |
1171 command reads a file name using the minibuffer and then executes the | |
1172 contents of that file as Lisp code. It is not necessary to visit the | |
1173 file first; in any case, this command reads the file as found on disk, | |
1174 not text in an Emacs buffer. | |
1175 | |
1176 @findex load | |
1177 @findex load-library | |
1178 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
|
1179 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
|
1180 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
|
1181 similar but accepts some additional arguments. |
25829 | 1182 |
1183 @kbd{M-x load-library} differs from @kbd{M-x load-file} in that it | |
1184 searches a sequence of directories and tries three file names in each | |
1185 directory. Suppose your argument is @var{lib}; the three names are | |
1186 @file{@var{lib}.elc}, @file{@var{lib}.el}, and lastly just | |
1187 @file{@var{lib}}. If @file{@var{lib}.elc} exists, it is by convention | |
1188 the result of compiling @file{@var{lib}.el}; it is better to load the | |
1189 compiled file, since it will load and run faster. | |
1190 | |
1191 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
|
1192 @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
|
1193 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
|
1194 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
|
1195 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
|
1196 recompile it until they think it is ready to use. |
25829 | 1197 |
1198 Because the argument to @code{load-library} is usually not in itself | |
1199 a valid file name, file name completion is not available. Indeed, when | |
1200 using this command, you usually do not know exactly what file name | |
1201 will be used. | |
1202 | |
1203 @vindex load-path | |
1204 The sequence of directories searched by @kbd{M-x load-library} is | |
1205 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
|
1206 directory names. The default value of the list contains the directories where |
25829 | 1207 the Lisp code for Emacs itself is stored. If you have libraries of |
1208 your own, put them in a single directory and add that directory | |
1209 to @code{load-path}. @code{nil} in this list stands for the current default | |
1210 directory, but it is probably not a good idea to put @code{nil} in the | |
1211 list. If you find yourself wishing that @code{nil} were in the list, | |
1212 most likely what you really want to do is use @kbd{M-x load-file} | |
1213 this once. | |
1214 | |
1215 @cindex autoload | |
1216 Often you do not have to give any command to load a library, because | |
1217 the commands defined in the library are set up to @dfn{autoload} that | |
1218 library. Trying to run any of those commands calls @code{load} to load | |
1219 the library; this replaces the autoload definitions with the real ones | |
1220 from the library. | |
1221 | |
31027
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
1222 @vindex load-dangerous-libraries |
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
1223 @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
|
1224 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
|
1225 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
|
1226 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
|
1227 @code{t} if you want to try loading them. |
31027
561ef681eab5
Document load-dangerous-libraries.
Eli Zaretskii <eliz@gnu.org>
parents:
28431
diff
changeset
|
1228 |
25829 | 1229 @node Lisp Eval |
58369
a54b2a5402d6
(Lisp Eval): Delete hyphen in section name.
Richard M. Stallman <rms@gnu.org>
parents:
57348
diff
changeset
|
1230 @section Evaluating Emacs Lisp Expressions |
25829 | 1231 @cindex Emacs-Lisp mode |
1232 @cindex mode, Emacs-Lisp | |
1233 | |
1234 @findex emacs-lisp-mode | |
1235 Lisp programs intended to be run in Emacs should be edited in | |
1236 Emacs-Lisp mode; this happens automatically for file names ending in | |
1237 @file{.el}. By contrast, Lisp mode itself is used for editing Lisp | |
1238 programs intended for other Lisp systems. To switch to Emacs-Lisp mode | |
1239 explicitly, use the command @kbd{M-x emacs-lisp-mode}. | |
1240 | |
1241 For testing of Lisp programs to run in Emacs, it is often useful to | |
1242 evaluate part of the program as it is found in the Emacs buffer. For | |
1243 example, after changing the text of a Lisp function definition, | |
1244 evaluating the definition installs the change for future calls to the | |
1245 function. Evaluation of Lisp expressions is also useful in any kind of | |
1246 editing, for invoking noninteractive functions (functions that are | |
1247 not commands). | |
1248 | |
1249 @table @kbd | |
1250 @item M-: | |
1251 Read a single Lisp expression in the minibuffer, evaluate it, and print | |
1252 the value in the echo area (@code{eval-expression}). | |
1253 @item C-x C-e | |
1254 Evaluate the Lisp expression before point, and print the value in the | |
1255 echo area (@code{eval-last-sexp}). | |
1256 @item C-M-x | |
1257 Evaluate the defun containing or after point, and print the value in | |
1258 the echo area (@code{eval-defun}). | |
1259 @item M-x eval-region | |
1260 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
|
1261 @item M-x eval-buffer |
25829 | 1262 Evaluate all the Lisp expressions in the buffer. |
1263 @end table | |
1264 | |
44116
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1265 @ifinfo |
43889
c5ea7e769ffd
(Electric C, Lisp Eval): Avoid makeinfo warnings about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents:
43151
diff
changeset
|
1266 @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
|
1267 @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
|
1268 @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
|
1269 @end ifinfo |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1270 @ifnotinfo |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1271 @kindex M-: |
1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
Eli Zaretskii <eliz@gnu.org>
parents:
43889
diff
changeset
|
1272 @end ifnotinfo |
25829 | 1273 @findex eval-expression |
1274 @kbd{M-:} (@code{eval-expression}) is the most basic command for evaluating | |
1275 a Lisp expression interactively. It reads the expression using the | |
1276 minibuffer, so you can execute any expression on a buffer regardless of | |
1277 what the buffer contains. When the expression is evaluated, the current | |
1278 buffer is once again the buffer that was current when @kbd{M-:} was | |
1279 typed. | |
1280 | |
1281 @kindex C-M-x @r{(Emacs-Lisp mode)} | |
1282 @findex eval-defun | |
1283 In Emacs-Lisp mode, the key @kbd{C-M-x} is bound to the command | |
1284 @code{eval-defun}, which parses the defun containing or following point | |
1285 as a Lisp expression and evaluates it. The value is printed in the echo | |
1286 area. This command is convenient for installing in the Lisp environment | |
1287 changes that you have just made in the text of a function definition. | |
1288 | |
1289 @kbd{C-M-x} treats @code{defvar} expressions specially. Normally, | |
1290 evaluating a @code{defvar} expression does nothing if the variable it | |
1291 defines already has a value. But @kbd{C-M-x} unconditionally resets the | |
1292 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
|
1293 @code{defcustom} expressions are treated similarly. |
25829 | 1294 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
|
1295 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
|
1296 the face according to the @code{defface} specification. |
25829 | 1297 |
1298 @kindex C-x C-e | |
1299 @findex eval-last-sexp | |
1300 The command @kbd{C-x C-e} (@code{eval-last-sexp}) evaluates the Lisp | |
1301 expression preceding point in the buffer, and displays the value in the | |
1302 echo area. It is available in all major modes, not just Emacs-Lisp | |
1303 mode. It does not treat @code{defvar} specially. | |
1304 | |
60789
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
1305 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
|
1306 @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
|
1307 in additional formats (octal, hexadecimal, and character). |
e1f3e09e22da
(Starting GUD): Add bashdb.
Richard M. Stallman <rms@gnu.org>
parents:
60594
diff
changeset
|
1308 |
62741
718dc622c12e
(Lisp Eval): C-M-x with arg runs Edebug.
Richard M. Stallman <rms@gnu.org>
parents:
62666
diff
changeset
|
1309 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
|
1310 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
|
1311 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
|
1312 @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
|
1313 definition for Edebug (@pxref{Instrumenting, Instrumenting for Edebug,, elisp, the Emacs Lisp Reference Manual}). |
25829 | 1314 |
1315 @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
|
1316 @findex eval-buffer |
25829 | 1317 The most general command for evaluating Lisp expressions from a buffer |
1318 is @code{eval-region}. @kbd{M-x eval-region} parses the text of the | |
1319 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
|
1320 @kbd{M-x eval-buffer} is similar but evaluates the entire |
25829 | 1321 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
|
1322 Lisp code that you are ready to test. Later, as you find bugs and |
25829 | 1323 change individual functions, use @kbd{C-M-x} on each function that you |
1324 change. This keeps the Lisp world in step with the source file. | |
1325 | |
28431
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1326 @vindex eval-expression-print-level |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1327 @vindex eval-expression-print-length |
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1328 @vindex eval-expression-debug-on-error |
71593 | 1329 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
|
1330 @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
|
1331 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
|
1332 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
|
1333 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
|
1334 used; its default is @code{t}. |
28431
315d6e79ea38
Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents:
27223
diff
changeset
|
1335 |
25829 | 1336 @node Lisp Interaction |
1337 @section Lisp Interaction Buffers | |
1338 | |
1339 The buffer @samp{*scratch*} which is selected when Emacs starts up is | |
1340 provided for evaluating Lisp expressions interactively inside Emacs. | |
1341 | |
1342 The simplest way to use the @samp{*scratch*} buffer is to insert Lisp | |
1343 expressions and type @kbd{C-j} after each expression. This command | |
1344 reads the Lisp expression before point, evaluates it, and inserts the | |
1345 value in printed representation before point. The result is a complete | |
1346 typescript of the expressions you have evaluated and their values. | |
1347 | |
1348 The @samp{*scratch*} buffer's major mode is Lisp Interaction mode, which | |
1349 is the same as Emacs-Lisp mode except for the binding of @kbd{C-j}. | |
1350 | |
1351 @findex lisp-interaction-mode | |
1352 The rationale for this feature is that Emacs must have a buffer when | |
1353 it starts up, but that buffer is not useful for editing files since a | |
1354 new buffer is made for every file that you visit. The Lisp interpreter | |
1355 typescript is the most useful thing I can think of for the initial | |
1356 buffer to do. Type @kbd{M-x lisp-interaction-mode} to put the current | |
1357 buffer in Lisp Interaction mode. | |
1358 | |
1359 @findex ielm | |
1360 An alternative way of evaluating Emacs Lisp expressions interactively | |
1361 is to use Inferior Emacs-Lisp mode, which provides an interface rather | |
1362 like Shell mode (@pxref{Shell Mode}) for evaluating Emacs Lisp | |
1363 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
|
1364 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
|
1365 documentation. |
25829 | 1366 |
1367 @node External Lisp | |
1368 @section Running an External Lisp | |
1369 | |
1370 Emacs has facilities for running programs in other Lisp systems. You can | |
1371 run a Lisp process as an inferior of Emacs, and pass expressions to it to | |
1372 be evaluated. You can also pass changed function definitions directly from | |
1373 the Emacs buffers in which you edit the Lisp programs to the inferior Lisp | |
1374 process. | |
1375 | |
1376 @findex run-lisp | |
1377 @vindex inferior-lisp-program | |
1378 @kindex C-x C-z | |
1379 To run an inferior Lisp process, type @kbd{M-x run-lisp}. This runs | |
1380 the program named @code{lisp}, the same program you would run by typing | |
1381 @code{lisp} as a shell command, with both input and output going through | |
1382 an Emacs buffer named @samp{*lisp*}. That is to say, any ``terminal | |
1383 output'' from Lisp will go into the buffer, advancing point, and any | |
1384 ``terminal input'' for Lisp comes from text in the buffer. (You can | |
1385 change the name of the Lisp executable file by setting the variable | |
1386 @code{inferior-lisp-program}.) | |
1387 | |
1388 To give input to Lisp, go to the end of the buffer and type the input, | |
1389 terminated by @key{RET}. The @samp{*lisp*} buffer is in Inferior Lisp | |
1390 mode, which combines the special characteristics of Lisp mode with most | |
1391 of the features of Shell mode (@pxref{Shell Mode}). The definition of | |
1392 @key{RET} to send a line to a subprocess is one of the features of Shell | |
1393 mode. | |
1394 | |
1395 @findex lisp-mode | |
1396 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
|
1397 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
|
1398 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
|
1399 @file{.lsp}, or @file{.lisp}. |
25829 | 1400 |
1401 @kindex C-M-x @r{(Lisp mode)} | |
1402 @findex lisp-eval-defun | |
1403 When you edit a function in a Lisp program you are running, the easiest | |
1404 way to send the changed definition to the inferior Lisp process is the key | |
1405 @kbd{C-M-x}. In Lisp mode, this runs the function @code{lisp-eval-defun}, | |
1406 which finds the defun around or following point and sends it as input to | |
1407 the Lisp process. (Emacs can send input to any inferior process regardless | |
1408 of what buffer is current.) | |
1409 | |
68686
f2477980fde3
(Compilation): Move and split kill-compilation para.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
1410 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
|
1411 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
|
1412 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
|
1413 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
|
1414 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
|
1415 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
|
1416 |
52401 | 1417 |
1418 @ignore | |
1419 arch-tag: 9c3c2f71-b332-4144-8500-3ff9945a50ed | |
1420 @end ignore |