Mercurial > emacs
annotate man/trouble.texi @ 71232:55a3edae726b
*** empty log message ***
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 05 Jun 2006 17:21:37 +0000 |
parents | 756223adf885 |
children | 3d45362f1d38 a8190f7e546e |
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:
64464
diff
changeset
|
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2001, 2002, |
68639
dc2d5a6655a3
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
66503
diff
changeset
|
3 @c 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
25829 | 4 @c See file emacs.texi for copying conditions. |
5 @iftex | |
6 @chapter Dealing with Common Problems | |
7 | |
8 If you type an Emacs command you did not intend, the results are often | |
9 mysterious. This chapter tells what you can do to cancel your mistake or | |
10 recover from a mysterious situation. Emacs bugs and system crashes are | |
11 also considered. | |
12 @end iftex | |
13 | |
56812
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
14 @ifnottex |
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
15 @raisesections |
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
16 @end ifnottex |
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
17 |
25829 | 18 @node Quitting, Lossage, Customization, Top |
19 @section Quitting and Aborting | |
20 @cindex quitting | |
21 | |
22 @table @kbd | |
23 @item C-g | |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
24 @itemx C-@key{BREAK} @r{(MS-DOS only)} |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
25 Quit: cancel running or partially typed command. |
25829 | 26 @item C-] |
27 Abort innermost recursive editing level and cancel the command which | |
28 invoked it (@code{abort-recursive-edit}). | |
29 @item @key{ESC} @key{ESC} @key{ESC} | |
30 Either quit or abort, whichever makes sense (@code{keyboard-escape-quit}). | |
31 @item M-x top-level | |
32 Abort all recursive editing levels that are currently executing. | |
33 @item C-x u | |
34 Cancel a previously made change in the buffer contents (@code{undo}). | |
35 @end table | |
36 | |
69800 | 37 There are two ways of canceling a command before it has finished: |
38 @dfn{quitting} with @kbd{C-g}, and @dfn{aborting} with @kbd{C-]} or | |
39 @kbd{M-x top-level}. Quitting cancels a partially typed command, or | |
40 one which is still running. Aborting exits a recursive editing level | |
41 and cancels the command that invoked the recursive edit. | |
25829 | 42 (@xref{Recursive Edit}.) |
43 | |
44 @cindex quitting | |
45 @kindex C-g | |
69800 | 46 Quitting with @kbd{C-g} is the way to get rid of a partially typed |
25829 | 47 command, or a numeric argument that you don't want. It also stops a |
48 running command in the middle in a relatively safe way, so you can use | |
49 it if you accidentally give a command which takes a long time. In | |
69800 | 50 particular, it is safe to quit out of a kill command; either your text |
51 will @emph{all} still be in the buffer, or it will @emph{all} be in | |
52 the kill ring, or maybe both. Quitting an incremental search does | |
53 special things, documented under searching; it may take two successive | |
54 @kbd{C-g} characters to get out of a search (@pxref{Incremental | |
55 Search}). | |
25829 | 56 |
57 On MS-DOS, the character @kbd{C-@key{BREAK}} serves as a quit character | |
58 like @kbd{C-g}. The reason is that it is not feasible, on MS-DOS, to | |
59 recognize @kbd{C-g} while a command is running, between interactions | |
60 with the user. By contrast, it @emph{is} feasible to recognize | |
70439
48fec2b642c9
(Quitting): Replace inforef to emacs-xtra by conditional xref's, depending on
Eli Zaretskii <eliz@gnu.org>
parents:
70362
diff
changeset
|
61 @kbd{C-@key{BREAK}} at all times. |
48fec2b642c9
(Quitting): Replace inforef to emacs-xtra by conditional xref's, depending on
Eli Zaretskii <eliz@gnu.org>
parents:
70362
diff
changeset
|
62 @iftex |
48fec2b642c9
(Quitting): Replace inforef to emacs-xtra by conditional xref's, depending on
Eli Zaretskii <eliz@gnu.org>
parents:
70362
diff
changeset
|
63 @xref{MS-DOS Keyboard,,,emacs-xtra, Specialized Emacs Features}. |
48fec2b642c9
(Quitting): Replace inforef to emacs-xtra by conditional xref's, depending on
Eli Zaretskii <eliz@gnu.org>
parents:
70362
diff
changeset
|
64 @end iftex |
48fec2b642c9
(Quitting): Replace inforef to emacs-xtra by conditional xref's, depending on
Eli Zaretskii <eliz@gnu.org>
parents:
70362
diff
changeset
|
65 @ifnottex |
48fec2b642c9
(Quitting): Replace inforef to emacs-xtra by conditional xref's, depending on
Eli Zaretskii <eliz@gnu.org>
parents:
70362
diff
changeset
|
66 @xref{MS-DOS Keyboard}. |
48fec2b642c9
(Quitting): Replace inforef to emacs-xtra by conditional xref's, depending on
Eli Zaretskii <eliz@gnu.org>
parents:
70362
diff
changeset
|
67 @end ifnottex |
48fec2b642c9
(Quitting): Replace inforef to emacs-xtra by conditional xref's, depending on
Eli Zaretskii <eliz@gnu.org>
parents:
70362
diff
changeset
|
68 |
25829 | 69 |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
70 @findex keyboard-quit |
25829 | 71 @kbd{C-g} works by setting the variable @code{quit-flag} to @code{t} |
72 the instant @kbd{C-g} is typed; Emacs Lisp checks this variable | |
69800 | 73 frequently, and quits if it is non-@code{nil}. @kbd{C-g} is only |
25829 | 74 actually executed as a command if you type it while Emacs is waiting for |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
75 input. In that case, the command it runs is @code{keyboard-quit}. |
25829 | 76 |
60115
63c8eb0c25c0
(Quitting): Emergency escape only for text terminal.
Richard M. Stallman <rms@gnu.org>
parents:
56812
diff
changeset
|
77 On a text terminal, if you quit with @kbd{C-g} a second time before |
63c8eb0c25c0
(Quitting): Emergency escape only for text terminal.
Richard M. Stallman <rms@gnu.org>
parents:
56812
diff
changeset
|
78 the first @kbd{C-g} is recognized, you activate the ``emergency |
63c8eb0c25c0
(Quitting): Emergency escape only for text terminal.
Richard M. Stallman <rms@gnu.org>
parents:
56812
diff
changeset
|
79 escape'' feature and return to the shell. @xref{Emergency Escape}. |
25829 | 80 |
81 @cindex NFS and quitting | |
69800 | 82 There are some situations where you cannot quit. When Emacs is |
83 waiting for the operating system to do something, quitting is | |
84 impossible unless special pains are taken for the particular system | |
85 call within Emacs where the waiting occurs. We have done this for the | |
86 system calls that users are likely to want to quit from, but it's | |
87 possible you will a case not handled. In one very common | |
88 case---waiting for file input or output using NFS---Emacs itself knows | |
89 how to quit, but many NFS implementations simply do not allow user | |
90 programs to stop waiting for NFS when the NFS server is hung. | |
25829 | 91 |
92 @cindex aborting recursive edit | |
93 @findex abort-recursive-edit | |
94 @kindex C-] | |
95 Aborting with @kbd{C-]} (@code{abort-recursive-edit}) is used to get | |
96 out of a recursive editing level and cancel the command which invoked | |
97 it. Quitting with @kbd{C-g} does not do this, and could not do this, | |
98 because it is used to cancel a partially typed command @emph{within} the | |
99 recursive editing level. Both operations are useful. For example, if | |
100 you are in a recursive edit and type @kbd{C-u 8} to enter a numeric | |
101 argument, you can cancel that argument with @kbd{C-g} and remain in the | |
102 recursive edit. | |
103 | |
104 @findex keyboard-escape-quit | |
105 @kindex ESC ESC ESC | |
69800 | 106 The sequence @kbd{@key{ESC} @key{ESC} @key{ESC}} |
107 (@code{keyboard-escape-quit}) can either quit or abort. (We defined | |
108 it this way because @key{ESC} means ``get out'' in many PC programs.) | |
109 It can cancel a prefix argument, clear a selected region, or get out | |
110 of a Query Replace, like @kbd{C-g}. It can get out of the minibuffer | |
111 or a recursive edit, like @kbd{C-]}. It can also get out of splitting | |
112 the frame into multiple windows, as with @kbd{C-x 1}. One thing it | |
113 cannot do, however, is stop a command that is running. That's because | |
114 it executes as an ordinary command, and Emacs doesn't notice it until | |
115 it is ready for the next command. | |
25829 | 116 |
117 @findex top-level | |
118 The command @kbd{M-x top-level} is equivalent to ``enough'' @kbd{C-]} | |
119 commands to get you out of all the levels of recursive edits that you | |
120 are in. @kbd{C-]} gets you out one level at a time, but @kbd{M-x | |
121 top-level} goes out all levels at once. Both @kbd{C-]} and @kbd{M-x | |
122 top-level} are like all other commands, and unlike @kbd{C-g}, in that | |
123 they take effect only when Emacs is ready for a command. @kbd{C-]} is | |
124 an ordinary key and has its meaning only because of its binding in the | |
125 keymap. @xref{Recursive Edit}. | |
126 | |
127 @kbd{C-x u} (@code{undo}) is not strictly speaking a way of canceling | |
128 a command, but you can think of it as canceling a command that already | |
37869 | 129 finished executing. @xref{Undo}, for more information |
130 about the undo facility. | |
25829 | 131 |
132 @node Lossage, Bugs, Quitting, Top | |
133 @section Dealing with Emacs Trouble | |
134 | |
135 This section describes various conditions in which Emacs fails to work | |
38686
0d3019db87ac
(Lossage, Bugs): Mention etc/PROBLEMS and the Bugs section of the FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38245
diff
changeset
|
136 normally, and how to recognize them and correct them. For a list of |
0d3019db87ac
(Lossage, Bugs): Mention etc/PROBLEMS and the Bugs section of the FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38245
diff
changeset
|
137 additional problems you might encounter, see @ref{Bugs and problems, , |
0d3019db87ac
(Lossage, Bugs): Mention etc/PROBLEMS and the Bugs section of the FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38245
diff
changeset
|
138 Bugs and problems, efaq, GNU Emacs FAQ}, and the file @file{etc/PROBLEMS} |
54478 | 139 in the Emacs distribution. Type @kbd{C-h C-f} to read the FAQ; type |
140 @kbd{C-h C-e} to read the @file{PROBLEMS} file. | |
25829 | 141 |
142 @menu | |
46235 | 143 * DEL Does Not Delete:: What to do if @key{DEL} doesn't delete. |
38767
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
144 * Stuck Recursive:: `[...]' in mode line around the parentheses. |
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
145 * Screen Garbled:: Garbage on the screen. |
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
146 * Text Garbled:: Garbage in the text. |
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
147 * Memory Full:: How to cope when you run out of memory. |
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
148 * After a Crash:: Recovering editing in an Emacs session that crashed. |
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
149 * Emergency Escape:: Emergency escape--- |
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
150 What to do if Emacs stops responding. |
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
151 * Total Frustration:: When you are at your wits' end. |
25829 | 152 @end menu |
153 | |
38767
5889c45fd6ad
Change the name of the "DEL Doesn't Delete" node to "DEL Does Not Delete",
Eli Zaretskii <eliz@gnu.org>
parents:
38742
diff
changeset
|
154 @node DEL Does Not Delete |
25829 | 155 @subsection If @key{DEL} Fails to Delete |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
156 @cindex @key{DEL} vs @key{BACKSPACE} |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
157 @cindex @key{BACKSPACE} vs @key{DEL} |
37126
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
158 @cindex usual erasure key |
25829 | 159 |
37126
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
160 Every keyboard has a large key, a little ways above the @key{RET} or |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
161 @key{ENTER} key, which you normally use outside Emacs to erase the |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
162 last character that you typed. We call this key @dfn{the usual |
37347
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
163 erasure key}. In Emacs, it is supposed to be equivalent to @key{DEL}, |
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
164 and when Emacs is properly configured for your terminal, it translates |
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
165 that key into the character @key{DEL}. |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
166 |
68702
066d88077bfc
"Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
167 When Emacs starts up on a graphical display, it determines |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
168 automatically which key should be @key{DEL}. In some unusual cases |
37126
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
169 Emacs gets the wrong information from the system. If the usual |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
170 erasure key deletes forwards instead of backwards, that is probably |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
171 what happened---Emacs ought to be treating the @key{DELETE} key as |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
172 @key{DEL}, but it isn't. |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
173 |
68702
066d88077bfc
"Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
174 On a graphical display, if the usual erasure key is labeled |
37126
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
175 @key{BACKSPACE} and there is a @key{DELETE} key elsewhere, but the |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
176 @key{DELETE} key deletes backward instead of forward, that too |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
177 suggests Emacs got the wrong information---but in the opposite sense. |
37357
ad563f9185fb
Minor clarifications of BACKSPACE vs DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37347
diff
changeset
|
178 It ought to be treating the @key{BACKSPACE} key as @key{DEL}, and |
ad563f9185fb
Minor clarifications of BACKSPACE vs DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37347
diff
changeset
|
179 treating @key{DELETE} differently, but it isn't. |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
180 |
37126
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
181 On a text-only terminal, if you find the usual erasure key prompts |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
182 for a Help command, like @kbd{Control-h}, instead of deleting a |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
183 character, it means that key is actually sending the @key{BS} |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
184 character. Emacs ought to be treating @key{BS} as @key{DEL}, but it |
6a2d75e45a87
Add concept of "usual erasure key" to explain about DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37119
diff
changeset
|
185 isn't. |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
186 |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
187 In all of those cases, the immediate remedy is the same: use the |
37498
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
188 command @kbd{M-x normal-erase-is-backspace-mode}. This toggles |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
189 between the two modes that Emacs supports for handling @key{DEL}, so |
69800 | 190 if Emacs starts in the wrong mode, this should switch to the right |
191 mode. On a text-only terminal, if you want to ask for help when | |
192 @key{BS} is treated as @key{DEL}, use @key{F1}; @kbd{C-?} may also | |
193 work, if it sends character code 127. | |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
194 |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
195 @findex normal-erase-is-backspace-mode |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
196 To fix the problem automatically for every Emacs session, you can |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
197 put one of the following lines into your @file{.emacs} file |
37357
ad563f9185fb
Minor clarifications of BACKSPACE vs DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37347
diff
changeset
|
198 (@pxref{Init File}). For the first case above, where @key{DELETE} |
ad563f9185fb
Minor clarifications of BACKSPACE vs DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37347
diff
changeset
|
199 deletes forwards instead of backwards, use this line to make |
37498
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
200 @key{DELETE} act as @key{DEL} (resulting in behavior compatible |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
201 with Emacs 20 and previous versions): |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
202 |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
203 @lisp |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
204 (normal-erase-is-backspace-mode 0) |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
205 @end lisp |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
206 |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
207 @noindent |
37357
ad563f9185fb
Minor clarifications of BACKSPACE vs DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37347
diff
changeset
|
208 For the other two cases, where @key{BACKSPACE} ought to act as |
ad563f9185fb
Minor clarifications of BACKSPACE vs DEL.
Richard M. Stallman <rms@gnu.org>
parents:
37347
diff
changeset
|
209 @key{DEL}, use this line: |
36791
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
210 |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
211 @lisp |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
212 (normal-erase-is-backspace-mode 1) |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
213 @end lisp |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
214 |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
215 @vindex normal-erase-is-backspace |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
216 Another way to fix the problem for every Emacs session is to |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
217 customize the variable @code{normal-erase-is-backspace}: the value |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
218 @code{t} specifies the mode where @key{BS} or @key{BACKSPACE} is |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
219 @key{DEL}, and @code{nil} specifies the other mode. @xref{Easy |
308577404dc3
DEL Gets Help: Complete rewrite to deal with automatic
Richard M. Stallman <rms@gnu.org>
parents:
36620
diff
changeset
|
220 Customization}. |
25829 | 221 |
68702
066d88077bfc
"Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
222 On a graphical display, it can also happen that the usual erasure key |
37498
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
223 is labeled @key{BACKSPACE}, there is a @key{DELETE} key elsewhere, and |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
224 both keys delete forward. This probably means that someone has |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
225 redefined your @key{BACKSPACE} key as a @key{DELETE} key. With X, |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
226 this is typically done with a command to the @code{xmodmap} program |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
227 when you start the server or log in. The most likely motive for this |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
228 customization was to support old versions of Emacs, so we recommend |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
229 you simply remove it now. |
0b7a984464cf
Clarify when C-? is available as Help.
Richard M. Stallman <rms@gnu.org>
parents:
37357
diff
changeset
|
230 |
25829 | 231 @node Stuck Recursive |
232 @subsection Recursive Editing Levels | |
233 | |
234 Recursive editing levels are important and useful features of Emacs, but | |
68702
066d88077bfc
"Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents:
68639
diff
changeset
|
235 they can seem like malfunctions if you do not understand them. |
25829 | 236 |
237 If the mode line has square brackets @samp{[@dots{}]} around the parentheses | |
238 that contain the names of the major and minor modes, you have entered a | |
239 recursive editing level. If you did not do this on purpose, or if you | |
240 don't understand what that means, you should just get out of the recursive | |
241 editing level. To do so, type @kbd{M-x top-level}. This is called getting | |
242 back to top level. @xref{Recursive Edit}. | |
243 | |
244 @node Screen Garbled | |
245 @subsection Garbage on the Screen | |
246 | |
60115
63c8eb0c25c0
(Quitting): Emergency escape only for text terminal.
Richard M. Stallman <rms@gnu.org>
parents:
56812
diff
changeset
|
247 If the text on a text terminal looks wrong, the first thing to do is |
63c8eb0c25c0
(Quitting): Emergency escape only for text terminal.
Richard M. Stallman <rms@gnu.org>
parents:
56812
diff
changeset
|
248 see whether it is wrong in the buffer. Type @kbd{C-l} to redisplay |
63c8eb0c25c0
(Quitting): Emergency escape only for text terminal.
Richard M. Stallman <rms@gnu.org>
parents:
56812
diff
changeset
|
249 the entire screen. If the screen appears correct after this, the |
63c8eb0c25c0
(Quitting): Emergency escape only for text terminal.
Richard M. Stallman <rms@gnu.org>
parents:
56812
diff
changeset
|
250 problem was entirely in the previous screen update. (Otherwise, see |
63c8eb0c25c0
(Quitting): Emergency escape only for text terminal.
Richard M. Stallman <rms@gnu.org>
parents:
56812
diff
changeset
|
251 the following section.) |
25829 | 252 |
69800 | 253 Display updating problems often result from an incorrect terminfo |
254 entry for the terminal you are using. The file @file{etc/TERMS} in | |
255 the Emacs distribution gives the fixes for known problems of this | |
256 sort. @file{INSTALL} contains general advice for these problems in | |
257 one of its sections. To investigate the possibility that you have | |
258 this sort of problem, try Emacs on another terminal made by a | |
259 different manufacturer. If problems happen frequently on one kind of | |
260 terminal but not another kind, it is likely to be a bad terminfo entry, | |
261 though it could also be due to a bug in Emacs that appears for | |
262 terminals that have or that lack specific features. | |
25829 | 263 |
264 @node Text Garbled | |
265 @subsection Garbage in the Text | |
266 | |
69800 | 267 If @kbd{C-l} shows that the text is wrong, first type @kbd{C-h l} to |
268 see what commands you typed to produce the observed results. Then try | |
269 undoing the changes step by step using @kbd{C-x u}, until it gets back | |
270 to a state you consider correct. | |
25829 | 271 |
272 If a large portion of text appears to be missing at the beginning or | |
273 end of the buffer, check for the word @samp{Narrow} in the mode line. | |
274 If it appears, the text you don't see is probably still present, but | |
275 temporarily off-limits. To make it accessible again, type @kbd{C-x n | |
276 w}. @xref{Narrowing}. | |
277 | |
278 @node Memory Full | |
279 @subsection Running out of Memory | |
280 @cindex memory full | |
281 @cindex out of memory | |
282 | |
66503
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
283 If you get the error message @samp{Virtual memory exceeded}, save |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
284 your modified buffers with @kbd{C-x s}. This method of saving them |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
285 has the smallest need for additional memory. Emacs keeps a reserve of |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
286 memory which it makes available when this error happens; that should |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
287 be enough to enable @kbd{C-x s} to complete its work. When the |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
288 reserve has been used, @samp{!MEM FULL!} appears at the beginning of |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
289 the mode line, indicating there is no more reserve. |
25829 | 290 |
66503
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
291 Once you have saved your modified buffers, you can exit this Emacs |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
292 session and start another, or you can use @kbd{M-x kill-some-buffers} |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
293 to free space in the current Emacs job. If this frees up sufficient |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
294 space, Emacs will refill its memory reserve, and @samp{!MEM FULL!} |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
295 will disappear from the mode line. That means you can safely go on |
97aa71642e9c
(Memory Full): Mention !MEM FULL! in mode line.
Richard M. Stallman <rms@gnu.org>
parents:
65034
diff
changeset
|
296 editing in the same Emacs session. |
25829 | 297 |
298 Do not use @kbd{M-x buffer-menu} to save or kill buffers when you run | |
37976
23dc2eca0bd3
Proofreading changes from Tim Goodwin <tjg@star.le.ac.uk>.
Eli Zaretskii <eliz@gnu.org>
parents:
37869
diff
changeset
|
299 out of memory, because the buffer menu needs a fair amount of memory |
25829 | 300 itself, and the reserve supply may not be enough. |
301 | |
302 @node After a Crash | |
303 @subsection Recovery After a Crash | |
304 | |
305 If Emacs or the computer crashes, you can recover the files you were | |
306 editing at the time of the crash from their auto-save files. To do | |
307 this, start Emacs again and type the command @kbd{M-x recover-session}. | |
308 | |
309 This command initially displays a buffer which lists interrupted | |
310 session files, each with its date. You must choose which session to | |
311 recover from. Typically the one you want is the most recent one. Move | |
312 point to the one you choose, and type @kbd{C-c C-c}. | |
313 | |
69800 | 314 Then @code{recover-session} considers each of the files that you |
315 were editing during that session; for each such file, it asks whether | |
316 to recover that file. If you answer @kbd{y} for a file, it shows the | |
317 dates of that file and its auto-save file, then asks once again | |
318 whether to recover that file. For the second question, you must | |
319 confirm with @kbd{yes}. If you do, Emacs visits the file but gets the | |
320 text from the auto-save file. | |
25829 | 321 |
322 When @code{recover-session} is done, the files you've chosen to | |
323 recover are present in Emacs buffers. You should then save them. Only | |
324 this---saving them---updates the files themselves. | |
325 | |
62897
6181dbed8947
(After a Crash): Mention emacs-buffer.gdb as a recovery mechanism.
Noah Friedman <friedman@splode.com>
parents:
60342
diff
changeset
|
326 As a last resort, if you had buffers with content which were not |
6181dbed8947
(After a Crash): Mention emacs-buffer.gdb as a recovery mechanism.
Noah Friedman <friedman@splode.com>
parents:
60342
diff
changeset
|
327 associated with any files, or if the autosave was not recent enough to |
6181dbed8947
(After a Crash): Mention emacs-buffer.gdb as a recovery mechanism.
Noah Friedman <friedman@splode.com>
parents:
60342
diff
changeset
|
328 have recorded important changes, you can use the |
62899
1a33c4dbb62b
(After a Crash): Describe how to use emacs-buffer.gdb more explicitly.
Noah Friedman <friedman@splode.com>
parents:
62897
diff
changeset
|
329 @file{etc/emacs-buffer.gdb} script with GDB (the GNU Debugger) to |
1a33c4dbb62b
(After a Crash): Describe how to use emacs-buffer.gdb more explicitly.
Noah Friedman <friedman@splode.com>
parents:
62897
diff
changeset
|
330 retrieve them from a core dump--provided that a core dump was saved, |
1a33c4dbb62b
(After a Crash): Describe how to use emacs-buffer.gdb more explicitly.
Noah Friedman <friedman@splode.com>
parents:
62897
diff
changeset
|
331 and that the Emacs executable was not stripped of its debugging |
1a33c4dbb62b
(After a Crash): Describe how to use emacs-buffer.gdb more explicitly.
Noah Friedman <friedman@splode.com>
parents:
62897
diff
changeset
|
332 symbols. |
1a33c4dbb62b
(After a Crash): Describe how to use emacs-buffer.gdb more explicitly.
Noah Friedman <friedman@splode.com>
parents:
62897
diff
changeset
|
333 |
69800 | 334 As soon as you get the core dump, rename it to another name such as |
335 @file{core.emacs}, so that another crash won't overwrite it. | |
336 | |
62991
b9a3bc12a80f
(After a Crash): Polish previous change.
Richard M. Stallman <rms@gnu.org>
parents:
62899
diff
changeset
|
337 To use this script, run @code{gdb} with the file name of your Emacs |
b9a3bc12a80f
(After a Crash): Polish previous change.
Richard M. Stallman <rms@gnu.org>
parents:
62899
diff
changeset
|
338 executable and the file name of the core dump, e.g. @samp{gdb |
62899
1a33c4dbb62b
(After a Crash): Describe how to use emacs-buffer.gdb more explicitly.
Noah Friedman <friedman@splode.com>
parents:
62897
diff
changeset
|
339 /usr/bin/emacs core.emacs}. At the @code{(gdb)} prompt, load the |
1a33c4dbb62b
(After a Crash): Describe how to use emacs-buffer.gdb more explicitly.
Noah Friedman <friedman@splode.com>
parents:
62897
diff
changeset
|
340 recovery script: @samp{source /usr/src/emacs/etc/emacs-buffer.gdb}. |
62991
b9a3bc12a80f
(After a Crash): Polish previous change.
Richard M. Stallman <rms@gnu.org>
parents:
62899
diff
changeset
|
341 Then type the command @code{ybuffer-list} to see which buffers are |
b9a3bc12a80f
(After a Crash): Polish previous change.
Richard M. Stallman <rms@gnu.org>
parents:
62899
diff
changeset
|
342 available. For each buffer, it lists a buffer number. To save a |
b9a3bc12a80f
(After a Crash): Polish previous change.
Richard M. Stallman <rms@gnu.org>
parents:
62899
diff
changeset
|
343 buffer, use @code{ysave-buffer}; you specify the buffer number, and |
b9a3bc12a80f
(After a Crash): Polish previous change.
Richard M. Stallman <rms@gnu.org>
parents:
62899
diff
changeset
|
344 the file name to write that buffer into. You should use a file name |
b9a3bc12a80f
(After a Crash): Polish previous change.
Richard M. Stallman <rms@gnu.org>
parents:
62899
diff
changeset
|
345 which does not already exist; if the file does exist, the script does |
64464
a40344cc40b0
(After a Crash): Delete duplicate words.
Juri Linkov <juri@jurta.org>
parents:
64083
diff
changeset
|
346 not make a backup of its old contents. |
62897
6181dbed8947
(After a Crash): Mention emacs-buffer.gdb as a recovery mechanism.
Noah Friedman <friedman@splode.com>
parents:
60342
diff
changeset
|
347 |
25829 | 348 @node Emergency Escape |
349 @subsection Emergency Escape | |
350 | |
69800 | 351 On text-only terminals, the @dfn{emergency escape} feature suspends |
352 Emacs immediately if you type @kbd{C-g} a second time before Emacs can | |
353 actually respond to the first one by quitting. This is so you can | |
354 always get out of GNU Emacs no matter how badly it might be hung. | |
355 When things are working properly, Emacs recognizes and handles the | |
356 first @kbd{C-g} so fast that the second one won't trigger emergency | |
357 escape. However, if some problem prevents Emacs from handling the | |
358 first @kbd{C-g} properly, then the second one will get you back to the | |
359 shell. | |
25829 | 360 |
69800 | 361 When you resume Emacs after a suspension caused by emergency escape, |
362 it asks two questions before going back to what it had been doing: | |
25829 | 363 |
364 @example | |
365 Auto-save? (y or n) | |
366 Abort (and dump core)? (y or n) | |
367 @end example | |
368 | |
369 @noindent | |
370 Answer each one with @kbd{y} or @kbd{n} followed by @key{RET}. | |
371 | |
69800 | 372 Saying @kbd{y} to @samp{Auto-save?} causes immediate auto-saving of |
373 all modified buffers in which auto-saving is enabled. Saying @kbd{n} | |
374 skips this. | |
25829 | 375 |
69800 | 376 Saying @kbd{y} to @samp{Abort (and dump core)?} causes Emacs to |
377 crash, dumping core. This is to enable a wizard to figure out why | |
378 Emacs was failing to quit in the first place. Execution does not | |
379 continue after a core dump. | |
380 | |
381 If you answer this question @kbd{n}, Emacs execution resumes. With | |
382 luck, Emacs will ultimately do the requested quit. If not, each | |
383 subsequent @kbd{C-g} invokes emergency escape again. | |
25829 | 384 |
385 If Emacs is not really hung, just slow, you may invoke the double | |
69800 | 386 @kbd{C-g} feature without really meaning to. Then just resume and |
387 answer @kbd{n} to both questions, and you will get back to the former | |
388 state. The quit you requested will happen by and by. | |
25829 | 389 |
70362
017a2a1beeee
(Emergency Escape): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
69898
diff
changeset
|
390 Emergency escape is active only for text terminals. On graphical |
017a2a1beeee
(Emergency Escape): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
69898
diff
changeset
|
391 displays, you can use the mouse to kill Emacs or switch to another |
017a2a1beeee
(Emergency Escape): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
69898
diff
changeset
|
392 program. |
25829 | 393 |
69800 | 394 On MS-DOS, you must type @kbd{C-@key{BREAK}} (twice) to cause |
395 emergency escape---but there are cases where it won't work, when | |
396 system call hangs or when Emacs is stuck in a tight loop in C code. | |
25829 | 397 |
398 @node Total Frustration | |
399 @subsection Help for Total Frustration | |
400 @cindex Eliza | |
401 @cindex doctor | |
402 | |
403 If using Emacs (or something else) becomes terribly frustrating and none | |
404 of the techniques described above solve the problem, Emacs can still help | |
405 you. | |
406 | |
407 First, if the Emacs you are using is not responding to commands, type | |
408 @kbd{C-g C-g} to get out of it and then start a new one. | |
409 | |
410 @findex doctor | |
411 Second, type @kbd{M-x doctor @key{RET}}. | |
412 | |
69800 | 413 The Emacs psychotherapist will help you feel better. Each time you |
414 say something to the psychotherapist, you must end it by typing | |
415 @key{RET} @key{RET}. This indicates you are finished typing. | |
25829 | 416 |
417 @node Bugs, Contributing, Lossage, Top | |
418 @section Reporting Bugs | |
419 | |
420 @cindex bugs | |
421 Sometimes you will encounter a bug in Emacs. Although we cannot | |
422 promise we can or will fix the bug, and we might not even agree that it | |
423 is a bug, we want to hear about problems you encounter. Often we agree | |
424 they are bugs and want to fix them. | |
425 | |
426 To make it possible for us to fix a bug, you must report it. In order | |
427 to do so effectively, you must know when and how to do it. | |
428 | |
38686
0d3019db87ac
(Lossage, Bugs): Mention etc/PROBLEMS and the Bugs section of the FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38245
diff
changeset
|
429 Before reporting a bug, it is a good idea to see if it is already |
0d3019db87ac
(Lossage, Bugs): Mention etc/PROBLEMS and the Bugs section of the FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38245
diff
changeset
|
430 known. You can find the list of known problems in the file |
54478 | 431 @file{etc/PROBLEMS} in the Emacs distribution; type @kbd{C-h C-e} to read |
38691
5c9ec2d0b570
(Lossage, Bugs): Mention the keys which display PROBLEMS and FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38686
diff
changeset
|
432 it. Some additional user-level problems can be found in @ref{Bugs and |
5c9ec2d0b570
(Lossage, Bugs): Mention the keys which display PROBLEMS and FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38686
diff
changeset
|
433 problems, , Bugs and problems, efaq, GNU Emacs FAQ}. Looking up your |
5c9ec2d0b570
(Lossage, Bugs): Mention the keys which display PROBLEMS and FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38686
diff
changeset
|
434 problem in these two documents might provide you with a solution or a |
5c9ec2d0b570
(Lossage, Bugs): Mention the keys which display PROBLEMS and FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38686
diff
changeset
|
435 work-around, or give you additional information about related issues. |
38686
0d3019db87ac
(Lossage, Bugs): Mention etc/PROBLEMS and the Bugs section of the FAQ.
Eli Zaretskii <eliz@gnu.org>
parents:
38245
diff
changeset
|
436 |
25829 | 437 @menu |
438 * Criteria: Bug Criteria. Have you really found a bug? | |
439 * Understanding Bug Reporting:: How to report a bug effectively. | |
440 * Checklist:: Steps to follow for a good bug report. | |
441 * Sending Patches:: How to send a patch for GNU Emacs. | |
442 @end menu | |
443 | |
444 @node Bug Criteria | |
445 @subsection When Is There a Bug | |
446 | |
69800 | 447 If Emacs accesses an invalid memory location (``segmentation |
448 fault''), or exits with an operating system error message that | |
449 indicates a problem in the program (as opposed to something like | |
450 ``disk full''), then it is certainly a bug. | |
25829 | 451 |
452 If Emacs updates the display in a way that does not correspond to what is | |
453 in the buffer, then it is certainly a bug. If a command seems to do the | |
454 wrong thing but the problem corrects itself if you type @kbd{C-l}, it is a | |
455 case of incorrect display updating. | |
456 | |
457 Taking forever to complete a command can be a bug, but you must make | |
458 certain that it was really Emacs's fault. Some commands simply take a | |
459 long time. Type @kbd{C-g} (@kbd{C-@key{BREAK}} on MS-DOS) and then @kbd{C-h l} | |
460 to see whether the input Emacs received was what you intended to type; | |
461 if the input was such that you @emph{know} it should have been processed | |
462 quickly, report a bug. If you don't know whether the command should | |
463 take a long time, find out by looking in the manual or by asking for | |
464 assistance. | |
465 | |
466 If a command you are familiar with causes an Emacs error message in a | |
467 case where its usual definition ought to be reasonable, it is probably a | |
468 bug. | |
469 | |
470 If a command does the wrong thing, that is a bug. But be sure you know | |
471 for certain what it ought to have done. If you aren't familiar with the | |
472 command, or don't know for certain how the command is supposed to work, | |
473 then it might actually be working right. Rather than jumping to | |
474 conclusions, show the problem to someone who knows for certain. | |
475 | |
36388
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
476 Finally, a command's intended definition may not be the best |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
477 possible definition for editing with. This is a very important sort |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
478 of problem, but it is also a matter of judgment. Also, it is easy to |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
479 come to such a conclusion out of ignorance of some of the existing |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
480 features. It is probably best not to complain about such a problem |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
481 until you have checked the documentation in the usual ways, feel |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
482 confident that you understand it, and know for certain that what you |
69800 | 483 want is not available. Ask other Emacs users, too. If you are not |
484 sure what the command is supposed to do after a careful reading of the | |
485 manual, check the index and glossary for any terms that may be | |
486 unclear. | |
25829 | 487 |
488 If after careful rereading of the manual you still do not understand | |
489 what the command should do, that indicates a bug in the manual, which | |
490 you should report. The manual's job is to make everything clear to | |
491 people who are not Emacs experts---including you. It is just as | |
492 important to report documentation bugs as program bugs. | |
493 | |
494 If the on-line documentation string of a function or variable disagrees | |
495 with the manual, one of them must be wrong; that is a bug. | |
496 | |
497 @node Understanding Bug Reporting | |
498 @subsection Understanding Bug Reporting | |
499 | |
500 @findex emacs-version | |
501 When you decide that there is a bug, it is important to report it and to | |
502 report it in a way which is useful. What is most useful is an exact | |
503 description of what commands you type, starting with the shell command to | |
504 run Emacs, until the problem happens. | |
505 | |
506 The most important principle in reporting a bug is to report | |
507 @emph{facts}. Hypotheses and verbal descriptions are no substitute for | |
508 the detailed raw data. Reporting the facts is straightforward, but many | |
509 people strain to posit explanations and report them instead of the | |
510 facts. If the explanations are based on guesses about how Emacs is | |
511 implemented, they will be useless; meanwhile, lacking the facts, we will | |
512 have no real information about the bug. | |
513 | |
514 For example, suppose that you type @kbd{C-x C-f /glorp/baz.ugh | |
69800 | 515 @key{RET}}, visiting a file which (you know) happens to be rather |
516 large, and Emacs displays @samp{I feel pretty today}. The best way to | |
517 report the bug is with a sentence like the preceding one, because it | |
518 gives all the facts. | |
25829 | 519 |
520 A bad way would be to assume that the problem is due to the size of | |
521 the file and say, ``I visited a large file, and Emacs displayed @samp{I | |
522 feel pretty today}.'' This is what we mean by ``guessing | |
523 explanations.'' The problem is just as likely to be due to the fact | |
524 that there is a @samp{z} in the file name. If this is so, then when we | |
525 got your report, we would try out the problem with some ``large file,'' | |
526 probably with no @samp{z} in its name, and not see any problem. There | |
527 is no way in the world that we could guess that we should try visiting a | |
528 file with a @samp{z} in its name. | |
529 | |
530 Alternatively, the problem might be due to the fact that the file starts | |
531 with exactly 25 spaces. For this reason, you should make sure that you | |
532 inform us of the exact contents of any file that is needed to reproduce the | |
533 bug. What if the problem only occurs when you have typed the @kbd{C-x C-a} | |
534 command previously? This is why we ask you to give the exact sequence of | |
535 characters you typed since starting the Emacs session. | |
536 | |
537 You should not even say ``visit a file'' instead of @kbd{C-x C-f} unless | |
538 you @emph{know} that it makes no difference which visiting command is used. | |
539 Similarly, rather than saying ``if I have three characters on the line,'' | |
540 say ``after I type @kbd{@key{RET} A B C @key{RET} C-p},'' if that is | |
69800 | 541 the way you entered the text. |
25829 | 542 |
543 So please don't guess any explanations when you report a bug. If you | |
544 want to actually @emph{debug} the problem, and report explanations that | |
545 are more than guesses, that is useful---but please include the facts as | |
546 well. | |
547 | |
548 @node Checklist | |
549 @subsection Checklist for Bug Reports | |
550 | |
551 @cindex reporting bugs | |
552 The best way to send a bug report is to mail it electronically to the | |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
553 Emacs maintainers at @email{bug-gnu-emacs@@gnu.org}, or to |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
554 @email{emacs-pretest-bug@@gnu.org} if you are pretesting an Emacs beta |
26021
4f5e4ec69f6a
Add emacs-prestest-bug@gnu.org analogous to bug-gnu-emacs@gnu.org.
Gerd Moellmann <gerd@gnu.org>
parents:
25829
diff
changeset
|
555 release. (If you want to suggest a change as an improvement, use the |
4f5e4ec69f6a
Add emacs-prestest-bug@gnu.org analogous to bug-gnu-emacs@gnu.org.
Gerd Moellmann <gerd@gnu.org>
parents:
25829
diff
changeset
|
556 same address.) |
25829 | 557 |
558 If you'd like to read the bug reports, you can find them on the | |
559 newsgroup @samp{gnu.emacs.bug}; keep in mind, however, that as a | |
560 spectator you should not criticize anything about what you see there. | |
561 The purpose of bug reports is to give information to the Emacs | |
562 maintainers. Spectators are welcome only as long as they do not | |
38245
9ada58a02f7e
Don't include data bigger than 500,000 bytes directly in the bug
Richard M. Stallman <rms@gnu.org>
parents:
38230
diff
changeset
|
563 interfere with this. In particular, some bug reports contain fairly |
9ada58a02f7e
Don't include data bigger than 500,000 bytes directly in the bug
Richard M. Stallman <rms@gnu.org>
parents:
38230
diff
changeset
|
564 large amounts of data; spectators should not complain about this. |
25829 | 565 |
566 Please do not post bug reports using netnews; mail is more reliable | |
38245
9ada58a02f7e
Don't include data bigger than 500,000 bytes directly in the bug
Richard M. Stallman <rms@gnu.org>
parents:
38230
diff
changeset
|
567 than netnews about reporting your correct address, which we may need |
9ada58a02f7e
Don't include data bigger than 500,000 bytes directly in the bug
Richard M. Stallman <rms@gnu.org>
parents:
38230
diff
changeset
|
568 in order to ask you for more information. If your data is more than |
9ada58a02f7e
Don't include data bigger than 500,000 bytes directly in the bug
Richard M. Stallman <rms@gnu.org>
parents:
38230
diff
changeset
|
569 500,000 bytes, please don't include it directly in the bug report; |
9ada58a02f7e
Don't include data bigger than 500,000 bytes directly in the bug
Richard M. Stallman <rms@gnu.org>
parents:
38230
diff
changeset
|
570 instead, offer to send it on request, or make it available by ftp and |
9ada58a02f7e
Don't include data bigger than 500,000 bytes directly in the bug
Richard M. Stallman <rms@gnu.org>
parents:
38230
diff
changeset
|
571 say where. |
25829 | 572 |
573 @findex report-emacs-bug | |
574 A convenient way to send a bug report for Emacs is to use the command | |
575 @kbd{M-x report-emacs-bug}. This sets up a mail buffer (@pxref{Sending | |
576 Mail}) and automatically inserts @emph{some} of the essential | |
577 information. However, it cannot supply all the necessary information; | |
578 you should still read and follow the guidelines below, so you can enter | |
579 the other crucial information by hand before you send the message. | |
580 | |
581 To enable maintainers to investigate a bug, your report | |
582 should include all these things: | |
583 | |
584 @itemize @bullet | |
585 @item | |
586 The version number of Emacs. Without this, we won't know whether there | |
587 is any point in looking for the bug in the current version of GNU | |
588 Emacs. | |
589 | |
590 You can get the version number by typing @kbd{M-x emacs-version | |
591 @key{RET}}. If that command does not work, you probably have something | |
592 other than GNU Emacs, so you will have to report the bug somewhere | |
593 else. | |
594 | |
595 @item | |
596 The type of machine you are using, and the operating system name and | |
597 version number. @kbd{M-x emacs-version @key{RET}} provides this | |
598 information too. Copy its output from the @samp{*Messages*} buffer, so | |
599 that you get it all and get it accurately. | |
600 | |
601 @item | |
602 The operands given to the @code{configure} command when Emacs was | |
603 installed. | |
604 | |
605 @item | |
606 A complete list of any modifications you have made to the Emacs source. | |
607 (We may not have time to investigate the bug unless it happens in an | |
608 unmodified Emacs. But if you've made modifications and you don't tell | |
609 us, you are sending us on a wild goose chase.) | |
610 | |
611 Be precise about these changes. A description in English is not | |
612 enough---send a context diff for them. | |
613 | |
614 Adding files of your own, or porting to another machine, is a | |
615 modification of the source. | |
616 | |
617 @item | |
618 Details of any other deviations from the standard procedure for installing | |
619 GNU Emacs. | |
620 | |
621 @item | |
622 The complete text of any files needed to reproduce the bug. | |
623 | |
624 If you can tell us a way to cause the problem without visiting any files, | |
625 please do so. This makes it much easier to debug. If you do need files, | |
626 make sure you arrange for us to see their exact contents. For example, it | |
69800 | 627 can matter whether there are spaces at the ends of lines, or a |
25829 | 628 newline after the last line in the buffer (nothing ought to care whether |
629 the last line is terminated, but try telling the bugs that). | |
630 | |
631 @item | |
632 The precise commands we need to type to reproduce the bug. | |
633 | |
634 @findex open-dribble-file | |
635 @cindex dribble file | |
35705
6c05ec832ecc
(Checklist): Add index entry for logging keystrokes.
Eli Zaretskii <eliz@gnu.org>
parents:
35239
diff
changeset
|
636 @cindex logging keystrokes |
69800 | 637 The easy way to record the input to Emacs precisely is to write a |
25829 | 638 dribble file. To start the file, execute the Lisp expression |
639 | |
640 @example | |
641 (open-dribble-file "~/dribble") | |
642 @end example | |
643 | |
644 @noindent | |
645 using @kbd{M-:} or from the @samp{*scratch*} buffer just after | |
646 starting Emacs. From then on, Emacs copies all your input to the | |
647 specified dribble file until the Emacs process is killed. | |
648 | |
649 @item | |
650 @findex open-termscript | |
651 @cindex termscript file | |
29107 | 652 @cindex @env{TERM} environment variable |
25829 | 653 For possible display bugs, the terminal type (the value of environment |
29107 | 654 variable @env{TERM}), the complete termcap entry for the terminal from |
25829 | 655 @file{/etc/termcap} (since that file is not identical on all machines), |
656 and the output that Emacs actually sent to the terminal. | |
657 | |
658 The way to collect the terminal output is to execute the Lisp expression | |
659 | |
660 @example | |
661 (open-termscript "~/termscript") | |
662 @end example | |
663 | |
664 @noindent | |
665 using @kbd{M-:} or from the @samp{*scratch*} buffer just after | |
666 starting Emacs. From then on, Emacs copies all terminal output to the | |
667 specified termscript file as well, until the Emacs process is killed. | |
668 If the problem happens when Emacs starts up, put this expression into | |
669 your @file{.emacs} file so that the termscript file will be open when | |
670 Emacs displays the screen for the first time. | |
671 | |
672 Be warned: it is often difficult, and sometimes impossible, to fix a | |
673 terminal-dependent bug without access to a terminal of the type that | |
69800 | 674 stimulates the bug. |
25829 | 675 |
676 @item | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
677 If non-@acronym{ASCII} text or internationalization is relevant, the locale that |
36497
1ba3f8033b3a
(Checklist): Say that the example with LC_ALL and such is for a Unix shell.
Eli Zaretskii <eliz@gnu.org>
parents:
36388
diff
changeset
|
678 was current when you started Emacs. On GNU/Linux and Unix systems, or |
38865
62e02f5ae533
Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents:
38767
diff
changeset
|
679 if you use a Posix-style shell such as Bash, you can use this shell |
36497
1ba3f8033b3a
(Checklist): Say that the example with LC_ALL and such is for a Unix shell.
Eli Zaretskii <eliz@gnu.org>
parents:
36388
diff
changeset
|
680 command to view the relevant values: |
35239
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
681 |
37580
ac2f45ecf299
Use @smallexample for the echo LC... command.
Richard M. Stallman <rms@gnu.org>
parents:
37508
diff
changeset
|
682 @smallexample |
42117
bdf2f34631aa
Finish previous change.
Richard M. Stallman <rms@gnu.org>
parents:
42110
diff
changeset
|
683 echo LC_ALL=$LC_ALL LC_COLLATE=$LC_COLLATE LC_CTYPE=$LC_CTYPE \ |
37119
a4f474cb3812
(Checklist): Include more LC_* variables in the list, as suggested
Eli Zaretskii <eliz@gnu.org>
parents:
37087
diff
changeset
|
684 LC_MESSAGES=$LC_MESSAGES LC_TIME=$LC_TIME LANG=$LANG |
37580
ac2f45ecf299
Use @smallexample for the echo LC... command.
Richard M. Stallman <rms@gnu.org>
parents:
37508
diff
changeset
|
685 @end smallexample |
35239
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
686 |
37087
f4039f11318f
(Checklist): Mention the `locale' command as an alternative method of
Eli Zaretskii <eliz@gnu.org>
parents:
36791
diff
changeset
|
687 Alternatively, use the @command{locale} command, if your system has it, |
f4039f11318f
(Checklist): Mention the `locale' command as an alternative method of
Eli Zaretskii <eliz@gnu.org>
parents:
36791
diff
changeset
|
688 to display your locale settings. |
f4039f11318f
(Checklist): Mention the `locale' command as an alternative method of
Eli Zaretskii <eliz@gnu.org>
parents:
36791
diff
changeset
|
689 |
f4039f11318f
(Checklist): Mention the `locale' command as an alternative method of
Eli Zaretskii <eliz@gnu.org>
parents:
36791
diff
changeset
|
690 You can use the @kbd{M-!} command to execute these commands from |
35239
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
691 Emacs, and then copy the output from the @samp{*Messages*} buffer into |
36620
639ad3d05eb6
(Checklist): Mention that `getenv' can be used to get at the value
Eli Zaretskii <eliz@gnu.org>
parents:
36497
diff
changeset
|
692 the bug report. Alternatively, @kbd{M-x getenv @key{RET} LC_ALL |
38870
d44abb4e68b2
Don't use "print" for displaying a message.
Richard M. Stallman <rms@gnu.org>
parents:
38865
diff
changeset
|
693 @key{RET}} will display the value of @code{LC_ALL} in the echo area, and |
36620
639ad3d05eb6
(Checklist): Mention that `getenv' can be used to get at the value
Eli Zaretskii <eliz@gnu.org>
parents:
36497
diff
changeset
|
694 you can copy its output from the @samp{*Messages*} buffer. |
35239
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
695 |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
696 @item |
25829 | 697 A description of what behavior you observe that you believe is |
698 incorrect. For example, ``The Emacs process gets a fatal signal,'' or, | |
699 ``The resulting text is as follows, which I think is wrong.'' | |
700 | |
701 Of course, if the bug is that Emacs gets a fatal signal, then one can't | |
702 miss it. But if the bug is incorrect text, the maintainer might fail to | |
703 notice what is wrong. Why leave it to chance? | |
704 | |
705 Even if the problem you experience is a fatal signal, you should still | |
706 say so explicitly. Suppose something strange is going on, such as, your | |
707 copy of the source is out of sync, or you have encountered a bug in the | |
708 C library on your system. (This has happened!) Your copy might crash | |
709 and the copy here might not. If you @emph{said} to expect a crash, then | |
710 when Emacs here fails to crash, we would know that the bug was not | |
711 happening. If you don't say to expect a crash, then we would not know | |
712 whether the bug was happening---we would not be able to draw any | |
713 conclusion from our observations. | |
714 | |
715 @item | |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
716 If the bug is that the Emacs Manual or the Emacs Lisp Reference Manual |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
717 fails to describe the actual behavior of Emacs, or that the text is |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
718 confusing, copy in the text from the online manual which you think is |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
719 at fault. If the section is small, just the section name is enough. |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
720 |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
721 @item |
25829 | 722 If the manifestation of the bug is an Emacs error message, it is |
723 important to report the precise text of the error message, and a | |
724 backtrace showing how the Lisp program in Emacs arrived at the error. | |
725 | |
726 To get the error message text accurately, copy it from the | |
727 @samp{*Messages*} buffer into the bug report. Copy all of it, not just | |
728 part. | |
729 | |
37347
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
730 @findex toggle-debug-on-error |
37508
e2849d417d6d
(Checklist): Mention Edebug.
Eli Zaretskii <eliz@gnu.org>
parents:
37498
diff
changeset
|
731 @pindex Edebug |
37347
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
732 To make a backtrace for the error, use @kbd{M-x toggle-debug-on-error} |
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
733 before the error happens (that is to say, you must give that command |
69800 | 734 and then make the bug happen). This causes the error to start the Lisp |
37347
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
735 debugger, which shows you a backtrace. Copy the text of the |
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
736 debugger's backtrace into the bug report. @xref{Debugger,, The Lisp |
bd817d6f9ba3
Minor clarifications regarding DEL key.
Richard M. Stallman <rms@gnu.org>
parents:
37126
diff
changeset
|
737 Debugger, elisp, the Emacs Lisp Reference Manual}, for information on |
37508
e2849d417d6d
(Checklist): Mention Edebug.
Eli Zaretskii <eliz@gnu.org>
parents:
37498
diff
changeset
|
738 debugging Emacs Lisp programs with the Edebug package. |
25829 | 739 |
740 This use of the debugger is possible only if you know how to make the | |
741 bug happen again. If you can't make it happen again, at least copy | |
742 the whole error message. | |
743 | |
744 @item | |
745 Check whether any programs you have loaded into the Lisp world, | |
746 including your @file{.emacs} file, set any variables that may affect the | |
747 functioning of Emacs. Also, see whether the problem happens in a | |
748 freshly started Emacs without loading your @file{.emacs} file (start | |
749 Emacs with the @code{-q} switch to prevent loading the init file). If | |
750 the problem does @emph{not} occur then, you must report the precise | |
751 contents of any programs that you must load into the Lisp world in order | |
752 to cause the problem to occur. | |
753 | |
754 @item | |
755 If the problem does depend on an init file or other Lisp programs that | |
756 are not part of the standard Emacs system, then you should make sure it | |
757 is not a bug in those programs by complaining to their maintainers | |
758 first. After they verify that they are using Emacs in a way that is | |
759 supposed to work, they should report the bug. | |
760 | |
761 @item | |
762 If you wish to mention something in the GNU Emacs source, show the line | |
763 of code with a few lines of context. Don't just give a line number. | |
764 | |
765 The line numbers in the development sources don't match those in your | |
766 sources. It would take extra work for the maintainers to determine what | |
767 code is in your version at a given line number, and we could not be | |
768 certain. | |
769 | |
770 @item | |
771 Additional information from a C debugger such as GDB might enable | |
772 someone to find a problem on a machine which he does not have available. | |
773 If you don't know how to use GDB, please read the GDB manual---it is not | |
774 very long, and using GDB is easy. You can find the GDB distribution, | |
775 including the GDB manual in online form, in most of the same places you | |
776 can find the Emacs distribution. To run Emacs under GDB, you should | |
777 switch to the @file{src} subdirectory in which Emacs was compiled, then | |
778 do @samp{gdb emacs}. It is important for the directory @file{src} to be | |
779 current so that GDB will read the @file{.gdbinit} file in this | |
780 directory. | |
781 | |
782 However, you need to think when you collect the additional information | |
783 if you want it to show what causes the bug. | |
784 | |
785 @cindex backtrace for bug reports | |
786 For example, many people send just a backtrace, but that is not very | |
787 useful by itself. A simple backtrace with arguments often conveys | |
788 little about what is happening inside GNU Emacs, because most of the | |
789 arguments listed in the backtrace are pointers to Lisp objects. The | |
790 numeric values of these pointers have no significance whatever; all that | |
791 matters is the contents of the objects they point to (and most of the | |
792 contents are themselves pointers). | |
793 | |
794 @findex debug_print | |
795 To provide useful information, you need to show the values of Lisp | |
796 objects in Lisp notation. Do this for each variable which is a Lisp | |
797 object, in several stack frames near the bottom of the stack. Look at | |
798 the source to see which variables are Lisp objects, because the debugger | |
799 thinks of them as integers. | |
800 | |
801 To show a variable's value in Lisp syntax, first print its value, then | |
802 use the user-defined GDB command @code{pr} to print the Lisp object in | |
803 Lisp syntax. (If you must use another debugger, call the function | |
804 @code{debug_print} with the object as an argument.) The @code{pr} | |
805 command is defined by the file @file{.gdbinit}, and it works only if you | |
806 are debugging a running process (not with a core dump). | |
807 | |
808 To make Lisp errors stop Emacs and return to GDB, put a breakpoint at | |
809 @code{Fsignal}. | |
810 | |
27729 | 811 For a short listing of Lisp functions running, type the GDB |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46235
diff
changeset
|
812 command @code{xbacktrace}. |
27729 | 813 |
25829 | 814 The file @file{.gdbinit} defines several other commands that are useful |
815 for examining the data types and contents of Lisp objects. Their names | |
816 begin with @samp{x}. These commands work at a lower level than | |
817 @code{pr}, and are less convenient, but they may work even when | |
818 @code{pr} does not, such as when debugging a core dump or when Emacs has | |
819 had a fatal signal. | |
820 | |
35874
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
821 @cindex debugging Emacs, tricks and techniques |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
822 More detailed advice and other useful techniques for debugging Emacs |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
823 are available in the file @file{etc/DEBUG} in the Emacs distribution. |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
824 That file also includes instructions for investigating problems |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
825 whereby Emacs stops responding (many people assume that Emacs is |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
826 ``hung,'' whereas in fact it might be in an infinite loop). |
25829 | 827 |
38130
7aad2fda759d
Update how to find etc/DEBUG.
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
828 To find the file @file{etc/DEBUG} in your Emacs installation, use the |
7aad2fda759d
Update how to find etc/DEBUG.
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
829 directory name stored in the variable @code{data-directory}. |
25829 | 830 @end itemize |
831 | |
832 Here are some things that are not necessary in a bug report: | |
833 | |
834 @itemize @bullet | |
835 @item | |
836 A description of the envelope of the bug---this is not necessary for a | |
837 reproducible bug. | |
838 | |
839 Often people who encounter a bug spend a lot of time investigating | |
840 which changes to the input file will make the bug go away and which | |
841 changes will not affect it. | |
842 | |
843 This is often time-consuming and not very useful, because the way we | |
38130
7aad2fda759d
Update how to find etc/DEBUG.
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
844 will find the bug is by running a single example under the debugger |
7aad2fda759d
Update how to find etc/DEBUG.
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
845 with breakpoints, not by pure deduction from a series of examples. |
7aad2fda759d
Update how to find etc/DEBUG.
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
846 You might as well save time by not searching for additional examples. |
7aad2fda759d
Update how to find etc/DEBUG.
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
847 It is better to send the bug report right away, go back to editing, |
7aad2fda759d
Update how to find etc/DEBUG.
Richard M. Stallman <rms@gnu.org>
parents:
37976
diff
changeset
|
848 and find another bug to report. |
25829 | 849 |
850 Of course, if you can find a simpler example to report @emph{instead} of | |
851 the original one, that is a convenience. Errors in the output will be | |
852 easier to spot, running under the debugger will take less time, etc. | |
853 | |
854 However, simplification is not vital; if you can't do this or don't have | |
855 time to try, please report the bug with your original test case. | |
856 | |
857 @item | |
38230
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
858 A core dump file. |
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
859 |
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
860 Debugging the core dump might be useful, but it can only be done on |
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
861 your machine, with your Emacs executable. Therefore, sending the core |
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
862 dump file to the Emacs maintainers won't be useful. Above all, don't |
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
863 include the core file in an email bug report! Such a large message |
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
864 can be extremely inconvenient. |
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
865 |
ec2015ba505d
Explain why don't mail a core dump.
Richard M. Stallman <rms@gnu.org>
parents:
38130
diff
changeset
|
866 @item |
25829 | 867 A system-call trace of Emacs execution. |
868 | |
869 System-call traces are very useful for certain special kinds of | |
870 debugging, but in most cases they give little useful information. It is | |
871 therefore strange that many people seem to think that @emph{the} way to | |
872 report information about a crash is to send a system-call trace. Perhaps | |
873 this is a habit formed from experience debugging programs that don't | |
874 have source code or debugging symbols. | |
875 | |
876 In most programs, a backtrace is normally far, far more informative than | |
877 a system-call trace. Even in Emacs, a simple backtrace is generally | |
878 more informative, though to give full information you should supplement | |
879 the backtrace by displaying variable values and printing them as Lisp | |
880 objects with @code{pr} (see above). | |
881 | |
882 @item | |
883 A patch for the bug. | |
884 | |
885 A patch for the bug is useful if it is a good one. But don't omit the | |
886 other information that a bug report needs, such as the test case, on the | |
887 assumption that a patch is sufficient. We might see problems with your | |
888 patch and decide to fix the problem another way, or we might not | |
889 understand it at all. And if we can't understand what bug you are | |
890 trying to fix, or why your patch should be an improvement, we mustn't | |
891 install it. | |
892 | |
70757
756223adf885
(Checklist): ifinfo -> ifnottex.
Luc Teirlinck <teirllm@auburn.edu>
parents:
70439
diff
changeset
|
893 @ifnottex |
25829 | 894 @xref{Sending Patches}, for guidelines on how to make it easy for us to |
895 understand and install your patches. | |
70757
756223adf885
(Checklist): ifinfo -> ifnottex.
Luc Teirlinck <teirllm@auburn.edu>
parents:
70439
diff
changeset
|
896 @end ifnottex |
25829 | 897 |
898 @item | |
899 A guess about what the bug is or what it depends on. | |
900 | |
901 Such guesses are usually wrong. Even experts can't guess right about | |
902 such things without first using the debugger to find the facts. | |
903 @end itemize | |
904 | |
905 @node Sending Patches | |
906 @subsection Sending Patches for GNU Emacs | |
907 | |
908 @cindex sending patches for GNU Emacs | |
909 @cindex patches, sending | |
910 If you would like to write bug fixes or improvements for GNU Emacs, | |
911 that is very helpful. When you send your changes, please follow these | |
912 guidelines to make it easy for the maintainers to use them. If you | |
913 don't follow these guidelines, your information might still be useful, | |
914 but using it will take extra work. Maintaining GNU Emacs is a lot of | |
915 work in the best of circumstances, and we can't keep up unless you do | |
916 your best to help. | |
917 | |
918 @itemize @bullet | |
919 @item | |
920 Send an explanation with your changes of what problem they fix or what | |
921 improvement they bring about. For a bug fix, just include a copy of the | |
922 bug report, and explain why the change fixes the bug. | |
923 | |
924 (Referring to a bug report is not as good as including it, because then | |
925 we will have to look it up, and we have probably already deleted it if | |
926 we've already fixed the bug.) | |
927 | |
928 @item | |
929 Always include a proper bug report for the problem you think you have | |
930 fixed. We need to convince ourselves that the change is right before | |
931 installing it. Even if it is correct, we might have trouble | |
932 understanding it if we don't have a way to reproduce the problem. | |
933 | |
934 @item | |
935 Include all the comments that are appropriate to help people reading the | |
936 source in the future understand why this change was needed. | |
937 | |
938 @item | |
939 Don't mix together changes made for different reasons. | |
940 Send them @emph{individually}. | |
941 | |
942 If you make two changes for separate reasons, then we might not want to | |
943 install them both. We might want to install just one. If you send them | |
944 all jumbled together in a single set of diffs, we have to do extra work | |
945 to disentangle them---to figure out which parts of the change serve | |
946 which purpose. If we don't have time for this, we might have to ignore | |
947 your changes entirely. | |
948 | |
949 If you send each change as soon as you have written it, with its own | |
950 explanation, then two changes never get tangled up, and we can consider | |
951 each one properly without any extra work to disentangle them. | |
952 | |
953 @item | |
954 Send each change as soon as that change is finished. Sometimes people | |
955 think they are helping us by accumulating many changes to send them all | |
956 together. As explained above, this is absolutely the worst thing you | |
957 could do. | |
958 | |
959 Since you should send each change separately, you might as well send it | |
960 right away. That gives us the option of installing it immediately if it | |
961 is important. | |
962 | |
963 @item | |
964 Use @samp{diff -c} to make your diffs. Diffs without context are hard | |
965 to install reliably. More than that, they are hard to study; we must | |
966 always study a patch to decide whether we want to install it. Unidiff | |
967 format is better than contextless diffs, but not as easy to read as | |
968 @samp{-c} format. | |
969 | |
970 If you have GNU diff, use @samp{diff -c -F'^[_a-zA-Z0-9$]+ *('} when | |
971 making diffs of C code. This shows the name of the function that each | |
972 change occurs in. | |
973 | |
974 @item | |
975 Avoid any ambiguity as to which is the old version and which is the new. | |
976 Please make the old version the first argument to diff, and the new | |
977 version the second argument. And please give one version or the other a | |
978 name that indicates whether it is the old version or your new changed | |
979 one. | |
980 | |
981 @item | |
982 Write the change log entries for your changes. This is both to save us | |
983 the extra work of writing them, and to help explain your changes so we | |
984 can understand them. | |
985 | |
986 The purpose of the change log is to show people where to find what was | |
987 changed. So you need to be specific about what functions you changed; | |
988 in large functions, it's often helpful to indicate where within the | |
989 function the change was. | |
990 | |
991 On the other hand, once you have shown people where to find the change, | |
992 you need not explain its purpose in the change log. Thus, if you add a | |
993 new function, all you need to say about it is that it is new. If you | |
994 feel that the purpose needs explaining, it probably does---but put the | |
995 explanation in comments in the code. It will be more useful there. | |
996 | |
69800 | 997 Please read the @file{ChangeLog} files in the @file{src} and |
998 @file{lisp} directories to see what sorts of information to put in, | |
999 and to learn the style that we use. @xref{Change Log}. | |
25829 | 1000 |
1001 @item | |
1002 When you write the fix, keep in mind that we can't install a change that | |
1003 would break other systems. Please think about what effect your change | |
1004 will have if compiled on another type of system. | |
1005 | |
1006 Sometimes people send fixes that @emph{might} be an improvement in | |
1007 general---but it is hard to be sure of this. It's hard to install | |
1008 such changes because we have to study them very carefully. Of course, | |
1009 a good explanation of the reasoning by which you concluded the change | |
1010 was correct can help convince us. | |
1011 | |
1012 The safest changes are changes to the configuration files for a | |
1013 particular machine. These are safe because they can't create new bugs | |
1014 on other machines. | |
1015 | |
1016 Please help us keep up with the workload by designing the patch in a | |
1017 form that is clearly safe to install. | |
1018 @end itemize | |
1019 | |
1020 @node Contributing, Service, Bugs, Top | |
1021 @section Contributing to Emacs Development | |
1022 | |
1023 If you would like to help pretest Emacs releases to assure they work | |
1024 well, or if you would like to work on improving Emacs, please contact | |
60342
0f12295e50a4
(Contributing): Mention Savannah. Direct users to
Nick Roberts <nickrob@snap.net.nz>
parents:
60121
diff
changeset
|
1025 the maintainers at @email{emacs-devel@@gnu.org}. A pretester |
25829 | 1026 should be prepared to investigate bugs as well as report them. If you'd |
1027 like to work on improving Emacs, please ask for suggested projects or | |
1028 suggest your own ideas. | |
1029 | |
1030 If you have already written an improvement, please tell us about it. If | |
1031 you have not yet started work, it is useful to contact | |
60342
0f12295e50a4
(Contributing): Mention Savannah. Direct users to
Nick Roberts <nickrob@snap.net.nz>
parents:
60121
diff
changeset
|
1032 @email{emacs-devel@@gnu.org} before you start; it might be |
25829 | 1033 possible to suggest ways to make your extension fit in better with the |
1034 rest of Emacs. | |
1035 | |
60342
0f12295e50a4
(Contributing): Mention Savannah. Direct users to
Nick Roberts <nickrob@snap.net.nz>
parents:
60121
diff
changeset
|
1036 The development version of Emacs can be downloaded from the CVS |
0f12295e50a4
(Contributing): Mention Savannah. Direct users to
Nick Roberts <nickrob@snap.net.nz>
parents:
60121
diff
changeset
|
1037 repository where it is actively maintained by a group of developers. |
69800 | 1038 See the Emacs project page |
1039 @url{http://savannah.gnu.org/projects/emacs/} for details. | |
60342
0f12295e50a4
(Contributing): Mention Savannah. Direct users to
Nick Roberts <nickrob@snap.net.nz>
parents:
60121
diff
changeset
|
1040 |
56812
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
1041 @node Service, Copying, Contributing, Top |
25829 | 1042 @section How To Get Help with GNU Emacs |
1043 | |
1044 If you need help installing, using or changing GNU Emacs, there are two | |
1045 ways to find it: | |
1046 | |
1047 @itemize @bullet | |
1048 @item | |
1049 Send a message to the mailing list | |
29107 | 1050 @email{help-gnu-emacs@@gnu.org}, or post your request on |
25829 | 1051 newsgroup @code{gnu.emacs.help}. (This mailing list and newsgroup |
1052 interconnect, so it does not matter which one you use.) | |
1053 | |
1054 @item | |
1055 Look in the service directory for someone who might help you for a fee. | |
1056 The service directory is found in the file named @file{etc/SERVICE} in the | |
1057 Emacs distribution. | |
1058 @end itemize | |
52401 | 1059 |
56812
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
1060 @ifnottex |
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
1061 @lowersections |
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
1062 @end ifnottex |
16152de85a64
Adapt sectioning in Info to the node structure.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54478
diff
changeset
|
1063 |
52401 | 1064 @ignore |
1065 arch-tag: c9cba76d-b2cb-4e0c-ae3f-19d5ef35817c | |
1066 @end ignore |