Mercurial > emacs
annotate doc/misc/faq.texi @ 98705:af39dbfa0fda
*** empty log message ***
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Tue, 14 Oct 2008 11:39:50 +0000 |
parents | 9592c50233ab |
children | cb5d2387102c |
rev | line source |
---|---|
84296 | 1 \input texinfo @c -*- mode: texinfo; -*- |
2 @c %**start of header | |
84329
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84296
diff
changeset
|
3 @setfilename ../../info/efaq |
84296 | 4 @settitle GNU Emacs FAQ |
5 @c %**end of header | |
6 | |
7 @setchapternewpage odd | |
8 | |
9 @c This is used in many places | |
95940 | 10 @set VER 23.0.60 |
84296 | 11 |
12 @c This file is maintained by Romain Francoise <rfrancoise@gnu.org>. | |
13 @c Feel free to install changes without prior permission (but I'd | |
14 @c appreciate a notice if you do). | |
15 | |
16 @copying | |
87903 | 17 Copyright @copyright{} 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 |
84296 | 18 Free Software Foundation, Inc.@* |
19 Copyright 1994,1995,1996,1997,1998,1999,2000 Reuven M. Lerner@* | |
20 Copyright 1992,1993 Steven Byrnes@* | |
21 Copyright 1990,1991,1992 Joseph Brian Wells@* | |
22 | |
23 @quotation | |
24 This list of frequently asked questions about GNU Emacs with answers | |
25 (``FAQ'') may be translated into other languages, transformed into other | |
26 formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information. | |
27 | |
28 The same conditions apply to any derivative of the FAQ as apply to the FAQ | |
29 itself. Every copy of the FAQ must include this notice or an approved | |
30 translation, information on who is currently maintaining the FAQ and how to | |
31 contact them (including their e-mail address), and information on where the | |
32 latest version of the FAQ is archived (including FTP information). | |
33 | |
34 The FAQ may be copied and redistributed under these conditions, except that | |
35 the FAQ may not be embedded in a larger literary work unless that work | |
36 itself allows free copying and redistribution. | |
37 | |
38 [This version has been heavily edited since it was included in the Emacs | |
39 distribution.] | |
40 @end quotation | |
41 @end copying | |
42 | |
43 @dircategory Emacs | |
44 @direntry | |
45 * Emacs FAQ: (efaq). Frequently Asked Questions about Emacs. | |
46 @end direntry | |
47 | |
48 @c The @titlepage stuff only appears in the printed version | |
49 @titlepage | |
50 @sp 10 | |
51 @center @titlefont{GNU Emacs FAQ} | |
52 | |
53 @c The following two commands start the copyright page. | |
54 @page | |
55 @vskip 0pt plus 1filll | |
56 @insertcopying | |
57 @end titlepage | |
58 | |
59 @node Top, FAQ notation, (dir), (dir) | |
60 | |
61 This is the GNU Emacs FAQ, last updated on @today{}. | |
62 | |
63 This FAQ is maintained as a part of GNU Emacs. If you find any errors, | |
64 or have any suggestions, please use @kbd{M-x report-emacs-bug} to report | |
65 them. | |
66 | |
67 @menu | |
68 * FAQ notation:: | |
69 * General questions:: | |
70 * Getting help:: | |
71 * Status of Emacs:: | |
72 * Common requests:: | |
73 * Bugs and problems:: | |
74 * Compiling and installing Emacs:: | |
75 * Finding Emacs and related packages:: | |
76 * Major packages and programs:: | |
77 * Key bindings:: | |
78 * Alternate character sets:: | |
79 * Mail and news:: | |
80 * Concept index:: | |
81 @end menu | |
82 | |
83 @c ------------------------------------------------------------ | |
84 @node FAQ notation, General questions, Top, Top | |
85 @chapter FAQ notation | |
86 @cindex FAQ notation | |
87 | |
88 This chapter describes notation used in the GNU Emacs FAQ, as well as in | |
89 the Emacs documentation. Consult this section if this is the first time | |
90 you are reading the FAQ, or if you are confused by notation or terms | |
91 used in the FAQ. | |
92 | |
93 @menu | |
94 * Basic keys:: | |
95 * Extended commands:: | |
96 * On-line manual:: | |
97 * File-name conventions:: | |
98 * Common acronyms:: | |
99 @end menu | |
100 | |
101 @node Basic keys, Extended commands, FAQ notation, FAQ notation | |
102 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.? | |
103 @cindex Basic keys | |
104 @cindex Control key, notation for | |
105 @cindex @key{Meta} key, notation for | |
106 @cindex Control-Meta characters, notation for | |
107 @cindex @kbd{C-h}, definition of | |
108 @cindex @kbd{C-M-h}, definition of | |
109 @cindex @key{DEL}, definition of | |
110 @cindex @key{ESC}, definition of | |
111 @cindex @key{LFD}, definition of | |
112 @cindex @key{RET}, definition of | |
113 @cindex @key{SPC}, definition of | |
114 @cindex @key{TAB}, definition of | |
115 @cindex Notation for keys | |
116 | |
117 @itemize @bullet | |
118 | |
119 @item | |
120 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key | |
121 | |
122 @item | |
123 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key | |
124 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key}) | |
125 | |
126 @item | |
127 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control} | |
128 and @key{Meta} | |
129 | |
130 @item | |
131 @kbd{C-M-x}: a synonym for the above | |
132 | |
133 @item | |
134 @key{LFD}: Linefeed or Newline; same as @kbd{C-j} | |
135 | |
136 @item | |
137 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m} | |
138 | |
139 @item | |
140 @key{DEL}: @key{Delete}, usually @strong{not} the same as | |
141 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if | |
142 deleting invokes Emacs help) | |
143 | |
144 @item | |
145 @key{ESC}: Escape; same as @kbd{C-[} | |
146 | |
147 @item | |
148 @key{TAB}: Tab; same as @kbd{C-i} | |
149 | |
150 @item | |
151 @key{SPC}: Space bar | |
152 | |
153 @end itemize | |
154 | |
155 Key sequences longer than one key (and some single-key sequences) are | |
156 written inside quotes or on lines by themselves, like this: | |
157 | |
158 @display | |
159 @kbd{M-x frobnicate-while-foo RET} | |
160 @end display | |
161 | |
162 @noindent | |
163 Any real spaces in such a key sequence should be ignored; only @key{SPC} | |
164 really means press the space key. | |
165 | |
166 The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value | |
167 that would be sent by pressing just @key{x} minus 96 (or 64 for | |
168 upper-case @key{X}) and will be from 0 to 31. On Unix and GNU/Linux | |
169 terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the | |
170 @acronym{ASCII} code that would be sent by pressing just @key{x}. Essentially, | |
171 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit | |
172 7@footnote{ | |
173 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is | |
174 pressed.}. | |
175 | |
176 @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call | |
177 @kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON. | |
178 Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127. | |
179 | |
180 @inforef{Text Characters, Text Characters, emacs}, and @inforef{Keys, | |
181 Keys, emacs}, for more information. (@xref{On-line manual}, for more | |
182 information about Info.) | |
183 | |
184 @node Extended commands, On-line manual, Basic keys, FAQ notation | |
185 @section What does @file{M-x @var{command}} mean? | |
186 @cindex Extended commands | |
187 @cindex Commands, extended | |
188 @cindex M-x, meaning of | |
189 | |
190 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the | |
191 command, then type @key{RET}. (@xref{Basic keys}, if you're not sure | |
192 what @kbd{M-x} and @key{RET} mean.) | |
193 | |
194 @kbd{M-x} (by default) invokes the command | |
195 @code{execute-extended-command}. This command allows you to run any | |
196 Emacs command if you can remember the command's name. If you can't | |
197 remember the command's name, you can type @key{TAB} and @key{SPC} for | |
198 completion, @key{?} for a list of possibilities, and @kbd{M-p} and | |
199 @kbd{M-n} (or up-arrow and down-arrow on terminals that have these | |
200 editing keys) to see previous commands entered. An Emacs @dfn{command} | |
201 is an @dfn{interactive} Emacs function. | |
202 | |
203 @cindex @key{Do} key | |
204 Your system administrator may have bound other key sequences to invoke | |
205 @code{execute-extended-command}. A function key labeled @kbd{Do} is a | |
206 good candidate for this, on keyboards that have such a key. | |
207 | |
208 If you need to run non-interactive Emacs functions, see @ref{Evaluating | |
209 Emacs Lisp code}. | |
210 | |
211 @node On-line manual, File-name conventions, Extended commands, FAQ notation | |
212 @section How do I read topic XXX in the on-line manual? | |
213 @cindex On-line manual, reading topics in | |
214 @cindex Reading topics in the on-line manual | |
215 @cindex Finding topics in the on-line manual | |
216 @cindex Info, finding topics in | |
217 | |
218 When we refer you to some @var{topic} in the on-line manual, you can | |
219 read this manual node inside Emacs (assuming nothing is broken) by | |
220 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}. | |
221 | |
222 This invokes Info, the GNU hypertext documentation browser. If you don't | |
223 already know how to use Info, type @key{?} from within Info. | |
224 | |
225 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs | |
226 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}. | |
227 | |
228 If these commands don't work as expected, your system administrator may | |
229 not have installed the Info files, or may have installed them | |
230 improperly. In this case you should complain. | |
231 | |
232 @xref{Getting a printed manual}, if you would like a paper copy of the | |
233 Emacs manual. | |
234 | |
235 @node File-name conventions, Common acronyms, On-line manual, FAQ notation | |
236 @section What are @file{etc/SERVICE}, @file{src/config.h}, and @file{lisp/default.el}? | |
237 @cindex File-name conventions | |
238 @cindex Conventions for file names | |
239 @cindex Directories and files that come with Emacs | |
240 | |
241 These are files that come with Emacs. The Emacs distribution is divided | |
242 into subdirectories; the important ones are @file{etc}, @file{lisp}, and | |
243 @file{src}. | |
244 | |
245 If you use Emacs, but don't know where it is kept on your system, start | |
246 Emacs, then type @kbd{C-h v data-directory @key{RET}}. The directory | |
247 name displayed by this will be the full pathname of the installed | |
248 @file{etc} directory. (This full path is recorded in the Emacs variable | |
249 @code{data-directory}, and @kbd{C-h v} displays the value and the | |
250 documentation of a variable.) | |
251 | |
252 The location of your Info directory (i.e., where on-line documentation | |
253 is stored) is kept in the variable @code{Info-default-directory-list}. Use | |
254 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of | |
255 this variable, which will be a list of directory names. The last | |
256 directory in that list is probably where most Info files are stored. By | |
257 default, Info documentation is placed in @file{/usr/local/info}. | |
258 | |
259 Some of these files are available individually via FTP or e-mail; see | |
260 @ref{Informational files for Emacs}. They all are available in the | |
261 source distribution. Many of the files in the @file{etc} directory are | |
262 also available via the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} | |
263 (@kbd{M-x help-for-help}). | |
264 | |
265 Your system administrator may have removed the @file{src} directory and | |
266 many files from the @file{etc} directory. | |
267 | |
268 @node Common acronyms, , File-name conventions, FAQ notation | |
269 @section What are FSF, LPF, OSF, GNU, RMS, FTP, and GPL? | |
270 @cindex FSF, definition of | |
271 @cindex LPF, definition of | |
272 @cindex OSF, definition of | |
273 @cindex GNU, definition of | |
274 @cindex RMS, definition of | |
275 @cindex Stallman, Richard, acronym for | |
276 @cindex Richard Stallman, acronym for | |
277 @cindex FTP, definition of | |
278 @cindex GPL, definition of | |
279 @cindex Acronyms, definitions for | |
280 @cindex Common acronyms, definitions for | |
281 | |
282 @table @asis | |
283 | |
284 @item FSF | |
285 Free Software Foundation | |
286 | |
287 @item LPF | |
288 League for Programming Freedom | |
289 | |
290 @item OSF | |
291 Open Software Foundation | |
292 | |
293 @item GNU | |
294 GNU's Not Unix | |
295 | |
296 @item RMS | |
297 Richard Matthew Stallman | |
298 | |
299 @item FTP | |
300 File Transfer Protocol | |
301 | |
302 @item GPL | |
303 GNU General Public License | |
304 | |
305 @end table | |
306 | |
307 Avoid confusing the FSF, the LPF, and the OSF. The LPF opposes | |
308 look-and-feel copyrights and software patents. The FSF aims to make | |
309 high quality free software available for everyone. The OSF is a | |
310 consortium of computer vendors which develops commercial software for | |
311 Unix systems. | |
312 | |
313 The word ``free'' in the title of the Free Software Foundation refers to | |
314 ``freedom,'' not ``zero cost.'' Anyone can charge any price for | |
315 GPL-covered software that they want to. However, in practice, the | |
316 freedom enforced by the GPL leads to low prices, because you can always | |
317 get the software for less money from someone else, since everyone has | |
318 the right to resell or give away GPL-covered software. | |
319 | |
320 @c ------------------------------------------------------------ | |
321 @node General questions, Getting help, FAQ notation, Top | |
322 @chapter General questions | |
323 @cindex General questions | |
324 | |
325 This chapter contains general questions having to do with Emacs, the | |
326 Free Software Foundation, and related organizations. | |
327 | |
328 @menu | |
329 * The LPF:: | |
330 * Real meaning of copyleft:: | |
331 * Guidelines for newsgroup postings:: | |
332 * Newsgroup archives:: | |
333 * Reporting bugs:: | |
334 * Unsubscribing from Emacs lists:: | |
335 * Contacting the FSF:: | |
336 @end menu | |
337 | |
338 @node The LPF, Real meaning of copyleft, General questions, General questions | |
339 @section What is the LPF? | |
340 @cindex LPF, description of | |
341 @cindex League for Programming Freedom | |
342 @cindex Software patents, opposition to | |
343 @cindex Patents for software, opposition to | |
344 | |
345 The LPF opposes the expanding danger of software patents and | |
346 look-and-feel copyrights. To get more information, feel free to contact | |
347 the LPF via e-mail or otherwise. You may also contact | |
348 @email{jbw@@cs.bu.edu, Joe Wells}; he will be happy to talk to you | |
349 about the LPF. | |
350 | |
351 You can find more information about the LPF in the file @file{etc/LPF}. | |
352 More papers describing the LPF's views are available on the Internet and | |
353 also from @uref{http://lpf.ai.mit.edu/, the LPF home page}. | |
354 | |
355 @node Real meaning of copyleft, Guidelines for newsgroup postings, The LPF, General questions | |
356 @section What is the real legal meaning of the GNU copyleft? | |
357 @cindex Copyleft, real meaning of | |
358 @cindex GPL, real meaning of | |
359 @cindex General Public License, real meaning of | |
360 @cindex Discussion of the GPL | |
361 | |
362 The real legal meaning of the GNU General Public License (copyleft) will | |
363 only be known if and when a judge rules on its validity and scope. | |
364 There has never been a copyright infringement case involving the GPL to | |
365 set any precedents. Please take any discussion regarding this issue to | |
366 the newsgroup @uref{news:gnu.misc.discuss}, which was created to hold the | |
367 extensive flame wars on the subject. | |
368 | |
369 RMS writes: | |
370 | |
371 @quotation | |
372 The legal meaning of the GNU copyleft is less important than the spirit, | |
373 which is that Emacs is a free software project and that work pertaining | |
374 to Emacs should also be free software. ``Free'' means that all users | |
375 have the freedom to study, share, change and improve Emacs. To make | |
376 sure everyone has this freedom, pass along source code when you | |
377 distribute any version of Emacs or a related program, and give the | |
378 recipients the same freedom that you enjoyed. | |
379 @end quotation | |
380 | |
381 @node Guidelines for newsgroup postings, Newsgroup archives, Real meaning of copyleft, General questions | |
382 @section What are appropriate messages for @uref{news:gnu.emacs.help}, @uref{news:gnu.emacs.bug}, @uref{news:comp.emacs}, etc.? | |
383 @cindex Newsgroups, appropriate messages for | |
384 @cindex GNU newsgroups, appropriate messages for | |
385 @cindex Usenet groups, appropriate messages for | |
386 @cindex Mailing lists, appropriate messages for | |
387 @cindex Posting messages to newsgroups | |
388 | |
389 @cindex GNU mailing lists | |
390 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU | |
391 mailing list. (@xref{Informational files for Emacs}, if you want a copy | |
392 of the file.) For those lists which are gatewayed with newsgroups, it | |
393 lists both the newsgroup name and the mailing list address. | |
394 | |
395 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs | |
396 in general. This includes Emacs along with various other | |
397 implementations, such as XEmacs, JOVE, MicroEmacs, Freemacs, MG, | |
398 Unipress, CCA, and Epsilon. | |
399 | |
400 Many people post Emacs questions to @uref{news:comp.emacs} because they | |
401 don't receive any of the @code{gnu.*} newsgroups. Arguments have been | |
402 made both for and against posting GNU-Emacs-specific material to | |
403 @uref{news:comp.emacs}. You have to decide for yourself. | |
404 | |
405 Messages advocating ``non-free'' software are considered unacceptable on | |
406 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss}, | |
407 which was created to hold the extensive flame-wars on the subject. | |
408 ``Non-free'' software includes any software for which the end user can't | |
409 freely modify the source code and exchange enhancements. Be careful to | |
410 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when | |
411 posting a followup that recommends such software. | |
412 | |
413 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid | |
414 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}). | |
415 | |
416 @node Newsgroup archives, Reporting bugs, Guidelines for newsgroup postings, General questions | |
417 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups? | |
418 @cindex Archived postings from @code{gnu.emacs.help} | |
419 @cindex Usenet archives for GNU groups | |
420 @cindex Old Usenet postings for GNU groups | |
421 | |
422 The FSF has maintained archives of all of the GNU mailing lists for many | |
423 years, although there may be some unintentional gaps in coverage. The | |
424 archive is not particularly well organized or easy to retrieve | |
425 individual postings from, but pretty much everything is there. | |
426 | |
427 The archive is at @uref{ftp://lists.gnu.org/}. | |
428 | |
429 The archive can be browsed over the web at | |
430 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}. | |
431 | |
432 Web-based Usenet search services, such as | |
433 @uref{http://groups.google.com/groups/dir?sel=33592484, Google}, also | |
434 archive the @code{gnu.*} groups. | |
435 | |
436 You can read the archives of the @code{gnu.*} groups and post new | |
437 messages at @uref{http://gmane.org/, Gmane}. | |
438 | |
439 @node Reporting bugs, Unsubscribing from Emacs lists, Newsgroup archives, General questions | |
440 @section Where should I report bugs and other problems with Emacs? | |
441 @cindex Bug reporting | |
442 @cindex Good bug reports | |
443 @cindex How to submit a bug report | |
444 @cindex Reporting bugs | |
445 | |
446 The correct way to report Emacs bugs is to use the command | |
447 @kbd{M-x report-emacs-bug}. It sets up a mail buffer with the | |
448 essential information and the correct e-mail address which is | |
449 @email{bug-gnu-emacs@@gnu.org} for the released versions of Emacs. | |
450 Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the | |
451 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of | |
452 news to submit the bug report. This ensures a reliable return address | |
453 so you can be contacted for further details. | |
454 | |
455 Be sure to read the ``Bugs'' section of the Emacs manual before reporting | |
456 a bug! The manual describes in detail how to submit a useful bug | |
457 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}). | |
458 (@xref{On-line manual}, if you don't know how to read the manual.) | |
459 | |
460 RMS says: | |
461 | |
462 @quotation | |
463 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the | |
464 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because | |
465 it takes the time of an unnecessarily large group of people, most of | |
466 whom are just users and have no idea how to fix these problem. | |
467 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people | |
468 who are more likely to know what to do and have expressed a wish to | |
469 receive more messages about Emacs than the others. | |
470 @end quotation | |
471 | |
472 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}: | |
473 | |
474 @quotation | |
475 If you have reported a bug and you don't hear about a possible fix, | |
476 then after a suitable delay (such as a week) it is okay to post on | |
477 @code{gnu.emacs.help} asking if anyone can help you. | |
478 @end quotation | |
479 | |
480 If you are unsure whether you have found a bug, consider the following | |
481 non-exhaustive list, courtesy of RMS: | |
482 | |
483 @quotation | |
484 If Emacs crashes, that is a bug. If Emacs gets compilation errors | |
485 while building, that is a bug. If Emacs crashes while building, that | |
486 is a bug. If Lisp code does not do what the documentation says it | |
487 does, that is a bug. | |
488 @end quotation | |
489 | |
490 @node Unsubscribing from Emacs lists, Contacting the FSF, Reporting bugs, General questions | |
491 @section How do I unsubscribe from this mailing list? | |
492 @cindex Unsubscribing from GNU mailing lists | |
493 @cindex Removing yourself from GNU mailing lists | |
494 | |
495 If you are receiving a GNU mailing list named @var{list}, you might be | |
496 able to unsubscribe from it by sending a request to the address | |
497 @email{@var{list}-request@@gnu.org}. However, this will not work if you are | |
498 not listed on the main mailing list, but instead receive the mail from a | |
499 distribution point. In that case, you will have to track down at which | |
500 distribution point you are listed. Inspecting the @samp{Received} headers | |
501 on the mail messages may help, along with liberal use of the @samp{EXPN} or | |
502 @samp{VRFY} sendmail commands through @samp{telnet @var{site-address} | |
503 smtp}. Ask your postmaster for help, if you cannot figure out these | |
504 details. | |
505 | |
506 @node Contacting the FSF, , Unsubscribing from Emacs lists, General questions | |
507 @section What is the current address of the FSF? | |
508 @cindex Snail mail address of the FSF | |
509 @cindex Postal address of the FSF | |
510 @cindex Contracting the FSF | |
511 @cindex Free Software Foundation, contacting | |
512 | |
513 @table @asis | |
514 | |
515 @item E-mail | |
516 gnu@@gnu.org | |
517 | |
518 @item Telephone | |
519 +1-617-542-5942 | |
520 | |
521 @item Fax | |
522 +1-617-542-2652 | |
523 | |
524 @item World Wide Web | |
525 @uref{http://www.gnu.org/} | |
526 | |
527 @item Postal address | |
528 Free Software Foundation@* | |
529 51 Franklin Street, Fifth Floor@* | |
530 Boston, MA 02110-1301@* | |
531 USA@* | |
532 | |
533 @end table | |
534 | |
535 @cindex Ordering GNU software | |
536 For details on how to order items directly from the FSF, see the | |
537 @uref{http://www.gnu.org/order/order.html, GNU Web site}. | |
538 | |
539 @c ------------------------------------------------------------ | |
540 @node Getting help, Status of Emacs, General questions, Top | |
541 @chapter Getting help | |
542 @cindex Getting help | |
543 | |
544 This chapter tells you how to get help with Emacs | |
545 | |
546 @menu | |
547 * Basic editing:: | |
548 * Learning how to do something:: | |
549 * Getting a printed manual:: | |
550 * Emacs Lisp documentation:: | |
551 * Installing Texinfo documentation:: | |
552 * Printing a Texinfo file:: | |
553 * Viewing Info files outside of Emacs:: | |
554 * Informational files for Emacs:: | |
555 * Help installing Emacs:: | |
556 * Obtaining the FAQ:: | |
557 @end menu | |
558 | |
559 @node Basic editing, Learning how to do something, Getting help, Getting help | |
560 @section I'm just starting Emacs; how do I do basic editing? | |
561 @cindex Basic editing with Emacs | |
562 @cindex Beginning editing | |
563 @cindex Tutorial, invoking the | |
564 @cindex Self-paced tutorial, invoking the | |
565 @cindex Help system, entering the | |
566 | |
567 Type @kbd{C-h t} to invoke the self-paced tutorial. Just typing | |
568 @kbd{C-h} enters the help system. Starting with Emacs 22, the tutorial | |
569 is available in many foreign languages such as French, German, Japanese, | |
570 Russian, etc. Use @kbd{M-x help-with-tutorial-spec-language @key{RET}} | |
571 to choose your language and start the tutorial. | |
572 | |
573 Your system administrator may have changed @kbd{C-h} to act like | |
574 @key{DEL} to deal with local keyboards. You can use @kbd{M-x | |
575 help-for-help} instead to invoke help. To discover what key (if any) | |
576 invokes help on your system, type @kbd{M-x where-is @key{RET} | |
577 help-for-help @key{RET}}. This will print a comma-separated list of key | |
578 sequences in the echo area. Ignore the last character in each key | |
579 sequence listed. Each of the resulting key sequences invokes help. | |
580 | |
581 Emacs help works best if it is invoked by a single key whose value | |
582 should be stored in the variable @code{help-char}. | |
583 | |
584 @node Learning how to do something, Getting a printed manual, Basic editing, Getting help | |
585 @section How do I find out how to do something in Emacs? | |
586 @cindex Help for Emacs | |
587 @cindex Learning to do something in Emacs | |
588 @cindex Reference card for Emacs | |
589 @cindex Overview of help systems | |
590 | |
591 There are several methods for finding out how to do things in Emacs. | |
592 | |
593 @itemize @bullet | |
594 | |
595 @cindex Reading the Emacs manual | |
596 @item | |
597 The complete text of the Emacs manual is available on-line via the Info | |
598 hypertext reader. Type @kbd{C-h r} to display the manual in Info mode. | |
599 Typing @key{h} immediately after entering Info will provide a short | |
600 tutorial on how to use it. | |
601 | |
602 @cindex Lookup a subject in a manual | |
603 @cindex Index search in a manual | |
604 @item | |
605 To quickly locate the section of the manual which discusses a certain | |
606 issue, or describes a command or a variable, type @kbd{C-h i m emacs | |
607 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the | |
608 topic, the command, or the variable which you are looking for. If this | |
609 does not land you on the right place in the manual, press @kbd{,} | |
610 (comma) repeatedly until you find what you need. (The @kbd{i} and | |
611 @kbd{,} keys invoke the index-searching functions, which look for the | |
612 @var{topic} you type in all the indices of the Emacs manual.) | |
613 | |
614 @cindex Apropos | |
615 @item | |
616 You can list all of the commands whose names contain a certain word | |
617 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x | |
618 command-apropos}). | |
619 | |
620 @cindex Command description in the manual | |
621 @item | |
622 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts | |
623 for the name of a command, and then attempts to find the section in the | |
624 Emacs manual where that command is described. | |
625 | |
626 @cindex Finding commands and variables | |
627 @item | |
628 You can list all of the functions and variables whose names contain a | |
629 certain word using @kbd{M-x apropos}. | |
630 | |
631 @item | |
632 You can list all of the functions and variables whose documentation | |
633 matches a regular expression or a string, using @kbd{M-x | |
634 apropos-documentation}. | |
635 | |
636 @item | |
637 You can order a hardcopy of the manual from the FSF. @xref{Getting a | |
638 printed manual}. | |
639 | |
640 @cindex Reference cards, in other languages | |
641 @item | |
642 You can get a printed reference card listing commands and keys to | |
643 invoke them. You can order one from the FSF for $1 (or 10 for $5), | |
644 or you can print your own from the @file{etc/refcards/refcard.tex} or | |
645 @file{etc/refcards/refcard.ps} files in the Emacs distribution. | |
646 Beginning with version 21.1, the Emacs distribution comes with | |
647 translations of the reference card into several languages; look for | |
648 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang} | |
649 is a two-letter code of the language. For example, the German version | |
650 of the reference card is in the files @file{etc/refcards/de-refcard.tex} | |
651 and @file{etc/recards/de-refcard.ps}. | |
652 | |
653 @item | |
654 There are many other commands in Emacs for getting help and | |
655 information. To get a list of these commands, type @samp{?} after | |
656 @kbd{C-h}. | |
657 | |
658 @end itemize | |
659 | |
660 @node Getting a printed manual, Emacs Lisp documentation, Learning how to do something, Getting help | |
661 @section How do I get a printed copy of the Emacs manual? | |
662 @cindex Printed Emacs manual, obtaining | |
663 @cindex Manual, obtaining a printed or HTML copy of | |
664 @cindex Emacs manual, obtaining a printed or HTML copy of | |
665 | |
666 You can order a printed copy of the Emacs manual from the FSF. For | |
667 details see the @uref{http://www.gnu.org/order/order.html, GNU Web site}. | |
668 | |
669 @c The number 620 below is version-dependent! | |
670 The full Texinfo source for the manual also comes in the @file{man} | |
671 directory of the Emacs distribution, if you're daring enough to try to | |
672 print out this 620-page manual yourself (@pxref{Printing a Texinfo | |
673 file}). | |
674 | |
675 If you absolutely have to print your own copy, and you don't have @TeX{}, | |
676 you can get a PostScript version from | |
677 | |
678 @uref{http://www.gnu.org/software/emacs/manual/emacs.ps.gz} | |
679 | |
680 @cindex HTML version of Emacs manual, obtaining | |
681 An HTML version of the manual is at | |
682 | |
683 @uref{http://www.gnu.org/software/emacs/manual/emacs.html} | |
684 | |
685 The manual is available in other formats at | |
686 | |
687 @uref{http://www.gnu.org/software/emacs/manual/} | |
688 | |
689 @xref{Learning how to do something}, for how to view the manual on-line. | |
690 | |
691 @node Emacs Lisp documentation, Installing Texinfo documentation, Getting a printed manual, Getting help | |
692 @section Where can I get documentation on Emacs Lisp? | |
693 @cindex Documentation on Emacs Lisp | |
694 @cindex Function documentation | |
695 @cindex Variable documentation | |
696 @cindex Emacs Lisp Reference Manual | |
697 @cindex Reference manual for Emacs Lisp | |
698 | |
699 Within Emacs, you can type @kbd{C-h f} to get the documentation for a | |
700 function, @kbd{C-h v} for a variable. | |
701 | |
702 For more information, the Emacs Lisp Reference Manual is available | |
703 on-line, in Info format. @xref{Top, Emacs Lisp,, elisp, The | |
704 Emacs Lisp Reference Manual}. | |
705 | |
706 You can also order a hardcopy of the manual, details on ordering it from | |
707 FSF are on the @uref{http://www.gnu.org/order/order.html, GNU Web site}. | |
708 | |
709 An HTML version of the Emacs Lisp Reference Manual is available at | |
710 | |
711 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html} | |
712 | |
713 @node Installing Texinfo documentation, Printing a Texinfo file, Emacs Lisp documentation, Getting help | |
714 @section How do I install a piece of Texinfo documentation? | |
715 @cindex Texinfo documentation, installing | |
716 @cindex Installing Texinfo documentation | |
717 @cindex New Texinfo files, installing | |
718 @cindex Documentation, installing new Texinfo files | |
719 @cindex Info files, how to install | |
720 | |
721 First, you must turn the Texinfo files into Info files. You may do this | |
722 using the stand-alone @file{makeinfo} program, available as part of the latest | |
723 Texinfo package at | |
724 | |
725 @uref{ftp://ftp.gnu.org/pub/gnu/texinfo/texinfo-4.8.tar.gz} | |
726 | |
727 and all mirrors of @samp{ftp.gnu.org} (for a list, @pxref{Current GNU | |
728 distributions}). | |
729 | |
730 For information about the Texinfo format, read the Texinfo manual which | |
731 comes with the Texinfo package. This manual also comes installed in | |
732 Info format, so you can read it on-line; type @kbd{C-h i m texinfo | |
733 @key{RET}}. | |
734 | |
735 Alternatively, you could use the Emacs command @kbd{M-x | |
736 texinfo-format-buffer}, after visiting the Texinfo source file of the | |
737 manual you want to convert. | |
738 | |
739 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the | |
740 resulting Info files in Emacs's Info tree. To install Info files, | |
741 perform these steps: | |
742 | |
743 @enumerate | |
744 @item | |
745 Move the files to the @file{info} directory in the installed Emacs | |
746 distribution. @xref{File-name conventions}, if you don't know where that | |
747 is. | |
748 | |
749 @item | |
750 Run the @code{install-info} command, which is part of the Texinfo | |
751 distribution, to update the main Info directory menu, like this: | |
752 | |
753 @example | |
754 install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file} | |
755 @end example | |
756 | |
757 @noindent | |
758 where @var{dir-path} is the full path to the directory where you copied | |
759 the produced Info file(s), and @var{file} is the name of the Info file | |
760 you produced and want to install. | |
761 | |
762 If you don't have the @code{install-info} command installed, you can | |
763 edit the file @file{info/dir} in the installed Emacs distribution, and | |
764 add a line for the top level node in the Info package that you are | |
765 installing. Follow the examples already in this file. The format is: | |
766 | |
767 @example | |
768 * Topic: (relative-pathname). Short description of topic. | |
769 @end example | |
770 | |
771 @end enumerate | |
772 | |
773 If you want to install Info files and you don't have the necessary | |
774 privileges, you have several options: | |
775 | |
776 @itemize @bullet | |
777 @item | |
778 Info files don't actually need to be installed before being used. | |
779 You can use a prefix argument for the @code{info} command and specify | |
780 the name of the Info file in the minibuffer. This goes to the node | |
781 named @samp{Top} in that file. For example, to view a Info file named | |
782 @file{@var{info-file}} in your home directory, you can type this: | |
783 | |
784 @example | |
785 @kbd{C-u C-h i ~/@var{info-file} @key{RET}} | |
786 @end example | |
787 | |
788 Alternatively, you can feed a file name to the @code{Info-goto-node} | |
789 command (invoked by pressing @key{g} in Info mode) by typing the name | |
790 of the file in parentheses, like this: | |
791 | |
792 @example | |
793 @kbd{C-h i g (~/@var{info-file}) @key{RET}} | |
794 @end example | |
795 | |
796 @item | |
797 You can create your own Info directory. You can tell Emacs where that | |
798 Info directory is by adding its pathname to the value of the variable | |
799 @code{Info-default-directory-list}. For example, to use a private Info | |
800 directory which is a subdirectory of your home directory named @file{Info}, | |
801 you could put this in your @file{.emacs} file: | |
802 | |
803 @lisp | |
804 (setq Info-default-directory-list | |
805 (cons "~/Info" Info-default-directory-list)) | |
806 @end lisp | |
807 | |
808 You will need a top-level Info file named @file{dir} in this directory | |
809 which has everything the system @file{dir} file has in it, except it should | |
810 list only entries for Info files in that directory. You might not need | |
811 it if all files in this directory were referenced by other @file{dir} | |
812 files. The node lists from all @file{dir} files in | |
813 @code{Info-default-directory-list} are merged by the Info system. | |
814 | |
815 @end itemize | |
816 | |
817 @node Printing a Texinfo file, Viewing Info files outside of Emacs, Installing Texinfo documentation, Getting help | |
818 @section How do I print a Texinfo file? | |
819 @cindex Printing a Texinfo file | |
820 @cindex Texinfo file, printing | |
821 @cindex Printing documentation | |
822 | |
823 You can't get nicely printed output from Info files; you must still have | |
824 the original Texinfo source file for the manual you want to print. | |
825 | |
826 Assuming you have @TeX{} installed on your system, follow these steps: | |
827 | |
828 @enumerate | |
829 | |
830 @item | |
831 Make sure the first line of the Texinfo file looks like this: | |
832 | |
833 @example | |
834 \input texinfo | |
835 @end example | |
836 | |
837 You may need to change @samp{texinfo} to the full pathname of the | |
838 @file{texinfo.tex} file, which comes with Emacs as | |
84329
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84296
diff
changeset
|
839 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory). |
84296 | 840 |
841 @item | |
842 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is | |
843 the name of the Texinfo source file for which you want to produce a | |
844 printed copy. | |
845 | |
846 The @samp{texi2dvi} script is part of the GNU Texinfo distribution | |
847 (@pxref{Installing Texinfo documentation}). | |
848 | |
849 @item | |
850 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for | |
851 printing DVI files at your site. For example, if you have a PostScript | |
852 printer, run the @code{dvips} program to print the DVI file on that | |
853 printer. | |
854 | |
855 @end enumerate | |
856 | |
857 To get more general instructions, retrieve the latest Texinfo package | |
858 (@pxref{Installing Texinfo documentation}). | |
859 | |
860 @node Viewing Info files outside of Emacs, Informational files for Emacs, Printing a Texinfo file, Getting help | |
861 @section Can I view Info files without using Emacs? | |
862 @cindex Viewing Info files | |
863 @cindex Info file viewers | |
864 @cindex Alternative Info file viewers | |
865 | |
866 Yes. Here are some alternative programs: | |
867 | |
868 @itemize @bullet | |
869 | |
870 @item | |
871 @code{info}, a stand-alone version of the Info program, comes as part of | |
872 the Texinfo package. @xref{Installing Texinfo documentation}, for | |
873 details. | |
874 | |
875 @item | |
876 Xinfo, a stand-alone version of the Info program that runs under X | |
877 Window system. You can get it at | |
878 @uref{ftp://ftp.gnu.org/pub/gnu/xinfo/xinfo-1.01.01.tar.gz} and all | |
879 mirrors of @samp{ftp.gnu.org} (see @ref{Current GNU distributions}, for a | |
880 list of mirrors). | |
881 | |
882 @item | |
883 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk. | |
884 You can get Tkinfo at | |
885 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}. | |
886 | |
887 @end itemize | |
888 | |
889 @node Informational files for Emacs, Help installing Emacs, Viewing Info files outside of Emacs, Getting help | |
890 @section What informational files are available for Emacs? | |
891 @cindex Informational files included with Emacs | |
892 @cindex Files included with Emacs | |
893 @cindex @file{COPYING}, description of file | |
894 @cindex @file{DISTRIB}, description of file | |
895 @cindex @file{FTP}, description of file | |
896 @cindex @file{GNU}, description of file | |
897 @cindex @file{INTERVIEW}, description of file | |
898 @cindex @file{LPF}, description of file | |
899 @cindex @file{MACHINES}, description of file | |
900 @cindex @file{MAILINGLISTS}, description of file | |
901 @cindex @file{NEWS}, description of file | |
902 @cindex @file{SERVICE}, description of file | |
903 @cindex @file{SUN-SUPPORT}, description of file | |
904 | |
905 This isn't a frequently asked question, but it should be! A variety of | |
906 informational files about Emacs and relevant aspects of the GNU project | |
907 are available for you to read. | |
908 | |
909 The following files are available in the @file{etc} directory of the | |
910 Emacs distribution (see @ref{File-name conventions}, if you're not sure | |
911 where that is). | |
912 | |
913 @table @file | |
914 | |
915 @item COPYING | |
916 GNU General Public License | |
917 | |
918 @item DISTRIB | |
919 Emacs Availability Information, including the popular Free Software | |
920 Foundation Order Form | |
921 | |
922 @item FTP | |
923 How to get GNU Software by Internet FTP or by UUCP | |
924 | |
925 @item GNU | |
926 The GNU Manifesto | |
927 | |
928 @item INTERVIEW | |
929 Richard Stallman discusses his public-domain UNIX-compatible software | |
930 system with BYTE editors | |
931 | |
932 @item LPF | |
933 Why you should join the League for Programming Freedom | |
934 | |
935 @item MACHINES | |
936 Status of Emacs on Various Machines and Systems | |
937 | |
938 @item MAILINGLISTS | |
939 GNU Project Electronic Mailing Lists | |
940 | |
941 @item NEWS | |
942 Emacs news, a history of recent user-visible changes | |
943 | |
944 @item SERVICE | |
945 GNU Service Directory | |
946 | |
947 @item SUN-SUPPORT | |
948 including ``Using Emacstool with GNU Emacs'' | |
949 | |
950 @end table | |
951 | |
952 More GNU information, including back issues of the @cite{GNU's | |
953 Bulletin}, are at | |
954 | |
955 @uref{http://www.gnu.org/bulletins/bulletins.html} and | |
956 | |
957 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html} | |
958 | |
959 @node Help installing Emacs, Obtaining the FAQ, Informational files for Emacs, Getting help | |
960 @section Where can I get help in installing Emacs? | |
961 @cindex Installation help | |
962 @cindex Help installing Emacs | |
963 | |
964 @xref{Installing Emacs}, for some basic installation hints, and see | |
965 @ref{Problems building Emacs}, or @ref{Linking with -lX11 fails}, if you | |
966 have problems with the installation. | |
967 | |
968 The file @file{etc/SERVICE} (see @ref{File-name conventions}, if you're | |
969 not sure where that is) lists companies and individuals willing to sell | |
970 you help in installing or using Emacs. An up-to-date version this file | |
971 is available on @samp{ftp.gnu.org} (@pxref{Informational files for | |
972 Emacs}). | |
973 | |
974 @node Obtaining the FAQ, , Help installing Emacs, Getting help | |
975 @section Where can I get the latest version of this FAQ? | |
976 @cindex FAQ, obtaining the | |
977 @cindex Latest FAQ version, obtaining the | |
978 @cindex Retrieving the latest FAQ version | |
979 @cindex E-mail, retrieving the FAQ via | |
980 @cindex Web, reading the FAQ on the | |
981 | |
982 The Emacs FAQ is available in several ways: | |
983 | |
984 @itemize @bullet | |
985 | |
986 @item | |
987 Inside of Emacs itself. You can get it from selecting the @samp{Emacs | |
988 FAQ} option from the @samp{Help} menu of the Emacs menu bar at the top | |
989 of any Emacs frame, or by typing @kbd{C-h C-f} (@kbd{M-x view-emacs-FAQ}). | |
990 | |
991 @item | |
992 Via USENET. If you can read news, the FAQ should be available in your | |
993 news spool, in both the @uref{news:gnu.emacs.help} and | |
994 @uref{news:comp.emacs} newsgroups. Every news reader should allow you | |
995 to read any news article that is still in the news spool, even if you | |
996 have read the article before. You may need to read the instructions for | |
997 your news reader to discover how to do this. In @file{rn}, this command | |
998 will do this for you at the article selection level: | |
999 | |
1000 @example | |
1001 ?GNU Emacs Frequently Asked Questions?rc:m | |
1002 @end example | |
1003 | |
1004 In Gnus, you should type @kbd{C-u C-x C-s} from the @file{*Summary*} | |
1005 buffer or @kbd{C-u @key{SPC}} from the @file{*Newsgroup*} buffer to view | |
1006 all articles in a newsgroup. | |
1007 | |
1008 If the FAQ articles have expired and have been deleted from your news | |
1009 spool, it might (or might not) do some good to complain to your news | |
1010 administrator, because the most recent FAQ should not expire for a | |
1011 while. | |
1012 | |
1013 @item | |
1014 In the Emacs distribution. Since Emacs 18.56, the FAQ at the time | |
1015 of release has been part of the Emacs distribution as either | |
84329
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84296
diff
changeset
|
1016 @file{etc/FAQ}, @file{man/faq.texi}, or (from version 23 onwards) |
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84296
diff
changeset
|
1017 @file{doc/misc/faq.texi} (@pxref{File-name conventions}). |
84296 | 1018 |
1019 @item | |
1020 Via anonymous ftp and e-mail from @file{rtfm.mit.edu} (and its mirror in | |
1021 Europe), the main repository for FAQs and other items posted to | |
1022 news.answers. The Emacs FAQs are available at | |
1023 | |
1024 @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/} and | |
1025 | |
1026 @uref{ftp://ftp.uni-paderborn.de/pub/doc/FAQ/comp/emacs/} | |
1027 | |
1028 If you do not have access to anonymous FTP, you can access the archives | |
1029 using the @file{rtfm.mit.edu} mail server. The Emacs FAQ can be | |
1030 retrieved by sending mail to @email{mail-server@@rtfm.mit.edu} with a | |
1031 blank subject and containing | |
1032 | |
1033 @example | |
1034 send usenet/news.answers/GNU-Emacs-FAQ/diffs | |
1035 send usenet/news.answers/GNU-Emacs-FAQ/part1 | |
1036 send usenet/news.answers/GNU-Emacs-FAQ/part2 | |
1037 send usenet/news.answers/GNU-Emacs-FAQ/part3 | |
1038 send usenet/news.answers/GNU-Emacs-FAQ/part4 | |
1039 send usenet/news.answers/GNU-Emacs-FAQ/part5 | |
1040 @end example | |
1041 | |
1042 For more information, send email to @email{mail-server@@rtfm.mit.edu} | |
1043 with @samp{help} and @samp{index} in the body on separate lines. | |
1044 @end itemize | |
1045 | |
1046 @c ------------------------------------------------------------ | |
1047 @node Status of Emacs, Common requests, Getting help, Top | |
1048 @chapter Status of Emacs | |
1049 @cindex Status of Emacs | |
1050 | |
1051 This chapter gives you basic information about Emacs, including its | |
1052 latest version status. | |
1053 | |
1054 @menu | |
1055 * Origin of the term Emacs:: | |
1056 * Latest version of Emacs:: | |
1057 * New in Emacs 20:: | |
1058 * New in Emacs 21:: | |
1059 * New in Emacs 22:: | |
1060 @end menu | |
1061 | |
1062 @node Origin of the term Emacs, Latest version of Emacs, Status of Emacs, Status of Emacs | |
1063 @section Where does the name ``Emacs'' come from? | |
1064 @cindex Origin of the term ``Emacs'' | |
1065 @cindex Emacs name origin | |
1066 @cindex TECO | |
1067 @cindex Original version of Emacs | |
1068 | |
1069 Emacs originally was an acronym for Editor MACroS. RMS says he ``picked | |
1070 the name Emacs because @key{E} was not in use as an abbreviation on ITS at | |
1071 the time.'' The first Emacs was a set of macros written in 1976 at MIT | |
1072 by RMS for the editor TECO (Text Editor and COrrector, originally Tape | |
1073 Editor and COrrector) under ITS on a PDP-10. RMS had already extended | |
1074 TECO with a ``real-time'' full-screen mode with reprogrammable keys. | |
1075 Emacs was started by @email{gls@@east.sun.com, Guy Steele} as a project | |
1076 to unify the many divergent TECO command sets and key bindings at MIT, | |
1077 and completed by RMS. | |
1078 | |
1079 Many people have said that TECO code looks a lot like line noise; you | |
1080 can read more at @uref{news:alt.lang.teco}. Someone has written a TECO | |
1081 implementation in Emacs Lisp (to find it, see @ref{Packages that do not | |
1082 come with Emacs}); it would be an interesting project to run the | |
1083 original TECO Emacs inside of Emacs. | |
1084 | |
1085 @cindex Why Emacs? | |
1086 For some not-so-serious alternative reasons for Emacs to have that | |
1087 name, check out the file @file{etc/JOKES} (@pxref{File-name | |
1088 conventions}). | |
1089 | |
1090 @node Latest version of Emacs, New in Emacs 20, Origin of the term Emacs, Status of Emacs | |
1091 @section What is the latest version of Emacs? | |
1092 @cindex Version, latest | |
1093 @cindex Latest version of Emacs | |
1094 | |
1095 Emacs @value{VER} is the current version as of this writing. | |
1096 | |
1097 @node New in Emacs 20, New in Emacs 21, Latest version of Emacs, Status of Emacs | |
1098 @section What is different about Emacs 20? | |
1099 @cindex Differences between Emacs 19 and Emacs 20 | |
1100 @cindex Emacs 20, new features in | |
1101 | |
1102 To find out what has changed in recent versions, type @kbd{C-h C-n} | |
1103 (@kbd{M-x view-emacs-news}). The oldest changes are at the bottom of | |
1104 the file, so you might want to read it starting there, rather than at | |
1105 the top. | |
1106 | |
1107 The differences between Emacs versions 18 and 19 was rather dramatic; | |
1108 the introduction of frames, faces, and colors on windowing systems was | |
1109 obvious to even the most casual user. | |
1110 | |
1111 There are differences between Emacs versions 19 and 20 as well, but many | |
1112 are more subtle or harder to find. Among the changes are the inclusion | |
1113 of MULE code for languages that use non-Latin characters and for mixing | |
1114 several languages in the same document; the ``Customize'' facility for | |
1115 modifying variables without having to use Lisp; and automatic conversion | |
1116 of files from Macintosh, Microsoft, and Unix platforms. | |
1117 | |
1118 A number of older Lisp packages, such as Gnus, Supercite and the | |
1119 calendar/diary, have been updated and enhanced to work with Emacs 20, | |
1120 and are now included with the standard distribution. | |
1121 | |
1122 | |
1123 @node New in Emacs 21, New in Emacs 22, New in Emacs 20, Status of Emacs | |
1124 @section What is different about Emacs 21? | |
1125 @cindex Differences between Emacs 20 and Emacs 21 | |
1126 @cindex Emacs 21, new features in | |
1127 @cindex Recently introduced features | |
1128 | |
1129 @cindex Variable-size fonts | |
1130 @cindex Toolbar support | |
1131 Emacs 21 features a thorough rewrite of the display engine. The new | |
1132 display engine supports variable-size fonts, images, and can play sounds | |
1133 on platforms which support that. As a result, the visual appearance of | |
1134 Emacs, when it runs on a windowed display, is much more reminiscent of | |
1135 modern GUI programs, and includes 3D widgets (used for the mode line and | |
1136 the scroll bars), a configurable and extensible toolbar, tooltips | |
1137 (a.k.a.@: balloon help), and other niceties. | |
1138 | |
1139 @cindex Colors on text-only terminals | |
1140 @cindex TTY colors | |
1141 In addition, Emacs 21 supports faces on text-only terminals. This means | |
1142 that you can now have colors when you run Emacs on a GNU/Linux console | |
1143 and on @code{xterm} with @kbd{emacs -nw}. | |
1144 | |
1145 @node New in Emacs 22, , New in Emacs 21, Status of Emacs | |
1146 @section What is different about Emacs 22? | |
1147 @cindex Differences between Emacs 21 and Emacs 22 | |
1148 @cindex Emacs 22, new features in | |
1149 @cindex Recently introduced features | |
1150 @cindex Default features | |
1151 | |
1152 @itemize | |
1153 @cindex GTK+ Toolkit | |
1154 @cindex Drag-and-drop | |
1155 @item | |
1156 Emacs can be built with GTK+ widgets, and supports drag-and-drop | |
1157 operation on X. | |
1158 | |
1159 @cindex Supported systems | |
1160 @item | |
1161 Emacs 22 features support for GNU/Linux systems on S390 and x86-64 | |
1162 machines, as well as support for the Mac OS X and Cygwin operating | |
1163 systems. | |
1164 | |
1165 @item | |
97043
9592c50233ab
Remove support for Mac Carbon.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
95940
diff
changeset
|
1166 The native MS-Windows, and Mac OS X builds include full support |
84296 | 1167 for images, toolbar, and tooltips. |
1168 | |
1169 @item | |
1170 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are | |
1171 enabled by default. | |
1172 | |
1173 @item | |
1174 The maximum size of buffers has been doubled and is 256M on 32-bit | |
1175 machines. | |
1176 | |
1177 @item | |
1178 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}. | |
1179 | |
1180 @cindex Mouse wheel | |
1181 @item | |
1182 Mouse wheel support is enabled by default. | |
1183 | |
1184 @item | |
1185 Window fringes are customizable. | |
1186 | |
1187 @item | |
1188 The mode line of the selected window is now highlighted. | |
1189 | |
1190 @item | |
1191 The minibuffer prompt is displayed in a distinct face. | |
1192 | |
1193 @item | |
1194 Abbrev definitions are read automatically at startup. | |
1195 | |
1196 @item | |
1197 Grep mode is separate from Compilation mode and has many new options and | |
1198 commands specific to grep. | |
1199 | |
1200 @item | |
1201 The original Emacs macro system has been replaced by the new Kmacro | |
1202 package, which provides many new commands and features and a simple | |
1203 interface that uses the function keys F3 and F4. Macros are stored in a | |
1204 macro ring, and can be debugged and edited interactively. | |
1205 | |
1206 @item | |
1207 The Grand Unified Debugger (GUD) can be used with a full graphical user | |
1208 interface to GDB; this provides many features found in traditional | |
1209 development environments, making it easy to manipulate breakpoints, add | |
1210 watch points, display the call stack, etc. Breakpoints are visually | |
1211 indicated in the source buffer. | |
1212 | |
1213 @item | |
1214 @cindex New modes | |
1215 Many new modes and packages have been included in Emacs, such as Calc, | |
1216 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org, | |
1217 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines, | |
1218 savehist, Conf mode, Python mode, DNS mode, etc. | |
1219 | |
1220 @cindex Multilingual Environment | |
1221 @item | |
1222 Leim is now part of Emacs. Unicode support has been much improved, and | |
1223 the following input methods have been added: belarusian, bulgarian-bds, | |
1224 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian, | |
1225 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard, | |
1226 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345, | |
1227 russian-computer, sgml, slovenian, tamil-inscript, ucs, | |
1228 ukrainian-computer, vietnamese-telex, and welsh. | |
1229 | |
1230 The following language environments have also been added: Belarusian, | |
1231 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6, | |
1232 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish, | |
1233 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255. | |
1234 | |
1235 @cindex Documentation | |
1236 @cindex Emacs Lisp Manual | |
1237 @item | |
1238 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual | |
1239 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro. | |
1240 @end itemize | |
1241 | |
1242 Many other changes have been made in Emacs 22, use @kbd{C-h n} to get a | |
1243 full list. | |
1244 | |
1245 @c ------------------------------------------------------------ | |
1246 @node Common requests, Bugs and problems, Status of Emacs, Top | |
1247 @chapter Common requests | |
1248 @cindex Common requests | |
1249 | |
1250 @menu | |
1251 * Setting up a customization file:: | |
1252 * Using Customize:: | |
1253 * Colors on a TTY:: | |
1254 * Debugging a customization file:: | |
1255 * Displaying the current line or column:: | |
1256 * Displaying the current file name in the titlebar:: | |
1257 * Turning on abbrevs by default:: | |
1258 * Associating modes with files:: | |
1259 * Highlighting a region:: | |
1260 * Replacing highlighted text:: | |
1261 * Controlling case sensitivity:: | |
1262 * Working with unprintable characters:: | |
1263 * Searching for/replacing newlines:: | |
1264 * Yanking text in isearch:: | |
1265 * Wrapping words automatically:: | |
1266 * Turning on auto-fill by default:: | |
1267 * Spell-checkers:: | |
1268 * Checking TeX and *roff documents:: | |
1269 * Changing load-path:: | |
1270 * Using an already running Emacs process:: | |
1271 * Compiler error messages:: | |
1272 * Indenting switch statements:: | |
1273 * Customizing C and C++ indentation:: | |
1274 * Horizontal scrolling:: | |
1275 * Overwrite mode:: | |
1276 * Turning off beeping:: | |
1277 * Turning the volume down:: | |
1278 * Automatic indentation:: | |
1279 * Matching parentheses:: | |
1280 * Hiding #ifdef lines:: | |
1281 * Repeating commands:: | |
1282 * Valid X resources:: | |
1283 * Evaluating Emacs Lisp code:: | |
1284 * Changing the length of a Tab:: | |
1285 * Inserting text at the beginning of each line:: | |
1286 * Underlining paragraphs:: | |
1287 * Forcing the cursor to remain in the same column:: | |
1288 * Forcing Emacs to iconify itself:: | |
1289 * Using regular expressions:: | |
1290 * Replacing text across multiple files:: | |
1291 * Documentation for etags:: | |
1292 * Disabling backups:: | |
1293 * Disabling auto-save-mode:: | |
1294 * Going to a line by number:: | |
1295 * Modifying pull-down menus:: | |
1296 * Deleting menus and menu options:: | |
1297 * Turning on syntax highlighting:: | |
1298 * Scrolling only one line:: | |
1299 * Editing MS-DOS files:: | |
1300 * Filling paragraphs with a single space:: | |
1301 * Escape sequences in shell output:: | |
1302 * Fullscreen mode on MS-Windows:: | |
1303 @end menu | |
1304 | |
1305 @node Setting up a customization file, Using Customize, Common requests, Common requests | |
1306 @section How do I set up a @file{.emacs} file properly? | |
1307 @cindex @file{.emacs} file, setting up | |
1308 @cindex @file{.emacs} file, locating | |
1309 @cindex Init file, setting up | |
1310 @cindex Customization file, setting up | |
1311 | |
1312 @inforef{Init File, Init File, emacs}. | |
1313 | |
1314 In general, new Emacs users should not have @file{.emacs} files, because | |
1315 it causes confusing non-standard behavior. Then they send questions to | |
1316 @email{help-gnu-emacs@@gnu.org} asking why Emacs isn't behaving as | |
1317 documented. | |
1318 | |
1319 Beginning with version 20.1, Emacs includes the new Customize facility | |
1320 (@pxref{Using Customize}). This allows users who are unfamiliar with | |
1321 Emacs Lisp to modify their @file{.emacs} files in a relatively | |
1322 straightforward way, using menus rather than Lisp code. Most packages | |
1323 support Customize as of this writing. | |
1324 | |
1325 While Customize might indeed make it easier to configure Emacs, | |
1326 consider taking a bit of time to learn Emacs Lisp and modifying your | |
1327 @file{.emacs} directly. Simple configuration options are described | |
1328 rather completely in @inforef{Init File, Init File, emacs}, for users | |
1329 interested in performing frequently requested, basic tasks. | |
1330 | |
1331 Sometimes users are unsure as to where their @file{.emacs} file should | |
1332 be found. Visiting the file as @file{~/.emacs} from Emacs will find | |
1333 the correct file. | |
1334 | |
1335 @node Using Customize, Colors on a TTY, Setting up a customization file, Common requests | |
1336 @section How do I start using Customize? | |
1337 @cindex Customize groups | |
1338 @cindex Customizing variables | |
1339 @cindex Customizing faces | |
1340 | |
1341 The main Customize entry point is @kbd{M-x customize @key{RET}}. This | |
1342 command takes you to a buffer listing all the available Customize | |
1343 groups. From there, you can access all customizable options and faces, | |
1344 change their values, and save your changes to your init file. | |
1345 @inforef{Easy Customization, Easy Customization, emacs}. | |
1346 | |
1347 If you know the name of the group in advance (e.g. ``shell''), use | |
1348 @kbd{M-x customize-group @key{RET}}. | |
1349 | |
1350 If you wish to customize a single option, use @kbd{M-x customize-option | |
1351 @key{RET}}. This command prompts you for the name of the option to | |
1352 customize, with completion. | |
1353 | |
1354 @node Colors on a TTY, Debugging a customization file, Using Customize, Common requests | |
1355 @section How do I get colors and syntax highlighting on a TTY? | |
1356 @cindex Colors on a TTY | |
1357 @cindex Syntax highlighting on a TTY | |
1358 @cindex Console, colors | |
1359 | |
1360 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode, | |
1361 i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when | |
97043
9592c50233ab
Remove support for Mac Carbon.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
95940
diff
changeset
|
1362 invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were |
84296 | 1363 supported in the MS-DOS port since Emacs 19.29.) Emacs automatically |
1364 detects color support at startup and uses it if available. If you think | |
1365 that your terminal supports colors, but Emacs won't use them, check the | |
1366 @code{termcap} entry for your display type for color-related | |
1367 capabilities. | |
1368 | |
1369 The command @kbd{M-x list-colors-display} pops up a window which | |
1370 exhibits all the colors Emacs knows about on the current display. | |
1371 | |
1372 Syntax highlighting is on by default since version 22.1. | |
1373 | |
1374 @node Debugging a customization file, Displaying the current line or column, Colors on a TTY, Common requests | |
1375 @section How do I debug a @file{.emacs} file? | |
1376 @cindex Debugging @file{.emacs} file | |
1377 @cindex @file{.emacs} debugging | |
1378 @cindex Init file debugging | |
1379 @cindex @samp{-debug-init} option | |
1380 | |
1381 Start Emacs with the @samp{-debug-init} command-line option. This | |
1382 enables the Emacs Lisp debugger before evaluating your @file{.emacs} | |
1383 file, and places you in the debugger if something goes wrong. The top | |
1384 line in the @file{trace-back} buffer will be the error message, and the | |
1385 second or third line of that buffer will display the Lisp code from your | |
1386 @file{.emacs} file that caused the problem. | |
1387 | |
1388 You can also evaluate an individual function or argument to a function | |
1389 in your @file{.emacs} file by moving the cursor to the end of the | |
1390 function or argument and typing @kbd{C-x C-e} (@kbd{M-x | |
1391 eval-last-sexp}). | |
1392 | |
1393 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of | |
1394 variables which you are trying to set or use. | |
1395 | |
1396 @node Displaying the current line or column, Displaying the current file name in the titlebar, Debugging a customization file, Common requests | |
1397 @section How do I make Emacs display the current line (or column) number? | |
1398 @cindex @code{line-number-mode} | |
1399 @cindex Displaying the current line or column | |
1400 @cindex Line number, displaying the current | |
1401 @cindex Column, displaying the current | |
1402 @cindex @code{mode-line-format} | |
1403 | |
1404 To have Emacs automatically display the current line number of the point | |
1405 in the mode line, do @kbd{M-x line-number-mode}. You can also put the | |
1406 form | |
1407 | |
1408 @lisp | |
1409 (setq line-number-mode t) | |
1410 @end lisp | |
1411 | |
1412 @noindent | |
1413 in your @file{.emacs} file to achieve this whenever you start Emacs. | |
1414 (Line number display is on by default, unless your site-specific | |
1415 initialization disables it.) Note that Emacs will not display the line | |
1416 number if the buffer's size in bytes is larger than the value of the | |
1417 variable @code{line-number-display-limit}. | |
1418 | |
1419 You can similarly display the current column with | |
1420 @kbd{M-x column-number-mode}, or by putting the form | |
1421 | |
1422 @lisp | |
1423 (setq column-number-mode t) | |
1424 @end lisp | |
1425 | |
1426 @noindent | |
1427 in your @file{.emacs} file. | |
1428 | |
1429 The @code{"%c"} format specifier in the variable @code{mode-line-format} | |
1430 will insert the current column's value into the mode line. See the | |
1431 documentation for @code{mode-line-format} (using @kbd{C-h v | |
1432 mode-line-format @key{RET}}) for more information on how to set and use | |
1433 this variable. | |
1434 | |
1435 Users of all Emacs versions can display the current column using the | |
1436 @samp{column} package written by @email{abraham@@dina.kvl.dk, Per | |
1437 Abrahamsen}. @xref{Packages that do not come with Emacs}, for | |
1438 instructions on how to get it. | |
1439 | |
1440 @cindex Set number capability in @code{vi} emulators | |
1441 None of the @code{vi} emulation modes provide the ``set number'' | |
1442 capability of @code{vi} (as far as we know). The @samp{setnu} package | |
1443 written by @email{kyle@@wonderworks.com, Kyle Jones} provides this | |
1444 feature. So too does @samp{wb-line-number}, written by | |
1445 @email{naoki.y.nakamura@@nifty.com, Naoki Nakamura}. | |
1446 | |
1447 @node Displaying the current file name in the titlebar, Turning on abbrevs by default, Displaying the current line or column, Common requests | |
1448 @section How can I modify the titlebar to contain the current file name? | |
1449 @cindex Titlebar, displaying the current file name in | |
1450 @cindex File name, displaying in the titlebar | |
1451 @cindex @code{frame-title-format} | |
1452 | |
1453 The contents of an Emacs frame's titlebar is controlled by the variable | |
1454 @code{frame-title-format}, which has the same structure as the variable | |
1455 @code{mode-line-format}. (Use @kbd{C-h v} or @kbd{M-x | |
1456 describe-variable} to get information about one or both of these | |
1457 variables.) | |
1458 | |
1459 By default, the titlebar for a frame does contain the name of the buffer | |
1460 currently being visited, except if there is a single frame. In such a | |
1461 case, the titlebar contains Emacs invocation name and the name of the | |
1462 machine at which Emacs was invoked. This is done by setting | |
1463 @code{frame-title-format} to the default value of | |
1464 | |
1465 @lisp | |
1466 (multiple-frames "%b" ("" invocation-name "@@" system-name)) | |
1467 @end lisp | |
1468 | |
1469 To modify the behavior such that frame titlebars contain the buffer's | |
1470 name regardless of the number of existing frames, include the following | |
1471 in your @file{.emacs}: | |
1472 | |
1473 @lisp | |
1474 (setq frame-title-format "%b") | |
1475 @end lisp | |
1476 | |
1477 @node Turning on abbrevs by default, Associating modes with files, Displaying the current file name in the titlebar, Common requests | |
1478 @section How do I turn on abbrevs by default just in mode @var{mymode}? | |
1479 @cindex Abbrevs, turning on by default | |
1480 | |
1481 Put this in your @file{.emacs} file: | |
1482 | |
1483 @lisp | |
1484 (condition-case () | |
1485 (quietly-read-abbrev-file) | |
1486 (file-error nil)) | |
1487 | |
1488 (add-hook '@var{mymode}-mode-hook | |
1489 (lambda () | |
1490 (setq abbrev-mode t))) | |
1491 @end lisp | |
1492 | |
1493 Starting with Emacs 22, the standard abbrevs file is read automatically | |
1494 at startup, so the first of these two forms becomes unnecessary. | |
1495 | |
1496 @node Associating modes with files, Highlighting a region, Turning on abbrevs by default, Common requests | |
1497 @section How do I make Emacs use a certain major mode for certain files? | |
1498 @cindex Associating modes with files | |
1499 @cindex File extensions and modes | |
1500 @cindex @code{auto-mode-alist}, modifying | |
1501 @cindex Modes, associating with file extensions | |
1502 | |
1503 If you want to use a certain mode @var{foo} for all files whose names end | |
1504 with the extension @file{.@var{bar}}, this will do it for you: | |
1505 | |
1506 @lisp | |
1507 (setq auto-mode-alist (cons '("\\.@var{bar}\\'" . @var{foo}-mode) auto-mode-alist)) | |
1508 @end lisp | |
1509 | |
1510 Otherwise put this somewhere in the first line of any file you want to | |
1511 edit in the mode @var{foo} (in the second line, if the first line begins | |
1512 with @samp{#!}): | |
1513 | |
1514 @example | |
1515 -*- @var{foo} -*- | |
1516 @end example | |
1517 | |
1518 @cindex Major mode for shell scripts | |
1519 Beginning with Emacs 19, the variable @code{interpreter-mode-alist} | |
1520 specifies which mode to use when loading a shell script. (Emacs | |
1521 determines which interpreter you're using by examining the first line of | |
1522 the script.) This feature only applies when the file name doesn't | |
1523 indicate which mode to use. Use @kbd{C-h v} (or @kbd{M-x | |
1524 describe-variable}) on @code{interpreter-mode-alist} to learn more. | |
1525 | |
1526 @node Highlighting a region, Replacing highlighted text, Associating modes with files, Common requests | |
1527 @section How can I highlight a region of text in Emacs? | |
1528 @cindex Highlighting text | |
1529 @cindex Text, highlighting | |
1530 @cindex @code{transient-mark-mode} | |
1531 @cindex Region, highlighting a | |
1532 | |
1533 You can cause the region to be highlighted when the mark is active by | |
1534 including | |
1535 | |
1536 @lisp | |
1537 (transient-mark-mode t) | |
1538 @end lisp | |
1539 | |
1540 @noindent | |
1541 in your @file{.emacs} file. | |
1542 | |
1543 @node Replacing highlighted text, Controlling case sensitivity, Highlighting a region, Common requests | |
1544 @section How can I replace highlighted text with what I type? | |
1545 @cindex @code{delete-selection-mode} | |
1546 @cindex Replacing highlighted text | |
1547 @cindex Highlighting and replacing text | |
1548 | |
1549 Use @code{delete-selection-mode}, which you can start automatically by | |
1550 placing the following Lisp form in your @file{.emacs} file: | |
1551 | |
1552 @lisp | |
1553 (delete-selection-mode 1) | |
1554 @end lisp | |
1555 | |
1556 According to the documentation string for @code{delete-selection-mode} | |
1557 (which you can read using @kbd{M-x describe-function @key{RET} | |
1558 delete-selection-mode @key{RET}}): | |
1559 | |
1560 @quotation | |
1561 When ON, typed text replaces the selection if the selection is active. | |
1562 When OFF, typed text is just inserted at point. | |
1563 @end quotation | |
1564 | |
1565 This mode also allows you to delete (not kill) the highlighted region by | |
1566 pressing @key{DEL}. | |
1567 | |
1568 @node Controlling case sensitivity, Working with unprintable characters, Replacing highlighted text, Common requests | |
1569 @section How do I control Emacs's case-sensitivity when searching/replacing? | |
1570 @cindex @code{case-fold-search} | |
1571 @cindex Case sensitivity of searches | |
1572 @cindex Searching without case sensitivity | |
1573 @cindex Ignoring case in searches | |
1574 | |
1575 For searching, the value of the variable @code{case-fold-search} | |
1576 determines whether they are case sensitive: | |
1577 | |
1578 @lisp | |
1579 (setq case-fold-search nil) ; make searches case sensitive | |
1580 (setq case-fold-search t) ; make searches case insensitive | |
1581 @end lisp | |
1582 | |
1583 @cindex Case sensitivity in replacements | |
1584 @cindex Replacing, and case sensitivity | |
1585 @cindex @code{case-replace} | |
1586 Similarly, for replacing, the variable @code{case-replace} determines | |
1587 whether replacements preserve case. | |
1588 | |
1589 You can also toggle case sensitivity at will in isearch with @kbd{M-c}. | |
1590 | |
1591 To change the case sensitivity just for one major mode, use the major | |
1592 mode's hook. For example: | |
1593 | |
1594 @lisp | |
1595 (add-hook '@var{foo}-mode-hook | |
1596 (lambda () | |
1597 (setq case-fold-search nil))) | |
1598 @end lisp | |
1599 | |
1600 @node Working with unprintable characters, Searching for/replacing newlines, Controlling case sensitivity, Common requests | |
1601 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters? | |
1602 @cindex Unprintable characters, working with | |
1603 @cindex Working with unprintable characters | |
1604 @cindex Control characters, working with | |
1605 @cindex Eight-bit characters, working with | |
1606 @cindex Searching for unprintable characters | |
1607 @cindex Regexps and unprintable characters | |
1608 | |
1609 To search for a single character that appears in the buffer as, for | |
1610 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}. (This assumes | |
1611 the value of @code{search-quote-char} is 17 (i.e., @kbd{C-q}).) | |
1612 Searching for @strong{all} unprintable characters is best done with a | |
1613 regular expression (@dfn{regexp}) search. The easiest regexp to use for | |
1614 the unprintable chars is the complement of the regexp for the printable | |
1615 chars. | |
1616 | |
1617 @itemize @bullet | |
1618 | |
1619 @item | |
1620 Regexp for the printable chars: @samp{[\t\n\r\f -~]} | |
1621 | |
1622 @item | |
1623 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]} | |
1624 | |
1625 @end itemize | |
1626 | |
1627 To type these special characters in an interactive argument to | |
1628 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to | |
1629 use @kbd{C-q}. (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand | |
1630 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.) So, | |
1631 to search for unprintable characters using @code{re-search-forward}: | |
1632 | |
1633 @kbd{M-x re-search-forward @key{RET} [^ @key{TAB} C-q @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~] @key{RET}} | |
1634 | |
1635 Using @code{isearch-forward-regexp}: | |
1636 | |
1637 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]} | |
1638 | |
1639 To delete all unprintable characters, simply use replace-regexp: | |
1640 | |
1641 @kbd{M-x replace-regexp @key{RET} [^ @key{TAB} C-q @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~] @key{RET} @key{RET}} | |
1642 | |
1643 Replacing is similar to the above. To replace all unprintable | |
1644 characters with a colon, use: | |
1645 | |
1646 M-x replace-regexp @key{RET} [^ @key{TAB} C-q @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~] @key{RET} : @key{RET} | |
1647 | |
1648 @node Searching for/replacing newlines, Yanking text in isearch, Working with unprintable characters, Common requests | |
1649 @section How do I input a newline character in isearch or query-replace? | |
1650 @cindex Searching for newlines | |
1651 @cindex Replacing newlines | |
1652 | |
1653 Use @kbd{C-q C-j}. For more information, see @inforef{Special Isearch, | |
1654 Special Input for Incremental Search, emacs}. | |
1655 | |
1656 | |
1657 @node Yanking text in isearch, Wrapping words automatically, Searching for/replacing newlines, Common requests | |
1658 @section How do I copy text from the kill ring into the search string? | |
1659 @cindex Yanking text into the search string | |
1660 @cindex isearch yanking | |
1661 | |
1662 Use @kbd{M-y}. @inforef{Isearch Yank, Isearch Yanking, emacs}. | |
1663 | |
1664 @node Wrapping words automatically, Turning on auto-fill by default, Yanking text in isearch, Common requests | |
1665 @section How do I make Emacs wrap words for me? | |
1666 @cindex Wrapping word automatically | |
1667 @cindex Wrapping lines | |
1668 @cindex Line wrap | |
1669 @cindex @code{auto-fill-mode}, introduction to | |
1670 @cindex Maximum line width, default value | |
1671 @cindex @code{fill-column}, default value | |
1672 | |
1673 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}. | |
1674 The default maximum line width is 70, determined by the variable | |
1675 @code{fill-column}. To learn how to turn this on automatically, see | |
1676 @ref{Turning on auto-fill by default}. | |
1677 | |
1678 @node Turning on auto-fill by default, Spell-checkers, Wrapping words automatically, Common requests | |
1679 @section How do I turn on @code{auto-fill-mode} by default? | |
1680 @cindex @code{auto-fill-mode}, activating automatically | |
1681 @cindex Filling automatically | |
1682 @cindex Automatic entry to @code{auto-fill-mode} | |
1683 | |
1684 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x | |
1685 auto-fill-mode}. | |
1686 | |
1687 To turn it on for every buffer in a certain mode, you must use the hook | |
1688 for that mode. For example, to turn on @code{auto-fill} mode for all | |
1689 text buffers, including the following in your @file{.emacs} file: | |
1690 | |
1691 @lisp | |
1692 (add-hook 'text-mode-hook 'turn-on-auto-fill) | |
1693 @end lisp | |
1694 | |
1695 If you want @code{auto-fill} mode on in all major modes, do this: | |
1696 | |
1697 @lisp | |
1698 (setq-default auto-fill-function 'do-auto-fill) | |
1699 @end lisp | |
1700 | |
1701 @node Spell-checkers, Checking TeX and *roff documents, Turning on auto-fill by default, Common requests | |
1702 @section Where can I get a better spelling checker for Emacs? | |
1703 @cindex Checking spelling | |
1704 @cindex Spelling, checking text documents | |
1705 | |
1706 Use Ispell. @xref{Ispell}. | |
1707 | |
1708 @node Checking TeX and *roff documents, Changing load-path, Spell-checkers, Common requests | |
1709 @section How can I spell-check @TeX{} or *roff documents? | |
1710 @cindex Spelling, checking @TeX{} documents | |
1711 @cindex @TeX{} documents, checking spelling in | |
1712 | |
1713 Use Ispell. Ispell can handle @TeX{} and *roff documents. | |
1714 @xref{Ispell}. | |
1715 | |
1716 @node Changing load-path, Using an already running Emacs process, Checking TeX and *roff documents, Common requests | |
1717 @section How do I change @code{load-path}? | |
1718 @cindex @code{load-path}, modifying | |
1719 @cindex Modifying @code{load-path} | |
1720 @cindex Adding to @code{load-path} | |
1721 | |
1722 In general, you should only add to the @code{load-path}. You can add | |
1723 directory @var{/dir/subdir} to the load path like this: | |
1724 | |
1725 @lisp | |
1726 (setq load-path (cons "/dir/subdir/" load-path)) | |
1727 @end lisp | |
1728 | |
1729 To do this relative to your home directory: | |
1730 | |
1731 @lisp | |
1732 (setq load-path (cons "~/mysubdir/" load-path)) | |
1733 @end lisp | |
1734 | |
1735 @node Using an already running Emacs process, Compiler error messages, Changing load-path, Common requests | |
1736 @section How do I use an already running Emacs from another window? | |
1737 @cindex @code{emacsclient} | |
1738 @cindex Emacs server functions | |
1739 @cindex Using an existing Emacs process | |
1740 | |
1741 @code{emacsclient}, which comes with Emacs, is for editing a file using | |
1742 an already running Emacs rather than starting up a new Emacs. It does | |
1743 this by sending a request to the already running Emacs, which must be | |
1744 expecting the request. | |
1745 | |
1746 @itemize @bullet | |
1747 | |
1748 @item | |
1749 Setup: | |
1750 | |
1751 Emacs must have executed the @code{server-start} function for | |
1752 @samp{emacsclient} to work. This can be done either by a command line | |
1753 option: | |
1754 | |
1755 @example | |
1756 emacs -f server-start | |
1757 @end example | |
1758 | |
1759 or by invoking @code{server-start} from @file{.emacs}: | |
1760 | |
1761 @lisp | |
1762 (if (@var{some conditions are met}) (server-start)) | |
1763 @end lisp | |
1764 | |
1765 When this is done, Emacs creates a Unix domain socket named | |
1766 @file{server} in @file{/tmp/emacs@var{userid}}. See | |
1767 @code{server-socket-dir}. | |
1768 | |
1769 To get your news reader, mail reader, etc., to invoke | |
1770 @samp{emacsclient}, try setting the environment variable @code{EDITOR} | |
1771 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}. You may | |
1772 have to specify the full pathname of the @samp{emacsclient} program | |
1773 instead. Examples: | |
1774 | |
1775 @example | |
1776 # csh commands: | |
1777 setenv EDITOR emacsclient | |
1778 | |
1779 # using full pathname | |
1780 setenv EDITOR /usr/local/emacs/etc/emacsclient | |
1781 | |
1782 # sh command: | |
1783 EDITOR=emacsclient ; export EDITOR | |
1784 @end example | |
1785 | |
1786 @item | |
1787 Normal use: | |
1788 | |
1789 When @samp{emacsclient} is run, it connects to the socket and passes its | |
1790 command line options to Emacs, which at the next opportunity will visit | |
1791 the files specified. (Line numbers can be specified just like with | |
1792 Emacs.) The user will have to switch to the Emacs window by hand. When | |
1793 the user is done editing a file, the user can type @kbd{C-x #} (or | |
1794 @kbd{M-x server-edit}) to indicate this. If there is another buffer | |
1795 requested by @code{emacsclient}, Emacs will switch to it; otherwise | |
1796 @code{emacsclient} will exit, signaling the calling program to continue. | |
1797 | |
1798 @cindex @code{gnuserv} | |
1799 There is an enhanced version of @samp{emacsclient} called | |
1800 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman} | |
1801 (@pxref{Packages that do not come with Emacs}). @samp{gnuserv} uses | |
1802 Internet domain sockets, so it can work across most network connections. | |
1803 | |
1804 The most recent @samp{gnuserv} package is available at | |
1805 | |
1806 @uref{http://meltin.net/hacks/emacs/} | |
1807 | |
1808 @end itemize | |
1809 | |
1810 @node Compiler error messages, Indenting switch statements, Using an already running Emacs process, Common requests | |
1811 @section How do I make Emacs recognize my compiler's funny error messages? | |
1812 @cindex Compiler error messages, recognizing | |
1813 @cindex Recognizing non-standard compiler errors | |
1814 @cindex Regexps for recognizing compiler errors | |
1815 @cindex Errors, recognizing compiler | |
1816 | |
1817 Customize the @code{compilation-error-regexp-alist} variable. | |
1818 | |
1819 @node Indenting switch statements, Customizing C and C++ indentation, Compiler error messages, Common requests | |
1820 @section How do I change the indentation for @code{switch}? | |
1821 @cindex @code{switch}, indenting | |
1822 @cindex Indenting of @code{switch} | |
1823 | |
1824 Many people want to indent their @code{switch} statements like this: | |
1825 | |
1826 @example | |
1827 f() | |
1828 @{ | |
1829 switch(x) @{ | |
1830 case A: | |
1831 x1; | |
1832 break; | |
1833 case B: | |
1834 x2; | |
1835 break; | |
1836 default: | |
1837 x3; | |
1838 @} | |
1839 @} | |
1840 @end example | |
1841 | |
1842 The solution at first appears to be: set @code{c-indent-level} to 4 and | |
1843 @code{c-label-offset} to -2. However, this will give you an indentation | |
1844 spacing of four instead of two. | |
1845 | |
1846 The @emph{real} solution is to use @code{cc-mode} (the default mode for | |
1847 C programming in Emacs 20 and later) and add the following line to your | |
1848 @file{.emacs}: | |
1849 | |
1850 @lisp | |
1851 (c-set-offset 'case-label '+) | |
1852 @end lisp | |
1853 | |
1854 There appears to be no way to do this with the old @code{c-mode}. | |
1855 | |
1856 @node Customizing C and C++ indentation, Horizontal scrolling, Indenting switch statements, Common requests | |
1857 @section How to customize indentation in C, C@t{++}, and Java buffers? | |
1858 @cindex Indentation, how to customize | |
1859 @cindex Customize indentation | |
1860 | |
1861 The Emacs @code{cc-mode} features an interactive procedure for | |
1862 customizing the indentation style, which is fully explained in the | |
1863 @cite{CC Mode} manual that is part of the Emacs distribution, see | |
1864 @ref{Customizing Indentation, , Customization Indentation, ccmode, | |
1865 The CC Mode Manual}. Here's a short summary of the procedure: | |
1866 | |
1867 @enumerate | |
1868 @item | |
1869 Go to the beginning of the first line where you don't like the | |
1870 indentation and type @kbd{C-c C-o}. Emacs will prompt you for the | |
1871 syntactic symbol; type @key{RET} to accept the default it suggests. | |
1872 | |
1873 @item | |
1874 Emacs now prompts for the offset of this syntactic symbol, showing the | |
1875 default (the current definition) inside parentheses. You can choose | |
1876 one of these: | |
1877 | |
1878 @table @code | |
1879 @item 0 | |
1880 No extra indentation. | |
1881 @item + | |
1882 Indent one basic offset. | |
1883 @item - | |
1884 Outdent one basic offset. | |
1885 @item ++ | |
1886 Indent two basic offsets | |
1887 @item -- | |
1888 Outdent two basic offsets. | |
1889 @item * | |
1890 Indent half basic offset. | |
1891 @item / | |
1892 Outdent half basic offset. | |
1893 @end table | |
1894 | |
1895 @item | |
1896 After choosing one of these symbols, type @kbd{C-c C-q} to reindent | |
1897 the line or the block according to what you just specified. | |
1898 | |
1899 @item | |
1900 If you don't like the result, go back to step 1. Otherwise, add the | |
1901 following line to your @file{.emacs}: | |
1902 | |
1903 @lisp | |
1904 (c-set-offset '@var{syntactic-symbol} @var{offset}) | |
1905 @end lisp | |
1906 | |
1907 @noindent | |
1908 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer | |
1909 when you type @kbd{C-c C-o} at the beginning of the line, and | |
1910 @var{offset} is one of the indentation symbols listed above (@code{+}, | |
1911 @code{/}, @code{0}, etc.) that you've chosen during the interactive | |
1912 procedure. | |
1913 | |
1914 @item | |
1915 Go to the next line whose indentation is not to your liking and repeat | |
1916 the process there. | |
1917 @end enumerate | |
1918 | |
1919 It is recommended to put all the resulting @code{(c-set-offset ...)} | |
1920 customizations inside a C mode hook, like this: | |
1921 | |
1922 @lisp | |
1923 (defun my-c-mode-hook () | |
1924 (c-set-offset ...) | |
1925 (c-set-offset ...)) | |
1926 (add-hook 'c-mode-hook 'my-c-mode-hook) | |
1927 @end lisp | |
1928 | |
1929 @noindent | |
1930 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require | |
1931 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset} | |
1932 might be unavailable when @code{cc-mode} is not loaded. | |
1933 | |
1934 Note that @code{c-mode-hook} runs for C source files only; use | |
1935 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for | |
1936 Java sources, etc. If you want the same customizations to be in | |
1937 effect in @emph{all} languages supported by @code{cc-mode}, use | |
1938 @code{c-mode-common-hook}. | |
1939 | |
1940 @node Horizontal scrolling, Overwrite mode, Customizing C and C++ indentation, Common requests | |
1941 @section How can I make Emacs automatically scroll horizontally? | |
1942 @cindex @code{hscroll-mode} | |
1943 @cindex Horizontal scrolling | |
1944 @cindex Scrolling horizontally | |
1945 | |
1946 In Emacs 21 and later, this is on by default: if the variable | |
1947 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs | |
1948 automatically scrolls the display horizontally when point moves off the | |
1949 left or right edge of the window. | |
1950 | |
1951 Note that this is overridden by the variable | |
1952 @code{truncate-partial-width-windows} if that variable is non-nil | |
1953 and the current buffer is not full-frame width. | |
1954 | |
1955 In Emacs 20, use the @code{hscroll-mode}. Here is some information from | |
1956 the documentation, available by typing @kbd{C-h f hscroll-mode @key{RET}}: | |
1957 | |
1958 Automatically scroll horizontally when the point moves off the | |
1959 left or right edge of the window. | |
1960 | |
1961 @itemize @minus | |
1962 @item | |
1963 Type @kbd{M-x hscroll-mode} to enable it in the current buffer. | |
1964 | |
1965 @item | |
1966 Type @kbd{M-x hscroll-global-mode} to enable it in every buffer. | |
1967 | |
1968 @item | |
1969 @code{turn-on-hscroll} is useful in mode hooks as in: | |
1970 | |
1971 @lisp | |
1972 (add-hook 'text-mode-hook 'turn-on-hscroll) | |
1973 @end lisp | |
1974 | |
1975 @item | |
1976 @code{hscroll-margin} controls how close the cursor can get to the | |
1977 edge of the window. | |
1978 | |
1979 @item | |
1980 @code{hscroll-step-percent} controls how far to jump once we decide to do so. | |
1981 @end itemize | |
1982 | |
1983 @node Overwrite mode, Turning off beeping, Horizontal scrolling, Common requests | |
1984 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting? | |
1985 @cindex @key{Insert} | |
1986 @cindex @code{overwrite-mode} | |
1987 @cindex Overwriting existing text | |
1988 @cindex Toggling @code{overwrite-mode} | |
1989 | |
1990 @kbd{M-x overwrite-mode} (a minor mode). This toggles | |
1991 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode} | |
1992 is as easy as another @kbd{M-x overwrite-mode}. | |
1993 | |
1994 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off. | |
1995 | |
1996 @node Turning off beeping, Turning the volume down, Overwrite mode, Common requests | |
1997 @section How do I stop Emacs from beeping on a terminal? | |
1998 @cindex Beeping, turning off | |
1999 @cindex Visible bell | |
2000 @cindex Bell, visible | |
2001 | |
2002 @email{martin@@cc.gatech.edu, Martin R. Frank} writes: | |
2003 | |
2004 Tell Emacs to use the @dfn{visible bell} instead of the audible bell, | |
2005 and set the visible bell to nothing. | |
2006 | |
2007 That is, put the following in your @code{TERMCAP} environment variable | |
2008 (assuming you have one): | |
2009 | |
2010 @example | |
2011 ... :vb=: ... | |
2012 @end example | |
2013 | |
2014 And evaluate the following Lisp form: | |
2015 | |
2016 @example | |
2017 (setq visible-bell t) | |
2018 @end example | |
2019 | |
2020 @node Turning the volume down, Automatic indentation, Turning off beeping, Common requests | |
2021 @section How do I turn down the bell volume in Emacs running under X? | |
2022 @cindex Bell, volume of | |
2023 @cindex Volume of bell | |
2024 | |
2025 On X Window system, you can adjust the bell volume and duration for all | |
2026 programs with the shell command @code{xset}. | |
2027 | |
2028 Invoking @code{xset} without any arguments produces some basic | |
2029 information, including the following: | |
2030 | |
2031 @example | |
2032 usage: xset [-display host:dpy] option ... | |
2033 To turn bell off: | |
2034 -b b off b 0 | |
2035 To set bell volume, pitch and duration: | |
2036 b [vol [pitch [dur]]] b on | |
2037 @end example | |
2038 | |
2039 @node Automatic indentation, Matching parentheses, Turning the volume down, Common requests | |
2040 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line? | |
2041 @cindex Indenting new lines | |
2042 @cindex New lines, indenting of | |
2043 @cindex Previous line, indenting according to | |
2044 @cindex Text indentation | |
2045 | |
2046 Such behavior is automatic in Emacs 20 and later. From the | |
2047 @file{etc/NEWS} file for Emacs 20.2: | |
2048 | |
2049 @example | |
2050 ** In Text mode, now only blank lines separate paragraphs. This makes | |
2051 it possible to get the full benefit of Adaptive Fill mode in Text mode, | |
2052 and other modes derived from it (such as Mail mode). @key{TAB} in Text | |
2053 mode now runs the command @code{indent-relative}; this makes a practical | |
2054 difference only when you use indented paragraphs. | |
2055 | |
2056 As a result, the old Indented Text mode is now identical to Text mode, | |
2057 and is an alias for it. | |
2058 | |
2059 If you want spaces at the beginning of a line to start a paragraph, use | |
2060 the new mode, Paragraph Indent Text mode. | |
2061 @end example | |
2062 | |
2063 @cindex Prefixing lines | |
2064 @cindex Fill prefix | |
2065 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill | |
2066 by default}), you can tell Emacs to prefix every line with a certain | |
2067 character sequence, the @dfn{fill prefix}. Type the prefix at the | |
2068 beginning of a line, position point after it, and then type @kbd{C-x .} | |
2069 (@code{set-fill-prefix}) to set the fill prefix. Thereafter, | |
2070 auto-filling will automatically put the fill prefix at the beginning of | |
2071 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill | |
2072 prefix when refilling the paragraph. | |
2073 | |
2074 If you have paragraphs with different levels of indentation, you will | |
2075 have to set the fill prefix to the correct value each time you move to a | |
2076 new paragraph. There are many packages available to deal with this | |
2077 (@pxref{Packages that do not come with Emacs}). Look for ``fill'' and | |
2078 ``indent'' keywords for guidance. | |
2079 | |
2080 @node Matching parentheses, Hiding #ifdef lines, Automatic indentation, Common requests | |
2081 @section How do I show which parenthesis matches the one I'm looking at? | |
2082 @cindex Parentheses, matching | |
2083 @cindex @file{paren.el} | |
2084 @cindex Highlighting matching parentheses | |
2085 @cindex Pairs of parentheses, highlighting | |
2086 @cindex Matching parentheses | |
2087 | |
2088 Call @code{show-paren-mode} in your @file{.emacs} file: | |
2089 | |
2090 @lisp | |
2091 (show-paren-mode 1) | |
2092 @end lisp | |
2093 | |
2094 You can also enable this mode by selecting the @samp{Paren Match | |
2095 Highlighting} option from the @samp{Options} menu of the Emacs menu bar | |
2096 at the top of any Emacs frame. | |
2097 | |
2098 Alternatives to this mode include: | |
2099 | |
2100 @itemize @bullet | |
2101 | |
2102 @item | |
2103 If you're looking at a right parenthesis (or brace or bracket) you can | |
2104 delete it and reinsert it. Emacs will momentarily move the cursor to | |
2105 the matching parenthesis. | |
2106 | |
2107 @item | |
2108 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp}) | |
2109 will skip over one set of balanced parentheses, so you can see which | |
2110 parentheses match. (You can train it to skip over balanced brackets | |
2111 and braces at the same time by modifying the syntax table.) | |
2112 | |
2113 @cindex Show matching paren as in @code{vi} | |
2114 @item | |
2115 Here is some Emacs Lisp that will make the @key{%} key show the matching | |
2116 parenthesis, like in @code{vi}. In addition, if the cursor isn't over a | |
2117 parenthesis, it simply inserts a % like normal. | |
2118 | |
2119 @lisp | |
2120 ;; By an unknown contributor | |
2121 | |
2122 (global-set-key "%" 'match-paren) | |
2123 | |
2124 (defun match-paren (arg) | |
2125 "Go to the matching paren if on a paren; otherwise insert %." | |
2126 (interactive "p") | |
2127 (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1)) | |
2128 ((looking-at "\\s\)") (forward-char 1) (backward-list 1)) | |
2129 (t (self-insert-command (or arg 1))))) | |
2130 @end lisp | |
2131 | |
2132 @end itemize | |
2133 | |
2134 @node Hiding #ifdef lines, Repeating commands, Matching parentheses, Common requests | |
2135 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler? | |
2136 @cindex @code{#ifdef}, selective display of | |
2137 @cindex @code{hide-ifdef-mode} | |
2138 @cindex Hiding @code{#ifdef} text | |
2139 @cindex Selectively displaying @code{#ifdef} code | |
2140 | |
2141 @kbd{M-x hide-ifdef-mode}. (This is a minor mode.) You might also want | |
2142 to investigate @file{cpp.el}, which is distributed with Emacs. | |
2143 | |
2144 @node Repeating commands, Valid X resources, Hiding #ifdef lines, Common requests | |
2145 @section How do I repeat a command as many times as possible? | |
2146 @cindex Repeating commands many times | |
2147 @cindex Commands, repeating many times | |
2148 @cindex @code{.}, equivalent to @code{vi} command | |
2149 | |
2150 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z}) | |
2151 that repeats the last command. If you preface it with a prefix | |
2152 argument, the prefix arg is applied to the command. | |
2153 | |
2154 You can also type @kbd{C-x @key{ESC} @key{ESC}} | |
2155 (@code{repeat-complex-command}) to reinvoke commands that used the | |
2156 minibuffer to get arguments. In @code{repeat-complex-command} you can | |
2157 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your | |
2158 keyboard has these keys) to scan through all the different complex | |
2159 commands you've typed. | |
2160 | |
2161 To repeat a set of commands, use keyboard macros. Use @kbd{C-x (} and | |
2162 @kbd{C-x )} to make a keyboard macro that invokes the command and then | |
2163 type @kbd{C-x e}. (@inforef{Keyboard Macros, Keyboard Macros, emacs}.) | |
2164 | |
2165 If you're really desperate for the @code{.} command in @code{vi} that | |
2166 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation | |
2167 mode which comes with Emacs, and which appears to support it. | |
2168 | |
2169 @node Valid X resources, Evaluating Emacs Lisp code, Repeating commands, Common requests | |
2170 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)? | |
2171 @cindex Resources, X | |
2172 @cindex X resources | |
2173 @cindex Setting X resources | |
2174 | |
2175 @inforef{X Resources, X Resources, emacs}. | |
2176 | |
2177 You can also use a resource editor, such as editres (for X11R5 and | |
2178 onwards), to look at the resource names for the menu bar, assuming Emacs | |
2179 was compiled with the X toolkit. | |
2180 | |
2181 @node Evaluating Emacs Lisp code, Changing the length of a Tab, Valid X resources, Common requests | |
2182 @section How do I execute (``evaluate'') a piece of Emacs Lisp code? | |
2183 @cindex Evaluating Lisp code | |
2184 @cindex Lisp forms, evaluating | |
2185 | |
2186 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an | |
2187 Emacs Lisp @dfn{form}: | |
2188 | |
2189 @itemize @bullet | |
2190 | |
2191 @item | |
2192 If you want it evaluated every time you run Emacs, put it in a file | |
2193 named @file{.emacs} in your home directory. This is known as ``your | |
2194 @file{.emacs} file,'' and contains all of your personal customizations. | |
2195 | |
2196 @item | |
2197 You can type the form in the @file{*scratch*} buffer, and then type | |
2198 @key{LFD} (or @kbd{C-j}) after it. The result of evaluating the form | |
2199 will be inserted in the buffer. | |
2200 | |
2201 @item | |
2202 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form | |
2203 before or around point. | |
2204 | |
2205 @item | |
2206 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately | |
2207 before point and prints its value in the echo area. | |
2208 | |
2209 @item | |
2210 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp | |
2211 form in the minibuffer which will be evaluated once you press @key{RET}. | |
2212 | |
2213 @item | |
2214 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp | |
2215 forms in a file. (To do this from Lisp use the function @code{load} | |
2216 instead.) | |
2217 | |
2218 The functions @code{load-library}, @code{eval-region}, | |
2219 @code{eval-buffer}, @code{require}, and @code{autoload} are also | |
2220 useful; see @ref{Emacs Lisp documentation}, if you want to learn more | |
2221 about them. | |
2222 | |
2223 @end itemize | |
2224 | |
2225 @node Changing the length of a Tab, Inserting text at the beginning of each line, Evaluating Emacs Lisp code, Common requests | |
2226 @section How do I change Emacs's idea of the @key{TAB} character's length? | |
2227 @cindex Tab length | |
2228 @cindex Length of tab character | |
2229 @cindex @code{default-tab-width} | |
2230 | |
2231 Set the variable @code{default-tab-width}. For example, to set | |
2232 @key{TAB} stops every 10 characters, insert the following in your | |
2233 @file{.emacs} file: | |
2234 | |
2235 @lisp | |
2236 (setq default-tab-width 10) | |
2237 @end lisp | |
2238 | |
2239 Do not confuse variable @code{tab-width} with variable | |
2240 @code{tab-stop-list}. The former is used for the display of literal | |
2241 @key{TAB} characters. The latter controls what characters are inserted | |
2242 when you press the @key{TAB} character in certain modes. | |
2243 | |
2244 @node Inserting text at the beginning of each line, Underlining paragraphs, Changing the length of a Tab, Common requests | |
2245 @section How do I insert <some text> at the beginning of every line? | |
2246 @cindex Prefixing a region with some text | |
2247 @cindex Prefix character, inserting in mail/news replies | |
2248 @cindex Replies to mail/news, inserting a prefix character | |
2249 @cindex @code{mail-yank-prefix} | |
2250 @cindex Mail replies, inserting a prefix character | |
2251 @cindex News replies, inserting a prefix character | |
2252 | |
2253 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp | |
2254 @key{RET} ^ @key{RET} your text @key{RET}}. | |
2255 | |
2256 To do this to a region, use @code{string-insert-rectangle}. | |
2257 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you | |
2258 want to prefix, move the cursor to last line to be prefixed, and type | |
2259 @kbd{M-x string-insert-rectangle @key{RET}}. To do this for the whole | |
2260 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}. | |
2261 | |
2262 If you are trying to prefix a yanked mail message with @samp{>}, you | |
2263 might want to set the variable @code{mail-yank-prefix}. In Message | |
2264 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;} | |
2265 runs the function @code{comment-region}, it is a general-purpose | |
2266 mechanism to comment regions) (@pxref{Changing the included text prefix}). | |
2267 | |
2268 @node Underlining paragraphs, Forcing the cursor to remain in the same column, Inserting text at the beginning of each line, Common requests | |
2269 @section How do I insert @samp{_^H} before each character in a region to get an underlined paragraph? | |
2270 @cindex Underlining a region of text | |
2271 @cindex @code{underline-region} | |
2272 | |
2273 Mark the region and then type @kbd{M-x underline-region @key{RET}}. | |
2274 | |
2275 @node Forcing the cursor to remain in the same column, Forcing Emacs to iconify itself, Underlining paragraphs, Common requests | |
2276 @section How do I make Emacs behave like this: when I go up or down, the cursor should stay in the same column even if the line is too short? | |
2277 @cindex @code{picture-mode} | |
2278 @cindex Remaining in the same column, regardless of contents | |
2279 @cindex Vertical movement in empty documents | |
2280 | |
2281 Use @kbd{M-x picture-mode}. | |
2282 | |
2283 See also the variable @code{track-eol} and the command | |
2284 @code{set-goal-column} bound to @kbd{C-x C-n} | |
2285 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}). | |
2286 | |
2287 @node Forcing Emacs to iconify itself, Using regular expressions, Forcing the cursor to remain in the same column, Common requests | |
2288 @section How do I tell Emacs to iconify itself? | |
2289 @cindex Iconification under the X Window System | |
2290 @cindex X Window System and iconification | |
2291 @cindex Suspending Emacs | |
2292 | |
2293 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs | |
2294 otherwise. @inforef{Frame Commands, Frame Commands, emacs}. | |
2295 | |
2296 @node Using regular expressions, Replacing text across multiple files, Forcing Emacs to iconify itself, Common requests | |
2297 @section How do I use regexps (regular expressions) in Emacs? | |
2298 @cindex Regexps | |
2299 @cindex Regular expressions | |
2300 @cindex Differences between Unix and Emacs regexps | |
2301 @cindex Unix regexps, differences from Emacs | |
2302 @cindex Text strings, putting regexps in | |
2303 | |
2304 @inforef{Regexp Backslash, Regexp Backslash, emacs}. | |
2305 | |
2306 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators | |
2307 are @samp{\(} and @samp{\)}. Also, the string syntax for a backslash is | |
2308 @samp{\\}. To specify a regular expression like @samp{xxx\(foo\|bar\)} | |
2309 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}. | |
2310 | |
2311 Note the doubled backslashes! | |
2312 | |
2313 @itemize @bullet | |
2314 | |
2315 @item | |
2316 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set | |
2317 (@samp{[^...]}) can match a newline character (@key{LFD} a.k.a.@: | |
2318 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the | |
2319 characters not to match. | |
2320 | |
2321 @item | |
2322 The character syntax regexps (e.g., @samp{\sw}) are not | |
2323 meaningful inside character set regexps (e.g., @samp{[aeiou]}). (This | |
2324 is actually typical for regexp syntax.) | |
2325 | |
2326 @end itemize | |
2327 | |
2328 @node Replacing text across multiple files, Documentation for etags, Using regular expressions, Common requests | |
2329 @section How do I perform a replace operation across more than one file? | |
2330 @cindex Replacing strings across files | |
2331 @cindex Multiple files, replacing across | |
2332 @cindex Files, replacing strings across multiple | |
2333 @cindex Recursive search/replace operations | |
2334 | |
2335 As of Emacs 19.29, Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x | |
2336 d}) supports the command @code{dired-do-query-replace} (@kbd{Q}), which | |
2337 allows users to replace regular expressions in multiple files. | |
2338 | |
2339 You can use this command to perform search/replace operations on | |
2340 multiple files by following the following steps: | |
2341 | |
2342 @itemize @bullet | |
2343 @item | |
2344 Assemble a list of files you want to operate on with either | |
2345 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}. | |
2346 | |
2347 @item | |
2348 Mark all files in the resulting Dired buffer using @kbd{t}. | |
2349 | |
2350 @item | |
2351 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked | |
2352 files. | |
2353 | |
2354 @item | |
2355 To accept all replacements in each file, hit @kbd{!}. | |
2356 @end itemize | |
2357 | |
2358 Another way to do the same thing is to use the ``tags'' feature of | |
2359 Emacs: it includes the command @code{tags-query-replace} which performs | |
2360 a query-replace across all the files mentioned in the @file{TAGS} file. | |
2361 @inforef{Tags Search, Tags Search, emacs}. | |
2362 | |
2363 @node Documentation for etags, Disabling backups, Replacing text across multiple files, Common requests | |
2364 @section Where is the documentation for @code{etags}? | |
2365 @cindex Documentation for @code{etags} | |
2366 @cindex @code{etags}, documentation for | |
2367 | |
2368 The @code{etags} man page should be in the same place as the | |
2369 @code{emacs} man page. | |
2370 | |
2371 Quick command-line switch descriptions are also available. For example, | |
2372 @samp{etags -H}. | |
2373 | |
2374 @node Disabling backups, Disabling auto-save-mode, Documentation for etags, Common requests | |
2375 @section How do I disable backup files? | |
2376 @cindex Backups, disabling | |
2377 @cindex Disabling backups | |
2378 | |
2379 You probably don't want to do this, since backups are useful, especially | |
2380 when something goes wrong. | |
2381 | |
2382 To avoid seeing backup files (and other ``uninteresting'' files) in Dired, | |
2383 load @code{dired-x} by adding the following to your @file{.emacs} file: | |
2384 | |
2385 @lisp | |
2386 (add-hook 'dired-load-hook | |
2387 (lambda () | |
2388 (load "dired-x"))) | |
2389 @end lisp | |
2390 | |
2391 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer. | |
2392 You can make omitting the default for new dired buffers by putting the | |
2393 following in your @file{.emacs}: | |
2394 | |
2395 @lisp | |
2396 (add-hook 'dired-mode-hook 'dired-omit-toggle) | |
2397 @end lisp | |
2398 | |
2399 If you're tired of seeing backup files whenever you do an @samp{ls} at | |
2400 the Unix shell, try GNU @code{ls} with the @samp{-B} option. GNU | |
2401 @code{ls} is part of the GNU Fileutils package, available from | |
2402 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}). | |
2403 | |
2404 To disable or change the way backups are made, @inforef{Backup Names, , | |
2405 emacs}. | |
2406 | |
2407 @cindex Backup files in a single directory | |
2408 Beginning with Emacs 21.1, you can control where Emacs puts backup files | |
2409 by customizing the variable @code{backup-directory-alist}. This | |
2410 variable's value specifies that files whose names match specific patters | |
2411 should have their backups put in certain directories. A typical use is | |
2412 to add the element @code{("." . @var{dir})} to force Emacs to put | |
2413 @strong{all} backup files in the directory @file{dir}. | |
2414 | |
2415 @node Disabling auto-save-mode, Going to a line by number, Disabling backups, Common requests | |
2416 @section How do I disable @code{auto-save-mode}? | |
2417 @cindex Disabling @code{auto-save-mode} | |
2418 @cindex Auto-saving | |
2419 @cindex Saving at frequent intervals | |
2420 | |
2421 You probably don't want to do this, since auto-saving is useful, | |
2422 especially when Emacs or your computer crashes while you are editing a | |
2423 document. | |
2424 | |
2425 Instead, you might want to change the variable | |
2426 @code{auto-save-interval}, which specifies how many keystrokes Emacs | |
2427 waits before auto-saving. Increasing this value forces Emacs to wait | |
2428 longer between auto-saves, which might annoy you less. | |
2429 | |
2430 You might also want to look into Sebastian Kremer's @code{auto-save} | |
2431 package (@pxref{Packages that do not come with Emacs}). This | |
2432 package also allows you to place all auto-save files in one directory, | |
2433 such as @file{/tmp}. | |
2434 | |
2435 To disable or change how @code{auto-save-mode} works, @inforef{Auto | |
2436 Save, , emacs}. | |
2437 | |
2438 @node Going to a line by number, Modifying pull-down menus, Disabling auto-save-mode, Common requests | |
2439 @section How can I go to a certain line given its number? | |
2440 @cindex Going to a line by number | |
2441 @cindex Compilation error messages | |
2442 @cindex Recompilation | |
2443 | |
2444 Are you sure you indeed need to go to a line by its number? Perhaps all | |
2445 you want is to display a line in your source file for which a compiler | |
2446 printed an error message? If so, compiling from within Emacs using the | |
2447 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more | |
2448 effective way of doing that. Emacs automatically intercepts the compile | |
2449 error messages, inserts them into a special buffer called | |
2450 @code{*compilation*}, and lets you visit the locus of each message in | |
2451 the source. Type @kbd{C-x `} to step through the offending lines one by | |
2452 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and | |
2453 @kbd{M-g M-n} to go to the previous and next matches directly). Click | |
2454 @kbd{Mouse-2} or press @key{RET} on a message text in the | |
2455 @code{*compilation*} buffer to go to the line whose number is mentioned | |
2456 in that message. | |
2457 | |
2458 But if you indeed need to go to a certain text line, type @kbd{M-g M-g} | |
2459 (which is the default binding of the @code{goto-line} function starting | |
2460 with Emacs 22). Emacs will prompt you for the number of the line and go | |
2461 to that line. | |
2462 | |
2463 You can do this faster by invoking @code{goto-line} with a numeric | |
2464 argument that is the line's number. For example, @kbd{C-u 286 M-g M-g} | |
2465 will jump to line number 286 in the current buffer. | |
2466 | |
2467 @node Modifying pull-down menus, Deleting menus and menu options, Going to a line by number, Common requests | |
2468 @section How can I create or modify new pull-down menu options? | |
2469 @cindex Pull-down menus, creating or modifying | |
2470 @cindex Menus, creating or modifying | |
2471 @cindex Creating new menu options | |
2472 @cindex Modifying pull-down menus | |
2473 @cindex Menus and keymaps | |
2474 @cindex Keymaps and menus | |
2475 | |
2476 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers}) | |
2477 represents a local or global keymap. Selecting a menu title with the | |
2478 mouse displays that keymap's non-@code{nil} contents in the form of a menu. | |
2479 | |
2480 So to add a menu option to an existing menu, all you have to do is add a | |
2481 new definition to the appropriate keymap. Adding a @samp{Forward Word} | |
2482 item to the @samp{Edit} menu thus requires the following Lisp code: | |
2483 | |
2484 @lisp | |
2485 (define-key global-map | |
2486 [menu-bar edit forward] | |
2487 '("Forward word" . forward-word)) | |
2488 @end lisp | |
2489 | |
2490 @noindent | |
2491 The first line adds the entry to the global keymap, which includes | |
2492 global menu bar entries. Replacing the reference to @code{global-map} | |
2493 with a local keymap would add this menu option only within a particular | |
2494 mode. | |
2495 | |
2496 The second line describes the path from the menu-bar to the new entry. | |
2497 Placing this menu entry underneath the @samp{File} menu would mean | |
2498 changing the word @code{edit} in the second line to @code{file}. | |
2499 | |
2500 The third line is a cons cell whose first element is the title that will | |
2501 be displayed, and whose second element is the function that will be | |
2502 called when that menu option is invoked. | |
2503 | |
2504 To add a new menu, rather than a new option to an existing menu, we must | |
2505 define an entirely new keymap: | |
2506 | |
2507 @lisp | |
2508 (define-key global-map [menu-bar words] | |
2509 (cons "Words" (make-sparse-keymap "Words"))) | |
2510 @end lisp | |
2511 | |
2512 The above code creates a new sparse keymap, gives it the name | |
2513 @samp{Words}, and attaches it to the global menu bar. Adding the | |
2514 @samp{Forward Word} item to this new menu would thus require the | |
2515 following code: | |
2516 | |
2517 @lisp | |
2518 (define-key global-map | |
2519 [menu-bar words forward] | |
2520 '("Forward word" . forward-word)) | |
2521 @end lisp | |
2522 | |
2523 @noindent | |
2524 Note that because of the way keymaps work, menu options are displayed | |
2525 with the more recently defined items at the top. Thus if you were to | |
2526 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that | |
2527 order), the menu option @samp{baz} would appear at the top, and | |
2528 @samp{foo} would be at the bottom. | |
2529 | |
2530 One way to avoid this problem is to use the function @code{define-key-after}, | |
2531 which works the same as @code{define-key}, but lets you modify where items | |
2532 appear. The following Lisp code would insert the @samp{Forward Word} | |
2533 item in the @samp{Edit} menu immediately following the @samp{Undo} item: | |
2534 | |
2535 @lisp | |
2536 (define-key-after | |
2537 (lookup-key global-map [menu-bar edit]) | |
2538 [forward] | |
2539 '("Forward word" . forward-word) | |
2540 'undo) | |
2541 @end lisp | |
2542 | |
2543 Note how the second and third arguments to @code{define-key-after} are | |
2544 different from those of @code{define-key}, and that we have added a new | |
2545 (final) argument, the function after which our new key should be | |
2546 defined. | |
2547 | |
2548 To move a menu option from one position to another, simply evaluate | |
2549 @code{define-key-after} with the appropriate final argument. | |
2550 | |
2551 More detailed information---and more examples of how to create and | |
2552 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under | |
2553 ``Menu Keymaps.'' (@xref{Emacs Lisp documentation}, for information on | |
2554 this manual.) | |
2555 | |
2556 @node Deleting menus and menu options, Turning on syntax highlighting, Modifying pull-down menus, Common requests | |
2557 @section How do I delete menus and menu options? | |
2558 @cindex Deleting menus and menu options | |
2559 @cindex Menus, deleting | |
2560 | |
2561 The simplest way to remove a menu is to set its keymap to @samp{nil}. | |
2562 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down | |
2563 menus}), use: | |
2564 | |
2565 @lisp | |
2566 (define-key global-map [menu-bar words] nil) | |
2567 @end lisp | |
2568 | |
2569 Similarly, removing a menu option requires redefining a keymap entry to | |
2570 @code{nil}. For example, to delete the @samp{Forward word} menu option | |
2571 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down | |
2572 menus}), use: | |
2573 | |
2574 @lisp | |
2575 (define-key global-map [menu-bar edit forward] nil) | |
2576 @end lisp | |
2577 | |
2578 @node Turning on syntax highlighting, Scrolling only one line, Deleting menus and menu options, Common requests | |
2579 @section How do I turn on syntax highlighting? | |
2580 @cindex Syntax highlighting | |
2581 @cindex @code{font-lock-mode} | |
2582 @cindex Highlighting based on syntax | |
2583 @cindex Colorizing text | |
2584 @cindex FAQ, @code{font-lock-mode} | |
2585 | |
2586 @code{font-lock-mode} is the standard way to have Emacs perform syntax | |
2587 highlighting in the current buffer. It is enabled by default in Emacs | |
2588 22.1 and later. | |
2589 | |
2590 With @code{font-lock-mode} turned on, different types of text will | |
2591 appear in different colors. For instance, in a programming mode, | |
2592 variables will appear in one face, keywords in a second, and comments in | |
2593 a third. | |
2594 | |
2595 @cindex hilit19 is deprecated | |
2596 Earlier versions of Emacs supported hilit19, a similar package. Use of | |
2597 hilit19 is now considered non-standard, although @file{hilit19.el} comes | |
2598 with the stock Emacs distribution. It is no longer maintained. | |
2599 | |
2600 To turn @code{font-lock-mode} off within an existing buffer, use | |
2601 @kbd{M-x font-lock-mode @key{RET}}. | |
2602 | |
2603 In Emacs 21 and earlier versions, you could use the following code in | |
2604 your @file{.emacs} file to turn on @code{font-lock-mode} globally: | |
2605 | |
2606 @lisp | |
2607 (global-font-lock-mode 1) | |
2608 @end lisp | |
2609 | |
2610 Highlighting a buffer with @code{font-lock-mode} can take quite a while, | |
2611 and cause an annoying delay in display, so several features exist to | |
2612 work around this. | |
2613 | |
2614 @cindex Just-In-Time syntax highlighting | |
2615 In Emacs 21 and later, turning on @code{font-lock-mode} automatically | |
2616 activates the new @dfn{Just-In-Time fontification} provided by | |
2617 @code{jit-lock-mode}. @code{jit-lock-mode} defers the fontification of | |
2618 portions of buffer until you actually need to see them, and can also | |
2619 fontify while Emacs is idle. This makes display of the visible portion | |
2620 of a buffer almost instantaneous. For details about customizing | |
2621 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}. | |
2622 | |
2623 @cindex Levels of syntax highlighting | |
2624 @cindex Decoration level, in @code{font-lock-mode} | |
2625 In versions of Emacs before 21, different levels of decoration are | |
2626 available, from slight to gaudy. More decoration means you need to wait | |
2627 more time for a buffer to be fontified (or a faster machine). To | |
2628 control how decorated your buffers should become, set the value of | |
2629 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a | |
2630 @code{nil} value indicating default (usually minimum) decoration, and a | |
2631 @code{t} value indicating the maximum decoration. For the gaudiest | |
2632 possible look, then, include the line | |
2633 | |
2634 @lisp | |
2635 (setq font-lock-maximum-decoration t) | |
2636 @end lisp | |
2637 | |
2638 @noindent | |
2639 in your @file{.emacs} file. You can also set this variable such that | |
2640 different modes are highlighted in a different ways; for more | |
2641 information, see the documentation for | |
2642 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x | |
2643 describe-variable @key{RET}}). | |
2644 | |
2645 Also see the documentation for the function @code{font-lock-mode}, | |
2646 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x | |
2647 describe-function @key{RET} font-lock-mode @key{RET}}). | |
2648 | |
2649 To print buffers with the faces (i.e., colors and fonts) intact, use | |
2650 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x | |
2651 ps-print-region-with-faces}. You will need a way to send text to a | |
2652 PostScript printer, or a PostScript interpreter such as Ghostscript; | |
2653 consult the documentation of the variables @code{ps-printer-name}, | |
2654 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details. | |
2655 | |
2656 @node Scrolling only one line, Editing MS-DOS files, Turning on syntax highlighting, Common requests | |
2657 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen? | |
2658 @cindex Scrolling only one line | |
2659 @cindex Reducing the increment when scrolling | |
2660 | |
2661 Customize the @code{scroll-conservatively} variable with @kbd{M-x | |
2662 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it | |
2663 to a large value like, say, 10000. For an explanation of what this | |
2664 means, @inforef{Auto Scrolling, Auto Scrolling, emacs}. | |
2665 | |
2666 Alternatively, use the following Lisp form in your @file{.emacs}: | |
2667 | |
2668 @lisp | |
2669 (setq scroll-conservatively most-positive-fixnum) | |
2670 @end lisp | |
2671 | |
2672 @node Editing MS-DOS files, Filling paragraphs with a single space, Scrolling only one line, Common requests | |
2673 @section How can I edit MS-DOS files using Emacs? | |
2674 @cindex Editing MS-DOS files | |
2675 @cindex MS-DOS files, editing | |
2676 @cindex Microsoft files, editing | |
2677 @cindex Windows files, editing | |
2678 | |
2679 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is | |
2680 performed transparently. You can open MS-DOS files on a Unix system, | |
2681 edit it, and save it without having to worry about the file format. | |
2682 | |
2683 When editing an MS-DOS style file, the mode line will indicate that it | |
2684 is a DOS file. On Unix and GNU/Linux systems, and also on a Macintosh, | |
2685 the string @samp{(DOS)} will appear near the left edge of the mode line; | |
2686 on DOS and Windows, where the DOS end-of-line (EOL) format is the | |
2687 default, a backslash (@samp{\}) will appear in the mode line. | |
2688 | |
2689 If you are running a version of Emacs before 20.1, get @code{crypt++} | |
2690 (@pxref{Packages that do not come with Emacs}). Among other things, | |
2691 @code{crypt++} transparently modifies MS-DOS files as they are loaded | |
2692 and saved, allowing you to ignore the different conventions that Unix | |
2693 and MS-DOS have for delineating the end of a line. | |
2694 | |
2695 @node Filling paragraphs with a single space, Escape sequences in shell output, Editing MS-DOS files, Common requests | |
2696 @section How can I tell Emacs to fill paragraphs with a single space after each period? | |
2697 @cindex One space following periods | |
2698 @cindex Single space following periods | |
2699 @cindex Periods, one space following | |
2700 | |
2701 Add the following line to your @file{.emacs} file: | |
2702 | |
2703 @lisp | |
2704 (setq sentence-end-double-space nil) | |
2705 @end lisp | |
2706 | |
2707 @node Escape sequences in shell output, Fullscreen mode on MS-Windows, Filling paragraphs with a single space, Common requests | |
2708 @section Why these strange escape sequences from @code{ls} from the Shell mode? | |
2709 @cindex Escape sequences in @code{ls} output | |
2710 @cindex @code{ls} in Shell mode | |
2711 | |
2712 This happens because @code{ls} is aliased to @samp{ls --color} in your | |
2713 shell init file. You have two alternatives to solve this: | |
2714 | |
2715 @itemize @bullet | |
2716 @item | |
2717 Make the alias conditioned on the @code{EMACS} variable in the | |
2718 environment. When Emacs runs a subsidiary shell, it exports the | |
2719 @code{EMACS} variable to that shell, with value equal to the absolute | |
2720 file name of Emacs. You can | |
2721 unalias @code{ls} when that happens, thus limiting the alias to your | |
2722 interactive sessions. | |
2723 | |
2724 @item | |
2725 Install the @code{ansi-color} package (bundled with Emacs 21.1 and | |
2726 later), which converts these ANSI escape sequences into colors. | |
2727 @end itemize | |
2728 | |
2729 @node Fullscreen mode on MS-Windows, , Escape sequences in shell output, Common requests | |
2730 @section How can I start Emacs in fullscreen mode on MS-Windows? | |
2731 @cindex Maximize frame | |
2732 @cindex Fullscreen mode | |
2733 | |
2734 Use the function @code{w32-send-sys-command}. For example, you can | |
2735 put the following in your @file{.emacs} file: | |
2736 | |
2737 @lisp | |
2738 (add-hook 'term-setup-hook | |
2739 #'(lambda () (w32-send-sys-command ?\xF030))) | |
2740 @end lisp | |
2741 | |
2742 To avoid the slightly distracting visual effect of Emacs starting with | |
2743 its default frame size and then growing to fullscreen, you can add an | |
2744 @samp{Emacs.Geometry} entry to the Windows registry settings (see | |
2745 @pxref{(emacs)X Resources}). | |
2746 | |
2747 To compute the correct values for width and height, first maximize the | |
2748 Emacs frame and then evaluate @code{(frame-height)} and | |
2749 @code{(frame-width)} with @kbd{M-:}. | |
2750 | |
2751 @c ------------------------------------------------------------ | |
2752 @node Bugs and problems, Compiling and installing Emacs, Common requests, Top | |
2753 @chapter Bugs and problems | |
2754 @cindex Bugs and problems | |
2755 | |
2756 The Emacs manual lists some common kinds of trouble users could get | |
2757 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU | |
2758 Emacs Manual}, so you might look there if the problem you encounter | |
2759 isn't described in this chapter. If you decide you've discovered a bug, | |
2760 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for | |
2761 instructions how to do that. | |
2762 | |
2763 The file @file{etc/PROBLEMS} in the Emacs distribution lists various | |
2764 known problems with building and using Emacs on specific platforms; | |
2765 type @kbd{C-h C-e} to read it. | |
2766 | |
2767 @menu | |
2768 * Problems with very large files:: | |
2769 * ^M in the shell buffer:: | |
2770 * Shell process exits abnormally:: | |
2771 * Problems with Shell Mode on MS-Windows:: | |
2772 * Termcap/Terminfo entries for Emacs:: | |
2773 * Spontaneous entry into isearch-mode:: | |
2774 * Problems talking to certain hosts:: | |
2775 * Errors with init files:: | |
2776 * Emacs ignores X resources:: | |
2777 * Emacs ignores frame parameters:: | |
2778 * Emacs takes a long time to visit files:: | |
2779 * Editing files with $ in the name:: | |
2780 * Shell mode loses the current directory:: | |
2781 * Security risks with Emacs:: | |
2782 * Dired claims that no file is on this line:: | |
2783 @end menu | |
2784 | |
2785 @node Problems with very large files, ^M in the shell buffer, Bugs and problems, Bugs and problems | |
2786 @section Does Emacs have problems with files larger than 8 megabytes? | |
2787 @cindex Very large files, opening | |
2788 @cindex Large files, opening | |
2789 @cindex Opening very large files | |
2790 @cindex Maximum file size | |
2791 @cindex Files, maximum size | |
2792 | |
2793 Old versions (i.e., anything before 19.29) of Emacs had problems editing | |
2794 files larger than 8 megabytes. In versions 19.29 and later, the maximum | |
2795 buffer size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes. | |
2796 And in Emacs 22, the maximum buffer size has been increased to | |
2797 268,435,455 bytes (or 256 MBytes) on 32-bit machines. | |
2798 | |
2799 @node ^M in the shell buffer, Shell process exits abnormally, Problems with very large files, Bugs and problems | |
2800 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer? | |
2801 @cindex Shell buffer, echoed commands and @samp{^M} in | |
2802 @cindex Echoed commands in @code{shell-mode} | |
2803 | |
2804 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to | |
2805 make them go away. If that doesn't work, you have several options: | |
2806 | |
2807 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc}) | |
2808 file: | |
2809 | |
2810 @example | |
2811 if ($?EMACS) then | |
2812 if ("$EMACS" =~ /*) then | |
2813 if ($?tcsh) unset edit | |
2814 stty nl | |
2815 endif | |
2816 endif | |
2817 @end example | |
2818 | |
2819 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file: | |
2820 | |
2821 @example | |
2822 unset edit | |
2823 stty nl | |
2824 @end example | |
2825 | |
2826 Alternatively, use @code{csh} in your shell buffers instead of | |
2827 @code{tcsh}. One way is: | |
2828 | |
2829 @lisp | |
2830 (setq explicit-shell-file-name "/bin/csh") | |
2831 @end lisp | |
2832 | |
2833 @noindent | |
2834 and another is to do this in your @file{.cshrc} (or @file{.tcshrc}) | |
2835 file: | |
2836 | |
2837 @example | |
2838 setenv ESHELL /bin/csh | |
2839 @end example | |
2840 | |
2841 @noindent | |
2842 (You must start Emacs over again with the environment variable properly | |
2843 set for this to take effect.) | |
2844 | |
2845 You can also set the @code{ESHELL} environment variable in Emacs Lisp | |
2846 with the following Lisp form, | |
2847 | |
2848 @lisp | |
2849 (setenv "ESHELL" "/bin/csh") | |
2850 @end lisp | |
2851 | |
2852 The above solutions try to prevent the shell from producing the | |
2853 @samp{^M} characters in the first place. If this is not possible | |
2854 (e.g., if you use a Windows shell), you can get Emacs to remove these | |
2855 characters from the buffer by adding this to your @file{.emacs} init | |
2856 file: | |
2857 | |
2858 @smalllisp | |
2859 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m) | |
2860 @end smalllisp | |
2861 | |
2862 On a related note: if your shell is echoing your input line in the shell | |
2863 buffer, you might want to customize the @code{comint-process-echoes} | |
2864 variable in your shell buffers, or try the following command in your | |
2865 shell start-up file: | |
2866 | |
2867 @example | |
2868 stty -icrnl -onlcr -echo susp ^Z | |
2869 @end example | |
2870 | |
2871 @node Shell process exits abnormally, Problems with Shell Mode on MS-Windows, ^M in the shell buffer, Bugs and problems | |
2872 @section Why do I get ``Process shell exited abnormally with code 1''? | |
2873 @cindex Abnormal exits from @code{shell-mode} | |
2874 @cindex @code{shell-mode} exits | |
2875 @cindex Process shell exited | |
2876 | |
2877 The most likely reason for this message is that the @samp{env} program | |
2878 is not properly installed. Compile this program for your architecture, | |
2879 and install it with @samp{a+x} permission in the architecture-dependent | |
2880 Emacs program directory. (You can find what this directory is at your | |
2881 site by inspecting the value of the variable @code{exec-directory} by | |
2882 typing @kbd{C-h v exec-directory @key{RET}}.) | |
2883 | |
2884 You should also check for other programs named @samp{env} in your path | |
2885 (e.g., SunOS has a program named @file{/usr/bin/env}). We don't | |
2886 understand why this can cause a failure and don't know a general | |
2887 solution for working around the problem in this case. | |
2888 | |
2889 The @samp{make clean} command will remove @samp{env} and other vital | |
2890 programs, so be careful when using it. | |
2891 | |
2892 It has been reported that this sometimes happened when Emacs was started | |
2893 as an X client from an xterm window (i.e., had a controlling tty) but the | |
2894 xterm was later terminated. | |
2895 | |
2896 See also @samp{PROBLEMS} (in the @file{etc} subdirectory of the | |
2897 top-level directory when you unpack the Emacs source) for other | |
2898 possible causes of this message. | |
2899 | |
2900 @node Problems with Shell Mode on MS-Windows, Termcap/Terminfo entries for Emacs, Shell process exits abnormally, Bugs and problems | |
2901 @section Why do I get an error message when I try to run @kbd{M-x shell}? | |
2902 | |
2903 @cindex Shell Mode, and MS-Windows | |
2904 @cindex @code{explicit-shell-file-name} | |
2905 On MS-Windows, this might happen because Emacs tries to look for the | |
2906 shell in a wrong place. The default file name @file{/bin/sh} is | |
2907 usually incorrect for non-Unix systems. If you know where your shell | |
2908 executable is, set the variable @code{explicit-shell-file-name} in | |
2909 your @file{.emacs} file to point to its full file name, like this: | |
2910 | |
2911 @lisp | |
2912 (setq explicit-shell-file-name "d:/shells/bash.exe") | |
2913 @end lisp | |
2914 | |
2915 If you don't know what shell does Emacs use, try the @kbd{M-!} | |
2916 command; if that works, put the following line into your | |
2917 @file{.emacs}: | |
2918 | |
2919 @lisp | |
2920 (setq explicit-shell-file-name shell-file-name) | |
2921 @end lisp | |
2922 | |
2923 @cindex Antivirus programs, and Shell Mode | |
2924 Some people have trouble with Shell Mode because of intrusive | |
2925 antivirus software; disabling the resident antivirus program solves | |
2926 the problems in those cases. | |
2927 | |
2928 @node Termcap/Terminfo entries for Emacs, Spontaneous entry into isearch-mode, Problems with Shell Mode on MS-Windows, Bugs and problems | |
2929 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}? | |
2930 @cindex Termcap | |
2931 @cindex Terminfo | |
2932 @cindex Emacs entries for termcap/terminfo | |
2933 | |
2934 The termcap entry for terminal type @samp{emacs} is ordinarily put in | |
2935 the @samp{TERMCAP} environment variable of subshells. It may help in | |
2936 certain situations (e.g., using rlogin from shell buffer) to add an | |
2937 entry for @samp{emacs} to the system-wide termcap file. Here is a | |
2938 correct termcap entry for @samp{emacs}: | |
2939 | |
2940 @example | |
2941 emacs:tc=unknown: | |
2942 @end example | |
2943 | |
2944 To make a terminfo entry for @samp{emacs}, use @code{tic} or | |
2945 @code{captoinfo}. You need to generate | |
2946 @file{/usr/lib/terminfo/e/emacs}. It may work to simply copy | |
2947 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}. | |
2948 | |
2949 Having a termcap/terminfo entry will not enable the use of full screen | |
2950 programs in shell buffers. Use @kbd{M-x terminal-emulator} for that | |
2951 instead. | |
2952 | |
2953 A workaround to the problem of missing termcap/terminfo entries is to | |
2954 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown} | |
2955 in your shell start up file. @code{csh} users could put this in their | |
2956 @file{.cshrc} files: | |
2957 | |
2958 @example | |
2959 if ("$term" == emacs) set term=dumb | |
2960 @end example | |
2961 | |
2962 @node Spontaneous entry into isearch-mode, Problems talking to certain hosts, Termcap/Terminfo entries for Emacs, Bugs and problems | |
2963 @section Why does Emacs spontaneously start displaying @samp{I-search:} and beeping? | |
2964 @cindex Spontaneous entry into isearch-mode | |
2965 @cindex isearch-mode, spontaneous entry into | |
2966 @cindex Beeping without obvious reason | |
2967 | |
2968 Your terminal (or something between your terminal and the computer) is | |
2969 sending @kbd{C-s} and @kbd{C-q} for flow control, and Emacs is receiving | |
2970 these characters and interpreting them as commands. (The @kbd{C-s} | |
2971 character normally invokes the @code{isearch-forward} command.) For | |
2972 possible solutions, see @ref{Handling C-s and C-q with flow control}. | |
2973 | |
2974 @node Problems talking to certain hosts, Errors with init files, Spontaneous entry into isearch-mode, Bugs and problems | |
2975 @section Why can't Emacs talk to certain hosts (or certain hostnames)? | |
2976 @cindex Hosts, Emacs cannot talk to | |
2977 @cindex @code{gethostbyname}, problematic version | |
2978 | |
2979 The problem may be that Emacs is linked with a wimpier version of | |
2980 @code{gethostbyname} than the rest of the programs on the machine. This | |
2981 is often manifested as a message on startup of ``X server not responding. | |
2982 Check your @samp{DISPLAY} environment variable.'' or a message of | |
2983 ``Unknown host'' from @code{open-network-stream}. | |
2984 | |
2985 On a Sun, this may be because Emacs had to be linked with the static C | |
2986 library. The version of @code{gethostbyname} in the static C library | |
2987 may only look in @file{/etc/hosts} and the NIS (YP) maps, while the | |
2988 version in the dynamic C library may be smart enough to check DNS in | |
2989 addition to or instead of NIS. On a Motorola Delta running System V | |
2990 R3.6, the version of @code{gethostbyname} in the standard library works, | |
2991 but the one that works with NIS doesn't (the one you get with -linet). | |
2992 Other operating systems have similar problems. | |
2993 | |
2994 Try these options: | |
2995 | |
2996 @itemize @bullet | |
2997 | |
2998 @item | |
2999 Explicitly add the host you want to communicate with to @file{/etc/hosts}. | |
3000 | |
3001 @item | |
3002 Relink Emacs with this line in @file{src/config.h}: | |
3003 | |
3004 @example | |
3005 #define LIBS_SYSTEM -lresolv | |
3006 @end example | |
3007 | |
3008 @item | |
3009 Replace @code{gethostbyname} and friends in @file{libc.a} with more | |
3010 useful versions such as the ones in @file{libresolv.a}. Then relink | |
3011 Emacs. | |
3012 | |
3013 @item | |
3014 If you are actually running NIS, make sure that @code{ypbind} is | |
3015 properly told to do DNS lookups with the correct command line switch. | |
3016 | |
3017 @end itemize | |
3018 | |
3019 @node Errors with init files, Emacs ignores X resources, Problems talking to certain hosts, Bugs and problems | |
3020 @section Why does Emacs say @samp{Error in init file}? | |
3021 @cindex Error in @file{.emacs} | |
3022 @cindex Error in init file | |
3023 @cindex Init file, errors in | |
3024 @cindex @file{.emacs} file, errors in | |
3025 @cindex Debugging @file{.emacs} file | |
3026 | |
3027 An error occurred while loading either your @file{.emacs} file or the | |
3028 system-wide file @file{lisp/default.el}. Emacs 21.1 and later pops the | |
3029 @file{*Messages*} buffer, and puts there some additional information | |
3030 about the error, to provide some hints for debugging. | |
3031 | |
3032 For information on how to debug your @file{.emacs} file, see | |
3033 @ref{Debugging a customization file}. | |
3034 | |
3035 It may be the case that you need to load some package first, or use a | |
3036 hook that will be evaluated after the package is loaded. A common case | |
3037 of this is explained in @ref{Terminal setup code works after Emacs has | |
3038 begun}. | |
3039 | |
3040 @node Emacs ignores X resources, Emacs ignores frame parameters, Errors with init files, Bugs and problems | |
3041 @section Why does Emacs ignore my X resources (my .Xdefaults file)? | |
3042 @cindex X resources being ignored | |
3043 @cindex Ignored X resources | |
3044 @cindex @file{.Xdefaults} | |
3045 | |
3046 As of version 19, Emacs searches for X resources in the files specified | |
3047 by the following environment variables: | |
3048 | |
3049 @itemize @bullet | |
3050 | |
3051 @item @code{XFILESEARCHPATH} | |
3052 @item @code{XUSERFILESEARCHPATH} | |
3053 @item @code{XAPPLRESDIR} | |
3054 | |
3055 @end itemize | |
3056 | |
3057 This emulates the functionality provided by programs written using the | |
3058 Xt toolkit. | |
3059 | |
3060 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list | |
3061 of file names separated by colons. @code{XAPPLRESDIR} should be a list | |
3062 of directory names separated by colons. | |
3063 | |
3064 Emacs searches for X resources: | |
3065 | |
3066 @enumerate | |
3067 | |
3068 @item | |
3069 specified on the command line, with the @samp{-xrm RESOURCESTRING} option, | |
3070 | |
3071 @item | |
3072 then in the value of the @samp{XENVIRONMENT} environment variable, | |
3073 | |
3074 @itemize @minus | |
3075 | |
3076 @item | |
3077 or if that is unset, in the file named | |
3078 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is | |
3079 the name of the machine Emacs is running on), | |
3080 | |
3081 @end itemize | |
3082 | |
3083 @item | |
3084 then in the screen-specific and server-wide resource properties provided | |
3085 by the server, | |
3086 | |
3087 @itemize @minus | |
3088 | |
3089 @item | |
3090 or if those properties are unset, in the file named @file{~/.Xdefaults} | |
3091 if it exists, | |
3092 | |
3093 @end itemize | |
3094 | |
3095 @item | |
3096 then in the files listed in @samp{XUSERFILESEARCHPATH}, | |
3097 | |
3098 @itemize @minus | |
3099 | |
3100 @item | |
3101 or in files named @file{@var{lang}/Emacs} in directories listed in | |
3102 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG} | |
3103 environment variable), if the @samp{LANG} environment variable is set, | |
3104 @item | |
3105 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR} | |
3106 @item | |
3107 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable | |
3108 is set), | |
3109 @item | |
3110 or in @file{~/Emacs}, | |
3111 | |
3112 @end itemize | |
3113 | |
3114 @item | |
3115 then in the files listed in @code{XFILESEARCHPATH}. | |
3116 | |
3117 @end enumerate | |
3118 | |
3119 @node Emacs ignores frame parameters, Emacs takes a long time to visit files, Emacs ignores X resources, Bugs and problems | |
3120 @section Why don't my customizations of the frame parameters work? | |
3121 @cindex Frame parameters | |
3122 | |
3123 This probably happens because you have set the frame parameters in the | |
3124 variable @code{initial-frame-alist}. That variable holds parameters | |
3125 used only for the first frame created when Emacs starts. To customize | |
3126 the parameters of all frames, change the variable | |
3127 @code{default-frame-alist} instead. | |
3128 | |
3129 These two variables exist because many users customize the initial frame | |
3130 in a special way. For example, you could determine the position and | |
3131 size of the initial frame, but would like to control the geometry of the | |
3132 other frames by individually positioning each one of them. | |
3133 | |
3134 | |
3135 @node Emacs takes a long time to visit files, Editing files with $ in the name, Emacs ignores frame parameters, Bugs and problems | |
3136 @section Why does Emacs take 20 seconds to visit a file? | |
3137 @cindex Visiting files takes a long time | |
3138 @cindex Delay when visiting files | |
3139 @cindex Files, take a long time to visit | |
3140 | |
3141 Old versions of Emacs (i.e., versions before Emacs 20.x) often | |
3142 encountered this when the master lock file, @file{!!!SuperLock!!!}, has | |
3143 been left in the lock directory somehow. Delete it. | |
3144 | |
3145 @email{meuer@@geom.umn.edu, Mark Meuer} says that NeXT NFS has a bug | |
3146 where an exclusive create succeeds but returns an error status. This | |
3147 can cause the same problem. Since Emacs's file locking doesn't work | |
3148 over NFS anyway, the best solution is to recompile Emacs with | |
3149 @code{CLASH_DETECTION} undefined. | |
3150 | |
3151 @node Editing files with $ in the name, Shell mode loses the current directory, Emacs takes a long time to visit files, Bugs and problems | |
3152 @section How do I edit a file with a @samp{$} in its name? | |
3153 @cindex Editing files with @samp{$} in the name | |
3154 @cindex @samp{$} in file names | |
3155 @cindex File names containing @samp{$}, editing | |
3156 | |
3157 When entering a file name in the minibuffer, Emacs will attempt to expand | |
3158 a @samp{$} followed by a word as an environment variable. To suppress | |
3159 this behavior, type @kbd{$$} instead. | |
3160 | |
3161 @node Shell mode loses the current directory, Security risks with Emacs, Editing files with $ in the name, Bugs and problems | |
3162 @section Why does shell mode lose track of the shell's current directory? | |
3163 @cindex Current directory and @code{shell-mode} | |
3164 @cindex @code{shell-mode} and current directory | |
3165 @cindex Directory, current in @code{shell-mode} | |
3166 | |
3167 Emacs has no way of knowing when the shell actually changes its | |
3168 directory. This is an intrinsic limitation of Unix. So it tries to | |
3169 guess by recognizing @samp{cd} commands. If you type @kbd{cd} followed | |
3170 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or | |
3171 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to | |
3172 correctly guess the shell's new current directory. A huge variety of | |
3173 fixes and enhancements to shell mode for this problem have been written | |
3174 to handle this problem (@pxref{Finding a package with particular | |
3175 functionality}). | |
3176 | |
3177 You can tell Emacs the shell's current directory with the command | |
3178 @kbd{M-x dirs}. | |
3179 | |
3180 @node Security risks with Emacs, Dired claims that no file is on this line, Shell mode loses the current directory, Bugs and problems | |
3181 @section Are there any security risks in Emacs? | |
3182 @cindex Security with Emacs | |
3183 @cindex @samp{movemail} and security | |
3184 @cindex @code{file-local-variable} and security | |
3185 @cindex Synthetic X events and security | |
3186 @cindex X events and security | |
3187 | |
3188 @itemize @bullet | |
3189 | |
3190 @item | |
3191 The @file{movemail} incident. (No, this is not a risk.) | |
3192 | |
3193 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in | |
3194 chapter 4. The site at LBL had installed the @file{/etc/movemail} | |
3195 program setuid root. (As of version 19, @file{movemail} is in your | |
3196 architecture-specific directory; type @kbd{C-h v exec-directory | |
3197 @key{RET}} to see what it is.) Since @code{movemail} had not been | |
3198 designed for this situation, a security hole was created and users could | |
3199 get root privileges. | |
3200 | |
3201 @code{movemail} has since been changed so that this security hole will | |
3202 not exist, even if it is installed setuid root. However, | |
3203 @code{movemail} no longer needs to be installed setuid root, which | |
3204 should eliminate this particular risk. | |
3205 | |
3206 We have heard unverified reports that the 1988 Internet worm took | |
3207 advantage of this configuration problem. | |
3208 | |
3209 @item | |
3210 The @code{file-local-variable} feature. (Yes, a risk, but easy to | |
3211 change.) | |
3212 | |
3213 There is an Emacs feature that allows the setting of local values for | |
3214 variables when editing a file by including specially formatted text near | |
3215 the end of the file. This feature also includes the ability to have | |
3216 arbitrary Emacs Lisp code evaluated when the file is visited. | |
3217 Obviously, there is a potential for Trojan horses to exploit this | |
3218 feature. | |
3219 | |
3220 As of Emacs 22, Emacs has a list of local variables that are known to | |
3221 be safe to set. If a file tries to set any variable outside this | |
3222 list, it asks the user to confirm whether the variables should be set. | |
3223 You can also tell Emacs whether to allow the evaluation of Emacs Lisp | |
3224 code found at the bottom of files by setting the variable | |
3225 @code{enable-local-eval}. | |
3226 | |
3227 For more information, @inforef{File Variables, File Variables, emacs}. | |
3228 | |
3229 @item | |
3230 Synthetic X events. (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or | |
3231 better.) | |
3232 | |
3233 Emacs accepts synthetic X events generated by the @code{SendEvent} | |
3234 request as though they were regular events. As a result, if you are | |
3235 using the trivial host-based authentication, other users who can open X | |
3236 connections to your X workstation can make your Emacs process do | |
3237 anything, including run other processes with your privileges. | |
3238 | |
3239 The only fix for this is to prevent other users from being able to open | |
3240 X connections. The standard way to prevent this is to use a real | |
3241 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}. If using | |
3242 the @code{xauth} program has any effect, then you are probably using | |
3243 @samp{MIT-MAGIC-COOKIE-1}. Your site may be using a superior | |
3244 authentication method; ask your system administrator. | |
3245 | |
3246 If real authentication is not a possibility, you may be satisfied by | |
3247 just allowing hosts access for brief intervals while you start your X | |
3248 programs, then removing the access. This reduces the risk somewhat by | |
3249 narrowing the time window when hostile users would have access, but | |
3250 @emph{does not eliminate the risk}. | |
3251 | |
3252 On most computers running Unix and X, you enable and disable | |
3253 access using the @code{xhost} command. To allow all hosts access to | |
3254 your X server, use | |
3255 | |
3256 @example | |
3257 xhost + | |
3258 @end example | |
3259 | |
3260 @noindent | |
3261 at the shell prompt, which (on an HP machine, at least) produces the | |
3262 following message: | |
3263 | |
3264 @example | |
3265 access control disabled, clients can connect from any host | |
3266 @end example | |
3267 | |
3268 To deny all hosts access to your X server (except those explicitly | |
3269 allowed by name), use | |
3270 | |
3271 @example | |
3272 xhost - | |
3273 @end example | |
3274 | |
3275 On the test HP computer, this command generated the following message: | |
3276 | |
3277 @example | |
3278 access control enabled, only authorized clients can connect | |
3279 @end example | |
3280 | |
3281 @end itemize | |
3282 | |
3283 @node Dired claims that no file is on this line, , Security risks with Emacs, Bugs and problems | |
3284 @section Dired says, @samp{no file on this line} when I try to do something. | |
3285 @cindex Dired does not see a file | |
3286 | |
3287 @c FIXME: I think this is fixed in Emacs 21, but I didn't have time to | |
3288 @c check. | |
3289 Chances are you're using a localized version of Unix that doesn't use US | |
3290 date format in dired listings. You can check this by looking at dired | |
3291 listings or by typing @kbd{ls -l} to a shell and looking at the dates that | |
3292 come out. | |
3293 | |
3294 Dired uses a regular expression to find the beginning of a file name. | |
3295 In a long Unix-style directory listing (@samp{ls -l}), the file name | |
3296 starts after the date. The regexp has thus been written to look for the | |
3297 date, the format of which can vary on non-US systems. | |
3298 | |
3299 There are two approaches to solving this. The first one involves | |
3300 setting things up so that @samp{ls -l} outputs US date format. This can | |
3301 be done by setting the locale. See your OS manual for more information. | |
3302 | |
3303 The second approach involves changing the regular expression used by | |
3304 dired, @code{directory-listing-before-filename-regexp}. | |
3305 | |
3306 @c ------------------------------------------------------------ | |
3307 @node Compiling and installing Emacs, Finding Emacs and related packages, Bugs and problems, Top | |
3308 @chapter Compiling and installing Emacs | |
3309 @cindex Compiling and installing Emacs | |
3310 | |
3311 @menu | |
3312 * Installing Emacs:: | |
3313 * Updating Emacs:: | |
3314 * Problems building Emacs:: | |
3315 * Linking with -lX11 fails:: | |
3316 @end menu | |
3317 | |
3318 @node Installing Emacs, Updating Emacs, Compiling and installing Emacs, Compiling and installing Emacs | |
3319 @section How do I install Emacs? | |
3320 @cindex Installing Emacs | |
3321 @cindex Unix systems, installing Emacs on | |
3322 @cindex Downloading and installing Emacs | |
3323 @cindex Retrieving and installing Emacs | |
3324 @cindex Building Emacs from source | |
3325 @cindex Source code, building Emacs from | |
3326 @cindex Unpacking and installing Emacs | |
3327 | |
3328 This answer is meant for users of Unix and Unix-like systems. Users of | |
3329 other operating systems should see the series of questions beginning | |
3330 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source | |
3331 and binaries, and how to install Emacs on those systems. | |
3332 | |
3333 For Unix and Unix-like systems, the easiest way is often to compile it | |
3334 from scratch. You will need: | |
3335 | |
3336 @itemize @bullet | |
3337 | |
3338 @item | |
3339 Emacs sources. @xref{Current GNU distributions}, for a list of ftp sites | |
3340 that make them available. On @file{ftp.gnu.org}, the main GNU | |
3341 distribution site, sources are available as | |
3342 | |
3343 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-@value{VER}.tar.gz} | |
3344 | |
3345 The above will obviously change as new versions of Emacs come out. For | |
3346 instance, when Emacs 22.42 is released, it will most probably be | |
3347 available as | |
3348 | |
3349 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-22.42.tar.gz} | |
3350 | |
3351 Again, you should use one of the GNU mirror sites (see @ref{Current GNU | |
3352 distributions}, and adjust the URL accordingly) so as to reduce load on | |
3353 @file{ftp.gnu.org}. | |
3354 | |
3355 @item | |
3356 @code{gzip}, the GNU compression utility. You can get @code{gzip} via | |
3357 anonymous ftp at mirrors of @file{ftp.gnu.org} sites; it should compile | |
3358 and install without much trouble on most systems. Once you have | |
3359 retrieved the Emacs sources, you will probably be able to uncompress | |
3360 them with the command | |
3361 | |
3362 @example | |
3363 gunzip --verbose emacs-@value{VER}.tar.gz | |
3364 @end example | |
3365 | |
3366 @noindent | |
3367 changing the Emacs version (@value{VER}), as necessary. Once | |
3368 @code{gunzip} has finished doing its job, a file by the name of | |
3369 @file{emacs-@value{VER}.tar} should be in your build directory. | |
3370 | |
3371 @item | |
3372 @code{tar}, the @dfn{tape archiving} program, which moves multiple files | |
3373 into and out of archive files, or @dfn{tarfiles}. All of the files | |
3374 comprising the Emacs source come in a single tarfile, and must be | |
3375 extracted using @code{tar} before you can build Emacs. Typically, the | |
3376 extraction command would look like | |
3377 | |
3378 @example | |
3379 tar -xvvf emacs-@value{VER}.tar | |
3380 @end example | |
3381 | |
3382 @noindent | |
3383 The @samp{x} indicates that we want to extract files from this tarfile, | |
3384 the two @samp{v}s force verbose output, and the @samp{f} tells | |
3385 @code{tar} to use a disk file, rather than one on the tape drive. | |
3386 | |
3387 If you're using GNU @code{tar} (available at mirrors of | |
3388 @file{ftp.gnu.org}), you can combine this step and the previous one by | |
3389 using the command | |
3390 | |
3391 @example | |
3392 tar -zxvvf emacs-@value{VER}.tar.gz | |
3393 @end example | |
3394 | |
3395 @noindent | |
3396 The additional @samp{z} at the beginning of the options list tells GNU | |
3397 @code{tar} to uncompress the file with @code{gunzip} before extracting | |
3398 the tarfile's components. | |
3399 | |
3400 @end itemize | |
3401 | |
3402 At this point, the Emacs sources (all 70+ megabytes of them) should be | |
3403 sitting in a directory called @file{emacs-@value{VER}}. On most common | |
3404 Unix and Unix-like systems, you should be able to compile Emacs (with X | |
3405 Window system support) with the following commands: | |
3406 | |
3407 @example | |
3408 cd emacs-@value{VER} # change directory to emacs-@value{VER} | |
3409 ./configure # configure Emacs for your particular system | |
3410 make # use Makefile to build components, then Emacs | |
3411 @end example | |
3412 | |
3413 If the @code{make} completes successfully, the odds are fairly good that | |
3414 the build has gone well. (@xref{Problems building Emacs}, if you weren't | |
3415 successful.) | |
3416 | |
3417 By default, Emacs is installed in the following directories: | |
3418 | |
3419 @table @file | |
3420 @item /usr/local/bin | |
3421 binaries. | |
3422 | |
3423 @item /usr/local/share/emacs/@value{VER} | |
3424 Lisp code and support files. | |
3425 | |
3426 @item /usr/local/info | |
3427 Info documentation. | |
3428 @end table | |
3429 | |
3430 To install files in those default directories, become the superuser and | |
3431 type | |
3432 | |
3433 @example | |
3434 make install | |
3435 @end example | |
3436 | |
3437 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs} | |
3438 and any Emacs Info files that might be in @file{/usr/local/info}. | |
3439 | |
3440 Much more verbose instructions (with many more hints and suggestions) | |
3441 come with the Emacs sources, in the file @file{INSTALL}. | |
3442 | |
3443 @node Updating Emacs, Problems building Emacs, Installing Emacs, Compiling and installing Emacs | |
3444 @section How do I update Emacs to the latest version? | |
3445 @cindex Updating Emacs | |
3446 | |
3447 @xref{Installing Emacs}, and follow the instructions there for | |
3448 installation. | |
3449 | |
3450 Most files are placed in version-specific directories. Emacs | |
3451 @value{VER}, for instance, places files in | |
3452 @file{/usr/local/share/emacs/@value{VER}}. | |
3453 | |
3454 Upgrading should overwrite only, @file{/usr/local/bin/emacs} (the Emacs | |
3455 binary) and documentation in @file{/usr/local/info}. Back up these | |
3456 files before you upgrade, and you shouldn't have too much trouble. | |
3457 | |
3458 @node Problems building Emacs, Linking with -lX11 fails, Updating Emacs, Compiling and installing Emacs | |
3459 @section What should I do if I have trouble building Emacs? | |
3460 @cindex Problems building Emacs | |
3461 @cindex Errors when building Emacs | |
3462 | |
3463 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs | |
3464 source) to see if there is already a solution for your problem. Next, | |
3465 look for other questions in this FAQ that have to do with Emacs | |
3466 installation and compilation problems. | |
3467 | |
3468 If you'd like to have someone look at your problem and help solve it, | |
3469 see @ref{Help installing Emacs}. | |
3470 | |
3471 If you cannot find a solution in the documentation, send a message to | |
3472 @email{bug-gnu-emacs@@gnu.org}. | |
3473 | |
3474 Please don't post it to @uref{news:gnu.emacs.help} or send e-mail to | |
3475 @email{help-gnu-emacs@@gnu.org}. For further guidelines, see | |
3476 @ref{Guidelines for newsgroup postings} and @ref{Reporting bugs}. | |
3477 | |
3478 @node Linking with -lX11 fails, , Problems building Emacs, Compiling and installing Emacs | |
3479 @section Why does linking Emacs with -lX11 fail? | |
3480 @cindex Linking with -lX11 fails | |
3481 @cindex lX11, linking fails with | |
3482 | |
3483 Emacs needs to be linked with the static version of the X11 library, | |
3484 @file{libX11.a}. This may be missing. | |
3485 | |
3486 On OpenWindows, you may need to use @code{add_services} to add the | |
3487 ``OpenWindows Programmers'' optional software category from the CD-ROM. | |
3488 | |
3489 On HP-UX 8.0, you may need to run @code{update} again to load the | |
3490 X11-PRG ``fileset.'' This may be missing even if you specified ``all | |
3491 filesets'' the first time. If @file{libcurses.a} is missing, you may | |
3492 need to load the ``Berkeley Development Option.'' | |
3493 | |
3494 @email{zoo@@armadillo.com, David Zuhn} says that MIT X builds shared | |
3495 libraries by default, and only shared libraries, on those platforms that | |
3496 support them. These shared libraries can't be used when undumping | |
3497 @code{temacs} (the last stage of the Emacs build process). To get | |
3498 regular libraries in addition to shared libraries, add this to | |
3499 @file{site.cf}: | |
3500 | |
3501 @example | |
3502 #define ForceNormalLib YES | |
3503 @end example | |
3504 | |
3505 Other systems may have similar problems. You can always define | |
3506 @code{CANNOT_DUMP} and link with the shared libraries instead. | |
3507 | |
3508 @cindex X Menus don't work | |
3509 To get the Xmenu stuff to work, you need to find a copy of MIT's | |
3510 @file{liboldX.a}. | |
3511 | |
3512 @c ------------------------------------------------------------ | |
3513 @node Finding Emacs and related packages, Major packages and programs, Compiling and installing Emacs, Top | |
3514 @chapter Finding Emacs and related packages | |
3515 @cindex Finding Emacs and related packages | |
3516 | |
3517 @menu | |
3518 * Finding Emacs on the Internet:: | |
3519 * Finding a package with particular functionality:: | |
3520 * Packages that do not come with Emacs:: | |
3521 * Current GNU distributions:: | |
3522 * Difference between Emacs and XEmacs:: | |
3523 * Emacs for MS-DOS:: | |
3524 * Emacs for Windows:: | |
3525 * Emacs for OS/2:: | |
3526 * Emacs for Atari ST:: | |
3527 * Emacs for the Amiga :: | |
3528 * Emacs for NeXTSTEP:: | |
3529 * Emacs for Apple computers:: | |
3530 * Emacs for VMS and DECwindows:: | |
3531 * Modes for various languages:: | |
3532 @end menu | |
3533 | |
3534 @node Finding Emacs on the Internet, Finding a package with particular functionality, Finding Emacs and related packages, Finding Emacs and related packages | |
3535 @section Where can I get Emacs on the net (or by snail mail)? | |
3536 @cindex Finding Emacs on the Internet | |
3537 @cindex Snail mail, ordering Emacs via | |
3538 @cindex Postal service, ordering Emacs via | |
3539 @cindex Distribution, retrieving Emacs | |
3540 @cindex Internet, retrieving from | |
3541 | |
3542 Look in the files @file{etc/DISTRIB} and @file{etc/FTP} for | |
3543 information on nearby archive sites. If you don't already have Emacs, | |
3544 see @ref{Informational files for Emacs}, for how to get these files. | |
3545 | |
3546 @xref{Installing Emacs}, for information on how to obtain and build the latest | |
3547 version of Emacs, and see @ref{Current GNU distributions}, for a list of | |
3548 archive sites that make GNU software available. | |
3549 | |
3550 @node Finding a package with particular functionality, Packages that do not come with Emacs, Finding Emacs on the Internet, Finding Emacs and related packages | |
3551 @section How do I find a Emacs Lisp package that does XXX? | |
3552 @cindex Package, finding | |
3553 @cindex Finding an Emacs Lisp package | |
3554 @cindex Functionality, finding a particular package | |
3555 | |
3556 First of all, you should check to make sure that the package isn't | |
3557 already available. For example, typing @kbd{M-x apropos @key{RET} | |
3558 wordstar @key{RET}} lists all functions and variables containing the | |
3559 string @samp{wordstar}. | |
3560 | |
3561 It is also possible that the package is on your system, but has not been | |
3562 loaded. To see which packages are available for loading, look through | |
3563 your computer's lisp directory (@pxref{File-name conventions}). The Lisp | |
3564 source to most packages contains a short description of how they | |
3565 should be loaded, invoked, and configured---so before you use or | |
3566 modify a Lisp package, see if the author has provided any hints in the | |
3567 source code. | |
3568 | |
3569 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse | |
3570 the constituent Emacs packages. | |
3571 | |
3572 For advice on how to find extra packages that are not part of Emacs, | |
3573 see @ref{Packages that do not come with Emacs}. | |
3574 | |
3575 @node Packages that do not come with Emacs, Current GNU distributions, Finding a package with particular functionality, Finding Emacs and related packages | |
3576 @section Where can I get Emacs Lisp packages that don't come with Emacs? | |
3577 @cindex Unbundled packages | |
3578 @cindex Finding other packages | |
3579 @cindex Lisp packages that do not come with Emacs | |
3580 @cindex Packages, those that do not come with Emacs | |
3581 @cindex Emacs Lisp List | |
3582 @cindex Emacs Lisp Archive | |
3583 | |
3584 @uref{http://www.anc.ed.ac.uk/~stephen/emacs/ell.html, The Emacs Lisp | |
3585 List (ELL)}, maintained by @email{stephen@@anc.ed.ac.uk, Stephen Eglen}, | |
3586 aims to provide one compact list with links to all of the current Emacs | |
3587 Lisp files on the Internet. The ELL can be browsed over the web, or | |
3588 from Emacs with @uref{http://www.anc.ed.ac.uk/~stephen/emacs/ell.el, | |
3589 the @file{ell} package}. | |
3590 | |
3591 Many authors post their packages to the @uref{news:gnu.emacs.sources, | |
3592 Emacs sources newsgroup}. You can search the archives of this | |
3593 group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google}, | |
3594 or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example. | |
3595 | |
3596 Several packages are stored in | |
3597 @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}. | |
3598 | |
3599 For a long time, the Emacs Lisp Archive provided a central repository | |
3600 for Emacs packages. Sadly, it has not been active for some time, | |
3601 although you can still access the old files at | |
3602 | |
3603 @uref{http://www.club.cc.cmu.edu/pub/gnu/elisp-archive/} | |
3604 | |
3605 Read the file @file{etc/MORE.STUFF} for more information about | |
3606 external packages. | |
3607 | |
3608 @node Current GNU distributions, Difference between Emacs and XEmacs, Packages that do not come with Emacs, Finding Emacs and related packages | |
3609 @section Where can I get other up-to-date GNU stuff? | |
3610 @cindex Current GNU distributions | |
3611 @cindex Sources for current GNU distributions | |
3612 @cindex Stuff, current GNU | |
3613 @cindex Up-to-date GNU stuff | |
3614 @cindex Finding current GNU software | |
3615 @cindex Official GNU software sites | |
3616 | |
3617 The most up-to-date official GNU software is normally kept at | |
3618 | |
3619 @uref{ftp://ftp.gnu.org/pub/gnu} | |
3620 | |
3621 Read the files @file{etc/DISTRIB} and @file{etc/FTP} for more | |
3622 information. | |
3623 | |
3624 A list of sites mirroring @samp{ftp.gnu.org} can be found at | |
3625 | |
3626 @uref{http://www.gnu.org/order/ftp.html} | |
3627 | |
3628 @node Difference between Emacs and XEmacs, Emacs for MS-DOS, Current GNU distributions, Finding Emacs and related packages | |
3629 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)? | |
3630 @cindex XEmacs | |
3631 @cindex Difference Emacs and XEmacs | |
3632 @cindex Lucid Emacs | |
3633 @cindex Epoch | |
3634 | |
3635 XEmacs is a branch version of Emacs. It was first called Lucid Emacs, | |
3636 and was initially derived from a prerelease version of Emacs 19. In | |
3637 this FAQ, we use the name ``Emacs'' only for the official version. | |
3638 | |
3639 Emacs and XEmacs each come with Lisp packages that are lacking in the | |
3640 other. The two versions have some significant differences at the Lisp | |
3641 programming level. Their current features are roughly comparable, | |
3642 though the support for some operating systems, character sets and | |
3643 specific packages might be quite different. | |
3644 | |
3645 Some XEmacs code has been contributed to Emacs, and we would like to | |
3646 use other parts, but the earlier XEmacs maintainers did not always | |
3647 keep track of the authors of contributed code, which makes it | |
3648 impossible for the FSF to get copyright papers signed for that code. | |
3649 (The FSF requires these papers for all the code included in the Emacs | |
3650 release, aside from generic C support packages that retain their | |
3651 separate identity and are not integrated into the code of Emacs | |
3652 proper.) | |
3653 | |
3654 If you want to talk about these two versions and distinguish them, | |
3655 please call them ``Emacs'' and ``XEmacs.'' To contrast ``XEmacs'' | |
3656 with ``GNU Emacs'' would be misleading, since XEmacs too has its | |
3657 origin in the work of the GNU Project. Terms such as ``Emacsen'' and | |
3658 ``(X)Emacs'' are not wrong, but they are not very clear, so it | |
3659 is better to write ``Emacs and XEmacs.'' | |
3660 | |
3661 @node Emacs for MS-DOS, Emacs for Windows, Difference between Emacs and XEmacs, Finding Emacs and related packages | |
3662 @section Where can I get Emacs for my PC running MS-DOS? | |
3663 @cindex MS-DOS, Emacs for | |
3664 @cindex DOS, Emacs for | |
3665 @cindex Compiling Emacs for DOS | |
3666 @cindex Emacs for MS-DOS | |
3667 @cindex Tools needed to compile Emacs under DOS | |
3668 | |
3669 A pre-built binary distribution of Emacs is available from the | |
3670 SimTel.NET archives. This version apparently works under MS-DOS and | |
3671 Windows (3.X, 9X, ME, NT, and 2000) and supports long file names under | |
3672 Windows 9X, Windows ME, and Windows 2000. More information is available | |
3673 from | |
3674 | |
3675 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README} | |
3676 | |
3677 The binary itself is available in the files @file{em*.zip} in the | |
3678 directory | |
3679 | |
3680 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/} | |
3681 | |
3682 If you prefer to compile Emacs for yourself, you can do so with the | |
3683 current distribution directly. You will need a 386 (or | |
3684 better) processor, and to be running MS-DOS 3.0 or later. According to | |
3685 @email{eliz@@gnu.org, Eli Zaretskii} and | |
3686 @email{hankedr@@dms.auburn.edu, Darrel Hankerson}, you will need the | |
3687 following: | |
3688 | |
3689 @table @emph | |
3690 | |
3691 @item Compiler | |
3692 DJGPP version 1.12 maint 1 or later. Djgpp 2.0 or later is | |
3693 recommended, since 1.x is very old an unmaintained. Djgpp 2 supports | |
3694 long file names on Windows 9X/ME/2K. | |
3695 | |
3696 You can get the latest release of DJGPP by retrieving all of | |
3697 the files in | |
3698 | |
3699 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2*} | |
3700 | |
3701 @item Unpacking program | |
3702 The easiest way is to use @code{djtar} which comes with DJGPP v2.x, | |
3703 because it can open gzip'ed tarfiles (i.e., those ending with | |
3704 @file{.tar.gz}) in one step. @code{Djtar} comes in | |
3705 @file{djdev@var{nnn}.zip} archive (where @var{nnn} is the DJGPP version | |
3706 number), from the URL mentioned above. | |
3707 | |
3708 @strong{Warning!} Do @strong{not} use the popular WinZip program to | |
3709 unpack the Emacs distribution! WinZip is known to corrupt some of the | |
3710 files by converting them to the DOS CR-LF format, it doesn't always | |
3711 preserve the directory structure recorded in the compressed Emacs | |
3712 archive, and commits other atrocities. Some of these problems could | |
3713 actually prevent Emacs from building successfully! | |
3714 | |
3715 @item make, mv, sed, and rm | |
3716 All of these utilities are available at | |
3717 | |
3718 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu} | |
3719 | |
3720 16-bit utilities can be found in GNUish, at | |
3721 | |
3722 @uref{http://www.simtel.net/pub/gnuish/} | |
3723 | |
3724 @noindent | |
3725 (@code{mv} and @code{rm} are in the Fileutils package, @code{sed} and | |
3726 @code{make} are each one in a separate package named after them.) | |
3727 | |
3728 @end table | |
3729 | |
3730 The files @file{INSTALL} (near its end) and @file{etc/PROBLEMS} in the | |
3731 directory of the Emacs sources contains some additional information | |
3732 regarding Emacs under MS-DOS. | |
3733 | |
3734 For a list of other MS-DOS implementations of Emacs (and Emacs | |
3735 look-alikes), consult the list of ``Emacs implementations and literature,'' | |
3736 available at | |
3737 | |
3738 @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/} | |
3739 | |
3740 Note that while many of these programs look similar to Emacs, they often | |
3741 lack certain features, such as the Emacs Lisp extension language. | |
3742 | |
3743 @node Emacs for Windows, Emacs for OS/2, Emacs for MS-DOS, Finding Emacs and related packages | |
3744 @section Where can I get Emacs for Microsoft Windows? | |
3745 @cindex FAQ for NT Emacs | |
3746 @cindex Emacs for MS-Windows | |
3747 @cindex Microsoft Windows, Emacs for | |
3748 @cindex Windows 9X, ME, NT, 2K, and CE, Emacs for | |
3749 | |
3750 For information on Emacs for Windows 95 and NT, read the FAQ produced by | |
3751 @email{voelker@@cs.washington.edu, Geoff Voelker} and currently maintained | |
3752 by @email{ramprasad@@gnu.org, Ramprasad B}, available at | |
3753 | |
3754 @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html} | |
3755 | |
3756 @xref{Emacs for MS-DOS}, for Windows 3.1. | |
3757 | |
3758 A port of Emacs 20.7 for Windows CE, based on NTEmacs, is available at | |
3759 | |
3760 @uref{http://www.rainer-keuchel.de/software.html} | |
3761 | |
3762 @noindent | |
3763 This port was done by @email{coyxc@@rainer-keuchel.de, Rainer Keuchel}, | |
3764 and supports all Emacs features except async subprocesses and menus. | |
3765 You will need MSVC 6.0 and a Windows CE SDK to build this port. | |
3766 | |
3767 @node Emacs for OS/2, Emacs for Atari ST, Emacs for Windows, Finding Emacs and related packages | |
3768 @section Where can I get Emacs for my PC running OS/2? | |
3769 @cindex OS/2, Emacs for | |
3770 | |
3771 Emacs 20.6 is ported for emx on OS/2 2.0 or 2.1, and is available at | |
3772 | |
3773 @uref{ftp://hobbes.nmsu.edu/pub/os2/apps/editors/emacs/} | |
3774 | |
3775 @noindent | |
3776 and also at | |
3777 | |
3778 @uref{http://www.dotemacs.de/os2/emacs.html} | |
3779 | |
3780 Instructions for installation, basic setup, and other useful information | |
3781 for OS/2 users of Emacs can be found at | |
3782 | |
3783 @uref{http://home.snafu.de/ohei/emacs/emacs206-os2.html} | |
3784 | |
3785 @node Emacs for Atari ST, Emacs for the Amiga , Emacs for OS/2, Finding Emacs and related packages | |
3786 @section Where can I get Emacs for my Atari ST? | |
3787 @cindex Atari ST, Emacs for | |
3788 @cindex TOS, Emacs for | |
3789 | |
3790 Roland Sch@"auble reports that Emacs 18.58 running on plain TOS and MiNT | |
3791 is available at | |
3792 @uref{ftp://atari.archive.umich.edu/Editors/Emacs-18-58/1858b-d3.zoo}. | |
3793 | |
3794 @node Emacs for the Amiga , Emacs for NeXTSTEP, Emacs for Atari ST, Finding Emacs and related packages | |
3795 @section Where can I get Emacs for my Amiga? | |
3796 @cindex Amiga, Emacs for | |
3797 | |
3798 The files you need are available at | |
3799 | |
3800 @uref{ftp://ftp.wustl.edu/pub/aminet/util/gnu/} | |
3801 | |
3802 @email{dgilbert@@gamiga.guelphnet.dweomer.org, David Gilbert} has released a | |
3803 beta version of Emacs 19.25 for the Amiga. You can get the binary at | |
3804 | |
3805 @uref{ftp://ftp.wustl.edu/pub/aminet/util/gnu/a2.0bEmacs-bin.lha} | |
3806 | |
3807 @node Emacs for NeXTSTEP, Emacs for Apple computers, Emacs for the Amiga , Finding Emacs and related packages | |
3808 @section Where can I get Emacs for NeXTSTEP? | |
3809 @cindex NeXTSTEP, Emacs for | |
3810 | |
3811 Emacs.app is a NeXTSTEP version of Emacs 19.34 which supports colors, | |
3812 menus, and multiple frames. You can get it from | |
3813 | |
3814 @uref{ftp://next-ftp.peak.org/pub/next-ftp/next/apps/emacs/Emacs_for_NeXTstep.4.20a1.NIHS.b.tar.gz} | |
3815 | |
3816 @node Emacs for Apple computers, Emacs for VMS and DECwindows, Emacs for NeXTSTEP, Finding Emacs and related packages | |
3817 @section Where can I get Emacs for my Apple computer? | |
3818 @cindex Apple computers, Emacs for | |
3819 @cindex Macintosh, Emacs for | |
3820 | |
3821 Beginning with version 22.1, Emacs supports Mac OS X natively. | |
3822 | |
3823 @node Emacs for VMS and DECwindows, Modes for various languages, Emacs for Apple computers, Finding Emacs and related packages | |
3824 @section Where do I get Emacs that runs on VMS under DECwindows? | |
3825 @cindex DECwindows, Emacs for | |
3826 @cindex VMS, Emacs for | |
3827 | |
3828 Up-to-date information about GNU software (including Emacs) for VMS is | |
3829 available at @uref{http://www.lp.se/gnu-vms/}. | |
3830 | |
3831 @node Modes for various languages, , Emacs for VMS and DECwindows, Finding Emacs and related packages | |
3832 @section Where can I get modes for Lex, Yacc/Bison, Bourne shell, csh, C@t{++}, Objective-C, Pascal, Java, and Awk? | |
3833 @cindex Awk, mode for | |
3834 @cindex @code{awk-mode} | |
3835 @cindex Bison, mode for | |
3836 @cindex Bourne Shell, mode for | |
3837 @cindex C@t{++}, mode for | |
3838 @cindex Java, mode for | |
3839 @cindex Lex mode | |
3840 @cindex Objective-C, mode for | |
3841 @cindex @code{pascal-mode} | |
3842 @cindex Shell mode | |
3843 @cindex Yacc mode | |
3844 @cindex @file{csh} mode | |
3845 @cindex @code{sh-mode} | |
3846 @cindex @code{cc-mode} | |
3847 | |
3848 Most of these modes are now available in standard Emacs distribution. | |
3849 To get additional modes, see @ref{Finding a package with particular | |
3850 functionality}. | |
3851 | |
3852 Barry Warsaw's @code{cc-mode} now works for C, C@t{++}, Objective-C, and | |
3853 Java code. It is distributed with Emacs, but has | |
3854 @uref{http://cc-mode.sourceforge.net/, its own homepage}. | |
3855 | |
3856 @c ------------------------------------------------------------ | |
3857 @node Major packages and programs, Key bindings, Finding Emacs and related packages, Top | |
3858 @chapter Major packages and programs | |
3859 @cindex Major packages and programs | |
3860 | |
3861 @menu | |
3862 * VM:: | |
3863 * AUCTeX:: | |
3864 * BBDB:: | |
3865 * Ispell:: | |
3866 * Emacs/W3:: | |
3867 * EDB:: | |
3868 * Mailcrypt:: | |
3869 * JDE:: | |
3870 * Patch:: | |
3871 @end menu | |
3872 | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3873 @node VM, AUCTeX, Major packages and programs, Major packages and programs |
84296 | 3874 @section VM (View Mail) --- another mail reader within Emacs, with MIME support |
3875 @cindex VM | |
3876 @cindex Alternative mail software | |
3877 @cindex View Mail | |
3878 @cindex E-mail reader, VM | |
3879 | |
3880 @table @b | |
3881 | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3882 @item Maintainer |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3883 @email{hack@@robf.de, Robert Widhopf-Fenk} |
84296 | 3884 |
3885 @item Latest version | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3886 8.0 |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3887 |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3888 @item Web site |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3889 @uref{http://www.nongnu.org/viewmail/} |
84296 | 3890 |
3891 @item Informational newsgroup | |
3892 @uref{news:gnu.emacs.vm.info}@* | |
3893 | |
3894 @item Bug reports newsgroup | |
3895 @uref{news:gnu.emacs.vm.bug}@* | |
3896 @end table | |
3897 | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3898 VM was originally written by @uref{http://www.wonderworks.com/vm/,Kyle Jones}. |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3899 @uref{ftp://ftp.wonderworks.com/pub/vm/,Older versions} of VM remain |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3900 available. |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3901 |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3902 |
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3903 @node AUCTeX, BBDB, VM, Major packages and programs |
84296 | 3904 @section AUC@TeX{} --- enhanced @TeX{} modes with debugging facilities |
3905 @cindex Mode for @TeX{} | |
3906 @cindex @TeX{} mode | |
3907 @cindex AUC@TeX{} mode for editing @TeX{} | |
3908 @cindex Writing and debugging @TeX{} | |
3909 | |
3910 AUC@TeX{} is a set of sophisticated major modes for @TeX{}, LaTeX, | |
3911 ConTeXt, and Texinfo offering context-sensitive syntax highlighting, | |
3912 indentation, formatting and folding, macro completion, @TeX{} shell | |
3913 functionality, and debugging. Be also sure to check out | |
3914 @ref{Introduction, RefTeX, Introduction, reftex, Ref@TeX{} User Manual}. | |
3915 Current versions of AUC@TeX{} include the | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3916 @uref{http://www.gnu.org/software/auctex/preview-latex.html,preview-latex} |
84296 | 3917 package for WYSIWYG previews of various LaTeX constructs in the Emacs |
3918 source buffer. | |
3919 | |
3920 @table @b | |
3921 | |
3922 @item Authors | |
3923 @email{krab@@iesd.auc.dk, Kresten Krab Thorup}, @* | |
3924 @email{abraham@@dina.kvl.dk, Per Abrahamsen}, @* and others. | |
3925 | |
3926 @item Maintainer | |
3927 @email{dak@@gnu.org, David Kastrup} | |
3928 | |
3929 @item Latest version | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3930 11.85 |
84296 | 3931 |
3932 @item Distribution | |
3933 @uref{ftp://ftp.gnu.org/pub/gnu/auctex/} | |
3934 | |
3935 @item Web site | |
3936 @uref{http://www.gnu.org/software/auctex/} | |
3937 | |
3938 @item Mailing list: | |
3939 Subscription requests to @email{auctex-request@@gnu.org}@* | |
3940 Submissions to @email{auctex@@gnu.org} | |
3941 | |
3942 @end table | |
3943 | |
3944 @node BBDB, Ispell, AUCTeX, Major packages and programs | |
3945 @section BBDB --- personal Info Rolodex integrated with mail/news readers | |
3946 @cindex BBDB | |
3947 @cindex Rolodex-like functionality | |
3948 @cindex Integrated contact database | |
3949 @cindex Contact database | |
3950 @cindex Big Brother Database | |
3951 @cindex Address book | |
3952 | |
3953 @table @b | |
3954 | |
3955 @item Maintainer | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3956 @email{hack@@robf.de, Robert Widhopf-Fenk} |
84296 | 3957 |
3958 @item Latest version | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
3959 2.35 |
84296 | 3960 |
3961 @item Distribution | |
3962 @uref{http://bbdb.sourceforge.net/} | |
3963 | |
3964 @item Mailing lists | |
3965 Subscription requests to @email{bbdb-info-request@@lists.sourceforge.net}@* | |
3966 Submissions to @email{bbdb-info@@lists.sourceforge.net}@* | |
3967 Release announcements: @email{bbdb-announce-request@@lists.sourceforge.net} | |
3968 | |
3969 @end table | |
3970 | |
3971 @node Ispell, Emacs/W3, BBDB, Major packages and programs | |
3972 @section Ispell --- spell checker in C with interface for Emacs | |
3973 @cindex Spell-checker | |
3974 @cindex Checking spelling | |
3975 @cindex Ispell | |
3976 | |
3977 @table @b | |
3978 | |
3979 @item Author | |
3980 @email{geoff@@cs.hmc.edu, Geoff Kuenning} | |
3981 | |
3982 @item Latest version | |
3983 3.3.02 | |
3984 | |
3985 @item Distribution | |
3986 @uref{http://fmg-www.cs.ucla.edu/geoff/tars/ispell-3.3.02.tar.gz}@* | |
3987 | |
3988 @item Web site | |
3989 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html} | |
3990 | |
3991 @end table | |
3992 | |
3993 This Ispell program is distinct from GNU Ispell 4.0. GNU Ispell 4.0 is | |
3994 no longer a supported product. | |
3995 | |
3996 @node Emacs/W3, EDB, Ispell, Major packages and programs | |
3997 @section Emacs/W3 --- A World Wide Web browser inside of Emacs | |
3998 @cindex WWW browser | |
3999 @cindex Web browser | |
4000 @cindex HTML browser in Emacs | |
4001 @cindex @code{w3-mode} | |
4002 | |
4003 @table @b | |
4004 | |
4005 @item Author | |
4006 @email{wmperry@@gnu.org, Bill Perry} | |
4007 | |
4008 @item Maintainer | |
4009 Emacs/W3 needs a maintainer. It has lain dormant for several years. If | |
4010 you would like to take over the project, please contact | |
4011 @email{maintainers@@gnu.org}. | |
4012 | |
4013 @item Latest version | |
4014 4.0pre.47 | |
4015 | |
4016 @item Distribution | |
4017 @uref{http://savannah.gnu.org/projects/w3} | |
4018 | |
4019 @item Mailing lists | |
4020 Receive announcements from @email{w3-announce@@gnu.org}@* | |
4021 Help to develop Emacs/W3 at @email{w3-dev@@gnu.org} | |
4022 | |
4023 @end table | |
4024 | |
4025 @node EDB, Mailcrypt, Emacs/W3, Major packages and programs | |
4026 @section EDB --- Database program for Emacs; replaces forms editing modes | |
4027 @cindex EDB | |
4028 @cindex Database | |
4029 @cindex Forms mode | |
4030 | |
4031 @table @b | |
4032 @item Author | |
4033 @email{mernst@@theory.lcs.mit.edu, Michael Ernst} | |
4034 | |
4035 @item Latest version | |
4036 1.21 | |
4037 | |
4038 @item Distribution | |
4039 @uref{ftp://theory.lcs.mit.edu/pub/emacs/edb} | |
4040 | |
4041 @end table | |
4042 | |
4043 @node Mailcrypt, JDE, EDB, Major packages and programs | |
4044 @section Mailcrypt --- PGP interface within Emacs mail and news | |
4045 @cindex PGP | |
4046 @cindex GPG | |
4047 @cindex Interface to PGP from Emacs mail and news | |
4048 @cindex News, interface to PGP from | |
4049 @cindex Mail, interface to PGP from | |
4050 @cindex Encryption software, interface to | |
4051 | |
4052 @table @b | |
4053 | |
4054 @item Authors | |
4055 @email{patl@@lcs.mit.edu, Patrick J. LoPresti} and | |
4056 @email{jin@@atype.com, Jin S. Choi} | |
4057 | |
4058 @item Maintainer | |
4059 @email{warner-mailcrypt@@lothar.com, Brian Warner} | |
4060 | |
4061 @item Latest version | |
4062 3.5.8 | |
4063 | |
4064 @item Distribution | |
4065 @uref{http://dl.sourceforge.net/sourceforge/mailcrypt/mailcrypt-3.5.8.tar.gz} | |
4066 | |
4067 @item Web site | |
4068 @uref{http://mailcrypt.sourceforge.net/} | |
4069 | |
4070 @end table | |
4071 | |
4072 Note that a new package called PGG is bundled with Emacs starting with | |
4073 version 22.1. It is a modern interface to various PGP implementations, | |
4074 including @uref{http://www.gnupg.org/, The GNU Privacy Guard} and | |
4075 supports symmetric encryption. | |
4076 | |
4077 @node JDE, Patch, Mailcrypt, Major packages and programs | |
4078 @section JDE --- Integrated development environment for Java | |
4079 @cindex Java development environment | |
4080 @cindex Integrated Java development environment | |
4081 @cindex JDE | |
4082 | |
4083 @table @b | |
4084 | |
4085 @item Author | |
4086 @email{paulk@@mathworks.com, Paul Kinnucan} | |
4087 | |
4088 @item Latest version | |
4089 2.3.5 | |
4090 | |
4091 @item Web site | |
4092 @uref{http://jdee.sunsite.dk/} | |
4093 | |
4094 @item Mailing lists | |
4095 Subscription requests to @email{jde-subscribe@@sunsite.dk}@* | |
4096 Receive announcements from @email{jde-announce-subscribe@@sunsite.dk} | |
4097 | |
4098 @end table | |
4099 | |
4100 @node Patch, , JDE, Major packages and programs | |
4101 @section Patch --- program to apply ``diffs'' for updating files | |
4102 @cindex Updating files with diffs | |
4103 @cindex Patching source files with diffs | |
4104 @cindex Diffs and patching | |
4105 @cindex @file{patch} | |
4106 | |
4107 @table @b | |
4108 | |
4109 @item Author | |
4110 @email{lwall@@wall.org, Larry Wall} (with GNU modifications) | |
4111 | |
4112 @item Latest version | |
4113 2.5.4 | |
4114 | |
4115 @item Distribution | |
4116 @xref{Current GNU distributions}. | |
4117 | |
4118 @end table | |
4119 | |
4120 @c ------------------------------------------------------------ | |
4121 @node Key bindings, Alternate character sets, Major packages and programs, Top | |
4122 @chapter Key bindings | |
4123 @cindex Key bindings | |
4124 | |
4125 @menu | |
4126 * Binding keys to commands:: | |
4127 * Invalid prefix characters:: | |
4128 * Terminal setup code works after Emacs has begun:: | |
4129 * Using function keys under X:: | |
4130 * Working with function and arrow keys:: | |
4131 * X key translations for Emacs:: | |
4132 * Handling C-s and C-q with flow control:: | |
4133 * Binding C-s and C-q:: | |
4134 * Backspace invokes help:: | |
4135 * stty and Backspace key:: | |
4136 * Swapping keys:: | |
4137 * Producing C-XXX with the keyboard:: | |
4138 * No Meta key:: | |
4139 * No Escape key:: | |
4140 * Compose Character:: | |
4141 * Binding combinations of modifiers and function keys:: | |
4142 * Meta key does not work in xterm:: | |
4143 * ExtendChar key does not work as Meta:: | |
4144 * SPC no longer completes file names:: | |
4145 @end menu | |
4146 | |
4147 @node Binding keys to commands, Invalid prefix characters, Key bindings, Key bindings | |
4148 @section How do I bind keys (including function keys) to commands? | |
4149 @cindex Binding keys to commands | |
4150 @cindex Keys, binding to commands | |
4151 @cindex Commands, binding keys to | |
4152 | |
4153 Keys can be bound to commands either interactively or in your | |
4154 @file{.emacs} file. To interactively bind keys for all modes, type | |
4155 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}. | |
4156 | |
4157 To bind a key just in the current major mode, type @kbd{M-x | |
4158 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}. | |
4159 | |
4160 @inforef{Key Bindings, Key Bindings, emacs}, for further details. | |
4161 | |
4162 To make the process of binding keys interactively easier, use the | |
4163 following ``trick'': First bind the key interactively, then immediately | |
4164 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}. Now, the command needed | |
4165 to bind the key is in the kill ring, and can be yanked into your | |
4166 @file{.emacs} file. If the key binding is global, no changes to the | |
4167 command are required. For example, | |
4168 | |
4169 @lisp | |
4170 (global-set-key (quote [f1]) (quote help-for-help)) | |
4171 @end lisp | |
4172 | |
4173 @noindent | |
4174 can be placed directly into the @file{.emacs} file. If the key binding is | |
4175 local, the command is used in conjunction with the @samp{add-hook} function. | |
4176 For example, in TeX mode, a local binding might be | |
4177 | |
4178 @lisp | |
4179 (add-hook 'tex-mode-hook | |
4180 (lambda () | |
4181 (local-set-key (quote [f1]) (quote help-for-help)))) | |
4182 @end lisp | |
4183 | |
4184 | |
4185 @itemize @bullet | |
4186 | |
4187 @item | |
4188 Control characters in key sequences, in the form yanked from the kill | |
4189 ring are given in their graphic form---i.e., @key{CTRL} is shown as | |
4190 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc. You may want | |
4191 to convert these into their vector or string forms. | |
4192 | |
4193 @item | |
4194 If a prefix key of the character sequence to be bound is already | |
4195 bound as a complete key, then you must unbind it before the new | |
4196 binding. For example, if @kbd{ESC @{} is previously bound: | |
4197 | |
4198 @lisp | |
4199 (global-unset-key [?\e ?@{]) ;; or | |
4200 (local-unset-key [?\e ?@{]) | |
4201 @end lisp | |
4202 | |
4203 @item | |
4204 Aside from commands and ``lambda lists,'' a vector or string also | |
4205 can be bound to a key and thus treated as a macro. For example: | |
4206 | |
4207 @lisp | |
4208 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g]) ;; or | |
4209 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g") | |
4210 @end lisp | |
4211 | |
4212 @end itemize | |
4213 | |
4214 @node Invalid prefix characters, Terminal setup code works after Emacs has begun, Binding keys to commands, Key bindings | |
4215 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}? | |
4216 @cindex Prefix characters, invalid | |
4217 @cindex Invalid prefix characters | |
4218 @cindex Misspecified key sequences | |
4219 | |
4220 Usually, one of two things has happened. In one case, the control | |
4221 character in the key sequence has been misspecified (e.g. @samp{C-f} | |
4222 used instead of @samp{\C-f} within a Lisp expression). In the other | |
4223 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind | |
4224 was already bound as a @dfn{complete key}. Historically, the @samp{ESC [} | |
4225 prefix was usually the problem, in which case you should evaluate either | |
4226 of these forms before attempting to bind the key sequence: | |
4227 | |
4228 @lisp | |
4229 (global-unset-key [?\e ?[]) ;; or | |
4230 (global-unset-key "\e[") | |
4231 @end lisp | |
4232 | |
4233 @node Terminal setup code works after Emacs has begun, Using function keys under X, Invalid prefix characters, Key bindings | |
4234 @section Why doesn't this [terminal or window-system setup] code work in my @file{.emacs} file, but it works just fine after Emacs starts up? | |
4235 @cindex Terminal setup code in @file{.emacs} | |
4236 | |
4237 During startup, Emacs initializes itself according to a given code/file | |
4238 order. If some of the code executed in your @file{.emacs} file needs to | |
4239 be postponed until the initial terminal or window-system setup code has | |
4240 been executed but is not, then you will experience this problem (this | |
4241 code/file execution order is not enforced after startup). | |
4242 | |
4243 To postpone the execution of Emacs Lisp code until after terminal or | |
4244 window-system setup, treat the code as a @dfn{lambda list} and set the | |
4245 value of either the @code{term-setup-hook} or @code{window-setup-hook} | |
4246 variable to this lambda function. For example, | |
4247 | |
4248 @lisp | |
4249 (add-hook 'term-setup-hook | |
4250 (lambda () | |
4251 (when (string-match "\\`vt220" (or (getenv "TERM") "")) | |
4252 ;; Make vt220's "Do" key behave like M-x: | |
4253 (global-set-key [do] 'execute-extended-command)))) | |
4254 @end lisp | |
4255 | |
4256 For information on what Emacs does every time it is started, see the | |
4257 @file{lisp/startup.el} file. | |
4258 | |
4259 @node Using function keys under X, Working with function and arrow keys, Terminal setup code works after Emacs has begun, Key bindings | |
4260 @section How do I use function keys under X? | |
4261 @cindex Function keys | |
4262 @cindex X Window System and function keys | |
4263 @cindex Binding function keys | |
4264 | |
4265 With Emacs 19, functions keys under X are bound like any other key. @xref{Binding keys to commands}, for details. | |
4266 | |
4267 @node Working with function and arrow keys, X key translations for Emacs, Using function keys under X, Key bindings | |
4268 @section How do I tell what characters or symbols my function or arrow keys emit? | |
4269 @cindex Working with arrow keys | |
4270 @cindex Arrow keys, symbols generated by | |
4271 @cindex Working with function keys | |
4272 @cindex Function keys, symbols generated by | |
4273 @cindex Symbols generated by function keys | |
4274 | |
4275 Type @kbd{C-h c} then the function or arrow keys. The command will | |
4276 return either a function key symbol or character sequence (see the | |
4277 Emacs on-line documentation for an explanation). This works for other | |
4278 keys as well. | |
4279 | |
4280 @node X key translations for Emacs, Handling C-s and C-q with flow control, Working with function and arrow keys, Key bindings | |
4281 @section How do I set the X key ``translations'' for Emacs? | |
4282 @cindex X key translations | |
4283 @cindex Key translations under X | |
4284 @cindex Translations for keys under X | |
4285 | |
4286 Emacs is not written using the Xt library by default, so there are no | |
4287 ``translations'' to be set. (We aren't sure how to set such translations | |
4288 if you do build Emacs with Xt; please let us know if you've done this!) | |
4289 | |
4290 The only way to affect the behavior of keys within Emacs is through | |
4291 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs). The | |
4292 @code{define-key} command should be used in conjunction with the | |
4293 @code{function-key-map} map. For instance, | |
4294 | |
4295 @lisp | |
4296 (define-key function-key-map [M-@key{TAB}] [?\M-\t]) | |
4297 @end lisp | |
4298 | |
4299 @noindent | |
4300 defines the @kbd{M-@key{TAB}} key sequence. | |
4301 | |
4302 @node Handling C-s and C-q with flow control, Binding C-s and C-q, X key translations for Emacs, Key bindings | |
4303 @section How do I handle @kbd{C-s} and @kbd{C-q} being used for flow control? | |
4304 @cindex Flow control, @kbd{C-s} and @kbd{C-q} with | |
4305 @cindex @kbd{C-s} and @kbd{C-q} with flow control | |
4306 | |
4307 @kbd{C-s} and @kbd{C-q} are used in the XON/XOFF flow control protocol. | |
4308 This messes things up when you're using Emacs over a serial line, | |
4309 because Emacs binds these keys to commands by default. Because Emacs | |
4310 won't honor them as flow control characters, too many of these | |
4311 characters are not passed on and overwhelm output buffers. Sometimes, | |
4312 intermediate software using XON/XOFF flow control will prevent Emacs | |
4313 from ever seeing @kbd{C-s} and @kbd{C-q}. | |
4314 | |
4315 Possible solutions: | |
4316 | |
4317 @itemize @bullet | |
4318 | |
4319 @item | |
4320 Disable the use of @kbd{C-s} and @kbd{C-q} for flow control. | |
4321 | |
4322 You need to determine the cause of the flow control. | |
4323 | |
4324 @itemize @minus | |
4325 | |
4326 @item | |
4327 your terminal | |
4328 | |
4329 Your terminal may use XON/XOFF flow control to have time to display | |
4330 all the characters it receives. For example, VT series terminals do | |
4331 this. It may be possible to turn this off from a setup menu. For | |
4332 example, on a VT220 you may select ``No XOFF'' in the setup menu. This | |
4333 is also true for some terminal emulation programs on PCs. | |
4334 | |
4335 When you turn off flow control at the terminal, you will also need to | |
4336 turn it off at the other end, which might be at the computer you are | |
4337 logged in to or at some terminal server in between. | |
4338 | |
4339 If you turn off flow control, characters may be lost; using a printer | |
4340 connected to the terminal may fail. You may be able to get around | |
4341 this problem by modifying the @samp{termcap} entry for your terminal to | |
4342 include extra NUL padding characters. | |
4343 | |
4344 @item | |
4345 a modem | |
4346 | |
4347 If you are using a dialup connection, the modems may be using | |
4348 XON/XOFF flow control. It's not clear how to get around this. | |
4349 | |
4350 @item | |
4351 a router or terminal server | |
4352 | |
4353 Some network box between the terminal and your computer may be using | |
4354 XON/XOFF flow control. It may be possible to make it use some other | |
4355 kind of flow control. You will probably have to ask your local | |
4356 network experts for help with this. | |
4357 | |
4358 @item | |
4359 @code{tty} and/or @code{pty} devices | |
4360 | |
4361 If your connection to Emacs goes through multiple @code{tty} and/or | |
4362 @code{pty} devices, they may be using XON/XOFF flow control even when it | |
4363 is not necessary. | |
4364 | |
4365 @email{eirik@@theory.tn.cornell.edu, Eirik Fuller} writes: | |
4366 | |
4367 @quotation | |
4368 Some versions of @code{rlogin} (and possibly @code{telnet}) do not pass | |
4369 flow control characters to the remote system to which they connect. On | |
4370 such systems, Emacs on the remote system cannot disable flow control on | |
4371 the local system. Sometimes @samp{rlogin -8} will avoid this problem. | |
4372 | |
4373 One way to cure this is to disable flow control on the local host (the | |
4374 one running @code{rlogin}, not the one running @code{rlogind}) using the | |
4375 @code{stty} command, before starting the @code{rlogin} process. On many | |
4376 systems, @samp{stty start u stop u} will do this. | |
4377 | |
4378 Some versions of @samp{tcsh} will prevent even this from working. One | |
4379 way around this is to start another shell before starting rlogin, | |
4380 and issue the @samp{stty} command to disable flow control from that shell. | |
4381 @end quotation | |
4382 | |
4383 Use @samp{stty -ixon} instead of @samp{stty start u stop u} on some systems. | |
4384 | |
4385 @end itemize | |
4386 | |
4387 @item | |
4388 Make Emacs speak the XON/XOFF flow control protocol. | |
4389 | |
4390 You can make Emacs treat @kbd{C-s} and @kbd{C-q} as flow control characters by | |
4391 evaluating the form | |
4392 | |
4393 @lisp | |
4394 (enable-flow-control) | |
4395 @end lisp | |
4396 | |
4397 @noindent | |
4398 to unconditionally enable flow control or | |
4399 | |
4400 @lisp | |
4401 (enable-flow-control-on "vt100" "h19") | |
4402 @end lisp | |
4403 | |
4404 @noindent | |
4405 (using your terminal names instead of @samp{vt100} or @samp{h19}) to | |
4406 enable selectively. These commands will automatically swap @kbd{C-s} | |
4407 and @kbd{C-q} to @kbd{C-\} and @kbd{C-^}. Variables can be used to | |
4408 change the default swap keys (@code{flow-control-c-s-replacement} and | |
4409 @code{flow-control-c-q-replacement}). | |
4410 | |
4411 If you are fixing this for yourself, simply put the form in your | |
4412 @file{.emacs} file. If you are fixing this for your entire site, the | |
4413 best place to put it is in the @file{site-lisp/site-start.el} file. | |
4414 (Here @file{site-lisp} is actually a subdirectory of your Emacs | |
4415 installation directory, typically @file{/usr/local/share/emacs}.) | |
4416 Putting this form in @file{site-lisp/default.el} has the problem that | |
4417 if the user's @file{.emacs} file has an error, this will prevent | |
4418 @file{default.el} from being loaded and Emacs may be unusable for the | |
4419 user, even for correcting their @file{.emacs} file (unless they're | |
4420 smart enough to move it to another name). | |
4421 | |
4422 @code{enable-flow-control} can be invoked interactively as well: | |
4423 @kbd{M-x enable-flow-control @key{RET}}. | |
4424 | |
4425 @end itemize | |
4426 | |
4427 For further discussion of this issue, read the file @file{etc/PROBLEMS} | |
4428 (in the Emacs source directory when you unpack the Emacs distribution). | |
4429 | |
4430 @node Binding C-s and C-q, Backspace invokes help, Handling C-s and C-q with flow control, Key bindings | |
4431 @section How do I bind @kbd{C-s} and @kbd{C-q} (or any key) if these keys are filtered out? | |
4432 @cindex Binding @kbd{C-s} and @kbd{C-q} | |
4433 @cindex @kbd{C-s} and @kbd{C-q}, binding | |
4434 | |
4435 To bind @kbd{C-s} and @kbd{C-q}, use either @code{enable-flow-control} | |
4436 or @code{enable-flow-control-on}. @xref{Handling C-s and C-q with flow | |
4437 control}, for usage and implementation details. | |
4438 | |
4439 To bind other keys, use @code{keyboard-translate}. @xref{Swapping | |
4440 keys}, for usage details. To do this for an entire site, you should | |
4441 swap the keys in @file{site-lisp/site-start.el}. @xref{Handling C-s | |
4442 and C-q with flow control}, for an explanation of why | |
4443 @file{site-lisp/default.el} should not be used. | |
4444 | |
4445 @itemize @bullet | |
4446 | |
4447 @item | |
4448 If you do this for an entire site, the users will be confused by | |
4449 the disparity between what the documentation says and how Emacs | |
4450 actually behaves. | |
4451 | |
4452 @end itemize | |
4453 | |
4454 @node Backspace invokes help, stty and Backspace key, Binding C-s and C-q, Key bindings | |
4455 @section Why does the @key{Backspace} key invoke help? | |
4456 @cindex Backspace key invokes help | |
4457 @cindex Help invoked by Backspace | |
4458 @cindex DEL key does not delete | |
4459 | |
4460 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8. | |
4461 @kbd{C-h} sends the same code. In Emacs by default @kbd{C-h} invokes | |
4462 help-command. This is intended to be easy to remember since the first | |
4463 letter of @samp{help} is @samp{h}. The easiest solution to this problem | |
4464 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the | |
4465 @key{Delete} key) for deleting the previous character. | |
4466 | |
4467 For many people this solution may be problematic: | |
4468 | |
4469 @itemize @bullet | |
4470 | |
4471 @item | |
4472 They normally use @key{Backspace} outside of Emacs for deleting the | |
4473 previous character. This can be solved by making @key{DEL} the command | |
4474 for deleting the previous character outside of Emacs. On many Unix | |
4475 systems, this command will remap @key{DEL}: | |
4476 | |
4477 @example | |
4478 stty erase `^?' | |
4479 @end example | |
4480 | |
4481 @item | |
4482 The user may prefer the @key{Backspace} key for deleting the | |
4483 previous character because it is more conveniently located on their | |
4484 keyboard or because they don't even have a separate @key{Delete} key. | |
4485 In this case, the @key{Backspace} key should be made to behave like | |
4486 @key{Delete}. There are several methods. | |
4487 | |
4488 @itemize @minus | |
4489 @item | |
4490 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g., | |
4491 TeraTerm) allow the character generated by the @key{Backspace} key to be | |
4492 changed from a setup menu. | |
4493 | |
4494 @item | |
4495 You may be able to get a keyboard that is completely programmable, or a | |
4496 terminal emulator that supports remapping of any key to any other key. | |
4497 | |
4498 @item | |
4499 With Emacs 21.1 and later, you can control the effect of the | |
4500 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a | |
4501 windowed displays, by customizing the option | |
4502 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x | |
4503 normal-erase-is-backspace}. See the documentation of these symbols | |
4504 (@pxref{Emacs Lisp documentation}) for more info. | |
4505 | |
4506 @item | |
4507 It is possible to swap the @key{Backspace} and @key{DEL} keys inside | |
4508 Emacs: | |
4509 | |
4510 @lisp | |
4511 (keyboard-translate ?\C-h ?\C-?) | |
4512 @end lisp | |
4513 | |
4514 @noindent | |
4515 This is the recommended method of forcing @key{Backspace} to act as | |
4516 @key{DEL}, because it works even in modes which bind @key{DEL} to | |
4517 something other than @code{delete-backward-char}. | |
4518 | |
4519 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by | |
4520 default deletes forward: | |
4521 | |
4522 @lisp | |
4523 (keyboard-translate ?\C-? ?\C-d) | |
4524 @end lisp | |
4525 | |
4526 @xref{Swapping keys}, for further details about @code{keyboard-translate}. | |
4527 | |
4528 @item | |
4529 Another approach is to switch key bindings and put help on @kbd{C-x h} | |
4530 instead: | |
4531 | |
4532 @lisp | |
4533 (global-set-key "\C-h" 'delete-backward-char) | |
4534 | |
4535 ;; overrides mark-whole-buffer | |
4536 (global-set-key "\C-xh" 'help-command) | |
4537 @end lisp | |
4538 | |
4539 @noindent | |
4540 This method is not recommended, though: it only solves the problem for | |
4541 those modes which bind @key{DEL} to @code{delete-backward-char}. Modes | |
4542 which bind @key{DEL} to something else, such as @code{view-mode}, will | |
4543 not work as you expect when you press the @key{Backspace} key. For this | |
4544 reason, we recommend the @code{keyboard-translate} method, shown | |
4545 above. | |
4546 | |
4547 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}. | |
4548 @end itemize | |
4549 | |
4550 Don't try to bind @key{DEL} to @code{help-command}, because there are | |
4551 many modes that have local bindings of @key{DEL} that will interfere. | |
4552 | |
4553 @end itemize | |
4554 | |
4555 When Emacs 21 or later runs on a windowed display, it binds the | |
4556 @key{Delete} key to a command which deletes the character at point, to | |
4557 make Emacs more consistent with keyboard operation on these systems. | |
4558 | |
4559 For more information about troubleshooting this problem, see @ref{DEL | |
4560 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs | |
4561 Manual}. | |
4562 | |
4563 @node stty and Backspace key, Swapping keys, Backspace invokes help, Key bindings | |
4564 @section Why doesn't Emacs look at the @file{stty} settings for @key{Backspace} vs. @key{Delete}? | |
4565 @cindex @file{stty} and Emacs | |
4566 @cindex Backspace and @file{stty} | |
4567 @cindex Delete and @file{stty} | |
4568 | |
4569 Good question! | |
4570 | |
4571 @c FIXME: RMS explained the reasons for this on emacs-hackers. It's | |
4572 @c probably worth putting that explanation here. | |
4573 | |
4574 @node Swapping keys, Producing C-XXX with the keyboard, stty and Backspace key, Key bindings | |
4575 @section How do I swap two keys? | |
4576 @cindex Swapping keys | |
4577 @cindex Keys, swapping | |
4578 @cindex @code{keyboard-translate} | |
4579 | |
4580 You can swap two keys (or key sequences) by using the | |
4581 @code{keyboard-translate} function. For example, to turn @kbd{C-h} | |
4582 into @key{DEL} and @key{DEL} to @kbd{C-h}, use | |
4583 | |
4584 @lisp | |
4585 (keyboard-translate ?\C-h ?\C-?) ; translate `C-h' to DEL | |
4586 (keyboard-translate ?\C-? ?\C-h) ; translate DEL to `C-h'. | |
4587 @end lisp | |
4588 | |
4589 @noindent | |
4590 The first key sequence of the pair after the function identifies what is | |
4591 produced by the keyboard; the second, what is matched for in the | |
4592 keymaps. | |
4593 | |
4594 However, in the specific case of @kbd{C-h} and @key{DEL}, you should | |
4595 toggle @code{normal-erase-is-backspace-mode} instead of calling | |
4596 @code{keyboard-translate}. @inforef{DEL Does Not Delete, DEL Does Not Delete, | |
4597 emacs}. | |
4598 | |
4599 Keyboard translations are not the same as key bindings in keymaps. | |
4600 Emacs contains numerous keymaps that apply in different situations, but | |
4601 there is only one set of keyboard translations, and it applies to every | |
4602 character that Emacs reads from the terminal. Keyboard translations | |
4603 take place at the lowest level of input processing; the keys that are | |
4604 looked up in keymaps contain the characters that result from keyboard | |
4605 translation. | |
4606 | |
4607 @node Producing C-XXX with the keyboard, No Meta key, Swapping keys, Key bindings | |
4608 @section How do I produce C-XXX with my keyboard? | |
4609 @cindex Producing control characters | |
4610 @cindex Generating control characters | |
4611 @cindex Control characters, generating | |
4612 | |
4613 On terminals (but not under X), some common ``aliases'' are: | |
4614 | |
4615 @table @asis | |
4616 | |
4617 @item @kbd{C-2} or @kbd{C-@key{SPC}} | |
4618 @kbd{C-@@} | |
4619 | |
4620 @item @kbd{C-6} | |
4621 @kbd{C-^} | |
4622 | |
4623 @item @kbd{C-7} or @kbd{C-S--} | |
4624 @kbd{C-_} | |
4625 | |
4626 @item @kbd{C-4} | |
4627 @kbd{C-\} | |
4628 | |
4629 @item @kbd{C-5} | |
4630 @kbd{C-]} | |
4631 | |
4632 @item @kbd{C-/} | |
4633 @kbd{C-?} | |
4634 | |
4635 @end table | |
4636 | |
4637 Often other aliases exist; use the @kbd{C-h c} command and try | |
4638 @key{CTRL} with all of the digits on your keyboard to see what gets | |
4639 generated. You can also try the @kbd{C-h w} command if you know the | |
4640 name of the command. | |
4641 | |
4642 @node No Meta key, No Escape key, Producing C-XXX with the keyboard, Key bindings | |
4643 @section What if I don't have a @key{Meta} key? | |
4644 @cindex No @key{Meta} key | |
4645 @cindex @key{Meta} key, what to do if you lack it | |
4646 | |
4647 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it. | |
4648 | |
4649 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}. In fact, | |
4650 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway | |
4651 (depending on the value of @code{meta-prefix-char}). Note that you | |
4652 press @key{Meta} and @key{a} together, but with @key{ESC}, you press | |
4653 @key{ESC}, release it, and then press @key{a}. | |
4654 | |
4655 @node No Escape key, Compose Character, No Meta key, Key bindings | |
4656 @section What if I don't have an @key{Escape} key? | |
4657 @cindex No Escape key | |
4658 @cindex Lacking an Escape key | |
4659 @cindex Escape key, lacking | |
4660 | |
4661 Type @kbd{C-[} instead. This should send @acronym{ASCII} code 27 just like an | |
4662 Escape key would. @kbd{C-3} may also work on some terminal (but not | |
4663 under X). For many terminals (notably DEC terminals) @key{F11} | |
4664 generates @key{ESC}. If not, the following form can be used to bind it: | |
4665 | |
4666 @lisp | |
4667 ;; F11 is the documented ESC replacement on DEC terminals. | |
4668 (define-key function-key-map [f11] [?\e]) | |
4669 @end lisp | |
4670 | |
4671 @node Compose Character, Binding combinations of modifiers and function keys, No Escape key, Key bindings | |
4672 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key? | |
4673 @cindex @key{Compose Character} key, using as @key{Meta} | |
4674 @cindex @key{Meta}, using @key{Compose Character} for | |
4675 | |
4676 On a dumb terminal such as a VT220, no. It is rumored that certain | |
4677 VT220 clones could have their @key{Compose} key configured this way. If | |
4678 you're using X, you might be able to do this with the @code{xmodmap} | |
4679 command. | |
4680 | |
4681 @node Binding combinations of modifiers and function keys, Meta key does not work in xterm, Compose Character, Key bindings | |
4682 @section How do I bind a combination of modifier key and function key? | |
4683 @cindex Modifiers and function keys | |
4684 @cindex Function keys and modifiers | |
4685 @cindex Binding modifiers and function keys | |
4686 | |
4687 With Emacs 19 and later, you can represent modified function keys in | |
4688 vector format by adding prefixes to the function key symbol. For | |
4689 example (from the on-line documentation): | |
4690 | |
4691 @lisp | |
4692 (global-set-key [?\C-x right] 'forward-page) | |
4693 @end lisp | |
4694 | |
4695 @noindent | |
4696 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}. | |
4697 | |
4698 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper}, | |
4699 @key{Super}, @key{Alt}, and @key{Shift} with function keys. To | |
4700 represent these modifiers, prepend the strings @samp{C-}, @samp{M-}, | |
4701 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name. Here | |
4702 is how to make @kbd{H-M-RIGHT} move forward a word: | |
4703 | |
4704 @lisp | |
4705 (global-set-key [H-M-right] 'forward-word) | |
4706 @end lisp | |
4707 | |
4708 @itemize @bullet | |
4709 | |
4710 @item | |
4711 Not all modifiers are permitted in all situations. @key{Hyper}, | |
4712 @key{Super}, and @key{Alt} are not available on Unix character | |
4713 terminals. Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and | |
4714 @kbd{Mouse-1}) also fall under this category. | |
4715 | |
4716 @end itemize | |
4717 | |
4718 @xref{Binding keys to commands}, for general key binding instructions. | |
4719 | |
4720 @node Meta key does not work in xterm, ExtendChar key does not work as Meta, Binding combinations of modifiers and function keys, Key bindings | |
4721 @section Why doesn't my @key{Meta} key work in an @code{xterm} window? | |
4722 @cindex @key{Meta} key and @code{xterm} | |
4723 @cindex Xterm and @key{Meta} key | |
4724 | |
4725 @inforef{Unibyte Mode, Single-Byte Character Set Support, emacs}. | |
4726 | |
4727 If the advice in the Emacs manual fails, try all of these methods before | |
4728 asking for further help: | |
4729 | |
4730 @itemize @bullet | |
4731 | |
4732 @item | |
4733 You may have big problems using @code{mwm} as your window manager. | |
4734 (Does anyone know a good generic solution to allow the use of the | |
4735 @key{Meta} key in Emacs with @file{mwm}?) | |
4736 | |
4737 @item | |
4738 For X11: Make sure it really is a @key{Meta} key. Use @code{xev} to | |
4739 find out what keysym your @key{Meta} key generates. It should be either | |
4740 @code{Meta_L} or @code{Meta_R}. If it isn't, use @file{xmodmap} to fix | |
4741 the situation. If @key{Meta} does generate @code{Meta_L} or | |
4742 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in | |
4743 your @file{~/.Xdefaults} file: | |
4744 | |
4745 @example | |
4746 XTerm*eightBitInput: false | |
4747 XTerm*eightBitOutput: true | |
4748 @end example | |
4749 | |
4750 @item | |
4751 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit | |
4752 characters. @samp{stty -a} (or @samp{stty everything}) should show | |
4753 @samp{cs8} somewhere. If it shows @samp{cs7} instead, use @samp{stty | |
4754 cs8 -istrip} (or @samp{stty pass8}) to fix it. | |
4755 | |
4756 @item | |
4757 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the | |
4758 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits | |
4759 of every character. | |
4760 | |
4761 @item | |
4762 If Emacs is running on Ultrix, it is reported that evaluating | |
4763 @code{(set-input-mode t nil)} helps. | |
4764 | |
4765 @item | |
4766 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when | |
4767 you type @kbd{M-W}, which is the same conversion Emacs would make if it | |
4768 got the @kbd{M-W} anyway. In X11R4, the following resource | |
4769 specification will do this: | |
4770 | |
4771 @example | |
4772 XTerm.VT100.EightBitInput: false | |
4773 @end example | |
4774 | |
4775 @noindent | |
4776 (This changes the behavior of the @code{insert-eight-bit} action.) | |
4777 | |
4778 With older @code{xterm}s, you can specify this behavior with a translation: | |
4779 | |
4780 @example | |
4781 XTerm.VT100.Translations: #override \ | |
4782 Meta<KeyPress>: string(0x1b) insert() | |
4783 @end example | |
4784 | |
4785 @noindent | |
4786 You might have to replace @samp{Meta} with @samp{Alt}. | |
4787 | |
4788 @end itemize | |
4789 | |
4790 @node ExtendChar key does not work as Meta, SPC no longer completes file names, Meta key does not work in xterm, Key bindings | |
4791 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x? | |
4792 @cindex @key{ExtendChar} key as @key{Meta} | |
4793 @cindex @key{Meta}, using @key{ExtendChar} for | |
4794 @cindex HP-UX, the @key{ExtendChar} key | |
4795 | |
4796 This is a result of an internationalization extension in X11R4 and the | |
4797 fact that HP is now using this extension. Emacs assumes that the | |
4798 @code{XLookupString} function returns the same result regardless of the | |
4799 @key{Meta} key state which is no longer necessarily true. Until Emacs | |
4800 is fixed, the temporary kludge is to run this command after each time | |
4801 the X server is started but preferably before any xterm clients are: | |
4802 | |
4803 @example | |
4804 xmodmap -e 'remove mod1 = Mode_switch' | |
4805 @end example | |
4806 | |
4807 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is | |
4808 @c solved? | |
4809 | |
4810 This will disable the use of the extra keysyms systemwide, which may be | |
4811 undesirable if you actually intend to use them. | |
4812 | |
4813 @node SPC no longer completes file names, , ExtendChar key does not work as Meta, Key bindings | |
4814 @section Why doesn't SPC complete file names anymore? | |
4815 @cindex @kbd{SPC} file name completion | |
4816 | |
4817 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in | |
4818 the minibuffer, so that file names with embedded spaces could be typed | |
4819 without the need to quote the spaces. | |
4820 | |
4821 You can get the old behavior by binding @kbd{SPC} to | |
4822 @code{minibuffer-complete-word} in the minibuffer, as follows: | |
4823 | |
4824 @lisp | |
4825 (define-key minibuffer-local-filename-completion-map (kbd "SPC") | |
4826 'minibuffer-complete-word) | |
4827 | |
4828 (define-key minibuffer-local-must-match-filename-map (kbd "SPC") | |
4829 'minibuffer-complete-word) | |
4830 @end lisp | |
4831 | |
4832 @c ------------------------------------------------------------ | |
4833 @node Alternate character sets, Mail and news, Key bindings, Top | |
4834 @chapter Alternate character sets | |
4835 @cindex Alternate character sets | |
4836 | |
4837 @menu | |
4838 * Emacs does not display 8-bit characters:: | |
4839 * Inputting eight-bit characters:: | |
4840 * Kanji and Chinese characters:: | |
4841 * Right-to-left alphabets:: | |
4842 * How to add fonts:: | |
4843 @end menu | |
4844 | |
4845 @node Emacs does not display 8-bit characters, Inputting eight-bit characters, Alternate character sets, Alternate character sets | |
4846 @section How do I make Emacs display 8-bit characters? | |
4847 @cindex Displaying eight-bit characters | |
4848 @cindex Eight-bit characters, displaying | |
4849 | |
4850 @inforef{Unibyte Mode, Single-byte Character Set | |
4851 Support, emacs}. On a Unix, when Emacs runs on a text-only terminal | |
4852 display or is invoked with @samp{emacs -nw}, you typically need to use | |
4853 @code{set-terminal-coding-system} to tell Emacs what the terminal can | |
4854 display, even after setting the language environment; otherwise | |
4855 non-@acronym{ASCII} characters will display as @samp{?}. On other operating | |
4856 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the | |
4857 character set supported by the display, and sets up the required | |
4858 terminal coding system automatically. | |
4859 | |
4860 @node Inputting eight-bit characters, Kanji and Chinese characters, Emacs does not display 8-bit characters, Alternate character sets | |
4861 @section How do I input eight-bit characters? | |
4862 @cindex Entering eight-bit characters | |
4863 @cindex Eight-bit characters, entering | |
4864 @cindex Input, 8-bit characters | |
4865 | |
4866 Various methods are available for input of eight-bit characters. See | |
4867 @inforef{Unibyte Mode, Single-byte Character Set | |
4868 Support, emacs}. For more sophisticated methods, @inforef{Input | |
4869 Methods, Input Methods, emacs}. | |
4870 | |
4871 @node Kanji and Chinese characters, Right-to-left alphabets, Inputting eight-bit characters, Alternate character sets | |
4872 @section Where can I get an Emacs that handles kanji, Chinese, or other Far-Eastern character sets? | |
4873 @cindex Kanji, handling with Emacs | |
4874 @cindex Chinese, handling with Emacs | |
4875 @cindex Japanese, handling with Emacs | |
4876 @cindex Korean, handling with Emacs | |
4877 | |
4878 Emacs 20 and later includes many of the features of MULE, the MULtilingual | |
4879 Enhancement to Emacs. @xref{Installing Emacs}, for information on where | |
4880 to find and download the latest version of Emacs. | |
4881 | |
4882 @node Right-to-left alphabets, How to add fonts, Kanji and Chinese characters, Alternate character sets | |
4883 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets? | |
4884 @cindex Right-to-left alphabets | |
4885 @cindex Hebrew, handling with Emacs | |
4886 @cindex Semitic alphabets | |
4887 @cindex Arabic alphabets | |
4888 | |
4889 Emacs 20 and later supports Hebrew characters (ISO 8859-8), but does not | |
4890 yet support right-to-left character entry and display. | |
4891 | |
4892 @email{joel@@exc.com, Joel M. Hoffman} has written a Lisp package called | |
4893 @file{hebrew.el} that allows right-to-left editing of Hebrew. It | |
4894 reportedly works out of the box with Emacs 19, but requires patches for | |
4895 Emacs 18. Write to Joel if you want the patches or package. | |
4896 | |
4897 @c FIXME: Should we mention Ehud Karni's package? | |
4898 | |
4899 @file{hebrew.el} requires a Hebrew screen font, but no other hardware support. | |
4900 Joel has a screen font for PCs running MS-DOS or GNU/Linux. | |
4901 | |
4902 You might also try querying @code{archie} for files named with | |
4903 @file{hebrew}; several ftp sites in Israel may also have the necessary | |
4904 files. | |
4905 | |
4906 @node How to add fonts, , Right-to-left alphabets, Alternate character sets | |
4907 @section How do I add fonts for use with Emacs? | |
4908 @cindex add fonts for use with Emacs | |
4909 @cindex intlfonts | |
4910 | |
4911 First, download and install the BDF font files and any auxiliary | |
4912 packages they need. The GNU Intlfonts distribution can be found on | |
4913 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU | |
4914 Software Directory Web site}. | |
4915 | |
4916 Next, if you are on X Window system, issue the following two commands | |
4917 from the shell's prompt: | |
4918 | |
4919 @example | |
4920 xset +fp /usr/local/share/emacs/fonts | |
4921 xset fp rehash | |
4922 @end example | |
4923 | |
4924 @noindent | |
4925 (Modify the first command if you installed the fonts in a directory | |
4926 that is not @file{/usr/local/share/emacs/fonts}.) You also need to | |
4927 arrange for these two commands to run whenever you log in, e.g., by | |
4928 adding them to your window-system startup file, such as | |
4929 @file{~/.xsessionrc} or @file{~/.gnomerc}. | |
4930 | |
4931 Now, add the following line to your @file{~/.emacs} init file: | |
4932 | |
4933 @lisp | |
4934 (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf") | |
4935 @end lisp | |
4936 | |
4937 @noindent | |
4938 (Again, modify the file name if you installed the fonts elsewhere.) | |
4939 | |
4940 Finally, if you wish to use the installed fonts with @code{ps-print}, | |
4941 add the following line to your @file{~/.emacs}: | |
4942 | |
4943 @lisp | |
4944 (setq ps-multibyte-buffer 'bdf-font-except-latin) | |
4945 @end lisp | |
4946 | |
4947 A few additional steps are necessary for MS-Windows; they are listed | |
4948 below. | |
4949 | |
4950 First, make sure @emph{all} the directories with BDF font files are | |
4951 mentioned in @code{bdf-directory-list}. On Unix and GNU/Linux | |
4952 systems, one normally runs @kbd{make install} to install the BDF fonts | |
4953 in the same directory. By contrast, Windows users typically don't run | |
4954 the Intlfonts installation command, but unpack the distribution in | |
4955 some directory, which leaves the BDF fonts in its subdirectories. For | |
4956 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts}; | |
4957 then you should set @code{bdf-directory-list} as follows: | |
4958 | |
4959 @lisp | |
4960 (setq bdf-directory-list | |
4961 '("C:/Intlfonts/Asian" | |
4962 "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X" | |
4963 "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic" | |
4964 "C:/Intlfonts/European" "C:/Intlfonts/European.BIG" | |
4965 "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X" | |
4966 "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X" | |
4967 "C:/Intlfonts/Misc")) | |
4968 @end lisp | |
4969 | |
4970 @cindex @code{w32-bdf-filename-alist} | |
4971 @cindex @code{w32-find-bdf-fonts} | |
4972 Next, you need to set up the variable @code{w32-bdf-filename-alist} to | |
4973 an alist of the BDF fonts and their corresponding file names. | |
4974 Assuming you have set @code{bdf-directory-list} to name all the | |
4975 directories with the BDF font files, the following Lisp snippet will | |
4976 set up @code{w32-bdf-filename-alist}: | |
4977 | |
4978 @lisp | |
4979 (setq w32-bdf-filename-alist | |
4980 (w32-find-bdf-fonts bdf-directory-list)) | |
4981 @end lisp | |
4982 | |
4983 Now, create fontsets for the BDF fonts: | |
4984 | |
4985 @lisp | |
4986 (create-fontset-from-fontset-spec | |
4987 "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf, | |
4988 japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*, | |
4989 katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*, | |
4990 latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*, | |
4991 japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*, | |
4992 thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1, | |
4993 lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1, | |
4994 tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1, | |
4995 ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode, | |
4996 tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0") | |
4997 @end lisp | |
4998 | |
4999 Many of the international bdf fonts from Intlfonts are type 0, and | |
5000 therefore need to be added to font-encoding-alist: | |
5001 | |
5002 @lisp | |
5003 (setq font-encoding-alist | |
5004 (append '(("MuleTibetan-0" (tibetan . 0)) | |
5005 ("GB2312" (chinese-gb2312 . 0)) | |
5006 ("JISX0208" (japanese-jisx0208 . 0)) | |
5007 ("JISX0212" (japanese-jisx0212 . 0)) | |
5008 ("VISCII" (vietnamese-viscii-lower . 0)) | |
5009 ("KSC5601" (korean-ksc5601 . 0)) | |
5010 ("MuleArabic-0" (arabic-digit . 0)) | |
5011 ("MuleArabic-1" (arabic-1-column . 0)) | |
5012 ("MuleArabic-2" (arabic-2-column . 0))) | |
5013 font-encoding-alist)) | |
5014 @end lisp | |
5015 | |
5016 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium} | |
5017 fontset, or you can select it by setting the default font in your | |
5018 @file{~/.emacs}: | |
5019 | |
5020 @lisp | |
5021 (set-default-font "fontset-bdf") | |
5022 @end lisp | |
5023 | |
5024 | |
5025 @c ------------------------------------------------------------ | |
5026 @node Mail and news, Concept index, Alternate character sets, Top | |
5027 @chapter Mail and news | |
5028 @cindex Mail and news | |
5029 | |
5030 @menu | |
5031 * Changing the included text prefix:: | |
5032 * Saving a copy of outgoing mail:: | |
5033 * Expanding aliases when sending mail:: | |
5034 * Rmail thinks all messages are one big one:: | |
5035 * Sorting the messages in an Rmail folder:: | |
5036 * Rmail writes to /usr/spool/mail:: | |
5037 * Recovering mail files when Rmail munges them:: | |
5038 * Replying to the sender of a message:: | |
5039 * MIME with Emacs mail packages:: | |
5040 * Automatically starting a mail or news reader:: | |
5041 * Reading news with Emacs:: | |
5042 * Gnus does not work with NNTP:: | |
5043 * Viewing articles with embedded underlining:: | |
5044 * Saving a multi-part Gnus posting:: | |
5045 * Starting Gnus faster:: | |
5046 * Catching up in all newsgroups:: | |
5047 * Killing based on nonstandard headers:: | |
5048 * Removing flashing messages:: | |
5049 * Catch-up is slow in Gnus:: | |
5050 * Gnus hangs for a long time:: | |
5051 * Learning more about Gnus:: | |
5052 @end menu | |
5053 | |
5054 @node Changing the included text prefix, Saving a copy of outgoing mail, Mail and news, Mail and news | |
5055 @section How do I change the included text prefix in mail/news followups? | |
5056 @cindex Prefix in mail/news followups, changing | |
5057 @cindex Included text prefix, changing | |
5058 @cindex Setting the included text character | |
5059 @cindex Quoting in mail messages | |
5060 | |
5061 If you read mail with Rmail or news with Gnus, set the variable | |
5062 @code{mail-yank-prefix}. For VM, set @code{vm-included-text-prefix}. | |
5063 For mh-e, set @code{mh-ins-buf-prefix}. | |
5064 | |
95921
19f2346062f0
(Major packages and programs): Remove references to external
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
5065 For fancier control of citations, use Supercite (part of Emacs). |
84296 | 5066 |
5067 To prevent Emacs from including various headers of the replied-to | |
5068 message, set the value of @code{mail-yank-ignored-headers} to an | |
5069 appropriate regexp. | |
5070 | |
5071 @node Saving a copy of outgoing mail, Expanding aliases when sending mail, Changing the included text prefix, Mail and news | |
5072 @section How do I save a copy of outgoing mail? | |
5073 @cindex Saving a copy of outgoing mail | |
5074 @cindex Copying outgoing mail to a file | |
5075 @cindex Filing outgoing mail | |
5076 @cindex Automatic filing of outgoing mail | |
5077 @cindex Mail, saving outgoing automatically | |
5078 | |
5079 You can either mail yourself a copy by including a @samp{BCC} header in the | |
5080 mail message, or store a copy of the message directly to a file by | |
5081 including an @samp{FCC} header. | |
5082 | |
5083 If you use standard mail, you can automatically create a @samp{BCC} to | |
5084 yourself by putting | |
5085 | |
5086 @lisp | |
5087 (setq mail-self-blind t) | |
5088 @end lisp | |
5089 | |
5090 @noindent | |
5091 in your @file{.emacs} file. You can automatically include an @samp{FCC} | |
5092 field by putting something like the following in your @file{.emacs} | |
5093 file: | |
5094 | |
5095 @lisp | |
5096 (setq mail-archive-file-name (expand-file-name "~/outgoing")) | |
5097 @end lisp | |
5098 | |
5099 The output file will be in Unix mail format, which can be read directly | |
5100 by VM, but not always by Rmail. @xref{Learning how to do something}. | |
5101 | |
5102 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your | |
5103 components file. | |
5104 | |
5105 It does not work to put @samp{set record filename} in the @file{.mailrc} | |
5106 file. | |
5107 | |
5108 @node Expanding aliases when sending mail, Rmail thinks all messages are one big one, Saving a copy of outgoing mail, Mail and news | |
5109 @section Why doesn't Emacs expand my aliases when sending mail? | |
5110 @cindex Expanding aliases when sending mail | |
5111 @cindex Mail alias expansion | |
5112 @cindex Sending mail with aliases | |
5113 | |
5114 @itemize @bullet | |
5115 | |
5116 @item | |
5117 You must separate multiple addresses in the headers of the mail buffer | |
5118 with commas. This is because Emacs supports RFC822 standard addresses | |
5119 like this one: | |
5120 | |
5121 @example | |
5122 To: Willy Smith <wks@@xpnsv.lwyrs.com> | |
5123 @end example | |
5124 | |
5125 However, you do not need to---and probably should not, unless your | |
5126 system's version of @file{/usr/ucb/mail} (a.k.a.@: @code{mailx}) | |
5127 supports RFC822---separate addresses with commas in your | |
5128 @file{~/.mailrc} file. | |
5129 | |
5130 @item | |
5131 Emacs normally only reads the @file{.mailrc} file once per session, | |
5132 when you start to compose your first mail message. If you edit | |
5133 @file{.mailrc}, you can type @kbd{M-x rebuild-mail-abbrevs @key{RET}} to | |
5134 make Emacs reread @file{~/.mailrc}. | |
5135 | |
5136 @item | |
5137 If you like, you can expand mail aliases as abbrevs, as soon as you | |
5138 type them in. To enable this feature, execute the following: | |
5139 | |
5140 @lisp | |
5141 (add-hook 'mail-mode-hook 'mail-abbrevs-setup) | |
5142 @end lisp | |
5143 | |
5144 Note that the aliases are expanded automatically only after you type | |
5145 @key{RET} or a punctuation character (e.g. @kbd{,}). You can force their | |
5146 expansion by moving point to the end of the alias and typing @kbd{C-x a e} | |
5147 (@kbd{M-x expand-abbrev}). | |
5148 @end itemize | |
5149 | |
5150 @node Rmail thinks all messages are one big one, Sorting the messages in an Rmail folder, Expanding aliases when sending mail, Mail and news | |
5151 @section Why does Rmail think all my saved messages are one big message? | |
5152 @cindex Rmail thinks all messages are one large message | |
5153 | |
5154 A file created through the @samp{FCC} field in a message is in Unix mail | |
5155 format, not the format that Rmail uses (BABYL format). Rmail will try | |
5156 to convert a Unix mail file into BABYL format on input, but sometimes it | |
5157 makes errors. For guaranteed safety, you can make the | |
5158 @file{saved-messages} file be an inbox for your Rmail file by using the | |
5159 function @code{set-rmail-inbox-list}. | |
5160 | |
5161 @node Sorting the messages in an Rmail folder, Rmail writes to /usr/spool/mail, Rmail thinks all messages are one big one, Mail and news | |
5162 @section How can I sort the messages in my Rmail folder? | |
5163 @cindex Rmail, sorting messages in | |
5164 @cindex Folder, sorting messages in an Rmail | |
5165 @cindex Sorting messages in an Rmail folder | |
5166 | |
5167 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions | |
5168 and their key bindings. | |
5169 | |
5170 @node Rmail writes to /usr/spool/mail, Recovering mail files when Rmail munges them, Sorting the messages in an Rmail folder, Mail and news | |
5171 @section Why does Rmail need to write to @file{/usr/spool/mail}? | |
5172 @cindex Rmail and @file{/usr/spool/mail} | |
5173 @cindex @file{/usr/spool/mail} and Rmail | |
5174 | |
5175 This is the behavior of the @code{movemail} program which Rmail uses. | |
5176 This indicates that @code{movemail} is configured to use lock files. | |
5177 | |
5178 RMS writes: | |
5179 | |
5180 @quotation | |
5181 Certain systems require lock files to interlock access to mail files. | |
5182 On these systems, @code{movemail} must write lock files, or you risk losing | |
5183 mail. You simply must arrange to let @code{movemail} write them. | |
5184 | |
5185 Other systems use the @code{flock} system call to interlock access. On | |
5186 these systems, you should configure @code{movemail} to use @code{flock}. | |
5187 @end quotation | |
5188 | |
5189 @node Recovering mail files when Rmail munges them, Replying to the sender of a message, Rmail writes to /usr/spool/mail, Mail and news | |
5190 @section How do I recover my mail files after Rmail munges their format? | |
5191 @cindex Recovering munged mail files | |
5192 @cindex Rmail munged my files | |
5193 @cindex Mail files, recovering those munged by Rmail | |
5194 | |
5195 If you have just done @kbd{M-x rmail-input} on a file and you don't want | |
5196 to save it in Rmail's format (called BABYL), just kill the buffer (with | |
5197 @kbd{C-x k}). | |
5198 | |
5199 @cindex Exporting messages as Unix mail files | |
5200 If you typed @kbd{M-x rmail} and it read some messages out of your inbox | |
5201 and you want to put them in a Unix mail file, use @kbd{C-o} on each | |
5202 message. | |
5203 | |
5204 @cindex Converting from BABYL to Unix mail format | |
5205 @cindex @code{unrmail} command | |
5206 If you want to convert an existing file from BABYL format to Unix mail | |
5207 format, use the command @kbd{M-x unrmail}: it will prompt you for the | |
5208 input and output file names. | |
5209 | |
5210 @pindex b2m | |
5211 Alternatively, you could use the @code{b2m} program supplied with | |
5212 Emacs. @code{b2m} is a filter, and is used like this: | |
5213 | |
5214 @example | |
5215 b2m < @var{babyl-file} > @var{mbox-file} | |
5216 @end example | |
5217 | |
5218 @noindent | |
5219 where @var{babyl-file} is the name of the BABYL file, and | |
5220 @var{mbox-file} is the name of the file where the converted mail will | |
5221 be written. | |
5222 | |
5223 @node Replying to the sender of a message, MIME with Emacs mail packages, Recovering mail files when Rmail munges them, Mail and news | |
5224 @section How can I force Rmail to reply to the sender of a message, but not the other recipients? | |
5225 @cindex Replying only to the sender of a message | |
5226 @cindex Sender, replying only to | |
5227 @cindex Rmail, replying to the sender of a message in | |
5228 | |
5229 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit | |
5230 @key{r} to reply in Rmail, by default it CCs all of the original | |
5231 recipients (everyone on the original @samp{To} and @samp{CC} | |
5232 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}), | |
5233 it replies only to the sender. However, going through the whole | |
5234 @kbd{C-u} business every time you want to reply is a pain. This is the | |
5235 best fix I've been able to come up with: | |
5236 | |
5237 @lisp | |
5238 (defun rmail-reply-t () | |
5239 "Reply only to the sender of the current message. (See rmail-reply.)" | |
5240 (interactive) | |
5241 (rmail-reply t)) | |
5242 | |
5243 (add-hook 'rmail-mode-hook | |
5244 (lambda () | |
5245 (define-key rmail-mode-map "r" 'rmail-reply-t) | |
5246 (define-key rmail-mode-map "R" 'rmail-reply))) | |
5247 @end lisp | |
5248 | |
5249 @node MIME with Emacs mail packages, Automatically starting a mail or news reader, Replying to the sender of a message, Mail and news | |
5250 @section How can I get my favorite Emacs mail package to support MIME? | |
5251 @cindex MIME and Emacs mail packages | |
5252 @cindex Mail packages and MIME | |
5253 @cindex FAQ for MIME and Emacs | |
5254 | |
5255 Version 6.x of VM supports MIME. @xref{VM}. Gnus supports MIME in mail | |
5256 and news messages as of version 5.8.1 (Pterodactyl). Rmail has limited | |
5257 support for single-part MIME messages beginning with Emacs 20.3. | |
5258 | |
5259 @node Automatically starting a mail or news reader, Reading news with Emacs, MIME with Emacs mail packages, Mail and news | |
5260 @section How do I make Emacs automatically start my mail/news reader? | |
5261 @cindex Mail reader, starting automatically | |
5262 @cindex News reader, starting automatically | |
5263 @cindex Starting mail/news reader automatically | |
5264 | |
5265 To start Emacs in Gnus: | |
5266 | |
5267 @example | |
5268 emacs -f gnus | |
5269 @end example | |
5270 | |
5271 @noindent | |
5272 in Rmail: | |
5273 | |
5274 @example | |
5275 emacs -f rmail | |
5276 @end example | |
5277 | |
5278 A more convenient way to start with Gnus: | |
5279 | |
5280 @example | |
5281 alias gnus 'emacs -f gnus' | |
5282 gnus | |
5283 @end example | |
5284 | |
5285 It is probably unwise to automatically start your mail or news reader | |
5286 from your @file{.emacs} file. This would cause problems if you needed to run | |
5287 two copies of Emacs at the same time. Also, this would make it difficult for | |
5288 you to start Emacs quickly when you needed to. | |
5289 | |
5290 @node Reading news with Emacs, Gnus does not work with NNTP, Automatically starting a mail or news reader, Mail and news | |
5291 @section How do I read news under Emacs? | |
5292 @cindex Reading news under Emacs | |
5293 @cindex Usenet reader in Emacs | |
5294 @cindex Gnus newsreader | |
5295 | |
5296 Use @kbd{M-x gnus}. It is documented in Info (@pxref{Learning how to do | |
5297 something}). | |
5298 | |
5299 @node Gnus does not work with NNTP, Viewing articles with embedded underlining, Reading news with Emacs, Mail and news | |
5300 @section Why doesn't Gnus work via NNTP? | |
5301 @cindex Gnus and NNTP | |
5302 @cindex NNTP, Gnus fails to work with | |
5303 | |
5304 There is a bug in NNTP version 1.5.10, such that when multiple requests | |
5305 are sent to the NNTP server, the server only handles the first one | |
5306 before blocking waiting for more input which never comes. NNTP version | |
5307 1.5.11 claims to fix this. | |
5308 | |
5309 You can work around the bug inside Emacs like this: | |
5310 | |
5311 @lisp | |
5312 (setq nntp-maximum-request 1) | |
5313 @end lisp | |
5314 | |
5315 You can find out what version of NNTP your news server is running by | |
5316 telnetting to the NNTP port (usually 119) on the news server machine | |
5317 (i.e., @kbd{telnet server-machine 119}). The server should give its | |
5318 version number in the welcome message. Type @kbd{quit} to get out. | |
5319 | |
5320 @xref{Spontaneous entry into isearch-mode}, for some additional ideas. | |
5321 | |
5322 @node Viewing articles with embedded underlining, Saving a multi-part Gnus posting, Gnus does not work with NNTP, Mail and news | |
5323 @section How do I view news articles with embedded underlining (e.g., ClariNews)? | |
5324 @cindex Underlining, embedded in news articles | |
5325 @cindex News articles with embedded underlining | |
5326 @cindex Embedded underlining in news articles | |
5327 | |
5328 Underlining appears like this: | |
5329 | |
5330 @example | |
5331 _^Hu_^Hn_^Hd_^He_^Hr_^Hl_^Hi_^Hn_^Hi_^Hn_^Hg | |
5332 @end example | |
5333 | |
5334 @email{abraham@@dina.kvl.dk, Per Abrahamsen} suggests using the following | |
5335 code, which uses the underline face to turn such text into true | |
5336 underlining, inconjunction with Gnus: | |
5337 | |
5338 @lisp | |
5339 (defun gnus-article-prepare-overstrike () | |
5340 ;; Prepare article for overstrike commands. | |
5341 (save-excursion | |
5342 (set-buffer gnus-article-buffer) | |
5343 (let ((buffer-read-only nil)) | |
5344 (goto-char (point-min)) | |
5345 (while (search-forward "\b" nil t) | |
5346 (let ((next (following-char)) | |
5347 (previous (char-after (- (point) 2)))) | |
5348 (cond ((eq next previous) | |
5349 (delete-region (- (point) 2) (point)) | |
5350 (put-text-property (point) (1+ (point)) | |
5351 'face 'bold)) | |
5352 ((eq next ?_) | |
5353 (delete-region (1- (point)) (1+ (point))) | |
5354 (put-text-property (1- (point)) (point) | |
5355 'face 'underline)) | |
5356 ((eq previous ?_) | |
5357 (delete-region (- (point) 2) (point)) | |
5358 (put-text-property (point) (1+ (point)) | |
5359 'face 'underline)))))))) | |
5360 | |
5361 (add-hook 'gnus-article-prepare-hook 'gnus-article-prepare-overstrike) | |
5362 @end lisp | |
5363 | |
5364 Latest versions of Gnus do such a conversion automatically. | |
5365 | |
5366 If you prefer to do away with underlining altogether, you can | |
5367 destructively remove it with @kbd{M-x ununderline-region}; do this | |
5368 automatically via | |
5369 | |
5370 @lisp | |
5371 (add-hook 'gnus-article-prepare-hook | |
5372 (lambda () (ununderline-region (point-min) (point-max)))) | |
5373 @end lisp | |
5374 | |
5375 @node Saving a multi-part Gnus posting, Starting Gnus faster, Viewing articles with embedded underlining, Mail and news | |
5376 @section How do I save all the items of a multi-part posting in Gnus? | |
5377 @cindex Multi-part postings in Gnus, saving | |
5378 @cindex Saving multi-part postings in Gnus | |
5379 @cindex Gnus, saving multi-part postings in | |
5380 | |
5381 Use @code{gnus-uu}. Type @kbd{C-c C-v C-h} in the Gnus summary buffer | |
5382 to see a list of available commands. | |
5383 | |
5384 @node Starting Gnus faster, Catching up in all newsgroups, Saving a multi-part Gnus posting, Mail and news | |
5385 @section How do I make Gnus start up faster? | |
5386 @cindex Faster, starting Gnus | |
5387 @cindex Starting Gnus faster | |
5388 @cindex Gnus, starting faster | |
5389 | |
5390 From the Gnus FAQ (@pxref{Learning more about Gnus}): | |
5391 | |
5392 @quotation | |
5393 @email{pktiwari@@eos.ncsu.edu, Pranav Kumar Tiwari} writes: I posted | |
5394 the same query recently and I got an answer to it. I am going to | |
5395 repeat the answer. What you need is a newer version of gnus, version | |
5396 5.0.4+. I am using 5.0.12 and it works fine with me with the | |
5397 following settings: | |
5398 | |
5399 @lisp | |
5400 (setq gnus-check-new-newsgroups nil | |
5401 gnus-read-active-file 'some | |
5402 gnus-nov-is-evil nil | |
5403 gnus-select-method '(nntp gnus-nntp-server)) | |
5404 @end lisp | |
5405 @end quotation | |
5406 | |
5407 @node Catching up in all newsgroups, Killing based on nonstandard headers, Starting Gnus faster, Mail and news | |
5408 @section How do I catch up all newsgroups in Gnus? | |
5409 @cindex Catching up all newsgroups in Gnus | |
5410 @cindex Gnus, Catching up all newsgroups in | |
5411 | |
5412 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e} | |
5413 | |
5414 Leave off the initial @kbd{M-<} if you only want to catch up from point | |
5415 to the end of the @file{*Newsgroup*} buffer. | |
5416 | |
5417 @node Killing based on nonstandard headers, Removing flashing messages, Catching up in all newsgroups, Mail and news | |
5418 @section Why can't I kill in Gnus based on the Newsgroups/Keywords/Control headers? | |
5419 @cindex Killing articles based on nonstandard headers | |
5420 @cindex Newsgroups header, killing articles based on | |
5421 @cindex Keywords header, killing articles based on | |
5422 @cindex Control header, killing articles based on | |
5423 | |
5424 Gnus will complain that the @samp{Newsgroups}, @samp{Keywords}, and | |
5425 @samp{Control} headers are ``Unknown header'' fields. | |
5426 | |
5427 For the @samp{Newsgroups} header, there is an easy workaround: kill on the | |
5428 @samp{Xref} header instead, which will be present on any cross-posted article | |
5429 (as long as your site carries the cross-post group). | |
5430 | |
5431 If you really want to kill on one of these headers, you can do it like | |
5432 this: | |
5433 | |
5434 @lisp | |
5435 (gnus-kill nil "^Newsgroups: .*\\(bad\\.group\\|worse\\.group\\)") | |
5436 @end lisp | |
5437 | |
5438 @node Removing flashing messages, Catch-up is slow in Gnus, Killing based on nonstandard headers, Mail and news | |
5439 @section How do I get rid of flashing messages in Gnus for slow connections? | |
5440 @cindex Flashing Gnus messages, removing | |
5441 @cindex Removing flashing Gnus messages | |
5442 @cindex Slow connections causing flashing messages in Gnus | |
5443 @cindex Gnus, flashing messages in | |
5444 | |
5445 Set @code{nntp-debug-read} to @code{nil}. | |
5446 | |
5447 @node Catch-up is slow in Gnus, Gnus hangs for a long time, Removing flashing messages, Mail and news | |
5448 @section Why is catch up slow in Gnus? | |
5449 @cindex Slow catch up in Gnus | |
5450 @cindex Gnus is slow when catching up | |
5451 @cindex Crosspostings make Gnus catching up slow | |
5452 | |
5453 Because Gnus is marking crosspostings read. You can control this with | |
5454 the variable @code{gnus-use-cross-reference}. | |
5455 | |
5456 @node Gnus hangs for a long time, Learning more about Gnus, Catch-up is slow in Gnus, Mail and news | |
5457 @section Why does Gnus hang for a long time when posting? | |
5458 @cindex Hangs in Gnus | |
5459 @cindex Gnus hangs while posting | |
5460 @cindex Posting, Gnus hangs wile | |
5461 | |
5462 @email{tale@@uunet.uu.net, David Lawrence} explains: | |
5463 | |
5464 @quotation | |
5465 The problem is almost always interaction between NNTP and C News. NNTP | |
5466 POST asks C News's @code{inews} to not background itself but rather hang | |
5467 around and give its exit status so it knows whether the post was successful. | |
5468 (That wait will on some systems not return the exit status of the | |
5469 waited for job is a different sort of problem.) It ends up taking a | |
5470 long time because @code{inews} is calling @code{relaynews}, which often | |
5471 waits for another @code{relaynews} to free the lock on the news system | |
5472 so it can file the article. | |
5473 | |
5474 My preferred solution is to change @code{inews} to not call | |
5475 @code{relaynews}, but rather use @code{newsspool}. This loses some | |
5476 error-catching functionality, but is for the most part safe as | |
5477 @code{inews} will detect a lot of the errors on its own. The C News | |
5478 folks have sped up @code{inews}, too, so speed should look better to | |
5479 most folks as that update propagates around. | |
5480 @end quotation | |
5481 | |
5482 @node Learning more about Gnus, , Gnus hangs for a long time, Mail and news | |
5483 @section Where can I find out more about Gnus? | |
5484 @cindex FAQ for Gnus | |
5485 @cindex Gnus FAQ | |
5486 @cindex Learning more about Gnus | |
5487 | |
5488 For more information on Gnus, consult the Gnus manual and FAQ, which are | |
5489 part of the Gnus distribution. | |
5490 | |
5491 @node Concept index, , Mail and news, Top | |
5492 @unnumbered Concept Index | |
5493 @printindex cp | |
5494 | |
5495 @contents | |
5496 @bye | |
5497 | |
5498 @ignore | |
5499 arch-tag: fee0d62d-06cf-43d8-ac21-123408eaf10f | |
5500 @end ignore |