Fix bug #12073 with outdated FAQ entry.
[emacs.git] / doc / misc / faq.texi
blob2983667c5cdf8efc1fab9015db3726567b901f18
1 \input texinfo   @c -*- mode: texinfo; -*-
2 @c %**start of header
3 @setfilename ../../info/efaq
4 @settitle GNU Emacs FAQ
5 @c %**end of header
7 @include emacsver.texi
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).
13 @copying
14 Copyright @copyright{} 2001-2012 Free Software Foundation, Inc.@*
15 Copyright @copyright{} 1994, 1995, 1996, 1997, 1998, 1999, 2000
16 Reuven M. Lerner@*
17 Copyright @copyright{} 1992, 1993 Steven Byrnes@*
18 Copyright @copyright{} 1990, 1991, 1992 Joseph Brian Wells@*
20 @quotation
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
36 distribution.]
37 @end quotation
38 @end copying
40 @dircategory Emacs
41 @direntry
42 * Emacs FAQ: (efaq).            Frequently Asked Questions about Emacs.
43 @end direntry
45 @c The @titlepage stuff only appears in the printed version
46 @titlepage
47 @sp 10
48 @center @titlefont{GNU Emacs FAQ}
50 @c The following two commands start the copyright page.
51 @page
52 @vskip 0pt plus 1filll
53 @insertcopying
54 @end titlepage
56 @contents
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
66 them.
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
76 latest release.
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.
81 @ifnottex
82 @insertcopying
83 @end ifnottex
85 @menu
86 * FAQ notation::
87 * General questions::
88 * Getting help::
89 * Status of Emacs::
90 * Common requests::
91 * Bugs and problems::
92 * Compiling and installing Emacs::
93 * Finding Emacs and related packages::
94 * Key bindings::
95 * Alternate character sets::
96 * Mail and news::
97 * Concept index::
98 @end menu
100 @c ------------------------------------------------------------
101 @node FAQ notation
102 @chapter FAQ notation
103 @cindex FAQ notation
105 This chapter describes notation used in the GNU Emacs FAQ, as well as in
106 the Emacs documentation.  Consult this section if this is the first time
107 you are reading the FAQ, or if you are confused by notation or terms
108 used in the FAQ.
110 @menu
111 * Basic keys::
112 * Extended commands::
113 * Emacs manual::
114 * File-name conventions::
115 * Common acronyms::
116 @end menu
118 @node Basic keys
119 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
120 @cindex Basic keys
121 @cindex Control key, notation for
122 @cindex @key{Meta} key, notation for
123 @cindex Control-Meta characters, notation for
124 @cindex @kbd{C-h}, definition of
125 @cindex @kbd{C-M-h}, definition of
126 @cindex @key{DEL}, definition of
127 @cindex @key{ESC}, definition of
128 @cindex @key{LFD}, definition of
129 @cindex @key{RET}, definition of
130 @cindex @key{SPC}, definition of
131 @cindex @key{TAB}, definition of
132 @cindex Notation for keys
134 @itemize @bullet
136 @item
137 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
139 @item
140 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
141 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
143 @item
144 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
145 and @key{Meta}
147 @item
148 @kbd{C-M-x}: a synonym for the above
150 @item
151 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
153 @item
154 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
156 @item
157 @key{DEL}: @key{Delete}, usually @strong{not} the same as
158 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
159 deleting invokes Emacs help)
161 @item
162 @key{ESC}: Escape; same as @kbd{C-[}
164 @item
165 @key{TAB}: Tab; same as @kbd{C-i}
167 @item
168 @key{SPC}: Space bar
170 @end itemize
172 Key sequences longer than one key (and some single-key sequences) are
173 written inside quotes or on lines by themselves, like this:
175 @display
176   @kbd{M-x frobnicate-while-foo RET}
177 @end display
179 @noindent
180 Any real spaces in such a key sequence should be ignored; only @key{SPC}
181 really means press the space key.
183 The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
184 that would be sent by pressing just @key{x} minus 96 (or 64 for
185 upper-case @key{X}) and will be from 0 to 31.  On Unix and GNU/Linux
186 terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the
187 @acronym{ASCII} code that would be sent by pressing just @key{x}.  Essentially,
188 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
189 7@footnote{
190 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
191 pressed.}.
193 @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127.  It is a misnomer to call
194 @kbd{C-?}  a ``control'' key, since 127 has both bits 5 and 6 turned ON.
195 Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127.
196 @c FIXME I cannot understand the previous sentence.
198 @xref{Keys,,, emacs, The GNU Emacs Manual}.
200 @node Extended commands
201 @section What does @file{M-x @var{command}} mean?
202 @cindex Extended commands
203 @cindex Commands, extended
204 @cindex M-x, meaning of
206 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
207 command, then type @key{RET}.  (@xref{Basic keys}, if you're not sure
208 what @kbd{M-x} and @key{RET} mean.)
210 @kbd{M-x} (by default) invokes the command
211 @code{execute-extended-command}.  This command allows you to run any
212 Emacs command if you can remember the command's name.  If you can't
213 remember the command's name, you can type @key{TAB} and @key{SPC} for
214 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
215 @kbd{M-n} (or up-arrow and down-arrow) to see previous commands entered.
216 An Emacs @dfn{command} is an @dfn{interactive} Emacs function.
218 @cindex @key{Do} key
219 Your system administrator may have bound other key sequences to invoke
220 @code{execute-extended-command}.  A function key labeled @kbd{Do} is a
221 good candidate for this, on keyboards that have such a key.
223 If you need to run non-interactive Emacs functions, see @ref{Evaluating
224 Emacs Lisp code}.
226 @node Emacs manual
227 @section How do I read topic XXX in the Emacs manual?
228 @cindex Emacs manual, reading topics in
229 @cindex Reading topics in the Emacs manual
230 @cindex Finding topics in the Emacs manual
231 @cindex Info, finding topics in
233 When we refer you to some @var{topic} in the Emacs manual, you can
234 read this manual node inside Emacs (assuming nothing is broken) by
235 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
237 This invokes Info, the GNU hypertext documentation browser.  If you don't
238 already know how to use Info, type @key{?} from within Info.
240 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
241 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
243 If these commands don't work as expected, your system administrator may
244 not have installed the Info files, or may have installed them
245 improperly.  In this case you should complain.
247 If you are reading this FAQ in Info, you can simply press @key{RET} on a
248 reference to follow it.
250 @xref{Getting a printed manual}, if you would like a paper copy of the
251 Emacs manual.
253 @node File-name conventions
254 @section What are @file{src/config.h}, @file{site-lisp/default.el}, etc.?
255 @cindex File-name conventions
256 @cindex Conventions for file names
257 @cindex Directories and files that come with Emacs
259 These are files that come with Emacs.  The Emacs distribution is divided
260 into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}.
261 Some of these (e.g. @file{etc} and @file{lisp}) are present both in
262 an installed Emacs and in the sources, but some (e.g. @file{src}) are
263 only found in the sources.
265 If you use Emacs, but don't know where it is kept on your system, start
266 Emacs, then type @kbd{C-h v data-directory @key{RET}}.  The directory
267 name displayed by this will be the full pathname of the installed
268 @file{etc} directory.  (This full path is recorded in the Emacs variable
269 @code{data-directory}, and @kbd{C-h v} displays the value and the
270 documentation of a variable.)
272 The location of your Info directory (i.e., where Info documentation
273 is stored) is kept in the variable @code{Info-default-directory-list}.  Use
274 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
275 this variable, which will be a list of directory names.  The last
276 directory in that list is probably where most Info files are stored.  By
277 default, Emacs Info documentation is placed in @file{/usr/local/share/info}.
279 For information on some of the files in the @file{etc} directory,
280 @pxref{Informational files for Emacs}.
282 @node Common acronyms
283 @section What are FSF, LPF, GNU, RMS, FTP, and GPL?
284 @cindex FSF, definition of
285 @cindex LPF, definition of
286 @cindex GNU, definition of
287 @cindex RMS, definition of
288 @cindex Stallman, Richard, acronym for
289 @cindex Richard Stallman, acronym for
290 @cindex FTP, definition of
291 @cindex GPL, definition of
292 @cindex Acronyms, definitions for
293 @cindex Common acronyms, definitions for
295 @table @asis
297 @item FSF
298 Free Software Foundation
300 @item LPF
301 League for Programming Freedom
303 @item GNU
304 GNU's Not Unix
306 @item RMS
307 Richard Matthew Stallman
309 @item FTP
310 File Transfer Protocol
312 @item GPL
313 GNU General Public License
315 @end table
317 Avoid confusing the FSF and the LPF.  The LPF opposes
318 look-and-feel copyrights and software patents.  The FSF aims to make
319 high quality free software available for everyone.
321 The word ``free'' in the title of the Free Software Foundation refers to
322 ``freedom,'' not ``zero cost.''  Anyone can charge any price for
323 GPL-covered software that they want to.  However, in practice, the
324 freedom enforced by the GPL leads to low prices, because you can always
325 get the software for less money from someone else, since everyone has
326 the right to resell or give away GPL-covered software.
328 @c ------------------------------------------------------------
329 @node General questions
330 @chapter General questions
331 @cindex General questions
333 This chapter contains general questions having to do with Emacs, the
334 Free Software Foundation, and related organizations.
336 @menu
337 * The LPF::
338 * Real meaning of copyleft::
339 * Guidelines for newsgroup postings::
340 * Newsgroup archives::
341 * Reporting bugs::
342 * Unsubscribing from Emacs lists::
343 * Contacting the FSF::
344 @end menu
346 @node The LPF
347 @section What is the LPF?
348 @cindex LPF, description of
349 @cindex League for Programming Freedom
350 @cindex Software patents, opposition to
351 @cindex Patents for software, opposition to
353 The LPF opposes the expanding danger of software patents and
354 look-and-feel copyrights.  More information on the LPF's views is
355 available at @uref{http://progfree.org/, the LPF home page}.
357 @node Real meaning of copyleft
358 @section What is the real legal meaning of the GNU copyleft?
359 @cindex Copyleft, real meaning of
360 @cindex GPL, real meaning of
361 @cindex General Public License, real meaning of
362 @cindex Discussion of the GPL
364 The real legal meaning of the GNU General Public License (copyleft) will
365 only be known if and when a judge rules on its validity and scope.
366 There has never been a copyright infringement case involving the GPL to
367 set any precedents.  Although legal actions have been brought against
368 companies for violating the terms of the GPL, so far all have been
369 settled out of court (in favor of the plaintiffs).  Please take any
370 discussion regarding this issue to the newsgroup
371 @uref{news:gnu.misc.discuss}, which was created to hold the extensive
372 flame wars on the subject.
374 RMS writes:
376 @quotation
377 The legal meaning of the GNU copyleft is less important than the spirit,
378 which is that Emacs is a free software project and that work pertaining
379 to Emacs should also be free software.  ``Free'' means that all users
380 have the freedom to study, share, change and improve Emacs.  To make
381 sure everyone has this freedom, pass along source code when you
382 distribute any version of Emacs or a related program, and give the
383 recipients the same freedom that you enjoyed.
384 @end quotation
386 @node Guidelines for newsgroup postings
387 @section  What are appropriate messages for the various Emacs newsgroups?
388 @cindex Newsgroups, appropriate messages for
389 @cindex GNU newsgroups, appropriate messages for
390 @cindex Usenet groups, appropriate messages for
391 @cindex Mailing lists, appropriate messages for
392 @cindex Posting messages to newsgroups
394 @cindex GNU mailing lists
395 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU
396 mailing list (@pxref{Informational files for Emacs}).  For those lists
397 which are gatewayed with newsgroups, it lists both the newsgroup name
398 and the mailing list address.  The Emacs mailing lists are also
399 described at @uref{http://savannah.gnu.org/mail/?group=emacs, the Emacs
400 Savannah page}.
402 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
403 in general.  The newsgroup @uref{news:gnu.emacs.help} is specifically
404 for GNU Emacs.  It therefore makes no sense to cross-post to both
405 groups, since only one can be appropriate to any question.
407 Messages advocating ``non-free'' software are considered unacceptable on
408 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
409 which was created to hold the extensive flame-wars on the subject.
410 ``Non-free'' software includes any software for which the end user can't
411 freely modify the source code and exchange enhancements.  Be careful to
412 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
413 posting a followup that recommends such software.
415 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
416 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
418 @node Newsgroup archives
419 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
420 @cindex Archived postings from @code{gnu.emacs.help}
421 @cindex Usenet archives for GNU groups
422 @cindex Old Usenet postings for GNU groups
424 The FSF has maintained archives of all of the GNU mailing lists for many
425 years, although there may be some unintentional gaps in coverage.  The
426 archive can be browsed over the web at
427 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}.  Raw
428 files can be downloaded from @uref{ftp://lists.gnu.org/}.
430 Web-based Usenet search services, such as
431 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
432 archive the @code{gnu.*} groups.
434 You can also read the archives of the @code{gnu.*} groups and post new
435 messages at @uref{http://gmane.org/, Gmane}.  Gmane is a service that
436 presents mailing lists as newsgroups (even those without a traditional
437 mail-to-news gateway).
439 @node Reporting bugs
440 @section Where should I report bugs and other problems with Emacs?
441 @cindex Bug reporting
442 @cindex Good bug reports
443 @cindex How to submit a bug report
444 @cindex Reporting bugs
446 The correct way to report Emacs bugs is to use the command
447 @kbd{M-x report-emacs-bug}.  It sets up a mail buffer with the
448 essential information and the correct e-mail address, which is
449 @email{bug-gnu-emacs@@gnu.org} for the released versions of Emacs.
450 Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the
451 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
452 news to submit the bug report.  This ensures a reliable return address
453 so you can be contacted for further details.
455 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
456 a bug!  The manual describes in detail how to submit a useful bug
457 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
458 (@xref{Emacs manual}, if you don't know how to read the manual.)
460 RMS says:
462 @quotation
463 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the
464 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because
465 it takes the time of an unnecessarily large group of people, most of
466 whom are just users and have no idea how to fix these problem.
467 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people
468 who are more likely to know what to do and have expressed a wish to
469 receive more messages about Emacs than the others.
470 @end quotation
472 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
474 @quotation
475 If you have reported a bug and you don't hear about a possible fix,
476 then after a suitable delay (such as a week) it is okay to post on
477 @code{gnu.emacs.help} asking if anyone can help you.
478 @end quotation
480 If you are unsure whether you have found a bug, consider the following
481 non-exhaustive list, courtesy of RMS:
483 @quotation
484 If Emacs crashes, that is a bug.  If Emacs gets compilation errors
485 while building, that is a bug.  If Emacs crashes while building, that
486 is a bug.  If Lisp code does not do what the documentation says it
487 does, that is a bug.
488 @end quotation
490 @node Unsubscribing from Emacs lists
491 @section  How do I unsubscribe from a mailing list?
492 @cindex Unsubscribing from GNU mailing lists
493 @cindex Removing yourself from GNU mailing lists
495 If you are receiving a GNU mailing list named @var{list}, you should be
496 able to unsubscribe from it by sending a request to the address
497 @email{@var{list}-request@@gnu.org}.  Mailing lists mails normally
498 contain information in either the message header
499 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
500 unsubscribe.
502 @node Contacting the FSF
503 @section  How do I contact the FSF?
504 @cindex Contracting the FSF
505 @cindex Free Software Foundation, contacting
507 For up-to-date information, see
508 @uref{http://www.fsf.org/about/contact.html, the FSF contact web-page}.
509 You can send general correspondence to @email{info@@fsf.org}.
511 @cindex Ordering GNU software
512 For details on how to order items directly from the FSF, see the
513 @uref{http://shop.fsf.org/, FSF on-line store}.
515 @c ------------------------------------------------------------
516 @node Getting help
517 @chapter Getting help
518 @cindex Getting help
520 This chapter tells you how to get help with Emacs.
522 @menu
523 * Basic editing::
524 * Learning how to do something::
525 * Getting a printed manual::
526 * Emacs Lisp documentation::
527 * Installing Texinfo documentation::
528 * Printing a Texinfo file::
529 * Viewing Info files outside of Emacs::
530 * Informational files for Emacs::
531 * Help installing Emacs::
532 * Obtaining the FAQ::
533 @end menu
535 @node Basic editing
536 @section I'm just starting Emacs; how do I do basic editing?
537 @cindex Basic editing with Emacs
538 @cindex Beginning editing
539 @cindex Tutorial, invoking the
540 @cindex Self-paced tutorial, invoking the
541 @cindex Help system, entering the
543 Type @kbd{C-h t} to invoke the self-paced tutorial.  Just typing
544 @kbd{C-h} enters the help system.  Starting with Emacs 22, the tutorial
545 is available in many foreign languages such as French, German, Japanese,
546 Russian, etc.  Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
547 to choose your language and start the tutorial.
549 Your system administrator may have changed @kbd{C-h} to act like
550 @key{DEL} to deal with local keyboards.  You can use @kbd{M-x
551 help-for-help} instead to invoke help.  To discover what key (if any)
552 invokes help on your system, type @kbd{M-x where-is @key{RET}
553 help-for-help @key{RET}}.  This will print a comma-separated list of key
554 sequences in the echo area.  Ignore the last character in each key
555 sequence listed.  Each of the resulting key sequences (e.g. @key{F1} is
556 common) invokes help.
558 Emacs help works best if it is invoked by a single key whose value
559 should be stored in the variable @code{help-char}.
561 @node Learning how to do something
562 @section How do I find out how to do something in Emacs?
563 @cindex Help for Emacs
564 @cindex Learning to do something in Emacs
565 @cindex Reference card for Emacs
566 @cindex Overview of help systems
568 There are several methods for finding out how to do things in Emacs.
570 @itemize @bullet
572 @cindex Reading the Emacs manual
573 @item
574 The complete text of the Emacs manual is available via the Info
575 hypertext reader.  Type @kbd{C-h r} to display the manual in Info mode.
576 Typing @key{h} immediately after entering Info will provide a short
577 tutorial on how to use it.
579 @cindex Lookup a subject in a manual
580 @cindex Index search in a manual
581 @item
582 To quickly locate the section of the manual which discusses a certain
583 issue, or describes a command or a variable, type @kbd{C-h i m emacs
584 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
585 topic, the command, or the variable which you are looking for.  If this
586 does not land you on the right place in the manual, press @kbd{,}
587 (comma) repeatedly until you find what you need.  (The @kbd{i} and
588 @kbd{,} keys invoke the index-searching functions, which look for the
589 @var{topic} you type in all the indices of the Emacs manual.)
591 @cindex Apropos
592 @item
593 You can list all of the commands whose names contain a certain word
594 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
595 command-apropos}).
597 @cindex Command description in the manual
598 @item
599 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
600 for the name of a command, and then attempts to find the section in the
601 Emacs manual where that command is described.
603 @cindex Finding commands and variables
604 @item
605 You can list all of the functions and variables whose names contain a
606 certain word using @kbd{M-x apropos}.
608 @item
609 You can list all of the functions and variables whose documentation
610 matches a regular expression or a string, using @kbd{M-x
611 apropos-documentation}.
613 @item
614 You can order a hardcopy of the manual from the FSF.  @xref{Getting a
615 printed manual}.
617 @cindex Reference cards, in other languages
618 @item
619 You can get a printed reference card listing commands and keys to
620 invoke them.  You can order one from the FSF for $2 (or 10 for $18),
621 or you can print your own from the @file{etc/refcards/refcard.tex} or
622 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
623 Beginning with version 21.1, the Emacs distribution comes with
624 translations of the reference card into several languages; look for
625 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
626 is a two-letter code of the language.  For example, the German version
627 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
628 and @file{etc/refcards/de-refcard.pdf}.
630 @item
631 There are many other commands in Emacs for getting help and
632 information.  To get a list of these commands, type @samp{?} after
633 @kbd{C-h}.
635 @end itemize
637 @node Getting a printed manual
638 @section How do I get a printed copy of the Emacs manual?
639 @cindex Printed Emacs manual, obtaining
640 @cindex Manual, obtaining a printed or HTML copy of
641 @cindex Emacs manual, obtaining a printed or HTML copy of
643 You can order a printed copy of the Emacs manual from the FSF.  For
644 details see the @uref{http://shop.fsf.org/, FSF on-line store}.
646 The full Texinfo source for the manual also comes in the @file{doc/emacs}
647 directory of the Emacs distribution, if you're daring enough to try to
648 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
649 file}).
651 If you absolutely have to print your own copy, and you don't have @TeX{},
652 you can get a PostScript or PDF (or HTML) version from
654 @uref{http://www.gnu.org/software/emacs/manual/}
656 @xref{Learning how to do something}, for how to view the manual from Emacs.
658 @node Emacs Lisp documentation
659 @section Where can I get documentation on Emacs Lisp?
660 @cindex Documentation on Emacs Lisp
661 @cindex Function documentation
662 @cindex Variable documentation
663 @cindex Emacs Lisp Reference Manual
664 @cindex Reference manual for Emacs Lisp
666 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
667 function, @kbd{C-h v} for a variable.
669 For more information, the Emacs Lisp Reference Manual is available
670 in Info format (@pxref{Top, Emacs Lisp,, elisp, The
671 Emacs Lisp Reference Manual}).
673 You can also order a hardcopy of the manual from the FSF, for details
674 see the @uref{http://shop.fsf.org/, FSF on-line store}.  (This manual is
675 not always in print.)
677 An HTML version of the Emacs Lisp Reference Manual is available at
679 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html}
681 @node Installing Texinfo documentation
682 @section How do I install a piece of Texinfo documentation?
683 @cindex Texinfo documentation, installing
684 @cindex Installing Texinfo documentation
685 @cindex New Texinfo files, installing
686 @cindex Documentation, installing new Texinfo files
687 @cindex Info files, how to install
689 Emacs releases come with pre-built Info files, and the normal install
690 process places them in the correct location.  This is true for most
691 applications that provide Info files.  The following section is only
692 relevant if you want to install extra Info files by hand.
694 First, you must turn the Texinfo source files into Info files.  You may
695 do this using the stand-alone @file{makeinfo} program, available as part
696 of the Texinfo package at
698 @uref{http://www.gnu.org/software/texinfo/}
700 For information about the Texinfo format, read the Texinfo manual which
701 comes with the Texinfo package.  This manual also comes installed in
702 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
703 @key{RET}}.
705 @c FIXME is this a complete alternative?
706 @c Probably not, given that we require makeinfo to build Emacs.
707 Alternatively, you could use the Emacs command @kbd{M-x
708 texinfo-format-buffer}, after visiting the Texinfo source file of the
709 manual you want to convert.
711 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
712 resulting Info files in Emacs's Info tree.  To install Info files,
713 perform these steps:
715 @enumerate
716 @item
717 Move the files to the @file{info} directory in the installed Emacs
718 distribution.  @xref{File-name conventions}, if you don't know where that
721 @item
722 Run the @code{install-info} command, which is part of the Texinfo
723 distribution, to update the main Info directory menu, like this:
725 @example
726  install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
727 @end example
729 @noindent
730 where @var{dir-path} is the full path to the directory where you copied
731 the produced Info file(s), and @var{file} is the name of the Info file
732 you produced and want to install.
734 If you don't have the @code{install-info} command installed, you can
735 edit the file @file{info/dir} in the installed Emacs distribution, and
736 add a line for the top level node in the Info package that you are
737 installing.  Follow the examples already in this file.  The format is:
739 @example
740 * Topic: (relative-pathname).  Short description of topic.
741 @end example
743 @end enumerate
745 If you want to install Info files and you don't have the necessary
746 privileges, you have several options:
748 @itemize @bullet
749 @item
750 Info files don't actually need to be installed before being used.
751 You can use a prefix argument for the @code{info} command and specify
752 the name of the Info file in the minibuffer.  This goes to the node
753 named @samp{Top} in that file.  For example, to view a Info file named
754 @file{@var{info-file}} in your home directory, you can type this:
756 @example
757 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
758 @end example
760 Alternatively, you can feed a file name to the @code{Info-goto-node}
761 command (invoked by pressing @key{g} in Info mode) by typing the name
762 of the file in parentheses, like this:
764 @example
765 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
766 @end example
768 @item
769 You can create your own Info directory.  You can tell Emacs where that
770 Info directory is by adding its pathname to the value of the variable
771 @code{Info-default-directory-list}.  For example, to use a private Info
772 directory which is a subdirectory of your home directory named @file{Info},
773 you could put this in your @file{.emacs} file:
775 @lisp
776 (add-to-list 'Info-default-directory-list "~/Info")
777 @end lisp
779 You will need a top-level Info file named @file{dir} in this directory
780 which has everything the system @file{dir} file has in it, except it
781 should list only entries for Info files in that directory.  You might
782 not need it if (fortuitously) all files in this directory were
783 referenced by other @file{dir} files.  The node lists from all
784 @file{dir} files in @code{Info-default-directory-list} are merged by the
785 Info system.
787 @end itemize
789 @node Printing a Texinfo file
790 @section How do I print a Texinfo file?
791 @cindex Printing a Texinfo file
792 @cindex Texinfo file, printing
793 @cindex Printing documentation
795 You can't get nicely printed output from Info files; you must still have
796 the original Texinfo source file for the manual you want to print.
798 Assuming you have @TeX{} installed on your system, follow these steps:
800 @enumerate
802 @item
803 Make sure the first line of the Texinfo file looks like this:
805 @example
806 \input texinfo
807 @end example
809 You may need to change @samp{texinfo} to the full pathname of the
810 @file{texinfo.tex} file, which comes with Emacs as
811 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
813 @item
814 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
815 the name of the Texinfo source file for which you want to produce a
816 printed copy.  The @samp{texi2dvi} script is part of the GNU Texinfo
817 distribution.
819 Alternatively, @samp{texi2pdf} produces PDF files.
821 @item
822 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
823 printing DVI files at your site.  For example, if you have a PostScript
824 printer, run the @code{dvips} program to print the DVI file on that
825 printer.
827 @end enumerate
829 To get more general instructions, retrieve the latest Texinfo package
830 (@pxref{Installing Texinfo documentation}).
832 @node Viewing Info files outside of Emacs
833 @section Can I view Info files without using Emacs?
834 @cindex Viewing Info files
835 @cindex Info file viewers
836 @cindex Alternative Info file viewers
838 Yes.  Here are some alternative programs:
840 @itemize @bullet
842 @item
843 @code{info}, a stand-alone version of the Info program, comes as part of
844 the Texinfo package.  @xref{Installing Texinfo documentation}, for
845 details.
847 @item
848 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
849 You can get Tkinfo at
850 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
852 @end itemize
854 @node Informational files for Emacs
855 @section What informational files are available for Emacs?
856 @cindex Informational files included with Emacs
857 @cindex Files included with Emacs
858 @cindex @file{COPYING}, description of file
859 @cindex @file{DISTRIB}, description of file
860 @cindex @file{GNU}, description of file
861 @cindex @file{INTERVIEW}, description of file
862 @cindex @file{MACHINES}, description of file
863 @cindex @file{MAILINGLISTS}, description of file
864 @cindex @file{NEWS}, description of file
866 This isn't a frequently asked question, but it should be!  A variety of
867 informational files about Emacs and relevant aspects of the GNU project
868 are available for you to read.
870 The following files (and others) are available in the @file{etc}
871 directory of the Emacs distribution (see @ref{File-name conventions}, if
872 you're not sure where that is).  Many of these files are available via
873 the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
874 help-for-help}).
876 @table @file
878 @item COPYING
879 GNU General Public License
881 @item DISTRIB
882 Emacs Availability Information
884 @item GNU
885 The GNU Manifesto
887 @item INTERVIEW
888 Richard Stallman discusses his public-domain UNIX-compatible software
889 system with BYTE editors
891 @item MACHINES
892 Status of Emacs on Various Machines and Systems
894 @item MAILINGLISTS
895 GNU Project Electronic Mailing Lists
897 @item NEWS
898 Emacs news, a history of recent user-visible changes
900 @end table
902 More GNU information, including back issues of the @cite{GNU's
903 Bulletin}, are at
905 @uref{http://www.gnu.org/bulletins/bulletins.html} and
907 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
909 @node Help installing Emacs
910 @section Where can I get help in installing Emacs?
911 @cindex Installation help
912 @cindex Help installing Emacs
914 @xref{Installing Emacs}, for some basic installation hints, and see
915 @ref{Problems building Emacs}, if you have problems with the installation.
917 @uref{http://www.fsf.org/resources/service/, The GNU Service directory}
918 lists companies and individuals willing to sell you help in installing
919 or using Emacs and other GNU software.
921 @node Obtaining the FAQ
922 @section Where can I get the latest version of this FAQ?
923 @cindex FAQ, obtaining the
924 @cindex Latest FAQ version, obtaining the
926 The Emacs FAQ is distributed with Emacs in Info format.  You can read it
927 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
928 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
929 C-f} (@kbd{M-x view-emacs-FAQ}).  The very latest version is available
930 in the Emacs development repository (@pxref{Latest version of Emacs}).
932 @c ------------------------------------------------------------
933 @node Status of Emacs
934 @chapter Status of Emacs
935 @cindex Status of Emacs
937 This chapter gives you basic information about Emacs, including the
938 status of its latest version.
940 @menu
941 * Origin of the term Emacs::
942 * Latest version of Emacs::
943 * New in Emacs 24::
944 * New in Emacs 23::
945 * New in Emacs 22::
946 * New in Emacs 21::
947 * New in Emacs 20::
948 @end menu
950 @node Origin of the term Emacs
951 @section Where does the name ``Emacs'' come from?
952 @cindex Origin of the term ``Emacs''
953 @cindex Emacs name origin
954 @cindex TECO
955 @cindex Original version of Emacs
957 Emacs originally was an acronym for Editor MACroS.  RMS says he ``picked
958 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
959 the time.''  The first Emacs was a set of macros written in 1976 at MIT
960 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
961 Editor and COrrector) under ITS (the Incompatible Timesharing System) on
962 a PDP-10.  RMS had already extended TECO with a ``real-time''
963 full-screen mode with reprogrammable keys.  Emacs was started by
964 @email{gls@@east.sun.com, Guy Steele} as a project to unify the many
965 divergent TECO command sets and key bindings at MIT, and completed by
966 RMS.
968 Many people have said that TECO code looks a lot like line noise; you
969 can read more at @uref{news:alt.lang.teco}.  Someone has written a TECO
970 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
971 come with Emacs}); it would be an interesting project to run the
972 original TECO Emacs inside of Emacs.
974 @cindex Why Emacs?
975 For some not-so-serious alternative reasons for Emacs to have that
976 name, check out the file @file{etc/JOKES} (@pxref{File-name
977 conventions}).
979 @node Latest version of Emacs
980 @section What is the latest version of Emacs?
981 @cindex Version, latest
982 @cindex Latest version of Emacs
983 @cindex Development, Emacs
984 @cindex Repository, Emacs
985 @cindex Bazaar repository, Emacs
987 Emacs @value{EMACSVER} is the current version as of this writing.  A version
988 number with two components (e.g. @samp{22.1}) indicates a released
989 version; three components indicate a development
990 version (e.g. @samp{23.0.50} is what will eventually become @samp{23.1}).
992 Emacs is under active development, hosted at
993 @uref{http://savannah.gnu.org/projects/emacs/, Savannah}.  The source
994 code can be retrieved anonymously following the
995 @uref{http://savannah.gnu.org/bzr/?group=emacs, instructions}.
996 The repository is GNU Bazaar.
998 Because Emacs undergoes many changes before a release, the version
999 number of a development version is not especially meaningful.  It is
1000 better to refer to the date on which the sources were retrieved from the
1001 development repository.  The development version is usually quite robust
1002 for every-day use, but if stability is more important to you than the
1003 latest features, you may want to stick to the releases.
1005 The following sections list some of the major new features in the last
1006 few Emacs releases.  For full details of the changes in any version of
1007 Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}).  As of Emacs 22,
1008 you can give this command a prefix argument to read about which features
1009 were new in older versions.
1011 @node New in Emacs 24
1012 @section What is different about Emacs 24?
1013 @cindex Differences between Emacs 23 and Emacs 24
1014 @cindex Emacs 24, new features in
1016 @itemize
1017 @cindex packages, installing more
1018 @item
1019 Emacs now includes a package manager.  Type @kbd{M-x list-packages} to
1020 get started.  You can use this to download and automatically install
1021 many more Lisp packages.
1023 @cindex lexical binding
1024 @item
1025 Emacs Lisp now supports lexical binding on a per-file basis.  In
1026 @emph{lexical binding}, variable references must be located textually
1027 within the binding construct.  This contrasts with @emph{dynamic
1028 binding}, where programs can refer to variables defined outside their
1029 local textual scope.  A Lisp file can use a local variable setting of
1030 @code{lexical-binding: t} to indicate that the contents should be
1031 interpreted using lexical binding.  See the Emacs Lisp Reference
1032 Manual for more details.
1034 @cindex bidirectional display
1035 @cindex right-to-left languages
1036 @item
1037 Some human languages, such as English, are written from left to right.
1038 Others, such as Arabic, are written from right to left.  Emacs now has
1039 support for any mixture of these forms---this is ``bidirectional text''.
1041 @item
1042 Handling of text selections has been improved, and now integrates
1043 better with external clipboards.
1045 @cindex themes
1046 @item
1047 A new command @kbd{customize-themes} allows you to easily change the
1048 appearance of your Emacs.
1050 @item
1051 Emacs can be compiled with the GTK+ 3 toolkit.
1053 @item
1054 Support for several new external libraries can be included at compile
1055 time:
1057 @itemize
1059 @item
1060 ``Security-Enhanced Linux'' (SELinux) is a Linux kernel feature that
1061 provides more sophisticated file access controls than ordinary
1062 ``Unix-style'' file permissions.
1064 @item
1065 The ImageMagick display library.  This allows you to display many more
1066 image format in Emacs, as well as carry out transformations such as
1067 rotations.
1069 @item
1070 The GnuTLS library for secure network communications.  Emacs uses this
1071 transparently for email if your mail server supports it.
1073 @item
1074 The libxml2 library for parsing XML structures.
1075 @end itemize
1077 @item
1078 Much more flexibility in the handling of windows and buffer display.
1080 @end itemize
1082 As always, consult the @file{NEWS} file for more information.
1085 @node New in Emacs 23
1086 @section What is different about Emacs 23?
1087 @cindex Differences between Emacs 22 and Emacs 23
1088 @cindex Emacs 23, new features in
1090 @itemize
1092 @cindex Anti-aliased fonts
1093 @cindex Freetype fonts
1094 @item
1095 Emacs has a new font code that can use multiple font backends,
1096 including freetype and fontconfig.  Emacs can use the Xft library for
1097 anti-aliasing, and the otf and m17n libraries for complex text layout and
1098 text shaping.
1100 @cindex Unicode
1101 @cindex Character sets
1102 @item
1103 The Emacs character set is now a superset of Unicode.  Several new
1104 language environments have been added.
1106 @cindex Multi-tty support
1107 @cindex X and tty displays
1108 @item
1109 Emacs now supports using both X displays and ttys in the same session
1110 (@samp{multi-tty}).
1112 @cindex Daemon mode
1113 @item
1114 Emacs can be started as a daemon in the background.
1116 @cindex NeXTstep port
1117 @cindex GNUstep port
1118 @cindex Mac OS X Cocoa
1119 @item
1120 There is a new NeXTstep port of Emacs.  This supports GNUstep and Mac OS
1121 X (via the Cocoa libraries).  The Carbon port of Emacs, which supported
1122 Mac OS X in Emacs 22, has been removed.
1124 @cindex Directory-local variables
1125 @item
1126 Directory-local variables can now be defined, in a similar manner to
1127 file-local variables.
1129 @item
1130 Transient Mark mode (@pxref{Highlighting a region}) is on by default.
1132 @end itemize
1134 @noindent
1135 Other changes include: support for serial port access; D-Bus bindings; a
1136 new Visual Line mode for line-motion; improved completion; a new mode
1137 (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML
1138 mode (for editing XML documents) is included; VC has been updated for
1139 newer version control systems; etc.
1142 @node New in Emacs 22
1143 @section What is different about Emacs 22?
1144 @cindex Differences between Emacs 21 and Emacs 22
1145 @cindex Emacs 22, new features in
1147 @itemize
1148 @cindex GTK+ Toolkit
1149 @cindex Drag-and-drop
1150 @item
1151 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1152 operation on X.
1154 @cindex Supported systems
1155 @item
1156 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1157 machines, as well as support for the Mac OS X and Cygwin operating
1158 systems.
1160 @item
1161 The native MS-Windows, and Mac OS X builds include full support
1162 for images, toolbar, and tooltips.
1164 @item
1165 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1166 enabled by default.
1168 @item
1169 The maximum size of buffers is increased: on 32-bit machines, it is
1170 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above.
1172 @item
1173 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1175 @cindex Mouse wheel
1176 @item
1177 Mouse wheel support is enabled by default.
1179 @item
1180 Window fringes are customizable.
1182 @item
1183 The mode line of the selected window is now highlighted.
1185 @item
1186 The minibuffer prompt is displayed in a distinct face.
1188 @item
1189 Abbrev definitions are read automatically at startup.
1191 @item
1192 Grep mode is separate from Compilation mode and has many new options and
1193 commands specific to grep.
1195 @item
1196 The original Emacs macro system has been replaced by the new Kmacro
1197 package, which provides many new commands and features and a simple
1198 interface that uses the function keys F3 and F4.  Macros are stored in a
1199 macro ring, and can be debugged and edited interactively.
1201 @item
1202 The Grand Unified Debugger (GUD) can be used with a full graphical user
1203 interface to GDB; this provides many features found in traditional
1204 development environments, making it easy to manipulate breakpoints, add
1205 watch points, display the call stack, etc.  Breakpoints are visually
1206 indicated in the source buffer.
1208 @item
1209 @cindex New modes
1210 Many new modes and packages have been included in Emacs, such as Calc,
1211 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1212 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1213 savehist, Conf mode, Python mode, DNS mode, etc.
1215 @cindex Multilingual Environment
1216 @item
1217 Leim is now part of Emacs.  Unicode support has been much improved, and
1218 the following input methods have been added: belarusian, bulgarian-bds,
1219 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1220 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1221 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1222 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1223 ukrainian-computer, vietnamese-telex, and welsh.
1225 The following language environments have also been added: Belarusian,
1226 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1227 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1228 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1230 @cindex Documentation
1231 @cindex Emacs Lisp Manual
1232 @item
1233 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1234 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1235 @end itemize
1238 @node New in Emacs 21
1239 @section What is different about Emacs 21?
1240 @cindex Differences between Emacs 20 and Emacs 21
1241 @cindex Emacs 21, new features in
1243 @cindex Variable-size fonts
1244 @cindex Toolbar support
1245 Emacs 21 features a thorough rewrite of the display engine.  The new
1246 display engine supports variable-size fonts, images, and can play sounds
1247 on platforms which support that.  As a result, the visual appearance of
1248 Emacs, when it runs on a windowed display, is much more reminiscent of
1249 modern GUI programs, and includes 3D widgets (used for the mode line and
1250 the scroll bars), a configurable and extensible toolbar, tooltips
1251 (a.k.a.@: balloon help), and other niceties.
1253 @cindex Colors on text-only terminals
1254 @cindex TTY colors
1255 In addition, Emacs 21 supports faces on text-only terminals.  This means
1256 that you can now have colors when you run Emacs on a GNU/Linux console
1257 and on @code{xterm} with @kbd{emacs -nw}.
1260 @node New in Emacs 20
1261 @section What is different about Emacs 20?
1262 @cindex Differences between Emacs 19 and Emacs 20
1263 @cindex Emacs 20, new features in
1265 The differences between Emacs versions 18 and 19 were rather dramatic;
1266 the introduction of frames, faces, and colors on windowing systems was
1267 obvious to even the most casual user.
1269 There are differences between Emacs versions 19 and 20 as well, but many
1270 are more subtle or harder to find.  Among the changes are the inclusion
1271 of MULE code for languages that use non-Latin characters and for mixing
1272 several languages in the same document; the ``Customize'' facility for
1273 modifying variables without having to use Lisp; and automatic conversion
1274 of files from Macintosh, Microsoft, and Unix platforms.
1276 @c ------------------------------------------------------------
1277 @node Common requests
1278 @chapter Common requests
1279 @cindex Common requests
1281 @menu
1282 * Setting up a customization file::
1283 * Using Customize::
1284 * Colors on a TTY::
1285 * Debugging a customization file::
1286 * Displaying the current line or column::
1287 * Displaying the current file name in the titlebar::
1288 * Turning on abbrevs by default::
1289 * Associating modes with files::
1290 * Highlighting a region::
1291 * Replacing highlighted text::
1292 * Controlling case sensitivity::
1293 * Working with unprintable characters::
1294 * Searching for/replacing newlines::
1295 * Yanking text in isearch::
1296 * Wrapping words automatically::
1297 * Turning on auto-fill by default::
1298 * Changing load-path::
1299 * Using an already running Emacs process::
1300 * Compiler error messages::
1301 * Indenting switch statements::
1302 * Customizing C and C++ indentation::
1303 * Horizontal scrolling::
1304 * Overwrite mode::
1305 * Turning off beeping::
1306 * Turning the volume down::
1307 * Automatic indentation::
1308 * Matching parentheses::
1309 * Hiding #ifdef lines::
1310 * Repeating commands::
1311 * Valid X resources::
1312 * Evaluating Emacs Lisp code::
1313 * Changing the length of a Tab::
1314 * Inserting text at the beginning of each line::
1315 * Forcing the cursor to remain in the same column::
1316 * Forcing Emacs to iconify itself::
1317 * Using regular expressions::
1318 * Replacing text across multiple files::
1319 * Documentation for etags::
1320 * Disabling backups::
1321 * Disabling auto-save-mode::
1322 * Going to a line by number::
1323 * Modifying pull-down menus::
1324 * Deleting menus and menu options::
1325 * Turning on syntax highlighting::
1326 * Scrolling only one line::
1327 * Editing MS-DOS files::
1328 * Filling paragraphs with a single space::
1329 * Escape sequences in shell output::
1330 * Fullscreen mode on MS-Windows::
1331 @end menu
1333 @node Setting up a customization file
1334 @section How do I set up a @file{.emacs} file properly?
1335 @cindex @file{.emacs} file, setting up
1336 @cindex @file{.emacs} file, locating
1337 @cindex Init file, setting up
1338 @cindex Customization file, setting up
1340 @xref{Init File,,, emacs, The GNU Emacs Manual}.
1342 In general, new Emacs users should not be provided with @file{.emacs}
1343 files, because this can cause confusing non-standard behavior.  Then
1344 they send questions to @email{help-gnu-emacs@@gnu.org} asking why Emacs
1345 isn't behaving as documented.
1347 Emacs includes the Customize facility (@pxref{Using Customize}).  This
1348 allows users who are unfamiliar with Emacs Lisp to modify their
1349 @file{.emacs} files in a relatively straightforward way, using menus
1350 rather than Lisp code.
1352 While Customize might indeed make it easier to configure Emacs,
1353 consider taking a bit of time to learn Emacs Lisp and modifying your
1354 @file{.emacs} directly.  Simple configuration options are described
1355 rather completely in @ref{Init File,,, emacs, The GNU Emacs Manual},
1356 for users interested in performing frequently requested, basic tasks.
1358 Sometimes users are unsure as to where their @file{.emacs} file should
1359 be found.  Visiting the file as @file{~/.emacs} from Emacs will find
1360 the correct file.
1362 @node Using Customize
1363 @section How do I start using Customize?
1364 @cindex Customize groups
1365 @cindex Customizing variables
1366 @cindex Customizing faces
1368 The main Customize entry point is @kbd{M-x customize @key{RET}}.  This
1369 command takes you to a buffer listing all the available Customize
1370 groups.  From there, you can access all customizable options and faces,
1371 change their values, and save your changes to your init file.
1372 @xref{Easy Customization,,, emacs, The GNU Emacs Manual}.
1374 If you know the name of the group in advance (e.g. ``shell''), use
1375 @kbd{M-x customize-group @key{RET}}.
1377 If you wish to customize a single option, use @kbd{M-x customize-option
1378 @key{RET}}.  This command prompts you for the name of the option to
1379 customize, with completion.
1381 @node Colors on a TTY
1382 @section How do I get colors and syntax highlighting on a TTY?
1383 @cindex Colors on a TTY
1384 @cindex Syntax highlighting on a TTY
1385 @cindex Console, colors
1387 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1388 i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when
1389 invoked as @samp{emacs -nw} on X, and MS-Windows.  (Colors and faces were
1390 supported in the MS-DOS port since Emacs 19.29.)  Emacs automatically
1391 detects color support at startup and uses it if available.  If you think
1392 that your terminal supports colors, but Emacs won't use them, check the
1393 @code{termcap} entry for your display type for color-related
1394 capabilities.
1396 The command @kbd{M-x list-colors-display} pops up a window which
1397 exhibits all the colors Emacs knows about on the current display.
1399 Syntax highlighting is on by default since version 22.1.
1401 @node Debugging a customization file
1402 @section How do I debug a @file{.emacs} file?
1403 @cindex Debugging @file{.emacs} file
1404 @cindex @file{.emacs} debugging
1405 @cindex Init file debugging
1406 @cindex @samp{-debug-init} option
1408 Start Emacs with the @samp{-debug-init} command-line option.  This
1409 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1410 file, and places you in the debugger if something goes wrong.  The top
1411 line in the @file{trace-back} buffer will be the error message, and the
1412 second or third line of that buffer will display the Lisp code from your
1413 @file{.emacs} file that caused the problem.
1415 You can also evaluate an individual function or argument to a function
1416 in your @file{.emacs} file by moving the cursor to the end of the
1417 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1418 eval-last-sexp}).
1420 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1421 variables which you are trying to set or use.
1423 @node Displaying the current line or column
1424 @section How do I make Emacs display the current line (or column) number?
1425 @cindex @code{line-number-mode}
1426 @cindex Displaying the current line or column
1427 @cindex Line number, displaying the current
1428 @cindex Column, displaying the current
1429 @cindex @code{mode-line-format}
1431 By default, Emacs displays the current line number of the point in the
1432 mode line.  You can toggle this feature off or on with the command
1433 @kbd{M-x line-number-mode}, or by setting the variable
1434 @code{line-number-mode}.  Note that Emacs will not display the line
1435 number if the buffer's size in bytes is larger than the value of the
1436 variable @code{line-number-display-limit}.
1438 You can similarly display the current column with
1439 @kbd{M-x column-number-mode}, or by putting the form
1441 @lisp
1442 (setq column-number-mode t)
1443 @end lisp
1445 @noindent
1446 in your @file{.emacs} file.  This feature is off by default.
1448 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1449 will insert the current column's value into the mode line.  See the
1450 documentation for @code{mode-line-format} (using @kbd{C-h v
1451 mode-line-format @key{RET}}) for more information on how to set and use
1452 this variable.
1454 @cindex Set number capability in @code{vi} emulators
1455 The @samp{linum} package (distributed with Emacs since version 23.1)
1456 displays line numbers in the left margin, like the ``set number''
1457 capability of @code{vi}.  The packages @samp{setnu} and
1458 @samp{wb-line-number} (not distributed with Emacs) also implement this
1459 feature.
1461 @node Displaying the current file name in the titlebar
1462 @section How can I modify the titlebar to contain the current file name?
1463 @cindex Titlebar, displaying the current file name in
1464 @cindex File name, displaying in the titlebar
1465 @cindex @code{frame-title-format}
1467 The contents of an Emacs frame's titlebar is controlled by the variable
1468 @code{frame-title-format}, which has the same structure as the variable
1469 @code{mode-line-format}.  (Use @kbd{C-h v} or @kbd{M-x
1470 describe-variable} to get information about one or both of these
1471 variables.)
1473 By default, the titlebar for a frame does contain the name of the buffer
1474 currently being visited, except if there is a single frame.  In such a
1475 case, the titlebar contains Emacs invocation name and the name of the
1476 machine at which Emacs was invoked.  This is done by setting
1477 @code{frame-title-format} to the default value of
1479 @lisp
1480 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1481 @end lisp
1483 To modify the behavior such that frame titlebars contain the buffer's
1484 name regardless of the number of existing frames, include the following
1485 in your @file{.emacs}:
1487 @lisp
1488 (setq frame-title-format "%b")
1489 @end lisp
1491 @node Turning on abbrevs by default
1492 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1493 @cindex Abbrevs, turning on by default
1495 Abbrev mode expands abbreviations as you type them.  To turn it on in a
1496 specific buffer, use @kbd{M-x abbrev-mode}.  To turn it on in every
1497 buffer by default, put this in your @file{.emacs} file:
1499 @lisp
1500 (setq-default abbrev-mode t)
1501 @end lisp
1503 @noindent To turn it on in a specific mode, use:
1505 @lisp
1506 (add-hook '@var{mymode}-mode-hook
1507           (lambda ()
1508            (setq abbrev-mode t)))
1509 @end lisp
1511 @noindent If your Emacs version is older then 22.1, you will also need to use:
1513 @lisp
1514 (condition-case ()
1515    (quietly-read-abbrev-file)
1516   (file-error nil))
1517 @end lisp
1519 @node Associating modes with files
1520 @section How do I make Emacs use a certain major mode for certain files?
1521 @cindex Associating modes with files
1522 @cindex File extensions and modes
1523 @cindex @code{auto-mode-alist}, modifying
1524 @cindex Modes, associating with file extensions
1526 If you want to use a certain mode @var{foo} for all files whose names end
1527 with the extension @file{.@var{bar}}, this will do it for you:
1529 @lisp
1530 (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode))
1531 @end lisp
1533 Alternatively, put this somewhere in the first line of any file you want to
1534 edit in the mode @var{foo} (in the second line, if the first line begins
1535 with @samp{#!}):
1537 @example
1538 -*- @var{foo} -*-
1539 @end example
1541 @cindex Major mode for shell scripts
1542 The variable @code{interpreter-mode-alist} specifies which mode to use
1543 when loading an interpreted script (e.g. shell, python, etc.).  Emacs
1544 determines which interpreter you're using by examining the first line of
1545 the script.  Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
1546 @code{interpreter-mode-alist} to learn more.
1548 @node Highlighting a region
1549 @section How can I highlight a region of text in Emacs?
1550 @cindex Highlighting text
1551 @cindex Text, highlighting
1552 @cindex @code{transient-mark-mode}
1553 @cindex Region, highlighting a
1555 You can cause the region to be highlighted when the mark is active by
1556 including
1558 @lisp
1559 (transient-mark-mode 1)
1560 @end lisp
1562 @noindent
1563 in your @file{.emacs} file.  Since Emacs 23.1, this feature is on by default.
1565 @node Replacing highlighted text
1566 @section How can I replace highlighted text with what I type?
1567 @cindex @code{delete-selection-mode}
1568 @cindex Replacing highlighted text
1569 @cindex Highlighting and replacing text
1571 Use @code{delete-selection-mode}, which you can start automatically by
1572 placing the following Lisp form in your @file{.emacs} file:
1574 @lisp
1575 (delete-selection-mode 1)
1576 @end lisp
1578 According to the documentation string for @code{delete-selection-mode}
1579 (which you can read using @kbd{M-x describe-function @key{RET}
1580 delete-selection-mode @key{RET}}):
1582 @quotation
1583 When Delete Selection mode is enabled, Transient Mark mode is also
1584 enabled and typed text replaces the selection if the selection is
1585 active.  Otherwise, typed text is just inserted at point regardless of
1586 any selection.
1587 @end quotation
1589 This mode also allows you to delete (not kill) the highlighted region by
1590 pressing @key{DEL}.
1592 @node Controlling case sensitivity
1593 @section How do I control Emacs's case-sensitivity when searching/replacing?
1594 @cindex @code{case-fold-search}
1595 @cindex Case sensitivity of searches
1596 @cindex Searching without case sensitivity
1597 @cindex Ignoring case in searches
1599 @c FIXME
1600 The value of the variable @code{case-fold-search} determines whether
1601 searches are case sensitive:
1603 @lisp
1604 (setq case-fold-search nil) ; make searches case sensitive
1605 (setq case-fold-search t)   ; make searches case insensitive
1606 @end lisp
1608 @cindex Case sensitivity in replacements
1609 @cindex Replacing, and case sensitivity
1610 @cindex @code{case-replace}
1611 Similarly, for replacing, the variable @code{case-replace} determines
1612 whether replacements preserve case.
1614 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1616 To change the case sensitivity just for one major mode, use the major
1617 mode's hook.  For example:
1619 @lisp
1620 (add-hook '@var{foo}-mode-hook
1621           (lambda ()
1622            (setq case-fold-search nil)))
1623 @end lisp
1625 @node Working with unprintable characters
1626 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1627 @cindex Unprintable characters, working with
1628 @cindex Working with unprintable characters
1629 @cindex Control characters, working with
1630 @cindex Eight-bit characters, working with
1631 @cindex Searching for unprintable characters
1632 @cindex Regexps and unprintable characters
1634 To search for a single character that appears in the buffer as, for
1635 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.
1636 Searching for @strong{all} unprintable characters is best done with a
1637 regular expression (@dfn{regexp}) search.  The easiest regexp to use for
1638 the unprintable chars is the complement of the regexp for the printable
1639 chars.
1641 @itemize @bullet
1643 @item
1644 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1646 @item
1647 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1649 @end itemize
1651 To type these special characters in an interactive argument to
1652 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1653 use @kbd{C-q}.  (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1654 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.)  So,
1655 to search for unprintable characters using @code{re-search-forward}:
1657 @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}}
1659 Using @code{isearch-forward-regexp}:
1661 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1663 To delete all unprintable characters, simply use replace-regexp:
1665 @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}}
1667 Replacing is similar to the above.  To replace all unprintable
1668 characters with a colon, use:
1670 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}
1672 @node Searching for/replacing newlines
1673 @section How do I input a newline character in isearch or query-replace?
1674 @cindex Searching for newlines
1675 @cindex Replacing newlines
1677 Use @kbd{C-q C-j}.  For more information,
1678 @pxref{Special Isearch,, Special Input for Incremental Search, emacs,
1679 The GNU Emacs Manual}.
1681 @node Yanking text in isearch
1682 @section How do I copy text from the kill ring into the search string?
1683 @cindex Yanking text into the search string
1684 @cindex isearch yanking
1686 Use @kbd{M-y}.  @xref{Isearch Yank,,, emacs, The GNU Emacs Manual}.
1688 @node Wrapping words automatically
1689 @section How do I make Emacs wrap words for me?
1690 @cindex Wrapping word automatically
1691 @cindex Wrapping lines
1692 @cindex Line wrap
1693 @cindex @code{auto-fill-mode}, introduction to
1694 @cindex Maximum line width, default value
1695 @cindex @code{fill-column}, default value
1697 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1698 The default maximum line width is 70, determined by the variable
1699 @code{fill-column}.  To learn how to turn this on automatically, see
1700 @ref{Turning on auto-fill by default}.
1702 @node Turning on auto-fill by default
1703 @section How do I turn on @code{auto-fill-mode} by default?
1704 @cindex @code{auto-fill-mode}, activating automatically
1705 @cindex Filling automatically
1706 @cindex Automatic entry to @code{auto-fill-mode}
1708 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1709 auto-fill-mode}.
1711 To turn it on for every buffer in a certain mode, you must use the hook
1712 for that mode.  For example, to turn on @code{auto-fill} mode for all
1713 text buffers, including the following in your @file{.emacs} file:
1715 @lisp
1716 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1717 @end lisp
1719 If you want @code{auto-fill} mode on in all major modes, do this:
1721 @lisp
1722 (setq-default auto-fill-function 'do-auto-fill)
1723 @end lisp
1725 @node Changing load-path
1726 @section How do I change @code{load-path}?
1727 @cindex @code{load-path}, modifying
1728 @cindex Modifying @code{load-path}
1729 @cindex Adding to @code{load-path}
1731 In general, you should only add to the @code{load-path}.  You can add
1732 directory @var{/dir/subdir} to the load path like this:
1734 @lisp
1735 (add-to-list 'load-path "/dir/subdir/")
1736 @end lisp
1738 To do this relative to your home directory:
1740 @lisp
1741 (add-to-list 'load-path "~/mysubdir/")
1742 @end lisp
1744 @node Using an already running Emacs process
1745 @section How do I use an already running Emacs from another window?
1746 @cindex @code{emacsclient}
1747 @cindex Emacs server functions
1748 @cindex Using an existing Emacs process
1750 @code{emacsclient}, which comes with Emacs, is for editing a file using
1751 an already running Emacs rather than starting up a new Emacs.  It does
1752 this by sending a request to the already running Emacs, which must be
1753 expecting the request.
1755 @itemize @bullet
1757 @item
1758 Setup:
1760 Emacs must have executed the @code{server-start} function for
1761 @samp{emacsclient} to work.  This can be done either by a command line
1762 option:
1764 @example
1765 emacs -f server-start
1766 @end example
1768 or by invoking @code{server-start} from @file{.emacs}:
1770 @lisp
1771 (if (@var{some conditions are met}) (server-start))
1772 @end lisp
1774 When this is done, Emacs creates a Unix domain socket named
1775 @file{server} in @file{/tmp/emacs@var{userid}}. See
1776 @code{server-socket-dir}.
1778 To get your news reader, mail reader, etc., to invoke
1779 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1780 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}.  You may
1781 have to specify the full pathname of the @samp{emacsclient} program
1782 instead.  Examples:
1784 @example
1785 # csh commands:
1786 setenv EDITOR emacsclient
1788 # using full pathname
1789 setenv EDITOR /usr/local/emacs/etc/emacsclient
1791 # sh command:
1792 EDITOR=emacsclient ; export EDITOR
1793 @end example
1795 @item
1796 Normal use:
1798 When @samp{emacsclient} is run, it connects to the socket and passes its
1799 command line options to Emacs, which at the next opportunity will visit
1800 the files specified.  (Line numbers can be specified just like with
1801 Emacs.)  The user will have to switch to the Emacs window by hand.  When
1802 the user is done editing a file, the user can type @kbd{C-x #} (or
1803 @kbd{M-x server-edit}) to indicate this.  If there is another buffer
1804 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1805 @code{emacsclient} will exit, signaling the calling program to continue.
1807 @cindex @code{gnuserv}
1808 There is an alternative version of @samp{emacsclient} called
1809 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman}
1810 (@pxref{Packages that do not come with Emacs}).  @samp{gnuserv} uses
1811 Internet domain sockets, so it can work across most network connections.
1813 The most recent @samp{gnuserv} package is available at
1815 @uref{http://meltin.net/hacks/emacs/}
1817 @end itemize
1819 @node Compiler error messages
1820 @section How do I make Emacs recognize my compiler's funny error messages?
1821 @cindex Compiler error messages, recognizing
1822 @cindex Recognizing non-standard compiler errors
1823 @cindex Regexps for recognizing compiler errors
1824 @cindex Errors, recognizing compiler
1826 Customize the @code{compilation-error-regexp-alist} variable.
1828 @node Indenting switch statements
1829 @section How do I change the indentation for @code{switch}?
1830 @cindex @code{switch}, indenting
1831 @cindex Indenting of @code{switch}
1833 Many people want to indent their @code{switch} statements like this:
1835 @example
1838   switch(x) @{
1839     case A:
1840       x1;
1841       break;
1842     case B:
1843       x2;
1844       break;
1845     default:
1846       x3;
1847   @}
1849 @end example
1851 @noindent To achieve this, add the following line to your @file{.emacs}:
1853 @lisp
1854 (c-set-offset 'case-label '+)
1855 @end lisp
1857 @node Customizing C and C++ indentation
1858 @section How to customize indentation in C, C@t{++}, and Java buffers?
1859 @cindex Indentation, how to customize
1860 @cindex Customize indentation
1862 The Emacs @code{cc-mode} features an interactive procedure for
1863 customizing the indentation style, which is fully explained in the
1864 @cite{CC Mode} manual that is part of the Emacs distribution, see
1865 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1866 The CC Mode Manual}.  Here's a short summary of the procedure:
1868 @enumerate
1869 @item
1870 Go to the beginning of the first line where you don't like the
1871 indentation and type @kbd{C-c C-o}.  Emacs will prompt you for the
1872 syntactic symbol; type @key{RET} to accept the default it suggests.
1874 @item
1875 Emacs now prompts for the offset of this syntactic symbol, showing the
1876 default (the current definition) inside parentheses.  You can choose
1877 one of these:
1879 @table @code
1880 @item 0
1881 No extra indentation.
1882 @item +
1883 Indent one basic offset.
1884 @item -
1885 Outdent one basic offset.
1886 @item ++
1887 Indent two basic offsets
1888 @item --
1889 Outdent two basic offsets.
1890 @item *
1891 Indent half basic offset.
1892 @item /
1893 Outdent half basic offset.
1894 @end table
1896 @item
1897 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1898 the line or the block according to what you just specified.
1900 @item
1901 If you don't like the result, go back to step 1.  Otherwise, add the
1902 following line to your @file{.emacs}:
1904 @lisp
1905 (c-set-offset '@var{syntactic-symbol} @var{offset})
1906 @end lisp
1908 @noindent
1909 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1910 when you type @kbd{C-c C-o} at the beginning of the line, and
1911 @var{offset} is one of the indentation symbols listed above (@code{+},
1912 @code{/}, @code{0}, etc.) that you've chosen during the interactive
1913 procedure.
1915 @item
1916 Go to the next line whose indentation is not to your liking and repeat
1917 the process there.
1918 @end enumerate
1920 It is recommended to put all the resulting @code{(c-set-offset ...)}
1921 customizations inside a C mode hook, like this:
1923 @lisp
1924 (defun my-c-mode-hook ()
1925   (c-set-offset ...)
1926   (c-set-offset ...))
1927 (add-hook 'c-mode-hook 'my-c-mode-hook)
1928 @end lisp
1930 @noindent
1931 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1932 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1933 might be unavailable when @code{cc-mode} is not loaded.
1935 Note that @code{c-mode-hook} runs for C source files only; use
1936 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1937 Java sources, etc.  If you want the same customizations to be in
1938 effect in @emph{all} languages supported by @code{cc-mode}, use
1939 @code{c-mode-common-hook}.
1941 @node Horizontal scrolling
1942 @section How can I make Emacs automatically scroll horizontally?
1943 @cindex @code{hscroll-mode}
1944 @cindex Horizontal scrolling
1945 @cindex Scrolling horizontally
1947 In Emacs 21 and later, this is on by default: if the variable
1948 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1949 automatically scrolls the display horizontally when point moves off the
1950 left or right edge of the window.
1952 Note that this is overridden by the variable
1953 @code{truncate-partial-width-windows} if that variable is non-nil
1954 and the current buffer is not full-frame width.
1956 In Emacs 20, use @code{hscroll-mode}.
1958 @node Overwrite mode
1959 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
1960 @cindex @key{Insert}
1961 @cindex @code{overwrite-mode}
1962 @cindex Overwriting existing text
1963 @cindex Toggling @code{overwrite-mode}
1965 @kbd{M-x overwrite-mode} (a minor mode).  This toggles
1966 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1967 is as easy as another @kbd{M-x overwrite-mode}.
1969 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1971 @node Turning off beeping
1972 @section How do I stop Emacs from beeping on a terminal?
1973 @cindex Beeping, turning off
1974 @cindex Visible bell
1975 @cindex Bell, visible
1977 @email{martin@@cc.gatech.edu, Martin R. Frank} writes:
1979 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1980 and set the visible bell to nothing.
1982 That is, put the following in your @code{TERMCAP} environment variable
1983 (assuming you have one):
1985 @example
1986 ... :vb=: ...
1987 @end example
1989 And evaluate the following Lisp form:
1991 @example
1992 (setq visible-bell t)
1993 @end example
1995 @node Turning the volume down
1996 @section How do I turn down the bell volume in Emacs running under X?
1997 @cindex Bell, volume of
1998 @cindex Volume of bell
2000 On X Window system, you can adjust the bell volume and duration for all
2001 programs with the shell command @code{xset}.
2003 Invoking @code{xset} without any arguments produces some basic
2004 information, including the following:
2006 @example
2007 usage:  xset [-display host:dpy] option ...
2008   To turn bell off:
2009       -b                b off               b 0
2010   To set bell volume, pitch and duration:
2011        b [vol [pitch [dur]]]          b on
2012 @end example
2014 @node Automatic indentation
2015 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
2016 @cindex Indenting new lines
2017 @cindex New lines, indenting of
2018 @cindex Previous line, indenting according to
2019 @cindex Text indentation
2021 Such behavior is automatic (in Text mode) in Emacs 20 and later.  From the
2022 @file{etc/NEWS} file for Emacs 20.2:
2024 @example
2025 ** In Text mode, now only blank lines separate paragraphs.  This makes
2026 it possible to get the full benefit of Adaptive Fill mode in Text mode,
2027 and other modes derived from it (such as Mail mode).  @key{TAB} in Text
2028 mode now runs the command @code{indent-relative}; this makes a practical
2029 difference only when you use indented paragraphs.
2031 If you want spaces at the beginning of a line to start a paragraph, use
2032 the new mode, Paragraph Indent Text mode.
2033 @end example
2035 @cindex Prefixing lines
2036 @cindex Fill prefix
2037 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
2038 by default}), you can tell Emacs to prefix every line with a certain
2039 character sequence, the @dfn{fill prefix}.  Type the prefix at the
2040 beginning of a line, position point after it, and then type @kbd{C-x .}
2041 (@code{set-fill-prefix}) to set the fill prefix.  Thereafter,
2042 auto-filling will automatically put the fill prefix at the beginning of
2043 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
2044 prefix when refilling the paragraph.
2046 If you have paragraphs with different levels of indentation, you will
2047 have to set the fill prefix to the correct value each time you move to a
2048 new paragraph.  There are many packages available to deal with this
2049 (@pxref{Packages that do not come with Emacs}).  Look for ``fill'' and
2050 ``indent'' keywords for guidance.
2052 @node Matching parentheses
2053 @section How do I show which parenthesis matches the one I'm looking at?
2054 @cindex Parentheses, matching
2055 @cindex @file{paren.el}
2056 @cindex Highlighting matching parentheses
2057 @cindex Pairs of parentheses, highlighting
2058 @cindex Matching parentheses
2060 Call @code{show-paren-mode} in your @file{.emacs} file:
2062 @lisp
2063 (show-paren-mode 1)
2064 @end lisp
2066 You can also enable this mode by selecting the @samp{Paren Match
2067 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
2068 at the top of any Emacs frame.
2070 Alternatives to this mode include:
2072 @itemize @bullet
2074 @item
2075 If you're looking at a right parenthesis (or brace or bracket) you can
2076 delete it and reinsert it.  Emacs will momentarily move the cursor to
2077 the matching parenthesis.
2079 @item
2080 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2081 will skip over one set of balanced parentheses, so you can see which
2082 parentheses match.  (You can train it to skip over balanced brackets
2083 and braces at the same time by modifying the syntax table.)
2085 @cindex Show matching paren as in @code{vi}
2086 @item
2087 Here is some Emacs Lisp that will make the @key{%} key show the matching
2088 parenthesis, like in @code{vi}.  In addition, if the cursor isn't over a
2089 parenthesis, it simply inserts a % like normal.
2091 @lisp
2092 ;; By an unknown contributor
2094 (global-set-key "%" 'match-paren)
2096 (defun match-paren (arg)
2097   "Go to the matching paren if on a paren; otherwise insert %."
2098   (interactive "p")
2099   (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2100         ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2101         (t (self-insert-command (or arg 1)))))
2102 @end lisp
2104 @end itemize
2106 @node Hiding #ifdef lines
2107 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2108 @cindex @code{#ifdef}, selective display of
2109 @cindex @code{hide-ifdef-mode}
2110 @cindex Hiding @code{#ifdef} text
2111 @cindex Selectively displaying @code{#ifdef} code
2113 @kbd{M-x hide-ifdef-mode}.  (This is a minor mode.)  You might also want
2114 to investigate @file{cpp.el}, which is distributed with Emacs.
2116 @node Repeating commands
2117 @section How do I repeat a command as many times as possible?
2118 @cindex Repeating commands many times
2119 @cindex Commands, repeating many times
2120 @cindex @code{.}, equivalent to @code{vi} command
2122 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2123 that repeats the last command.  If you preface it with a prefix
2124 argument, the prefix arg is applied to the command.
2126 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2127 (@code{repeat-complex-command}) to reinvoke commands that used the
2128 minibuffer to get arguments.  In @code{repeat-complex-command} you can
2129 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2130 keyboard has these keys) to scan through all the different complex
2131 commands you've typed.
2133 To repeat a set of commands, use keyboard macros.  Use @kbd{C-x (} and
2134 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2135 type @kbd{C-x e}.  @xref{Keyboard Macros,,, emacs, The GNU Emacs Manual}.
2137 If you're really desperate for the @code{.} command in @code{vi} that
2138 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2139 mode which comes with Emacs, and which appears to support it.
2141 @node Valid X resources
2142 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2143 @cindex Resources, X
2144 @cindex X resources
2145 @cindex Setting X resources
2147 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2149 You can also use a resource editor, such as editres (for X11R5 and
2150 onwards), to look at the resource names for the menu bar, assuming Emacs
2151 was compiled with the X toolkit.
2153 @node Evaluating Emacs Lisp code
2154 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2155 @cindex Evaluating Lisp code
2156 @cindex Lisp forms, evaluating
2158 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2159 Emacs Lisp @dfn{form}:
2161 @itemize @bullet
2163 @item
2164 If you want it evaluated every time you run Emacs, put it in a file
2165 named @file{.emacs} in your home directory.  This is known as ``your
2166 @file{.emacs} file,'' and contains all of your personal customizations.
2168 @item
2169 You can type the form in the @file{*scratch*} buffer, and then type
2170 @key{LFD} (or @kbd{C-j}) after it.  The result of evaluating the form
2171 will be inserted in the buffer.
2173 @item
2174 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2175 before or around point.
2177 @item
2178 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2179 before point and prints its value in the echo area.
2181 @item
2182 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2183 form in the minibuffer which will be evaluated once you press @key{RET}.
2185 @item
2186 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2187 forms in a file.  (To do this from Lisp use the function @code{load}
2188 instead.)
2190 The functions @code{load-library}, @code{eval-region},
2191 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2192 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2193 about them.
2195 @end itemize
2197 @node Changing the length of a Tab
2198 @section How do I change Emacs's idea of the @key{TAB} character's length?
2199 @cindex Tab length
2200 @cindex Length of tab character
2202 Set the default value of the variable @code{tab-width}.  For example, to set
2203 @key{TAB} stops every 10 characters, insert the following in your
2204 @file{.emacs} file:
2206 @lisp
2207 (setq-default tab-width 10)
2208 @end lisp
2210 Do not confuse variable @code{tab-width} with variable
2211 @code{tab-stop-list}.  The former is used for the display of literal
2212 @key{TAB} characters.  The latter controls what characters are inserted
2213 when you press the @key{TAB} character in certain modes.
2215 @node Inserting text at the beginning of each line
2216 @section How do I insert <some text> at the beginning of every line?
2217 @cindex Prefixing a region with some text
2218 @cindex Prefix character, inserting in mail/news replies
2219 @cindex Replies to mail/news, inserting a prefix character
2220 @cindex @code{mail-yank-prefix}
2221 @cindex Mail replies, inserting a prefix character
2222 @cindex News replies, inserting a prefix character
2224 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2225 @key{RET} ^ @key{RET} your text @key{RET}}.
2227 To do this to a region, use @code{string-insert-rectangle}.
2228 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2229 want to prefix, move the cursor to last line to be prefixed, and type
2230 @kbd{M-x string-insert-rectangle @key{RET}}.  To do this for the whole
2231 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2233 If you are trying to prefix a yanked mail message with @samp{>}, you
2234 might want to set the variable @code{mail-yank-prefix}.  In Message
2235 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2236 runs the function @code{comment-region}, it is a general-purpose
2237 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2239 @node Forcing the cursor to remain in the same column
2240 @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?
2241 @cindex @code{picture-mode}
2242 @cindex Remaining in the same column, regardless of contents
2243 @cindex Vertical movement in empty documents
2245 Use @kbd{M-x picture-mode}.
2247 See also the variable @code{track-eol} and the command
2248 @code{set-goal-column} bound to @kbd{C-x C-n}
2249 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2251 @node Forcing Emacs to iconify itself
2252 @section How do I tell Emacs to iconify itself?
2253 @cindex Iconification under the X Window System
2254 @cindex X Window System and iconification
2255 @cindex Suspending Emacs
2257 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2258 otherwise.  @xref{Frame Commands,,, emacs, The GNU Emacs Manual}.
2260 @node Using regular expressions
2261 @section How do I use regexps (regular expressions) in Emacs?
2262 @cindex Regexps
2263 @cindex Regular expressions
2264 @cindex Differences between Unix and Emacs regexps
2265 @cindex Unix regexps, differences from Emacs
2266 @cindex Text strings, putting regexps in
2268 @xref{Regexp Backslash,,, emacs, The GNU Emacs Manual}.
2270 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2271 are @samp{\(} and @samp{\)}.  Also, the string syntax for a backslash is
2272 @samp{\\}.  To specify a regular expression like @samp{xxx\(foo\|bar\)}
2273 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2275 Note the doubled backslashes!
2277 @itemize @bullet
2279 @item
2280 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2281 (@samp{[^...]})  can match a newline character (@key{LFD} a.k.a.@:
2282 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2283 characters not to match.
2285 @item
2286 The character syntax regexps (e.g., @samp{\sw}) are not
2287 meaningful inside character set regexps (e.g., @samp{[aeiou]}).  (This
2288 is actually typical for regexp syntax.)
2290 @end itemize
2292 @node Replacing text across multiple files
2293 @section How do I perform a replace operation across more than one file?
2294 @cindex Replacing strings across files
2295 @cindex Multiple files, replacing across
2296 @cindex Files, replacing strings across multiple
2297 @cindex Recursive search/replace operations
2299 Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the
2300 command @code{dired-do-query-replace-regexp} (@kbd{Q}), which allows
2301 users to replace regular expressions in multiple files.
2303 You can use this command to perform search/replace operations on
2304 multiple files by following the following steps:
2306 @itemize @bullet
2307 @item
2308 Assemble a list of files you want to operate on with either
2309 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2311 @item
2312 Mark all files in the resulting Dired buffer using @kbd{t}.
2314 @item
2315 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2316 files.
2318 @item
2319 To accept all replacements in each file, hit @kbd{!}.
2320 @end itemize
2322 Another way to do the same thing is to use the ``tags'' feature of
2323 Emacs: it includes the command @code{tags-query-replace} which performs
2324 a query-replace across all the files mentioned in the @file{TAGS} file.
2325 @xref{Tags Search,,, emacs, The GNU Emacs Manual}.
2327 @node Documentation for etags
2328 @section Where is the documentation for @code{etags}?
2329 @cindex Documentation for @code{etags}
2330 @cindex @code{etags}, documentation for
2332 The @code{etags} man page should be in the same place as the
2333 @code{emacs} man page.
2335 Quick command-line switch descriptions are also available.  For example,
2336 @samp{etags -H}.
2338 @node Disabling backups
2339 @section How do I disable backup files?
2340 @cindex Backups, disabling
2341 @cindex Disabling backups
2343 You probably don't want to do this, since backups are useful, especially
2344 when something goes wrong.
2346 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2347 load @code{dired-x} by adding the following to your @file{.emacs} file:
2349 @lisp
2350 (add-hook 'dired-load-hook
2351           (lambda ()
2352            (require 'dired-x)))
2353 @end lisp
2355 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2356 You can make omitting the default for new dired buffers by putting the
2357 following in your @file{.emacs}:
2359 @lisp
2360 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2361 @end lisp
2363 If you're tired of seeing backup files whenever you do an @samp{ls} at
2364 the Unix shell, try GNU @code{ls} with the @samp{-B} option.  GNU
2365 @code{ls} is part of the GNU Fileutils package, available from
2366 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2368 To disable or change the way backups are made,
2369 @pxref{Backup Names,,, emacs, The GNU Emacs Manual}.
2371 @cindex Backup files in a single directory
2372 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2373 by customizing the variable @code{backup-directory-alist}.  This
2374 variable's value specifies that files whose names match specific patters
2375 should have their backups put in certain directories.  A typical use is
2376 to add the element @code{("." . @var{dir})} to force Emacs to put
2377 @strong{all} backup files in the directory @file{dir}.
2379 @node Disabling auto-save-mode
2380 @section How do I disable @code{auto-save-mode}?
2381 @cindex Disabling @code{auto-save-mode}
2382 @cindex Auto-saving
2383 @cindex Saving at frequent intervals
2385 You probably don't want to do this, since auto-saving is useful,
2386 especially when Emacs or your computer crashes while you are editing a
2387 document.
2389 Instead, you might want to change the variable
2390 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2391 waits before auto-saving.  Increasing this value forces Emacs to wait
2392 longer between auto-saves, which might annoy you less.
2394 You might also want to look into Sebastian Kremer's @code{auto-save}
2395 package (@pxref{Packages that do not come with Emacs}).  This
2396 package also allows you to place all auto-save files in one directory,
2397 such as @file{/tmp}.
2399 To disable or change how @code{auto-save-mode} works,
2400 @pxref{Auto Save,,, emacs, The GNU Emacs Manual}.
2402 @node Going to a line by number
2403 @section How can I go to a certain line given its number?
2404 @cindex Going to a line by number
2405 @cindex Compilation error messages
2406 @cindex Recompilation
2408 Are you sure you indeed need to go to a line by its number?  Perhaps all
2409 you want is to display a line in your source file for which a compiler
2410 printed an error message?  If so, compiling from within Emacs using the
2411 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2412 effective way of doing that.  Emacs automatically intercepts the compile
2413 error messages, inserts them into a special buffer called
2414 @code{*compilation*}, and lets you visit the locus of each message in
2415 the source.  Type @kbd{C-x `} to step through the offending lines one by
2416 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2417 @kbd{M-g M-n} to go to the previous and next matches directly).  Click
2418 @kbd{Mouse-2} or press @key{RET} on a message text in the
2419 @code{*compilation*} buffer to go to the line whose number is mentioned
2420 in that message.
2422 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2423 (which is the default binding of the @code{goto-line} function starting
2424 with Emacs 22).  Emacs will prompt you for the number of the line and go
2425 to that line.
2427 You can do this faster by invoking @code{goto-line} with a numeric
2428 argument that is the line's number.  For example, @kbd{C-u 286 M-g M-g}
2429 will jump to line number 286 in the current buffer.
2431 @node Modifying pull-down menus
2432 @section How can I create or modify new pull-down menu options?
2433 @cindex Pull-down menus, creating or modifying
2434 @cindex Menus, creating or modifying
2435 @cindex Creating new menu options
2436 @cindex Modifying pull-down menus
2437 @cindex Menus and keymaps
2438 @cindex Keymaps and menus
2440 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2441 represents a local or global keymap.  Selecting a menu title with the
2442 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2444 So to add a menu option to an existing menu, all you have to do is add a
2445 new definition to the appropriate keymap.  Adding a @samp{Forward Word}
2446 item to the @samp{Edit} menu thus requires the following Lisp code:
2448 @lisp
2449 (define-key global-map
2450   [menu-bar edit forward]
2451   '("Forward word" . forward-word))
2452 @end lisp
2454 @noindent
2455 The first line adds the entry to the global keymap, which includes
2456 global menu bar entries.  Replacing the reference to @code{global-map}
2457 with a local keymap would add this menu option only within a particular
2458 mode.
2460 The second line describes the path from the menu-bar to the new entry.
2461 Placing this menu entry underneath the @samp{File} menu would mean
2462 changing the word @code{edit} in the second line to @code{file}.
2464 The third line is a cons cell whose first element is the title that will
2465 be displayed, and whose second element is the function that will be
2466 called when that menu option is invoked.
2468 To add a new menu, rather than a new option to an existing menu, we must
2469 define an entirely new keymap:
2471 @lisp
2472 (define-key global-map [menu-bar words]
2473   (cons "Words" (make-sparse-keymap "Words")))
2474 @end lisp
2476 The above code creates a new sparse keymap, gives it the name
2477 @samp{Words}, and attaches it to the global menu bar.  Adding the
2478 @samp{Forward Word} item to this new menu would thus require the
2479 following code:
2481 @lisp
2482 (define-key global-map
2483   [menu-bar words forward]
2484   '("Forward word" . forward-word))
2485 @end lisp
2487 @noindent
2488 Note that because of the way keymaps work, menu options are displayed
2489 with the more recently defined items at the top.  Thus if you were to
2490 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2491 order), the menu option @samp{baz} would appear at the top, and
2492 @samp{foo} would be at the bottom.
2494 One way to avoid this problem is to use the function @code{define-key-after},
2495 which works the same as @code{define-key}, but lets you modify where items
2496 appear.  The following Lisp code would insert the @samp{Forward Word}
2497 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2499 @lisp
2500 (define-key-after
2501   (lookup-key global-map [menu-bar edit])
2502   [forward]
2503   '("Forward word" . forward-word)
2504   'undo)
2505 @end lisp
2507 Note how the second and third arguments to @code{define-key-after} are
2508 different from those of @code{define-key}, and that we have added a new
2509 (final) argument, the function after which our new key should be
2510 defined.
2512 To move a menu option from one position to another, simply evaluate
2513 @code{define-key-after} with the appropriate final argument.
2515 More detailed information---and more examples of how to create and
2516 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2517 ``Menu Keymaps.''  (@xref{Emacs Lisp documentation}, for information on
2518 this manual.)
2520 @node Deleting menus and menu options
2521 @section How do I delete menus and menu options?
2522 @cindex Deleting menus and menu options
2523 @cindex Menus, deleting
2525 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2526 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2527 menus}), use:
2529 @lisp
2530 (define-key global-map [menu-bar words] nil)
2531 @end lisp
2533 Similarly, removing a menu option requires redefining a keymap entry to
2534 @code{nil}.  For example, to delete the @samp{Forward word} menu option
2535 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2536 menus}), use:
2538 @lisp
2539 (define-key global-map [menu-bar edit forward] nil)
2540 @end lisp
2542 @node Turning on syntax highlighting
2543 @section How do I turn on syntax highlighting?
2544 @cindex Syntax highlighting
2545 @cindex @code{font-lock-mode}
2546 @cindex Highlighting based on syntax
2547 @cindex Colorizing text
2548 @cindex FAQ, @code{font-lock-mode}
2550 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2551 highlighting in the current buffer.  It is enabled by default in Emacs
2552 22.1 and later.
2554 With @code{font-lock-mode} turned on, different types of text will
2555 appear in different colors.  For instance, in a programming mode,
2556 variables will appear in one face, keywords in a second, and comments in
2557 a third.
2559 To turn @code{font-lock-mode} off within an existing buffer, use
2560 @kbd{M-x font-lock-mode @key{RET}}.
2562 In Emacs 21 and earlier versions, you could use the following code in
2563 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2565 @lisp
2566 (global-font-lock-mode 1)
2567 @end lisp
2569 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2570 and cause an annoying delay in display, so several features exist to
2571 work around this.
2573 @cindex Just-In-Time syntax highlighting
2574 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2575 activates the new @dfn{Just-In-Time fontification} provided by
2576 @code{jit-lock-mode}.  @code{jit-lock-mode} defers the fontification of
2577 portions of buffer until you actually need to see them, and can also
2578 fontify while Emacs is idle.  This makes display of the visible portion
2579 of a buffer almost instantaneous.  For details about customizing
2580 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2582 @cindex Levels of syntax highlighting
2583 @cindex Decoration level, in @code{font-lock-mode}
2584 In versions of Emacs before 21, different levels of decoration are
2585 available, from slight to gaudy.  More decoration means you need to wait
2586 more time for a buffer to be fontified (or a faster machine).  To
2587 control how decorated your buffers should become, set the value of
2588 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2589 @code{nil} value indicating default (usually minimum) decoration, and a
2590 @code{t} value indicating the maximum decoration.  For the gaudiest
2591 possible look, then, include the line
2593 @lisp
2594 (setq font-lock-maximum-decoration t)
2595 @end lisp
2597 @noindent
2598 in your @file{.emacs} file.  You can also set this variable such that
2599 different modes are highlighted in a different ways; for more
2600 information, see the documentation for
2601 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2602 describe-variable @key{RET}}).
2604 Also see the documentation for the function @code{font-lock-mode},
2605 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2606 describe-function @key{RET} font-lock-mode @key{RET}}).
2608 To print buffers with the faces (i.e., colors and fonts) intact, use
2609 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2610 ps-print-region-with-faces}.  You will need a way to send text to a
2611 PostScript printer, or a PostScript interpreter such as Ghostscript;
2612 consult the documentation of the variables @code{ps-printer-name},
2613 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2615 @node Scrolling only one line
2616 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2617 @cindex Scrolling only one line
2618 @cindex Reducing the increment when scrolling
2620 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2621 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2622 to a large value like, say, 10000.  For an explanation of what this
2623 means, @pxref{Auto Scrolling,,, emacs, The GNU Emacs Manual}.
2625 Alternatively, use the following Lisp form in your @file{.emacs}:
2627 @lisp
2628 (setq scroll-conservatively most-positive-fixnum)
2629 @end lisp
2631 @node Editing MS-DOS files
2632 @section How can I edit MS-DOS files using Emacs?
2633 @cindex Editing MS-DOS files
2634 @cindex MS-DOS files, editing
2635 @cindex Microsoft files, editing
2636 @cindex Windows files, editing
2638 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2639 performed transparently.  You can open MS-DOS files on a Unix system,
2640 edit it, and save it without having to worry about the file format.
2642 When editing an MS-DOS style file, the mode line will indicate that it
2643 is a DOS file.  On Unix and GNU/Linux systems, and also on a Macintosh,
2644 the string @samp{(DOS)} will appear near the left edge of the mode line;
2645 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2646 default, a backslash (@samp{\}) will appear in the mode line.
2648 @node Filling paragraphs with a single space
2649 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2650 @cindex One space following periods
2651 @cindex Single space following periods
2652 @cindex Periods, one space following
2654 Add the following line to your @file{.emacs} file:
2656 @lisp
2657 (setq sentence-end-double-space nil)
2658 @end lisp
2660 @node Escape sequences in shell output
2661 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2662 @cindex Escape sequences in @code{ls} output
2663 @cindex @code{ls} in Shell mode
2665 In many systems, @code{ls} is aliased to @samp{ls --color}, which
2666 prints using ANSI color escape sequences.  Emacs version 21.1 and
2667 later includes the @code{ansi-color} package, which lets Shell mode
2668 recognize these escape sequences.  In Emacs 23.2 and later, the
2669 package is enabled by default; in earlier versions you can enable it
2670 by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2671 by adding @code{(add-hook 'shell-mode-hook
2672 'ansi-color-for-comint-mode-on)} to your init file.
2674 In Emacs versions before 21.1, the @code{ansi-color} package is not
2675 included.  In that case, you need to unalias @code{ls} for interactive
2676 shells running in Emacs; this can be done by checking the @code{EMACS}
2677 variable in the environment.
2679 @node Fullscreen mode on MS-Windows
2680 @section How can I start Emacs in fullscreen mode on MS-Windows?
2681 @cindex Maximize frame
2682 @cindex Fullscreen mode
2684 Use the function @code{w32-send-sys-command}.  For example, you can
2685 put the following in your @file{.emacs} file:
2687 @lisp
2688 (add-hook 'term-setup-hook
2689           #'(lambda () (w32-send-sys-command ?\xF030)))
2690 @end lisp
2692 To avoid the slightly distracting visual effect of Emacs starting with
2693 its default frame size and then growing to fullscreen, you can add an
2694 @samp{Emacs.Geometry} entry to the Windows registry settings.
2695 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2697 To compute the correct values for width and height, first maximize the
2698 Emacs frame and then evaluate @code{(frame-height)} and
2699 @code{(frame-width)} with @kbd{M-:}.
2701 @c ------------------------------------------------------------
2702 @node Bugs and problems
2703 @chapter Bugs and problems
2704 @cindex Bugs and problems
2706 The Emacs manual lists some common kinds of trouble users could get
2707 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2708 Emacs Manual}, so you might look there if the problem you encounter
2709 isn't described in this chapter.  If you decide you've discovered a bug,
2710 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2711 instructions how to do that.
2713 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2714 known problems with building and using Emacs on specific platforms;
2715 type @kbd{C-h C-p} to read it.
2717 @menu
2718 * Problems with very large files::
2719 * ^M in the shell buffer::
2720 * Problems with Shell Mode::
2721 * Termcap/Terminfo entries for Emacs::
2722 * Errors with init files::
2723 * Emacs ignores X resources::
2724 * Emacs ignores frame parameters::
2725 * Editing files with $ in the name::
2726 * Shell mode loses the current directory::
2727 * Security risks with Emacs::
2728 * Dired claims that no file is on this line::
2729 @end menu
2731 @node Problems with very large files
2732 @section Does Emacs have problems with files larger than 8 megabytes?
2733 @cindex Very large files, opening
2734 @cindex Large files, opening
2735 @cindex Opening very large files
2736 @cindex Maximum file size
2737 @cindex Files, maximum size
2739 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2740 files larger than 8 megabytes.  In versions 19.29 and later, the maximum
2741 buffer size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes.
2742 The maximum buffer size on 32-bit machines increased to 256 MBytes in
2743 Emacs 22, and again to 512 MBytes in Emacs 23.2.
2745 Emacs compiled on a 64-bit machine can handle much larger buffers.
2747 @node ^M in the shell buffer
2748 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2749 @cindex Shell buffer, echoed commands and @samp{^M} in
2750 @cindex Echoed commands in @code{shell-mode}
2752 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2753 make them go away.  If that doesn't work, you have several options:
2755 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2756 file:
2758 @example
2759 if ($?EMACS) then
2760     if ("$EMACS" =~ /*) then
2761         if ($?tcsh) unset edit
2762         stty nl
2763     endif
2764 endif
2765 @end example
2767 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2769 @example
2770 unset edit
2771 stty nl
2772 @end example
2774 Alternatively, use @code{csh} in your shell buffers instead of
2775 @code{tcsh}.  One way is:
2777 @lisp
2778 (setq explicit-shell-file-name "/bin/csh")
2779 @end lisp
2781 @noindent
2782 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2783 file:
2785 @example
2786 setenv ESHELL /bin/csh
2787 @end example
2789 @noindent
2790 (You must start Emacs over again with the environment variable properly
2791 set for this to take effect.)
2793 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2794 with the following Lisp form,
2796 @lisp
2797 (setenv "ESHELL" "/bin/csh")
2798 @end lisp
2800 The above solutions try to prevent the shell from producing the
2801 @samp{^M} characters in the first place.  If this is not possible
2802 (e.g., if you use a Windows shell), you can get Emacs to remove these
2803 characters from the buffer by adding this to your @file{.emacs} init
2804 file:
2806 @smalllisp
2807 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2808 @end smalllisp
2810 On a related note: if your shell is echoing your input line in the shell
2811 buffer, you might want to customize the @code{comint-process-echoes}
2812 variable in your shell buffers, or try the following command in your
2813 shell start-up file:
2815 @example
2816 stty -icrnl -onlcr -echo susp ^Z
2817 @end example
2819 @node Problems with Shell Mode
2820 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2822 @cindex Shell Mode, problems
2823 @cindex @code{explicit-shell-file-name}
2824 This might happen because Emacs tries to look for the shell in a wrong
2825 place.  If you know where your shell executable is, set the variable
2826 @code{explicit-shell-file-name} in your @file{.emacs} file to point to
2827 its full file name.
2829 @cindex Antivirus programs, and Shell Mode
2830 Some people have trouble with Shell Mode on MS-Windows because of
2831 intrusive antivirus software; disabling the resident antivirus program
2832 solves the problems in those cases.
2834 @node Termcap/Terminfo entries for Emacs
2835 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2836 @cindex Termcap
2837 @cindex Terminfo
2838 @cindex Emacs entries for termcap/terminfo
2840 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2841 the @samp{TERMCAP} environment variable of subshells.  It may help in
2842 certain situations (e.g., using rlogin from shell buffer) to add an
2843 entry for @samp{emacs} to the system-wide termcap file.  Here is a
2844 correct termcap entry for @samp{emacs}:
2846 @example
2847 emacs:tc=unknown:
2848 @end example
2850 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2851 @code{captoinfo}.  You need to generate
2852 @file{/usr/lib/terminfo/e/emacs}.  It may work to simply copy
2853 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2855 Having a termcap/terminfo entry will not enable the use of full screen
2856 programs in shell buffers.  Use @kbd{M-x terminal-emulator} for that
2857 instead.
2859 A workaround to the problem of missing termcap/terminfo entries is to
2860 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2861 in your shell start up file.  @code{csh} users could put this in their
2862 @file{.cshrc} files:
2864 @example
2865 if ("$term" == emacs) set term=dumb
2866 @end example
2868 @node Errors with init files
2869 @section Why does Emacs say @samp{Error in init file}?
2870 @cindex Error in @file{.emacs}
2871 @cindex Error in init file
2872 @cindex Init file, errors in
2873 @cindex @file{.emacs} file, errors in
2874 @cindex Debugging @file{.emacs} file
2876 An error occurred while loading either your @file{.emacs} file or the
2877 system-wide file @file{site-lisp/default.el}.  Emacs 21.1 and later pops the
2878 @file{*Messages*} buffer, and puts there some additional information
2879 about the error, to provide some hints for debugging.
2881 For information on how to debug your @file{.emacs} file, see
2882 @ref{Debugging a customization file}.
2884 It may be the case that you need to load some package first, or use a
2885 hook that will be evaluated after the package is loaded.  A common case
2886 of this is explained in @ref{Terminal setup code works after Emacs has
2887 begun}.
2889 @node Emacs ignores X resources
2890 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
2891 @cindex X resources being ignored
2892 @cindex Ignored X resources
2893 @cindex @file{.Xdefaults}
2895 As of version 19, Emacs searches for X resources in the files specified
2896 by the following environment variables:
2898 @itemize @bullet
2900 @item @code{XFILESEARCHPATH}
2901 @item @code{XUSERFILESEARCHPATH}
2902 @item @code{XAPPLRESDIR}
2904 @end itemize
2906 This emulates the functionality provided by programs written using the
2907 Xt toolkit.
2909 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
2910 of file names separated by colons.  @code{XAPPLRESDIR} should be a list
2911 of directory names separated by colons.
2913 Emacs searches for X resources:
2915 @enumerate
2917 @item
2918 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
2920 @item
2921 then in the value of the @samp{XENVIRONMENT} environment variable,
2923 @itemize @minus
2925 @item
2926 or if that is unset, in the file named
2927 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
2928 the name of the machine Emacs is running on),
2930 @end itemize
2932 @item
2933 then in the screen-specific and server-wide resource properties provided
2934 by the server,
2936 @itemize @minus
2938 @item
2939 or if those properties are unset, in the file named @file{~/.Xdefaults}
2940 if it exists,
2942 @end itemize
2944 @item
2945 then in the files listed in @samp{XUSERFILESEARCHPATH},
2947 @itemize @minus
2949 @item
2950 or in files named @file{@var{lang}/Emacs} in directories listed in
2951 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
2952 environment variable), if the @samp{LANG} environment variable is set,
2953 @item
2954 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
2955 @item
2956 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
2957 is set),
2958 @item
2959 or in @file{~/Emacs},
2961 @end itemize
2963 @item
2964 then in the files listed in  @code{XFILESEARCHPATH}.
2966 @end enumerate
2968 @node Emacs ignores frame parameters
2969 @section Why don't my customizations of the frame parameters work?
2970 @cindex Frame parameters
2972 This probably happens because you have set the frame parameters in the
2973 variable @code{initial-frame-alist}.  That variable holds parameters
2974 used only for the first frame created when Emacs starts.  To customize
2975 the parameters of all frames, change the variable
2976 @code{default-frame-alist} instead.
2978 These two variables exist because many users customize the initial frame
2979 in a special way.  For example, you could determine the position and
2980 size of the initial frame, but would like to control the geometry of the
2981 other frames by individually positioning each one of them.
2984 @node Editing files with $ in the name
2985 @section How do I edit a file with a @samp{$} in its name?
2986 @cindex Editing files with @samp{$} in the name
2987 @cindex @samp{$} in file names
2988 @cindex File names containing @samp{$}, editing
2990 When entering a file name in the minibuffer, Emacs will attempt to expand
2991 a @samp{$} followed by a word as an environment variable.  To suppress
2992 this behavior, type @kbd{$$} instead.
2994 @node Shell mode loses the current directory
2995 @section Why does shell mode lose track of the shell's current directory?
2996 @cindex Current directory and @code{shell-mode}
2997 @cindex @code{shell-mode} and current directory
2998 @cindex Directory, current in @code{shell-mode}
3000 Emacs has no way of knowing when the shell actually changes its
3001 directory.  This is an intrinsic limitation of Unix.  So it tries to
3002 guess by recognizing @samp{cd} commands.  If you type @kbd{cd} followed
3003 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
3004 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
3005 correctly guess the shell's new current directory.  A huge variety of
3006 fixes and enhancements to shell mode for this problem have been written
3007 to handle this problem (@pxref{Finding a package with particular
3008 functionality}).
3010 You can tell Emacs the shell's current directory with the command
3011 @kbd{M-x dirs}.
3013 @node Security risks with Emacs
3014 @section Are there any security risks in Emacs?
3015 @cindex Security with Emacs
3016 @cindex @samp{movemail} and security
3017 @cindex @code{file-local-variable} and security
3018 @cindex Synthetic X events and security
3019 @cindex X events and security
3021 @itemize @bullet
3023 @item
3024 The @file{movemail} incident.  (No, this is not a risk.)
3026 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3027 chapter 4.  The site at LBL had installed the @file{/etc/movemail}
3028 program setuid root.  (As of version 19, @file{movemail} is in your
3029 architecture-specific directory; type @kbd{C-h v exec-directory
3030 @key{RET}} to see what it is.)  Since @code{movemail} had not been
3031 designed for this situation, a security hole was created and users could
3032 get root privileges.
3034 @code{movemail} has since been changed so that this security hole will
3035 not exist, even if it is installed setuid root.  However,
3036 @code{movemail} no longer needs to be installed setuid root, which
3037 should eliminate this particular risk.
3039 We have heard unverified reports that the 1988 Internet worm took
3040 advantage of this configuration problem.
3042 @item
3043 The @code{file-local-variable} feature.  (Yes, a risk, but easy to
3044 change.)
3046 There is an Emacs feature that allows the setting of local values for
3047 variables when editing a file by including specially formatted text near
3048 the end of the file.  This feature also includes the ability to have
3049 arbitrary Emacs Lisp code evaluated when the file is visited.
3050 Obviously, there is a potential for Trojan horses to exploit this
3051 feature.
3053 As of Emacs 22, Emacs has a list of local variables that are known to
3054 be safe to set.  If a file tries to set any variable outside this
3055 list, it asks the user to confirm whether the variables should be set.
3056 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
3057 code found at the bottom of files by setting the variable
3058 @code{enable-local-eval}.
3060 @xref{File Variables,,, emacs, The GNU Emacs Manual}.
3062 @item
3063 Synthetic X events.  (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3064 better.)
3066 Emacs accepts synthetic X events generated by the @code{SendEvent}
3067 request as though they were regular events.  As a result, if you are
3068 using the trivial host-based authentication, other users who can open X
3069 connections to your X workstation can make your Emacs process do
3070 anything, including run other processes with your privileges.
3072 The only fix for this is to prevent other users from being able to open
3073 X connections.  The standard way to prevent this is to use a real
3074 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}.  If using
3075 the @code{xauth} program has any effect, then you are probably using
3076 @samp{MIT-MAGIC-COOKIE-1}.  Your site may be using a superior
3077 authentication method; ask your system administrator.
3079 If real authentication is not a possibility, you may be satisfied by
3080 just allowing hosts access for brief intervals while you start your X
3081 programs, then removing the access.  This reduces the risk somewhat by
3082 narrowing the time window when hostile users would have access, but
3083 @emph{does not eliminate the risk}.
3085 On most computers running Unix and X, you enable and disable
3086 access using the @code{xhost} command.  To allow all hosts access to
3087 your X server, use
3089 @example
3090 xhost +
3091 @end example
3093 @noindent
3094 at the shell prompt, which (on an HP machine, at least) produces the
3095 following message:
3097 @example
3098 access control disabled, clients can connect from any host
3099 @end example
3101 To deny all hosts access to your X server (except those explicitly
3102 allowed by name), use
3104 @example
3105 xhost -
3106 @end example
3108 On the test HP computer, this command generated the following message:
3110 @example
3111 access control enabled, only authorized clients can connect
3112 @end example
3114 @end itemize
3116 @node Dired claims that no file is on this line
3117 @section Dired says, @samp{no file on this line} when I try to do something.
3118 @cindex Dired does not see a file
3120 Dired uses a regular expression to find the beginning of a file name.
3121 In a long Unix-style directory listing (@samp{ls -l}), the file name
3122 starts after the date.  The regexp has thus been written to look for the
3123 date.  By default, it should understand dates and times regardless of
3124 the language, but if your directory listing has an unusual format, Dired
3125 may get confused.
3127 There are two approaches to solving this.  The first one involves
3128 setting things up so that @samp{ls -l} outputs a more standard format.
3129 See your OS manual for more information.
3131 The second approach involves changing the regular expression used by
3132 dired, @code{directory-listing-before-filename-regexp}.
3134 @c ------------------------------------------------------------
3135 @node Compiling and installing Emacs
3136 @chapter    Compiling and installing Emacs
3137 @cindex    Compiling and installing Emacs
3139 @menu
3140 * Installing Emacs::
3141 * Problems building Emacs::
3142 @end menu
3144 @node Installing Emacs
3145 @section How do I install Emacs?
3146 @cindex Installing Emacs
3147 @cindex Unix systems, installing Emacs on
3148 @cindex Downloading and installing Emacs
3149 @cindex Building Emacs from source
3150 @cindex Source code, building Emacs from
3152 This answer is meant for users of Unix and Unix-like systems.  Users of
3153 other operating systems should see the series of questions beginning
3154 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3155 and binaries, and how to install Emacs on those systems.
3157 Most GNU/Linux distributions provide pre-built Emacs packages.
3158 If Emacs is not installed already, you can install it by running (as
3159 root) a command such as @samp{yum install emacs} (Red Hat and
3160 derivatives) or @samp{apt-get install emacs} (Debian and derivatives).
3162 If you want to compile Emacs yourself, read the file @file{INSTALL} in
3163 the source distribution.  In brief:
3165 @itemize @bullet
3167 @item
3168 First download the Emacs sources.  @xref{Current GNU distributions}, for
3169 a list of ftp sites that make them available.  On @file{ftp.gnu.org},
3170 the main GNU distribution site, sources are available as
3172 @c Don't include VER in the file name, because pretests are not there.
3173 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
3175 (Replace @samp{VERSION} with the relevant version number, e.g. @samp{23.1}.)
3177 @item
3178 Next uncompress and extract the source files.  This requires
3179 the @code{gzip} and @code{tar} programs, which are standard utilities.
3180 If your system does not have them, these can also be downloaded from
3181 @file{ftp.gnu.org}.
3183 GNU @code{tar} can uncompress and extract in a single-step:
3185 @example
3186 tar -zxvf emacs-VERSION.tar.gz
3187 @end example
3189 @item
3190 At this point, the Emacs sources should be sitting in a directory called
3191 @file{emacs-VERSION}.  On most common Unix and Unix-like systems,
3192 you should be able to compile Emacs with the following commands:
3194 @example
3195 cd emacs-VERSION
3196 ./configure         # configure Emacs for your particular system
3197 make                # use Makefile to build components, then Emacs
3198 @end example
3200 If the @code{make} completes successfully, the odds are fairly good that
3201 the build has gone well.  (@xref{Problems building Emacs}, if you weren't
3202 successful.)
3204 @item
3205 By default, Emacs is installed in @file{/usr/local}.  To actually
3206 install files, become the superuser and type
3208 @example
3209 make install
3210 @end example
3212 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3213 and any Emacs Info files that might be in @file{/usr/local/share/info/}.
3215 @end itemize
3217 @node Problems building Emacs
3218 @section What should I do if I have trouble building Emacs?
3219 @cindex Problems building Emacs
3220 @cindex Errors when building Emacs
3222 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3223 source) to see if there is already a solution for your problem.  Next,
3224 look for other questions in this FAQ that have to do with Emacs
3225 installation and compilation problems.
3227 If you'd like to have someone look at your problem and help solve it,
3228 see @ref{Help installing Emacs}.
3230 If you cannot find a solution in the documentation, please report the
3231 problem (@pxref{Reporting bugs}).
3234 @c ------------------------------------------------------------
3235 @node Finding Emacs and related packages
3236 @chapter Finding Emacs and related packages
3237 @cindex Finding Emacs and related packages
3239 @menu
3240 * Finding Emacs on the Internet::
3241 * Finding a package with particular functionality::
3242 * Packages that do not come with Emacs::
3243 * Spell-checkers::
3244 * Current GNU distributions::
3245 * Difference between Emacs and XEmacs::
3246 * Emacs for minimalists::
3247 * Emacs for MS-DOS::
3248 * Emacs for MS-Windows::
3249 * Emacs for GNUstep::
3250 * Emacs for Mac OS X::
3251 @end menu
3253 @node Finding Emacs on the Internet
3254 @section Where can I get Emacs on the net?
3255 @cindex Finding Emacs on the Internet
3256 @cindex Downloading Emacs
3258 Information on downloading Emacs is available at
3259 @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}.
3261 @xref{Installing Emacs}, for information on how to obtain and build the latest
3262 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3263 archive sites that make GNU software available.
3265 @node Finding a package with particular functionality
3266 @section How do I find a Emacs Lisp package that does XXX?
3267 @cindex Package, finding
3268 @cindex Finding an Emacs Lisp package
3269 @cindex Functionality, finding a particular package
3271 First of all, you should check to make sure that the package isn't
3272 already available.  For example, typing @kbd{M-x apropos @key{RET}
3273 wordstar @key{RET}} lists all functions and variables containing the
3274 string @samp{wordstar}.
3276 It is also possible that the package is on your system, but has not been
3277 loaded.  To see which packages are available for loading, look through
3278 your computer's lisp directory (@pxref{File-name conventions}).  The Lisp
3279 source to most packages contains a short description of how they
3280 should be loaded, invoked, and configured---so before you use or
3281 modify a Lisp package, see if the author has provided any hints in the
3282 source code.
3284 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3285 the constituent Emacs packages.
3287 For advice on how to find extra packages that are not part of Emacs,
3288 see @ref{Packages that do not come with Emacs}.
3290 @node Packages that do not come with Emacs
3291 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3292 @cindex Unbundled packages
3293 @cindex Finding other packages
3294 @cindex Lisp packages that do not come with Emacs
3295 @cindex Packages, those that do not come with Emacs
3296 @cindex Emacs Lisp List
3297 @cindex Emacs Lisp Archive
3299 Your first port of call should be the @kbd{M-x list-packages} command.
3300 This connects to the @uref{http:///elpa.gnu.org, GNU ELPA} (``Emacs
3301 Lisp Package Archive'') server and fetches the list of additional
3302 packages that it offers.  These are GNU packages that are available
3303 for use with Emacs, but are distributed separately.  Select a package
3304 to get more details about the features that it offers, and then if you
3305 wish, Emacs can download and automatically install it for you.
3307 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs Lisp
3308 List (ELL)}, maintained by @email{S.J.Eglen@@damtp.cam.ac.uk, Stephen Eglen},
3309 aims to provide one compact list with links to all of the current Emacs
3310 Lisp files on the Internet.  The ELL can be browsed over the web, or
3311 from Emacs with @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.el,
3312 the @file{ell} package}.
3314 Many authors post their packages to the @uref{news:gnu.emacs.sources,
3315 Emacs sources newsgroup}.  You can search the archives of this
3316 group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google},
3317 or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example.
3319 Several packages are stored in
3320 @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}.
3322 Read the file @file{etc/MORE.STUFF} for more information about
3323 external packages.
3325 @node Spell-checkers
3326 @section Spell-checkers
3327 @cindex Spell-checker
3328 @cindex Checking spelling
3329 @cindex Ispell
3330 @cindex Aspell
3331 @cindex Hunspell
3333 Various spell-checkers are compatible with Emacs, including:
3335 @table @b
3337 @item GNU Aspell
3338 @uref{http://aspell.net/}
3340 @item Ispell
3341 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3343 @item Hunspell
3344 @uref{http://hunspell.sourceforge.net/}
3346 @end table
3348 @node Current GNU distributions
3349 @section Where can I get other up-to-date GNU stuff?
3350 @cindex Current GNU distributions
3351 @cindex Sources for current GNU distributions
3352 @cindex Stuff, current GNU
3353 @cindex Up-to-date GNU stuff
3354 @cindex Finding current GNU software
3355 @cindex Official GNU software sites
3357 The most up-to-date official GNU software is normally kept at
3359 @uref{ftp://ftp.gnu.org/pub/gnu}
3361 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3363 @uref{http://www.gnu.org/order/ftp.html}
3365 @node Difference between Emacs and XEmacs
3366 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3367 @cindex XEmacs
3368 @cindex Difference Emacs and XEmacs
3369 @cindex Lucid Emacs
3370 @cindex Epoch
3372 XEmacs is a branch version of Emacs.  It was first called Lucid Emacs,
3373 and was initially derived from a prerelease version of Emacs 19.  In
3374 this FAQ, we use the name ``Emacs'' only for the official version.
3376 Emacs and XEmacs each come with Lisp packages that are lacking in the
3377 other.  The two versions have some significant differences at the Lisp
3378 programming level.  Their current features are roughly comparable,
3379 though the support for some operating systems, character sets and
3380 specific packages might be quite different.
3382 Some XEmacs code has been contributed to Emacs, and we would like to
3383 use other parts, but the earlier XEmacs maintainers did not always
3384 keep track of the authors of contributed code, which makes it
3385 impossible for the FSF to get copyright papers signed for that code.
3386 (The FSF requires these papers for all the code included in the Emacs
3387 release, aside from generic C support packages that retain their
3388 separate identity and are not integrated into the code of Emacs
3389 proper.)
3391 If you want to talk about these two versions and distinguish them,
3392 please call them ``Emacs'' and ``XEmacs.''  To contrast ``XEmacs''
3393 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3394 origin in the work of the GNU Project.  Terms such as ``Emacsen'' and
3395 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3396 is better to write ``Emacs and XEmacs.''
3398 @node Emacs for minimalists
3399 @section I don't have enough disk space to install Emacs
3400 @cindex Zile
3401 @cindex Not enough disk space to install Emacs
3403 GNU Zile is a lightweight Emacs clone.  Zile is short for @samp{Zile Is
3404 Lossy Emacs}.  It has all of Emacs's basic editing features.  The Zile
3405 binary typically has a size of about 130 kbytes, so this can be useful
3406 if you are in an extremely space-restricted environment.  More
3407 information is available from
3409 @uref{http://www.gnu.org/software/zile/}
3412 @node Emacs for MS-DOS
3413 @section Where can I get Emacs for MS-DOS?
3414 @cindex MS-DOS, Emacs for
3415 @cindex DOS, Emacs for
3416 @cindex Compiling Emacs for DOS
3417 @cindex Emacs for MS-DOS
3419 To build Emacs from source for MS-DOS, see the instructions in the file
3420 @file{msdos/INSTALL} in the distribution.  The DOS port builds and runs
3421 on plain DOS, and also on all versions of MS-Windows from version 3.X
3422 onwards, including Windows XP and Vista.
3424 The file @file{etc/PROBLEMS} contains some additional information
3425 regarding Emacs under MS-DOS.
3427 A pre-built binary distribution of the old Emacs 20 is available, as
3428 described at
3430 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3432 For a list of other MS-DOS implementations of Emacs (and Emacs
3433 look-alikes), consult the list of ``Emacs implementations and literature,''
3434 available at
3436 @uref{http://www.finseth.com/emacs.html}
3438 Note that while many of these programs look similar to Emacs, they often
3439 lack certain features, such as the Emacs Lisp extension language.
3441 @node Emacs for MS-Windows
3442 @section Where can I get Emacs for Microsoft Windows?
3443 @cindex FAQ for Emacs on MS-Windows
3444 @cindex Emacs for MS-Windows
3445 @cindex Microsoft Windows, Emacs for
3447 There is a @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html,
3448 separate FAQ} for Emacs on MS-Windows.  For MS-DOS, @pxref{Emacs for MS-DOS}.
3451 @node Emacs for GNUstep
3452 @section Where can I get Emacs for GNUstep?
3453 @cindex GNUstep, Emacs for
3455 Beginning with version 23.1, Emacs supports GNUstep natively.
3456 See the file @file{nextstep/INSTALL} in the distribution.
3458 @node Emacs for Mac OS X
3459 @section Where can I get Emacs for Mac OS X?
3460 @cindex Apple computers, Emacs for
3461 @cindex Macintosh, Emacs for
3462 @cindex Mac OS X, Emacs for
3464 Beginning with version 22.1, Emacs supports Mac OS X natively.
3465 See the file @file{nextstep/INSTALL} in the distribution.
3467 @c ------------------------------------------------------------
3468 @node Key bindings
3469 @chapter Key bindings
3470 @cindex Key bindings
3472 @menu
3473 * Binding keys to commands::
3474 * Invalid prefix characters::
3475 * Terminal setup code works after Emacs has begun::
3476 * Working with function and arrow keys::
3477 * X key translations for Emacs::
3478 * Backspace invokes help::
3479 * Swapping keys::
3480 * Producing C-XXX with the keyboard::
3481 * No Meta key::
3482 * No Escape key::
3483 * Compose Character::
3484 * Binding combinations of modifiers and function keys::
3485 * Meta key does not work in xterm::
3486 * ExtendChar key does not work as Meta::
3487 * SPC no longer completes file names::
3488 @end menu
3490 @node Binding keys to commands
3491 @section How do I bind keys (including function keys) to commands?
3492 @cindex Binding keys to commands
3493 @cindex Keys, binding to commands
3494 @cindex Commands, binding keys to
3496 Keys can be bound to commands either interactively or in your
3497 @file{.emacs} file.  To interactively bind keys for all modes, type
3498 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3500 To bind a key just in the current major mode, type @kbd{M-x
3501 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3503 @xref{Key Bindings,,, emacs, The GNU Emacs Manual}.
3505 To make the process of binding keys interactively easier, use the
3506 following ``trick'': First bind the key interactively, then immediately
3507 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}.  Now, the command needed
3508 to bind the key is in the kill ring, and can be yanked into your
3509 @file{.emacs} file.  If the key binding is global, no changes to the
3510 command are required.  For example,
3512 @lisp
3513 (global-set-key (quote [f1]) (quote help-for-help))
3514 @end lisp
3516 @noindent
3517 can be placed directly into the @file{.emacs} file.  If the key binding is
3518 local, the command is used in conjunction with the @samp{add-hook} function.
3519 For example, in TeX mode, a local binding might be
3521 @lisp
3522 (add-hook 'tex-mode-hook
3523   (lambda ()
3524    (local-set-key (quote [f1]) (quote help-for-help))))
3525 @end lisp
3528 @itemize @bullet
3530 @item
3531 Control characters in key sequences, in the form yanked from the kill
3532 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3533 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc.  You may want
3534 to convert these into their vector or string forms.
3536 @item
3537 If a prefix key of the character sequence to be bound is already
3538 bound as a complete key, then you must unbind it before the new
3539 binding.  For example, if @kbd{ESC @{} is previously bound:
3541 @lisp
3542 (global-unset-key [?\e ?@{])   ;;   or
3543 (local-unset-key [?\e ?@{])
3544 @end lisp
3546 @item
3547 Aside from commands and ``lambda lists,'' a vector or string also
3548 can be bound to a key and thus treated as a macro.  For example:
3550 @lisp
3551 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g])  ;;  or
3552 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3553 @end lisp
3555 @end itemize
3557 @node Invalid prefix characters
3558 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3559 @cindex Prefix characters, invalid
3560 @cindex Invalid prefix characters
3561 @cindex Misspecified key sequences
3563 Usually, one of two things has happened.  In one case, the control
3564 character in the key sequence has been misspecified (e.g. @samp{C-f}
3565 used instead of @samp{\C-f} within a Lisp expression).  In the other
3566 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3567 was already bound as a @dfn{complete key}.  Historically, the @samp{ESC [}
3568 prefix was usually the problem, in which case you should evaluate either
3569 of these forms before attempting to bind the key sequence:
3571 @lisp
3572 (global-unset-key [?\e ?[])  ;;  or
3573 (global-unset-key "\e[")
3574 @end lisp
3576 @node Terminal setup code works after Emacs has begun
3577 @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?
3578 @cindex Terminal setup code in @file{.emacs}
3580 During startup, Emacs initializes itself according to a given code/file
3581 order.  If some of the code executed in your @file{.emacs} file needs to
3582 be postponed until the initial terminal or window-system setup code has
3583 been executed but is not, then you will experience this problem (this
3584 code/file execution order is not enforced after startup).
3586 To postpone the execution of Emacs Lisp code until after terminal or
3587 window-system setup, treat the code as a @dfn{lambda list} and set the
3588 value of either the @code{term-setup-hook} or @code{window-setup-hook}
3589 variable to this lambda function.  For example,
3591 @lisp
3592 (add-hook 'term-setup-hook
3593           (lambda ()
3594            (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3595              ;; Make vt220's "Do" key behave like M-x:
3596              (global-set-key [do] 'execute-extended-command))))
3597 @end lisp
3599 For information on what Emacs does every time it is started, see the
3600 @file{lisp/startup.el} file.
3602 @node Working with function and arrow keys
3603 @section How do I tell what characters or symbols my function or arrow keys emit?
3604 @cindex Working with arrow keys
3605 @cindex Arrow keys, symbols generated by
3606 @cindex Working with function keys
3607 @cindex Function keys, symbols generated by
3608 @cindex Symbols generated by function keys
3610 Type @kbd{C-h c} then the function or arrow keys.  The command will
3611 return either a function key symbol or character sequence (see the
3612 Emacs documentation for an explanation).  This works for other
3613 keys as well.
3615 @node X key translations for Emacs
3616 @section How do I set the X key ``translations'' for Emacs?
3617 @cindex X key translations
3618 @cindex Key translations under X
3619 @cindex Translations for keys under X
3621 Emacs is not written using the Xt library by default, so there are no
3622 ``translations'' to be set.  (We aren't sure how to set such translations
3623 if you do build Emacs with Xt; please let us know if you've done this!)
3625 The only way to affect the behavior of keys within Emacs is through
3626 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs).  The
3627 @code{define-key} command should be used in conjunction with the
3628 @code{function-key-map} map.  For instance,
3630 @lisp
3631 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3632 @end lisp
3634 @noindent
3635 defines the @kbd{M-@key{TAB}} key sequence.
3637 @node Backspace invokes help
3638 @section Why does the @key{Backspace} key invoke help?
3639 @cindex Backspace key invokes help
3640 @cindex Help invoked by Backspace
3641 @cindex DEL key does not delete
3643 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
3644 @kbd{C-h} sends the same code.  In Emacs by default @kbd{C-h} invokes
3645 help-command.  This is intended to be easy to remember since the first
3646 letter of @samp{help} is @samp{h}.  The easiest solution to this problem
3647 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
3648 @key{Delete} key) for deleting the previous character.
3650 For many people this solution may be problematic:
3652 @itemize @bullet
3654 @item
3655 They normally use @key{Backspace} outside of Emacs for deleting the
3656 previous character.  This can be solved by making @key{DEL} the command
3657 for deleting the previous character outside of Emacs.  On many Unix
3658 systems, this command will remap @key{DEL}:
3660 @example
3661 stty erase `^?'
3662 @end example
3664 @item
3665 The user may prefer the @key{Backspace} key for deleting the
3666 previous character because it is more conveniently located on their
3667 keyboard or because they don't even have a separate @key{Delete} key.
3668 In this case, the @key{Backspace} key should be made to behave like
3669 @key{Delete}.  There are several methods.
3671 @itemize @minus
3672 @item
3673 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
3674 TeraTerm) allow the character generated by the @key{Backspace} key to be
3675 changed from a setup menu.
3677 @item
3678 You may be able to get a keyboard that is completely programmable, or a
3679 terminal emulator that supports remapping of any key to any other key.
3681 @item
3682 With Emacs 21.1 and later, you can control the effect of the
3683 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
3684 windowed displays, by customizing the option
3685 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
3686 normal-erase-is-backspace}.  See the documentation of these symbols
3687 (@pxref{Emacs Lisp documentation}) for more info.
3689 @item
3690 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
3691 Emacs:
3693 @lisp
3694 (keyboard-translate ?\C-h ?\C-?)
3695 @end lisp
3697 @noindent
3698 This is the recommended method of forcing @key{Backspace} to act as
3699 @key{DEL}, because it works even in modes which bind @key{DEL} to
3700 something other than @code{delete-backward-char}.
3702 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
3703 default deletes forward:
3705 @lisp
3706 (keyboard-translate ?\C-? ?\C-d)
3707 @end lisp
3709 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
3711 @item
3712 Another approach is to switch key bindings and put help on @kbd{C-x h}
3713 instead:
3715 @lisp
3716 (global-set-key "\C-h" 'delete-backward-char)
3718 ;; overrides mark-whole-buffer
3719 (global-set-key "\C-xh" 'help-command)
3720 @end lisp
3722 @noindent
3723 This method is not recommended, though: it only solves the problem for
3724 those modes which bind @key{DEL} to @code{delete-backward-char}.  Modes
3725 which bind @key{DEL} to something else, such as @code{view-mode}, will
3726 not work as you expect when you press the @key{Backspace} key.  For this
3727 reason, we recommend the @code{keyboard-translate} method, shown
3728 above.
3730 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
3731 @end itemize
3733 Don't try to bind @key{DEL} to @code{help-command}, because there are
3734 many modes that have local bindings of @key{DEL} that will interfere.
3736 @end itemize
3738 When Emacs 21 or later runs on a windowed display, it binds the
3739 @key{Delete} key to a command which deletes the character at point, to
3740 make Emacs more consistent with keyboard operation on these systems.
3742 For more information about troubleshooting this problem, see @ref{DEL
3743 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
3744 Manual}.
3746 @node Swapping keys
3747 @section How do I swap two keys?
3748 @cindex Swapping keys
3749 @cindex Keys, swapping
3750 @cindex @code{keyboard-translate}
3752 You can swap two keys (or key sequences) by using the
3753 @code{keyboard-translate} function.  For example, to turn @kbd{C-h}
3754 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
3756 @lisp
3757 (keyboard-translate ?\C-h ?\C-?)  ; translate `C-h' to DEL
3758 (keyboard-translate ?\C-? ?\C-h)  ; translate DEL to `C-h'.
3759 @end lisp
3761 @noindent
3762 The first key sequence of the pair after the function identifies what is
3763 produced by the keyboard; the second, what is matched for in the
3764 keymaps.
3766 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
3767 toggle @code{normal-erase-is-backspace-mode} instead of calling
3768 @code{keyboard-translate}.
3769 @xref{DEL Does Not Delete,,, emacs, The GNU Emacs Manual}.
3771 Keyboard translations are not the same as key bindings in keymaps.
3772 Emacs contains numerous keymaps that apply in different situations, but
3773 there is only one set of keyboard translations, and it applies to every
3774 character that Emacs reads from the terminal.  Keyboard translations
3775 take place at the lowest level of input processing; the keys that are
3776 looked up in keymaps contain the characters that result from keyboard
3777 translation.
3779 @node Producing C-XXX with the keyboard
3780 @section How do I produce C-XXX with my keyboard?
3781 @cindex Producing control characters
3782 @cindex Generating control characters
3783 @cindex Control characters, generating
3785 On terminals (but not under X), some common ``aliases'' are:
3787 @table @asis
3789 @item @kbd{C-2}  or  @kbd{C-@key{SPC}}
3790 @kbd{C-@@}
3792 @item @kbd{C-6}
3793 @kbd{C-^}
3795 @item @kbd{C-7}  or  @kbd{C-S--}
3796 @kbd{C-_}
3798 @item @kbd{C-4}
3799 @kbd{C-\}
3801 @item @kbd{C-5}
3802 @kbd{C-]}
3804 @item @kbd{C-/}
3805 @kbd{C-?}
3807 @end table
3809 Often other aliases exist; use the @kbd{C-h c} command and try
3810 @key{CTRL} with all of the digits on your keyboard to see what gets
3811 generated.  You can also try the @kbd{C-h w} command if you know the
3812 name of the command.
3814 @node No Meta key
3815 @section What if I don't have a @key{Meta} key?
3816 @cindex No @key{Meta} key
3817 @cindex @key{Meta} key, what to do if you lack it
3819 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
3821 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}.  In fact,
3822 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
3823 (depending on the value of @code{meta-prefix-char}).  Note that you
3824 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
3825 @key{ESC}, release it, and then press @key{a}.
3827 @node No Escape key
3828 @section What if I don't have an @key{Escape} key?
3829 @cindex No Escape key
3830 @cindex Lacking an Escape key
3831 @cindex Escape key, lacking
3833 Type @kbd{C-[} instead.  This should send @acronym{ASCII} code 27 just like an
3834 Escape key would.  @kbd{C-3} may also work on some terminal (but not
3835 under X).  For many terminals (notably DEC terminals) @key{F11}
3836 generates @key{ESC}.  If not, the following form can be used to bind it:
3838 @lisp
3839 ;; F11 is the documented ESC replacement on DEC terminals.
3840 (define-key function-key-map [f11] [?\e])
3841 @end lisp
3843 @node Compose Character
3844 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
3845 @cindex @key{Compose Character} key, using as @key{Meta}
3846 @cindex @key{Meta}, using @key{Compose Character} for
3848 On a dumb terminal such as a VT220, no.  It is rumored that certain
3849 VT220 clones could have their @key{Compose} key configured this way.  If
3850 you're using X, you might be able to do this with the @code{xmodmap}
3851 command.
3853 @node Binding combinations of modifiers and function keys
3854 @section How do I bind a combination of modifier key and function key?
3855 @cindex Modifiers and function keys
3856 @cindex Function keys and modifiers
3857 @cindex Binding modifiers and function keys
3859 You can represent modified function keys in vector format by adding
3860 prefixes to the function key symbol.  For example (from the Emacs
3861 documentation):
3863 @lisp
3864 (global-set-key [?\C-x right] 'forward-page)
3865 @end lisp
3867 @noindent
3868 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
3870 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
3871 @key{Super}, @key{Alt}, and @key{Shift} with function keys.  To
3872 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
3873 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name.  Here
3874 is how to make @kbd{H-M-RIGHT} move forward a word:
3876 @lisp
3877 (global-set-key [H-M-right] 'forward-word)
3878 @end lisp
3880 @itemize @bullet
3882 @item
3883 Not all modifiers are permitted in all situations.  @key{Hyper},
3884 @key{Super}, and @key{Alt} are not available on Unix character
3885 terminals.  Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and
3886 @kbd{Mouse-1}) also fall under this category.
3888 @end itemize
3890 @xref{Binding keys to commands}, for general key binding instructions.
3892 @node Meta key does not work in xterm
3893 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
3894 @cindex @key{Meta} key and @code{xterm}
3895 @cindex Xterm and @key{Meta} key
3897 @xref{Unibyte Mode,, Single-Byte Character Set Support, emacs, The GNU Emacs Manual}.
3899 If the advice in the Emacs manual fails, try all of these methods before
3900 asking for further help:
3902 @itemize @bullet
3904 @item
3905 You may have big problems using @code{mwm} as your window manager.
3906 (Does anyone know a good generic solution to allow the use of the
3907 @key{Meta} key in Emacs with @file{mwm}?)
3909 @item
3910 For X11: Make sure it really is a @key{Meta} key.  Use @code{xev} to
3911 find out what keysym your @key{Meta} key generates.  It should be either
3912 @code{Meta_L} or @code{Meta_R}.  If it isn't, use @file{xmodmap} to fix
3913 the situation.  If @key{Meta} does generate @code{Meta_L} or
3914 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
3915 your @file{~/.Xdefaults} file:
3917 @example
3918  XTerm*eightBitInput:   false
3919  XTerm*eightBitOutput:  true
3920 @end example
3922 @item
3923 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
3924 characters.  @samp{stty -a} (or @samp{stty everything}) should show
3925 @samp{cs8} somewhere.  If it shows @samp{cs7} instead, use @samp{stty
3926 cs8 -istrip} (or @samp{stty pass8}) to fix it.
3928 @item
3929 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
3930 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
3931 of every character.
3933 @item
3934 If Emacs is running on Ultrix, it is reported that evaluating
3935 @code{(set-input-mode t nil)} helps.
3937 @item
3938 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
3939 you type @kbd{M-W}, which is the same conversion Emacs would make if it
3940 got the @kbd{M-W} anyway.  In X11R4, the following resource
3941 specification will do this:
3943 @example
3944 XTerm.VT100.EightBitInput: false
3945 @end example
3947 @noindent
3948 (This changes the behavior of the @code{insert-eight-bit} action.)
3950 With older @code{xterm}s, you can specify this behavior with a translation:
3952 @example
3953 XTerm.VT100.Translations: #override \
3954   Meta<KeyPress>: string(0x1b) insert()
3955 @end example
3957 @noindent
3958 You might have to replace @samp{Meta} with @samp{Alt}.
3960 @end itemize
3962 @node ExtendChar key does not work as Meta
3963 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
3964 @cindex @key{ExtendChar} key as @key{Meta}
3965 @cindex @key{Meta}, using @key{ExtendChar} for
3966 @cindex HP-UX, the @key{ExtendChar} key
3968 This is a result of an internationalization extension in X11R4 and the
3969 fact that HP is now using this extension.  Emacs assumes that the
3970 @code{XLookupString} function returns the same result regardless of the
3971 @key{Meta} key state which is no longer necessarily true.  Until Emacs
3972 is fixed, the temporary kludge is to run this command after each time
3973 the X server is started but preferably before any xterm clients are:
3975 @example
3976 xmodmap -e 'remove mod1 = Mode_switch'
3977 @end example
3979 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
3980 @c solved?
3982 This will disable the use of the extra keysyms systemwide, which may be
3983 undesirable if you actually intend to use them.
3985 @node SPC no longer completes file names
3986 @section Why doesn't SPC complete file names anymore?
3987 @cindex @kbd{SPC} file name completion
3989 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
3990 the minibuffer, so that file names with embedded spaces could be typed
3991 without the need to quote the spaces.
3993 You can get the old behavior by binding @kbd{SPC} to
3994 @code{minibuffer-complete-word} in the minibuffer, as follows:
3996 @lisp
3997 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
3998   'minibuffer-complete-word)
4000 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4001   'minibuffer-complete-word)
4002 @end lisp
4004 @c ------------------------------------------------------------
4005 @node Alternate character sets
4006 @chapter Alternate character sets
4007 @cindex Alternate character sets
4009 @menu
4010 * Emacs does not display 8-bit characters::
4011 * Inputting eight-bit characters::
4012 * Right-to-left alphabets::
4013 * How to add fonts::
4014 @end menu
4016 @node Emacs does not display 8-bit characters
4017 @section How do I make Emacs display 8-bit characters?
4018 @cindex Displaying eight-bit characters
4019 @cindex Eight-bit characters, displaying
4021 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4022 Emacs Manual}.  On a Unix, when Emacs runs on a text-only terminal
4023 display or is invoked with @samp{emacs -nw}, you typically need to use
4024 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4025 display, even after setting the language environment; otherwise
4026 non-@acronym{ASCII} characters will display as @samp{?}.  On other operating
4027 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4028 character set supported by the display, and sets up the required
4029 terminal coding system automatically.
4031 @node Inputting eight-bit characters
4032 @section How do I input eight-bit characters?
4033 @cindex Entering eight-bit characters
4034 @cindex Eight-bit characters, entering
4035 @cindex Input, 8-bit characters
4037 Various methods are available for input of eight-bit characters.
4038 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4039 Emacs Manual}.  For more sophisticated methods,
4040 @pxref{Input Methods,,, emacs, The GNU Emacs Manual}.
4042 @node Right-to-left alphabets
4043 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4044 @cindex Right-to-left alphabets
4045 @cindex Hebrew, handling with Emacs
4046 @cindex Semitic alphabets
4047 @cindex Arabic
4048 @cindex Farsi
4049 @cindex bidirectional scripts
4051 Emacs supports display and editing of bidirectional scripts, such as
4052 Arabic, Farsi, and Hebrew, since version 24.1.
4053 @xref{New in Emacs 24, bidirectional display}.
4056 @node How to add fonts
4057 @section How do I add fonts for use with Emacs?
4058 @cindex add fonts for use with Emacs
4059 @cindex intlfonts
4061 First, download and install the BDF font files and any auxiliary
4062 packages they need.  The GNU Intlfonts distribution can be found on
4063 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU
4064 Software Directory Web site}.
4066 Next, if you are on X Window system, issue the following two commands
4067 from the shell's prompt:
4069 @example
4070   xset +fp /usr/local/share/emacs/fonts
4071   xset fp rehash
4072 @end example
4074 @noindent
4075 (Modify the first command if you installed the fonts in a directory
4076 that is not @file{/usr/local/share/emacs/fonts}.)  You also need to
4077 arrange for these two commands to run whenever you log in, e.g., by
4078 adding them to your window-system startup file, such as
4079 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4081 Now, add the following line to your @file{~/.emacs} init file:
4083 @lisp
4084   (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4085 @end lisp
4087 @noindent
4088 (Again, modify the file name if you installed the fonts elsewhere.)
4090 Finally, if you wish to use the installed fonts with @code{ps-print},
4091 add the following line to your @file{~/.emacs}:
4093 @lisp
4094   (setq ps-multibyte-buffer 'bdf-font-except-latin)
4095 @end lisp
4097 A few additional steps are necessary for MS-Windows; they are listed
4098 below.
4100 First, make sure @emph{all} the directories with BDF font files are
4101 mentioned in @code{bdf-directory-list}.  On Unix and GNU/Linux
4102 systems, one normally runs @kbd{make install} to install the BDF fonts
4103 in the same directory.  By contrast, Windows users typically don't run
4104 the Intlfonts installation command, but unpack the distribution in
4105 some directory, which leaves the BDF fonts in its subdirectories.  For
4106 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4107 then you should set @code{bdf-directory-list} as follows:
4109 @lisp
4110   (setq bdf-directory-list
4111     '("C:/Intlfonts/Asian"
4112       "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4113       "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4114       "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4115       "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4116       "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4117       "C:/Intlfonts/Misc"))
4118 @end lisp
4120 @cindex @code{w32-bdf-filename-alist}
4121 @cindex @code{w32-find-bdf-fonts}
4122 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4123 an alist of the BDF fonts and their corresponding file names.
4124 Assuming you have set @code{bdf-directory-list} to name all the
4125 directories with the BDF font files, the following Lisp snippet will
4126 set up @code{w32-bdf-filename-alist}:
4128 @lisp
4129   (setq w32-bdf-filename-alist
4130      (w32-find-bdf-fonts bdf-directory-list))
4131 @end lisp
4133 Now, create fontsets for the BDF fonts:
4135 @smallexample
4136   (create-fontset-from-fontset-spec
4137    "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4138    japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4139    katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4140    latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4141    japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4142    thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4143    lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4144    tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4145    ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4146    tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4147 @end smallexample
4149 Many of the international bdf fonts from Intlfonts are type 0, and
4150 therefore need to be added to font-encoding-alist:
4152 @lisp
4153   (setq font-encoding-alist
4154         (append '(("MuleTibetan-0" (tibetan . 0))
4155                   ("GB2312"        (chinese-gb2312 . 0))
4156                   ("JISX0208"      (japanese-jisx0208 . 0))
4157                   ("JISX0212"      (japanese-jisx0212 . 0))
4158                   ("VISCII"        (vietnamese-viscii-lower . 0))
4159                   ("KSC5601"       (korean-ksc5601 . 0))
4160                   ("MuleArabic-0"  (arabic-digit . 0))
4161                   ("MuleArabic-1"  (arabic-1-column . 0))
4162                   ("MuleArabic-2"  (arabic-2-column . 0)))
4163                 font-encoding-alist))
4164 @end lisp
4166 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4167 fontset, or you can select it by setting the default font in your
4168 @file{~/.emacs}:
4170 @lisp
4171   (set-default-font "fontset-bdf")
4172 @end lisp
4175 @c ------------------------------------------------------------
4176 @node Mail and news
4177 @chapter Mail and news
4178 @cindex Mail and news
4180 @menu
4181 * Changing the included text prefix::
4182 * Saving a copy of outgoing mail::
4183 * Expanding aliases when sending mail::
4184 * Sorting the messages in an Rmail folder::
4185 * Rmail writes to /var/spool/mail::
4186 * Replying to the sender of a message::
4187 * Automatically starting a mail or news reader::
4188 * Reading news with Emacs::
4189 * Gnus does not work with NNTP::
4190 * Making Gnus faster::
4191 * Catching up in all newsgroups::
4192 @end menu
4194 @node Changing the included text prefix
4195 @section How do I change the included text prefix in mail/news followups?
4196 @cindex Prefix in mail/news followups, changing
4197 @cindex Included text prefix, changing
4198 @cindex Setting the included text character
4199 @cindex Quoting in mail messages
4201 If you read mail with Rmail, set the variable @code{mail-yank-prefix}.
4202 For Gnus, set @code{message-yank-prefix}.  For VM, set
4203 @code{vm-included-text-prefix}.  For mh-e, set @code{mh-ins-buf-prefix}.
4205 For fancier control of citations, use Supercite (@pxref{Top,, the Supercite
4206 Manual, sc, The Supercite Manual}).
4208 To prevent Emacs from including various headers of the replied-to
4209 message, set the value of @code{mail-yank-ignored-headers} to an
4210 appropriate regexp.
4212 @node Saving a copy of outgoing mail
4213 @section How do I save a copy of outgoing mail?
4214 @cindex Saving a copy of outgoing mail
4215 @cindex Copying outgoing mail to a file
4216 @cindex Filing outgoing mail
4217 @cindex Automatic filing of outgoing mail
4218 @cindex Mail, saving outgoing automatically
4220 You can either mail yourself a copy by including a @samp{BCC} header in the
4221 mail message, or store a copy of the message directly to a file by
4222 including an @samp{FCC} header.
4224 If you use standard mail, you can automatically create a @samp{BCC} to
4225 yourself by putting
4227 @lisp
4228 (setq mail-self-blind t)
4229 @end lisp
4231 @noindent
4232 in your @file{.emacs} file.  You can automatically include an @samp{FCC}
4233 field by putting something like the following in your @file{.emacs}
4234 file:
4236 @lisp
4237 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4238 @end lisp
4240 The output file will be in Unix mail format.
4242 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4243 components file.
4245 It does not work to put @samp{set record filename} in the @file{.mailrc}
4246 file.
4248 @node Expanding aliases when sending mail
4249 @section Why doesn't Emacs expand my aliases when sending mail?
4250 @cindex Expanding aliases when sending mail
4251 @cindex Mail alias expansion
4252 @cindex Sending mail with aliases
4254 @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}.
4256 @itemize @bullet
4258 @item
4259 Normally, Emacs expands aliases when you send the message.
4260 To expand them before this, use @kbd{M-x expand-mail-aliases}.
4262 @item
4263 Emacs normally only reads the @file{.mailrc} file once per session, when
4264 you start to compose your first mail message.  If you edit the file
4265 after this, you can use @kbd{M-x build-mail-aliases} to make Emacs
4266 reread it.  Prior to Emacs 24.1, this is not an interactive command, so
4267 you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}.
4269 @item
4270 If you like, you can expand mail aliases as abbrevs, as soon as you
4271 type them in.  To enable this feature, execute the following:
4273 @lisp
4274 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4275 @end lisp
4277 Note that the aliases are expanded automatically only after you type
4278 a word-separator character (e.g. @key{RET} or @kbd{,}).  You can force their
4279 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4280 (@kbd{M-x expand-abbrev}).
4281 @end itemize
4283 @node Sorting the messages in an Rmail folder
4284 @section How can I sort the messages in my Rmail folder?
4285 @cindex Rmail, sorting messages in
4286 @cindex Folder, sorting messages in an Rmail
4287 @cindex Sorting messages in an Rmail folder
4289 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4290 and their key bindings.
4292 @node Rmail writes to /var/spool/mail
4293 @section Why does Rmail need to write to @file{/var/spool/mail}?
4294 @cindex Rmail and @file{/var/spool/mail}
4295 @cindex @file{/var/spool/mail} and Rmail
4297 This is the behavior of the @code{movemail} program which Rmail uses.
4298 This indicates that @code{movemail} is configured to use lock files.
4300 RMS writes:
4302 @quotation
4303 Certain systems require lock files to interlock access to mail files.
4304 On these systems, @code{movemail} must write lock files, or you risk losing
4305 mail.  You simply must arrange to let @code{movemail} write them.
4307 Other systems use the @code{flock} system call to interlock access.  On
4308 these systems, you should configure @code{movemail} to use @code{flock}.
4309 @end quotation
4311 @node Replying to the sender of a message
4312 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4313 @cindex Replying only to the sender of a message
4314 @cindex Sender, replying only to
4315 @cindex Rmail, replying to the sender of a message in
4317 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit
4318 @key{r} to reply in Rmail, by default it CCs all of the original
4319 recipients (everyone on the original @samp{To} and @samp{CC}
4320 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4321 it replies only to the sender.  However, going through the whole
4322 @kbd{C-u} business every time you want to reply is a pain.  This is the
4323 best fix I've been able to come up with:
4325 @lisp
4326 (defun rmail-reply-t ()
4327   "Reply only to the sender of the current message. (See rmail-reply.)"
4328   (interactive)
4329   (rmail-reply t))
4331 (add-hook 'rmail-mode-hook
4332   (lambda ()
4333     (define-key rmail-mode-map "r" 'rmail-reply-t)
4334     (define-key rmail-mode-map "R" 'rmail-reply)))
4335 @end lisp
4337 @node Automatically starting a mail or news reader
4338 @section How do I make Emacs automatically start my mail/news reader?
4339 @cindex Mail reader, starting automatically
4340 @cindex News reader, starting automatically
4341 @cindex Starting mail/news reader automatically
4343 To start Emacs in Gnus:
4345 @example
4346 emacs -f gnus
4347 @end example
4349 @noindent
4350 in Rmail:
4352 @example
4353 emacs -f rmail
4354 @end example
4356 A more convenient way to start with Gnus:
4358 @example
4359 alias gnus 'emacs -f gnus'
4360 gnus
4361 @end example
4363 It is probably unwise to automatically start your mail or news reader
4364 from your @file{.emacs} file.  This would cause problems if you needed to run
4365 two copies of Emacs at the same time.  Also, this would make it difficult for
4366 you to start Emacs quickly when you needed to.
4368 @node Reading news with Emacs
4369 @section How do I read news under Emacs?
4370 @cindex Reading news under Emacs
4371 @cindex Usenet reader in Emacs
4372 @cindex Gnus newsreader
4373 @cindex FAQ for Gnus
4374 @cindex Gnus FAQ
4375 @cindex Learning more about Gnus
4377 Use @kbd{M-x gnus}.  For more information on Gnus, @pxref{Top,, the Gnus
4378 Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked
4379 Questions,, the Gnus FAQ, gnus, The Gnus Manual}.
4382 @node Gnus does not work with NNTP
4383 @section Why doesn't Gnus work via NNTP?
4384 @cindex Gnus and NNTP
4385 @cindex NNTP, Gnus fails to work with
4387 There is a bug in NNTP version 1.5.10, such that when multiple requests
4388 are sent to the NNTP server, the server only handles the first one
4389 before blocking waiting for more input which never comes.  NNTP version
4390 1.5.11 claims to fix this.
4392 You can work around the bug inside Emacs like this:
4394 @lisp
4395 (setq nntp-maximum-request 1)
4396 @end lisp
4398 You can find out what version of NNTP your news server is running by
4399 telnetting to the NNTP port (usually 119) on the news server machine
4400 (i.e., @kbd{telnet server-machine 119}).  The server should give its
4401 version number in the welcome message.  Type @kbd{quit} to get out.
4403 @node Making Gnus faster
4404 @section How do I make Gnus faster?
4405 @cindex Faster, starting Gnus
4406 @cindex Starting Gnus faster
4407 @cindex Gnus, starting faster
4408 @cindex Slow catch up in Gnus
4409 @cindex Gnus is slow when catching up
4410 @cindex Crosspostings make Gnus catching up slow
4412 From the Gnus FAQ (@pxref{Reading news with Emacs}):
4414 @quotation
4415 If you have a slow machine, or are just really impatient, there are a
4416 few things you can do to make Gnus run faster.
4418 Set @code{gnus-check-new-newsgroups} and
4419 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
4421 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
4422 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
4423 summary buffer faster.
4424 @end quotation
4426 @node Catching up in all newsgroups
4427 @section How do I catch up all newsgroups in Gnus?
4428 @cindex Catching up all newsgroups in Gnus
4429 @cindex Gnus, Catching up all newsgroups in
4431 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4433 Leave off the initial @kbd{M-<} if you only want to catch up from point
4434 to the end of the @file{*Newsgroup*} buffer.
4436 @node Concept index
4437 @unnumbered Concept Index
4438 @printindex cp
4440 @bye