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-2011 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::
94 * Major packages and programs::
96 * Alternate character sets::
101 @c ------------------------------------------------------------
103 @chapter FAQ notation
106 This chapter describes notation used in the GNU Emacs FAQ, as well as in
107 the Emacs documentation. Consult this section if this is the first time
108 you are reading the FAQ, or if you are confused by notation or terms
113 * Extended commands::
115 * File-name conventions::
120 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
122 @cindex Control key, notation for
123 @cindex @key{Meta} key, notation for
124 @cindex Control-Meta characters, notation for
125 @cindex @kbd{C-h}, definition of
126 @cindex @kbd{C-M-h}, definition of
127 @cindex @key{DEL}, definition of
128 @cindex @key{ESC}, definition of
129 @cindex @key{LFD}, definition of
130 @cindex @key{RET}, definition of
131 @cindex @key{SPC}, definition of
132 @cindex @key{TAB}, definition of
133 @cindex Notation for keys
138 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
141 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
142 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
145 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
149 @kbd{C-M-x}: a synonym for the above
152 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
155 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
158 @key{DEL}: @key{Delete}, usually @strong{not} the same as
159 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
160 deleting invokes Emacs help)
163 @key{ESC}: Escape; same as @kbd{C-[}
166 @key{TAB}: Tab; same as @kbd{C-i}
173 Key sequences longer than one key (and some single-key sequences) are
174 written inside quotes or on lines by themselves, like this:
177 @kbd{M-x frobnicate-while-foo RET}
181 Any real spaces in such a key sequence should be ignored; only @key{SPC}
182 really means press the space key.
184 The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
185 that would be sent by pressing just @key{x} minus 96 (or 64 for
186 upper-case @key{X}) and will be from 0 to 31. On Unix and GNU/Linux
187 terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the
188 @acronym{ASCII} code that would be sent by pressing just @key{x}. Essentially,
189 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
191 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
194 @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call
195 @kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON.
196 Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127.
197 @c FIXME I cannot understand the previous sentence.
199 @inforef{Keys, Keys, emacs}, for more information. (@xref{Emacs
200 manual}, for more information about Info.)
202 @node Extended commands
203 @section What does @file{M-x @var{command}} mean?
204 @cindex Extended commands
205 @cindex Commands, extended
206 @cindex M-x, meaning of
208 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
209 command, then type @key{RET}. (@xref{Basic keys}, if you're not sure
210 what @kbd{M-x} and @key{RET} mean.)
212 @kbd{M-x} (by default) invokes the command
213 @code{execute-extended-command}. This command allows you to run any
214 Emacs command if you can remember the command's name. If you can't
215 remember the command's name, you can type @key{TAB} and @key{SPC} for
216 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
217 @kbd{M-n} (or up-arrow and down-arrow) to see previous commands entered.
218 An Emacs @dfn{command} is an @dfn{interactive} Emacs function.
221 Your system administrator may have bound other key sequences to invoke
222 @code{execute-extended-command}. A function key labeled @kbd{Do} is a
223 good candidate for this, on keyboards that have such a key.
225 If you need to run non-interactive Emacs functions, see @ref{Evaluating
229 @section How do I read topic XXX in the Emacs manual?
230 @cindex Emacs manual, reading topics in
231 @cindex Reading topics in the Emacs manual
232 @cindex Finding topics in the Emacs manual
233 @cindex Info, finding topics in
235 When we refer you to some @var{topic} in the Emacs manual, you can
236 read this manual node inside Emacs (assuming nothing is broken) by
237 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
239 This invokes Info, the GNU hypertext documentation browser. If you don't
240 already know how to use Info, type @key{?} from within Info.
242 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
243 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
245 If these commands don't work as expected, your system administrator may
246 not have installed the Info files, or may have installed them
247 improperly. In this case you should complain.
249 If you are reading this FAQ in Info, you can simply press @key{RET} on a
250 reference to follow it.
252 @xref{Getting a printed manual}, if you would like a paper copy of the
255 @node File-name conventions
256 @section What are @file{etc/GNU}, @file{src/config.h}, @file{site-lisp/default.el}, etc.?
257 @cindex File-name conventions
258 @cindex Conventions for file names
259 @cindex Directories and files that come with Emacs
261 These are files that come with Emacs. The Emacs distribution is divided
262 into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}.
263 Some of these (e.g. @file{etc} and @file{lisp}) are present both in
264 an installed Emacs and in the sources, but some (e.g. @file{src}) are
265 only found in the sources.
267 If you use Emacs, but don't know where it is kept on your system, start
268 Emacs, then type @kbd{C-h v data-directory @key{RET}}. The directory
269 name displayed by this will be the full pathname of the installed
270 @file{etc} directory. (This full path is recorded in the Emacs variable
271 @code{data-directory}, and @kbd{C-h v} displays the value and the
272 documentation of a variable.)
274 The location of your Info directory (i.e., where Info documentation
275 is stored) is kept in the variable @code{Info-default-directory-list}. Use
276 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
277 this variable, which will be a list of directory names. The last
278 directory in that list is probably where most Info files are stored. By
279 default, Emacs Info documentation is placed in @file{/usr/local/share/info}.
281 For information on some of the files in the @file{etc} directory,
282 @pxref{Informational files for Emacs}.
284 @node Common acronyms
285 @section What are FSF, LPF, GNU, RMS, FTP, and GPL?
286 @cindex FSF, definition of
287 @cindex LPF, definition of
288 @cindex GNU, definition of
289 @cindex RMS, definition of
290 @cindex Stallman, Richard, acronym for
291 @cindex Richard Stallman, acronym for
292 @cindex FTP, definition of
293 @cindex GPL, definition of
294 @cindex Acronyms, definitions for
295 @cindex Common acronyms, definitions for
300 Free Software Foundation
303 League for Programming Freedom
309 Richard Matthew Stallman
312 File Transfer Protocol
315 GNU General Public License
319 Avoid confusing the FSF and the LPF. The LPF opposes
320 look-and-feel copyrights and software patents. The FSF aims to make
321 high quality free software available for everyone.
323 The word ``free'' in the title of the Free Software Foundation refers to
324 ``freedom,'' not ``zero cost.'' Anyone can charge any price for
325 GPL-covered software that they want to. However, in practice, the
326 freedom enforced by the GPL leads to low prices, because you can always
327 get the software for less money from someone else, since everyone has
328 the right to resell or give away GPL-covered software.
330 @c ------------------------------------------------------------
331 @node General questions
332 @chapter General questions
333 @cindex General questions
335 This chapter contains general questions having to do with Emacs, the
336 Free Software Foundation, and related organizations.
340 * Real meaning of copyleft::
341 * Guidelines for newsgroup postings::
342 * Newsgroup archives::
344 * Unsubscribing from Emacs lists::
345 * Contacting the FSF::
349 @section What is the LPF?
350 @cindex LPF, description of
351 @cindex League for Programming Freedom
352 @cindex Software patents, opposition to
353 @cindex Patents for software, opposition to
355 The LPF opposes the expanding danger of software patents and
356 look-and-feel copyrights. More information on the LPF's views is
357 available at @uref{http://progfree.org/, the LPF home page}.
359 @node Real meaning of copyleft
360 @section What is the real legal meaning of the GNU copyleft?
361 @cindex Copyleft, real meaning of
362 @cindex GPL, real meaning of
363 @cindex General Public License, real meaning of
364 @cindex Discussion of the GPL
366 The real legal meaning of the GNU General Public License (copyleft) will
367 only be known if and when a judge rules on its validity and scope.
368 There has never been a copyright infringement case involving the GPL to
369 set any precedents. Although legal actions have been brought against
370 companies for violating the terms of the GPL, so far all have been
371 settled out of court (in favour of the plaintiffs). Please take any
372 discussion regarding this issue to the newsgroup
373 @uref{news:gnu.misc.discuss}, which was created to hold the extensive
374 flame wars on the subject.
379 The legal meaning of the GNU copyleft is less important than the spirit,
380 which is that Emacs is a free software project and that work pertaining
381 to Emacs should also be free software. ``Free'' means that all users
382 have the freedom to study, share, change and improve Emacs. To make
383 sure everyone has this freedom, pass along source code when you
384 distribute any version of Emacs or a related program, and give the
385 recipients the same freedom that you enjoyed.
388 @node Guidelines for newsgroup postings
389 @section What are appropriate messages for the various Emacs newsgroups?
390 @cindex Newsgroups, appropriate messages for
391 @cindex GNU newsgroups, appropriate messages for
392 @cindex Usenet groups, appropriate messages for
393 @cindex Mailing lists, appropriate messages for
394 @cindex Posting messages to newsgroups
396 @cindex GNU mailing lists
397 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU
398 mailing list (@pxref{Informational files for Emacs}). For those lists
399 which are gatewayed with newsgroups, it lists both the newsgroup name
400 and the mailing list address. The Emacs mailing lists are also
401 described at @uref{http://savannah.gnu.org/mail/?group=emacs, the Emacs
404 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
405 in general. The newsgroup @uref{news:gnu.emacs.help} is specifically
406 for GNU Emacs. It therefore makes no sense to cross-post to both
407 groups, since only one can be appropriate to any question.
409 Messages advocating ``non-free'' software are considered unacceptable on
410 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
411 which was created to hold the extensive flame-wars on the subject.
412 ``Non-free'' software includes any software for which the end user can't
413 freely modify the source code and exchange enhancements. Be careful to
414 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
415 posting a followup that recommends such software.
417 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
418 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
420 @node Newsgroup archives
421 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
422 @cindex Archived postings from @code{gnu.emacs.help}
423 @cindex Usenet archives for GNU groups
424 @cindex Old Usenet postings for GNU groups
426 The FSF has maintained archives of all of the GNU mailing lists for many
427 years, although there may be some unintentional gaps in coverage. The
428 archive can be browsed over the web at
429 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}. Raw
430 files can be downloaded from @uref{ftp://lists.gnu.org/}.
432 Web-based Usenet search services, such as
433 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
434 archive the @code{gnu.*} groups.
436 You can also read the archives of the @code{gnu.*} groups and post new
437 messages at @uref{http://gmane.org/, Gmane}. Gmane is a service that
438 presents mailing lists as newsgroups (even those without a traditional
439 mail-to-news gateway).
442 @section Where should I report bugs and other problems with Emacs?
443 @cindex Bug reporting
444 @cindex Good bug reports
445 @cindex How to submit a bug report
446 @cindex Reporting bugs
448 The correct way to report Emacs bugs is to use the command
449 @kbd{M-x report-emacs-bug}. It sets up a mail buffer with the
450 essential information and the correct e-mail address, which is
451 @email{bug-gnu-emacs@@gnu.org} for the released versions of Emacs.
452 Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the
453 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
454 news to submit the bug report. This ensures a reliable return address
455 so you can be contacted for further details.
457 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
458 a bug! The manual describes in detail how to submit a useful bug
459 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
460 (@xref{Emacs manual}, if you don't know how to read the manual.)
465 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the
466 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because
467 it takes the time of an unnecessarily large group of people, most of
468 whom are just users and have no idea how to fix these problem.
469 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people
470 who are more likely to know what to do and have expressed a wish to
471 receive more messages about Emacs than the others.
474 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
477 If you have reported a bug and you don't hear about a possible fix,
478 then after a suitable delay (such as a week) it is okay to post on
479 @code{gnu.emacs.help} asking if anyone can help you.
482 If you are unsure whether you have found a bug, consider the following
483 non-exhaustive list, courtesy of RMS:
486 If Emacs crashes, that is a bug. If Emacs gets compilation errors
487 while building, that is a bug. If Emacs crashes while building, that
488 is a bug. If Lisp code does not do what the documentation says it
492 @node Unsubscribing from Emacs lists
493 @section How do I unsubscribe from a mailing list?
494 @cindex Unsubscribing from GNU mailing lists
495 @cindex Removing yourself from GNU mailing lists
497 If you are receiving a GNU mailing list named @var{list}, you should be
498 able to unsubscribe from it by sending a request to the address
499 @email{@var{list}-request@@gnu.org}. Mailing lists mails normally
500 contain information in either the message header
501 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
504 @node Contacting the FSF
505 @section What is the current address of the FSF?
506 @cindex Snail mail address of the FSF
507 @cindex Postal address of the FSF
508 @cindex Contracting the FSF
509 @cindex Free Software Foundation, contacting
511 For up-to-date information, see
512 @uref{http://www.fsf.org/about/contact.html, the FSF contact web-page}.
526 @uref{http://www.fsf.org/}
529 Free Software Foundation@*
530 51 Franklin Street, Fifth Floor@*
531 Boston, MA 02110-1301@*
536 @cindex Ordering GNU software
537 For details on how to order items directly from the FSF, see the
538 @uref{http://shop.fsf.org/, FSF on-line store}.
540 @c ------------------------------------------------------------
542 @chapter Getting help
545 This chapter tells you how to get help with Emacs.
549 * Learning how to do something::
550 * Getting a printed manual::
551 * Emacs Lisp documentation::
552 * Installing Texinfo documentation::
553 * Printing a Texinfo file::
554 * Viewing Info files outside of Emacs::
555 * Informational files for Emacs::
556 * Help installing Emacs::
557 * Obtaining the FAQ::
561 @section I'm just starting Emacs; how do I do basic editing?
562 @cindex Basic editing with Emacs
563 @cindex Beginning editing
564 @cindex Tutorial, invoking the
565 @cindex Self-paced tutorial, invoking the
566 @cindex Help system, entering the
568 Type @kbd{C-h t} to invoke the self-paced tutorial. Just typing
569 @kbd{C-h} enters the help system. Starting with Emacs 22, the tutorial
570 is available in many foreign languages such as French, German, Japanese,
571 Russian, etc. Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
572 to choose your language and start the tutorial.
574 Your system administrator may have changed @kbd{C-h} to act like
575 @key{DEL} to deal with local keyboards. You can use @kbd{M-x
576 help-for-help} instead to invoke help. To discover what key (if any)
577 invokes help on your system, type @kbd{M-x where-is @key{RET}
578 help-for-help @key{RET}}. This will print a comma-separated list of key
579 sequences in the echo area. Ignore the last character in each key
580 sequence listed. Each of the resulting key sequences (e.g. @key{F1} is
581 common) invokes help.
583 Emacs help works best if it is invoked by a single key whose value
584 should be stored in the variable @code{help-char}.
586 @node Learning how to do something
587 @section How do I find out how to do something in Emacs?
588 @cindex Help for Emacs
589 @cindex Learning to do something in Emacs
590 @cindex Reference card for Emacs
591 @cindex Overview of help systems
593 There are several methods for finding out how to do things in Emacs.
597 @cindex Reading the Emacs manual
599 The complete text of the Emacs manual is available via the Info
600 hypertext reader. Type @kbd{C-h r} to display the manual in Info mode.
601 Typing @key{h} immediately after entering Info will provide a short
602 tutorial on how to use it.
604 @cindex Lookup a subject in a manual
605 @cindex Index search in a manual
607 To quickly locate the section of the manual which discusses a certain
608 issue, or describes a command or a variable, type @kbd{C-h i m emacs
609 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
610 topic, the command, or the variable which you are looking for. If this
611 does not land you on the right place in the manual, press @kbd{,}
612 (comma) repeatedly until you find what you need. (The @kbd{i} and
613 @kbd{,} keys invoke the index-searching functions, which look for the
614 @var{topic} you type in all the indices of the Emacs manual.)
618 You can list all of the commands whose names contain a certain word
619 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
622 @cindex Command description in the manual
624 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
625 for the name of a command, and then attempts to find the section in the
626 Emacs manual where that command is described.
628 @cindex Finding commands and variables
630 You can list all of the functions and variables whose names contain a
631 certain word using @kbd{M-x apropos}.
634 You can list all of the functions and variables whose documentation
635 matches a regular expression or a string, using @kbd{M-x
636 apropos-documentation}.
639 You can order a hardcopy of the manual from the FSF. @xref{Getting a
642 @cindex Reference cards, in other languages
644 You can get a printed reference card listing commands and keys to
645 invoke them. You can order one from the FSF for $2 (or 10 for $18),
646 or you can print your own from the @file{etc/refcards/refcard.tex} or
647 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
648 Beginning with version 21.1, the Emacs distribution comes with
649 translations of the reference card into several languages; look for
650 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
651 is a two-letter code of the language. For example, the German version
652 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
653 and @file{etc/recards/de-refcard.pdf}.
656 There are many other commands in Emacs for getting help and
657 information. To get a list of these commands, type @samp{?} after
662 @node Getting a printed manual
663 @section How do I get a printed copy of the Emacs manual?
664 @cindex Printed Emacs manual, obtaining
665 @cindex Manual, obtaining a printed or HTML copy of
666 @cindex Emacs manual, obtaining a printed or HTML copy of
668 You can order a printed copy of the Emacs manual from the FSF. For
669 details see the @uref{http://shop.fsf.org/, FSF on-line store}.
671 The full Texinfo source for the manual also comes in the @file{doc/emacs}
672 directory of the Emacs distribution, if you're daring enough to try to
673 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
676 If you absolutely have to print your own copy, and you don't have @TeX{},
677 you can get a PostScript or PDF (or HTML) version from
679 @uref{http://www.gnu.org/software/emacs/manual/}
681 @xref{Learning how to do something}, for how to view the manual from Emacs.
683 @node Emacs Lisp documentation
684 @section Where can I get documentation on Emacs Lisp?
685 @cindex Documentation on Emacs Lisp
686 @cindex Function documentation
687 @cindex Variable documentation
688 @cindex Emacs Lisp Reference Manual
689 @cindex Reference manual for Emacs Lisp
691 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
692 function, @kbd{C-h v} for a variable.
694 For more information, the Emacs Lisp Reference Manual is available
695 in Info format (@pxref{Top, Emacs Lisp,, elisp, The
696 Emacs Lisp Reference Manual}).
698 You can also order a hardcopy of the manual from the FSF, for details
699 see the @uref{http://shop.fsf.org/, FSF on-line store}. (This manual is
700 not always in print.)
702 An HTML version of the Emacs Lisp Reference Manual is available at
704 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html}
706 @node Installing Texinfo documentation
707 @section How do I install a piece of Texinfo documentation?
708 @cindex Texinfo documentation, installing
709 @cindex Installing Texinfo documentation
710 @cindex New Texinfo files, installing
711 @cindex Documentation, installing new Texinfo files
712 @cindex Info files, how to install
714 Emacs releases come with pre-built Info files, and the normal install
715 process places them in the correct location. This is true for most
716 applications that provide Info files. The following section is only
717 relevant if you want to install extra Info files by hand.
719 First, you must turn the Texinfo source files into Info files. You may
720 do this using the stand-alone @file{makeinfo} program, available as part
721 of the Texinfo package at
723 @uref{http://www.gnu.org/software/texinfo/}
725 For information about the Texinfo format, read the Texinfo manual which
726 comes with the Texinfo package. This manual also comes installed in
727 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
730 @c FIXME is this a complete alternative?
731 @c Probably not, given that we require makeinfo to build Emacs.
732 Alternatively, you could use the Emacs command @kbd{M-x
733 texinfo-format-buffer}, after visiting the Texinfo source file of the
734 manual you want to convert.
736 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
737 resulting Info files in Emacs's Info tree. To install Info files,
742 Move the files to the @file{info} directory in the installed Emacs
743 distribution. @xref{File-name conventions}, if you don't know where that
747 Run the @code{install-info} command, which is part of the Texinfo
748 distribution, to update the main Info directory menu, like this:
751 install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
755 where @var{dir-path} is the full path to the directory where you copied
756 the produced Info file(s), and @var{file} is the name of the Info file
757 you produced and want to install.
759 If you don't have the @code{install-info} command installed, you can
760 edit the file @file{info/dir} in the installed Emacs distribution, and
761 add a line for the top level node in the Info package that you are
762 installing. Follow the examples already in this file. The format is:
765 * Topic: (relative-pathname). Short description of topic.
770 If you want to install Info files and you don't have the necessary
771 privileges, you have several options:
775 Info files don't actually need to be installed before being used.
776 You can use a prefix argument for the @code{info} command and specify
777 the name of the Info file in the minibuffer. This goes to the node
778 named @samp{Top} in that file. For example, to view a Info file named
779 @file{@var{info-file}} in your home directory, you can type this:
782 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
785 Alternatively, you can feed a file name to the @code{Info-goto-node}
786 command (invoked by pressing @key{g} in Info mode) by typing the name
787 of the file in parentheses, like this:
790 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
794 You can create your own Info directory. You can tell Emacs where that
795 Info directory is by adding its pathname to the value of the variable
796 @code{Info-default-directory-list}. For example, to use a private Info
797 directory which is a subdirectory of your home directory named @file{Info},
798 you could put this in your @file{.emacs} file:
801 (add-to-list 'Info-default-directory-list "~/Info")
804 You will need a top-level Info file named @file{dir} in this directory
805 which has everything the system @file{dir} file has in it, except it
806 should list only entries for Info files in that directory. You might
807 not need it if (fortuitously) all files in this directory were
808 referenced by other @file{dir} files. The node lists from all
809 @file{dir} files in @code{Info-default-directory-list} are merged by the
814 @node Printing a Texinfo file
815 @section How do I print a Texinfo file?
816 @cindex Printing a Texinfo file
817 @cindex Texinfo file, printing
818 @cindex Printing documentation
820 You can't get nicely printed output from Info files; you must still have
821 the original Texinfo source file for the manual you want to print.
823 Assuming you have @TeX{} installed on your system, follow these steps:
828 Make sure the first line of the Texinfo file looks like this:
834 You may need to change @samp{texinfo} to the full pathname of the
835 @file{texinfo.tex} file, which comes with Emacs as
836 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
839 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
840 the name of the Texinfo source file for which you want to produce a
841 printed copy. The @samp{texi2dvi} script is part of the GNU Texinfo
844 Alternatively, @samp{texi2pdf} produces PDF files.
847 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
848 printing DVI files at your site. For example, if you have a PostScript
849 printer, run the @code{dvips} program to print the DVI file on that
854 To get more general instructions, retrieve the latest Texinfo package
855 (@pxref{Installing Texinfo documentation}).
857 @node Viewing Info files outside of Emacs
858 @section Can I view Info files without using Emacs?
859 @cindex Viewing Info files
860 @cindex Info file viewers
861 @cindex Alternative Info file viewers
863 Yes. Here are some alternative programs:
868 @code{info}, a stand-alone version of the Info program, comes as part of
869 the Texinfo package. @xref{Installing Texinfo documentation}, for
873 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
874 You can get Tkinfo at
875 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
879 @node Informational files for Emacs
880 @section What informational files are available for Emacs?
881 @cindex Informational files included with Emacs
882 @cindex Files included with Emacs
883 @cindex @file{COPYING}, description of file
884 @cindex @file{DISTRIB}, description of file
885 @cindex @file{GNU}, description of file
886 @cindex @file{INTERVIEW}, description of file
887 @cindex @file{MACHINES}, description of file
888 @cindex @file{MAILINGLISTS}, description of file
889 @cindex @file{NEWS}, description of file
891 This isn't a frequently asked question, but it should be! A variety of
892 informational files about Emacs and relevant aspects of the GNU project
893 are available for you to read.
895 The following files (and others) are available in the @file{etc}
896 directory of the Emacs distribution (see @ref{File-name conventions}, if
897 you're not sure where that is). Many of these files are available via
898 the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
904 GNU General Public License
907 Emacs Availability Information
913 Richard Stallman discusses his public-domain UNIX-compatible software
914 system with BYTE editors
917 Status of Emacs on Various Machines and Systems
920 GNU Project Electronic Mailing Lists
923 Emacs news, a history of recent user-visible changes
927 More GNU information, including back issues of the @cite{GNU's
930 @uref{http://www.gnu.org/bulletins/bulletins.html} and
932 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
934 @node Help installing Emacs
935 @section Where can I get help in installing Emacs?
936 @cindex Installation help
937 @cindex Help installing Emacs
939 @xref{Installing Emacs}, for some basic installation hints, and see
940 @ref{Problems building Emacs}, if you have problems with the installation.
942 @uref{http://www.fsf.org/resources/service/, The GNU Service directory}
943 lists companies and individuals willing to sell you help in installing
944 or using Emacs and other GNU software.
946 @node Obtaining the FAQ
947 @section Where can I get the latest version of this FAQ?
948 @cindex FAQ, obtaining the
949 @cindex Latest FAQ version, obtaining the
951 The Emacs FAQ is distributed with Emacs in Info format. You can read it
952 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
953 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
954 C-f} (@kbd{M-x view-emacs-FAQ}). The very latest version is available
955 in the Emacs development repository (@pxref{Latest version of Emacs}).
957 @c ------------------------------------------------------------
958 @node Status of Emacs
959 @chapter Status of Emacs
960 @cindex Status of Emacs
962 This chapter gives you basic information about Emacs, including the
963 status of its latest version.
966 * Origin of the term Emacs::
967 * Latest version of Emacs::
974 @node Origin of the term Emacs
975 @section Where does the name ``Emacs'' come from?
976 @cindex Origin of the term ``Emacs''
977 @cindex Emacs name origin
979 @cindex Original version of Emacs
981 Emacs originally was an acronym for Editor MACroS. RMS says he ``picked
982 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
983 the time.'' The first Emacs was a set of macros written in 1976 at MIT
984 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
985 Editor and COrrector) under ITS (the Incompatible Timesharing System) on
986 a PDP-10. RMS had already extended TECO with a ``real-time''
987 full-screen mode with reprogrammable keys. Emacs was started by
988 @email{gls@@east.sun.com, Guy Steele} as a project to unify the many
989 divergent TECO command sets and key bindings at MIT, and completed by
992 Many people have said that TECO code looks a lot like line noise; you
993 can read more at @uref{news:alt.lang.teco}. Someone has written a TECO
994 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
995 come with Emacs}); it would be an interesting project to run the
996 original TECO Emacs inside of Emacs.
999 For some not-so-serious alternative reasons for Emacs to have that
1000 name, check out the file @file{etc/JOKES} (@pxref{File-name
1003 @node Latest version of Emacs
1004 @section What is the latest version of Emacs?
1005 @cindex Version, latest
1006 @cindex Latest version of Emacs
1007 @cindex Development, Emacs
1008 @cindex Repository, Emacs
1009 @cindex Bazaar repository, Emacs
1011 Emacs @value{EMACSVER} is the current version as of this writing. A version
1012 number with two components (e.g. @samp{22.1}) indicates a released
1013 version; three components indicate a development
1014 version (e.g. @samp{23.0.50} is what will eventually become @samp{23.1}).
1016 Emacs is under active development, hosted at
1017 @uref{http://savannah.gnu.org/projects/emacs/, Savannah}. The source
1018 code can be retrieved anonymously following the
1019 @uref{http://savannah.gnu.org/bzr/?group=emacs, instructions}.
1020 The repository is GNU Bazaar.
1022 Because Emacs undergoes many changes before a release, the version
1023 number of a development version is not especially meaningful. It is
1024 better to refer to the date on which the sources were retrieved from the
1025 development repository. The development version is usually quite robust
1026 for every-day use, but if stability is more important to you than the
1027 latest features, you may want to stick to the releases.
1029 The following sections list some of the major new features in the last
1030 few Emacs releases. For full details of the changes in any version of
1031 Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}). As of Emacs 22,
1032 you can give this command a prefix argument to read about which features
1033 were new in older versions.
1035 @node New in Emacs 23
1036 @section What is different about Emacs 23?
1037 @cindex Differences between Emacs 22 and Emacs 23
1038 @cindex Emacs 23, new features in
1039 @cindex Recently introduced features
1040 @cindex Default features
1044 @cindex Anti-aliased fonts
1045 @cindex Freetype fonts
1047 Emacs has a new font code that can use multiple font backends,
1048 including freetype and fontconfig. Emacs can use the Xft library for
1049 anti-aliasing, and the otf and m17n libraries for complex text layout and
1053 @cindex Character sets
1055 The Emacs character set is now a superset of Unicode. Several new
1056 language environments have been added.
1058 @cindex Multi-tty support
1059 @cindex X and tty displays
1061 Emacs now supports using both X displays and ttys in the same session
1066 Emacs can be started as a daemon in the background.
1068 @cindex NeXTSTEP port
1069 @cindex GNUstep port
1070 @cindex Mac OS X Cocoa
1072 There is a new NeXTSTEP port of Emacs. This supports GNUstep and Mac OS
1073 X (via the Cocoa libraries). The Carbon port of Emacs, which supported
1074 Mac OS X in Emacs 22, has been removed.
1076 @cindex Directory-local variables
1078 Directory-local variables can now be defined, in a similar manner to
1079 file-local variables.
1082 Transient Mark mode (@pxref{Highlighting a region}) is on by default.
1087 Other changes include: support for serial port access; D-Bus bindings; a
1088 new Visual Line mode for line-motion; improved completion; a new mode
1089 (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML
1090 mode (for editing XML documents) is included; VC has been updated for
1091 newer version control systems; etc. As always, consult the @file{NEWS}
1092 file for more information.
1095 @node New in Emacs 22
1096 @section What is different about Emacs 22?
1097 @cindex Differences between Emacs 21 and Emacs 22
1098 @cindex Emacs 22, new features in
1101 @cindex GTK+ Toolkit
1102 @cindex Drag-and-drop
1104 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1107 @cindex Supported systems
1109 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1110 machines, as well as support for the Mac OS X and Cygwin operating
1114 The native MS-Windows, and Mac OS X builds include full support
1115 for images, toolbar, and tooltips.
1118 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1122 The maximum size of buffers is increased: on 32-bit machines, it is
1123 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above.
1126 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1130 Mouse wheel support is enabled by default.
1133 Window fringes are customizable.
1136 The mode line of the selected window is now highlighted.
1139 The minibuffer prompt is displayed in a distinct face.
1142 Abbrev definitions are read automatically at startup.
1145 Grep mode is separate from Compilation mode and has many new options and
1146 commands specific to grep.
1149 The original Emacs macro system has been replaced by the new Kmacro
1150 package, which provides many new commands and features and a simple
1151 interface that uses the function keys F3 and F4. Macros are stored in a
1152 macro ring, and can be debugged and edited interactively.
1155 The Grand Unified Debugger (GUD) can be used with a full graphical user
1156 interface to GDB; this provides many features found in traditional
1157 development environments, making it easy to manipulate breakpoints, add
1158 watch points, display the call stack, etc. Breakpoints are visually
1159 indicated in the source buffer.
1163 Many new modes and packages have been included in Emacs, such as Calc,
1164 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1165 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1166 savehist, Conf mode, Python mode, DNS mode, etc.
1168 @cindex Multilingual Environment
1170 Leim is now part of Emacs. Unicode support has been much improved, and
1171 the following input methods have been added: belarusian, bulgarian-bds,
1172 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1173 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1174 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1175 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1176 ukrainian-computer, vietnamese-telex, and welsh.
1178 The following language environments have also been added: Belarusian,
1179 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1180 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1181 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1183 @cindex Documentation
1184 @cindex Emacs Lisp Manual
1186 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1187 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1191 @node New in Emacs 21
1192 @section What is different about Emacs 21?
1193 @cindex Differences between Emacs 20 and Emacs 21
1194 @cindex Emacs 21, new features in
1196 @cindex Variable-size fonts
1197 @cindex Toolbar support
1198 Emacs 21 features a thorough rewrite of the display engine. The new
1199 display engine supports variable-size fonts, images, and can play sounds
1200 on platforms which support that. As a result, the visual appearance of
1201 Emacs, when it runs on a windowed display, is much more reminiscent of
1202 modern GUI programs, and includes 3D widgets (used for the mode line and
1203 the scroll bars), a configurable and extensible toolbar, tooltips
1204 (a.k.a.@: balloon help), and other niceties.
1206 @cindex Colors on text-only terminals
1208 In addition, Emacs 21 supports faces on text-only terminals. This means
1209 that you can now have colors when you run Emacs on a GNU/Linux console
1210 and on @code{xterm} with @kbd{emacs -nw}.
1213 @node New in Emacs 20
1214 @section What is different about Emacs 20?
1215 @cindex Differences between Emacs 19 and Emacs 20
1216 @cindex Emacs 20, new features in
1218 The differences between Emacs versions 18 and 19 were rather dramatic;
1219 the introduction of frames, faces, and colors on windowing systems was
1220 obvious to even the most casual user.
1222 There are differences between Emacs versions 19 and 20 as well, but many
1223 are more subtle or harder to find. Among the changes are the inclusion
1224 of MULE code for languages that use non-Latin characters and for mixing
1225 several languages in the same document; the ``Customize'' facility for
1226 modifying variables without having to use Lisp; and automatic conversion
1227 of files from Macintosh, Microsoft, and Unix platforms.
1229 @c ------------------------------------------------------------
1230 @node Common requests
1231 @chapter Common requests
1232 @cindex Common requests
1235 * Setting up a customization file::
1238 * Debugging a customization file::
1239 * Displaying the current line or column::
1240 * Displaying the current file name in the titlebar::
1241 * Turning on abbrevs by default::
1242 * Associating modes with files::
1243 * Highlighting a region::
1244 * Replacing highlighted text::
1245 * Controlling case sensitivity::
1246 * Working with unprintable characters::
1247 * Searching for/replacing newlines::
1248 * Yanking text in isearch::
1249 * Wrapping words automatically::
1250 * Turning on auto-fill by default::
1251 * Changing load-path::
1252 * Using an already running Emacs process::
1253 * Compiler error messages::
1254 * Indenting switch statements::
1255 * Customizing C and C++ indentation::
1256 * Horizontal scrolling::
1258 * Turning off beeping::
1259 * Turning the volume down::
1260 * Automatic indentation::
1261 * Matching parentheses::
1262 * Hiding #ifdef lines::
1263 * Repeating commands::
1264 * Valid X resources::
1265 * Evaluating Emacs Lisp code::
1266 * Changing the length of a Tab::
1267 * Inserting text at the beginning of each line::
1268 * Forcing the cursor to remain in the same column::
1269 * Forcing Emacs to iconify itself::
1270 * Using regular expressions::
1271 * Replacing text across multiple files::
1272 * Documentation for etags::
1273 * Disabling backups::
1274 * Disabling auto-save-mode::
1275 * Going to a line by number::
1276 * Modifying pull-down menus::
1277 * Deleting menus and menu options::
1278 * Turning on syntax highlighting::
1279 * Scrolling only one line::
1280 * Editing MS-DOS files::
1281 * Filling paragraphs with a single space::
1282 * Escape sequences in shell output::
1283 * Fullscreen mode on MS-Windows::
1286 @node Setting up a customization file
1287 @section How do I set up a @file{.emacs} file properly?
1288 @cindex @file{.emacs} file, setting up
1289 @cindex @file{.emacs} file, locating
1290 @cindex Init file, setting up
1291 @cindex Customization file, setting up
1293 @inforef{Init File, Init File, emacs}.
1295 In general, new Emacs users should not be provided with @file{.emacs}
1296 files, because this can cause confusing non-standard behavior. Then
1297 they send questions to @email{help-gnu-emacs@@gnu.org} asking why Emacs
1298 isn't behaving as documented.
1300 Emacs includes the Customize facility (@pxref{Using Customize}). This
1301 allows users who are unfamiliar with Emacs Lisp to modify their
1302 @file{.emacs} files in a relatively straightforward way, using menus
1303 rather than Lisp code.
1305 While Customize might indeed make it easier to configure Emacs,
1306 consider taking a bit of time to learn Emacs Lisp and modifying your
1307 @file{.emacs} directly. Simple configuration options are described
1308 rather completely in @inforef{Init File, Init File, emacs}, for users
1309 interested in performing frequently requested, basic tasks.
1311 Sometimes users are unsure as to where their @file{.emacs} file should
1312 be found. Visiting the file as @file{~/.emacs} from Emacs will find
1315 @node Using Customize
1316 @section How do I start using Customize?
1317 @cindex Customize groups
1318 @cindex Customizing variables
1319 @cindex Customizing faces
1321 The main Customize entry point is @kbd{M-x customize @key{RET}}. This
1322 command takes you to a buffer listing all the available Customize
1323 groups. From there, you can access all customizable options and faces,
1324 change their values, and save your changes to your init file.
1325 @inforef{Easy Customization, Easy Customization, emacs}.
1327 If you know the name of the group in advance (e.g. ``shell''), use
1328 @kbd{M-x customize-group @key{RET}}.
1330 If you wish to customize a single option, use @kbd{M-x customize-option
1331 @key{RET}}. This command prompts you for the name of the option to
1332 customize, with completion.
1334 @node Colors on a TTY
1335 @section How do I get colors and syntax highlighting on a TTY?
1336 @cindex Colors on a TTY
1337 @cindex Syntax highlighting on a TTY
1338 @cindex Console, colors
1340 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1341 i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when
1342 invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were
1343 supported in the MS-DOS port since Emacs 19.29.) Emacs automatically
1344 detects color support at startup and uses it if available. If you think
1345 that your terminal supports colors, but Emacs won't use them, check the
1346 @code{termcap} entry for your display type for color-related
1349 The command @kbd{M-x list-colors-display} pops up a window which
1350 exhibits all the colors Emacs knows about on the current display.
1352 Syntax highlighting is on by default since version 22.1.
1354 @node Debugging a customization file
1355 @section How do I debug a @file{.emacs} file?
1356 @cindex Debugging @file{.emacs} file
1357 @cindex @file{.emacs} debugging
1358 @cindex Init file debugging
1359 @cindex @samp{-debug-init} option
1361 Start Emacs with the @samp{-debug-init} command-line option. This
1362 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1363 file, and places you in the debugger if something goes wrong. The top
1364 line in the @file{trace-back} buffer will be the error message, and the
1365 second or third line of that buffer will display the Lisp code from your
1366 @file{.emacs} file that caused the problem.
1368 You can also evaluate an individual function or argument to a function
1369 in your @file{.emacs} file by moving the cursor to the end of the
1370 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1373 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1374 variables which you are trying to set or use.
1376 @node Displaying the current line or column
1377 @section How do I make Emacs display the current line (or column) number?
1378 @cindex @code{line-number-mode}
1379 @cindex Displaying the current line or column
1380 @cindex Line number, displaying the current
1381 @cindex Column, displaying the current
1382 @cindex @code{mode-line-format}
1384 By default, Emacs displays the current line number of the point in the
1385 mode line. You can toggle this feature off or on with the command
1386 @kbd{M-x line-number-mode}, or by setting the variable
1387 @code{line-number-mode}. Note that Emacs will not display the line
1388 number if the buffer's size in bytes is larger than the value of the
1389 variable @code{line-number-display-limit}.
1391 You can similarly display the current column with
1392 @kbd{M-x column-number-mode}, or by putting the form
1395 (setq column-number-mode t)
1399 in your @file{.emacs} file. This feature is off by default.
1401 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1402 will insert the current column's value into the mode line. See the
1403 documentation for @code{mode-line-format} (using @kbd{C-h v
1404 mode-line-format @key{RET}}) for more information on how to set and use
1407 @cindex Set number capability in @code{vi} emulators
1408 The @samp{linum} package (distributed with Emacs since version 23.1)
1409 displays line numbers in the left margin, like the ``set number''
1410 capability of @code{vi}. The packages @samp{setnu} and
1411 @samp{wb-line-number} (not distributed with Emacs) also implement this
1414 @node Displaying the current file name in the titlebar
1415 @section How can I modify the titlebar to contain the current file name?
1416 @cindex Titlebar, displaying the current file name in
1417 @cindex File name, displaying in the titlebar
1418 @cindex @code{frame-title-format}
1420 The contents of an Emacs frame's titlebar is controlled by the variable
1421 @code{frame-title-format}, which has the same structure as the variable
1422 @code{mode-line-format}. (Use @kbd{C-h v} or @kbd{M-x
1423 describe-variable} to get information about one or both of these
1426 By default, the titlebar for a frame does contain the name of the buffer
1427 currently being visited, except if there is a single frame. In such a
1428 case, the titlebar contains Emacs invocation name and the name of the
1429 machine at which Emacs was invoked. This is done by setting
1430 @code{frame-title-format} to the default value of
1433 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1436 To modify the behavior such that frame titlebars contain the buffer's
1437 name regardless of the number of existing frames, include the following
1438 in your @file{.emacs}:
1441 (setq frame-title-format "%b")
1444 @node Turning on abbrevs by default
1445 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1446 @cindex Abbrevs, turning on by default
1448 Abbrev mode expands abbreviations as you type them. To turn it on in a
1449 specific buffer, use @kbd{M-x abbrev-mode}. To turn it on in every
1450 buffer by default, put this in your @file{.emacs} file:
1453 (setq-default abbrev-mode t)
1456 @noindent To turn it on in a specific mode, use:
1459 (add-hook '@var{mymode}-mode-hook
1461 (setq abbrev-mode t)))
1464 @noindent If your Emacs version is older then 22.1, you will also need to use:
1468 (quietly-read-abbrev-file)
1472 @node Associating modes with files
1473 @section How do I make Emacs use a certain major mode for certain files?
1474 @cindex Associating modes with files
1475 @cindex File extensions and modes
1476 @cindex @code{auto-mode-alist}, modifying
1477 @cindex Modes, associating with file extensions
1479 If you want to use a certain mode @var{foo} for all files whose names end
1480 with the extension @file{.@var{bar}}, this will do it for you:
1483 (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode))
1486 Alternatively, put this somewhere in the first line of any file you want to
1487 edit in the mode @var{foo} (in the second line, if the first line begins
1494 @cindex Major mode for shell scripts
1495 The variable @code{interpreter-mode-alist} specifies which mode to use
1496 when loading an interpreted script (e.g. shell, python, etc.). Emacs
1497 determines which interpreter you're using by examining the first line of
1498 the script. Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
1499 @code{interpreter-mode-alist} to learn more.
1501 @node Highlighting a region
1502 @section How can I highlight a region of text in Emacs?
1503 @cindex Highlighting text
1504 @cindex Text, highlighting
1505 @cindex @code{transient-mark-mode}
1506 @cindex Region, highlighting a
1508 You can cause the region to be highlighted when the mark is active by
1512 (transient-mark-mode 1)
1516 in your @file{.emacs} file. Since Emacs 23.1, this feature is on by default.
1518 @node Replacing highlighted text
1519 @section How can I replace highlighted text with what I type?
1520 @cindex @code{delete-selection-mode}
1521 @cindex Replacing highlighted text
1522 @cindex Highlighting and replacing text
1524 Use @code{delete-selection-mode}, which you can start automatically by
1525 placing the following Lisp form in your @file{.emacs} file:
1528 (delete-selection-mode 1)
1531 According to the documentation string for @code{delete-selection-mode}
1532 (which you can read using @kbd{M-x describe-function @key{RET}
1533 delete-selection-mode @key{RET}}):
1536 When Delete Selection mode is enabled, Transient Mark mode is also
1537 enabled and typed text replaces the selection if the selection is
1538 active. Otherwise, typed text is just inserted at point regardless of
1542 This mode also allows you to delete (not kill) the highlighted region by
1545 @node Controlling case sensitivity
1546 @section How do I control Emacs's case-sensitivity when searching/replacing?
1547 @cindex @code{case-fold-search}
1548 @cindex Case sensitivity of searches
1549 @cindex Searching without case sensitivity
1550 @cindex Ignoring case in searches
1553 The value of the variable @code{case-fold-search} determines whether
1554 searches are case sensitive:
1557 (setq case-fold-search nil) ; make searches case sensitive
1558 (setq case-fold-search t) ; make searches case insensitive
1561 @cindex Case sensitivity in replacements
1562 @cindex Replacing, and case sensitivity
1563 @cindex @code{case-replace}
1564 Similarly, for replacing, the variable @code{case-replace} determines
1565 whether replacements preserve case.
1567 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1569 To change the case sensitivity just for one major mode, use the major
1570 mode's hook. For example:
1573 (add-hook '@var{foo}-mode-hook
1575 (setq case-fold-search nil)))
1578 @node Working with unprintable characters
1579 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1580 @cindex Unprintable characters, working with
1581 @cindex Working with unprintable characters
1582 @cindex Control characters, working with
1583 @cindex Eight-bit characters, working with
1584 @cindex Searching for unprintable characters
1585 @cindex Regexps and unprintable characters
1587 To search for a single character that appears in the buffer as, for
1588 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.
1589 Searching for @strong{all} unprintable characters is best done with a
1590 regular expression (@dfn{regexp}) search. The easiest regexp to use for
1591 the unprintable chars is the complement of the regexp for the printable
1597 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1600 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1604 To type these special characters in an interactive argument to
1605 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1606 use @kbd{C-q}. (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1607 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.) So,
1608 to search for unprintable characters using @code{re-search-forward}:
1610 @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}}
1612 Using @code{isearch-forward-regexp}:
1614 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1616 To delete all unprintable characters, simply use replace-regexp:
1618 @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}}
1620 Replacing is similar to the above. To replace all unprintable
1621 characters with a colon, use:
1623 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}
1625 @node Searching for/replacing newlines
1626 @section How do I input a newline character in isearch or query-replace?
1627 @cindex Searching for newlines
1628 @cindex Replacing newlines
1630 Use @kbd{C-q C-j}. For more information, see @inforef{Special Isearch,
1631 Special Input for Incremental Search, emacs}.
1634 @node Yanking text in isearch
1635 @section How do I copy text from the kill ring into the search string?
1636 @cindex Yanking text into the search string
1637 @cindex isearch yanking
1639 Use @kbd{M-y}. @inforef{Isearch Yank, Isearch Yanking, emacs}.
1641 @node Wrapping words automatically
1642 @section How do I make Emacs wrap words for me?
1643 @cindex Wrapping word automatically
1644 @cindex Wrapping lines
1646 @cindex @code{auto-fill-mode}, introduction to
1647 @cindex Maximum line width, default value
1648 @cindex @code{fill-column}, default value
1650 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1651 The default maximum line width is 70, determined by the variable
1652 @code{fill-column}. To learn how to turn this on automatically, see
1653 @ref{Turning on auto-fill by default}.
1655 @node Turning on auto-fill by default
1656 @section How do I turn on @code{auto-fill-mode} by default?
1657 @cindex @code{auto-fill-mode}, activating automatically
1658 @cindex Filling automatically
1659 @cindex Automatic entry to @code{auto-fill-mode}
1661 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1664 To turn it on for every buffer in a certain mode, you must use the hook
1665 for that mode. For example, to turn on @code{auto-fill} mode for all
1666 text buffers, including the following in your @file{.emacs} file:
1669 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1672 If you want @code{auto-fill} mode on in all major modes, do this:
1675 (setq-default auto-fill-function 'do-auto-fill)
1678 @node Changing load-path
1679 @section How do I change @code{load-path}?
1680 @cindex @code{load-path}, modifying
1681 @cindex Modifying @code{load-path}
1682 @cindex Adding to @code{load-path}
1684 In general, you should only add to the @code{load-path}. You can add
1685 directory @var{/dir/subdir} to the load path like this:
1688 (add-to-list 'load-path "/dir/subdir/")
1691 To do this relative to your home directory:
1694 (add-to-list 'load-path "~/mysubdir/")
1697 @node Using an already running Emacs process
1698 @section How do I use an already running Emacs from another window?
1699 @cindex @code{emacsclient}
1700 @cindex Emacs server functions
1701 @cindex Using an existing Emacs process
1703 @code{emacsclient}, which comes with Emacs, is for editing a file using
1704 an already running Emacs rather than starting up a new Emacs. It does
1705 this by sending a request to the already running Emacs, which must be
1706 expecting the request.
1713 Emacs must have executed the @code{server-start} function for
1714 @samp{emacsclient} to work. This can be done either by a command line
1718 emacs -f server-start
1721 or by invoking @code{server-start} from @file{.emacs}:
1724 (if (@var{some conditions are met}) (server-start))
1727 When this is done, Emacs creates a Unix domain socket named
1728 @file{server} in @file{/tmp/emacs@var{userid}}. See
1729 @code{server-socket-dir}.
1731 To get your news reader, mail reader, etc., to invoke
1732 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1733 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}. You may
1734 have to specify the full pathname of the @samp{emacsclient} program
1739 setenv EDITOR emacsclient
1741 # using full pathname
1742 setenv EDITOR /usr/local/emacs/etc/emacsclient
1745 EDITOR=emacsclient ; export EDITOR
1751 When @samp{emacsclient} is run, it connects to the socket and passes its
1752 command line options to Emacs, which at the next opportunity will visit
1753 the files specified. (Line numbers can be specified just like with
1754 Emacs.) The user will have to switch to the Emacs window by hand. When
1755 the user is done editing a file, the user can type @kbd{C-x #} (or
1756 @kbd{M-x server-edit}) to indicate this. If there is another buffer
1757 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1758 @code{emacsclient} will exit, signaling the calling program to continue.
1760 @cindex @code{gnuserv}
1761 There is an alternative version of @samp{emacsclient} called
1762 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman}
1763 (@pxref{Packages that do not come with Emacs}). @samp{gnuserv} uses
1764 Internet domain sockets, so it can work across most network connections.
1766 The most recent @samp{gnuserv} package is available at
1768 @uref{http://meltin.net/hacks/emacs/}
1772 @node Compiler error messages
1773 @section How do I make Emacs recognize my compiler's funny error messages?
1774 @cindex Compiler error messages, recognizing
1775 @cindex Recognizing non-standard compiler errors
1776 @cindex Regexps for recognizing compiler errors
1777 @cindex Errors, recognizing compiler
1779 Customize the @code{compilation-error-regexp-alist} variable.
1781 @node Indenting switch statements
1782 @section How do I change the indentation for @code{switch}?
1783 @cindex @code{switch}, indenting
1784 @cindex Indenting of @code{switch}
1786 Many people want to indent their @code{switch} statements like this:
1804 @noindent To achieve this, add the following line to your @file{.emacs}:
1807 (c-set-offset 'case-label '+)
1810 @node Customizing C and C++ indentation
1811 @section How to customize indentation in C, C@t{++}, and Java buffers?
1812 @cindex Indentation, how to customize
1813 @cindex Customize indentation
1815 The Emacs @code{cc-mode} features an interactive procedure for
1816 customizing the indentation style, which is fully explained in the
1817 @cite{CC Mode} manual that is part of the Emacs distribution, see
1818 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1819 The CC Mode Manual}. Here's a short summary of the procedure:
1823 Go to the beginning of the first line where you don't like the
1824 indentation and type @kbd{C-c C-o}. Emacs will prompt you for the
1825 syntactic symbol; type @key{RET} to accept the default it suggests.
1828 Emacs now prompts for the offset of this syntactic symbol, showing the
1829 default (the current definition) inside parentheses. You can choose
1834 No extra indentation.
1836 Indent one basic offset.
1838 Outdent one basic offset.
1840 Indent two basic offsets
1842 Outdent two basic offsets.
1844 Indent half basic offset.
1846 Outdent half basic offset.
1850 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1851 the line or the block according to what you just specified.
1854 If you don't like the result, go back to step 1. Otherwise, add the
1855 following line to your @file{.emacs}:
1858 (c-set-offset '@var{syntactic-symbol} @var{offset})
1862 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1863 when you type @kbd{C-c C-o} at the beginning of the line, and
1864 @var{offset} is one of the indentation symbols listed above (@code{+},
1865 @code{/}, @code{0}, etc.) that you've chosen during the interactive
1869 Go to the next line whose indentation is not to your liking and repeat
1873 It is recommended to put all the resulting @code{(c-set-offset ...)}
1874 customizations inside a C mode hook, like this:
1877 (defun my-c-mode-hook ()
1880 (add-hook 'c-mode-hook 'my-c-mode-hook)
1884 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1885 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1886 might be unavailable when @code{cc-mode} is not loaded.
1888 Note that @code{c-mode-hook} runs for C source files only; use
1889 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1890 Java sources, etc. If you want the same customizations to be in
1891 effect in @emph{all} languages supported by @code{cc-mode}, use
1892 @code{c-mode-common-hook}.
1894 @node Horizontal scrolling
1895 @section How can I make Emacs automatically scroll horizontally?
1896 @cindex @code{hscroll-mode}
1897 @cindex Horizontal scrolling
1898 @cindex Scrolling horizontally
1900 In Emacs 21 and later, this is on by default: if the variable
1901 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1902 automatically scrolls the display horizontally when point moves off the
1903 left or right edge of the window.
1905 Note that this is overridden by the variable
1906 @code{truncate-partial-width-windows} if that variable is non-nil
1907 and the current buffer is not full-frame width.
1909 In Emacs 20, use @code{hscroll-mode}.
1911 @node Overwrite mode
1912 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
1913 @cindex @key{Insert}
1914 @cindex @code{overwrite-mode}
1915 @cindex Overwriting existing text
1916 @cindex Toggling @code{overwrite-mode}
1918 @kbd{M-x overwrite-mode} (a minor mode). This toggles
1919 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1920 is as easy as another @kbd{M-x overwrite-mode}.
1922 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1924 @node Turning off beeping
1925 @section How do I stop Emacs from beeping on a terminal?
1926 @cindex Beeping, turning off
1927 @cindex Visible bell
1928 @cindex Bell, visible
1930 @email{martin@@cc.gatech.edu, Martin R. Frank} writes:
1932 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1933 and set the visible bell to nothing.
1935 That is, put the following in your @code{TERMCAP} environment variable
1936 (assuming you have one):
1942 And evaluate the following Lisp form:
1945 (setq visible-bell t)
1948 @node Turning the volume down
1949 @section How do I turn down the bell volume in Emacs running under X?
1950 @cindex Bell, volume of
1951 @cindex Volume of bell
1953 On X Window system, you can adjust the bell volume and duration for all
1954 programs with the shell command @code{xset}.
1956 Invoking @code{xset} without any arguments produces some basic
1957 information, including the following:
1960 usage: xset [-display host:dpy] option ...
1963 To set bell volume, pitch and duration:
1964 b [vol [pitch [dur]]] b on
1967 @node Automatic indentation
1968 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
1969 @cindex Indenting new lines
1970 @cindex New lines, indenting of
1971 @cindex Previous line, indenting according to
1972 @cindex Text indentation
1974 Such behavior is automatic (in Text mode) in Emacs 20 and later. From the
1975 @file{etc/NEWS} file for Emacs 20.2:
1978 ** In Text mode, now only blank lines separate paragraphs. This makes
1979 it possible to get the full benefit of Adaptive Fill mode in Text mode,
1980 and other modes derived from it (such as Mail mode). @key{TAB} in Text
1981 mode now runs the command @code{indent-relative}; this makes a practical
1982 difference only when you use indented paragraphs.
1984 If you want spaces at the beginning of a line to start a paragraph, use
1985 the new mode, Paragraph Indent Text mode.
1988 @cindex Prefixing lines
1990 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
1991 by default}), you can tell Emacs to prefix every line with a certain
1992 character sequence, the @dfn{fill prefix}. Type the prefix at the
1993 beginning of a line, position point after it, and then type @kbd{C-x .}
1994 (@code{set-fill-prefix}) to set the fill prefix. Thereafter,
1995 auto-filling will automatically put the fill prefix at the beginning of
1996 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
1997 prefix when refilling the paragraph.
1999 If you have paragraphs with different levels of indentation, you will
2000 have to set the fill prefix to the correct value each time you move to a
2001 new paragraph. There are many packages available to deal with this
2002 (@pxref{Packages that do not come with Emacs}). Look for ``fill'' and
2003 ``indent'' keywords for guidance.
2005 @node Matching parentheses
2006 @section How do I show which parenthesis matches the one I'm looking at?
2007 @cindex Parentheses, matching
2008 @cindex @file{paren.el}
2009 @cindex Highlighting matching parentheses
2010 @cindex Pairs of parentheses, highlighting
2011 @cindex Matching parentheses
2013 Call @code{show-paren-mode} in your @file{.emacs} file:
2019 You can also enable this mode by selecting the @samp{Paren Match
2020 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
2021 at the top of any Emacs frame.
2023 Alternatives to this mode include:
2028 If you're looking at a right parenthesis (or brace or bracket) you can
2029 delete it and reinsert it. Emacs will momentarily move the cursor to
2030 the matching parenthesis.
2033 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2034 will skip over one set of balanced parentheses, so you can see which
2035 parentheses match. (You can train it to skip over balanced brackets
2036 and braces at the same time by modifying the syntax table.)
2038 @cindex Show matching paren as in @code{vi}
2040 Here is some Emacs Lisp that will make the @key{%} key show the matching
2041 parenthesis, like in @code{vi}. In addition, if the cursor isn't over a
2042 parenthesis, it simply inserts a % like normal.
2045 ;; By an unknown contributor
2047 (global-set-key "%" 'match-paren)
2049 (defun match-paren (arg)
2050 "Go to the matching paren if on a paren; otherwise insert %."
2052 (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2053 ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2054 (t (self-insert-command (or arg 1)))))
2059 @node Hiding #ifdef lines
2060 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2061 @cindex @code{#ifdef}, selective display of
2062 @cindex @code{hide-ifdef-mode}
2063 @cindex Hiding @code{#ifdef} text
2064 @cindex Selectively displaying @code{#ifdef} code
2066 @kbd{M-x hide-ifdef-mode}. (This is a minor mode.) You might also want
2067 to investigate @file{cpp.el}, which is distributed with Emacs.
2069 @node Repeating commands
2070 @section How do I repeat a command as many times as possible?
2071 @cindex Repeating commands many times
2072 @cindex Commands, repeating many times
2073 @cindex @code{.}, equivalent to @code{vi} command
2075 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2076 that repeats the last command. If you preface it with a prefix
2077 argument, the prefix arg is applied to the command.
2079 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2080 (@code{repeat-complex-command}) to reinvoke commands that used the
2081 minibuffer to get arguments. In @code{repeat-complex-command} you can
2082 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2083 keyboard has these keys) to scan through all the different complex
2084 commands you've typed.
2086 To repeat a set of commands, use keyboard macros. Use @kbd{C-x (} and
2087 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2088 type @kbd{C-x e}. (@inforef{Keyboard Macros, Keyboard Macros, emacs}.)
2090 If you're really desperate for the @code{.} command in @code{vi} that
2091 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2092 mode which comes with Emacs, and which appears to support it.
2094 @node Valid X resources
2095 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2096 @cindex Resources, X
2098 @cindex Setting X resources
2100 @inforef{X Resources, X Resources, emacs}.
2102 You can also use a resource editor, such as editres (for X11R5 and
2103 onwards), to look at the resource names for the menu bar, assuming Emacs
2104 was compiled with the X toolkit.
2106 @node Evaluating Emacs Lisp code
2107 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2108 @cindex Evaluating Lisp code
2109 @cindex Lisp forms, evaluating
2111 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2112 Emacs Lisp @dfn{form}:
2117 If you want it evaluated every time you run Emacs, put it in a file
2118 named @file{.emacs} in your home directory. This is known as ``your
2119 @file{.emacs} file,'' and contains all of your personal customizations.
2122 You can type the form in the @file{*scratch*} buffer, and then type
2123 @key{LFD} (or @kbd{C-j}) after it. The result of evaluating the form
2124 will be inserted in the buffer.
2127 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2128 before or around point.
2131 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2132 before point and prints its value in the echo area.
2135 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2136 form in the minibuffer which will be evaluated once you press @key{RET}.
2139 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2140 forms in a file. (To do this from Lisp use the function @code{load}
2143 The functions @code{load-library}, @code{eval-region},
2144 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2145 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2150 @node Changing the length of a Tab
2151 @section How do I change Emacs's idea of the @key{TAB} character's length?
2153 @cindex Length of tab character
2155 Set the default value of the variable @code{tab-width}. For example, to set
2156 @key{TAB} stops every 10 characters, insert the following in your
2160 (setq-default tab-width 10)
2163 Do not confuse variable @code{tab-width} with variable
2164 @code{tab-stop-list}. The former is used for the display of literal
2165 @key{TAB} characters. The latter controls what characters are inserted
2166 when you press the @key{TAB} character in certain modes.
2168 @node Inserting text at the beginning of each line
2169 @section How do I insert <some text> at the beginning of every line?
2170 @cindex Prefixing a region with some text
2171 @cindex Prefix character, inserting in mail/news replies
2172 @cindex Replies to mail/news, inserting a prefix character
2173 @cindex @code{mail-yank-prefix}
2174 @cindex Mail replies, inserting a prefix character
2175 @cindex News replies, inserting a prefix character
2177 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2178 @key{RET} ^ @key{RET} your text @key{RET}}.
2180 To do this to a region, use @code{string-insert-rectangle}.
2181 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2182 want to prefix, move the cursor to last line to be prefixed, and type
2183 @kbd{M-x string-insert-rectangle @key{RET}}. To do this for the whole
2184 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2186 If you are trying to prefix a yanked mail message with @samp{>}, you
2187 might want to set the variable @code{mail-yank-prefix}. In Message
2188 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2189 runs the function @code{comment-region}, it is a general-purpose
2190 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2192 @node Forcing the cursor to remain in the same column
2193 @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?
2194 @cindex @code{picture-mode}
2195 @cindex Remaining in the same column, regardless of contents
2196 @cindex Vertical movement in empty documents
2198 Use @kbd{M-x picture-mode}.
2200 See also the variable @code{track-eol} and the command
2201 @code{set-goal-column} bound to @kbd{C-x C-n}
2202 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2204 @node Forcing Emacs to iconify itself
2205 @section How do I tell Emacs to iconify itself?
2206 @cindex Iconification under the X Window System
2207 @cindex X Window System and iconification
2208 @cindex Suspending Emacs
2210 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2211 otherwise. @inforef{Frame Commands, Frame Commands, emacs}.
2213 @node Using regular expressions
2214 @section How do I use regexps (regular expressions) in Emacs?
2216 @cindex Regular expressions
2217 @cindex Differences between Unix and Emacs regexps
2218 @cindex Unix regexps, differences from Emacs
2219 @cindex Text strings, putting regexps in
2221 @inforef{Regexp Backslash, Regexp Backslash, emacs}.
2223 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2224 are @samp{\(} and @samp{\)}. Also, the string syntax for a backslash is
2225 @samp{\\}. To specify a regular expression like @samp{xxx\(foo\|bar\)}
2226 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2228 Note the doubled backslashes!
2233 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2234 (@samp{[^...]}) can match a newline character (@key{LFD} a.k.a.@:
2235 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2236 characters not to match.
2239 The character syntax regexps (e.g., @samp{\sw}) are not
2240 meaningful inside character set regexps (e.g., @samp{[aeiou]}). (This
2241 is actually typical for regexp syntax.)
2245 @node Replacing text across multiple files
2246 @section How do I perform a replace operation across more than one file?
2247 @cindex Replacing strings across files
2248 @cindex Multiple files, replacing across
2249 @cindex Files, replacing strings across multiple
2250 @cindex Recursive search/replace operations
2252 Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the
2253 command @code{dired-do-query-replace-regexp} (@kbd{Q}), which allows
2254 users to replace regular expressions in multiple files.
2256 You can use this command to perform search/replace operations on
2257 multiple files by following the following steps:
2261 Assemble a list of files you want to operate on with either
2262 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2265 Mark all files in the resulting Dired buffer using @kbd{t}.
2268 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2272 To accept all replacements in each file, hit @kbd{!}.
2275 Another way to do the same thing is to use the ``tags'' feature of
2276 Emacs: it includes the command @code{tags-query-replace} which performs
2277 a query-replace across all the files mentioned in the @file{TAGS} file.
2278 @inforef{Tags Search, Tags Search, emacs}.
2280 @node Documentation for etags
2281 @section Where is the documentation for @code{etags}?
2282 @cindex Documentation for @code{etags}
2283 @cindex @code{etags}, documentation for
2285 The @code{etags} man page should be in the same place as the
2286 @code{emacs} man page.
2288 Quick command-line switch descriptions are also available. For example,
2291 @node Disabling backups
2292 @section How do I disable backup files?
2293 @cindex Backups, disabling
2294 @cindex Disabling backups
2296 You probably don't want to do this, since backups are useful, especially
2297 when something goes wrong.
2299 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2300 load @code{dired-x} by adding the following to your @file{.emacs} file:
2303 (add-hook 'dired-load-hook
2305 (require 'dired-x)))
2308 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2309 You can make omitting the default for new dired buffers by putting the
2310 following in your @file{.emacs}:
2313 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2316 If you're tired of seeing backup files whenever you do an @samp{ls} at
2317 the Unix shell, try GNU @code{ls} with the @samp{-B} option. GNU
2318 @code{ls} is part of the GNU Fileutils package, available from
2319 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2321 To disable or change the way backups are made, @inforef{Backup Names, ,
2324 @cindex Backup files in a single directory
2325 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2326 by customizing the variable @code{backup-directory-alist}. This
2327 variable's value specifies that files whose names match specific patters
2328 should have their backups put in certain directories. A typical use is
2329 to add the element @code{("." . @var{dir})} to force Emacs to put
2330 @strong{all} backup files in the directory @file{dir}.
2332 @node Disabling auto-save-mode
2333 @section How do I disable @code{auto-save-mode}?
2334 @cindex Disabling @code{auto-save-mode}
2336 @cindex Saving at frequent intervals
2338 You probably don't want to do this, since auto-saving is useful,
2339 especially when Emacs or your computer crashes while you are editing a
2342 Instead, you might want to change the variable
2343 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2344 waits before auto-saving. Increasing this value forces Emacs to wait
2345 longer between auto-saves, which might annoy you less.
2347 You might also want to look into Sebastian Kremer's @code{auto-save}
2348 package (@pxref{Packages that do not come with Emacs}). This
2349 package also allows you to place all auto-save files in one directory,
2350 such as @file{/tmp}.
2352 To disable or change how @code{auto-save-mode} works, @inforef{Auto
2355 @node Going to a line by number
2356 @section How can I go to a certain line given its number?
2357 @cindex Going to a line by number
2358 @cindex Compilation error messages
2359 @cindex Recompilation
2361 Are you sure you indeed need to go to a line by its number? Perhaps all
2362 you want is to display a line in your source file for which a compiler
2363 printed an error message? If so, compiling from within Emacs using the
2364 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2365 effective way of doing that. Emacs automatically intercepts the compile
2366 error messages, inserts them into a special buffer called
2367 @code{*compilation*}, and lets you visit the locus of each message in
2368 the source. Type @kbd{C-x `} to step through the offending lines one by
2369 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2370 @kbd{M-g M-n} to go to the previous and next matches directly). Click
2371 @kbd{Mouse-2} or press @key{RET} on a message text in the
2372 @code{*compilation*} buffer to go to the line whose number is mentioned
2375 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2376 (which is the default binding of the @code{goto-line} function starting
2377 with Emacs 22). Emacs will prompt you for the number of the line and go
2380 You can do this faster by invoking @code{goto-line} with a numeric
2381 argument that is the line's number. For example, @kbd{C-u 286 M-g M-g}
2382 will jump to line number 286 in the current buffer.
2384 @node Modifying pull-down menus
2385 @section How can I create or modify new pull-down menu options?
2386 @cindex Pull-down menus, creating or modifying
2387 @cindex Menus, creating or modifying
2388 @cindex Creating new menu options
2389 @cindex Modifying pull-down menus
2390 @cindex Menus and keymaps
2391 @cindex Keymaps and menus
2393 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2394 represents a local or global keymap. Selecting a menu title with the
2395 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2397 So to add a menu option to an existing menu, all you have to do is add a
2398 new definition to the appropriate keymap. Adding a @samp{Forward Word}
2399 item to the @samp{Edit} menu thus requires the following Lisp code:
2402 (define-key global-map
2403 [menu-bar edit forward]
2404 '("Forward word" . forward-word))
2408 The first line adds the entry to the global keymap, which includes
2409 global menu bar entries. Replacing the reference to @code{global-map}
2410 with a local keymap would add this menu option only within a particular
2413 The second line describes the path from the menu-bar to the new entry.
2414 Placing this menu entry underneath the @samp{File} menu would mean
2415 changing the word @code{edit} in the second line to @code{file}.
2417 The third line is a cons cell whose first element is the title that will
2418 be displayed, and whose second element is the function that will be
2419 called when that menu option is invoked.
2421 To add a new menu, rather than a new option to an existing menu, we must
2422 define an entirely new keymap:
2425 (define-key global-map [menu-bar words]
2426 (cons "Words" (make-sparse-keymap "Words")))
2429 The above code creates a new sparse keymap, gives it the name
2430 @samp{Words}, and attaches it to the global menu bar. Adding the
2431 @samp{Forward Word} item to this new menu would thus require the
2435 (define-key global-map
2436 [menu-bar words forward]
2437 '("Forward word" . forward-word))
2441 Note that because of the way keymaps work, menu options are displayed
2442 with the more recently defined items at the top. Thus if you were to
2443 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2444 order), the menu option @samp{baz} would appear at the top, and
2445 @samp{foo} would be at the bottom.
2447 One way to avoid this problem is to use the function @code{define-key-after},
2448 which works the same as @code{define-key}, but lets you modify where items
2449 appear. The following Lisp code would insert the @samp{Forward Word}
2450 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2454 (lookup-key global-map [menu-bar edit])
2456 '("Forward word" . forward-word)
2460 Note how the second and third arguments to @code{define-key-after} are
2461 different from those of @code{define-key}, and that we have added a new
2462 (final) argument, the function after which our new key should be
2465 To move a menu option from one position to another, simply evaluate
2466 @code{define-key-after} with the appropriate final argument.
2468 More detailed information---and more examples of how to create and
2469 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2470 ``Menu Keymaps.'' (@xref{Emacs Lisp documentation}, for information on
2473 @node Deleting menus and menu options
2474 @section How do I delete menus and menu options?
2475 @cindex Deleting menus and menu options
2476 @cindex Menus, deleting
2478 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2479 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2483 (define-key global-map [menu-bar words] nil)
2486 Similarly, removing a menu option requires redefining a keymap entry to
2487 @code{nil}. For example, to delete the @samp{Forward word} menu option
2488 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2492 (define-key global-map [menu-bar edit forward] nil)
2495 @node Turning on syntax highlighting
2496 @section How do I turn on syntax highlighting?
2497 @cindex Syntax highlighting
2498 @cindex @code{font-lock-mode}
2499 @cindex Highlighting based on syntax
2500 @cindex Colorizing text
2501 @cindex FAQ, @code{font-lock-mode}
2503 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2504 highlighting in the current buffer. It is enabled by default in Emacs
2507 With @code{font-lock-mode} turned on, different types of text will
2508 appear in different colors. For instance, in a programming mode,
2509 variables will appear in one face, keywords in a second, and comments in
2512 To turn @code{font-lock-mode} off within an existing buffer, use
2513 @kbd{M-x font-lock-mode @key{RET}}.
2515 In Emacs 21 and earlier versions, you could use the following code in
2516 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2519 (global-font-lock-mode 1)
2522 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2523 and cause an annoying delay in display, so several features exist to
2526 @cindex Just-In-Time syntax highlighting
2527 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2528 activates the new @dfn{Just-In-Time fontification} provided by
2529 @code{jit-lock-mode}. @code{jit-lock-mode} defers the fontification of
2530 portions of buffer until you actually need to see them, and can also
2531 fontify while Emacs is idle. This makes display of the visible portion
2532 of a buffer almost instantaneous. For details about customizing
2533 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2535 @cindex Levels of syntax highlighting
2536 @cindex Decoration level, in @code{font-lock-mode}
2537 In versions of Emacs before 21, different levels of decoration are
2538 available, from slight to gaudy. More decoration means you need to wait
2539 more time for a buffer to be fontified (or a faster machine). To
2540 control how decorated your buffers should become, set the value of
2541 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2542 @code{nil} value indicating default (usually minimum) decoration, and a
2543 @code{t} value indicating the maximum decoration. For the gaudiest
2544 possible look, then, include the line
2547 (setq font-lock-maximum-decoration t)
2551 in your @file{.emacs} file. You can also set this variable such that
2552 different modes are highlighted in a different ways; for more
2553 information, see the documentation for
2554 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2555 describe-variable @key{RET}}).
2557 Also see the documentation for the function @code{font-lock-mode},
2558 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2559 describe-function @key{RET} font-lock-mode @key{RET}}).
2561 To print buffers with the faces (i.e., colors and fonts) intact, use
2562 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2563 ps-print-region-with-faces}. You will need a way to send text to a
2564 PostScript printer, or a PostScript interpreter such as Ghostscript;
2565 consult the documentation of the variables @code{ps-printer-name},
2566 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2568 @node Scrolling only one line
2569 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2570 @cindex Scrolling only one line
2571 @cindex Reducing the increment when scrolling
2573 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2574 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2575 to a large value like, say, 10000. For an explanation of what this
2576 means, @inforef{Auto Scrolling, Auto Scrolling, emacs}.
2578 Alternatively, use the following Lisp form in your @file{.emacs}:
2581 (setq scroll-conservatively most-positive-fixnum)
2584 @node Editing MS-DOS files
2585 @section How can I edit MS-DOS files using Emacs?
2586 @cindex Editing MS-DOS files
2587 @cindex MS-DOS files, editing
2588 @cindex Microsoft files, editing
2589 @cindex Windows files, editing
2591 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2592 performed transparently. You can open MS-DOS files on a Unix system,
2593 edit it, and save it without having to worry about the file format.
2595 When editing an MS-DOS style file, the mode line will indicate that it
2596 is a DOS file. On Unix and GNU/Linux systems, and also on a Macintosh,
2597 the string @samp{(DOS)} will appear near the left edge of the mode line;
2598 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2599 default, a backslash (@samp{\}) will appear in the mode line.
2601 @node Filling paragraphs with a single space
2602 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2603 @cindex One space following periods
2604 @cindex Single space following periods
2605 @cindex Periods, one space following
2607 Add the following line to your @file{.emacs} file:
2610 (setq sentence-end-double-space nil)
2613 @node Escape sequences in shell output
2614 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2615 @cindex Escape sequences in @code{ls} output
2616 @cindex @code{ls} in Shell mode
2618 In many systems, @code{ls} is aliased to @samp{ls --color}, which
2619 prints using ANSI color escape sequences. Emacs version 21.1 and
2620 later includes the @code{ansi-color} package, which lets Shell mode
2621 recognize these escape sequences. In Emacs 23.2 and later, the
2622 package is enabled by default; in earlier versions you can enable it
2623 by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2624 by adding @code{(add-hook 'shell-mode-hook
2625 'ansi-color-for-comint-mode-on)} to your init file.
2627 In Emacs versions before 21.1, the @code{ansi-color} package is not
2628 included. In that case, you need to unalias @code{ls} for interactive
2629 shells running in Emacs; this can be done by checking the @code{EMACS}
2630 variable in the environment.
2632 @node Fullscreen mode on MS-Windows
2633 @section How can I start Emacs in fullscreen mode on MS-Windows?
2634 @cindex Maximize frame
2635 @cindex Fullscreen mode
2637 Use the function @code{w32-send-sys-command}. For example, you can
2638 put the following in your @file{.emacs} file:
2641 (add-hook 'term-setup-hook
2642 #'(lambda () (w32-send-sys-command ?\xF030)))
2645 To avoid the slightly distracting visual effect of Emacs starting with
2646 its default frame size and then growing to fullscreen, you can add an
2647 @samp{Emacs.Geometry} entry to the Windows registry settings (see
2648 @pxref{(emacs)X Resources}).
2650 To compute the correct values for width and height, first maximize the
2651 Emacs frame and then evaluate @code{(frame-height)} and
2652 @code{(frame-width)} with @kbd{M-:}.
2654 @c ------------------------------------------------------------
2655 @node Bugs and problems
2656 @chapter Bugs and problems
2657 @cindex Bugs and problems
2659 The Emacs manual lists some common kinds of trouble users could get
2660 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2661 Emacs Manual}, so you might look there if the problem you encounter
2662 isn't described in this chapter. If you decide you've discovered a bug,
2663 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2664 instructions how to do that.
2666 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2667 known problems with building and using Emacs on specific platforms;
2668 type @kbd{C-h C-p} to read it.
2671 * Problems with very large files::
2672 * ^M in the shell buffer::
2673 * Problems with Shell Mode::
2674 * Termcap/Terminfo entries for Emacs::
2675 * Errors with init files::
2676 * Emacs ignores X resources::
2677 * Emacs ignores frame parameters::
2678 * Editing files with $ in the name::
2679 * Shell mode loses the current directory::
2680 * Security risks with Emacs::
2681 * Dired claims that no file is on this line::
2684 @node Problems with very large files
2685 @section Does Emacs have problems with files larger than 8 megabytes?
2686 @cindex Very large files, opening
2687 @cindex Large files, opening
2688 @cindex Opening very large files
2689 @cindex Maximum file size
2690 @cindex Files, maximum size
2692 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2693 files larger than 8 megabytes. In versions 19.29 and later, the maximum
2694 buffer size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes.
2695 The maximum buffer size on 32-bit machines increased to 256 MBytes in
2696 Emacs 22, and again to 512 MBytes in Emacs 23.2.
2698 Emacs compiled on a 64-bit machine can handle much larger buffers.
2700 @node ^M in the shell buffer
2701 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2702 @cindex Shell buffer, echoed commands and @samp{^M} in
2703 @cindex Echoed commands in @code{shell-mode}
2705 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2706 make them go away. If that doesn't work, you have several options:
2708 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2713 if ("$EMACS" =~ /*) then
2714 if ($?tcsh) unset edit
2720 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2727 Alternatively, use @code{csh} in your shell buffers instead of
2728 @code{tcsh}. One way is:
2731 (setq explicit-shell-file-name "/bin/csh")
2735 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2739 setenv ESHELL /bin/csh
2743 (You must start Emacs over again with the environment variable properly
2744 set for this to take effect.)
2746 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2747 with the following Lisp form,
2750 (setenv "ESHELL" "/bin/csh")
2753 The above solutions try to prevent the shell from producing the
2754 @samp{^M} characters in the first place. If this is not possible
2755 (e.g., if you use a Windows shell), you can get Emacs to remove these
2756 characters from the buffer by adding this to your @file{.emacs} init
2760 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2763 On a related note: if your shell is echoing your input line in the shell
2764 buffer, you might want to customize the @code{comint-process-echoes}
2765 variable in your shell buffers, or try the following command in your
2766 shell start-up file:
2769 stty -icrnl -onlcr -echo susp ^Z
2772 @node Problems with Shell Mode
2773 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2775 @cindex Shell Mode, problems
2776 @cindex @code{explicit-shell-file-name}
2777 This might happen because Emacs tries to look for the shell in a wrong
2778 place. If you know where your shell executable is, set the variable
2779 @code{explicit-shell-file-name} in your @file{.emacs} file to point to
2782 @cindex Antivirus programs, and Shell Mode
2783 Some people have trouble with Shell Mode on MS-Windows because of
2784 intrusive antivirus software; disabling the resident antivirus program
2785 solves the problems in those cases.
2787 @node Termcap/Terminfo entries for Emacs
2788 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2791 @cindex Emacs entries for termcap/terminfo
2793 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2794 the @samp{TERMCAP} environment variable of subshells. It may help in
2795 certain situations (e.g., using rlogin from shell buffer) to add an
2796 entry for @samp{emacs} to the system-wide termcap file. Here is a
2797 correct termcap entry for @samp{emacs}:
2803 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2804 @code{captoinfo}. You need to generate
2805 @file{/usr/lib/terminfo/e/emacs}. It may work to simply copy
2806 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2808 Having a termcap/terminfo entry will not enable the use of full screen
2809 programs in shell buffers. Use @kbd{M-x terminal-emulator} for that
2812 A workaround to the problem of missing termcap/terminfo entries is to
2813 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2814 in your shell start up file. @code{csh} users could put this in their
2815 @file{.cshrc} files:
2818 if ("$term" == emacs) set term=dumb
2821 @node Errors with init files
2822 @section Why does Emacs say @samp{Error in init file}?
2823 @cindex Error in @file{.emacs}
2824 @cindex Error in init file
2825 @cindex Init file, errors in
2826 @cindex @file{.emacs} file, errors in
2827 @cindex Debugging @file{.emacs} file
2829 An error occurred while loading either your @file{.emacs} file or the
2830 system-wide file @file{site-lisp/default.el}. Emacs 21.1 and later pops the
2831 @file{*Messages*} buffer, and puts there some additional information
2832 about the error, to provide some hints for debugging.
2834 For information on how to debug your @file{.emacs} file, see
2835 @ref{Debugging a customization file}.
2837 It may be the case that you need to load some package first, or use a
2838 hook that will be evaluated after the package is loaded. A common case
2839 of this is explained in @ref{Terminal setup code works after Emacs has
2842 @node Emacs ignores X resources
2843 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
2844 @cindex X resources being ignored
2845 @cindex Ignored X resources
2846 @cindex @file{.Xdefaults}
2848 As of version 19, Emacs searches for X resources in the files specified
2849 by the following environment variables:
2853 @item @code{XFILESEARCHPATH}
2854 @item @code{XUSERFILESEARCHPATH}
2855 @item @code{XAPPLRESDIR}
2859 This emulates the functionality provided by programs written using the
2862 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
2863 of file names separated by colons. @code{XAPPLRESDIR} should be a list
2864 of directory names separated by colons.
2866 Emacs searches for X resources:
2871 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
2874 then in the value of the @samp{XENVIRONMENT} environment variable,
2879 or if that is unset, in the file named
2880 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
2881 the name of the machine Emacs is running on),
2886 then in the screen-specific and server-wide resource properties provided
2892 or if those properties are unset, in the file named @file{~/.Xdefaults}
2898 then in the files listed in @samp{XUSERFILESEARCHPATH},
2903 or in files named @file{@var{lang}/Emacs} in directories listed in
2904 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
2905 environment variable), if the @samp{LANG} environment variable is set,
2907 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
2909 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
2912 or in @file{~/Emacs},
2917 then in the files listed in @code{XFILESEARCHPATH}.
2921 @node Emacs ignores frame parameters
2922 @section Why don't my customizations of the frame parameters work?
2923 @cindex Frame parameters
2925 This probably happens because you have set the frame parameters in the
2926 variable @code{initial-frame-alist}. That variable holds parameters
2927 used only for the first frame created when Emacs starts. To customize
2928 the parameters of all frames, change the variable
2929 @code{default-frame-alist} instead.
2931 These two variables exist because many users customize the initial frame
2932 in a special way. For example, you could determine the position and
2933 size of the initial frame, but would like to control the geometry of the
2934 other frames by individually positioning each one of them.
2937 @node Editing files with $ in the name
2938 @section How do I edit a file with a @samp{$} in its name?
2939 @cindex Editing files with @samp{$} in the name
2940 @cindex @samp{$} in file names
2941 @cindex File names containing @samp{$}, editing
2943 When entering a file name in the minibuffer, Emacs will attempt to expand
2944 a @samp{$} followed by a word as an environment variable. To suppress
2945 this behavior, type @kbd{$$} instead.
2947 @node Shell mode loses the current directory
2948 @section Why does shell mode lose track of the shell's current directory?
2949 @cindex Current directory and @code{shell-mode}
2950 @cindex @code{shell-mode} and current directory
2951 @cindex Directory, current in @code{shell-mode}
2953 Emacs has no way of knowing when the shell actually changes its
2954 directory. This is an intrinsic limitation of Unix. So it tries to
2955 guess by recognizing @samp{cd} commands. If you type @kbd{cd} followed
2956 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
2957 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
2958 correctly guess the shell's new current directory. A huge variety of
2959 fixes and enhancements to shell mode for this problem have been written
2960 to handle this problem (@pxref{Finding a package with particular
2963 You can tell Emacs the shell's current directory with the command
2966 @node Security risks with Emacs
2967 @section Are there any security risks in Emacs?
2968 @cindex Security with Emacs
2969 @cindex @samp{movemail} and security
2970 @cindex @code{file-local-variable} and security
2971 @cindex Synthetic X events and security
2972 @cindex X events and security
2977 The @file{movemail} incident. (No, this is not a risk.)
2979 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
2980 chapter 4. The site at LBL had installed the @file{/etc/movemail}
2981 program setuid root. (As of version 19, @file{movemail} is in your
2982 architecture-specific directory; type @kbd{C-h v exec-directory
2983 @key{RET}} to see what it is.) Since @code{movemail} had not been
2984 designed for this situation, a security hole was created and users could
2985 get root privileges.
2987 @code{movemail} has since been changed so that this security hole will
2988 not exist, even if it is installed setuid root. However,
2989 @code{movemail} no longer needs to be installed setuid root, which
2990 should eliminate this particular risk.
2992 We have heard unverified reports that the 1988 Internet worm took
2993 advantage of this configuration problem.
2996 The @code{file-local-variable} feature. (Yes, a risk, but easy to
2999 There is an Emacs feature that allows the setting of local values for
3000 variables when editing a file by including specially formatted text near
3001 the end of the file. This feature also includes the ability to have
3002 arbitrary Emacs Lisp code evaluated when the file is visited.
3003 Obviously, there is a potential for Trojan horses to exploit this
3006 As of Emacs 22, Emacs has a list of local variables that are known to
3007 be safe to set. If a file tries to set any variable outside this
3008 list, it asks the user to confirm whether the variables should be set.
3009 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
3010 code found at the bottom of files by setting the variable
3011 @code{enable-local-eval}.
3013 For more information, @inforef{File Variables, File Variables, emacs}.
3016 Synthetic X events. (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3019 Emacs accepts synthetic X events generated by the @code{SendEvent}
3020 request as though they were regular events. As a result, if you are
3021 using the trivial host-based authentication, other users who can open X
3022 connections to your X workstation can make your Emacs process do
3023 anything, including run other processes with your privileges.
3025 The only fix for this is to prevent other users from being able to open
3026 X connections. The standard way to prevent this is to use a real
3027 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}. If using
3028 the @code{xauth} program has any effect, then you are probably using
3029 @samp{MIT-MAGIC-COOKIE-1}. Your site may be using a superior
3030 authentication method; ask your system administrator.
3032 If real authentication is not a possibility, you may be satisfied by
3033 just allowing hosts access for brief intervals while you start your X
3034 programs, then removing the access. This reduces the risk somewhat by
3035 narrowing the time window when hostile users would have access, but
3036 @emph{does not eliminate the risk}.
3038 On most computers running Unix and X, you enable and disable
3039 access using the @code{xhost} command. To allow all hosts access to
3047 at the shell prompt, which (on an HP machine, at least) produces the
3051 access control disabled, clients can connect from any host
3054 To deny all hosts access to your X server (except those explicitly
3055 allowed by name), use
3061 On the test HP computer, this command generated the following message:
3064 access control enabled, only authorized clients can connect
3069 @node Dired claims that no file is on this line
3070 @section Dired says, @samp{no file on this line} when I try to do something.
3071 @cindex Dired does not see a file
3073 Dired uses a regular expression to find the beginning of a file name.
3074 In a long Unix-style directory listing (@samp{ls -l}), the file name
3075 starts after the date. The regexp has thus been written to look for the
3076 date. By default, it should understand dates and times regardless of
3077 the language, but if your directory listing has an unusual format, Dired
3080 There are two approaches to solving this. The first one involves
3081 setting things up so that @samp{ls -l} outputs a more standard format.
3082 See your OS manual for more information.
3084 The second approach involves changing the regular expression used by
3085 dired, @code{directory-listing-before-filename-regexp}.
3087 @c ------------------------------------------------------------
3088 @node Compiling and installing Emacs
3089 @chapter Compiling and installing Emacs
3090 @cindex Compiling and installing Emacs
3093 * Installing Emacs::
3094 * Problems building Emacs::
3097 @node Installing Emacs
3098 @section How do I install Emacs?
3099 @cindex Installing Emacs
3100 @cindex Unix systems, installing Emacs on
3101 @cindex Downloading and installing Emacs
3102 @cindex Building Emacs from source
3103 @cindex Source code, building Emacs from
3105 This answer is meant for users of Unix and Unix-like systems. Users of
3106 other operating systems should see the series of questions beginning
3107 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3108 and binaries, and how to install Emacs on those systems.
3110 Most GNU/Linux distributions provide pre-built Emacs packages.
3111 If Emacs is not installed already, you can install it by running (as
3112 root) a command such as @samp{yum install emacs} (Red Hat and
3113 derivatives) or @samp{apt-get install emacs} (Debian and derivatives).
3115 If you want to compile Emacs yourself, read the file @file{INSTALL} in
3116 the source distribution. In brief:
3121 First download the Emacs sources. @xref{Current GNU distributions}, for
3122 a list of ftp sites that make them available. On @file{ftp.gnu.org},
3123 the main GNU distribution site, sources are available as
3125 @c Don't include VER in the file name, because pretests are not there.
3126 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
3128 (Replace @samp{VERSION} with the relevant version number, e.g. @samp{23.1}.)
3131 Next uncompress and extract the source files. This requires
3132 the @code{gzip} and @code{tar} programs, which are standard utilities.
3133 If your system does not have them, these can also be downloaded from
3136 GNU @code{tar} can uncompress and extract in a single-step:
3139 tar -zxvf emacs-VERSION.tar.gz
3143 At this point, the Emacs sources should be sitting in a directory called
3144 @file{emacs-VERSION}. On most common Unix and Unix-like systems,
3145 you should be able to compile Emacs with the following commands:
3149 ./configure # configure Emacs for your particular system
3150 make # use Makefile to build components, then Emacs
3153 If the @code{make} completes successfully, the odds are fairly good that
3154 the build has gone well. (@xref{Problems building Emacs}, if you weren't
3158 By default, Emacs is installed in @file{/usr/local}. To actually
3159 install files, become the superuser and type
3165 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3166 and any Emacs Info files that might be in @file{/usr/local/share/info/}.
3170 @node Problems building Emacs
3171 @section What should I do if I have trouble building Emacs?
3172 @cindex Problems building Emacs
3173 @cindex Errors when building Emacs
3175 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3176 source) to see if there is already a solution for your problem. Next,
3177 look for other questions in this FAQ that have to do with Emacs
3178 installation and compilation problems.
3180 If you'd like to have someone look at your problem and help solve it,
3181 see @ref{Help installing Emacs}.
3183 If you cannot find a solution in the documentation, please report the
3184 problem (@pxref{Reporting bugs}).
3187 @c ------------------------------------------------------------
3188 @node Finding Emacs and related packages
3189 @chapter Finding Emacs and related packages
3190 @cindex Finding Emacs and related packages
3193 * Finding Emacs on the Internet::
3194 * Finding a package with particular functionality::
3195 * Packages that do not come with Emacs::
3196 * Current GNU distributions::
3197 * Difference between Emacs and XEmacs::
3198 * Emacs for minimalists::
3199 * Emacs for MS-DOS::
3200 * Emacs for MS-Windows::
3201 * Emacs for GNUstep::
3202 * Emacs for Mac OS X::
3205 @node Finding Emacs on the Internet
3206 @section Where can I get Emacs on the net?
3207 @cindex Finding Emacs on the Internet
3208 @cindex Downloading Emacs
3210 Information on downloading Emacs is available at
3211 @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}.
3213 @xref{Installing Emacs}, for information on how to obtain and build the latest
3214 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3215 archive sites that make GNU software available.
3217 @node Finding a package with particular functionality
3218 @section How do I find a Emacs Lisp package that does XXX?
3219 @cindex Package, finding
3220 @cindex Finding an Emacs Lisp package
3221 @cindex Functionality, finding a particular package
3223 First of all, you should check to make sure that the package isn't
3224 already available. For example, typing @kbd{M-x apropos @key{RET}
3225 wordstar @key{RET}} lists all functions and variables containing the
3226 string @samp{wordstar}.
3228 It is also possible that the package is on your system, but has not been
3229 loaded. To see which packages are available for loading, look through
3230 your computer's lisp directory (@pxref{File-name conventions}). The Lisp
3231 source to most packages contains a short description of how they
3232 should be loaded, invoked, and configured---so before you use or
3233 modify a Lisp package, see if the author has provided any hints in the
3236 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3237 the constituent Emacs packages.
3239 For advice on how to find extra packages that are not part of Emacs,
3240 see @ref{Packages that do not come with Emacs}.
3242 @node Packages that do not come with Emacs
3243 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3244 @cindex Unbundled packages
3245 @cindex Finding other packages
3246 @cindex Lisp packages that do not come with Emacs
3247 @cindex Packages, those that do not come with Emacs
3248 @cindex Emacs Lisp List
3249 @cindex Emacs Lisp Archive
3251 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs Lisp
3252 List (ELL)}, maintained by @email{S.J.Eglen@@damtp.cam.ac.uk, Stephen Eglen},
3253 aims to provide one compact list with links to all of the current Emacs
3254 Lisp files on the Internet. The ELL can be browsed over the web, or
3255 from Emacs with @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.el,
3256 the @file{ell} package}.
3258 Many authors post their packages to the @uref{news:gnu.emacs.sources,
3259 Emacs sources newsgroup}. You can search the archives of this
3260 group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google},
3261 or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example.
3263 Several packages are stored in
3264 @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}.
3266 Read the file @file{etc/MORE.STUFF} for more information about
3269 @node Current GNU distributions
3270 @section Where can I get other up-to-date GNU stuff?
3271 @cindex Current GNU distributions
3272 @cindex Sources for current GNU distributions
3273 @cindex Stuff, current GNU
3274 @cindex Up-to-date GNU stuff
3275 @cindex Finding current GNU software
3276 @cindex Official GNU software sites
3278 The most up-to-date official GNU software is normally kept at
3280 @uref{ftp://ftp.gnu.org/pub/gnu}
3282 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3284 @uref{http://www.gnu.org/order/ftp.html}
3286 @node Difference between Emacs and XEmacs
3287 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3289 @cindex Difference Emacs and XEmacs
3293 XEmacs is a branch version of Emacs. It was first called Lucid Emacs,
3294 and was initially derived from a prerelease version of Emacs 19. In
3295 this FAQ, we use the name ``Emacs'' only for the official version.
3297 Emacs and XEmacs each come with Lisp packages that are lacking in the
3298 other. The two versions have some significant differences at the Lisp
3299 programming level. Their current features are roughly comparable,
3300 though the support for some operating systems, character sets and
3301 specific packages might be quite different.
3303 Some XEmacs code has been contributed to Emacs, and we would like to
3304 use other parts, but the earlier XEmacs maintainers did not always
3305 keep track of the authors of contributed code, which makes it
3306 impossible for the FSF to get copyright papers signed for that code.
3307 (The FSF requires these papers for all the code included in the Emacs
3308 release, aside from generic C support packages that retain their
3309 separate identity and are not integrated into the code of Emacs
3312 If you want to talk about these two versions and distinguish them,
3313 please call them ``Emacs'' and ``XEmacs.'' To contrast ``XEmacs''
3314 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3315 origin in the work of the GNU Project. Terms such as ``Emacsen'' and
3316 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3317 is better to write ``Emacs and XEmacs.''
3319 @node Emacs for minimalists
3320 @section I don't have enough disk space to install Emacs
3322 @cindex Not enough disk space to install Emacs
3324 GNU Zile is a lightweight Emacs clone. Zile is short for @samp{Zile Is
3325 Lossy Emacs}. It has all of Emacs's basic editing features. The Zile
3326 binary typically has a size of about 130 kbytes, so this can be useful
3327 if you are in an extremely space-restricted environment. More
3328 information is available from
3330 @uref{http://www.gnu.org/software/zile/}
3333 @node Emacs for MS-DOS
3334 @section Where can I get Emacs for MS-DOS?
3335 @cindex MS-DOS, Emacs for
3336 @cindex DOS, Emacs for
3337 @cindex Compiling Emacs for DOS
3338 @cindex Emacs for MS-DOS
3340 To build Emacs from source for MS-DOS, see the instructions in the file
3341 @file{msdos/INSTALL} in the distribution. The DOS port builds and runs
3342 on plain DOS, and also on all versions of MS-Windows from version 3.X
3343 onwards, including Windows XP and Vista.
3345 The file @file{etc/PROBLEMS} contains some additional information
3346 regarding Emacs under MS-DOS.
3348 A pre-built binary distribution of the old Emacs 20 is available, as
3351 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3353 For a list of other MS-DOS implementations of Emacs (and Emacs
3354 look-alikes), consult the list of ``Emacs implementations and literature,''
3357 @uref{http://www.finseth.com/emacs.html}
3359 Note that while many of these programs look similar to Emacs, they often
3360 lack certain features, such as the Emacs Lisp extension language.
3362 @node Emacs for MS-Windows
3363 @section Where can I get Emacs for Microsoft Windows?
3364 @cindex FAQ for Emacs on MS-Windows
3365 @cindex Emacs for MS-Windows
3366 @cindex Microsoft Windows, Emacs for
3368 There is a @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html,
3369 separate FAQ} for Emacs on MS-Windows. For MS-DOS, @pxref{Emacs for MS-DOS}.
3372 @node Emacs for GNUstep
3373 @section Where can I get Emacs for GNUstep?
3374 @cindex GNUstep, Emacs for
3376 Beginning with version 23.1, Emacs supports GNUstep natively.
3377 See the file @file{nextstep/INSTALL} in the distribution.
3379 @node Emacs for Mac OS X
3380 @section Where can I get Emacs for Mac OS X?
3381 @cindex Apple computers, Emacs for
3382 @cindex Macintosh, Emacs for
3383 @cindex Mac OS X, Emacs for
3385 Beginning with version 22.1, Emacs supports Mac OS X natively.
3386 See the file @file{nextstep/INSTALL} in the distribution.
3388 @c ------------------------------------------------------------
3389 @node Major packages and programs
3390 @chapter Major packages and programs
3391 @cindex Major packages and programs
3404 @section VM (View Mail) --- another mail reader within Emacs, with MIME support
3406 @cindex Alternative mail software
3408 @cindex E-mail reader, VM
3413 @uref{http://launchpad.net/vm}
3414 (was @uref{http://www.nongnu.org/viewmail/})
3416 @item Informational newsgroup
3417 @uref{news:gnu.emacs.vm.info}@*
3419 @item Bug reports newsgroup
3420 @uref{news:gnu.emacs.vm.bug}@*
3423 VM was originally written by @uref{http://www.wonderworks.com/vm/,Kyle Jones}.
3424 @uref{ftp://ftp.wonderworks.com/pub/vm/,Older versions} of VM remain
3429 @section AUC@TeX{} --- enhanced @TeX{} modes with debugging facilities
3430 @cindex Mode for @TeX{}
3432 @cindex AUC@TeX{} mode for editing @TeX{}
3433 @cindex Writing and debugging @TeX{}
3435 AUC@TeX{} is a set of sophisticated major modes for @TeX{}, LaTeX,
3436 ConTeXt, and Texinfo offering context-sensitive syntax highlighting,
3437 indentation, formatting and folding, macro completion, @TeX{} shell
3438 functionality, and debugging. Be also sure to check out
3439 @ref{Introduction, RefTeX, Introduction, reftex, Ref@TeX{} User Manual}.
3440 Current versions of AUC@TeX{} include the
3441 @uref{http://www.gnu.org/software/auctex/preview-latex.html,preview-latex}
3442 package for WYSIWYG previews of various LaTeX constructs in the Emacs
3445 @uref{http://www.gnu.org/software/auctex/, AUCTeX}
3448 @section BBDB --- personal Info Rolodex integrated with mail/news readers
3450 @cindex Rolodex-like functionality
3451 @cindex Integrated contact database
3452 @cindex Contact database
3453 @cindex Big Brother Database
3454 @cindex Address book
3456 @uref{http://bbdb.sourceforge.net/, The Insidious Big Brother Database}
3458 @node Spell-checkers
3459 @section Spell-checkers
3460 @cindex Spell-checker
3461 @cindex Checking spelling
3466 Various spell-checkers are compatible with Emacs, including:
3471 @uref{http://aspell.net/}
3474 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3477 @uref{http://hunspell.sourceforge.net/}
3482 @section Emacs/W3 --- A World Wide Web browser inside of Emacs
3485 @cindex HTML browser in Emacs
3486 @cindex @code{w3-mode}
3488 @uref{http://www.gnu.org/software/w3/, Emacs/W3}
3491 @section EDB --- Database program for Emacs; replaces forms editing modes
3496 @uref{http://gnuvola.org/software/edb/, The Emacs Database}
3499 @section JDEE --- Integrated development environment for Java
3500 @cindex Java development environment
3501 @cindex Integrated Java development environment
3504 @uref{http://jdee.sourceforge.net/, A Java Development Environment for Emacs}
3506 @c ------------------------------------------------------------
3508 @chapter Key bindings
3509 @cindex Key bindings
3512 * Binding keys to commands::
3513 * Invalid prefix characters::
3514 * Terminal setup code works after Emacs has begun::
3515 * Working with function and arrow keys::
3516 * X key translations for Emacs::
3517 * Backspace invokes help::
3519 * Producing C-XXX with the keyboard::
3522 * Compose Character::
3523 * Binding combinations of modifiers and function keys::
3524 * Meta key does not work in xterm::
3525 * ExtendChar key does not work as Meta::
3526 * SPC no longer completes file names::
3529 @node Binding keys to commands
3530 @section How do I bind keys (including function keys) to commands?
3531 @cindex Binding keys to commands
3532 @cindex Keys, binding to commands
3533 @cindex Commands, binding keys to
3535 Keys can be bound to commands either interactively or in your
3536 @file{.emacs} file. To interactively bind keys for all modes, type
3537 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3539 To bind a key just in the current major mode, type @kbd{M-x
3540 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3542 @inforef{Key Bindings, Key Bindings, emacs}, for further details.
3544 To make the process of binding keys interactively easier, use the
3545 following ``trick'': First bind the key interactively, then immediately
3546 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}. Now, the command needed
3547 to bind the key is in the kill ring, and can be yanked into your
3548 @file{.emacs} file. If the key binding is global, no changes to the
3549 command are required. For example,
3552 (global-set-key (quote [f1]) (quote help-for-help))
3556 can be placed directly into the @file{.emacs} file. If the key binding is
3557 local, the command is used in conjunction with the @samp{add-hook} function.
3558 For example, in TeX mode, a local binding might be
3561 (add-hook 'tex-mode-hook
3563 (local-set-key (quote [f1]) (quote help-for-help))))
3570 Control characters in key sequences, in the form yanked from the kill
3571 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3572 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc. You may want
3573 to convert these into their vector or string forms.
3576 If a prefix key of the character sequence to be bound is already
3577 bound as a complete key, then you must unbind it before the new
3578 binding. For example, if @kbd{ESC @{} is previously bound:
3581 (global-unset-key [?\e ?@{]) ;; or
3582 (local-unset-key [?\e ?@{])
3586 Aside from commands and ``lambda lists,'' a vector or string also
3587 can be bound to a key and thus treated as a macro. For example:
3590 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g]) ;; or
3591 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3596 @node Invalid prefix characters
3597 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3598 @cindex Prefix characters, invalid
3599 @cindex Invalid prefix characters
3600 @cindex Misspecified key sequences
3602 Usually, one of two things has happened. In one case, the control
3603 character in the key sequence has been misspecified (e.g. @samp{C-f}
3604 used instead of @samp{\C-f} within a Lisp expression). In the other
3605 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3606 was already bound as a @dfn{complete key}. Historically, the @samp{ESC [}
3607 prefix was usually the problem, in which case you should evaluate either
3608 of these forms before attempting to bind the key sequence:
3611 (global-unset-key [?\e ?[]) ;; or
3612 (global-unset-key "\e[")
3615 @node Terminal setup code works after Emacs has begun
3616 @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?
3617 @cindex Terminal setup code in @file{.emacs}
3619 During startup, Emacs initializes itself according to a given code/file
3620 order. If some of the code executed in your @file{.emacs} file needs to
3621 be postponed until the initial terminal or window-system setup code has
3622 been executed but is not, then you will experience this problem (this
3623 code/file execution order is not enforced after startup).
3625 To postpone the execution of Emacs Lisp code until after terminal or
3626 window-system setup, treat the code as a @dfn{lambda list} and set the
3627 value of either the @code{term-setup-hook} or @code{window-setup-hook}
3628 variable to this lambda function. For example,
3631 (add-hook 'term-setup-hook
3633 (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3634 ;; Make vt220's "Do" key behave like M-x:
3635 (global-set-key [do] 'execute-extended-command))))
3638 For information on what Emacs does every time it is started, see the
3639 @file{lisp/startup.el} file.
3641 @node Working with function and arrow keys
3642 @section How do I tell what characters or symbols my function or arrow keys emit?
3643 @cindex Working with arrow keys
3644 @cindex Arrow keys, symbols generated by
3645 @cindex Working with function keys
3646 @cindex Function keys, symbols generated by
3647 @cindex Symbols generated by function keys
3649 Type @kbd{C-h c} then the function or arrow keys. The command will
3650 return either a function key symbol or character sequence (see the
3651 Emacs documentation for an explanation). This works for other
3654 @node X key translations for Emacs
3655 @section How do I set the X key ``translations'' for Emacs?
3656 @cindex X key translations
3657 @cindex Key translations under X
3658 @cindex Translations for keys under X
3660 Emacs is not written using the Xt library by default, so there are no
3661 ``translations'' to be set. (We aren't sure how to set such translations
3662 if you do build Emacs with Xt; please let us know if you've done this!)
3664 The only way to affect the behavior of keys within Emacs is through
3665 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs). The
3666 @code{define-key} command should be used in conjunction with the
3667 @code{function-key-map} map. For instance,
3670 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3674 defines the @kbd{M-@key{TAB}} key sequence.
3676 @node Backspace invokes help
3677 @section Why does the @key{Backspace} key invoke help?
3678 @cindex Backspace key invokes help
3679 @cindex Help invoked by Backspace
3680 @cindex DEL key does not delete
3682 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
3683 @kbd{C-h} sends the same code. In Emacs by default @kbd{C-h} invokes
3684 help-command. This is intended to be easy to remember since the first
3685 letter of @samp{help} is @samp{h}. The easiest solution to this problem
3686 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
3687 @key{Delete} key) for deleting the previous character.
3689 For many people this solution may be problematic:
3694 They normally use @key{Backspace} outside of Emacs for deleting the
3695 previous character. This can be solved by making @key{DEL} the command
3696 for deleting the previous character outside of Emacs. On many Unix
3697 systems, this command will remap @key{DEL}:
3704 The user may prefer the @key{Backspace} key for deleting the
3705 previous character because it is more conveniently located on their
3706 keyboard or because they don't even have a separate @key{Delete} key.
3707 In this case, the @key{Backspace} key should be made to behave like
3708 @key{Delete}. There are several methods.
3712 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
3713 TeraTerm) allow the character generated by the @key{Backspace} key to be
3714 changed from a setup menu.
3717 You may be able to get a keyboard that is completely programmable, or a
3718 terminal emulator that supports remapping of any key to any other key.
3721 With Emacs 21.1 and later, you can control the effect of the
3722 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
3723 windowed displays, by customizing the option
3724 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
3725 normal-erase-is-backspace}. See the documentation of these symbols
3726 (@pxref{Emacs Lisp documentation}) for more info.
3729 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
3733 (keyboard-translate ?\C-h ?\C-?)
3737 This is the recommended method of forcing @key{Backspace} to act as
3738 @key{DEL}, because it works even in modes which bind @key{DEL} to
3739 something other than @code{delete-backward-char}.
3741 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
3742 default deletes forward:
3745 (keyboard-translate ?\C-? ?\C-d)
3748 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
3751 Another approach is to switch key bindings and put help on @kbd{C-x h}
3755 (global-set-key "\C-h" 'delete-backward-char)
3757 ;; overrides mark-whole-buffer
3758 (global-set-key "\C-xh" 'help-command)
3762 This method is not recommended, though: it only solves the problem for
3763 those modes which bind @key{DEL} to @code{delete-backward-char}. Modes
3764 which bind @key{DEL} to something else, such as @code{view-mode}, will
3765 not work as you expect when you press the @key{Backspace} key. For this
3766 reason, we recommend the @code{keyboard-translate} method, shown
3769 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
3772 Don't try to bind @key{DEL} to @code{help-command}, because there are
3773 many modes that have local bindings of @key{DEL} that will interfere.
3777 When Emacs 21 or later runs on a windowed display, it binds the
3778 @key{Delete} key to a command which deletes the character at point, to
3779 make Emacs more consistent with keyboard operation on these systems.
3781 For more information about troubleshooting this problem, see @ref{DEL
3782 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
3786 @section How do I swap two keys?
3787 @cindex Swapping keys
3788 @cindex Keys, swapping
3789 @cindex @code{keyboard-translate}
3791 You can swap two keys (or key sequences) by using the
3792 @code{keyboard-translate} function. For example, to turn @kbd{C-h}
3793 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
3796 (keyboard-translate ?\C-h ?\C-?) ; translate `C-h' to DEL
3797 (keyboard-translate ?\C-? ?\C-h) ; translate DEL to `C-h'.
3801 The first key sequence of the pair after the function identifies what is
3802 produced by the keyboard; the second, what is matched for in the
3805 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
3806 toggle @code{normal-erase-is-backspace-mode} instead of calling
3807 @code{keyboard-translate}. @inforef{DEL Does Not Delete, DEL Does Not Delete,
3810 Keyboard translations are not the same as key bindings in keymaps.
3811 Emacs contains numerous keymaps that apply in different situations, but
3812 there is only one set of keyboard translations, and it applies to every
3813 character that Emacs reads from the terminal. Keyboard translations
3814 take place at the lowest level of input processing; the keys that are
3815 looked up in keymaps contain the characters that result from keyboard
3818 @node Producing C-XXX with the keyboard
3819 @section How do I produce C-XXX with my keyboard?
3820 @cindex Producing control characters
3821 @cindex Generating control characters
3822 @cindex Control characters, generating
3824 On terminals (but not under X), some common ``aliases'' are:
3828 @item @kbd{C-2} or @kbd{C-@key{SPC}}
3834 @item @kbd{C-7} or @kbd{C-S--}
3848 Often other aliases exist; use the @kbd{C-h c} command and try
3849 @key{CTRL} with all of the digits on your keyboard to see what gets
3850 generated. You can also try the @kbd{C-h w} command if you know the
3851 name of the command.
3854 @section What if I don't have a @key{Meta} key?
3855 @cindex No @key{Meta} key
3856 @cindex @key{Meta} key, what to do if you lack it
3858 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
3860 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}. In fact,
3861 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
3862 (depending on the value of @code{meta-prefix-char}). Note that you
3863 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
3864 @key{ESC}, release it, and then press @key{a}.
3867 @section What if I don't have an @key{Escape} key?
3868 @cindex No Escape key
3869 @cindex Lacking an Escape key
3870 @cindex Escape key, lacking
3872 Type @kbd{C-[} instead. This should send @acronym{ASCII} code 27 just like an
3873 Escape key would. @kbd{C-3} may also work on some terminal (but not
3874 under X). For many terminals (notably DEC terminals) @key{F11}
3875 generates @key{ESC}. If not, the following form can be used to bind it:
3878 ;; F11 is the documented ESC replacement on DEC terminals.
3879 (define-key function-key-map [f11] [?\e])
3882 @node Compose Character
3883 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
3884 @cindex @key{Compose Character} key, using as @key{Meta}
3885 @cindex @key{Meta}, using @key{Compose Character} for
3887 On a dumb terminal such as a VT220, no. It is rumored that certain
3888 VT220 clones could have their @key{Compose} key configured this way. If
3889 you're using X, you might be able to do this with the @code{xmodmap}
3892 @node Binding combinations of modifiers and function keys
3893 @section How do I bind a combination of modifier key and function key?
3894 @cindex Modifiers and function keys
3895 @cindex Function keys and modifiers
3896 @cindex Binding modifiers and function keys
3898 With Emacs 19 and later, you can represent modified function keys in
3899 vector format by adding prefixes to the function key symbol. For
3900 example (from the Emacs documentation):
3903 (global-set-key [?\C-x right] 'forward-page)
3907 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
3909 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
3910 @key{Super}, @key{Alt}, and @key{Shift} with function keys. To
3911 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
3912 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name. Here
3913 is how to make @kbd{H-M-RIGHT} move forward a word:
3916 (global-set-key [H-M-right] 'forward-word)
3922 Not all modifiers are permitted in all situations. @key{Hyper},
3923 @key{Super}, and @key{Alt} are not available on Unix character
3924 terminals. Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and
3925 @kbd{Mouse-1}) also fall under this category.
3929 @xref{Binding keys to commands}, for general key binding instructions.
3931 @node Meta key does not work in xterm
3932 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
3933 @cindex @key{Meta} key and @code{xterm}
3934 @cindex Xterm and @key{Meta} key
3936 @inforef{Unibyte Mode, Single-Byte Character Set Support, emacs}.
3938 If the advice in the Emacs manual fails, try all of these methods before
3939 asking for further help:
3944 You may have big problems using @code{mwm} as your window manager.
3945 (Does anyone know a good generic solution to allow the use of the
3946 @key{Meta} key in Emacs with @file{mwm}?)
3949 For X11: Make sure it really is a @key{Meta} key. Use @code{xev} to
3950 find out what keysym your @key{Meta} key generates. It should be either
3951 @code{Meta_L} or @code{Meta_R}. If it isn't, use @file{xmodmap} to fix
3952 the situation. If @key{Meta} does generate @code{Meta_L} or
3953 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
3954 your @file{~/.Xdefaults} file:
3957 XTerm*eightBitInput: false
3958 XTerm*eightBitOutput: true
3962 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
3963 characters. @samp{stty -a} (or @samp{stty everything}) should show
3964 @samp{cs8} somewhere. If it shows @samp{cs7} instead, use @samp{stty
3965 cs8 -istrip} (or @samp{stty pass8}) to fix it.
3968 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
3969 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
3973 If Emacs is running on Ultrix, it is reported that evaluating
3974 @code{(set-input-mode t nil)} helps.
3977 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
3978 you type @kbd{M-W}, which is the same conversion Emacs would make if it
3979 got the @kbd{M-W} anyway. In X11R4, the following resource
3980 specification will do this:
3983 XTerm.VT100.EightBitInput: false
3987 (This changes the behavior of the @code{insert-eight-bit} action.)
3989 With older @code{xterm}s, you can specify this behavior with a translation:
3992 XTerm.VT100.Translations: #override \
3993 Meta<KeyPress>: string(0x1b) insert()
3997 You might have to replace @samp{Meta} with @samp{Alt}.
4001 @node ExtendChar key does not work as Meta
4002 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
4003 @cindex @key{ExtendChar} key as @key{Meta}
4004 @cindex @key{Meta}, using @key{ExtendChar} for
4005 @cindex HP-UX, the @key{ExtendChar} key
4007 This is a result of an internationalization extension in X11R4 and the
4008 fact that HP is now using this extension. Emacs assumes that the
4009 @code{XLookupString} function returns the same result regardless of the
4010 @key{Meta} key state which is no longer necessarily true. Until Emacs
4011 is fixed, the temporary kludge is to run this command after each time
4012 the X server is started but preferably before any xterm clients are:
4015 xmodmap -e 'remove mod1 = Mode_switch'
4018 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
4021 This will disable the use of the extra keysyms systemwide, which may be
4022 undesirable if you actually intend to use them.
4024 @node SPC no longer completes file names
4025 @section Why doesn't SPC complete file names anymore?
4026 @cindex @kbd{SPC} file name completion
4028 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
4029 the minibuffer, so that file names with embedded spaces could be typed
4030 without the need to quote the spaces.
4032 You can get the old behavior by binding @kbd{SPC} to
4033 @code{minibuffer-complete-word} in the minibuffer, as follows:
4036 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
4037 'minibuffer-complete-word)
4039 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4040 'minibuffer-complete-word)
4043 @c ------------------------------------------------------------
4044 @node Alternate character sets
4045 @chapter Alternate character sets
4046 @cindex Alternate character sets
4049 * Emacs does not display 8-bit characters::
4050 * Inputting eight-bit characters::
4051 * Right-to-left alphabets::
4052 * How to add fonts::
4055 @node Emacs does not display 8-bit characters
4056 @section How do I make Emacs display 8-bit characters?
4057 @cindex Displaying eight-bit characters
4058 @cindex Eight-bit characters, displaying
4060 @inforef{Unibyte Mode, Single-byte Character Set
4061 Support, emacs}. On a Unix, when Emacs runs on a text-only terminal
4062 display or is invoked with @samp{emacs -nw}, you typically need to use
4063 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4064 display, even after setting the language environment; otherwise
4065 non-@acronym{ASCII} characters will display as @samp{?}. On other operating
4066 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4067 character set supported by the display, and sets up the required
4068 terminal coding system automatically.
4070 @node Inputting eight-bit characters
4071 @section How do I input eight-bit characters?
4072 @cindex Entering eight-bit characters
4073 @cindex Eight-bit characters, entering
4074 @cindex Input, 8-bit characters
4076 Various methods are available for input of eight-bit characters. See
4077 @inforef{Unibyte Mode, Single-byte Character Set
4078 Support, emacs}. For more sophisticated methods, @inforef{Input
4079 Methods, Input Methods, emacs}.
4081 @node Right-to-left alphabets
4082 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4083 @cindex Right-to-left alphabets
4084 @cindex Hebrew, handling with Emacs
4085 @cindex Semitic alphabets
4086 @cindex Arabic alphabets
4087 @cindex Bidirectional text
4089 Emacs supports Hebrew characters (ISO 8859-8) since version 20, but does
4090 not yet support right-to-left character entry and display. The
4091 @uref{http://lists.gnu.org/mailman/listinfo/emacs-bidi, emacs-bidi
4092 mailing list} discusses development of support for this feature.
4095 @node How to add fonts
4096 @section How do I add fonts for use with Emacs?
4097 @cindex add fonts for use with Emacs
4100 First, download and install the BDF font files and any auxiliary
4101 packages they need. The GNU Intlfonts distribution can be found on
4102 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU
4103 Software Directory Web site}.
4105 Next, if you are on X Window system, issue the following two commands
4106 from the shell's prompt:
4109 xset +fp /usr/local/share/emacs/fonts
4114 (Modify the first command if you installed the fonts in a directory
4115 that is not @file{/usr/local/share/emacs/fonts}.) You also need to
4116 arrange for these two commands to run whenever you log in, e.g., by
4117 adding them to your window-system startup file, such as
4118 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4120 Now, add the following line to your @file{~/.emacs} init file:
4123 (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4127 (Again, modify the file name if you installed the fonts elsewhere.)
4129 Finally, if you wish to use the installed fonts with @code{ps-print},
4130 add the following line to your @file{~/.emacs}:
4133 (setq ps-multibyte-buffer 'bdf-font-except-latin)
4136 A few additional steps are necessary for MS-Windows; they are listed
4139 First, make sure @emph{all} the directories with BDF font files are
4140 mentioned in @code{bdf-directory-list}. On Unix and GNU/Linux
4141 systems, one normally runs @kbd{make install} to install the BDF fonts
4142 in the same directory. By contrast, Windows users typically don't run
4143 the Intlfonts installation command, but unpack the distribution in
4144 some directory, which leaves the BDF fonts in its subdirectories. For
4145 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4146 then you should set @code{bdf-directory-list} as follows:
4149 (setq bdf-directory-list
4150 '("C:/Intlfonts/Asian"
4151 "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4152 "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4153 "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4154 "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4155 "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4156 "C:/Intlfonts/Misc"))
4159 @cindex @code{w32-bdf-filename-alist}
4160 @cindex @code{w32-find-bdf-fonts}
4161 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4162 an alist of the BDF fonts and their corresponding file names.
4163 Assuming you have set @code{bdf-directory-list} to name all the
4164 directories with the BDF font files, the following Lisp snippet will
4165 set up @code{w32-bdf-filename-alist}:
4168 (setq w32-bdf-filename-alist
4169 (w32-find-bdf-fonts bdf-directory-list))
4172 Now, create fontsets for the BDF fonts:
4175 (create-fontset-from-fontset-spec
4176 "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4177 japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4178 katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4179 latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4180 japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4181 thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4182 lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4183 tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4184 ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4185 tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4188 Many of the international bdf fonts from Intlfonts are type 0, and
4189 therefore need to be added to font-encoding-alist:
4192 (setq font-encoding-alist
4193 (append '(("MuleTibetan-0" (tibetan . 0))
4194 ("GB2312" (chinese-gb2312 . 0))
4195 ("JISX0208" (japanese-jisx0208 . 0))
4196 ("JISX0212" (japanese-jisx0212 . 0))
4197 ("VISCII" (vietnamese-viscii-lower . 0))
4198 ("KSC5601" (korean-ksc5601 . 0))
4199 ("MuleArabic-0" (arabic-digit . 0))
4200 ("MuleArabic-1" (arabic-1-column . 0))
4201 ("MuleArabic-2" (arabic-2-column . 0)))
4202 font-encoding-alist))
4205 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4206 fontset, or you can select it by setting the default font in your
4210 (set-default-font "fontset-bdf")
4214 @c ------------------------------------------------------------
4216 @chapter Mail and news
4217 @cindex Mail and news
4220 * Changing the included text prefix::
4221 * Saving a copy of outgoing mail::
4222 * Expanding aliases when sending mail::
4223 * Sorting the messages in an Rmail folder::
4224 * Rmail writes to /var/spool/mail::
4225 * Replying to the sender of a message::
4226 * Automatically starting a mail or news reader::
4227 * Reading news with Emacs::
4228 * Gnus does not work with NNTP::
4229 * Making Gnus faster::
4230 * Catching up in all newsgroups::
4233 @node Changing the included text prefix
4234 @section How do I change the included text prefix in mail/news followups?
4235 @cindex Prefix in mail/news followups, changing
4236 @cindex Included text prefix, changing
4237 @cindex Setting the included text character
4238 @cindex Quoting in mail messages
4240 If you read mail with Rmail, set the variable @code{mail-yank-prefix}.
4241 For Gnus, set @code{message-yank-prefix}. For VM, set
4242 @code{vm-included-text-prefix}. For mh-e, set @code{mh-ins-buf-prefix}.
4244 For fancier control of citations, use Supercite (@pxref{Top,, the Supercite
4245 Manual, sc, The Supercite Manual}).
4247 To prevent Emacs from including various headers of the replied-to
4248 message, set the value of @code{mail-yank-ignored-headers} to an
4251 @node Saving a copy of outgoing mail
4252 @section How do I save a copy of outgoing mail?
4253 @cindex Saving a copy of outgoing mail
4254 @cindex Copying outgoing mail to a file
4255 @cindex Filing outgoing mail
4256 @cindex Automatic filing of outgoing mail
4257 @cindex Mail, saving outgoing automatically
4259 You can either mail yourself a copy by including a @samp{BCC} header in the
4260 mail message, or store a copy of the message directly to a file by
4261 including an @samp{FCC} header.
4263 If you use standard mail, you can automatically create a @samp{BCC} to
4267 (setq mail-self-blind t)
4271 in your @file{.emacs} file. You can automatically include an @samp{FCC}
4272 field by putting something like the following in your @file{.emacs}
4276 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4279 The output file will be in Unix mail format.
4281 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4284 It does not work to put @samp{set record filename} in the @file{.mailrc}
4287 @node Expanding aliases when sending mail
4288 @section Why doesn't Emacs expand my aliases when sending mail?
4289 @cindex Expanding aliases when sending mail
4290 @cindex Mail alias expansion
4291 @cindex Sending mail with aliases
4293 @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}.
4298 Normally, Emacs expands aliases when you send the message.
4299 To expand them before this, use @kbd{M-x expand-mail-aliases}.
4302 Emacs normally only reads the @file{.mailrc} file once per session, when
4303 you start to compose your first mail message. If you edit the file
4304 after this, you can use @kbd{M-x build-mail-aliases} to make Emacs
4305 reread it. Prior to Emacs 24.1, this is not an interactive command, so
4306 you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}.
4309 If you like, you can expand mail aliases as abbrevs, as soon as you
4310 type them in. To enable this feature, execute the following:
4313 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4316 Note that the aliases are expanded automatically only after you type
4317 a word-separator character (e.g. @key{RET} or @kbd{,}). You can force their
4318 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4319 (@kbd{M-x expand-abbrev}).
4322 @node Sorting the messages in an Rmail folder
4323 @section How can I sort the messages in my Rmail folder?
4324 @cindex Rmail, sorting messages in
4325 @cindex Folder, sorting messages in an Rmail
4326 @cindex Sorting messages in an Rmail folder
4328 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4329 and their key bindings.
4331 @node Rmail writes to /var/spool/mail
4332 @section Why does Rmail need to write to @file{/var/spool/mail}?
4333 @cindex Rmail and @file{/var/spool/mail}
4334 @cindex @file{/var/spool/mail} and Rmail
4336 This is the behavior of the @code{movemail} program which Rmail uses.
4337 This indicates that @code{movemail} is configured to use lock files.
4342 Certain systems require lock files to interlock access to mail files.
4343 On these systems, @code{movemail} must write lock files, or you risk losing
4344 mail. You simply must arrange to let @code{movemail} write them.
4346 Other systems use the @code{flock} system call to interlock access. On
4347 these systems, you should configure @code{movemail} to use @code{flock}.
4350 @node Replying to the sender of a message
4351 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4352 @cindex Replying only to the sender of a message
4353 @cindex Sender, replying only to
4354 @cindex Rmail, replying to the sender of a message in
4356 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit
4357 @key{r} to reply in Rmail, by default it CCs all of the original
4358 recipients (everyone on the original @samp{To} and @samp{CC}
4359 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4360 it replies only to the sender. However, going through the whole
4361 @kbd{C-u} business every time you want to reply is a pain. This is the
4362 best fix I've been able to come up with:
4365 (defun rmail-reply-t ()
4366 "Reply only to the sender of the current message. (See rmail-reply.)"
4370 (add-hook 'rmail-mode-hook
4372 (define-key rmail-mode-map "r" 'rmail-reply-t)
4373 (define-key rmail-mode-map "R" 'rmail-reply)))
4376 @node Automatically starting a mail or news reader
4377 @section How do I make Emacs automatically start my mail/news reader?
4378 @cindex Mail reader, starting automatically
4379 @cindex News reader, starting automatically
4380 @cindex Starting mail/news reader automatically
4382 To start Emacs in Gnus:
4395 A more convenient way to start with Gnus:
4398 alias gnus 'emacs -f gnus'
4402 It is probably unwise to automatically start your mail or news reader
4403 from your @file{.emacs} file. This would cause problems if you needed to run
4404 two copies of Emacs at the same time. Also, this would make it difficult for
4405 you to start Emacs quickly when you needed to.
4407 @node Reading news with Emacs
4408 @section How do I read news under Emacs?
4409 @cindex Reading news under Emacs
4410 @cindex Usenet reader in Emacs
4411 @cindex Gnus newsreader
4412 @cindex FAQ for Gnus
4414 @cindex Learning more about Gnus
4416 Use @kbd{M-x gnus}. For more information on Gnus, @pxref{Top,, the Gnus
4417 Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked
4418 Questions,, the Gnus FAQ, gnus}.
4421 @node Gnus does not work with NNTP
4422 @section Why doesn't Gnus work via NNTP?
4423 @cindex Gnus and NNTP
4424 @cindex NNTP, Gnus fails to work with
4426 There is a bug in NNTP version 1.5.10, such that when multiple requests
4427 are sent to the NNTP server, the server only handles the first one
4428 before blocking waiting for more input which never comes. NNTP version
4429 1.5.11 claims to fix this.
4431 You can work around the bug inside Emacs like this:
4434 (setq nntp-maximum-request 1)
4437 You can find out what version of NNTP your news server is running by
4438 telnetting to the NNTP port (usually 119) on the news server machine
4439 (i.e., @kbd{telnet server-machine 119}). The server should give its
4440 version number in the welcome message. Type @kbd{quit} to get out.
4442 @node Making Gnus faster
4443 @section How do I make Gnus faster?
4444 @cindex Faster, starting Gnus
4445 @cindex Starting Gnus faster
4446 @cindex Gnus, starting faster
4447 @cindex Slow catch up in Gnus
4448 @cindex Gnus is slow when catching up
4449 @cindex Crosspostings make Gnus catching up slow
4451 From the Gnus FAQ (@pxref{Reading news with Emacs}):
4454 If you have a slow machine, or are just really impatient, there are a
4455 few things you can do to make Gnus run faster.
4457 Set @code{gnus-check-new-newsgroups} and
4458 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
4460 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
4461 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
4462 summary buffer faster.
4465 @node Catching up in all newsgroups
4466 @section How do I catch up all newsgroups in Gnus?
4467 @cindex Catching up all newsgroups in Gnus
4468 @cindex Gnus, Catching up all newsgroups in
4470 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4472 Leave off the initial @kbd{M-<} if you only want to catch up from point
4473 to the end of the @file{*Newsgroup*} buffer.
4476 @unnumbered Concept Index