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