1 \input texinfo @c -*- mode: texinfo; -*-
3 @setfilename ../../info/efaq
4 @settitle GNU Emacs FAQ
9 @c This file is maintained by Romain Francoise <rfrancoise@gnu.org>.
10 @c Feel free to install changes without prior permission (but I'd
11 @c appreciate a notice if you do).
14 Copyright @copyright{} 2001-2012 Free Software Foundation, Inc.@*
15 Copyright @copyright{} 1994, 1995, 1996, 1997, 1998, 1999, 2000
17 Copyright @copyright{} 1992, 1993 Steven Byrnes@*
18 Copyright @copyright{} 1990, 1991, 1992 Joseph Brian Wells@*
21 This list of frequently asked questions about GNU Emacs with answers
22 (``FAQ'') may be translated into other languages, transformed into other
23 formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information.
25 The same conditions apply to any derivative of the FAQ as apply to the FAQ
26 itself. Every copy of the FAQ must include this notice or an approved
27 translation, information on who is currently maintaining the FAQ and how to
28 contact them (including their e-mail address), and information on where the
29 latest version of the FAQ is archived (including FTP information).
31 The FAQ may be copied and redistributed under these conditions, except that
32 the FAQ may not be embedded in a larger literary work unless that work
33 itself allows free copying and redistribution.
35 [This version has been heavily edited since it was included in the Emacs
42 * Emacs FAQ: (efaq). Frequently Asked Questions about Emacs.
45 @c The @titlepage stuff only appears in the printed version
48 @center @titlefont{GNU Emacs FAQ}
50 @c The following two commands start the copyright page.
52 @vskip 0pt plus 1filll
58 @node Top, FAQ notation, (dir), (dir)
59 @top The GNU Emacs FAQ
61 @c FIXME @today is just the day we ran `makeinfo'.
62 This is the GNU Emacs FAQ, last updated on @today{}.
64 This FAQ is maintained as a part of GNU Emacs. If you find any errors,
65 or have any suggestions, please use @kbd{M-x report-emacs-bug} to report
68 This is the version of the FAQ distributed with Emacs @value{EMACSVER}, and
69 mainly describes that version. Although there is some information on
70 older versions, details about very old releases (now only of historical
71 interest) have been removed. If you are interested in this, consult
72 either the version of the FAQ distributed with older versions of Emacs,
73 or the history of this document in the Emacs source repository.
75 Since Emacs releases are very stable, we recommend always running the
78 This FAQ is not updated very frequently. When you have a question about
79 Emacs, the Emacs manual is often the best starting point.
92 * Compiling and installing Emacs::
93 * Finding Emacs and related packages::
95 * Alternate character sets::
100 @c ------------------------------------------------------------
102 @chapter FAQ notation
105 This chapter describes notation used in the GNU Emacs FAQ, as well as in
106 the Emacs documentation. Consult this section if this is the first time
107 you are reading the FAQ, or if you are confused by notation or terms
112 * Extended commands::
114 * File-name conventions::
119 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
121 @cindex Control key, notation for
122 @cindex @key{Meta} key, notation for
123 @cindex Control-Meta characters, notation for
124 @cindex @kbd{C-h}, definition of
125 @cindex @kbd{C-M-h}, definition of
126 @cindex @key{DEL}, definition of
127 @cindex @key{ESC}, definition of
128 @cindex @key{LFD}, definition of
129 @cindex @key{RET}, definition of
130 @cindex @key{SPC}, definition of
131 @cindex @key{TAB}, definition of
132 @cindex Notation for keys
137 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
140 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
141 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
144 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
148 @kbd{C-M-x}: a synonym for the above
151 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
154 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
157 @key{DEL}: @key{Delete}, usually @strong{not} the same as
158 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
159 deleting invokes Emacs help)
162 @key{ESC}: Escape; same as @kbd{C-[}
165 @key{TAB}: Tab; same as @kbd{C-i}
172 Key sequences longer than one key (and some single-key sequences) are
173 written inside quotes or on lines by themselves, like this:
176 @kbd{M-x frobnicate-while-foo RET}
180 Any real spaces in such a key sequence should be ignored; only @key{SPC}
181 really means press the space key.
183 The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
184 that would be sent by pressing just @key{x} minus 96 (or 64 for
185 upper-case @key{X}) and will be from 0 to 31. On Unix and GNU/Linux
186 terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the
187 @acronym{ASCII} code that would be sent by pressing just @key{x}. Essentially,
188 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
190 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
193 @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call
194 @kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON.
195 Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127.
196 @c FIXME I cannot understand the previous sentence.
198 @inforef{Keys, Keys, emacs}, for more information. (@xref{Emacs
199 manual}, for more information about Info.)
201 @node Extended commands
202 @section What does @file{M-x @var{command}} mean?
203 @cindex Extended commands
204 @cindex Commands, extended
205 @cindex M-x, meaning of
207 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
208 command, then type @key{RET}. (@xref{Basic keys}, if you're not sure
209 what @kbd{M-x} and @key{RET} mean.)
211 @kbd{M-x} (by default) invokes the command
212 @code{execute-extended-command}. This command allows you to run any
213 Emacs command if you can remember the command's name. If you can't
214 remember the command's name, you can type @key{TAB} and @key{SPC} for
215 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
216 @kbd{M-n} (or up-arrow and down-arrow) to see previous commands entered.
217 An Emacs @dfn{command} is an @dfn{interactive} Emacs function.
220 Your system administrator may have bound other key sequences to invoke
221 @code{execute-extended-command}. A function key labeled @kbd{Do} is a
222 good candidate for this, on keyboards that have such a key.
224 If you need to run non-interactive Emacs functions, see @ref{Evaluating
228 @section How do I read topic XXX in the Emacs manual?
229 @cindex Emacs manual, reading topics in
230 @cindex Reading topics in the Emacs manual
231 @cindex Finding topics in the Emacs manual
232 @cindex Info, finding topics in
234 When we refer you to some @var{topic} in the Emacs manual, you can
235 read this manual node inside Emacs (assuming nothing is broken) by
236 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
238 This invokes Info, the GNU hypertext documentation browser. If you don't
239 already know how to use Info, type @key{?} from within Info.
241 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
242 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
244 If these commands don't work as expected, your system administrator may
245 not have installed the Info files, or may have installed them
246 improperly. In this case you should complain.
248 If you are reading this FAQ in Info, you can simply press @key{RET} on a
249 reference to follow it.
251 @xref{Getting a printed manual}, if you would like a paper copy of the
254 @node File-name conventions
255 @section What are @file{etc/GNU}, @file{src/config.h}, @file{site-lisp/default.el}, etc.?
256 @cindex File-name conventions
257 @cindex Conventions for file names
258 @cindex Directories and files that come with Emacs
260 These are files that come with Emacs. The Emacs distribution is divided
261 into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}.
262 Some of these (e.g. @file{etc} and @file{lisp}) are present both in
263 an installed Emacs and in the sources, but some (e.g. @file{src}) are
264 only found in the sources.
266 If you use Emacs, but don't know where it is kept on your system, start
267 Emacs, then type @kbd{C-h v data-directory @key{RET}}. The directory
268 name displayed by this will be the full pathname of the installed
269 @file{etc} directory. (This full path is recorded in the Emacs variable
270 @code{data-directory}, and @kbd{C-h v} displays the value and the
271 documentation of a variable.)
273 The location of your Info directory (i.e., where Info documentation
274 is stored) is kept in the variable @code{Info-default-directory-list}. Use
275 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
276 this variable, which will be a list of directory names. The last
277 directory in that list is probably where most Info files are stored. By
278 default, Emacs Info documentation is placed in @file{/usr/local/share/info}.
280 For information on some of the files in the @file{etc} directory,
281 @pxref{Informational files for Emacs}.
283 @node Common acronyms
284 @section What are FSF, LPF, GNU, RMS, FTP, and GPL?
285 @cindex FSF, definition of
286 @cindex LPF, definition of
287 @cindex GNU, definition of
288 @cindex RMS, definition of
289 @cindex Stallman, Richard, acronym for
290 @cindex Richard Stallman, acronym for
291 @cindex FTP, definition of
292 @cindex GPL, definition of
293 @cindex Acronyms, definitions for
294 @cindex Common acronyms, definitions for
299 Free Software Foundation
302 League for Programming Freedom
308 Richard Matthew Stallman
311 File Transfer Protocol
314 GNU General Public License
318 Avoid confusing the FSF and the LPF. The LPF opposes
319 look-and-feel copyrights and software patents. The FSF aims to make
320 high quality free software available for everyone.
322 The word ``free'' in the title of the Free Software Foundation refers to
323 ``freedom,'' not ``zero cost.'' Anyone can charge any price for
324 GPL-covered software that they want to. However, in practice, the
325 freedom enforced by the GPL leads to low prices, because you can always
326 get the software for less money from someone else, since everyone has
327 the right to resell or give away GPL-covered software.
329 @c ------------------------------------------------------------
330 @node General questions
331 @chapter General questions
332 @cindex General questions
334 This chapter contains general questions having to do with Emacs, the
335 Free Software Foundation, and related organizations.
339 * Real meaning of copyleft::
340 * Guidelines for newsgroup postings::
341 * Newsgroup archives::
343 * Unsubscribing from Emacs lists::
344 * Contacting the FSF::
348 @section What is the LPF?
349 @cindex LPF, description of
350 @cindex League for Programming Freedom
351 @cindex Software patents, opposition to
352 @cindex Patents for software, opposition to
354 The LPF opposes the expanding danger of software patents and
355 look-and-feel copyrights. More information on the LPF's views is
356 available at @uref{http://progfree.org/, the LPF home page}.
358 @node Real meaning of copyleft
359 @section What is the real legal meaning of the GNU copyleft?
360 @cindex Copyleft, real meaning of
361 @cindex GPL, real meaning of
362 @cindex General Public License, real meaning of
363 @cindex Discussion of the GPL
365 The real legal meaning of the GNU General Public License (copyleft) will
366 only be known if and when a judge rules on its validity and scope.
367 There has never been a copyright infringement case involving the GPL to
368 set any precedents. Although legal actions have been brought against
369 companies for violating the terms of the GPL, so far all have been
370 settled out of court (in favor of the plaintiffs). Please take any
371 discussion regarding this issue to the newsgroup
372 @uref{news:gnu.misc.discuss}, which was created to hold the extensive
373 flame wars on the subject.
378 The legal meaning of the GNU copyleft is less important than the spirit,
379 which is that Emacs is a free software project and that work pertaining
380 to Emacs should also be free software. ``Free'' means that all users
381 have the freedom to study, share, change and improve Emacs. To make
382 sure everyone has this freedom, pass along source code when you
383 distribute any version of Emacs or a related program, and give the
384 recipients the same freedom that you enjoyed.
387 @node Guidelines for newsgroup postings
388 @section What are appropriate messages for the various Emacs newsgroups?
389 @cindex Newsgroups, appropriate messages for
390 @cindex GNU newsgroups, appropriate messages for
391 @cindex Usenet groups, appropriate messages for
392 @cindex Mailing lists, appropriate messages for
393 @cindex Posting messages to newsgroups
395 @cindex GNU mailing lists
396 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU
397 mailing list (@pxref{Informational files for Emacs}). For those lists
398 which are gatewayed with newsgroups, it lists both the newsgroup name
399 and the mailing list address. The Emacs mailing lists are also
400 described at @uref{http://savannah.gnu.org/mail/?group=emacs, the Emacs
403 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
404 in general. The newsgroup @uref{news:gnu.emacs.help} is specifically
405 for GNU Emacs. It therefore makes no sense to cross-post to both
406 groups, since only one can be appropriate to any question.
408 Messages advocating ``non-free'' software are considered unacceptable on
409 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
410 which was created to hold the extensive flame-wars on the subject.
411 ``Non-free'' software includes any software for which the end user can't
412 freely modify the source code and exchange enhancements. Be careful to
413 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
414 posting a followup that recommends such software.
416 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
417 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
419 @node Newsgroup archives
420 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
421 @cindex Archived postings from @code{gnu.emacs.help}
422 @cindex Usenet archives for GNU groups
423 @cindex Old Usenet postings for GNU groups
425 The FSF has maintained archives of all of the GNU mailing lists for many
426 years, although there may be some unintentional gaps in coverage. The
427 archive can be browsed over the web at
428 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}. Raw
429 files can be downloaded from @uref{ftp://lists.gnu.org/}.
431 Web-based Usenet search services, such as
432 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
433 archive the @code{gnu.*} groups.
435 You can also read the archives of the @code{gnu.*} groups and post new
436 messages at @uref{http://gmane.org/, Gmane}. Gmane is a service that
437 presents mailing lists as newsgroups (even those without a traditional
438 mail-to-news gateway).
441 @section Where should I report bugs and other problems with Emacs?
442 @cindex Bug reporting
443 @cindex Good bug reports
444 @cindex How to submit a bug report
445 @cindex Reporting bugs
447 The correct way to report Emacs bugs is to use the command
448 @kbd{M-x report-emacs-bug}. It sets up a mail buffer with the
449 essential information and the correct e-mail address, which is
450 @email{bug-gnu-emacs@@gnu.org} for the released versions of Emacs.
451 Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the
452 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
453 news to submit the bug report. This ensures a reliable return address
454 so you can be contacted for further details.
456 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
457 a bug! The manual describes in detail how to submit a useful bug
458 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
459 (@xref{Emacs manual}, if you don't know how to read the manual.)
464 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the
465 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because
466 it takes the time of an unnecessarily large group of people, most of
467 whom are just users and have no idea how to fix these problem.
468 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people
469 who are more likely to know what to do and have expressed a wish to
470 receive more messages about Emacs than the others.
473 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
476 If you have reported a bug and you don't hear about a possible fix,
477 then after a suitable delay (such as a week) it is okay to post on
478 @code{gnu.emacs.help} asking if anyone can help you.
481 If you are unsure whether you have found a bug, consider the following
482 non-exhaustive list, courtesy of RMS:
485 If Emacs crashes, that is a bug. If Emacs gets compilation errors
486 while building, that is a bug. If Emacs crashes while building, that
487 is a bug. If Lisp code does not do what the documentation says it
491 @node Unsubscribing from Emacs lists
492 @section How do I unsubscribe from a mailing list?
493 @cindex Unsubscribing from GNU mailing lists
494 @cindex Removing yourself from GNU mailing lists
496 If you are receiving a GNU mailing list named @var{list}, you should be
497 able to unsubscribe from it by sending a request to the address
498 @email{@var{list}-request@@gnu.org}. Mailing lists mails normally
499 contain information in either the message header
500 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
503 @node Contacting the FSF
504 @section How do I contact the FSF?
505 @cindex Contracting the FSF
506 @cindex Free Software Foundation, contacting
508 For up-to-date information, see
509 @uref{http://www.fsf.org/about/contact.html, the FSF contact web-page}.
510 You can send general correspondence to @email{info@@fsf.org}.
512 @cindex Ordering GNU software
513 For details on how to order items directly from the FSF, see the
514 @uref{http://shop.fsf.org/, FSF on-line store}.
516 @c ------------------------------------------------------------
518 @chapter Getting help
521 This chapter tells you how to get help with Emacs.
525 * Learning how to do something::
526 * Getting a printed manual::
527 * Emacs Lisp documentation::
528 * Installing Texinfo documentation::
529 * Printing a Texinfo file::
530 * Viewing Info files outside of Emacs::
531 * Informational files for Emacs::
532 * Help installing Emacs::
533 * Obtaining the FAQ::
537 @section I'm just starting Emacs; how do I do basic editing?
538 @cindex Basic editing with Emacs
539 @cindex Beginning editing
540 @cindex Tutorial, invoking the
541 @cindex Self-paced tutorial, invoking the
542 @cindex Help system, entering the
544 Type @kbd{C-h t} to invoke the self-paced tutorial. Just typing
545 @kbd{C-h} enters the help system. Starting with Emacs 22, the tutorial
546 is available in many foreign languages such as French, German, Japanese,
547 Russian, etc. Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
548 to choose your language and start the tutorial.
550 Your system administrator may have changed @kbd{C-h} to act like
551 @key{DEL} to deal with local keyboards. You can use @kbd{M-x
552 help-for-help} instead to invoke help. To discover what key (if any)
553 invokes help on your system, type @kbd{M-x where-is @key{RET}
554 help-for-help @key{RET}}. This will print a comma-separated list of key
555 sequences in the echo area. Ignore the last character in each key
556 sequence listed. Each of the resulting key sequences (e.g. @key{F1} is
557 common) invokes help.
559 Emacs help works best if it is invoked by a single key whose value
560 should be stored in the variable @code{help-char}.
562 @node Learning how to do something
563 @section How do I find out how to do something in Emacs?
564 @cindex Help for Emacs
565 @cindex Learning to do something in Emacs
566 @cindex Reference card for Emacs
567 @cindex Overview of help systems
569 There are several methods for finding out how to do things in Emacs.
573 @cindex Reading the Emacs manual
575 The complete text of the Emacs manual is available via the Info
576 hypertext reader. Type @kbd{C-h r} to display the manual in Info mode.
577 Typing @key{h} immediately after entering Info will provide a short
578 tutorial on how to use it.
580 @cindex Lookup a subject in a manual
581 @cindex Index search in a manual
583 To quickly locate the section of the manual which discusses a certain
584 issue, or describes a command or a variable, type @kbd{C-h i m emacs
585 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
586 topic, the command, or the variable which you are looking for. If this
587 does not land you on the right place in the manual, press @kbd{,}
588 (comma) repeatedly until you find what you need. (The @kbd{i} and
589 @kbd{,} keys invoke the index-searching functions, which look for the
590 @var{topic} you type in all the indices of the Emacs manual.)
594 You can list all of the commands whose names contain a certain word
595 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
598 @cindex Command description in the manual
600 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
601 for the name of a command, and then attempts to find the section in the
602 Emacs manual where that command is described.
604 @cindex Finding commands and variables
606 You can list all of the functions and variables whose names contain a
607 certain word using @kbd{M-x apropos}.
610 You can list all of the functions and variables whose documentation
611 matches a regular expression or a string, using @kbd{M-x
612 apropos-documentation}.
615 You can order a hardcopy of the manual from the FSF. @xref{Getting a
618 @cindex Reference cards, in other languages
620 You can get a printed reference card listing commands and keys to
621 invoke them. You can order one from the FSF for $2 (or 10 for $18),
622 or you can print your own from the @file{etc/refcards/refcard.tex} or
623 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
624 Beginning with version 21.1, the Emacs distribution comes with
625 translations of the reference card into several languages; look for
626 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
627 is a two-letter code of the language. For example, the German version
628 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
629 and @file{etc/refcards/de-refcard.pdf}.
632 There are many other commands in Emacs for getting help and
633 information. To get a list of these commands, type @samp{?} after
638 @node Getting a printed manual
639 @section How do I get a printed copy of the Emacs manual?
640 @cindex Printed Emacs manual, obtaining
641 @cindex Manual, obtaining a printed or HTML copy of
642 @cindex Emacs manual, obtaining a printed or HTML copy of
644 You can order a printed copy of the Emacs manual from the FSF. For
645 details see the @uref{http://shop.fsf.org/, FSF on-line store}.
647 The full Texinfo source for the manual also comes in the @file{doc/emacs}
648 directory of the Emacs distribution, if you're daring enough to try to
649 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
652 If you absolutely have to print your own copy, and you don't have @TeX{},
653 you can get a PostScript or PDF (or HTML) version from
655 @uref{http://www.gnu.org/software/emacs/manual/}
657 @xref{Learning how to do something}, for how to view the manual from Emacs.
659 @node Emacs Lisp documentation
660 @section Where can I get documentation on Emacs Lisp?
661 @cindex Documentation on Emacs Lisp
662 @cindex Function documentation
663 @cindex Variable documentation
664 @cindex Emacs Lisp Reference Manual
665 @cindex Reference manual for Emacs Lisp
667 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
668 function, @kbd{C-h v} for a variable.
670 For more information, the Emacs Lisp Reference Manual is available
671 in Info format (@pxref{Top, Emacs Lisp,, elisp, The
672 Emacs Lisp Reference Manual}).
674 You can also order a hardcopy of the manual from the FSF, for details
675 see the @uref{http://shop.fsf.org/, FSF on-line store}. (This manual is
676 not always in print.)
678 An HTML version of the Emacs Lisp Reference Manual is available at
680 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html}
682 @node Installing Texinfo documentation
683 @section How do I install a piece of Texinfo documentation?
684 @cindex Texinfo documentation, installing
685 @cindex Installing Texinfo documentation
686 @cindex New Texinfo files, installing
687 @cindex Documentation, installing new Texinfo files
688 @cindex Info files, how to install
690 Emacs releases come with pre-built Info files, and the normal install
691 process places them in the correct location. This is true for most
692 applications that provide Info files. The following section is only
693 relevant if you want to install extra Info files by hand.
695 First, you must turn the Texinfo source files into Info files. You may
696 do this using the stand-alone @file{makeinfo} program, available as part
697 of the Texinfo package at
699 @uref{http://www.gnu.org/software/texinfo/}
701 For information about the Texinfo format, read the Texinfo manual which
702 comes with the Texinfo package. This manual also comes installed in
703 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
706 @c FIXME is this a complete alternative?
707 @c Probably not, given that we require makeinfo to build Emacs.
708 Alternatively, you could use the Emacs command @kbd{M-x
709 texinfo-format-buffer}, after visiting the Texinfo source file of the
710 manual you want to convert.
712 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
713 resulting Info files in Emacs's Info tree. To install Info files,
718 Move the files to the @file{info} directory in the installed Emacs
719 distribution. @xref{File-name conventions}, if you don't know where that
723 Run the @code{install-info} command, which is part of the Texinfo
724 distribution, to update the main Info directory menu, like this:
727 install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
731 where @var{dir-path} is the full path to the directory where you copied
732 the produced Info file(s), and @var{file} is the name of the Info file
733 you produced and want to install.
735 If you don't have the @code{install-info} command installed, you can
736 edit the file @file{info/dir} in the installed Emacs distribution, and
737 add a line for the top level node in the Info package that you are
738 installing. Follow the examples already in this file. The format is:
741 * Topic: (relative-pathname). Short description of topic.
746 If you want to install Info files and you don't have the necessary
747 privileges, you have several options:
751 Info files don't actually need to be installed before being used.
752 You can use a prefix argument for the @code{info} command and specify
753 the name of the Info file in the minibuffer. This goes to the node
754 named @samp{Top} in that file. For example, to view a Info file named
755 @file{@var{info-file}} in your home directory, you can type this:
758 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
761 Alternatively, you can feed a file name to the @code{Info-goto-node}
762 command (invoked by pressing @key{g} in Info mode) by typing the name
763 of the file in parentheses, like this:
766 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
770 You can create your own Info directory. You can tell Emacs where that
771 Info directory is by adding its pathname to the value of the variable
772 @code{Info-default-directory-list}. For example, to use a private Info
773 directory which is a subdirectory of your home directory named @file{Info},
774 you could put this in your @file{.emacs} file:
777 (add-to-list 'Info-default-directory-list "~/Info")
780 You will need a top-level Info file named @file{dir} in this directory
781 which has everything the system @file{dir} file has in it, except it
782 should list only entries for Info files in that directory. You might
783 not need it if (fortuitously) all files in this directory were
784 referenced by other @file{dir} files. The node lists from all
785 @file{dir} files in @code{Info-default-directory-list} are merged by the
790 @node Printing a Texinfo file
791 @section How do I print a Texinfo file?
792 @cindex Printing a Texinfo file
793 @cindex Texinfo file, printing
794 @cindex Printing documentation
796 You can't get nicely printed output from Info files; you must still have
797 the original Texinfo source file for the manual you want to print.
799 Assuming you have @TeX{} installed on your system, follow these steps:
804 Make sure the first line of the Texinfo file looks like this:
810 You may need to change @samp{texinfo} to the full pathname of the
811 @file{texinfo.tex} file, which comes with Emacs as
812 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
815 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
816 the name of the Texinfo source file for which you want to produce a
817 printed copy. The @samp{texi2dvi} script is part of the GNU Texinfo
820 Alternatively, @samp{texi2pdf} produces PDF files.
823 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
824 printing DVI files at your site. For example, if you have a PostScript
825 printer, run the @code{dvips} program to print the DVI file on that
830 To get more general instructions, retrieve the latest Texinfo package
831 (@pxref{Installing Texinfo documentation}).
833 @node Viewing Info files outside of Emacs
834 @section Can I view Info files without using Emacs?
835 @cindex Viewing Info files
836 @cindex Info file viewers
837 @cindex Alternative Info file viewers
839 Yes. Here are some alternative programs:
844 @code{info}, a stand-alone version of the Info program, comes as part of
845 the Texinfo package. @xref{Installing Texinfo documentation}, for
849 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
850 You can get Tkinfo at
851 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
855 @node Informational files for Emacs
856 @section What informational files are available for Emacs?
857 @cindex Informational files included with Emacs
858 @cindex Files included with Emacs
859 @cindex @file{COPYING}, description of file
860 @cindex @file{DISTRIB}, description of file
861 @cindex @file{GNU}, description of file
862 @cindex @file{INTERVIEW}, description of file
863 @cindex @file{MACHINES}, description of file
864 @cindex @file{MAILINGLISTS}, description of file
865 @cindex @file{NEWS}, description of file
867 This isn't a frequently asked question, but it should be! A variety of
868 informational files about Emacs and relevant aspects of the GNU project
869 are available for you to read.
871 The following files (and others) are available in the @file{etc}
872 directory of the Emacs distribution (see @ref{File-name conventions}, if
873 you're not sure where that is). Many of these files are available via
874 the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
880 GNU General Public License
883 Emacs Availability Information
889 Richard Stallman discusses his public-domain UNIX-compatible software
890 system with BYTE editors
893 Status of Emacs on Various Machines and Systems
896 GNU Project Electronic Mailing Lists
899 Emacs news, a history of recent user-visible changes
903 More GNU information, including back issues of the @cite{GNU's
906 @uref{http://www.gnu.org/bulletins/bulletins.html} and
908 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
910 @node Help installing Emacs
911 @section Where can I get help in installing Emacs?
912 @cindex Installation help
913 @cindex Help installing Emacs
915 @xref{Installing Emacs}, for some basic installation hints, and see
916 @ref{Problems building Emacs}, if you have problems with the installation.
918 @uref{http://www.fsf.org/resources/service/, The GNU Service directory}
919 lists companies and individuals willing to sell you help in installing
920 or using Emacs and other GNU software.
922 @node Obtaining the FAQ
923 @section Where can I get the latest version of this FAQ?
924 @cindex FAQ, obtaining the
925 @cindex Latest FAQ version, obtaining the
927 The Emacs FAQ is distributed with Emacs in Info format. You can read it
928 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
929 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
930 C-f} (@kbd{M-x view-emacs-FAQ}). The very latest version is available
931 in the Emacs development repository (@pxref{Latest version of Emacs}).
933 @c ------------------------------------------------------------
934 @node Status of Emacs
935 @chapter Status of Emacs
936 @cindex Status of Emacs
938 This chapter gives you basic information about Emacs, including the
939 status of its latest version.
942 * Origin of the term Emacs::
943 * Latest version of Emacs::
951 @node Origin of the term Emacs
952 @section Where does the name ``Emacs'' come from?
953 @cindex Origin of the term ``Emacs''
954 @cindex Emacs name origin
956 @cindex Original version of Emacs
958 Emacs originally was an acronym for Editor MACroS. RMS says he ``picked
959 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
960 the time.'' The first Emacs was a set of macros written in 1976 at MIT
961 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
962 Editor and COrrector) under ITS (the Incompatible Timesharing System) on
963 a PDP-10. RMS had already extended TECO with a ``real-time''
964 full-screen mode with reprogrammable keys. Emacs was started by
965 @email{gls@@east.sun.com, Guy Steele} as a project to unify the many
966 divergent TECO command sets and key bindings at MIT, and completed by
969 Many people have said that TECO code looks a lot like line noise; you
970 can read more at @uref{news:alt.lang.teco}. Someone has written a TECO
971 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
972 come with Emacs}); it would be an interesting project to run the
973 original TECO Emacs inside of Emacs.
976 For some not-so-serious alternative reasons for Emacs to have that
977 name, check out the file @file{etc/JOKES} (@pxref{File-name
980 @node Latest version of Emacs
981 @section What is the latest version of Emacs?
982 @cindex Version, latest
983 @cindex Latest version of Emacs
984 @cindex Development, Emacs
985 @cindex Repository, Emacs
986 @cindex Bazaar repository, Emacs
988 Emacs @value{EMACSVER} is the current version as of this writing. A version
989 number with two components (e.g. @samp{22.1}) indicates a released
990 version; three components indicate a development
991 version (e.g. @samp{23.0.50} is what will eventually become @samp{23.1}).
993 Emacs is under active development, hosted at
994 @uref{http://savannah.gnu.org/projects/emacs/, Savannah}. The source
995 code can be retrieved anonymously following the
996 @uref{http://savannah.gnu.org/bzr/?group=emacs, instructions}.
997 The repository is GNU Bazaar.
999 Because Emacs undergoes many changes before a release, the version
1000 number of a development version is not especially meaningful. It is
1001 better to refer to the date on which the sources were retrieved from the
1002 development repository. The development version is usually quite robust
1003 for every-day use, but if stability is more important to you than the
1004 latest features, you may want to stick to the releases.
1006 The following sections list some of the major new features in the last
1007 few Emacs releases. For full details of the changes in any version of
1008 Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}). As of Emacs 22,
1009 you can give this command a prefix argument to read about which features
1010 were new in older versions.
1012 @node New in Emacs 24
1013 @section What is different about Emacs 24?
1014 @cindex Differences between Emacs 23 and Emacs 24
1015 @cindex Emacs 24, new features in
1018 @cindex packages, installing more
1020 Emacs now includes a package manager. Type @kbd{M-x list-packages} to
1021 get started. You can use this to download and automatically install
1022 many more Lisp packages.
1024 @cindex lexical binding
1026 Emacs Lisp now supports lexical binding on a per-file basis. In
1027 @emph{lexical binding}, variable references must be located textually
1028 within the binding construct. This contrasts with @emph{dynamic
1029 binding}, where programs can refer to variables defined outside their
1030 local textual scope. A Lisp file can use a local variable setting of
1031 @code{lexical-binding: t} to indicate that the contents should be
1032 interpreted using lexical binding. See the Emacs Lisp Reference
1033 Manual for more details.
1035 @cindex bidirectional display
1036 @cindex right-to-left languages
1038 Some human languages, such as English, are written from left to right.
1039 Others, such as Arabic, are written from right to left. Emacs now has
1040 support for any mixture of these forms---this is ``bidirectional text''.
1043 Handling of text selections has been improved, and now integrates
1044 better with external clipboards.
1048 A new command @kbd{customize-themes} allows you to easily change the
1049 appearance of your Emacs.
1052 Emacs can be compiled with the GTK+ 3 toolkit.
1055 Support for several new external libraries can be included at compile
1061 ``Security-Enhanced Linux'' (SELinux) is a Linux kernel feature that
1062 provides more sophisticated file access controls than ordinary
1063 ``Unix-style'' file permissions.
1066 The ImageMagick display library. This allows you to display many more
1067 image format in Emacs, as well as carry out transformations such as
1071 The GnuTLS library for secure network communications. Emacs uses this
1072 transparently for email if your mail server supports it.
1075 The libxml2 library for parsing XML structures.
1079 Much more flexibility in the handling of windows and buffer display.
1083 As always, consult the @file{NEWS} file for more information.
1086 @node New in Emacs 23
1087 @section What is different about Emacs 23?
1088 @cindex Differences between Emacs 22 and Emacs 23
1089 @cindex Emacs 23, new features in
1093 @cindex Anti-aliased fonts
1094 @cindex Freetype fonts
1096 Emacs has a new font code that can use multiple font backends,
1097 including freetype and fontconfig. Emacs can use the Xft library for
1098 anti-aliasing, and the otf and m17n libraries for complex text layout and
1102 @cindex Character sets
1104 The Emacs character set is now a superset of Unicode. Several new
1105 language environments have been added.
1107 @cindex Multi-tty support
1108 @cindex X and tty displays
1110 Emacs now supports using both X displays and ttys in the same session
1115 Emacs can be started as a daemon in the background.
1117 @cindex NeXTstep port
1118 @cindex GNUstep port
1119 @cindex Mac OS X Cocoa
1121 There is a new NeXTstep port of Emacs. This supports GNUstep and Mac OS
1122 X (via the Cocoa libraries). The Carbon port of Emacs, which supported
1123 Mac OS X in Emacs 22, has been removed.
1125 @cindex Directory-local variables
1127 Directory-local variables can now be defined, in a similar manner to
1128 file-local variables.
1131 Transient Mark mode (@pxref{Highlighting a region}) is on by default.
1136 Other changes include: support for serial port access; D-Bus bindings; a
1137 new Visual Line mode for line-motion; improved completion; a new mode
1138 (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML
1139 mode (for editing XML documents) is included; VC has been updated for
1140 newer version control systems; etc.
1143 @node New in Emacs 22
1144 @section What is different about Emacs 22?
1145 @cindex Differences between Emacs 21 and Emacs 22
1146 @cindex Emacs 22, new features in
1149 @cindex GTK+ Toolkit
1150 @cindex Drag-and-drop
1152 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1155 @cindex Supported systems
1157 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1158 machines, as well as support for the Mac OS X and Cygwin operating
1162 The native MS-Windows, and Mac OS X builds include full support
1163 for images, toolbar, and tooltips.
1166 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1170 The maximum size of buffers is increased: on 32-bit machines, it is
1171 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above.
1174 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1178 Mouse wheel support is enabled by default.
1181 Window fringes are customizable.
1184 The mode line of the selected window is now highlighted.
1187 The minibuffer prompt is displayed in a distinct face.
1190 Abbrev definitions are read automatically at startup.
1193 Grep mode is separate from Compilation mode and has many new options and
1194 commands specific to grep.
1197 The original Emacs macro system has been replaced by the new Kmacro
1198 package, which provides many new commands and features and a simple
1199 interface that uses the function keys F3 and F4. Macros are stored in a
1200 macro ring, and can be debugged and edited interactively.
1203 The Grand Unified Debugger (GUD) can be used with a full graphical user
1204 interface to GDB; this provides many features found in traditional
1205 development environments, making it easy to manipulate breakpoints, add
1206 watch points, display the call stack, etc. Breakpoints are visually
1207 indicated in the source buffer.
1211 Many new modes and packages have been included in Emacs, such as Calc,
1212 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1213 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1214 savehist, Conf mode, Python mode, DNS mode, etc.
1216 @cindex Multilingual Environment
1218 Leim is now part of Emacs. Unicode support has been much improved, and
1219 the following input methods have been added: belarusian, bulgarian-bds,
1220 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1221 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1222 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1223 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1224 ukrainian-computer, vietnamese-telex, and welsh.
1226 The following language environments have also been added: Belarusian,
1227 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1228 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1229 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1231 @cindex Documentation
1232 @cindex Emacs Lisp Manual
1234 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1235 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1239 @node New in Emacs 21
1240 @section What is different about Emacs 21?
1241 @cindex Differences between Emacs 20 and Emacs 21
1242 @cindex Emacs 21, new features in
1244 @cindex Variable-size fonts
1245 @cindex Toolbar support
1246 Emacs 21 features a thorough rewrite of the display engine. The new
1247 display engine supports variable-size fonts, images, and can play sounds
1248 on platforms which support that. As a result, the visual appearance of
1249 Emacs, when it runs on a windowed display, is much more reminiscent of
1250 modern GUI programs, and includes 3D widgets (used for the mode line and
1251 the scroll bars), a configurable and extensible toolbar, tooltips
1252 (a.k.a.@: balloon help), and other niceties.
1254 @cindex Colors on text-only terminals
1256 In addition, Emacs 21 supports faces on text-only terminals. This means
1257 that you can now have colors when you run Emacs on a GNU/Linux console
1258 and on @code{xterm} with @kbd{emacs -nw}.
1261 @node New in Emacs 20
1262 @section What is different about Emacs 20?
1263 @cindex Differences between Emacs 19 and Emacs 20
1264 @cindex Emacs 20, new features in
1266 The differences between Emacs versions 18 and 19 were rather dramatic;
1267 the introduction of frames, faces, and colors on windowing systems was
1268 obvious to even the most casual user.
1270 There are differences between Emacs versions 19 and 20 as well, but many
1271 are more subtle or harder to find. Among the changes are the inclusion
1272 of MULE code for languages that use non-Latin characters and for mixing
1273 several languages in the same document; the ``Customize'' facility for
1274 modifying variables without having to use Lisp; and automatic conversion
1275 of files from Macintosh, Microsoft, and Unix platforms.
1277 @c ------------------------------------------------------------
1278 @node Common requests
1279 @chapter Common requests
1280 @cindex Common requests
1283 * Setting up a customization file::
1286 * Debugging a customization file::
1287 * Displaying the current line or column::
1288 * Displaying the current file name in the titlebar::
1289 * Turning on abbrevs by default::
1290 * Associating modes with files::
1291 * Highlighting a region::
1292 * Replacing highlighted text::
1293 * Controlling case sensitivity::
1294 * Working with unprintable characters::
1295 * Searching for/replacing newlines::
1296 * Yanking text in isearch::
1297 * Wrapping words automatically::
1298 * Turning on auto-fill by default::
1299 * Changing load-path::
1300 * Using an already running Emacs process::
1301 * Compiler error messages::
1302 * Indenting switch statements::
1303 * Customizing C and C++ indentation::
1304 * Horizontal scrolling::
1306 * Turning off beeping::
1307 * Turning the volume down::
1308 * Automatic indentation::
1309 * Matching parentheses::
1310 * Hiding #ifdef lines::
1311 * Repeating commands::
1312 * Valid X resources::
1313 * Evaluating Emacs Lisp code::
1314 * Changing the length of a Tab::
1315 * Inserting text at the beginning of each line::
1316 * Forcing the cursor to remain in the same column::
1317 * Forcing Emacs to iconify itself::
1318 * Using regular expressions::
1319 * Replacing text across multiple files::
1320 * Documentation for etags::
1321 * Disabling backups::
1322 * Disabling auto-save-mode::
1323 * Going to a line by number::
1324 * Modifying pull-down menus::
1325 * Deleting menus and menu options::
1326 * Turning on syntax highlighting::
1327 * Scrolling only one line::
1328 * Editing MS-DOS files::
1329 * Filling paragraphs with a single space::
1330 * Escape sequences in shell output::
1331 * Fullscreen mode on MS-Windows::
1334 @node Setting up a customization file
1335 @section How do I set up a @file{.emacs} file properly?
1336 @cindex @file{.emacs} file, setting up
1337 @cindex @file{.emacs} file, locating
1338 @cindex Init file, setting up
1339 @cindex Customization file, setting up
1341 @inforef{Init File, Init File, emacs}.
1343 In general, new Emacs users should not be provided with @file{.emacs}
1344 files, because this can cause confusing non-standard behavior. Then
1345 they send questions to @email{help-gnu-emacs@@gnu.org} asking why Emacs
1346 isn't behaving as documented.
1348 Emacs includes the Customize facility (@pxref{Using Customize}). This
1349 allows users who are unfamiliar with Emacs Lisp to modify their
1350 @file{.emacs} files in a relatively straightforward way, using menus
1351 rather than Lisp code.
1353 While Customize might indeed make it easier to configure Emacs,
1354 consider taking a bit of time to learn Emacs Lisp and modifying your
1355 @file{.emacs} directly. Simple configuration options are described
1356 rather completely in @inforef{Init File, Init File, emacs}, for users
1357 interested in performing frequently requested, basic tasks.
1359 Sometimes users are unsure as to where their @file{.emacs} file should
1360 be found. Visiting the file as @file{~/.emacs} from Emacs will find
1363 @node Using Customize
1364 @section How do I start using Customize?
1365 @cindex Customize groups
1366 @cindex Customizing variables
1367 @cindex Customizing faces
1369 The main Customize entry point is @kbd{M-x customize @key{RET}}. This
1370 command takes you to a buffer listing all the available Customize
1371 groups. From there, you can access all customizable options and faces,
1372 change their values, and save your changes to your init file.
1373 @inforef{Easy Customization, Easy Customization, emacs}.
1375 If you know the name of the group in advance (e.g. ``shell''), use
1376 @kbd{M-x customize-group @key{RET}}.
1378 If you wish to customize a single option, use @kbd{M-x customize-option
1379 @key{RET}}. This command prompts you for the name of the option to
1380 customize, with completion.
1382 @node Colors on a TTY
1383 @section How do I get colors and syntax highlighting on a TTY?
1384 @cindex Colors on a TTY
1385 @cindex Syntax highlighting on a TTY
1386 @cindex Console, colors
1388 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1389 i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when
1390 invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were
1391 supported in the MS-DOS port since Emacs 19.29.) Emacs automatically
1392 detects color support at startup and uses it if available. If you think
1393 that your terminal supports colors, but Emacs won't use them, check the
1394 @code{termcap} entry for your display type for color-related
1397 The command @kbd{M-x list-colors-display} pops up a window which
1398 exhibits all the colors Emacs knows about on the current display.
1400 Syntax highlighting is on by default since version 22.1.
1402 @node Debugging a customization file
1403 @section How do I debug a @file{.emacs} file?
1404 @cindex Debugging @file{.emacs} file
1405 @cindex @file{.emacs} debugging
1406 @cindex Init file debugging
1407 @cindex @samp{-debug-init} option
1409 Start Emacs with the @samp{-debug-init} command-line option. This
1410 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1411 file, and places you in the debugger if something goes wrong. The top
1412 line in the @file{trace-back} buffer will be the error message, and the
1413 second or third line of that buffer will display the Lisp code from your
1414 @file{.emacs} file that caused the problem.
1416 You can also evaluate an individual function or argument to a function
1417 in your @file{.emacs} file by moving the cursor to the end of the
1418 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1421 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1422 variables which you are trying to set or use.
1424 @node Displaying the current line or column
1425 @section How do I make Emacs display the current line (or column) number?
1426 @cindex @code{line-number-mode}
1427 @cindex Displaying the current line or column
1428 @cindex Line number, displaying the current
1429 @cindex Column, displaying the current
1430 @cindex @code{mode-line-format}
1432 By default, Emacs displays the current line number of the point in the
1433 mode line. You can toggle this feature off or on with the command
1434 @kbd{M-x line-number-mode}, or by setting the variable
1435 @code{line-number-mode}. Note that Emacs will not display the line
1436 number if the buffer's size in bytes is larger than the value of the
1437 variable @code{line-number-display-limit}.
1439 You can similarly display the current column with
1440 @kbd{M-x column-number-mode}, or by putting the form
1443 (setq column-number-mode t)
1447 in your @file{.emacs} file. This feature is off by default.
1449 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1450 will insert the current column's value into the mode line. See the
1451 documentation for @code{mode-line-format} (using @kbd{C-h v
1452 mode-line-format @key{RET}}) for more information on how to set and use
1455 @cindex Set number capability in @code{vi} emulators
1456 The @samp{linum} package (distributed with Emacs since version 23.1)
1457 displays line numbers in the left margin, like the ``set number''
1458 capability of @code{vi}. The packages @samp{setnu} and
1459 @samp{wb-line-number} (not distributed with Emacs) also implement this
1462 @node Displaying the current file name in the titlebar
1463 @section How can I modify the titlebar to contain the current file name?
1464 @cindex Titlebar, displaying the current file name in
1465 @cindex File name, displaying in the titlebar
1466 @cindex @code{frame-title-format}
1468 The contents of an Emacs frame's titlebar is controlled by the variable
1469 @code{frame-title-format}, which has the same structure as the variable
1470 @code{mode-line-format}. (Use @kbd{C-h v} or @kbd{M-x
1471 describe-variable} to get information about one or both of these
1474 By default, the titlebar for a frame does contain the name of the buffer
1475 currently being visited, except if there is a single frame. In such a
1476 case, the titlebar contains Emacs invocation name and the name of the
1477 machine at which Emacs was invoked. This is done by setting
1478 @code{frame-title-format} to the default value of
1481 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1484 To modify the behavior such that frame titlebars contain the buffer's
1485 name regardless of the number of existing frames, include the following
1486 in your @file{.emacs}:
1489 (setq frame-title-format "%b")
1492 @node Turning on abbrevs by default
1493 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1494 @cindex Abbrevs, turning on by default
1496 Abbrev mode expands abbreviations as you type them. To turn it on in a
1497 specific buffer, use @kbd{M-x abbrev-mode}. To turn it on in every
1498 buffer by default, put this in your @file{.emacs} file:
1501 (setq-default abbrev-mode t)
1504 @noindent To turn it on in a specific mode, use:
1507 (add-hook '@var{mymode}-mode-hook
1509 (setq abbrev-mode t)))
1512 @noindent If your Emacs version is older then 22.1, you will also need to use:
1516 (quietly-read-abbrev-file)
1520 @node Associating modes with files
1521 @section How do I make Emacs use a certain major mode for certain files?
1522 @cindex Associating modes with files
1523 @cindex File extensions and modes
1524 @cindex @code{auto-mode-alist}, modifying
1525 @cindex Modes, associating with file extensions
1527 If you want to use a certain mode @var{foo} for all files whose names end
1528 with the extension @file{.@var{bar}}, this will do it for you:
1531 (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode))
1534 Alternatively, put this somewhere in the first line of any file you want to
1535 edit in the mode @var{foo} (in the second line, if the first line begins
1542 @cindex Major mode for shell scripts
1543 The variable @code{interpreter-mode-alist} specifies which mode to use
1544 when loading an interpreted script (e.g. shell, python, etc.). Emacs
1545 determines which interpreter you're using by examining the first line of
1546 the script. Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
1547 @code{interpreter-mode-alist} to learn more.
1549 @node Highlighting a region
1550 @section How can I highlight a region of text in Emacs?
1551 @cindex Highlighting text
1552 @cindex Text, highlighting
1553 @cindex @code{transient-mark-mode}
1554 @cindex Region, highlighting a
1556 You can cause the region to be highlighted when the mark is active by
1560 (transient-mark-mode 1)
1564 in your @file{.emacs} file. Since Emacs 23.1, this feature is on by default.
1566 @node Replacing highlighted text
1567 @section How can I replace highlighted text with what I type?
1568 @cindex @code{delete-selection-mode}
1569 @cindex Replacing highlighted text
1570 @cindex Highlighting and replacing text
1572 Use @code{delete-selection-mode}, which you can start automatically by
1573 placing the following Lisp form in your @file{.emacs} file:
1576 (delete-selection-mode 1)
1579 According to the documentation string for @code{delete-selection-mode}
1580 (which you can read using @kbd{M-x describe-function @key{RET}
1581 delete-selection-mode @key{RET}}):
1584 When Delete Selection mode is enabled, Transient Mark mode is also
1585 enabled and typed text replaces the selection if the selection is
1586 active. Otherwise, typed text is just inserted at point regardless of
1590 This mode also allows you to delete (not kill) the highlighted region by
1593 @node Controlling case sensitivity
1594 @section How do I control Emacs's case-sensitivity when searching/replacing?
1595 @cindex @code{case-fold-search}
1596 @cindex Case sensitivity of searches
1597 @cindex Searching without case sensitivity
1598 @cindex Ignoring case in searches
1601 The value of the variable @code{case-fold-search} determines whether
1602 searches are case sensitive:
1605 (setq case-fold-search nil) ; make searches case sensitive
1606 (setq case-fold-search t) ; make searches case insensitive
1609 @cindex Case sensitivity in replacements
1610 @cindex Replacing, and case sensitivity
1611 @cindex @code{case-replace}
1612 Similarly, for replacing, the variable @code{case-replace} determines
1613 whether replacements preserve case.
1615 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1617 To change the case sensitivity just for one major mode, use the major
1618 mode's hook. For example:
1621 (add-hook '@var{foo}-mode-hook
1623 (setq case-fold-search nil)))
1626 @node Working with unprintable characters
1627 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1628 @cindex Unprintable characters, working with
1629 @cindex Working with unprintable characters
1630 @cindex Control characters, working with
1631 @cindex Eight-bit characters, working with
1632 @cindex Searching for unprintable characters
1633 @cindex Regexps and unprintable characters
1635 To search for a single character that appears in the buffer as, for
1636 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.
1637 Searching for @strong{all} unprintable characters is best done with a
1638 regular expression (@dfn{regexp}) search. The easiest regexp to use for
1639 the unprintable chars is the complement of the regexp for the printable
1645 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1648 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1652 To type these special characters in an interactive argument to
1653 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1654 use @kbd{C-q}. (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1655 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.) So,
1656 to search for unprintable characters using @code{re-search-forward}:
1658 @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}}
1660 Using @code{isearch-forward-regexp}:
1662 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1664 To delete all unprintable characters, simply use replace-regexp:
1666 @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}}
1668 Replacing is similar to the above. To replace all unprintable
1669 characters with a colon, use:
1671 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}
1673 @node Searching for/replacing newlines
1674 @section How do I input a newline character in isearch or query-replace?
1675 @cindex Searching for newlines
1676 @cindex Replacing newlines
1678 Use @kbd{C-q C-j}. For more information, see @inforef{Special Isearch,
1679 Special Input for Incremental Search, emacs}.
1682 @node Yanking text in isearch
1683 @section How do I copy text from the kill ring into the search string?
1684 @cindex Yanking text into the search string
1685 @cindex isearch yanking
1687 Use @kbd{M-y}. @inforef{Isearch Yank, Isearch Yanking, emacs}.
1689 @node Wrapping words automatically
1690 @section How do I make Emacs wrap words for me?
1691 @cindex Wrapping word automatically
1692 @cindex Wrapping lines
1694 @cindex @code{auto-fill-mode}, introduction to
1695 @cindex Maximum line width, default value
1696 @cindex @code{fill-column}, default value
1698 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1699 The default maximum line width is 70, determined by the variable
1700 @code{fill-column}. To learn how to turn this on automatically, see
1701 @ref{Turning on auto-fill by default}.
1703 @node Turning on auto-fill by default
1704 @section How do I turn on @code{auto-fill-mode} by default?
1705 @cindex @code{auto-fill-mode}, activating automatically
1706 @cindex Filling automatically
1707 @cindex Automatic entry to @code{auto-fill-mode}
1709 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1712 To turn it on for every buffer in a certain mode, you must use the hook
1713 for that mode. For example, to turn on @code{auto-fill} mode for all
1714 text buffers, including the following in your @file{.emacs} file:
1717 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1720 If you want @code{auto-fill} mode on in all major modes, do this:
1723 (setq-default auto-fill-function 'do-auto-fill)
1726 @node Changing load-path
1727 @section How do I change @code{load-path}?
1728 @cindex @code{load-path}, modifying
1729 @cindex Modifying @code{load-path}
1730 @cindex Adding to @code{load-path}
1732 In general, you should only add to the @code{load-path}. You can add
1733 directory @var{/dir/subdir} to the load path like this:
1736 (add-to-list 'load-path "/dir/subdir/")
1739 To do this relative to your home directory:
1742 (add-to-list 'load-path "~/mysubdir/")
1745 @node Using an already running Emacs process
1746 @section How do I use an already running Emacs from another window?
1747 @cindex @code{emacsclient}
1748 @cindex Emacs server functions
1749 @cindex Using an existing Emacs process
1751 @code{emacsclient}, which comes with Emacs, is for editing a file using
1752 an already running Emacs rather than starting up a new Emacs. It does
1753 this by sending a request to the already running Emacs, which must be
1754 expecting the request.
1761 Emacs must have executed the @code{server-start} function for
1762 @samp{emacsclient} to work. This can be done either by a command line
1766 emacs -f server-start
1769 or by invoking @code{server-start} from @file{.emacs}:
1772 (if (@var{some conditions are met}) (server-start))
1775 When this is done, Emacs creates a Unix domain socket named
1776 @file{server} in @file{/tmp/emacs@var{userid}}. See
1777 @code{server-socket-dir}.
1779 To get your news reader, mail reader, etc., to invoke
1780 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1781 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}. You may
1782 have to specify the full pathname of the @samp{emacsclient} program
1787 setenv EDITOR emacsclient
1789 # using full pathname
1790 setenv EDITOR /usr/local/emacs/etc/emacsclient
1793 EDITOR=emacsclient ; export EDITOR
1799 When @samp{emacsclient} is run, it connects to the socket and passes its
1800 command line options to Emacs, which at the next opportunity will visit
1801 the files specified. (Line numbers can be specified just like with
1802 Emacs.) The user will have to switch to the Emacs window by hand. When
1803 the user is done editing a file, the user can type @kbd{C-x #} (or
1804 @kbd{M-x server-edit}) to indicate this. If there is another buffer
1805 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1806 @code{emacsclient} will exit, signaling the calling program to continue.
1808 @cindex @code{gnuserv}
1809 There is an alternative version of @samp{emacsclient} called
1810 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman}
1811 (@pxref{Packages that do not come with Emacs}). @samp{gnuserv} uses
1812 Internet domain sockets, so it can work across most network connections.
1814 The most recent @samp{gnuserv} package is available at
1816 @uref{http://meltin.net/hacks/emacs/}
1820 @node Compiler error messages
1821 @section How do I make Emacs recognize my compiler's funny error messages?
1822 @cindex Compiler error messages, recognizing
1823 @cindex Recognizing non-standard compiler errors
1824 @cindex Regexps for recognizing compiler errors
1825 @cindex Errors, recognizing compiler
1827 Customize the @code{compilation-error-regexp-alist} variable.
1829 @node Indenting switch statements
1830 @section How do I change the indentation for @code{switch}?
1831 @cindex @code{switch}, indenting
1832 @cindex Indenting of @code{switch}
1834 Many people want to indent their @code{switch} statements like this:
1852 @noindent To achieve this, add the following line to your @file{.emacs}:
1855 (c-set-offset 'case-label '+)
1858 @node Customizing C and C++ indentation
1859 @section How to customize indentation in C, C@t{++}, and Java buffers?
1860 @cindex Indentation, how to customize
1861 @cindex Customize indentation
1863 The Emacs @code{cc-mode} features an interactive procedure for
1864 customizing the indentation style, which is fully explained in the
1865 @cite{CC Mode} manual that is part of the Emacs distribution, see
1866 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1867 The CC Mode Manual}. Here's a short summary of the procedure:
1871 Go to the beginning of the first line where you don't like the
1872 indentation and type @kbd{C-c C-o}. Emacs will prompt you for the
1873 syntactic symbol; type @key{RET} to accept the default it suggests.
1876 Emacs now prompts for the offset of this syntactic symbol, showing the
1877 default (the current definition) inside parentheses. You can choose
1882 No extra indentation.
1884 Indent one basic offset.
1886 Outdent one basic offset.
1888 Indent two basic offsets
1890 Outdent two basic offsets.
1892 Indent half basic offset.
1894 Outdent half basic offset.
1898 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1899 the line or the block according to what you just specified.
1902 If you don't like the result, go back to step 1. Otherwise, add the
1903 following line to your @file{.emacs}:
1906 (c-set-offset '@var{syntactic-symbol} @var{offset})
1910 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1911 when you type @kbd{C-c C-o} at the beginning of the line, and
1912 @var{offset} is one of the indentation symbols listed above (@code{+},
1913 @code{/}, @code{0}, etc.) that you've chosen during the interactive
1917 Go to the next line whose indentation is not to your liking and repeat
1921 It is recommended to put all the resulting @code{(c-set-offset ...)}
1922 customizations inside a C mode hook, like this:
1925 (defun my-c-mode-hook ()
1928 (add-hook 'c-mode-hook 'my-c-mode-hook)
1932 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1933 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1934 might be unavailable when @code{cc-mode} is not loaded.
1936 Note that @code{c-mode-hook} runs for C source files only; use
1937 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1938 Java sources, etc. If you want the same customizations to be in
1939 effect in @emph{all} languages supported by @code{cc-mode}, use
1940 @code{c-mode-common-hook}.
1942 @node Horizontal scrolling
1943 @section How can I make Emacs automatically scroll horizontally?
1944 @cindex @code{hscroll-mode}
1945 @cindex Horizontal scrolling
1946 @cindex Scrolling horizontally
1948 In Emacs 21 and later, this is on by default: if the variable
1949 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1950 automatically scrolls the display horizontally when point moves off the
1951 left or right edge of the window.
1953 Note that this is overridden by the variable
1954 @code{truncate-partial-width-windows} if that variable is non-nil
1955 and the current buffer is not full-frame width.
1957 In Emacs 20, use @code{hscroll-mode}.
1959 @node Overwrite mode
1960 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
1961 @cindex @key{Insert}
1962 @cindex @code{overwrite-mode}
1963 @cindex Overwriting existing text
1964 @cindex Toggling @code{overwrite-mode}
1966 @kbd{M-x overwrite-mode} (a minor mode). This toggles
1967 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1968 is as easy as another @kbd{M-x overwrite-mode}.
1970 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1972 @node Turning off beeping
1973 @section How do I stop Emacs from beeping on a terminal?
1974 @cindex Beeping, turning off
1975 @cindex Visible bell
1976 @cindex Bell, visible
1978 @email{martin@@cc.gatech.edu, Martin R. Frank} writes:
1980 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1981 and set the visible bell to nothing.
1983 That is, put the following in your @code{TERMCAP} environment variable
1984 (assuming you have one):
1990 And evaluate the following Lisp form:
1993 (setq visible-bell t)
1996 @node Turning the volume down
1997 @section How do I turn down the bell volume in Emacs running under X?
1998 @cindex Bell, volume of
1999 @cindex Volume of bell
2001 On X Window system, you can adjust the bell volume and duration for all
2002 programs with the shell command @code{xset}.
2004 Invoking @code{xset} without any arguments produces some basic
2005 information, including the following:
2008 usage: xset [-display host:dpy] option ...
2011 To set bell volume, pitch and duration:
2012 b [vol [pitch [dur]]] b on
2015 @node Automatic indentation
2016 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
2017 @cindex Indenting new lines
2018 @cindex New lines, indenting of
2019 @cindex Previous line, indenting according to
2020 @cindex Text indentation
2022 Such behavior is automatic (in Text mode) in Emacs 20 and later. From the
2023 @file{etc/NEWS} file for Emacs 20.2:
2026 ** In Text mode, now only blank lines separate paragraphs. This makes
2027 it possible to get the full benefit of Adaptive Fill mode in Text mode,
2028 and other modes derived from it (such as Mail mode). @key{TAB} in Text
2029 mode now runs the command @code{indent-relative}; this makes a practical
2030 difference only when you use indented paragraphs.
2032 If you want spaces at the beginning of a line to start a paragraph, use
2033 the new mode, Paragraph Indent Text mode.
2036 @cindex Prefixing lines
2038 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
2039 by default}), you can tell Emacs to prefix every line with a certain
2040 character sequence, the @dfn{fill prefix}. Type the prefix at the
2041 beginning of a line, position point after it, and then type @kbd{C-x .}
2042 (@code{set-fill-prefix}) to set the fill prefix. Thereafter,
2043 auto-filling will automatically put the fill prefix at the beginning of
2044 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
2045 prefix when refilling the paragraph.
2047 If you have paragraphs with different levels of indentation, you will
2048 have to set the fill prefix to the correct value each time you move to a
2049 new paragraph. There are many packages available to deal with this
2050 (@pxref{Packages that do not come with Emacs}). Look for ``fill'' and
2051 ``indent'' keywords for guidance.
2053 @node Matching parentheses
2054 @section How do I show which parenthesis matches the one I'm looking at?
2055 @cindex Parentheses, matching
2056 @cindex @file{paren.el}
2057 @cindex Highlighting matching parentheses
2058 @cindex Pairs of parentheses, highlighting
2059 @cindex Matching parentheses
2061 Call @code{show-paren-mode} in your @file{.emacs} file:
2067 You can also enable this mode by selecting the @samp{Paren Match
2068 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
2069 at the top of any Emacs frame.
2071 Alternatives to this mode include:
2076 If you're looking at a right parenthesis (or brace or bracket) you can
2077 delete it and reinsert it. Emacs will momentarily move the cursor to
2078 the matching parenthesis.
2081 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2082 will skip over one set of balanced parentheses, so you can see which
2083 parentheses match. (You can train it to skip over balanced brackets
2084 and braces at the same time by modifying the syntax table.)
2086 @cindex Show matching paren as in @code{vi}
2088 Here is some Emacs Lisp that will make the @key{%} key show the matching
2089 parenthesis, like in @code{vi}. In addition, if the cursor isn't over a
2090 parenthesis, it simply inserts a % like normal.
2093 ;; By an unknown contributor
2095 (global-set-key "%" 'match-paren)
2097 (defun match-paren (arg)
2098 "Go to the matching paren if on a paren; otherwise insert %."
2100 (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2101 ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2102 (t (self-insert-command (or arg 1)))))
2107 @node Hiding #ifdef lines
2108 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2109 @cindex @code{#ifdef}, selective display of
2110 @cindex @code{hide-ifdef-mode}
2111 @cindex Hiding @code{#ifdef} text
2112 @cindex Selectively displaying @code{#ifdef} code
2114 @kbd{M-x hide-ifdef-mode}. (This is a minor mode.) You might also want
2115 to investigate @file{cpp.el}, which is distributed with Emacs.
2117 @node Repeating commands
2118 @section How do I repeat a command as many times as possible?
2119 @cindex Repeating commands many times
2120 @cindex Commands, repeating many times
2121 @cindex @code{.}, equivalent to @code{vi} command
2123 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2124 that repeats the last command. If you preface it with a prefix
2125 argument, the prefix arg is applied to the command.
2127 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2128 (@code{repeat-complex-command}) to reinvoke commands that used the
2129 minibuffer to get arguments. In @code{repeat-complex-command} you can
2130 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2131 keyboard has these keys) to scan through all the different complex
2132 commands you've typed.
2134 To repeat a set of commands, use keyboard macros. Use @kbd{C-x (} and
2135 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2136 type @kbd{C-x e}. (@inforef{Keyboard Macros, Keyboard Macros, emacs}.)
2138 If you're really desperate for the @code{.} command in @code{vi} that
2139 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2140 mode which comes with Emacs, and which appears to support it.
2142 @node Valid X resources
2143 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2144 @cindex Resources, X
2146 @cindex Setting X resources
2148 @inforef{X Resources, X Resources, emacs}.
2150 You can also use a resource editor, such as editres (for X11R5 and
2151 onwards), to look at the resource names for the menu bar, assuming Emacs
2152 was compiled with the X toolkit.
2154 @node Evaluating Emacs Lisp code
2155 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2156 @cindex Evaluating Lisp code
2157 @cindex Lisp forms, evaluating
2159 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2160 Emacs Lisp @dfn{form}:
2165 If you want it evaluated every time you run Emacs, put it in a file
2166 named @file{.emacs} in your home directory. This is known as ``your
2167 @file{.emacs} file,'' and contains all of your personal customizations.
2170 You can type the form in the @file{*scratch*} buffer, and then type
2171 @key{LFD} (or @kbd{C-j}) after it. The result of evaluating the form
2172 will be inserted in the buffer.
2175 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2176 before or around point.
2179 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2180 before point and prints its value in the echo area.
2183 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2184 form in the minibuffer which will be evaluated once you press @key{RET}.
2187 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2188 forms in a file. (To do this from Lisp use the function @code{load}
2191 The functions @code{load-library}, @code{eval-region},
2192 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2193 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2198 @node Changing the length of a Tab
2199 @section How do I change Emacs's idea of the @key{TAB} character's length?
2201 @cindex Length of tab character
2203 Set the default value of the variable @code{tab-width}. For example, to set
2204 @key{TAB} stops every 10 characters, insert the following in your
2208 (setq-default tab-width 10)
2211 Do not confuse variable @code{tab-width} with variable
2212 @code{tab-stop-list}. The former is used for the display of literal
2213 @key{TAB} characters. The latter controls what characters are inserted
2214 when you press the @key{TAB} character in certain modes.
2216 @node Inserting text at the beginning of each line
2217 @section How do I insert <some text> at the beginning of every line?
2218 @cindex Prefixing a region with some text
2219 @cindex Prefix character, inserting in mail/news replies
2220 @cindex Replies to mail/news, inserting a prefix character
2221 @cindex @code{mail-yank-prefix}
2222 @cindex Mail replies, inserting a prefix character
2223 @cindex News replies, inserting a prefix character
2225 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2226 @key{RET} ^ @key{RET} your text @key{RET}}.
2228 To do this to a region, use @code{string-insert-rectangle}.
2229 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2230 want to prefix, move the cursor to last line to be prefixed, and type
2231 @kbd{M-x string-insert-rectangle @key{RET}}. To do this for the whole
2232 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2234 If you are trying to prefix a yanked mail message with @samp{>}, you
2235 might want to set the variable @code{mail-yank-prefix}. In Message
2236 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2237 runs the function @code{comment-region}, it is a general-purpose
2238 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2240 @node Forcing the cursor to remain in the same column
2241 @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?
2242 @cindex @code{picture-mode}
2243 @cindex Remaining in the same column, regardless of contents
2244 @cindex Vertical movement in empty documents
2246 Use @kbd{M-x picture-mode}.
2248 See also the variable @code{track-eol} and the command
2249 @code{set-goal-column} bound to @kbd{C-x C-n}
2250 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2252 @node Forcing Emacs to iconify itself
2253 @section How do I tell Emacs to iconify itself?
2254 @cindex Iconification under the X Window System
2255 @cindex X Window System and iconification
2256 @cindex Suspending Emacs
2258 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2259 otherwise. @inforef{Frame Commands, Frame Commands, emacs}.
2261 @node Using regular expressions
2262 @section How do I use regexps (regular expressions) in Emacs?
2264 @cindex Regular expressions
2265 @cindex Differences between Unix and Emacs regexps
2266 @cindex Unix regexps, differences from Emacs
2267 @cindex Text strings, putting regexps in
2269 @inforef{Regexp Backslash, Regexp Backslash, emacs}.
2271 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2272 are @samp{\(} and @samp{\)}. Also, the string syntax for a backslash is
2273 @samp{\\}. To specify a regular expression like @samp{xxx\(foo\|bar\)}
2274 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2276 Note the doubled backslashes!
2281 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2282 (@samp{[^...]}) can match a newline character (@key{LFD} a.k.a.@:
2283 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2284 characters not to match.
2287 The character syntax regexps (e.g., @samp{\sw}) are not
2288 meaningful inside character set regexps (e.g., @samp{[aeiou]}). (This
2289 is actually typical for regexp syntax.)
2293 @node Replacing text across multiple files
2294 @section How do I perform a replace operation across more than one file?
2295 @cindex Replacing strings across files
2296 @cindex Multiple files, replacing across
2297 @cindex Files, replacing strings across multiple
2298 @cindex Recursive search/replace operations
2300 Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the
2301 command @code{dired-do-query-replace-regexp} (@kbd{Q}), which allows
2302 users to replace regular expressions in multiple files.
2304 You can use this command to perform search/replace operations on
2305 multiple files by following the following steps:
2309 Assemble a list of files you want to operate on with either
2310 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2313 Mark all files in the resulting Dired buffer using @kbd{t}.
2316 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2320 To accept all replacements in each file, hit @kbd{!}.
2323 Another way to do the same thing is to use the ``tags'' feature of
2324 Emacs: it includes the command @code{tags-query-replace} which performs
2325 a query-replace across all the files mentioned in the @file{TAGS} file.
2326 @inforef{Tags Search, Tags Search, emacs}.
2328 @node Documentation for etags
2329 @section Where is the documentation for @code{etags}?
2330 @cindex Documentation for @code{etags}
2331 @cindex @code{etags}, documentation for
2333 The @code{etags} man page should be in the same place as the
2334 @code{emacs} man page.
2336 Quick command-line switch descriptions are also available. For example,
2339 @node Disabling backups
2340 @section How do I disable backup files?
2341 @cindex Backups, disabling
2342 @cindex Disabling backups
2344 You probably don't want to do this, since backups are useful, especially
2345 when something goes wrong.
2347 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2348 load @code{dired-x} by adding the following to your @file{.emacs} file:
2351 (add-hook 'dired-load-hook
2353 (require 'dired-x)))
2356 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2357 You can make omitting the default for new dired buffers by putting the
2358 following in your @file{.emacs}:
2361 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2364 If you're tired of seeing backup files whenever you do an @samp{ls} at
2365 the Unix shell, try GNU @code{ls} with the @samp{-B} option. GNU
2366 @code{ls} is part of the GNU Fileutils package, available from
2367 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2369 To disable or change the way backups are made, @inforef{Backup Names, ,
2372 @cindex Backup files in a single directory
2373 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2374 by customizing the variable @code{backup-directory-alist}. This
2375 variable's value specifies that files whose names match specific patters
2376 should have their backups put in certain directories. A typical use is
2377 to add the element @code{("." . @var{dir})} to force Emacs to put
2378 @strong{all} backup files in the directory @file{dir}.
2380 @node Disabling auto-save-mode
2381 @section How do I disable @code{auto-save-mode}?
2382 @cindex Disabling @code{auto-save-mode}
2384 @cindex Saving at frequent intervals
2386 You probably don't want to do this, since auto-saving is useful,
2387 especially when Emacs or your computer crashes while you are editing a
2390 Instead, you might want to change the variable
2391 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2392 waits before auto-saving. Increasing this value forces Emacs to wait
2393 longer between auto-saves, which might annoy you less.
2395 You might also want to look into Sebastian Kremer's @code{auto-save}
2396 package (@pxref{Packages that do not come with Emacs}). This
2397 package also allows you to place all auto-save files in one directory,
2398 such as @file{/tmp}.
2400 To disable or change how @code{auto-save-mode} works, @inforef{Auto
2403 @node Going to a line by number
2404 @section How can I go to a certain line given its number?
2405 @cindex Going to a line by number
2406 @cindex Compilation error messages
2407 @cindex Recompilation
2409 Are you sure you indeed need to go to a line by its number? Perhaps all
2410 you want is to display a line in your source file for which a compiler
2411 printed an error message? If so, compiling from within Emacs using the
2412 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2413 effective way of doing that. Emacs automatically intercepts the compile
2414 error messages, inserts them into a special buffer called
2415 @code{*compilation*}, and lets you visit the locus of each message in
2416 the source. Type @kbd{C-x `} to step through the offending lines one by
2417 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2418 @kbd{M-g M-n} to go to the previous and next matches directly). Click
2419 @kbd{Mouse-2} or press @key{RET} on a message text in the
2420 @code{*compilation*} buffer to go to the line whose number is mentioned
2423 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2424 (which is the default binding of the @code{goto-line} function starting
2425 with Emacs 22). Emacs will prompt you for the number of the line and go
2428 You can do this faster by invoking @code{goto-line} with a numeric
2429 argument that is the line's number. For example, @kbd{C-u 286 M-g M-g}
2430 will jump to line number 286 in the current buffer.
2432 @node Modifying pull-down menus
2433 @section How can I create or modify new pull-down menu options?
2434 @cindex Pull-down menus, creating or modifying
2435 @cindex Menus, creating or modifying
2436 @cindex Creating new menu options
2437 @cindex Modifying pull-down menus
2438 @cindex Menus and keymaps
2439 @cindex Keymaps and menus
2441 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2442 represents a local or global keymap. Selecting a menu title with the
2443 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2445 So to add a menu option to an existing menu, all you have to do is add a
2446 new definition to the appropriate keymap. Adding a @samp{Forward Word}
2447 item to the @samp{Edit} menu thus requires the following Lisp code:
2450 (define-key global-map
2451 [menu-bar edit forward]
2452 '("Forward word" . forward-word))
2456 The first line adds the entry to the global keymap, which includes
2457 global menu bar entries. Replacing the reference to @code{global-map}
2458 with a local keymap would add this menu option only within a particular
2461 The second line describes the path from the menu-bar to the new entry.
2462 Placing this menu entry underneath the @samp{File} menu would mean
2463 changing the word @code{edit} in the second line to @code{file}.
2465 The third line is a cons cell whose first element is the title that will
2466 be displayed, and whose second element is the function that will be
2467 called when that menu option is invoked.
2469 To add a new menu, rather than a new option to an existing menu, we must
2470 define an entirely new keymap:
2473 (define-key global-map [menu-bar words]
2474 (cons "Words" (make-sparse-keymap "Words")))
2477 The above code creates a new sparse keymap, gives it the name
2478 @samp{Words}, and attaches it to the global menu bar. Adding the
2479 @samp{Forward Word} item to this new menu would thus require the
2483 (define-key global-map
2484 [menu-bar words forward]
2485 '("Forward word" . forward-word))
2489 Note that because of the way keymaps work, menu options are displayed
2490 with the more recently defined items at the top. Thus if you were to
2491 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2492 order), the menu option @samp{baz} would appear at the top, and
2493 @samp{foo} would be at the bottom.
2495 One way to avoid this problem is to use the function @code{define-key-after},
2496 which works the same as @code{define-key}, but lets you modify where items
2497 appear. The following Lisp code would insert the @samp{Forward Word}
2498 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2502 (lookup-key global-map [menu-bar edit])
2504 '("Forward word" . forward-word)
2508 Note how the second and third arguments to @code{define-key-after} are
2509 different from those of @code{define-key}, and that we have added a new
2510 (final) argument, the function after which our new key should be
2513 To move a menu option from one position to another, simply evaluate
2514 @code{define-key-after} with the appropriate final argument.
2516 More detailed information---and more examples of how to create and
2517 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2518 ``Menu Keymaps.'' (@xref{Emacs Lisp documentation}, for information on
2521 @node Deleting menus and menu options
2522 @section How do I delete menus and menu options?
2523 @cindex Deleting menus and menu options
2524 @cindex Menus, deleting
2526 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2527 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2531 (define-key global-map [menu-bar words] nil)
2534 Similarly, removing a menu option requires redefining a keymap entry to
2535 @code{nil}. For example, to delete the @samp{Forward word} menu option
2536 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2540 (define-key global-map [menu-bar edit forward] nil)
2543 @node Turning on syntax highlighting
2544 @section How do I turn on syntax highlighting?
2545 @cindex Syntax highlighting
2546 @cindex @code{font-lock-mode}
2547 @cindex Highlighting based on syntax
2548 @cindex Colorizing text
2549 @cindex FAQ, @code{font-lock-mode}
2551 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2552 highlighting in the current buffer. It is enabled by default in Emacs
2555 With @code{font-lock-mode} turned on, different types of text will
2556 appear in different colors. For instance, in a programming mode,
2557 variables will appear in one face, keywords in a second, and comments in
2560 To turn @code{font-lock-mode} off within an existing buffer, use
2561 @kbd{M-x font-lock-mode @key{RET}}.
2563 In Emacs 21 and earlier versions, you could use the following code in
2564 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2567 (global-font-lock-mode 1)
2570 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2571 and cause an annoying delay in display, so several features exist to
2574 @cindex Just-In-Time syntax highlighting
2575 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2576 activates the new @dfn{Just-In-Time fontification} provided by
2577 @code{jit-lock-mode}. @code{jit-lock-mode} defers the fontification of
2578 portions of buffer until you actually need to see them, and can also
2579 fontify while Emacs is idle. This makes display of the visible portion
2580 of a buffer almost instantaneous. For details about customizing
2581 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2583 @cindex Levels of syntax highlighting
2584 @cindex Decoration level, in @code{font-lock-mode}
2585 In versions of Emacs before 21, different levels of decoration are
2586 available, from slight to gaudy. More decoration means you need to wait
2587 more time for a buffer to be fontified (or a faster machine). To
2588 control how decorated your buffers should become, set the value of
2589 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2590 @code{nil} value indicating default (usually minimum) decoration, and a
2591 @code{t} value indicating the maximum decoration. For the gaudiest
2592 possible look, then, include the line
2595 (setq font-lock-maximum-decoration t)
2599 in your @file{.emacs} file. You can also set this variable such that
2600 different modes are highlighted in a different ways; for more
2601 information, see the documentation for
2602 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2603 describe-variable @key{RET}}).
2605 Also see the documentation for the function @code{font-lock-mode},
2606 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2607 describe-function @key{RET} font-lock-mode @key{RET}}).
2609 To print buffers with the faces (i.e., colors and fonts) intact, use
2610 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2611 ps-print-region-with-faces}. You will need a way to send text to a
2612 PostScript printer, or a PostScript interpreter such as Ghostscript;
2613 consult the documentation of the variables @code{ps-printer-name},
2614 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2616 @node Scrolling only one line
2617 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2618 @cindex Scrolling only one line
2619 @cindex Reducing the increment when scrolling
2621 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2622 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2623 to a large value like, say, 10000. For an explanation of what this
2624 means, @inforef{Auto Scrolling, Auto Scrolling, emacs}.
2626 Alternatively, use the following Lisp form in your @file{.emacs}:
2629 (setq scroll-conservatively most-positive-fixnum)
2632 @node Editing MS-DOS files
2633 @section How can I edit MS-DOS files using Emacs?
2634 @cindex Editing MS-DOS files
2635 @cindex MS-DOS files, editing
2636 @cindex Microsoft files, editing
2637 @cindex Windows files, editing
2639 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2640 performed transparently. You can open MS-DOS files on a Unix system,
2641 edit it, and save it without having to worry about the file format.
2643 When editing an MS-DOS style file, the mode line will indicate that it
2644 is a DOS file. On Unix and GNU/Linux systems, and also on a Macintosh,
2645 the string @samp{(DOS)} will appear near the left edge of the mode line;
2646 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2647 default, a backslash (@samp{\}) will appear in the mode line.
2649 @node Filling paragraphs with a single space
2650 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2651 @cindex One space following periods
2652 @cindex Single space following periods
2653 @cindex Periods, one space following
2655 Add the following line to your @file{.emacs} file:
2658 (setq sentence-end-double-space nil)
2661 @node Escape sequences in shell output
2662 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2663 @cindex Escape sequences in @code{ls} output
2664 @cindex @code{ls} in Shell mode
2666 In many systems, @code{ls} is aliased to @samp{ls --color}, which
2667 prints using ANSI color escape sequences. Emacs version 21.1 and
2668 later includes the @code{ansi-color} package, which lets Shell mode
2669 recognize these escape sequences. In Emacs 23.2 and later, the
2670 package is enabled by default; in earlier versions you can enable it
2671 by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2672 by adding @code{(add-hook 'shell-mode-hook
2673 'ansi-color-for-comint-mode-on)} to your init file.
2675 In Emacs versions before 21.1, the @code{ansi-color} package is not
2676 included. In that case, you need to unalias @code{ls} for interactive
2677 shells running in Emacs; this can be done by checking the @code{EMACS}
2678 variable in the environment.
2680 @node Fullscreen mode on MS-Windows
2681 @section How can I start Emacs in fullscreen mode on MS-Windows?
2682 @cindex Maximize frame
2683 @cindex Fullscreen mode
2685 Use the function @code{w32-send-sys-command}. For example, you can
2686 put the following in your @file{.emacs} file:
2689 (add-hook 'term-setup-hook
2690 #'(lambda () (w32-send-sys-command ?\xF030)))
2693 To avoid the slightly distracting visual effect of Emacs starting with
2694 its default frame size and then growing to fullscreen, you can add an
2695 @samp{Emacs.Geometry} entry to the Windows registry settings (see
2696 @pxref{(emacs)X Resources}).
2698 To compute the correct values for width and height, first maximize the
2699 Emacs frame and then evaluate @code{(frame-height)} and
2700 @code{(frame-width)} with @kbd{M-:}.
2702 @c ------------------------------------------------------------
2703 @node Bugs and problems
2704 @chapter Bugs and problems
2705 @cindex Bugs and problems
2707 The Emacs manual lists some common kinds of trouble users could get
2708 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2709 Emacs Manual}, so you might look there if the problem you encounter
2710 isn't described in this chapter. If you decide you've discovered a bug,
2711 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2712 instructions how to do that.
2714 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2715 known problems with building and using Emacs on specific platforms;
2716 type @kbd{C-h C-p} to read it.
2719 * Problems with very large files::
2720 * ^M in the shell buffer::
2721 * Problems with Shell Mode::
2722 * Termcap/Terminfo entries for Emacs::
2723 * Errors with init files::
2724 * Emacs ignores X resources::
2725 * Emacs ignores frame parameters::
2726 * Editing files with $ in the name::
2727 * Shell mode loses the current directory::
2728 * Security risks with Emacs::
2729 * Dired claims that no file is on this line::
2732 @node Problems with very large files
2733 @section Does Emacs have problems with files larger than 8 megabytes?
2734 @cindex Very large files, opening
2735 @cindex Large files, opening
2736 @cindex Opening very large files
2737 @cindex Maximum file size
2738 @cindex Files, maximum size
2740 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2741 files larger than 8 megabytes. In versions 19.29 and later, the maximum
2742 buffer size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes.
2743 The maximum buffer size on 32-bit machines increased to 256 MBytes in
2744 Emacs 22, and again to 512 MBytes in Emacs 23.2.
2746 Emacs compiled on a 64-bit machine can handle much larger buffers.
2748 @node ^M in the shell buffer
2749 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2750 @cindex Shell buffer, echoed commands and @samp{^M} in
2751 @cindex Echoed commands in @code{shell-mode}
2753 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2754 make them go away. If that doesn't work, you have several options:
2756 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2761 if ("$EMACS" =~ /*) then
2762 if ($?tcsh) unset edit
2768 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2775 Alternatively, use @code{csh} in your shell buffers instead of
2776 @code{tcsh}. One way is:
2779 (setq explicit-shell-file-name "/bin/csh")
2783 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2787 setenv ESHELL /bin/csh
2791 (You must start Emacs over again with the environment variable properly
2792 set for this to take effect.)
2794 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2795 with the following Lisp form,
2798 (setenv "ESHELL" "/bin/csh")
2801 The above solutions try to prevent the shell from producing the
2802 @samp{^M} characters in the first place. If this is not possible
2803 (e.g., if you use a Windows shell), you can get Emacs to remove these
2804 characters from the buffer by adding this to your @file{.emacs} init
2808 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2811 On a related note: if your shell is echoing your input line in the shell
2812 buffer, you might want to customize the @code{comint-process-echoes}
2813 variable in your shell buffers, or try the following command in your
2814 shell start-up file:
2817 stty -icrnl -onlcr -echo susp ^Z
2820 @node Problems with Shell Mode
2821 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2823 @cindex Shell Mode, problems
2824 @cindex @code{explicit-shell-file-name}
2825 This might happen because Emacs tries to look for the shell in a wrong
2826 place. If you know where your shell executable is, set the variable
2827 @code{explicit-shell-file-name} in your @file{.emacs} file to point to
2830 @cindex Antivirus programs, and Shell Mode
2831 Some people have trouble with Shell Mode on MS-Windows because of
2832 intrusive antivirus software; disabling the resident antivirus program
2833 solves the problems in those cases.
2835 @node Termcap/Terminfo entries for Emacs
2836 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2839 @cindex Emacs entries for termcap/terminfo
2841 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2842 the @samp{TERMCAP} environment variable of subshells. It may help in
2843 certain situations (e.g., using rlogin from shell buffer) to add an
2844 entry for @samp{emacs} to the system-wide termcap file. Here is a
2845 correct termcap entry for @samp{emacs}:
2851 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2852 @code{captoinfo}. You need to generate
2853 @file{/usr/lib/terminfo/e/emacs}. It may work to simply copy
2854 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2856 Having a termcap/terminfo entry will not enable the use of full screen
2857 programs in shell buffers. Use @kbd{M-x terminal-emulator} for that
2860 A workaround to the problem of missing termcap/terminfo entries is to
2861 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2862 in your shell start up file. @code{csh} users could put this in their
2863 @file{.cshrc} files:
2866 if ("$term" == emacs) set term=dumb
2869 @node Errors with init files
2870 @section Why does Emacs say @samp{Error in init file}?
2871 @cindex Error in @file{.emacs}
2872 @cindex Error in init file
2873 @cindex Init file, errors in
2874 @cindex @file{.emacs} file, errors in
2875 @cindex Debugging @file{.emacs} file
2877 An error occurred while loading either your @file{.emacs} file or the
2878 system-wide file @file{site-lisp/default.el}. Emacs 21.1 and later pops the
2879 @file{*Messages*} buffer, and puts there some additional information
2880 about the error, to provide some hints for debugging.
2882 For information on how to debug your @file{.emacs} file, see
2883 @ref{Debugging a customization file}.
2885 It may be the case that you need to load some package first, or use a
2886 hook that will be evaluated after the package is loaded. A common case
2887 of this is explained in @ref{Terminal setup code works after Emacs has
2890 @node Emacs ignores X resources
2891 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
2892 @cindex X resources being ignored
2893 @cindex Ignored X resources
2894 @cindex @file{.Xdefaults}
2896 As of version 19, Emacs searches for X resources in the files specified
2897 by the following environment variables:
2901 @item @code{XFILESEARCHPATH}
2902 @item @code{XUSERFILESEARCHPATH}
2903 @item @code{XAPPLRESDIR}
2907 This emulates the functionality provided by programs written using the
2910 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
2911 of file names separated by colons. @code{XAPPLRESDIR} should be a list
2912 of directory names separated by colons.
2914 Emacs searches for X resources:
2919 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
2922 then in the value of the @samp{XENVIRONMENT} environment variable,
2927 or if that is unset, in the file named
2928 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
2929 the name of the machine Emacs is running on),
2934 then in the screen-specific and server-wide resource properties provided
2940 or if those properties are unset, in the file named @file{~/.Xdefaults}
2946 then in the files listed in @samp{XUSERFILESEARCHPATH},
2951 or in files named @file{@var{lang}/Emacs} in directories listed in
2952 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
2953 environment variable), if the @samp{LANG} environment variable is set,
2955 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
2957 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
2960 or in @file{~/Emacs},
2965 then in the files listed in @code{XFILESEARCHPATH}.
2969 @node Emacs ignores frame parameters
2970 @section Why don't my customizations of the frame parameters work?
2971 @cindex Frame parameters
2973 This probably happens because you have set the frame parameters in the
2974 variable @code{initial-frame-alist}. That variable holds parameters
2975 used only for the first frame created when Emacs starts. To customize
2976 the parameters of all frames, change the variable
2977 @code{default-frame-alist} instead.
2979 These two variables exist because many users customize the initial frame
2980 in a special way. For example, you could determine the position and
2981 size of the initial frame, but would like to control the geometry of the
2982 other frames by individually positioning each one of them.
2985 @node Editing files with $ in the name
2986 @section How do I edit a file with a @samp{$} in its name?
2987 @cindex Editing files with @samp{$} in the name
2988 @cindex @samp{$} in file names
2989 @cindex File names containing @samp{$}, editing
2991 When entering a file name in the minibuffer, Emacs will attempt to expand
2992 a @samp{$} followed by a word as an environment variable. To suppress
2993 this behavior, type @kbd{$$} instead.
2995 @node Shell mode loses the current directory
2996 @section Why does shell mode lose track of the shell's current directory?
2997 @cindex Current directory and @code{shell-mode}
2998 @cindex @code{shell-mode} and current directory
2999 @cindex Directory, current in @code{shell-mode}
3001 Emacs has no way of knowing when the shell actually changes its
3002 directory. This is an intrinsic limitation of Unix. So it tries to
3003 guess by recognizing @samp{cd} commands. If you type @kbd{cd} followed
3004 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
3005 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
3006 correctly guess the shell's new current directory. A huge variety of
3007 fixes and enhancements to shell mode for this problem have been written
3008 to handle this problem (@pxref{Finding a package with particular
3011 You can tell Emacs the shell's current directory with the command
3014 @node Security risks with Emacs
3015 @section Are there any security risks in Emacs?
3016 @cindex Security with Emacs
3017 @cindex @samp{movemail} and security
3018 @cindex @code{file-local-variable} and security
3019 @cindex Synthetic X events and security
3020 @cindex X events and security
3025 The @file{movemail} incident. (No, this is not a risk.)
3027 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3028 chapter 4. The site at LBL had installed the @file{/etc/movemail}
3029 program setuid root. (As of version 19, @file{movemail} is in your
3030 architecture-specific directory; type @kbd{C-h v exec-directory
3031 @key{RET}} to see what it is.) Since @code{movemail} had not been
3032 designed for this situation, a security hole was created and users could
3033 get root privileges.
3035 @code{movemail} has since been changed so that this security hole will
3036 not exist, even if it is installed setuid root. However,
3037 @code{movemail} no longer needs to be installed setuid root, which
3038 should eliminate this particular risk.
3040 We have heard unverified reports that the 1988 Internet worm took
3041 advantage of this configuration problem.
3044 The @code{file-local-variable} feature. (Yes, a risk, but easy to
3047 There is an Emacs feature that allows the setting of local values for
3048 variables when editing a file by including specially formatted text near
3049 the end of the file. This feature also includes the ability to have
3050 arbitrary Emacs Lisp code evaluated when the file is visited.
3051 Obviously, there is a potential for Trojan horses to exploit this
3054 As of Emacs 22, Emacs has a list of local variables that are known to
3055 be safe to set. If a file tries to set any variable outside this
3056 list, it asks the user to confirm whether the variables should be set.
3057 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
3058 code found at the bottom of files by setting the variable
3059 @code{enable-local-eval}.
3061 For more information, @inforef{File Variables, File Variables, emacs}.
3064 Synthetic X events. (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3067 Emacs accepts synthetic X events generated by the @code{SendEvent}
3068 request as though they were regular events. As a result, if you are
3069 using the trivial host-based authentication, other users who can open X
3070 connections to your X workstation can make your Emacs process do
3071 anything, including run other processes with your privileges.
3073 The only fix for this is to prevent other users from being able to open
3074 X connections. The standard way to prevent this is to use a real
3075 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}. If using
3076 the @code{xauth} program has any effect, then you are probably using
3077 @samp{MIT-MAGIC-COOKIE-1}. Your site may be using a superior
3078 authentication method; ask your system administrator.
3080 If real authentication is not a possibility, you may be satisfied by
3081 just allowing hosts access for brief intervals while you start your X
3082 programs, then removing the access. This reduces the risk somewhat by
3083 narrowing the time window when hostile users would have access, but
3084 @emph{does not eliminate the risk}.
3086 On most computers running Unix and X, you enable and disable
3087 access using the @code{xhost} command. To allow all hosts access to
3095 at the shell prompt, which (on an HP machine, at least) produces the
3099 access control disabled, clients can connect from any host
3102 To deny all hosts access to your X server (except those explicitly
3103 allowed by name), use
3109 On the test HP computer, this command generated the following message:
3112 access control enabled, only authorized clients can connect
3117 @node Dired claims that no file is on this line
3118 @section Dired says, @samp{no file on this line} when I try to do something.
3119 @cindex Dired does not see a file
3121 Dired uses a regular expression to find the beginning of a file name.
3122 In a long Unix-style directory listing (@samp{ls -l}), the file name
3123 starts after the date. The regexp has thus been written to look for the
3124 date. By default, it should understand dates and times regardless of
3125 the language, but if your directory listing has an unusual format, Dired
3128 There are two approaches to solving this. The first one involves
3129 setting things up so that @samp{ls -l} outputs a more standard format.
3130 See your OS manual for more information.
3132 The second approach involves changing the regular expression used by
3133 dired, @code{directory-listing-before-filename-regexp}.
3135 @c ------------------------------------------------------------
3136 @node Compiling and installing Emacs
3137 @chapter Compiling and installing Emacs
3138 @cindex Compiling and installing Emacs
3141 * Installing Emacs::
3142 * Problems building Emacs::
3145 @node Installing Emacs
3146 @section How do I install Emacs?
3147 @cindex Installing Emacs
3148 @cindex Unix systems, installing Emacs on
3149 @cindex Downloading and installing Emacs
3150 @cindex Building Emacs from source
3151 @cindex Source code, building Emacs from
3153 This answer is meant for users of Unix and Unix-like systems. Users of
3154 other operating systems should see the series of questions beginning
3155 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3156 and binaries, and how to install Emacs on those systems.
3158 Most GNU/Linux distributions provide pre-built Emacs packages.
3159 If Emacs is not installed already, you can install it by running (as
3160 root) a command such as @samp{yum install emacs} (Red Hat and
3161 derivatives) or @samp{apt-get install emacs} (Debian and derivatives).
3163 If you want to compile Emacs yourself, read the file @file{INSTALL} in
3164 the source distribution. In brief:
3169 First download the Emacs sources. @xref{Current GNU distributions}, for
3170 a list of ftp sites that make them available. On @file{ftp.gnu.org},
3171 the main GNU distribution site, sources are available as
3173 @c Don't include VER in the file name, because pretests are not there.
3174 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
3176 (Replace @samp{VERSION} with the relevant version number, e.g. @samp{23.1}.)
3179 Next uncompress and extract the source files. This requires
3180 the @code{gzip} and @code{tar} programs, which are standard utilities.
3181 If your system does not have them, these can also be downloaded from
3184 GNU @code{tar} can uncompress and extract in a single-step:
3187 tar -zxvf emacs-VERSION.tar.gz
3191 At this point, the Emacs sources should be sitting in a directory called
3192 @file{emacs-VERSION}. On most common Unix and Unix-like systems,
3193 you should be able to compile Emacs with the following commands:
3197 ./configure # configure Emacs for your particular system
3198 make # use Makefile to build components, then Emacs
3201 If the @code{make} completes successfully, the odds are fairly good that
3202 the build has gone well. (@xref{Problems building Emacs}, if you weren't
3206 By default, Emacs is installed in @file{/usr/local}. To actually
3207 install files, become the superuser and type
3213 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3214 and any Emacs Info files that might be in @file{/usr/local/share/info/}.
3218 @node Problems building Emacs
3219 @section What should I do if I have trouble building Emacs?
3220 @cindex Problems building Emacs
3221 @cindex Errors when building Emacs
3223 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3224 source) to see if there is already a solution for your problem. Next,
3225 look for other questions in this FAQ that have to do with Emacs
3226 installation and compilation problems.
3228 If you'd like to have someone look at your problem and help solve it,
3229 see @ref{Help installing Emacs}.
3231 If you cannot find a solution in the documentation, please report the
3232 problem (@pxref{Reporting bugs}).
3235 @c ------------------------------------------------------------
3236 @node Finding Emacs and related packages
3237 @chapter Finding Emacs and related packages
3238 @cindex Finding Emacs and related packages
3241 * Finding Emacs on the Internet::
3242 * Finding a package with particular functionality::
3243 * Packages that do not come with Emacs::
3245 * Current GNU distributions::
3246 * Difference between Emacs and XEmacs::
3247 * Emacs for minimalists::
3248 * Emacs for MS-DOS::
3249 * Emacs for MS-Windows::
3250 * Emacs for GNUstep::
3251 * Emacs for Mac OS X::
3254 @node Finding Emacs on the Internet
3255 @section Where can I get Emacs on the net?
3256 @cindex Finding Emacs on the Internet
3257 @cindex Downloading Emacs
3259 Information on downloading Emacs is available at
3260 @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}.
3262 @xref{Installing Emacs}, for information on how to obtain and build the latest
3263 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3264 archive sites that make GNU software available.
3266 @node Finding a package with particular functionality
3267 @section How do I find a Emacs Lisp package that does XXX?
3268 @cindex Package, finding
3269 @cindex Finding an Emacs Lisp package
3270 @cindex Functionality, finding a particular package
3272 First of all, you should check to make sure that the package isn't
3273 already available. For example, typing @kbd{M-x apropos @key{RET}
3274 wordstar @key{RET}} lists all functions and variables containing the
3275 string @samp{wordstar}.
3277 It is also possible that the package is on your system, but has not been
3278 loaded. To see which packages are available for loading, look through
3279 your computer's lisp directory (@pxref{File-name conventions}). The Lisp
3280 source to most packages contains a short description of how they
3281 should be loaded, invoked, and configured---so before you use or
3282 modify a Lisp package, see if the author has provided any hints in the
3285 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3286 the constituent Emacs packages.
3288 For advice on how to find extra packages that are not part of Emacs,
3289 see @ref{Packages that do not come with Emacs}.
3291 @node Packages that do not come with Emacs
3292 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3293 @cindex Unbundled packages
3294 @cindex Finding other packages
3295 @cindex Lisp packages that do not come with Emacs
3296 @cindex Packages, those that do not come with Emacs
3297 @cindex Emacs Lisp List
3298 @cindex Emacs Lisp Archive
3300 Your first port of call should be the @kbd{M-x list-packages} command.
3301 This connects to the @uref{http:///elpa.gnu.org, GNU ELPA} (``Emacs
3302 Lisp Package Archive'') server and fetches the list of additional
3303 packages that it offers. These are GNU packages that are available
3304 for use with Emacs, but are distributed separately. Select a package
3305 to get more details about the features that it offers, and then if you
3306 wish, Emacs can download and automatically install it for you.
3308 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs Lisp
3309 List (ELL)}, maintained by @email{S.J.Eglen@@damtp.cam.ac.uk, Stephen Eglen},
3310 aims to provide one compact list with links to all of the current Emacs
3311 Lisp files on the Internet. The ELL can be browsed over the web, or
3312 from Emacs with @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.el,
3313 the @file{ell} package}.
3315 Many authors post their packages to the @uref{news:gnu.emacs.sources,
3316 Emacs sources newsgroup}. You can search the archives of this
3317 group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google},
3318 or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example.
3320 Several packages are stored in
3321 @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}.
3323 Read the file @file{etc/MORE.STUFF} for more information about
3326 @node Spell-checkers
3327 @section Spell-checkers
3328 @cindex Spell-checker
3329 @cindex Checking spelling
3334 Various spell-checkers are compatible with Emacs, including:
3339 @uref{http://aspell.net/}
3342 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3345 @uref{http://hunspell.sourceforge.net/}
3349 @node Current GNU distributions
3350 @section Where can I get other up-to-date GNU stuff?
3351 @cindex Current GNU distributions
3352 @cindex Sources for current GNU distributions
3353 @cindex Stuff, current GNU
3354 @cindex Up-to-date GNU stuff
3355 @cindex Finding current GNU software
3356 @cindex Official GNU software sites
3358 The most up-to-date official GNU software is normally kept at
3360 @uref{ftp://ftp.gnu.org/pub/gnu}
3362 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3364 @uref{http://www.gnu.org/order/ftp.html}
3366 @node Difference between Emacs and XEmacs
3367 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3369 @cindex Difference Emacs and XEmacs
3373 XEmacs is a branch version of Emacs. It was first called Lucid Emacs,
3374 and was initially derived from a prerelease version of Emacs 19. In
3375 this FAQ, we use the name ``Emacs'' only for the official version.
3377 Emacs and XEmacs each come with Lisp packages that are lacking in the
3378 other. The two versions have some significant differences at the Lisp
3379 programming level. Their current features are roughly comparable,
3380 though the support for some operating systems, character sets and
3381 specific packages might be quite different.
3383 Some XEmacs code has been contributed to Emacs, and we would like to
3384 use other parts, but the earlier XEmacs maintainers did not always
3385 keep track of the authors of contributed code, which makes it
3386 impossible for the FSF to get copyright papers signed for that code.
3387 (The FSF requires these papers for all the code included in the Emacs
3388 release, aside from generic C support packages that retain their
3389 separate identity and are not integrated into the code of Emacs
3392 If you want to talk about these two versions and distinguish them,
3393 please call them ``Emacs'' and ``XEmacs.'' To contrast ``XEmacs''
3394 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3395 origin in the work of the GNU Project. Terms such as ``Emacsen'' and
3396 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3397 is better to write ``Emacs and XEmacs.''
3399 @node Emacs for minimalists
3400 @section I don't have enough disk space to install Emacs
3402 @cindex Not enough disk space to install Emacs
3404 GNU Zile is a lightweight Emacs clone. Zile is short for @samp{Zile Is
3405 Lossy Emacs}. It has all of Emacs's basic editing features. The Zile
3406 binary typically has a size of about 130 kbytes, so this can be useful
3407 if you are in an extremely space-restricted environment. More
3408 information is available from
3410 @uref{http://www.gnu.org/software/zile/}
3413 @node Emacs for MS-DOS
3414 @section Where can I get Emacs for MS-DOS?
3415 @cindex MS-DOS, Emacs for
3416 @cindex DOS, Emacs for
3417 @cindex Compiling Emacs for DOS
3418 @cindex Emacs for MS-DOS
3420 To build Emacs from source for MS-DOS, see the instructions in the file
3421 @file{msdos/INSTALL} in the distribution. The DOS port builds and runs
3422 on plain DOS, and also on all versions of MS-Windows from version 3.X
3423 onwards, including Windows XP and Vista.
3425 The file @file{etc/PROBLEMS} contains some additional information
3426 regarding Emacs under MS-DOS.
3428 A pre-built binary distribution of the old Emacs 20 is available, as
3431 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3433 For a list of other MS-DOS implementations of Emacs (and Emacs
3434 look-alikes), consult the list of ``Emacs implementations and literature,''
3437 @uref{http://www.finseth.com/emacs.html}
3439 Note that while many of these programs look similar to Emacs, they often
3440 lack certain features, such as the Emacs Lisp extension language.
3442 @node Emacs for MS-Windows
3443 @section Where can I get Emacs for Microsoft Windows?
3444 @cindex FAQ for Emacs on MS-Windows
3445 @cindex Emacs for MS-Windows
3446 @cindex Microsoft Windows, Emacs for
3448 There is a @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html,
3449 separate FAQ} for Emacs on MS-Windows. For MS-DOS, @pxref{Emacs for MS-DOS}.
3452 @node Emacs for GNUstep
3453 @section Where can I get Emacs for GNUstep?
3454 @cindex GNUstep, Emacs for
3456 Beginning with version 23.1, Emacs supports GNUstep natively.
3457 See the file @file{nextstep/INSTALL} in the distribution.
3459 @node Emacs for Mac OS X
3460 @section Where can I get Emacs for Mac OS X?
3461 @cindex Apple computers, Emacs for
3462 @cindex Macintosh, Emacs for
3463 @cindex Mac OS X, Emacs for
3465 Beginning with version 22.1, Emacs supports Mac OS X natively.
3466 See the file @file{nextstep/INSTALL} in the distribution.
3468 @c ------------------------------------------------------------
3470 @chapter Key bindings
3471 @cindex Key bindings
3474 * Binding keys to commands::
3475 * Invalid prefix characters::
3476 * Terminal setup code works after Emacs has begun::
3477 * Working with function and arrow keys::
3478 * X key translations for Emacs::
3479 * Backspace invokes help::
3481 * Producing C-XXX with the keyboard::
3484 * Compose Character::
3485 * Binding combinations of modifiers and function keys::
3486 * Meta key does not work in xterm::
3487 * ExtendChar key does not work as Meta::
3488 * SPC no longer completes file names::
3491 @node Binding keys to commands
3492 @section How do I bind keys (including function keys) to commands?
3493 @cindex Binding keys to commands
3494 @cindex Keys, binding to commands
3495 @cindex Commands, binding keys to
3497 Keys can be bound to commands either interactively or in your
3498 @file{.emacs} file. To interactively bind keys for all modes, type
3499 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3501 To bind a key just in the current major mode, type @kbd{M-x
3502 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3504 @inforef{Key Bindings, Key Bindings, emacs}, for further details.
3506 To make the process of binding keys interactively easier, use the
3507 following ``trick'': First bind the key interactively, then immediately
3508 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}. Now, the command needed
3509 to bind the key is in the kill ring, and can be yanked into your
3510 @file{.emacs} file. If the key binding is global, no changes to the
3511 command are required. For example,
3514 (global-set-key (quote [f1]) (quote help-for-help))
3518 can be placed directly into the @file{.emacs} file. If the key binding is
3519 local, the command is used in conjunction with the @samp{add-hook} function.
3520 For example, in TeX mode, a local binding might be
3523 (add-hook 'tex-mode-hook
3525 (local-set-key (quote [f1]) (quote help-for-help))))
3532 Control characters in key sequences, in the form yanked from the kill
3533 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3534 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc. You may want
3535 to convert these into their vector or string forms.
3538 If a prefix key of the character sequence to be bound is already
3539 bound as a complete key, then you must unbind it before the new
3540 binding. For example, if @kbd{ESC @{} is previously bound:
3543 (global-unset-key [?\e ?@{]) ;; or
3544 (local-unset-key [?\e ?@{])
3548 Aside from commands and ``lambda lists,'' a vector or string also
3549 can be bound to a key and thus treated as a macro. For example:
3552 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g]) ;; or
3553 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3558 @node Invalid prefix characters
3559 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3560 @cindex Prefix characters, invalid
3561 @cindex Invalid prefix characters
3562 @cindex Misspecified key sequences
3564 Usually, one of two things has happened. In one case, the control
3565 character in the key sequence has been misspecified (e.g. @samp{C-f}
3566 used instead of @samp{\C-f} within a Lisp expression). In the other
3567 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3568 was already bound as a @dfn{complete key}. Historically, the @samp{ESC [}
3569 prefix was usually the problem, in which case you should evaluate either
3570 of these forms before attempting to bind the key sequence:
3573 (global-unset-key [?\e ?[]) ;; or
3574 (global-unset-key "\e[")
3577 @node Terminal setup code works after Emacs has begun
3578 @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?
3579 @cindex Terminal setup code in @file{.emacs}
3581 During startup, Emacs initializes itself according to a given code/file
3582 order. If some of the code executed in your @file{.emacs} file needs to
3583 be postponed until the initial terminal or window-system setup code has
3584 been executed but is not, then you will experience this problem (this
3585 code/file execution order is not enforced after startup).
3587 To postpone the execution of Emacs Lisp code until after terminal or
3588 window-system setup, treat the code as a @dfn{lambda list} and set the
3589 value of either the @code{term-setup-hook} or @code{window-setup-hook}
3590 variable to this lambda function. For example,
3593 (add-hook 'term-setup-hook
3595 (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3596 ;; Make vt220's "Do" key behave like M-x:
3597 (global-set-key [do] 'execute-extended-command))))
3600 For information on what Emacs does every time it is started, see the
3601 @file{lisp/startup.el} file.
3603 @node Working with function and arrow keys
3604 @section How do I tell what characters or symbols my function or arrow keys emit?
3605 @cindex Working with arrow keys
3606 @cindex Arrow keys, symbols generated by
3607 @cindex Working with function keys
3608 @cindex Function keys, symbols generated by
3609 @cindex Symbols generated by function keys
3611 Type @kbd{C-h c} then the function or arrow keys. The command will
3612 return either a function key symbol or character sequence (see the
3613 Emacs documentation for an explanation). This works for other
3616 @node X key translations for Emacs
3617 @section How do I set the X key ``translations'' for Emacs?
3618 @cindex X key translations
3619 @cindex Key translations under X
3620 @cindex Translations for keys under X
3622 Emacs is not written using the Xt library by default, so there are no
3623 ``translations'' to be set. (We aren't sure how to set such translations
3624 if you do build Emacs with Xt; please let us know if you've done this!)
3626 The only way to affect the behavior of keys within Emacs is through
3627 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs). The
3628 @code{define-key} command should be used in conjunction with the
3629 @code{function-key-map} map. For instance,
3632 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3636 defines the @kbd{M-@key{TAB}} key sequence.
3638 @node Backspace invokes help
3639 @section Why does the @key{Backspace} key invoke help?
3640 @cindex Backspace key invokes help
3641 @cindex Help invoked by Backspace
3642 @cindex DEL key does not delete
3644 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
3645 @kbd{C-h} sends the same code. In Emacs by default @kbd{C-h} invokes
3646 help-command. This is intended to be easy to remember since the first
3647 letter of @samp{help} is @samp{h}. The easiest solution to this problem
3648 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
3649 @key{Delete} key) for deleting the previous character.
3651 For many people this solution may be problematic:
3656 They normally use @key{Backspace} outside of Emacs for deleting the
3657 previous character. This can be solved by making @key{DEL} the command
3658 for deleting the previous character outside of Emacs. On many Unix
3659 systems, this command will remap @key{DEL}:
3666 The user may prefer the @key{Backspace} key for deleting the
3667 previous character because it is more conveniently located on their
3668 keyboard or because they don't even have a separate @key{Delete} key.
3669 In this case, the @key{Backspace} key should be made to behave like
3670 @key{Delete}. There are several methods.
3674 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
3675 TeraTerm) allow the character generated by the @key{Backspace} key to be
3676 changed from a setup menu.
3679 You may be able to get a keyboard that is completely programmable, or a
3680 terminal emulator that supports remapping of any key to any other key.
3683 With Emacs 21.1 and later, you can control the effect of the
3684 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
3685 windowed displays, by customizing the option
3686 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
3687 normal-erase-is-backspace}. See the documentation of these symbols
3688 (@pxref{Emacs Lisp documentation}) for more info.
3691 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
3695 (keyboard-translate ?\C-h ?\C-?)
3699 This is the recommended method of forcing @key{Backspace} to act as
3700 @key{DEL}, because it works even in modes which bind @key{DEL} to
3701 something other than @code{delete-backward-char}.
3703 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
3704 default deletes forward:
3707 (keyboard-translate ?\C-? ?\C-d)
3710 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
3713 Another approach is to switch key bindings and put help on @kbd{C-x h}
3717 (global-set-key "\C-h" 'delete-backward-char)
3719 ;; overrides mark-whole-buffer
3720 (global-set-key "\C-xh" 'help-command)
3724 This method is not recommended, though: it only solves the problem for
3725 those modes which bind @key{DEL} to @code{delete-backward-char}. Modes
3726 which bind @key{DEL} to something else, such as @code{view-mode}, will
3727 not work as you expect when you press the @key{Backspace} key. For this
3728 reason, we recommend the @code{keyboard-translate} method, shown
3731 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
3734 Don't try to bind @key{DEL} to @code{help-command}, because there are
3735 many modes that have local bindings of @key{DEL} that will interfere.
3739 When Emacs 21 or later runs on a windowed display, it binds the
3740 @key{Delete} key to a command which deletes the character at point, to
3741 make Emacs more consistent with keyboard operation on these systems.
3743 For more information about troubleshooting this problem, see @ref{DEL
3744 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
3748 @section How do I swap two keys?
3749 @cindex Swapping keys
3750 @cindex Keys, swapping
3751 @cindex @code{keyboard-translate}
3753 You can swap two keys (or key sequences) by using the
3754 @code{keyboard-translate} function. For example, to turn @kbd{C-h}
3755 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
3758 (keyboard-translate ?\C-h ?\C-?) ; translate `C-h' to DEL
3759 (keyboard-translate ?\C-? ?\C-h) ; translate DEL to `C-h'.
3763 The first key sequence of the pair after the function identifies what is
3764 produced by the keyboard; the second, what is matched for in the
3767 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
3768 toggle @code{normal-erase-is-backspace-mode} instead of calling
3769 @code{keyboard-translate}. @inforef{DEL Does Not Delete, DEL Does Not Delete,
3772 Keyboard translations are not the same as key bindings in keymaps.
3773 Emacs contains numerous keymaps that apply in different situations, but
3774 there is only one set of keyboard translations, and it applies to every
3775 character that Emacs reads from the terminal. Keyboard translations
3776 take place at the lowest level of input processing; the keys that are
3777 looked up in keymaps contain the characters that result from keyboard
3780 @node Producing C-XXX with the keyboard
3781 @section How do I produce C-XXX with my keyboard?
3782 @cindex Producing control characters
3783 @cindex Generating control characters
3784 @cindex Control characters, generating
3786 On terminals (but not under X), some common ``aliases'' are:
3790 @item @kbd{C-2} or @kbd{C-@key{SPC}}
3796 @item @kbd{C-7} or @kbd{C-S--}
3810 Often other aliases exist; use the @kbd{C-h c} command and try
3811 @key{CTRL} with all of the digits on your keyboard to see what gets
3812 generated. You can also try the @kbd{C-h w} command if you know the
3813 name of the command.
3816 @section What if I don't have a @key{Meta} key?
3817 @cindex No @key{Meta} key
3818 @cindex @key{Meta} key, what to do if you lack it
3820 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
3822 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}. In fact,
3823 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
3824 (depending on the value of @code{meta-prefix-char}). Note that you
3825 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
3826 @key{ESC}, release it, and then press @key{a}.
3829 @section What if I don't have an @key{Escape} key?
3830 @cindex No Escape key
3831 @cindex Lacking an Escape key
3832 @cindex Escape key, lacking
3834 Type @kbd{C-[} instead. This should send @acronym{ASCII} code 27 just like an
3835 Escape key would. @kbd{C-3} may also work on some terminal (but not
3836 under X). For many terminals (notably DEC terminals) @key{F11}
3837 generates @key{ESC}. If not, the following form can be used to bind it:
3840 ;; F11 is the documented ESC replacement on DEC terminals.
3841 (define-key function-key-map [f11] [?\e])
3844 @node Compose Character
3845 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
3846 @cindex @key{Compose Character} key, using as @key{Meta}
3847 @cindex @key{Meta}, using @key{Compose Character} for
3849 On a dumb terminal such as a VT220, no. It is rumored that certain
3850 VT220 clones could have their @key{Compose} key configured this way. If
3851 you're using X, you might be able to do this with the @code{xmodmap}
3854 @node Binding combinations of modifiers and function keys
3855 @section How do I bind a combination of modifier key and function key?
3856 @cindex Modifiers and function keys
3857 @cindex Function keys and modifiers
3858 @cindex Binding modifiers and function keys
3860 You can represent modified function keys in vector format by adding
3861 prefixes to the function key symbol. For example (from the Emacs
3865 (global-set-key [?\C-x right] 'forward-page)
3869 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
3871 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
3872 @key{Super}, @key{Alt}, and @key{Shift} with function keys. To
3873 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
3874 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name. Here
3875 is how to make @kbd{H-M-RIGHT} move forward a word:
3878 (global-set-key [H-M-right] 'forward-word)
3884 Not all modifiers are permitted in all situations. @key{Hyper},
3885 @key{Super}, and @key{Alt} are not available on Unix character
3886 terminals. Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and
3887 @kbd{Mouse-1}) also fall under this category.
3891 @xref{Binding keys to commands}, for general key binding instructions.
3893 @node Meta key does not work in xterm
3894 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
3895 @cindex @key{Meta} key and @code{xterm}
3896 @cindex Xterm and @key{Meta} key
3898 @inforef{Unibyte Mode, Single-Byte Character Set Support, emacs}.
3900 If the advice in the Emacs manual fails, try all of these methods before
3901 asking for further help:
3906 You may have big problems using @code{mwm} as your window manager.
3907 (Does anyone know a good generic solution to allow the use of the
3908 @key{Meta} key in Emacs with @file{mwm}?)
3911 For X11: Make sure it really is a @key{Meta} key. Use @code{xev} to
3912 find out what keysym your @key{Meta} key generates. It should be either
3913 @code{Meta_L} or @code{Meta_R}. If it isn't, use @file{xmodmap} to fix
3914 the situation. If @key{Meta} does generate @code{Meta_L} or
3915 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
3916 your @file{~/.Xdefaults} file:
3919 XTerm*eightBitInput: false
3920 XTerm*eightBitOutput: true
3924 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
3925 characters. @samp{stty -a} (or @samp{stty everything}) should show
3926 @samp{cs8} somewhere. If it shows @samp{cs7} instead, use @samp{stty
3927 cs8 -istrip} (or @samp{stty pass8}) to fix it.
3930 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
3931 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
3935 If Emacs is running on Ultrix, it is reported that evaluating
3936 @code{(set-input-mode t nil)} helps.
3939 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
3940 you type @kbd{M-W}, which is the same conversion Emacs would make if it
3941 got the @kbd{M-W} anyway. In X11R4, the following resource
3942 specification will do this:
3945 XTerm.VT100.EightBitInput: false
3949 (This changes the behavior of the @code{insert-eight-bit} action.)
3951 With older @code{xterm}s, you can specify this behavior with a translation:
3954 XTerm.VT100.Translations: #override \
3955 Meta<KeyPress>: string(0x1b) insert()
3959 You might have to replace @samp{Meta} with @samp{Alt}.
3963 @node ExtendChar key does not work as Meta
3964 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
3965 @cindex @key{ExtendChar} key as @key{Meta}
3966 @cindex @key{Meta}, using @key{ExtendChar} for
3967 @cindex HP-UX, the @key{ExtendChar} key
3969 This is a result of an internationalization extension in X11R4 and the
3970 fact that HP is now using this extension. Emacs assumes that the
3971 @code{XLookupString} function returns the same result regardless of the
3972 @key{Meta} key state which is no longer necessarily true. Until Emacs
3973 is fixed, the temporary kludge is to run this command after each time
3974 the X server is started but preferably before any xterm clients are:
3977 xmodmap -e 'remove mod1 = Mode_switch'
3980 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
3983 This will disable the use of the extra keysyms systemwide, which may be
3984 undesirable if you actually intend to use them.
3986 @node SPC no longer completes file names
3987 @section Why doesn't SPC complete file names anymore?
3988 @cindex @kbd{SPC} file name completion
3990 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
3991 the minibuffer, so that file names with embedded spaces could be typed
3992 without the need to quote the spaces.
3994 You can get the old behavior by binding @kbd{SPC} to
3995 @code{minibuffer-complete-word} in the minibuffer, as follows:
3998 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
3999 'minibuffer-complete-word)
4001 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4002 'minibuffer-complete-word)
4005 @c ------------------------------------------------------------
4006 @node Alternate character sets
4007 @chapter Alternate character sets
4008 @cindex Alternate character sets
4011 * Emacs does not display 8-bit characters::
4012 * Inputting eight-bit characters::
4013 * Right-to-left alphabets::
4014 * How to add fonts::
4017 @node Emacs does not display 8-bit characters
4018 @section How do I make Emacs display 8-bit characters?
4019 @cindex Displaying eight-bit characters
4020 @cindex Eight-bit characters, displaying
4022 @inforef{Unibyte Mode, Single-byte Character Set
4023 Support, emacs}. On a Unix, when Emacs runs on a text-only terminal
4024 display or is invoked with @samp{emacs -nw}, you typically need to use
4025 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4026 display, even after setting the language environment; otherwise
4027 non-@acronym{ASCII} characters will display as @samp{?}. On other operating
4028 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4029 character set supported by the display, and sets up the required
4030 terminal coding system automatically.
4032 @node Inputting eight-bit characters
4033 @section How do I input eight-bit characters?
4034 @cindex Entering eight-bit characters
4035 @cindex Eight-bit characters, entering
4036 @cindex Input, 8-bit characters
4038 Various methods are available for input of eight-bit characters. See
4039 @inforef{Unibyte Mode, Single-byte Character Set
4040 Support, emacs}. For more sophisticated methods, @inforef{Input
4041 Methods, Input Methods, emacs}.
4043 @node Right-to-left alphabets
4044 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4045 @cindex Right-to-left alphabets
4046 @cindex Hebrew, handling with Emacs
4047 @cindex Semitic alphabets
4048 @cindex Arabic alphabets
4049 @cindex Bidirectional text
4051 Emacs supports Hebrew characters (ISO 8859-8) since version 20, but does
4052 not yet support right-to-left character entry and display. The
4053 @uref{http://lists.gnu.org/mailman/listinfo/emacs-bidi, emacs-bidi
4054 mailing list} discusses development of support for this feature.
4057 @node How to add fonts
4058 @section How do I add fonts for use with Emacs?
4059 @cindex add fonts for use with Emacs
4062 First, download and install the BDF font files and any auxiliary
4063 packages they need. The GNU Intlfonts distribution can be found on
4064 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU
4065 Software Directory Web site}.
4067 Next, if you are on X Window system, issue the following two commands
4068 from the shell's prompt:
4071 xset +fp /usr/local/share/emacs/fonts
4076 (Modify the first command if you installed the fonts in a directory
4077 that is not @file{/usr/local/share/emacs/fonts}.) You also need to
4078 arrange for these two commands to run whenever you log in, e.g., by
4079 adding them to your window-system startup file, such as
4080 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4082 Now, add the following line to your @file{~/.emacs} init file:
4085 (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4089 (Again, modify the file name if you installed the fonts elsewhere.)
4091 Finally, if you wish to use the installed fonts with @code{ps-print},
4092 add the following line to your @file{~/.emacs}:
4095 (setq ps-multibyte-buffer 'bdf-font-except-latin)
4098 A few additional steps are necessary for MS-Windows; they are listed
4101 First, make sure @emph{all} the directories with BDF font files are
4102 mentioned in @code{bdf-directory-list}. On Unix and GNU/Linux
4103 systems, one normally runs @kbd{make install} to install the BDF fonts
4104 in the same directory. By contrast, Windows users typically don't run
4105 the Intlfonts installation command, but unpack the distribution in
4106 some directory, which leaves the BDF fonts in its subdirectories. For
4107 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4108 then you should set @code{bdf-directory-list} as follows:
4111 (setq bdf-directory-list
4112 '("C:/Intlfonts/Asian"
4113 "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4114 "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4115 "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4116 "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4117 "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4118 "C:/Intlfonts/Misc"))
4121 @cindex @code{w32-bdf-filename-alist}
4122 @cindex @code{w32-find-bdf-fonts}
4123 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4124 an alist of the BDF fonts and their corresponding file names.
4125 Assuming you have set @code{bdf-directory-list} to name all the
4126 directories with the BDF font files, the following Lisp snippet will
4127 set up @code{w32-bdf-filename-alist}:
4130 (setq w32-bdf-filename-alist
4131 (w32-find-bdf-fonts bdf-directory-list))
4134 Now, create fontsets for the BDF fonts:
4137 (create-fontset-from-fontset-spec
4138 "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4139 japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4140 katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4141 latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4142 japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4143 thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4144 lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4145 tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4146 ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4147 tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4150 Many of the international bdf fonts from Intlfonts are type 0, and
4151 therefore need to be added to font-encoding-alist:
4154 (setq font-encoding-alist
4155 (append '(("MuleTibetan-0" (tibetan . 0))
4156 ("GB2312" (chinese-gb2312 . 0))
4157 ("JISX0208" (japanese-jisx0208 . 0))
4158 ("JISX0212" (japanese-jisx0212 . 0))
4159 ("VISCII" (vietnamese-viscii-lower . 0))
4160 ("KSC5601" (korean-ksc5601 . 0))
4161 ("MuleArabic-0" (arabic-digit . 0))
4162 ("MuleArabic-1" (arabic-1-column . 0))
4163 ("MuleArabic-2" (arabic-2-column . 0)))
4164 font-encoding-alist))
4167 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4168 fontset, or you can select it by setting the default font in your
4172 (set-default-font "fontset-bdf")
4176 @c ------------------------------------------------------------
4178 @chapter Mail and news
4179 @cindex Mail and news
4182 * Changing the included text prefix::
4183 * Saving a copy of outgoing mail::
4184 * Expanding aliases when sending mail::
4185 * Sorting the messages in an Rmail folder::
4186 * Rmail writes to /var/spool/mail::
4187 * Replying to the sender of a message::
4188 * Automatically starting a mail or news reader::
4189 * Reading news with Emacs::
4190 * Gnus does not work with NNTP::
4191 * Making Gnus faster::
4192 * Catching up in all newsgroups::
4195 @node Changing the included text prefix
4196 @section How do I change the included text prefix in mail/news followups?
4197 @cindex Prefix in mail/news followups, changing
4198 @cindex Included text prefix, changing
4199 @cindex Setting the included text character
4200 @cindex Quoting in mail messages
4202 If you read mail with Rmail, set the variable @code{mail-yank-prefix}.
4203 For Gnus, set @code{message-yank-prefix}. For VM, set
4204 @code{vm-included-text-prefix}. For mh-e, set @code{mh-ins-buf-prefix}.
4206 For fancier control of citations, use Supercite (@pxref{Top,, the Supercite
4207 Manual, sc, The Supercite Manual}).
4209 To prevent Emacs from including various headers of the replied-to
4210 message, set the value of @code{mail-yank-ignored-headers} to an
4213 @node Saving a copy of outgoing mail
4214 @section How do I save a copy of outgoing mail?
4215 @cindex Saving a copy of outgoing mail
4216 @cindex Copying outgoing mail to a file
4217 @cindex Filing outgoing mail
4218 @cindex Automatic filing of outgoing mail
4219 @cindex Mail, saving outgoing automatically
4221 You can either mail yourself a copy by including a @samp{BCC} header in the
4222 mail message, or store a copy of the message directly to a file by
4223 including an @samp{FCC} header.
4225 If you use standard mail, you can automatically create a @samp{BCC} to
4229 (setq mail-self-blind t)
4233 in your @file{.emacs} file. You can automatically include an @samp{FCC}
4234 field by putting something like the following in your @file{.emacs}
4238 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4241 The output file will be in Unix mail format.
4243 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4246 It does not work to put @samp{set record filename} in the @file{.mailrc}
4249 @node Expanding aliases when sending mail
4250 @section Why doesn't Emacs expand my aliases when sending mail?
4251 @cindex Expanding aliases when sending mail
4252 @cindex Mail alias expansion
4253 @cindex Sending mail with aliases
4255 @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}.
4260 Normally, Emacs expands aliases when you send the message.
4261 To expand them before this, use @kbd{M-x expand-mail-aliases}.
4264 Emacs normally only reads the @file{.mailrc} file once per session, when
4265 you start to compose your first mail message. If you edit the file
4266 after this, you can use @kbd{M-x build-mail-aliases} to make Emacs
4267 reread it. Prior to Emacs 24.1, this is not an interactive command, so
4268 you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}.
4271 If you like, you can expand mail aliases as abbrevs, as soon as you
4272 type them in. To enable this feature, execute the following:
4275 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4278 Note that the aliases are expanded automatically only after you type
4279 a word-separator character (e.g. @key{RET} or @kbd{,}). You can force their
4280 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4281 (@kbd{M-x expand-abbrev}).
4284 @node Sorting the messages in an Rmail folder
4285 @section How can I sort the messages in my Rmail folder?
4286 @cindex Rmail, sorting messages in
4287 @cindex Folder, sorting messages in an Rmail
4288 @cindex Sorting messages in an Rmail folder
4290 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4291 and their key bindings.
4293 @node Rmail writes to /var/spool/mail
4294 @section Why does Rmail need to write to @file{/var/spool/mail}?
4295 @cindex Rmail and @file{/var/spool/mail}
4296 @cindex @file{/var/spool/mail} and Rmail
4298 This is the behavior of the @code{movemail} program which Rmail uses.
4299 This indicates that @code{movemail} is configured to use lock files.
4304 Certain systems require lock files to interlock access to mail files.
4305 On these systems, @code{movemail} must write lock files, or you risk losing
4306 mail. You simply must arrange to let @code{movemail} write them.
4308 Other systems use the @code{flock} system call to interlock access. On
4309 these systems, you should configure @code{movemail} to use @code{flock}.
4312 @node Replying to the sender of a message
4313 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4314 @cindex Replying only to the sender of a message
4315 @cindex Sender, replying only to
4316 @cindex Rmail, replying to the sender of a message in
4318 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit
4319 @key{r} to reply in Rmail, by default it CCs all of the original
4320 recipients (everyone on the original @samp{To} and @samp{CC}
4321 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4322 it replies only to the sender. However, going through the whole
4323 @kbd{C-u} business every time you want to reply is a pain. This is the
4324 best fix I've been able to come up with:
4327 (defun rmail-reply-t ()
4328 "Reply only to the sender of the current message. (See rmail-reply.)"
4332 (add-hook 'rmail-mode-hook
4334 (define-key rmail-mode-map "r" 'rmail-reply-t)
4335 (define-key rmail-mode-map "R" 'rmail-reply)))
4338 @node Automatically starting a mail or news reader
4339 @section How do I make Emacs automatically start my mail/news reader?
4340 @cindex Mail reader, starting automatically
4341 @cindex News reader, starting automatically
4342 @cindex Starting mail/news reader automatically
4344 To start Emacs in Gnus:
4357 A more convenient way to start with Gnus:
4360 alias gnus 'emacs -f gnus'
4364 It is probably unwise to automatically start your mail or news reader
4365 from your @file{.emacs} file. This would cause problems if you needed to run
4366 two copies of Emacs at the same time. Also, this would make it difficult for
4367 you to start Emacs quickly when you needed to.
4369 @node Reading news with Emacs
4370 @section How do I read news under Emacs?
4371 @cindex Reading news under Emacs
4372 @cindex Usenet reader in Emacs
4373 @cindex Gnus newsreader
4374 @cindex FAQ for Gnus
4376 @cindex Learning more about Gnus
4378 Use @kbd{M-x gnus}. For more information on Gnus, @pxref{Top,, the Gnus
4379 Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked
4380 Questions,, the Gnus FAQ, gnus}.
4383 @node Gnus does not work with NNTP
4384 @section Why doesn't Gnus work via NNTP?
4385 @cindex Gnus and NNTP
4386 @cindex NNTP, Gnus fails to work with
4388 There is a bug in NNTP version 1.5.10, such that when multiple requests
4389 are sent to the NNTP server, the server only handles the first one
4390 before blocking waiting for more input which never comes. NNTP version
4391 1.5.11 claims to fix this.
4393 You can work around the bug inside Emacs like this:
4396 (setq nntp-maximum-request 1)
4399 You can find out what version of NNTP your news server is running by
4400 telnetting to the NNTP port (usually 119) on the news server machine
4401 (i.e., @kbd{telnet server-machine 119}). The server should give its
4402 version number in the welcome message. Type @kbd{quit} to get out.
4404 @node Making Gnus faster
4405 @section How do I make Gnus faster?
4406 @cindex Faster, starting Gnus
4407 @cindex Starting Gnus faster
4408 @cindex Gnus, starting faster
4409 @cindex Slow catch up in Gnus
4410 @cindex Gnus is slow when catching up
4411 @cindex Crosspostings make Gnus catching up slow
4413 From the Gnus FAQ (@pxref{Reading news with Emacs}):
4416 If you have a slow machine, or are just really impatient, there are a
4417 few things you can do to make Gnus run faster.
4419 Set @code{gnus-check-new-newsgroups} and
4420 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
4422 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
4423 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
4424 summary buffer faster.
4427 @node Catching up in all newsgroups
4428 @section How do I catch up all newsgroups in Gnus?
4429 @cindex Catching up all newsgroups in Gnus
4430 @cindex Gnus, Catching up all newsgroups in
4432 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4434 Leave off the initial @kbd{M-<} if you only want to catch up from point
4435 to the end of the @file{*Newsgroup*} buffer.
4438 @unnumbered Concept Index