* doc/misc/faq.texi (Top): Don't say this was updated @today.
[emacs.git] / doc / misc / faq.texi
blob18e3340a4742d122d40f30d5337132beda5e6b04
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--2013 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 This is the GNU Emacs FAQ.
63 This FAQ is maintained as a part of GNU Emacs.  If you find any errors,
64 or have any suggestions, please use @kbd{M-x report-emacs-bug} to report
65 them.
67 This is the version of the FAQ distributed with Emacs @value{EMACSVER}, and
68 mainly describes that version.  Although there is some information on
69 older versions, details about very old releases (now only of historical
70 interest) have been removed.  If you are interested in this, consult
71 either the version of the FAQ distributed with older versions of Emacs,
72 or the history of this document in the Emacs source repository.
74 Since Emacs releases are very stable, we recommend always running the
75 latest release.
77 This FAQ is not updated very frequently.  When you have a question about
78 Emacs, the Emacs manual is often the best starting point.
80 @ifnottex
81 @insertcopying
82 @end ifnottex
84 @menu
85 * FAQ notation::
86 * General questions::
87 * Getting help::
88 * Status of Emacs::
89 * Common requests::
90 * Bugs and problems::
91 * Compiling and installing Emacs::
92 * Finding Emacs and related packages::
93 * Key bindings::
94 * Alternate character sets::
95 * Mail and news::
96 * Concept index::
97 @end menu
99 @c ------------------------------------------------------------
100 @node FAQ notation
101 @chapter FAQ notation
102 @cindex FAQ notation
104 This chapter describes notation used in the GNU Emacs FAQ, as well as in
105 the Emacs documentation.  Consult this section if this is the first time
106 you are reading the FAQ, or if you are confused by notation or terms
107 used in the FAQ.
109 @menu
110 * Basic keys::
111 * Extended commands::
112 * Emacs manual::
113 * File-name conventions::
114 * Common acronyms::
115 @end menu
117 @node Basic keys
118 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
119 @cindex Basic keys
120 @cindex Control key, notation for
121 @cindex @key{Meta} key, notation for
122 @cindex Control-Meta characters, notation for
123 @cindex @kbd{C-h}, definition of
124 @cindex @kbd{C-M-h}, definition of
125 @cindex @key{DEL}, definition of
126 @cindex @key{ESC}, definition of
127 @cindex @key{LFD}, definition of
128 @cindex @key{RET}, definition of
129 @cindex @key{SPC}, definition of
130 @cindex @key{TAB}, definition of
131 @cindex Notation for keys
133 @itemize @bullet
135 @item
136 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
138 @item
139 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
140 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
142 @item
143 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
144 and @key{Meta}
146 @item
147 @kbd{C-M-x}: a synonym for the above
149 @item
150 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
152 @item
153 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
155 @item
156 @key{DEL}: @key{Delete}, usually @strong{not} the same as
157 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
158 deleting invokes Emacs help)
160 @item
161 @key{ESC}: Escape; same as @kbd{C-[}
163 @item
164 @key{TAB}: Tab; same as @kbd{C-i}
166 @item
167 @key{SPC}: Space bar
169 @end itemize
171 Key sequences longer than one key (and some single-key sequences) are
172 written inside quotes or on lines by themselves, like this:
174 @display
175   @kbd{M-x frobnicate-while-foo RET}
176 @end display
178 @noindent
179 Any real spaces in such a key sequence should be ignored; only @key{SPC}
180 really means press the space key.
182 The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
183 that would be sent by pressing just @key{x} minus 96 (or 64 for
184 upper-case @key{X}) and will be from 0 to 31.  On Unix and GNU/Linux
185 terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the
186 @acronym{ASCII} code that would be sent by pressing just @key{x}.  Essentially,
187 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
188 7@footnote{
189 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
190 pressed.}.
192 @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127.  It is a misnomer to call
193 @kbd{C-?}  a ``control'' key, since 127 has both bits 5 and 6 turned ON@.
194 Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127.
195 @c FIXME I cannot understand the previous sentence.
197 @xref{Keys,,, emacs, The GNU Emacs Manual}.
199 @node Extended commands
200 @section What does @file{M-x @var{command}} mean?
201 @cindex Extended commands
202 @cindex Commands, extended
203 @cindex M-x, meaning of
205 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
206 command, then type @key{RET}.  (@xref{Basic keys}, if you're not sure
207 what @kbd{M-x} and @key{RET} mean.)
209 @kbd{M-x} (by default) invokes the command
210 @code{execute-extended-command}.  This command allows you to run any
211 Emacs command if you can remember the command's name.  If you can't
212 remember the command's name, you can type @key{TAB} and @key{SPC} for
213 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
214 @kbd{M-n} (or up-arrow and down-arrow) to see previous commands entered.
215 An Emacs @dfn{command} is an @dfn{interactive} Emacs function.
217 @cindex @key{Do} key
218 Your system administrator may have bound other key sequences to invoke
219 @code{execute-extended-command}.  A function key labeled @kbd{Do} is a
220 good candidate for this, on keyboards that have such a key.
222 If you need to run non-interactive Emacs functions, see @ref{Evaluating
223 Emacs Lisp code}.
225 @node Emacs manual
226 @section How do I read topic XXX in the Emacs manual?
227 @cindex Emacs manual, reading topics in
228 @cindex Reading topics in the Emacs manual
229 @cindex Finding topics in the Emacs manual
230 @cindex Info, finding topics in
232 When we refer you to some @var{topic} in the Emacs manual, you can
233 read this manual node inside Emacs (assuming nothing is broken) by
234 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
236 This invokes Info, the GNU hypertext documentation browser.  If you don't
237 already know how to use Info, type @key{?} from within Info.
239 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
240 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
242 If these commands don't work as expected, your system administrator may
243 not have installed the Info files, or may have installed them
244 improperly.  In this case you should complain.
246 If you are reading this FAQ in Info, you can simply press @key{RET} on a
247 reference to follow it.
249 @xref{Getting a printed manual}, if you would like a paper copy of the
250 Emacs manual.
252 @node File-name conventions
253 @section What are @file{src/config.h}, @file{site-lisp/default.el}, etc.?
254 @cindex File-name conventions
255 @cindex Conventions for file names
256 @cindex Directories and files that come with Emacs
258 These are files that come with Emacs.  The Emacs distribution is divided
259 into subdirectories; e.g., @file{etc}, @file{lisp}, and @file{src}.
260 Some of these (e.g., @file{etc} and @file{lisp}) are present both in
261 an installed Emacs and in the sources, but some (e.g., @file{src}) are
262 only found in the sources.
264 If you use Emacs, but don't know where it is kept on your system, start
265 Emacs, then type @kbd{C-h v data-directory @key{RET}}.  The directory
266 name displayed by this will be the full pathname of the installed
267 @file{etc} directory.  (This full path is recorded in the Emacs variable
268 @code{data-directory}, and @kbd{C-h v} displays the value and the
269 documentation of a variable.)
271 The location of your Info directory (i.e., where Info documentation
272 is stored) is kept in the variable @code{Info-default-directory-list}.  Use
273 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
274 this variable, which will be a list of directory names.  The last
275 directory in that list is probably where most Info files are stored.  By
276 default, Emacs Info documentation is placed in @file{/usr/local/share/info}.
278 For information on some of the files in the @file{etc} directory,
279 @pxref{Informational files for Emacs}.
281 @node Common acronyms
282 @section What are FSF, LPF, GNU, RMS, FTP, and GPL?
283 @cindex FSF, definition of
284 @cindex LPF, definition of
285 @cindex GNU, definition of
286 @cindex RMS, definition of
287 @cindex Stallman, Richard, acronym for
288 @cindex Richard Stallman, acronym for
289 @cindex FTP, definition of
290 @cindex GPL, definition of
291 @cindex Acronyms, definitions for
292 @cindex Common acronyms, definitions for
294 @table @asis
296 @item FSF
297 Free Software Foundation
299 @item LPF
300 League for Programming Freedom
302 @item GNU
303 GNU's Not Unix
305 @item RMS
306 Richard Matthew Stallman
308 @item FTP
309 File Transfer Protocol
311 @item GPL
312 GNU General Public License
314 @end table
316 Avoid confusing the FSF and the LPF@.  The LPF opposes
317 look-and-feel copyrights and software patents.  The FSF aims to make
318 high quality free software available for everyone.
320 The word ``free'' in the title of the Free Software Foundation refers to
321 ``freedom,'' not ``zero cost.''  Anyone can charge any price for
322 GPL-covered software that they want to.  However, in practice, the
323 freedom enforced by the GPL leads to low prices, because you can always
324 get the software for less money from someone else, since everyone has
325 the right to resell or give away GPL-covered software.
327 @c ------------------------------------------------------------
328 @node General questions
329 @chapter General questions
330 @cindex General questions
332 This chapter contains general questions having to do with Emacs, the
333 Free Software Foundation, and related organizations.
335 @menu
336 * The LPF::
337 * Real meaning of copyleft::
338 * Guidelines for newsgroup postings::
339 * Newsgroup archives::
340 * Reporting bugs::
341 * Unsubscribing from Emacs lists::
342 * Contacting the FSF::
343 @end menu
345 @node The LPF
346 @section What is the LPF?
347 @cindex LPF, description of
348 @cindex League for Programming Freedom
349 @cindex Software patents, opposition to
350 @cindex Patents for software, opposition to
352 The LPF opposes the expanding danger of software patents and
353 look-and-feel copyrights.  More information on the LPF's views is
354 available at @uref{http://progfree.org/, the LPF home page}.
356 @node Real meaning of copyleft
357 @section What is the real legal meaning of the GNU copyleft?
358 @cindex Copyleft, real meaning of
359 @cindex GPL, real meaning of
360 @cindex General Public License, real meaning of
361 @cindex Discussion of the GPL
363 The real legal meaning of the GNU General Public License (copyleft) will
364 only be known if and when a judge rules on its validity and scope.
365 There has never been a copyright infringement case involving the GPL to
366 set any precedents.  Although legal actions have been brought against
367 companies for violating the terms of the GPL, so far all have been
368 settled out of court (in favor of the plaintiffs).  Please take any
369 discussion regarding this issue to the newsgroup
370 @uref{news:gnu.misc.discuss}, which was created to hold the extensive
371 flame wars on the subject.
373 RMS writes:
375 @quotation
376 The legal meaning of the GNU copyleft is less important than the spirit,
377 which is that Emacs is a free software project and that work pertaining
378 to Emacs should also be free software.  ``Free'' means that all users
379 have the freedom to study, share, change and improve Emacs.  To make
380 sure everyone has this freedom, pass along source code when you
381 distribute any version of Emacs or a related program, and give the
382 recipients the same freedom that you enjoyed.
383 @end quotation
385 @node Guidelines for newsgroup postings
386 @section  What are appropriate messages for the various Emacs newsgroups?
387 @cindex Newsgroups, appropriate messages for
388 @cindex GNU newsgroups, appropriate messages for
389 @cindex Usenet groups, appropriate messages for
390 @cindex Mailing lists, appropriate messages for
391 @cindex Posting messages to newsgroups
393 @cindex GNU mailing lists
394 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU
395 mailing list (@pxref{Informational files for Emacs}).  For those lists
396 which are gatewayed with newsgroups, it lists both the newsgroup name
397 and the mailing list address.  The Emacs mailing lists are also
398 described at @uref{http://savannah.gnu.org/mail/?group=emacs, the Emacs
399 Savannah page}.
401 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
402 in general.  The newsgroup @uref{news:gnu.emacs.help} is specifically
403 for GNU Emacs.  It therefore makes no sense to cross-post to both
404 groups, since only one can be appropriate to any question.
406 Messages advocating ``non-free'' software are considered unacceptable on
407 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
408 which was created to hold the extensive flame-wars on the subject.
409 ``Non-free'' software includes any software for which the end user can't
410 freely modify the source code and exchange enhancements.  Be careful to
411 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
412 posting a followup that recommends such software.
414 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
415 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
417 @node Newsgroup archives
418 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
419 @cindex Archived postings from @code{gnu.emacs.help}
420 @cindex Usenet archives for GNU groups
421 @cindex Old Usenet postings for GNU groups
423 The FSF has maintained archives of all of the GNU mailing lists for many
424 years, although there may be some unintentional gaps in coverage.  The
425 archive can be browsed over the web at
426 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}.  Raw
427 files can be downloaded from @uref{ftp://lists.gnu.org/}.
429 Web-based Usenet search services, such as
430 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
431 archive the @code{gnu.*} groups.
433 You can also read the archives of the @code{gnu.*} groups and post new
434 messages at @uref{http://gmane.org/, Gmane}.  Gmane is a service that
435 presents mailing lists as newsgroups (even those without a traditional
436 mail-to-news gateway).
438 @node Reporting bugs
439 @section Where should I report bugs and other problems with Emacs?
440 @cindex Bug reporting
441 @cindex Good bug reports
442 @cindex How to submit a bug report
443 @cindex Reporting bugs
445 The correct way to report Emacs bugs is to use the command
446 @kbd{M-x report-emacs-bug}.  It sets up a mail buffer with the
447 essential information and the correct e-mail address, which is
448 @email{bug-gnu-emacs@@gnu.org} for the released versions of Emacs.
449 Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the
450 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
451 news to submit the bug report.  This ensures a reliable return address
452 so you can be contacted for further details.
454 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
455 a bug!  The manual describes in detail how to submit a useful bug
456 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
457 (@xref{Emacs manual}, if you don't know how to read the manual.)
459 RMS says:
461 @quotation
462 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the
463 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because
464 it takes the time of an unnecessarily large group of people, most of
465 whom are just users and have no idea how to fix these problem.
466 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people
467 who are more likely to know what to do and have expressed a wish to
468 receive more messages about Emacs than the others.
469 @end quotation
471 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
473 @quotation
474 If you have reported a bug and you don't hear about a possible fix,
475 then after a suitable delay (such as a week) it is okay to post on
476 @code{gnu.emacs.help} asking if anyone can help you.
477 @end quotation
479 If you are unsure whether you have found a bug, consider the following
480 non-exhaustive list, courtesy of RMS:
482 @quotation
483 If Emacs crashes, that is a bug.  If Emacs gets compilation errors
484 while building, that is a bug.  If Emacs crashes while building, that
485 is a bug.  If Lisp code does not do what the documentation says it
486 does, that is a bug.
487 @end quotation
489 @node Unsubscribing from Emacs lists
490 @section  How do I unsubscribe from a mailing list?
491 @cindex Unsubscribing from GNU mailing lists
492 @cindex Removing yourself from GNU mailing lists
494 If you are receiving a GNU mailing list named @var{list}, you should be
495 able to unsubscribe from it by sending a request to the address
496 @email{@var{list}-request@@gnu.org}.  Mailing lists mails normally
497 contain information in either the message header
498 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
499 unsubscribe.
501 @node Contacting the FSF
502 @section  How do I contact the FSF?
503 @cindex Contracting the FSF
504 @cindex Free Software Foundation, contacting
506 For up-to-date information, see
507 @uref{http://www.fsf.org/about/contact.html, the FSF contact web-page}.
508 You can send general correspondence to @email{info@@fsf.org}.
510 @cindex Ordering GNU software
511 For details on how to order items directly from the FSF, see the
512 @uref{http://shop.fsf.org/, FSF on-line store}.
514 @c ------------------------------------------------------------
515 @node Getting help
516 @chapter Getting help
517 @cindex Getting help
519 This chapter tells you how to get help with Emacs.
521 @menu
522 * Basic editing::
523 * Learning how to do something::
524 * Getting a printed manual::
525 * Emacs Lisp documentation::
526 * Installing Texinfo documentation::
527 * Printing a Texinfo file::
528 * Viewing Info files outside of Emacs::
529 * Informational files for Emacs::
530 * Help installing Emacs::
531 * Obtaining the FAQ::
532 @end menu
534 @node Basic editing
535 @section I'm just starting Emacs; how do I do basic editing?
536 @cindex Basic editing with Emacs
537 @cindex Beginning editing
538 @cindex Tutorial, invoking the
539 @cindex Self-paced tutorial, invoking the
540 @cindex Help system, entering the
542 Type @kbd{C-h t} to invoke the self-paced tutorial.  Just typing
543 @kbd{C-h} enters the help system.  Starting with Emacs 22, the tutorial
544 is available in many foreign languages such as French, German, Japanese,
545 Russian, etc.  Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
546 to choose your language and start the tutorial.
548 Your system administrator may have changed @kbd{C-h} to act like
549 @key{DEL} to deal with local keyboards.  You can use @kbd{M-x
550 help-for-help} instead to invoke help.  To discover what key (if any)
551 invokes help on your system, type @kbd{M-x where-is @key{RET}
552 help-for-help @key{RET}}.  This will print a comma-separated list of key
553 sequences in the echo area.  Ignore the last character in each key
554 sequence listed.  Each of the resulting key sequences (e.g., @key{F1} is
555 common) invokes help.
557 Emacs help works best if it is invoked by a single key whose value
558 should be stored in the variable @code{help-char}.
560 @node Learning how to do something
561 @section How do I find out how to do something in Emacs?
562 @cindex Help for Emacs
563 @cindex Learning to do something in Emacs
564 @cindex Reference card for Emacs
565 @cindex Overview of help systems
567 There are several methods for finding out how to do things in Emacs.
569 @itemize @bullet
571 @cindex Reading the Emacs manual
572 @item
573 The complete text of the Emacs manual is available via the Info
574 hypertext reader.  Type @kbd{C-h r} to display the manual in Info mode.
575 Typing @key{h} immediately after entering Info will provide a short
576 tutorial on how to use it.
578 @cindex Lookup a subject in a manual
579 @cindex Index search in a manual
580 @item
581 To quickly locate the section of the manual which discusses a certain
582 issue, or describes a command or a variable, type @kbd{C-h i m emacs
583 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
584 topic, the command, or the variable which you are looking for.  If this
585 does not land you on the right place in the manual, press @kbd{,}
586 (comma) repeatedly until you find what you need.  (The @kbd{i} and
587 @kbd{,} keys invoke the index-searching functions, which look for the
588 @var{topic} you type in all the indices of the Emacs manual.)
590 @cindex Apropos
591 @item
592 You can list all of the commands whose names contain a certain word
593 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
594 command-apropos}).
596 @cindex Command description in the manual
597 @item
598 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
599 for the name of a command, and then attempts to find the section in the
600 Emacs manual where that command is described.
602 @cindex Finding commands and variables
603 @item
604 You can list all of the functions and variables whose names contain a
605 certain word using @kbd{M-x apropos}.
607 @item
608 You can list all of the functions and variables whose documentation
609 matches a regular expression or a string, using @kbd{M-x
610 apropos-documentation}.
612 @item
613 You can order a hardcopy of the manual from the FSF@.  @xref{Getting a
614 printed manual}.
616 @cindex Reference cards, in other languages
617 @item
618 You can get a printed reference card listing commands and keys to
619 invoke them.  You can order one from the FSF for $2 (or 10 for $18),
620 or you can print your own from the @file{etc/refcards/refcard.tex} or
621 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
622 Beginning with version 21.1, the Emacs distribution comes with
623 translations of the reference card into several languages; look for
624 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
625 is a two-letter code of the language.  For example, the German version
626 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
627 and @file{etc/refcards/de-refcard.pdf}.
629 @item
630 There are many other commands in Emacs for getting help and
631 information.  To get a list of these commands, type @samp{?} after
632 @kbd{C-h}.
634 @end itemize
636 @node Getting a printed manual
637 @section How do I get a printed copy of the Emacs manual?
638 @cindex Printed Emacs manual, obtaining
639 @cindex Manual, obtaining a printed or HTML copy of
640 @cindex Emacs manual, obtaining a printed or HTML copy of
642 You can order a printed copy of the Emacs manual from the FSF@.  For
643 details see the @uref{http://shop.fsf.org/, FSF on-line store}.
645 The full Texinfo source for the manual also comes in the @file{doc/emacs}
646 directory of the Emacs distribution, if you're daring enough to try to
647 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
648 file}).
650 If you absolutely have to print your own copy, and you don't have @TeX{},
651 you can get a PostScript or PDF (or HTML) version from
653 @uref{http://www.gnu.org/software/emacs/manual/}
655 @xref{Learning how to do something}, for how to view the manual from Emacs.
657 @node Emacs Lisp documentation
658 @section Where can I get documentation on Emacs Lisp?
659 @cindex Documentation on Emacs Lisp
660 @cindex Function documentation
661 @cindex Variable documentation
662 @cindex Emacs Lisp Reference Manual
663 @cindex Reference manual for Emacs Lisp
665 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
666 function, @kbd{C-h v} for a variable.
668 For more information, the Emacs Lisp Reference Manual is available
669 in Info format (@pxref{Top, Emacs Lisp,, elisp, The
670 Emacs Lisp Reference Manual}).
672 You can also order a hardcopy of the manual from the FSF, for details
673 see the @uref{http://shop.fsf.org/, FSF on-line store}.  (This manual is
674 not always in print.)
676 An HTML version of the Emacs Lisp Reference Manual is available at
678 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html}
680 @node Installing Texinfo documentation
681 @section How do I install a piece of Texinfo documentation?
682 @cindex Texinfo documentation, installing
683 @cindex Installing Texinfo documentation
684 @cindex New Texinfo files, installing
685 @cindex Documentation, installing new Texinfo files
686 @cindex Info files, how to install
688 Emacs releases come with pre-built Info files, and the normal install
689 process places them in the correct location.  This is true for most
690 applications that provide Info files.  The following section is only
691 relevant if you want to install extra Info files by hand.
693 First, you must turn the Texinfo source files into Info files.  You may
694 do this using the stand-alone @file{makeinfo} program, available as part
695 of the Texinfo package at
697 @uref{http://www.gnu.org/software/texinfo/}
699 For information about the Texinfo format, read the Texinfo manual which
700 comes with the Texinfo package.  This manual also comes installed in
701 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
702 @key{RET}}.
704 @c FIXME is this a complete alternative?
705 @c Probably not, given that we require makeinfo to build Emacs.
706 Alternatively, you could use the Emacs command @kbd{M-x
707 texinfo-format-buffer}, after visiting the Texinfo source file of the
708 manual you want to convert.
710 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
711 resulting Info files in Emacs's Info tree.  To install Info files,
712 perform these steps:
714 @enumerate
715 @item
716 Move the files to the @file{info} directory in the installed Emacs
717 distribution.  @xref{File-name conventions}, if you don't know where that
720 @item
721 Run the @code{install-info} command, which is part of the Texinfo
722 distribution, to update the main Info directory menu, like this:
724 @example
725  install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
726 @end example
728 @noindent
729 where @var{dir-path} is the full path to the directory where you copied
730 the produced Info file(s), and @var{file} is the name of the Info file
731 you produced and want to install.
733 If you don't have the @code{install-info} command installed, you can
734 edit the file @file{info/dir} in the installed Emacs distribution, and
735 add a line for the top level node in the Info package that you are
736 installing.  Follow the examples already in this file.  The format is:
738 @example
739 * Topic: (relative-pathname).  Short description of topic.
740 @end example
742 @end enumerate
744 If you want to install Info files and you don't have the necessary
745 privileges, you have several options:
747 @itemize @bullet
748 @item
749 Info files don't actually need to be installed before being used.
750 You can use a prefix argument for the @code{info} command and specify
751 the name of the Info file in the minibuffer.  This goes to the node
752 named @samp{Top} in that file.  For example, to view a Info file named
753 @file{@var{info-file}} in your home directory, you can type this:
755 @example
756 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
757 @end example
759 Alternatively, you can feed a file name to the @code{Info-goto-node}
760 command (invoked by pressing @key{g} in Info mode) by typing the name
761 of the file in parentheses, like this:
763 @example
764 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
765 @end example
767 @item
768 You can create your own Info directory.  You can tell Emacs where that
769 Info directory is by adding its pathname to the value of the variable
770 @code{Info-default-directory-list}.  For example, to use a private Info
771 directory which is a subdirectory of your home directory named @file{Info},
772 you could put this in your @file{.emacs} file:
774 @lisp
775 (add-to-list 'Info-default-directory-list "~/Info")
776 @end lisp
778 You will need a top-level Info file named @file{dir} in this directory
779 which has everything the system @file{dir} file has in it, except it
780 should list only entries for Info files in that directory.  You might
781 not need it if (fortuitously) all files in this directory were
782 referenced by other @file{dir} files.  The node lists from all
783 @file{dir} files in @code{Info-default-directory-list} are merged by the
784 Info system.
786 @end itemize
788 @node Printing a Texinfo file
789 @section How do I print a Texinfo file?
790 @cindex Printing a Texinfo file
791 @cindex Texinfo file, printing
792 @cindex Printing documentation
794 You can't get nicely printed output from Info files; you must still have
795 the original Texinfo source file for the manual you want to print.
797 Assuming you have @TeX{} installed on your system, follow these steps:
799 @enumerate
801 @item
802 Make sure the first line of the Texinfo file looks like this:
804 @example
805 \input texinfo
806 @end example
808 You may need to change @samp{texinfo} to the full pathname of the
809 @file{texinfo.tex} file, which comes with Emacs as
810 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
812 @item
813 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
814 the name of the Texinfo source file for which you want to produce a
815 printed copy.  The @samp{texi2dvi} script is part of the GNU Texinfo
816 distribution.
818 Alternatively, @samp{texi2pdf} produces PDF files.
820 @item
821 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
822 printing DVI files at your site.  For example, if you have a PostScript
823 printer, run the @code{dvips} program to print the DVI file on that
824 printer.
826 @end enumerate
828 To get more general instructions, retrieve the latest Texinfo package
829 (@pxref{Installing Texinfo documentation}).
831 @node Viewing Info files outside of Emacs
832 @section Can I view Info files without using Emacs?
833 @cindex Viewing Info files
834 @cindex Info file viewers
835 @cindex Alternative Info file viewers
837 Yes.  Here are some alternative programs:
839 @itemize @bullet
841 @item
842 @code{info}, a stand-alone version of the Info program, comes as part of
843 the Texinfo package.  @xref{Installing Texinfo documentation}, for
844 details.
846 @item
847 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
848 You can get Tkinfo at
849 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
851 @end itemize
853 @node Informational files for Emacs
854 @section What informational files are available for Emacs?
855 @cindex Informational files included with Emacs
856 @cindex Files included with Emacs
857 @cindex @file{COPYING}, description of file
858 @cindex @file{DISTRIB}, description of file
859 @cindex @file{GNU}, description of file
860 @cindex @file{INTERVIEW}, description of file
861 @cindex @file{MACHINES}, description of file
862 @cindex @file{MAILINGLISTS}, description of file
863 @cindex @file{NEWS}, description of file
865 This isn't a frequently asked question, but it should be!  A variety of
866 informational files about Emacs and relevant aspects of the GNU project
867 are available for you to read.
869 The following files (and others) are available in the @file{etc}
870 directory of the Emacs distribution (see @ref{File-name conventions}, if
871 you're not sure where that is).  Many of these files are available via
872 the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
873 help-for-help}).
875 @table @file
877 @item COPYING
878 GNU General Public License
880 @item DISTRIB
881 Emacs Availability Information
883 @item GNU
884 The GNU Manifesto
886 @item INTERVIEW
887 Richard Stallman discusses his public-domain UNIX-compatible software
888 system with BYTE editors
890 @item MACHINES
891 Status of Emacs on Various Machines and Systems
893 @item MAILINGLISTS
894 GNU Project Electronic Mailing Lists
896 @item NEWS
897 Emacs news, a history of recent user-visible changes
899 @end table
901 More GNU information, including back issues of the @cite{GNU's
902 Bulletin}, are at
904 @uref{http://www.gnu.org/bulletins/bulletins.html} and
906 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
908 @node Help installing Emacs
909 @section Where can I get help in installing Emacs?
910 @cindex Installation help
911 @cindex Help installing Emacs
913 @xref{Installing Emacs}, for some basic installation hints, and see
914 @ref{Problems building Emacs}, if you have problems with the installation.
916 @uref{http://www.fsf.org/resources/service/, The GNU Service directory}
917 lists companies and individuals willing to sell you help in installing
918 or using Emacs and other GNU software.
920 @node Obtaining the FAQ
921 @section Where can I get the latest version of this FAQ?
922 @cindex FAQ, obtaining the
923 @cindex Latest FAQ version, obtaining the
925 The Emacs FAQ is distributed with Emacs in Info format.  You can read it
926 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
927 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
928 C-f} (@kbd{M-x view-emacs-FAQ}).  The very latest version is available
929 in the Emacs development repository (@pxref{Latest version of Emacs}).
931 @c ------------------------------------------------------------
932 @node Status of Emacs
933 @chapter Status of Emacs
934 @cindex Status of Emacs
936 This chapter gives you basic information about Emacs, including the
937 status of its latest version.
939 @menu
940 * Origin of the term Emacs::
941 * Latest version of Emacs::
942 * New in Emacs 24::
943 * New in Emacs 23::
944 * New in Emacs 22::
945 * New in Emacs 21::
946 * New in Emacs 20::
947 @end menu
949 @node Origin of the term Emacs
950 @section Where does the name ``Emacs'' come from?
951 @cindex Origin of the term ``Emacs''
952 @cindex Emacs name origin
953 @cindex TECO
954 @cindex Original version of Emacs
956 Emacs originally was an acronym for Editor MACroS@.  RMS says he ``picked
957 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
958 the time.''  The first Emacs was a set of macros written in 1976 at MIT
959 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
960 Editor and COrrector) under ITS (the Incompatible Timesharing System) on
961 a PDP-10.  RMS had already extended TECO with a ``real-time''
962 full-screen mode with reprogrammable keys.  Emacs was started by
963 @email{gls@@east.sun.com, Guy Steele} as a project to unify the many
964 divergent TECO command sets and key bindings at MIT, and completed by
965 RMS.
967 Many people have said that TECO code looks a lot like line noise; you
968 can read more at @uref{news:alt.lang.teco}.  Someone has written a TECO
969 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
970 come with Emacs}); it would be an interesting project to run the
971 original TECO Emacs inside of Emacs.
973 @cindex Why Emacs?
974 For some not-so-serious alternative reasons for Emacs to have that
975 name, check out the file @file{etc/JOKES} (@pxref{File-name
976 conventions}).
978 @node Latest version of Emacs
979 @section What is the latest version of Emacs?
980 @cindex Version, latest
981 @cindex Latest version of Emacs
982 @cindex Development, Emacs
983 @cindex Repository, Emacs
984 @cindex Bazaar repository, Emacs
986 Emacs @value{EMACSVER} is the current version as of this writing.  A version
987 number with two components (e.g., @samp{22.1}) indicates a released
988 version; three components indicate a development
989 version (e.g., @samp{23.0.50} is what will eventually become @samp{23.1}).
991 Emacs is under active development, hosted at
992 @uref{http://savannah.gnu.org/projects/emacs/, Savannah}.  The source
993 code can be retrieved anonymously following the
994 @uref{http://savannah.gnu.org/bzr/?group=emacs, instructions}.
995 The repository is GNU Bazaar.
997 Because Emacs undergoes many changes before a release, the version
998 number of a development version is not especially meaningful.  It is
999 better to refer to the date on which the sources were retrieved from the
1000 development repository.  The development version is usually quite robust
1001 for every-day use, but if stability is more important to you than the
1002 latest features, you may want to stick to the releases.
1004 The following sections list some of the major new features in the last
1005 few Emacs releases.  For full details of the changes in any version of
1006 Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}).  As of Emacs 22,
1007 you can give this command a prefix argument to read about which features
1008 were new in older versions.
1010 @node New in Emacs 24
1011 @section What is different about Emacs 24?
1012 @cindex Differences between Emacs 23 and Emacs 24
1013 @cindex Emacs 24, new features in
1015 @itemize
1016 @cindex packages, installing more
1017 @item
1018 Emacs now includes a package manager.  Type @kbd{M-x list-packages} to
1019 get started.  You can use this to download and automatically install
1020 many more Lisp packages.
1022 @cindex lexical binding
1023 @item
1024 Emacs Lisp now supports lexical binding on a per-file basis.  In
1025 @emph{lexical binding}, variable references must be located textually
1026 within the binding construct.  This contrasts with @emph{dynamic
1027 binding}, where programs can refer to variables defined outside their
1028 local textual scope.  A Lisp file can use a local variable setting of
1029 @code{lexical-binding: t} to indicate that the contents should be
1030 interpreted using lexical binding.  See the Emacs Lisp Reference
1031 Manual for more details.
1033 @cindex bidirectional display
1034 @cindex right-to-left languages
1035 @item
1036 Some human languages, such as English, are written from left to right.
1037 Others, such as Arabic, are written from right to left.  Emacs now has
1038 support for any mixture of these forms---this is ``bidirectional text''.
1040 @item
1041 Handling of text selections has been improved, and now integrates
1042 better with external clipboards.
1044 @cindex themes
1045 @item
1046 A new command @kbd{customize-themes} allows you to easily change the
1047 appearance of your Emacs.
1049 @item
1050 Emacs can be compiled with the GTK+ 3 toolkit.
1052 @item
1053 Support for several new external libraries can be included at compile
1054 time:
1056 @itemize
1058 @item
1059 ``Security-Enhanced Linux'' (SELinux) is a Linux kernel feature that
1060 provides more sophisticated file access controls than ordinary
1061 ``Unix-style'' file permissions.
1063 @item
1064 The ImageMagick display library.  This allows you to display many more
1065 image format in Emacs, as well as carry out transformations such as
1066 rotations.
1068 @item
1069 The GnuTLS library for secure network communications.  Emacs uses this
1070 transparently for email if your mail server supports it.
1072 @item
1073 The libxml2 library for parsing XML structures.
1074 @end itemize
1076 @item
1077 Much more flexibility in the handling of windows and buffer display.
1079 @end itemize
1081 As always, consult the @file{NEWS} file for more information.
1084 @node New in Emacs 23
1085 @section What is different about Emacs 23?
1086 @cindex Differences between Emacs 22 and Emacs 23
1087 @cindex Emacs 23, new features in
1089 @itemize
1091 @cindex Anti-aliased fonts
1092 @cindex Freetype fonts
1093 @item
1094 Emacs has a new font code that can use multiple font backends,
1095 including freetype and fontconfig.  Emacs can use the Xft library for
1096 anti-aliasing, and the otf and m17n libraries for complex text layout and
1097 text shaping.
1099 @cindex Unicode
1100 @cindex Character sets
1101 @item
1102 The Emacs character set is now a superset of Unicode.  Several new
1103 language environments have been added.
1105 @cindex Multi-tty support
1106 @cindex X and tty displays
1107 @item
1108 Emacs now supports using both X displays and ttys in the same session
1109 (@samp{multi-tty}).
1111 @cindex Daemon mode
1112 @item
1113 Emacs can be started as a daemon in the background.
1115 @cindex NeXTstep port
1116 @cindex GNUstep port
1117 @cindex Mac OS X Cocoa
1118 @item
1119 There is a new NeXTstep port of Emacs.  This supports GNUstep and Mac OS
1120 X (via the Cocoa libraries).  The Carbon port of Emacs, which supported
1121 Mac OS X in Emacs 22, has been removed.
1123 @cindex Directory-local variables
1124 @item
1125 Directory-local variables can now be defined, in a similar manner to
1126 file-local variables.
1128 @item
1129 Transient Mark mode (@pxref{Highlighting a region}) is on by default.
1131 @end itemize
1133 @noindent
1134 Other changes include: support for serial port access; D-Bus bindings; a
1135 new Visual Line mode for line-motion; improved completion; a new mode
1136 (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML
1137 mode (for editing XML documents) is included; VC has been updated for
1138 newer version control systems; etc.
1141 @node New in Emacs 22
1142 @section What is different about Emacs 22?
1143 @cindex Differences between Emacs 21 and Emacs 22
1144 @cindex Emacs 22, new features in
1146 @itemize
1147 @cindex GTK+ Toolkit
1148 @cindex Drag-and-drop
1149 @item
1150 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1151 operation on X.
1153 @cindex Supported systems
1154 @item
1155 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1156 machines, as well as support for the Mac OS X and Cygwin operating
1157 systems.
1159 @item
1160 The native MS-Windows, and Mac OS X builds include full support
1161 for images, toolbar, and tooltips.
1163 @item
1164 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1165 enabled by default.
1167 @item
1168 The maximum size of buffers is increased: on 32-bit machines, it is
1169 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above.
1171 @item
1172 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1174 @cindex Mouse wheel
1175 @item
1176 Mouse wheel support is enabled by default.
1178 @item
1179 Window fringes are customizable.
1181 @item
1182 The mode line of the selected window is now highlighted.
1184 @item
1185 The minibuffer prompt is displayed in a distinct face.
1187 @item
1188 Abbrev definitions are read automatically at startup.
1190 @item
1191 Grep mode is separate from Compilation mode and has many new options and
1192 commands specific to grep.
1194 @item
1195 The original Emacs macro system has been replaced by the new Kmacro
1196 package, which provides many new commands and features and a simple
1197 interface that uses the function keys F3 and F4.  Macros are stored in a
1198 macro ring, and can be debugged and edited interactively.
1200 @item
1201 The Grand Unified Debugger (GUD) can be used with a full graphical user
1202 interface to GDB; this provides many features found in traditional
1203 development environments, making it easy to manipulate breakpoints, add
1204 watch points, display the call stack, etc.  Breakpoints are visually
1205 indicated in the source buffer.
1207 @item
1208 @cindex New modes
1209 Many new modes and packages have been included in Emacs, such as Calc,
1210 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1211 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1212 savehist, Conf mode, Python mode, DNS mode, etc.
1214 @cindex Multilingual Environment
1215 @item
1216 Leim is now part of Emacs.  Unicode support has been much improved, and
1217 the following input methods have been added: belarusian, bulgarian-bds,
1218 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1219 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1220 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1221 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1222 ukrainian-computer, vietnamese-telex, and welsh.
1224 The following language environments have also been added: Belarusian,
1225 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1226 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1227 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1229 @cindex Documentation
1230 @cindex Emacs Lisp Manual
1231 @item
1232 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1233 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1234 @end itemize
1237 @node New in Emacs 21
1238 @section What is different about Emacs 21?
1239 @cindex Differences between Emacs 20 and Emacs 21
1240 @cindex Emacs 21, new features in
1242 @cindex Variable-size fonts
1243 @cindex Toolbar support
1244 Emacs 21 features a thorough rewrite of the display engine.  The new
1245 display engine supports variable-size fonts, images, and can play sounds
1246 on platforms which support that.  As a result, the visual appearance of
1247 Emacs, when it runs on a windowed display, is much more reminiscent of
1248 modern GUI programs, and includes 3D widgets (used for the mode line and
1249 the scroll bars), a configurable and extensible toolbar, tooltips
1250 (a.k.a.@: balloon help), and other niceties.
1252 @cindex Colors on text-only terminals
1253 @cindex TTY colors
1254 In addition, Emacs 21 supports faces on text-only terminals.  This means
1255 that you can now have colors when you run Emacs on a GNU/Linux console
1256 and on @code{xterm} with @kbd{emacs -nw}.
1259 @node New in Emacs 20
1260 @section What is different about Emacs 20?
1261 @cindex Differences between Emacs 19 and Emacs 20
1262 @cindex Emacs 20, new features in
1264 The differences between Emacs versions 18 and 19 were rather dramatic;
1265 the introduction of frames, faces, and colors on windowing systems was
1266 obvious to even the most casual user.
1268 There are differences between Emacs versions 19 and 20 as well, but many
1269 are more subtle or harder to find.  Among the changes are the inclusion
1270 of MULE code for languages that use non-Latin characters and for mixing
1271 several languages in the same document; the ``Customize'' facility for
1272 modifying variables without having to use Lisp; and automatic conversion
1273 of files from Macintosh, Microsoft, and Unix platforms.
1275 @c ------------------------------------------------------------
1276 @node Common requests
1277 @chapter Common requests
1278 @cindex Common requests
1280 @menu
1281 * Setting up a customization file::
1282 * Using Customize::
1283 * Colors on a TTY::
1284 * Debugging a customization file::
1285 * Displaying the current line or column::
1286 * Displaying the current file name in the titlebar::
1287 * Turning on abbrevs by default::
1288 * Associating modes with files::
1289 * Highlighting a region::
1290 * Replacing highlighted text::
1291 * Controlling case sensitivity::
1292 * Working with unprintable characters::
1293 * Searching for/replacing newlines::
1294 * Yanking text in isearch::
1295 * Wrapping words automatically::
1296 * Turning on auto-fill by default::
1297 * Changing load-path::
1298 * Using an already running Emacs process::
1299 * Compiler error messages::
1300 * Indenting switch statements::
1301 * Customizing C and C++ indentation::
1302 * Horizontal scrolling::
1303 * Overwrite mode::
1304 * Turning off beeping::
1305 * Turning the volume down::
1306 * Automatic indentation::
1307 * Matching parentheses::
1308 * Hiding #ifdef lines::
1309 * Repeating commands::
1310 * Valid X resources::
1311 * Evaluating Emacs Lisp code::
1312 * Changing the length of a Tab::
1313 * Inserting text at the beginning of each line::
1314 * Forcing the cursor to remain in the same column::
1315 * Forcing Emacs to iconify itself::
1316 * Using regular expressions::
1317 * Replacing text across multiple files::
1318 * Documentation for etags::
1319 * Disabling backups::
1320 * Disabling auto-save-mode::
1321 * Going to a line by number::
1322 * Modifying pull-down menus::
1323 * Deleting menus and menu options::
1324 * Turning on syntax highlighting::
1325 * Scrolling only one line::
1326 * Editing MS-DOS files::
1327 * Filling paragraphs with a single space::
1328 * Escape sequences in shell output::
1329 * Fullscreen mode on MS-Windows::
1330 @end menu
1332 @node Setting up a customization file
1333 @section How do I set up a @file{.emacs} file properly?
1334 @cindex @file{.emacs} file, setting up
1335 @cindex @file{.emacs} file, locating
1336 @cindex Init file, setting up
1337 @cindex Customization file, setting up
1339 @xref{Init File,,, emacs, The GNU Emacs Manual}.
1341 In general, new Emacs users should not be provided with @file{.emacs}
1342 files, because this can cause confusing non-standard behavior.  Then
1343 they send questions to @email{help-gnu-emacs@@gnu.org} asking why Emacs
1344 isn't behaving as documented.
1346 Emacs includes the Customize facility (@pxref{Using Customize}).  This
1347 allows users who are unfamiliar with Emacs Lisp to modify their
1348 @file{.emacs} files in a relatively straightforward way, using menus
1349 rather than Lisp code.
1351 While Customize might indeed make it easier to configure Emacs,
1352 consider taking a bit of time to learn Emacs Lisp and modifying your
1353 @file{.emacs} directly.  Simple configuration options are described
1354 rather completely in @ref{Init File,,, emacs, The GNU Emacs Manual},
1355 for users interested in performing frequently requested, basic tasks.
1357 Sometimes users are unsure as to where their @file{.emacs} file should
1358 be found.  Visiting the file as @file{~/.emacs} from Emacs will find
1359 the correct file.
1361 @node Using Customize
1362 @section How do I start using Customize?
1363 @cindex Customize groups
1364 @cindex Customizing variables
1365 @cindex Customizing faces
1367 The main Customize entry point is @kbd{M-x customize @key{RET}}.  This
1368 command takes you to a buffer listing all the available Customize
1369 groups.  From there, you can access all customizable options and faces,
1370 change their values, and save your changes to your init file.
1371 @xref{Easy Customization,,, emacs, The GNU Emacs Manual}.
1373 If you know the name of the group in advance (e.g., ``shell''), use
1374 @kbd{M-x customize-group @key{RET}}.
1376 If you wish to customize a single option, use @kbd{M-x customize-option
1377 @key{RET}}.  This command prompts you for the name of the option to
1378 customize, with completion.
1380 @node Colors on a TTY
1381 @section How do I get colors and syntax highlighting on a TTY?
1382 @cindex Colors on a TTY
1383 @cindex Syntax highlighting on a TTY
1384 @cindex Console, colors
1386 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1387 i.e., on Unix and GNU/Linux text-only terminals and consoles, and when
1388 invoked as @samp{emacs -nw} on X, and MS-Windows.  (Colors and faces were
1389 supported in the MS-DOS port since Emacs 19.29.)  Emacs automatically
1390 detects color support at startup and uses it if available.  If you think
1391 that your terminal supports colors, but Emacs won't use them, check the
1392 @code{termcap} entry for your display type for color-related
1393 capabilities.
1395 The command @kbd{M-x list-colors-display} pops up a window which
1396 exhibits all the colors Emacs knows about on the current display.
1398 Syntax highlighting is on by default since version 22.1.
1400 @node Debugging a customization file
1401 @section How do I debug a @file{.emacs} file?
1402 @cindex Debugging @file{.emacs} file
1403 @cindex @file{.emacs} debugging
1404 @cindex Init file debugging
1405 @cindex @samp{-debug-init} option
1407 Start Emacs with the @samp{-debug-init} command-line option.  This
1408 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1409 file, and places you in the debugger if something goes wrong.  The top
1410 line in the @file{trace-back} buffer will be the error message, and the
1411 second or third line of that buffer will display the Lisp code from your
1412 @file{.emacs} file that caused the problem.
1414 You can also evaluate an individual function or argument to a function
1415 in your @file{.emacs} file by moving the cursor to the end of the
1416 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1417 eval-last-sexp}).
1419 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1420 variables which you are trying to set or use.
1422 @node Displaying the current line or column
1423 @section How do I make Emacs display the current line (or column) number?
1424 @cindex @code{line-number-mode}
1425 @cindex Displaying the current line or column
1426 @cindex Line number, displaying the current
1427 @cindex Column, displaying the current
1428 @cindex @code{mode-line-format}
1430 By default, Emacs displays the current line number of the point in the
1431 mode line.  You can toggle this feature off or on with the command
1432 @kbd{M-x line-number-mode}, or by setting the variable
1433 @code{line-number-mode}.  Note that Emacs will not display the line
1434 number if the buffer's size in bytes is larger than the value of the
1435 variable @code{line-number-display-limit}.
1437 You can similarly display the current column with
1438 @kbd{M-x column-number-mode}, or by putting the form
1440 @lisp
1441 (setq column-number-mode t)
1442 @end lisp
1444 @noindent
1445 in your @file{.emacs} file.  This feature is off by default.
1447 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1448 will insert the current column's value into the mode line.  See the
1449 documentation for @code{mode-line-format} (using @kbd{C-h v
1450 mode-line-format @key{RET}}) for more information on how to set and use
1451 this variable.
1453 @cindex Set number capability in @code{vi} emulators
1454 The @samp{linum} package (distributed with Emacs since version 23.1)
1455 displays line numbers in the left margin, like the ``set number''
1456 capability of @code{vi}.  The packages @samp{setnu} and
1457 @samp{wb-line-number} (not distributed with Emacs) also implement this
1458 feature.
1460 @node Displaying the current file name in the titlebar
1461 @section How can I modify the titlebar to contain the current file name?
1462 @cindex Titlebar, displaying the current file name in
1463 @cindex File name, displaying in the titlebar
1464 @cindex @code{frame-title-format}
1466 The contents of an Emacs frame's titlebar is controlled by the variable
1467 @code{frame-title-format}, which has the same structure as the variable
1468 @code{mode-line-format}.  (Use @kbd{C-h v} or @kbd{M-x
1469 describe-variable} to get information about one or both of these
1470 variables.)
1472 By default, the titlebar for a frame does contain the name of the buffer
1473 currently being visited, except if there is a single frame.  In such a
1474 case, the titlebar contains Emacs invocation name and the name of the
1475 machine at which Emacs was invoked.  This is done by setting
1476 @code{frame-title-format} to the default value of
1478 @lisp
1479 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1480 @end lisp
1482 To modify the behavior such that frame titlebars contain the buffer's
1483 name regardless of the number of existing frames, include the following
1484 in your @file{.emacs}:
1486 @lisp
1487 (setq frame-title-format "%b")
1488 @end lisp
1490 @node Turning on abbrevs by default
1491 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1492 @cindex Abbrevs, turning on by default
1494 Abbrev mode expands abbreviations as you type them.  To turn it on in a
1495 specific buffer, use @kbd{M-x abbrev-mode}.  To turn it on in every
1496 buffer by default, put this in your @file{.emacs} file:
1498 @lisp
1499 (setq-default abbrev-mode t)
1500 @end lisp
1502 @noindent To turn it on in a specific mode, use:
1504 @lisp
1505 (add-hook '@var{mymode}-mode-hook
1506           (lambda ()
1507            (setq abbrev-mode t)))
1508 @end lisp
1510 @noindent If your Emacs version is older then 22.1, you will also need to use:
1512 @lisp
1513 (condition-case ()
1514    (quietly-read-abbrev-file)
1515   (file-error nil))
1516 @end lisp
1518 @node Associating modes with files
1519 @section How do I make Emacs use a certain major mode for certain files?
1520 @cindex Associating modes with files
1521 @cindex File extensions and modes
1522 @cindex @code{auto-mode-alist}, modifying
1523 @cindex Modes, associating with file extensions
1525 If you want to use a certain mode @var{foo} for all files whose names end
1526 with the extension @file{.@var{bar}}, this will do it for you:
1528 @lisp
1529 (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode))
1530 @end lisp
1532 Alternatively, put this somewhere in the first line of any file you want to
1533 edit in the mode @var{foo} (in the second line, if the first line begins
1534 with @samp{#!}):
1536 @example
1537 -*- @var{foo} -*-
1538 @end example
1540 @cindex Major mode for shell scripts
1541 The variable @code{interpreter-mode-alist} specifies which mode to use
1542 when loading an interpreted script (e.g., shell, python, etc.).  Emacs
1543 determines which interpreter you're using by examining the first line of
1544 the script.  Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
1545 @code{interpreter-mode-alist} to learn more.
1547 @node Highlighting a region
1548 @section How can I highlight a region of text in Emacs?
1549 @cindex Highlighting text
1550 @cindex Text, highlighting
1551 @cindex @code{transient-mark-mode}
1552 @cindex Region, highlighting a
1554 You can cause the region to be highlighted when the mark is active by
1555 including
1557 @lisp
1558 (transient-mark-mode 1)
1559 @end lisp
1561 @noindent
1562 in your @file{.emacs} file.  Since Emacs 23.1, this feature is on by default.
1564 @node Replacing highlighted text
1565 @section How can I replace highlighted text with what I type?
1566 @cindex @code{delete-selection-mode}
1567 @cindex Replacing highlighted text
1568 @cindex Highlighting and replacing text
1570 Use @code{delete-selection-mode}, which you can start automatically by
1571 placing the following Lisp form in your @file{.emacs} file:
1573 @lisp
1574 (delete-selection-mode 1)
1575 @end lisp
1577 According to the documentation string for @code{delete-selection-mode}
1578 (which you can read using @kbd{M-x describe-function @key{RET}
1579 delete-selection-mode @key{RET}}):
1581 @quotation
1582 When Delete Selection mode is enabled, Transient Mark mode is also
1583 enabled and typed text replaces the selection if the selection is
1584 active.  Otherwise, typed text is just inserted at point regardless of
1585 any selection.
1586 @end quotation
1588 This mode also allows you to delete (not kill) the highlighted region by
1589 pressing @key{DEL}.
1591 @node Controlling case sensitivity
1592 @section How do I control Emacs's case-sensitivity when searching/replacing?
1593 @cindex @code{case-fold-search}
1594 @cindex Case sensitivity of searches
1595 @cindex Searching without case sensitivity
1596 @cindex Ignoring case in searches
1598 @c FIXME
1599 The value of the variable @code{case-fold-search} determines whether
1600 searches are case sensitive:
1602 @lisp
1603 (setq case-fold-search nil) ; make searches case sensitive
1604 (setq case-fold-search t)   ; make searches case insensitive
1605 @end lisp
1607 @cindex Case sensitivity in replacements
1608 @cindex Replacing, and case sensitivity
1609 @cindex @code{case-replace}
1610 Similarly, for replacing, the variable @code{case-replace} determines
1611 whether replacements preserve case.
1613 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1615 To change the case sensitivity just for one major mode, use the major
1616 mode's hook.  For example:
1618 @lisp
1619 (add-hook '@var{foo}-mode-hook
1620           (lambda ()
1621            (setq case-fold-search nil)))
1622 @end lisp
1624 @node Working with unprintable characters
1625 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1626 @cindex Unprintable characters, working with
1627 @cindex Working with unprintable characters
1628 @cindex Control characters, working with
1629 @cindex Eight-bit characters, working with
1630 @cindex Searching for unprintable characters
1631 @cindex Regexps and unprintable characters
1633 To search for a single character that appears in the buffer as, for
1634 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.
1635 Searching for @strong{all} unprintable characters is best done with a
1636 regular expression (@dfn{regexp}) search.  The easiest regexp to use for
1637 the unprintable chars is the complement of the regexp for the printable
1638 chars.
1640 @itemize @bullet
1642 @item
1643 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1645 @item
1646 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1648 @end itemize
1650 To type these special characters in an interactive argument to
1651 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1652 use @kbd{C-q}.  (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1653 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.)  So,
1654 to search for unprintable characters using @code{re-search-forward}:
1656 @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}}
1658 Using @code{isearch-forward-regexp}:
1660 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1662 To delete all unprintable characters, simply use replace-regexp:
1664 @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}}
1666 Replacing is similar to the above.  To replace all unprintable
1667 characters with a colon, use:
1669 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}
1671 @node Searching for/replacing newlines
1672 @section How do I input a newline character in isearch or query-replace?
1673 @cindex Searching for newlines
1674 @cindex Replacing newlines
1676 Use @kbd{C-q C-j}.  For more information,
1677 @pxref{Special Isearch,, Special Input for Incremental Search, emacs,
1678 The GNU Emacs Manual}.
1680 @node Yanking text in isearch
1681 @section How do I copy text from the kill ring into the search string?
1682 @cindex Yanking text into the search string
1683 @cindex isearch yanking
1685 Use @kbd{M-y}.  @xref{Isearch Yank,,, emacs, The GNU Emacs Manual}.
1687 @node Wrapping words automatically
1688 @section How do I make Emacs wrap words for me?
1689 @cindex Wrapping word automatically
1690 @cindex Wrapping lines
1691 @cindex Line wrap
1692 @cindex @code{auto-fill-mode}, introduction to
1693 @cindex Maximum line width, default value
1694 @cindex @code{fill-column}, default value
1696 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1697 The default maximum line width is 70, determined by the variable
1698 @code{fill-column}.  To learn how to turn this on automatically, see
1699 @ref{Turning on auto-fill by default}.
1701 @node Turning on auto-fill by default
1702 @section How do I turn on @code{auto-fill-mode} by default?
1703 @cindex @code{auto-fill-mode}, activating automatically
1704 @cindex Filling automatically
1705 @cindex Automatic entry to @code{auto-fill-mode}
1707 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1708 auto-fill-mode}.
1710 To turn it on for every buffer in a certain mode, you must use the hook
1711 for that mode.  For example, to turn on @code{auto-fill} mode for all
1712 text buffers, including the following in your @file{.emacs} file:
1714 @lisp
1715 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1716 @end lisp
1718 If you want @code{auto-fill} mode on in all major modes, do this:
1720 @lisp
1721 (setq-default auto-fill-function 'do-auto-fill)
1722 @end lisp
1724 @node Changing load-path
1725 @section How do I change @code{load-path}?
1726 @cindex @code{load-path}, modifying
1727 @cindex Modifying @code{load-path}
1728 @cindex Adding to @code{load-path}
1730 In general, you should only add to the @code{load-path}.  You can add
1731 directory @var{/dir/subdir} to the load path like this:
1733 @lisp
1734 (add-to-list 'load-path "/dir/subdir/")
1735 @end lisp
1737 To do this relative to your home directory:
1739 @lisp
1740 (add-to-list 'load-path "~/mysubdir/")
1741 @end lisp
1743 @node Using an already running Emacs process
1744 @section How do I use an already running Emacs from another window?
1745 @cindex @code{emacsclient}
1746 @cindex Emacs server functions
1747 @cindex Using an existing Emacs process
1749 @code{emacsclient}, which comes with Emacs, is for editing a file using
1750 an already running Emacs rather than starting up a new Emacs.  It does
1751 this by sending a request to the already running Emacs, which must be
1752 expecting the request.
1754 @itemize @bullet
1756 @item
1757 Setup:
1759 Emacs must have executed the @code{server-start} function for
1760 @samp{emacsclient} to work.  This can be done either by a command line
1761 option:
1763 @example
1764 emacs -f server-start
1765 @end example
1767 or by invoking @code{server-start} from @file{.emacs}:
1769 @lisp
1770 (if (@var{some conditions are met}) (server-start))
1771 @end lisp
1773 When this is done, Emacs creates a Unix domain socket named
1774 @file{server} in @file{/tmp/emacs@var{userid}}. See
1775 @code{server-socket-dir}.
1777 To get your news reader, mail reader, etc., to invoke
1778 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1779 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}.  You may
1780 have to specify the full pathname of the @samp{emacsclient} program
1781 instead.  Examples:
1783 @example
1784 # csh commands:
1785 setenv EDITOR emacsclient
1787 # using full pathname
1788 setenv EDITOR /usr/local/emacs/etc/emacsclient
1790 # sh command:
1791 EDITOR=emacsclient ; export EDITOR
1792 @end example
1794 @item
1795 Normal use:
1797 When @samp{emacsclient} is run, it connects to the socket and passes its
1798 command line options to Emacs, which at the next opportunity will visit
1799 the files specified.  (Line numbers can be specified just like with
1800 Emacs.)  The user will have to switch to the Emacs window by hand.  When
1801 the user is done editing a file, the user can type @kbd{C-x #} (or
1802 @kbd{M-x server-edit}) to indicate this.  If there is another buffer
1803 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1804 @code{emacsclient} will exit, signaling the calling program to continue.
1806 @cindex @code{gnuserv}
1807 There is an alternative version of @samp{emacsclient} called
1808 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman}
1809 (@pxref{Packages that do not come with Emacs}).  @samp{gnuserv} uses
1810 Internet domain sockets, so it can work across most network connections.
1812 The most recent @samp{gnuserv} package is available at
1814 @uref{http://meltin.net/hacks/emacs/}
1816 @end itemize
1818 @node Compiler error messages
1819 @section How do I make Emacs recognize my compiler's funny error messages?
1820 @cindex Compiler error messages, recognizing
1821 @cindex Recognizing non-standard compiler errors
1822 @cindex Regexps for recognizing compiler errors
1823 @cindex Errors, recognizing compiler
1825 Customize the @code{compilation-error-regexp-alist} variable.
1827 @node Indenting switch statements
1828 @section How do I change the indentation for @code{switch}?
1829 @cindex @code{switch}, indenting
1830 @cindex Indenting of @code{switch}
1832 Many people want to indent their @code{switch} statements like this:
1834 @example
1837   switch(x) @{
1838     case A:
1839       x1;
1840       break;
1841     case B:
1842       x2;
1843       break;
1844     default:
1845       x3;
1846   @}
1848 @end example
1850 @noindent To achieve this, add the following line to your @file{.emacs}:
1852 @lisp
1853 (c-set-offset 'case-label '+)
1854 @end lisp
1856 @node Customizing C and C++ indentation
1857 @section How to customize indentation in C, C@t{++}, and Java buffers?
1858 @cindex Indentation, how to customize
1859 @cindex Customize indentation
1861 The Emacs @code{cc-mode} features an interactive procedure for
1862 customizing the indentation style, which is fully explained in the
1863 @cite{CC Mode} manual that is part of the Emacs distribution, see
1864 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1865 The CC Mode Manual}.  Here's a short summary of the procedure:
1867 @enumerate
1868 @item
1869 Go to the beginning of the first line where you don't like the
1870 indentation and type @kbd{C-c C-o}.  Emacs will prompt you for the
1871 syntactic symbol; type @key{RET} to accept the default it suggests.
1873 @item
1874 Emacs now prompts for the offset of this syntactic symbol, showing the
1875 default (the current definition) inside parentheses.  You can choose
1876 one of these:
1878 @table @code
1879 @item 0
1880 No extra indentation.
1881 @item +
1882 Indent one basic offset.
1883 @item -
1884 Outdent one basic offset.
1885 @item ++
1886 Indent two basic offsets
1887 @item --
1888 Outdent two basic offsets.
1889 @item *
1890 Indent half basic offset.
1891 @item /
1892 Outdent half basic offset.
1893 @end table
1895 @item
1896 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1897 the line or the block according to what you just specified.
1899 @item
1900 If you don't like the result, go back to step 1.  Otherwise, add the
1901 following line to your @file{.emacs}:
1903 @lisp
1904 (c-set-offset '@var{syntactic-symbol} @var{offset})
1905 @end lisp
1907 @noindent
1908 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1909 when you type @kbd{C-c C-o} at the beginning of the line, and
1910 @var{offset} is one of the indentation symbols listed above (@code{+},
1911 @code{/}, @code{0}, etc.)@: that you've chosen during the interactive
1912 procedure.
1914 @item
1915 Go to the next line whose indentation is not to your liking and repeat
1916 the process there.
1917 @end enumerate
1919 It is recommended to put all the resulting @code{(c-set-offset ...)}
1920 customizations inside a C mode hook, like this:
1922 @lisp
1923 (defun my-c-mode-hook ()
1924   (c-set-offset ...)
1925   (c-set-offset ...))
1926 (add-hook 'c-mode-hook 'my-c-mode-hook)
1927 @end lisp
1929 @noindent
1930 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1931 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1932 might be unavailable when @code{cc-mode} is not loaded.
1934 Note that @code{c-mode-hook} runs for C source files only; use
1935 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1936 Java sources, etc.  If you want the same customizations to be in
1937 effect in @emph{all} languages supported by @code{cc-mode}, use
1938 @code{c-mode-common-hook}.
1940 @node Horizontal scrolling
1941 @section How can I make Emacs automatically scroll horizontally?
1942 @cindex @code{hscroll-mode}
1943 @cindex Horizontal scrolling
1944 @cindex Scrolling horizontally
1946 In Emacs 21 and later, this is on by default: if the variable
1947 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1948 automatically scrolls the display horizontally when point moves off the
1949 left or right edge of the window.
1951 Note that this is overridden by the variable
1952 @code{truncate-partial-width-windows} if that variable is non-nil
1953 and the current buffer is not full-frame width.
1955 In Emacs 20, use @code{hscroll-mode}.
1957 @node Overwrite mode
1958 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
1959 @cindex @key{Insert}
1960 @cindex @code{overwrite-mode}
1961 @cindex Overwriting existing text
1962 @cindex Toggling @code{overwrite-mode}
1964 @kbd{M-x overwrite-mode} (a minor mode).  This toggles
1965 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1966 is as easy as another @kbd{M-x overwrite-mode}.
1968 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1970 @node Turning off beeping
1971 @section How do I stop Emacs from beeping on a terminal?
1972 @cindex Beeping, turning off
1973 @cindex Visible bell
1974 @cindex Bell, visible
1976 @email{martin@@cc.gatech.edu, Martin R. Frank} writes:
1978 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1979 and set the visible bell to nothing.
1981 That is, put the following in your @code{TERMCAP} environment variable
1982 (assuming you have one):
1984 @example
1985 ... :vb=: ...
1986 @end example
1988 And evaluate the following Lisp form:
1990 @example
1991 (setq visible-bell t)
1992 @end example
1994 @node Turning the volume down
1995 @section How do I turn down the bell volume in Emacs running under X?
1996 @cindex Bell, volume of
1997 @cindex Volume of bell
1999 On X Window system, you can adjust the bell volume and duration for all
2000 programs with the shell command @code{xset}.
2002 Invoking @code{xset} without any arguments produces some basic
2003 information, including the following:
2005 @example
2006 usage:  xset [-display host:dpy] option ...
2007   To turn bell off:
2008       -b                b off               b 0
2009   To set bell volume, pitch and duration:
2010        b [vol [pitch [dur]]]          b on
2011 @end example
2013 @node Automatic indentation
2014 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
2015 @cindex Indenting new lines
2016 @cindex New lines, indenting of
2017 @cindex Previous line, indenting according to
2018 @cindex Text indentation
2020 Such behavior is automatic (in Text mode) in Emacs 20 and later.  From the
2021 @file{etc/NEWS} file for Emacs 20.2:
2023 @example
2024 ** In Text mode, now only blank lines separate paragraphs.  This makes
2025 it possible to get the full benefit of Adaptive Fill mode in Text mode,
2026 and other modes derived from it (such as Mail mode).  @key{TAB} in Text
2027 mode now runs the command @code{indent-relative}; this makes a practical
2028 difference only when you use indented paragraphs.
2030 If you want spaces at the beginning of a line to start a paragraph, use
2031 the new mode, Paragraph Indent Text mode.
2032 @end example
2034 @cindex Prefixing lines
2035 @cindex Fill prefix
2036 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
2037 by default}), you can tell Emacs to prefix every line with a certain
2038 character sequence, the @dfn{fill prefix}.  Type the prefix at the
2039 beginning of a line, position point after it, and then type @kbd{C-x .}
2040 (@code{set-fill-prefix}) to set the fill prefix.  Thereafter,
2041 auto-filling will automatically put the fill prefix at the beginning of
2042 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
2043 prefix when refilling the paragraph.
2045 If you have paragraphs with different levels of indentation, you will
2046 have to set the fill prefix to the correct value each time you move to a
2047 new paragraph.  There are many packages available to deal with this
2048 (@pxref{Packages that do not come with Emacs}).  Look for ``fill'' and
2049 ``indent'' keywords for guidance.
2051 @node Matching parentheses
2052 @section How do I show which parenthesis matches the one I'm looking at?
2053 @cindex Parentheses, matching
2054 @cindex @file{paren.el}
2055 @cindex Highlighting matching parentheses
2056 @cindex Pairs of parentheses, highlighting
2057 @cindex Matching parentheses
2059 Call @code{show-paren-mode} in your @file{.emacs} file:
2061 @lisp
2062 (show-paren-mode 1)
2063 @end lisp
2065 You can also enable this mode by selecting the @samp{Paren Match
2066 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
2067 at the top of any Emacs frame.
2069 Alternatives to this mode include:
2071 @itemize @bullet
2073 @item
2074 If you're looking at a right parenthesis (or brace or bracket) you can
2075 delete it and reinsert it.  Emacs will momentarily move the cursor to
2076 the matching parenthesis.
2078 @item
2079 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2080 will skip over one set of balanced parentheses, so you can see which
2081 parentheses match.  (You can train it to skip over balanced brackets
2082 and braces at the same time by modifying the syntax table.)
2084 @cindex Show matching paren as in @code{vi}
2085 @item
2086 Here is some Emacs Lisp that will make the @key{%} key show the matching
2087 parenthesis, like in @code{vi}.  In addition, if the cursor isn't over a
2088 parenthesis, it simply inserts a % like normal.
2090 @lisp
2091 ;; By an unknown contributor
2093 (global-set-key "%" 'match-paren)
2095 (defun match-paren (arg)
2096   "Go to the matching paren if on a paren; otherwise insert %."
2097   (interactive "p")
2098   (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2099         ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2100         (t (self-insert-command (or arg 1)))))
2101 @end lisp
2103 @end itemize
2105 @node Hiding #ifdef lines
2106 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2107 @cindex @code{#ifdef}, selective display of
2108 @cindex @code{hide-ifdef-mode}
2109 @cindex Hiding @code{#ifdef} text
2110 @cindex Selectively displaying @code{#ifdef} code
2112 @kbd{M-x hide-ifdef-mode}.  (This is a minor mode.)  You might also want
2113 to investigate @file{cpp.el}, which is distributed with Emacs.
2115 @node Repeating commands
2116 @section How do I repeat a command as many times as possible?
2117 @cindex Repeating commands many times
2118 @cindex Commands, repeating many times
2119 @cindex @code{.}, equivalent to @code{vi} command
2121 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2122 that repeats the last command.  If you preface it with a prefix
2123 argument, the prefix arg is applied to the command.
2125 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2126 (@code{repeat-complex-command}) to reinvoke commands that used the
2127 minibuffer to get arguments.  In @code{repeat-complex-command} you can
2128 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2129 keyboard has these keys) to scan through all the different complex
2130 commands you've typed.
2132 To repeat a set of commands, use keyboard macros.  Use @kbd{C-x (} and
2133 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2134 type @kbd{C-x e}.  @xref{Keyboard Macros,,, emacs, The GNU Emacs Manual}.
2136 If you're really desperate for the @code{.} command in @code{vi} that
2137 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2138 mode which comes with Emacs, and which appears to support it.
2140 @node Valid X resources
2141 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2142 @cindex Resources, X
2143 @cindex X resources
2144 @cindex Setting X resources
2146 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2148 You can also use a resource editor, such as editres (for X11R5 and
2149 onwards), to look at the resource names for the menu bar, assuming Emacs
2150 was compiled with the X toolkit.
2152 @node Evaluating Emacs Lisp code
2153 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2154 @cindex Evaluating Lisp code
2155 @cindex Lisp forms, evaluating
2157 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2158 Emacs Lisp @dfn{form}:
2160 @itemize @bullet
2162 @item
2163 If you want it evaluated every time you run Emacs, put it in a file
2164 named @file{.emacs} in your home directory.  This is known as ``your
2165 @file{.emacs} file,'' and contains all of your personal customizations.
2167 @item
2168 You can type the form in the @file{*scratch*} buffer, and then type
2169 @key{LFD} (or @kbd{C-j}) after it.  The result of evaluating the form
2170 will be inserted in the buffer.
2172 @item
2173 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2174 before or around point.
2176 @item
2177 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2178 before point and prints its value in the echo area.
2180 @item
2181 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2182 form in the minibuffer which will be evaluated once you press @key{RET}.
2184 @item
2185 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2186 forms in a file.  (To do this from Lisp use the function @code{load}
2187 instead.)
2189 The functions @code{load-library}, @code{eval-region},
2190 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2191 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2192 about them.
2194 @end itemize
2196 @node Changing the length of a Tab
2197 @section How do I change Emacs's idea of the @key{TAB} character's length?
2198 @cindex Tab length
2199 @cindex Length of tab character
2201 Set the default value of the variable @code{tab-width}.  For example, to set
2202 @key{TAB} stops every 10 characters, insert the following in your
2203 @file{.emacs} file:
2205 @lisp
2206 (setq-default tab-width 10)
2207 @end lisp
2209 Do not confuse variable @code{tab-width} with variable
2210 @code{tab-stop-list}.  The former is used for the display of literal
2211 @key{TAB} characters.  The latter controls what characters are inserted
2212 when you press the @key{TAB} character in certain modes.
2214 @node Inserting text at the beginning of each line
2215 @section How do I insert <some text> at the beginning of every line?
2216 @cindex Prefixing a region with some text
2217 @cindex Prefix character, inserting in mail/news replies
2218 @cindex Replies to mail/news, inserting a prefix character
2219 @cindex @code{mail-yank-prefix}
2220 @cindex Mail replies, inserting a prefix character
2221 @cindex News replies, inserting a prefix character
2223 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2224 @key{RET} ^ @key{RET} your text @key{RET}}.
2226 To do this to a region, use @code{string-insert-rectangle}.
2227 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2228 want to prefix, move the cursor to last line to be prefixed, and type
2229 @kbd{M-x string-insert-rectangle @key{RET}}.  To do this for the whole
2230 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2232 If you are trying to prefix a yanked mail message with @samp{>}, you
2233 might want to set the variable @code{mail-yank-prefix}.  In Message
2234 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2235 runs the function @code{comment-region}, it is a general-purpose
2236 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2238 @node Forcing the cursor to remain in the same column
2239 @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?
2240 @cindex @code{picture-mode}
2241 @cindex Remaining in the same column, regardless of contents
2242 @cindex Vertical movement in empty documents
2244 Use @kbd{M-x picture-mode}.
2246 See also the variable @code{track-eol} and the command
2247 @code{set-goal-column} bound to @kbd{C-x C-n}
2248 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2250 @node Forcing Emacs to iconify itself
2251 @section How do I tell Emacs to iconify itself?
2252 @cindex Iconification under the X Window System
2253 @cindex X Window System and iconification
2254 @cindex Suspending Emacs
2256 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2257 otherwise.  @xref{Frame Commands,,, emacs, The GNU Emacs Manual}.
2259 @node Using regular expressions
2260 @section How do I use regexps (regular expressions) in Emacs?
2261 @cindex Regexps
2262 @cindex Regular expressions
2263 @cindex Differences between Unix and Emacs regexps
2264 @cindex Unix regexps, differences from Emacs
2265 @cindex Text strings, putting regexps in
2267 @xref{Regexp Backslash,,, emacs, The GNU Emacs Manual}.
2269 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2270 are @samp{\(} and @samp{\)}.  Also, the string syntax for a backslash is
2271 @samp{\\}.  To specify a regular expression like @samp{xxx\(foo\|bar\)}
2272 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2274 Note the doubled backslashes!
2276 @itemize @bullet
2278 @item
2279 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2280 (@samp{[^...]})  can match a newline character (@key{LFD} a.k.a.@:
2281 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2282 characters not to match.
2284 @item
2285 The character syntax regexps (e.g., @samp{\sw}) are not
2286 meaningful inside character set regexps (e.g., @samp{[aeiou]}).  (This
2287 is actually typical for regexp syntax.)
2289 @end itemize
2291 @node Replacing text across multiple files
2292 @section How do I perform a replace operation across more than one file?
2293 @cindex Replacing strings across files
2294 @cindex Multiple files, replacing across
2295 @cindex Files, replacing strings across multiple
2296 @cindex Recursive search/replace operations
2298 Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the
2299 command @code{dired-do-query-replace-regexp} (@kbd{Q}), which allows
2300 users to replace regular expressions in multiple files.
2302 You can use this command to perform search/replace operations on
2303 multiple files by following the following steps:
2305 @itemize @bullet
2306 @item
2307 Assemble a list of files you want to operate on with either
2308 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2310 @item
2311 Mark all files in the resulting Dired buffer using @kbd{t}.
2313 @item
2314 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2315 files.
2317 @item
2318 To accept all replacements in each file, hit @kbd{!}.
2319 @end itemize
2321 Another way to do the same thing is to use the ``tags'' feature of
2322 Emacs: it includes the command @code{tags-query-replace} which performs
2323 a query-replace across all the files mentioned in the @file{TAGS} file.
2324 @xref{Tags Search,,, emacs, The GNU Emacs Manual}.
2326 @node Documentation for etags
2327 @section Where is the documentation for @code{etags}?
2328 @cindex Documentation for @code{etags}
2329 @cindex @code{etags}, documentation for
2331 The @code{etags} man page should be in the same place as the
2332 @code{emacs} man page.
2334 Quick command-line switch descriptions are also available.  For example,
2335 @samp{etags -H}.
2337 @node Disabling backups
2338 @section How do I disable backup files?
2339 @cindex Backups, disabling
2340 @cindex Disabling backups
2342 You probably don't want to do this, since backups are useful, especially
2343 when something goes wrong.
2345 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2346 load @code{dired-x} by adding the following to your @file{.emacs} file:
2348 @lisp
2349 (add-hook 'dired-load-hook
2350           (lambda ()
2351            (require 'dired-x)))
2352 @end lisp
2354 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2355 You can make omitting the default for new dired buffers by putting the
2356 following in your @file{.emacs}:
2358 @lisp
2359 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2360 @end lisp
2362 If you're tired of seeing backup files whenever you do an @samp{ls} at
2363 the Unix shell, try GNU @code{ls} with the @samp{-B} option.  GNU
2364 @code{ls} is part of the GNU Fileutils package, available from
2365 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2367 To disable or change the way backups are made,
2368 @pxref{Backup Names,,, emacs, The GNU Emacs Manual}.
2370 @cindex Backup files in a single directory
2371 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2372 by customizing the variable @code{backup-directory-alist}.  This
2373 variable's value specifies that files whose names match specific patters
2374 should have their backups put in certain directories.  A typical use is
2375 to add the element @code{("." . @var{dir})} to force Emacs to put
2376 @strong{all} backup files in the directory @file{dir}.
2378 @node Disabling auto-save-mode
2379 @section How do I disable @code{auto-save-mode}?
2380 @cindex Disabling @code{auto-save-mode}
2381 @cindex Auto-saving
2382 @cindex Saving at frequent intervals
2384 You probably don't want to do this, since auto-saving is useful,
2385 especially when Emacs or your computer crashes while you are editing a
2386 document.
2388 Instead, you might want to change the variable
2389 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2390 waits before auto-saving.  Increasing this value forces Emacs to wait
2391 longer between auto-saves, which might annoy you less.
2393 You might also want to look into Sebastian Kremer's @code{auto-save}
2394 package (@pxref{Packages that do not come with Emacs}).  This
2395 package also allows you to place all auto-save files in one directory,
2396 such as @file{/tmp}.
2398 To disable or change how @code{auto-save-mode} works,
2399 @pxref{Auto Save,,, emacs, The GNU Emacs Manual}.
2401 @node Going to a line by number
2402 @section How can I go to a certain line given its number?
2403 @cindex Going to a line by number
2404 @cindex Compilation error messages
2405 @cindex Recompilation
2407 Are you sure you indeed need to go to a line by its number?  Perhaps all
2408 you want is to display a line in your source file for which a compiler
2409 printed an error message?  If so, compiling from within Emacs using the
2410 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2411 effective way of doing that.  Emacs automatically intercepts the compile
2412 error messages, inserts them into a special buffer called
2413 @code{*compilation*}, and lets you visit the locus of each message in
2414 the source.  Type @kbd{C-x `} to step through the offending lines one by
2415 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2416 @kbd{M-g M-n} to go to the previous and next matches directly).  Click
2417 @kbd{Mouse-2} or press @key{RET} on a message text in the
2418 @code{*compilation*} buffer to go to the line whose number is mentioned
2419 in that message.
2421 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2422 (which is the default binding of the @code{goto-line} function starting
2423 with Emacs 22).  Emacs will prompt you for the number of the line and go
2424 to that line.
2426 You can do this faster by invoking @code{goto-line} with a numeric
2427 argument that is the line's number.  For example, @kbd{C-u 286 M-g M-g}
2428 will jump to line number 286 in the current buffer.
2430 @node Modifying pull-down menus
2431 @section How can I create or modify new pull-down menu options?
2432 @cindex Pull-down menus, creating or modifying
2433 @cindex Menus, creating or modifying
2434 @cindex Creating new menu options
2435 @cindex Modifying pull-down menus
2436 @cindex Menus and keymaps
2437 @cindex Keymaps and menus
2439 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2440 represents a local or global keymap.  Selecting a menu title with the
2441 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2443 So to add a menu option to an existing menu, all you have to do is add a
2444 new definition to the appropriate keymap.  Adding a @samp{Forward Word}
2445 item to the @samp{Edit} menu thus requires the following Lisp code:
2447 @lisp
2448 (define-key global-map
2449   [menu-bar edit forward]
2450   '("Forward word" . forward-word))
2451 @end lisp
2453 @noindent
2454 The first line adds the entry to the global keymap, which includes
2455 global menu bar entries.  Replacing the reference to @code{global-map}
2456 with a local keymap would add this menu option only within a particular
2457 mode.
2459 The second line describes the path from the menu-bar to the new entry.
2460 Placing this menu entry underneath the @samp{File} menu would mean
2461 changing the word @code{edit} in the second line to @code{file}.
2463 The third line is a cons cell whose first element is the title that will
2464 be displayed, and whose second element is the function that will be
2465 called when that menu option is invoked.
2467 To add a new menu, rather than a new option to an existing menu, we must
2468 define an entirely new keymap:
2470 @lisp
2471 (define-key global-map [menu-bar words]
2472   (cons "Words" (make-sparse-keymap "Words")))
2473 @end lisp
2475 The above code creates a new sparse keymap, gives it the name
2476 @samp{Words}, and attaches it to the global menu bar.  Adding the
2477 @samp{Forward Word} item to this new menu would thus require the
2478 following code:
2480 @lisp
2481 (define-key global-map
2482   [menu-bar words forward]
2483   '("Forward word" . forward-word))
2484 @end lisp
2486 @noindent
2487 Note that because of the way keymaps work, menu options are displayed
2488 with the more recently defined items at the top.  Thus if you were to
2489 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2490 order), the menu option @samp{baz} would appear at the top, and
2491 @samp{foo} would be at the bottom.
2493 One way to avoid this problem is to use the function @code{define-key-after},
2494 which works the same as @code{define-key}, but lets you modify where items
2495 appear.  The following Lisp code would insert the @samp{Forward Word}
2496 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2498 @lisp
2499 (define-key-after
2500   (lookup-key global-map [menu-bar edit])
2501   [forward]
2502   '("Forward word" . forward-word)
2503   'undo)
2504 @end lisp
2506 Note how the second and third arguments to @code{define-key-after} are
2507 different from those of @code{define-key}, and that we have added a new
2508 (final) argument, the function after which our new key should be
2509 defined.
2511 To move a menu option from one position to another, simply evaluate
2512 @code{define-key-after} with the appropriate final argument.
2514 More detailed information---and more examples of how to create and
2515 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2516 ``Menu Keymaps.''  (@xref{Emacs Lisp documentation}, for information on
2517 this manual.)
2519 @node Deleting menus and menu options
2520 @section How do I delete menus and menu options?
2521 @cindex Deleting menus and menu options
2522 @cindex Menus, deleting
2524 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2525 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2526 menus}), use:
2528 @lisp
2529 (define-key global-map [menu-bar words] nil)
2530 @end lisp
2532 Similarly, removing a menu option requires redefining a keymap entry to
2533 @code{nil}.  For example, to delete the @samp{Forward word} menu option
2534 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2535 menus}), use:
2537 @lisp
2538 (define-key global-map [menu-bar edit forward] nil)
2539 @end lisp
2541 @node Turning on syntax highlighting
2542 @section How do I turn on syntax highlighting?
2543 @cindex Syntax highlighting
2544 @cindex @code{font-lock-mode}
2545 @cindex Highlighting based on syntax
2546 @cindex Colorizing text
2547 @cindex FAQ, @code{font-lock-mode}
2549 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2550 highlighting in the current buffer.  It is enabled by default in Emacs
2551 22.1 and later.
2553 With @code{font-lock-mode} turned on, different types of text will
2554 appear in different colors.  For instance, in a programming mode,
2555 variables will appear in one face, keywords in a second, and comments in
2556 a third.
2558 To turn @code{font-lock-mode} off within an existing buffer, use
2559 @kbd{M-x font-lock-mode @key{RET}}.
2561 In Emacs 21 and earlier versions, you could use the following code in
2562 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2564 @lisp
2565 (global-font-lock-mode 1)
2566 @end lisp
2568 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2569 and cause an annoying delay in display, so several features exist to
2570 work around this.
2572 @cindex Just-In-Time syntax highlighting
2573 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2574 activates the new @dfn{Just-In-Time fontification} provided by
2575 @code{jit-lock-mode}.  @code{jit-lock-mode} defers the fontification of
2576 portions of buffer until you actually need to see them, and can also
2577 fontify while Emacs is idle.  This makes display of the visible portion
2578 of a buffer almost instantaneous.  For details about customizing
2579 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2581 @cindex Levels of syntax highlighting
2582 @cindex Decoration level, in @code{font-lock-mode}
2583 In versions of Emacs before 21, different levels of decoration are
2584 available, from slight to gaudy.  More decoration means you need to wait
2585 more time for a buffer to be fontified (or a faster machine).  To
2586 control how decorated your buffers should become, set the value of
2587 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2588 @code{nil} value indicating default (usually minimum) decoration, and a
2589 @code{t} value indicating the maximum decoration.  For the gaudiest
2590 possible look, then, include the line
2592 @lisp
2593 (setq font-lock-maximum-decoration t)
2594 @end lisp
2596 @noindent
2597 in your @file{.emacs} file.  You can also set this variable such that
2598 different modes are highlighted in a different ways; for more
2599 information, see the documentation for
2600 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2601 describe-variable @key{RET}}).
2603 Also see the documentation for the function @code{font-lock-mode},
2604 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2605 describe-function @key{RET} font-lock-mode @key{RET}}).
2607 To print buffers with the faces (i.e., colors and fonts) intact, use
2608 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2609 ps-print-region-with-faces}.  You will need a way to send text to a
2610 PostScript printer, or a PostScript interpreter such as Ghostscript;
2611 consult the documentation of the variables @code{ps-printer-name},
2612 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2614 @node Scrolling only one line
2615 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2616 @cindex Scrolling only one line
2617 @cindex Reducing the increment when scrolling
2619 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2620 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2621 to a large value like, say, 10000.  For an explanation of what this
2622 means, @pxref{Auto Scrolling,,, emacs, The GNU Emacs Manual}.
2624 Alternatively, use the following Lisp form in your @file{.emacs}:
2626 @lisp
2627 (setq scroll-conservatively most-positive-fixnum)
2628 @end lisp
2630 @node Editing MS-DOS files
2631 @section How can I edit MS-DOS files using Emacs?
2632 @cindex Editing MS-DOS files
2633 @cindex MS-DOS files, editing
2634 @cindex Microsoft files, editing
2635 @cindex Windows files, editing
2637 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2638 performed transparently.  You can open MS-DOS files on a Unix system,
2639 edit it, and save it without having to worry about the file format.
2641 When editing an MS-DOS style file, the mode line will indicate that it
2642 is a DOS file.  On Unix and GNU/Linux systems, and also on a Macintosh,
2643 the string @samp{(DOS)} will appear near the left edge of the mode line;
2644 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2645 default, a backslash (@samp{\}) will appear in the mode line.
2647 @node Filling paragraphs with a single space
2648 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2649 @cindex One space following periods
2650 @cindex Single space following periods
2651 @cindex Periods, one space following
2653 Add the following line to your @file{.emacs} file:
2655 @lisp
2656 (setq sentence-end-double-space nil)
2657 @end lisp
2659 @node Escape sequences in shell output
2660 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2661 @cindex Escape sequences in @code{ls} output
2662 @cindex @code{ls} in Shell mode
2664 In many systems, @code{ls} is aliased to @samp{ls --color}, which
2665 prints using ANSI color escape sequences.  Emacs version 21.1 and
2666 later includes the @code{ansi-color} package, which lets Shell mode
2667 recognize these escape sequences.  In Emacs 23.2 and later, the
2668 package is enabled by default; in earlier versions you can enable it
2669 by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2670 by adding @code{(add-hook 'shell-mode-hook
2671 'ansi-color-for-comint-mode-on)} to your init file.
2673 In Emacs versions before 21.1, the @code{ansi-color} package is not
2674 included.  In that case, you need to unalias @code{ls} for interactive
2675 shells running in Emacs; this can be done by checking the @code{EMACS}
2676 variable in the environment.
2678 @node Fullscreen mode on MS-Windows
2679 @section How can I start Emacs in fullscreen mode on MS-Windows?
2680 @cindex Maximize frame
2681 @cindex Fullscreen mode
2683 Use the function @code{w32-send-sys-command}.  For example, you can
2684 put the following in your @file{.emacs} file:
2686 @lisp
2687 (add-hook 'term-setup-hook
2688           #'(lambda () (w32-send-sys-command ?\xF030)))
2689 @end lisp
2691 To avoid the slightly distracting visual effect of Emacs starting with
2692 its default frame size and then growing to fullscreen, you can add an
2693 @samp{Emacs.Geometry} entry to the Windows registry settings.
2694 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2696 To compute the correct values for width and height, first maximize the
2697 Emacs frame and then evaluate @code{(frame-height)} and
2698 @code{(frame-width)} with @kbd{M-:}.
2700 @c ------------------------------------------------------------
2701 @node Bugs and problems
2702 @chapter Bugs and problems
2703 @cindex Bugs and problems
2705 The Emacs manual lists some common kinds of trouble users could get
2706 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2707 Emacs Manual}, so you might look there if the problem you encounter
2708 isn't described in this chapter.  If you decide you've discovered a bug,
2709 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2710 instructions how to do that.
2712 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2713 known problems with building and using Emacs on specific platforms;
2714 type @kbd{C-h C-p} to read it.
2716 @menu
2717 * Problems with very large files::
2718 * ^M in the shell buffer::
2719 * Problems with Shell Mode::
2720 * Termcap/Terminfo entries for Emacs::
2721 * Errors with init files::
2722 * Emacs ignores X resources::
2723 * Emacs ignores frame parameters::
2724 * Editing files with $ in the name::
2725 * Shell mode loses the current directory::
2726 * Security risks with Emacs::
2727 * Dired claims that no file is on this line::
2728 @end menu
2730 @node Problems with very large files
2731 @section Does Emacs have problems with files larger than 8 megabytes?
2732 @cindex Very large files, opening
2733 @cindex Large files, opening
2734 @cindex Opening very large files
2735 @cindex Maximum file size
2736 @cindex Files, maximum size
2738 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2739 files larger than 8 megabytes.  In versions 19.29 and later, the maximum
2740 buffer size is at least 2^27@minus{}1, or 134,217,727 bytes, or 132 MBytes.
2741 The maximum buffer size on 32-bit machines increased to 256 MBytes in
2742 Emacs 22, and again to 512 MBytes in Emacs 23.2.
2744 Emacs compiled on a 64-bit machine can handle much larger buffers.
2746 @node ^M in the shell buffer
2747 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2748 @cindex Shell buffer, echoed commands and @samp{^M} in
2749 @cindex Echoed commands in @code{shell-mode}
2751 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2752 make them go away.  If that doesn't work, you have several options:
2754 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2755 file:
2757 @example
2758 if ($?EMACS) then
2759     if ("$EMACS" =~ /*) then
2760         if ($?tcsh) unset edit
2761         stty nl
2762     endif
2763 endif
2764 @end example
2766 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2768 @example
2769 unset edit
2770 stty nl
2771 @end example
2773 Alternatively, use @code{csh} in your shell buffers instead of
2774 @code{tcsh}.  One way is:
2776 @lisp
2777 (setq explicit-shell-file-name "/bin/csh")
2778 @end lisp
2780 @noindent
2781 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2782 file:
2784 @example
2785 setenv ESHELL /bin/csh
2786 @end example
2788 @noindent
2789 (You must start Emacs over again with the environment variable properly
2790 set for this to take effect.)
2792 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2793 with the following Lisp form,
2795 @lisp
2796 (setenv "ESHELL" "/bin/csh")
2797 @end lisp
2799 The above solutions try to prevent the shell from producing the
2800 @samp{^M} characters in the first place.  If this is not possible
2801 (e.g., if you use a Windows shell), you can get Emacs to remove these
2802 characters from the buffer by adding this to your @file{.emacs} init
2803 file:
2805 @smalllisp
2806 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2807 @end smalllisp
2809 On a related note: if your shell is echoing your input line in the shell
2810 buffer, you might want to customize the @code{comint-process-echoes}
2811 variable in your shell buffers, or try the following command in your
2812 shell start-up file:
2814 @example
2815 stty -icrnl -onlcr -echo susp ^Z
2816 @end example
2818 @node Problems with Shell Mode
2819 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2821 @cindex Shell Mode, problems
2822 @cindex @code{explicit-shell-file-name}
2823 This might happen because Emacs tries to look for the shell in a wrong
2824 place.  If you know where your shell executable is, set the variable
2825 @code{explicit-shell-file-name} in your @file{.emacs} file to point to
2826 its full file name.
2828 @cindex Antivirus programs, and Shell Mode
2829 Some people have trouble with Shell Mode on MS-Windows because of
2830 intrusive antivirus software; disabling the resident antivirus program
2831 solves the problems in those cases.
2833 @node Termcap/Terminfo entries for Emacs
2834 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2835 @cindex Termcap
2836 @cindex Terminfo
2837 @cindex Emacs entries for termcap/terminfo
2839 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2840 the @samp{TERMCAP} environment variable of subshells.  It may help in
2841 certain situations (e.g., using rlogin from shell buffer) to add an
2842 entry for @samp{emacs} to the system-wide termcap file.  Here is a
2843 correct termcap entry for @samp{emacs}:
2845 @example
2846 emacs:tc=unknown:
2847 @end example
2849 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2850 @code{captoinfo}.  You need to generate
2851 @file{/usr/lib/terminfo/e/emacs}.  It may work to simply copy
2852 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2854 Having a termcap/terminfo entry will not enable the use of full screen
2855 programs in shell buffers.  Use @kbd{M-x terminal-emulator} for that
2856 instead.
2858 A workaround to the problem of missing termcap/terminfo entries is to
2859 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2860 in your shell start up file.  @code{csh} users could put this in their
2861 @file{.cshrc} files:
2863 @example
2864 if ("$term" == emacs) set term=dumb
2865 @end example
2867 @node Errors with init files
2868 @section Why does Emacs say @samp{Error in init file}?
2869 @cindex Error in @file{.emacs}
2870 @cindex Error in init file
2871 @cindex Init file, errors in
2872 @cindex @file{.emacs} file, errors in
2873 @cindex Debugging @file{.emacs} file
2875 An error occurred while loading either your @file{.emacs} file or the
2876 system-wide file @file{site-lisp/default.el}.  Emacs 21.1 and later pops the
2877 @file{*Messages*} buffer, and puts there some additional information
2878 about the error, to provide some hints for debugging.
2880 For information on how to debug your @file{.emacs} file, see
2881 @ref{Debugging a customization file}.
2883 It may be the case that you need to load some package first, or use a
2884 hook that will be evaluated after the package is loaded.  A common case
2885 of this is explained in @ref{Terminal setup code works after Emacs has
2886 begun}.
2888 @node Emacs ignores X resources
2889 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
2890 @cindex X resources being ignored
2891 @cindex Ignored X resources
2892 @cindex @file{.Xdefaults}
2894 As of version 19, Emacs searches for X resources in the files specified
2895 by the following environment variables:
2897 @itemize @bullet
2899 @item @code{XFILESEARCHPATH}
2900 @item @code{XUSERFILESEARCHPATH}
2901 @item @code{XAPPLRESDIR}
2903 @end itemize
2905 This emulates the functionality provided by programs written using the
2906 Xt toolkit.
2908 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
2909 of file names separated by colons.  @code{XAPPLRESDIR} should be a list
2910 of directory names separated by colons.
2912 Emacs searches for X resources:
2914 @enumerate
2916 @item
2917 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
2919 @item
2920 then in the value of the @samp{XENVIRONMENT} environment variable,
2922 @itemize @minus
2924 @item
2925 or if that is unset, in the file named
2926 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
2927 the name of the machine Emacs is running on),
2929 @end itemize
2931 @item
2932 then in the screen-specific and server-wide resource properties provided
2933 by the server,
2935 @itemize @minus
2937 @item
2938 or if those properties are unset, in the file named @file{~/.Xdefaults}
2939 if it exists,
2941 @end itemize
2943 @item
2944 then in the files listed in @samp{XUSERFILESEARCHPATH},
2946 @itemize @minus
2948 @item
2949 or in files named @file{@var{lang}/Emacs} in directories listed in
2950 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
2951 environment variable), if the @samp{LANG} environment variable is set,
2952 @item
2953 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
2954 @item
2955 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
2956 is set),
2957 @item
2958 or in @file{~/Emacs},
2960 @end itemize
2962 @item
2963 then in the files listed in  @code{XFILESEARCHPATH}.
2965 @end enumerate
2967 @node Emacs ignores frame parameters
2968 @section Why don't my customizations of the frame parameters work?
2969 @cindex Frame parameters
2971 This probably happens because you have set the frame parameters in the
2972 variable @code{initial-frame-alist}.  That variable holds parameters
2973 used only for the first frame created when Emacs starts.  To customize
2974 the parameters of all frames, change the variable
2975 @code{default-frame-alist} instead.
2977 These two variables exist because many users customize the initial frame
2978 in a special way.  For example, you could determine the position and
2979 size of the initial frame, but would like to control the geometry of the
2980 other frames by individually positioning each one of them.
2983 @node Editing files with $ in the name
2984 @section How do I edit a file with a @samp{$} in its name?
2985 @cindex Editing files with @samp{$} in the name
2986 @cindex @samp{$} in file names
2987 @cindex File names containing @samp{$}, editing
2989 When entering a file name in the minibuffer, Emacs will attempt to expand
2990 a @samp{$} followed by a word as an environment variable.  To suppress
2991 this behavior, type @kbd{$$} instead.
2993 @node Shell mode loses the current directory
2994 @section Why does shell mode lose track of the shell's current directory?
2995 @cindex Current directory and @code{shell-mode}
2996 @cindex @code{shell-mode} and current directory
2997 @cindex Directory, current in @code{shell-mode}
2999 Emacs has no way of knowing when the shell actually changes its
3000 directory.  This is an intrinsic limitation of Unix.  So it tries to
3001 guess by recognizing @samp{cd} commands.  If you type @kbd{cd} followed
3002 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
3003 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
3004 correctly guess the shell's new current directory.  A huge variety of
3005 fixes and enhancements to shell mode for this problem have been written
3006 to handle this problem (@pxref{Finding a package with particular
3007 functionality}).
3009 You can tell Emacs the shell's current directory with the command
3010 @kbd{M-x dirs}.
3012 @node Security risks with Emacs
3013 @section Are there any security risks in Emacs?
3014 @cindex Security with Emacs
3015 @cindex @samp{movemail} and security
3016 @cindex @code{file-local-variable} and security
3017 @cindex Synthetic X events and security
3018 @cindex X events and security
3020 @itemize @bullet
3022 @item
3023 The @file{movemail} incident.  (No, this is not a risk.)
3025 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3026 chapter 4.  The site at LBL had installed the @file{/etc/movemail}
3027 program setuid root.  (As of version 19, @file{movemail} is in your
3028 architecture-specific directory; type @kbd{C-h v exec-directory
3029 @key{RET}} to see what it is.)  Since @code{movemail} had not been
3030 designed for this situation, a security hole was created and users could
3031 get root privileges.
3033 @code{movemail} has since been changed so that this security hole will
3034 not exist, even if it is installed setuid root.  However,
3035 @code{movemail} no longer needs to be installed setuid root, which
3036 should eliminate this particular risk.
3038 We have heard unverified reports that the 1988 Internet worm took
3039 advantage of this configuration problem.
3041 @item
3042 The @code{file-local-variable} feature.  (Yes, a risk, but easy to
3043 change.)
3045 There is an Emacs feature that allows the setting of local values for
3046 variables when editing a file by including specially formatted text near
3047 the end of the file.  This feature also includes the ability to have
3048 arbitrary Emacs Lisp code evaluated when the file is visited.
3049 Obviously, there is a potential for Trojan horses to exploit this
3050 feature.
3052 As of Emacs 22, Emacs has a list of local variables that are known to
3053 be safe to set.  If a file tries to set any variable outside this
3054 list, it asks the user to confirm whether the variables should be set.
3055 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
3056 code found at the bottom of files by setting the variable
3057 @code{enable-local-eval}.
3059 @xref{File Variables,,, emacs, The GNU Emacs Manual}.
3061 @item
3062 Synthetic X events.  (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3063 better.)
3065 Emacs accepts synthetic X events generated by the @code{SendEvent}
3066 request as though they were regular events.  As a result, if you are
3067 using the trivial host-based authentication, other users who can open X
3068 connections to your X workstation can make your Emacs process do
3069 anything, including run other processes with your privileges.
3071 The only fix for this is to prevent other users from being able to open
3072 X connections.  The standard way to prevent this is to use a real
3073 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}.  If using
3074 the @code{xauth} program has any effect, then you are probably using
3075 @samp{MIT-MAGIC-COOKIE-1}.  Your site may be using a superior
3076 authentication method; ask your system administrator.
3078 If real authentication is not a possibility, you may be satisfied by
3079 just allowing hosts access for brief intervals while you start your X
3080 programs, then removing the access.  This reduces the risk somewhat by
3081 narrowing the time window when hostile users would have access, but
3082 @emph{does not eliminate the risk}.
3084 On most computers running Unix and X, you enable and disable
3085 access using the @code{xhost} command.  To allow all hosts access to
3086 your X server, use
3088 @example
3089 xhost +
3090 @end example
3092 @noindent
3093 at the shell prompt, which (on an HP machine, at least) produces the
3094 following message:
3096 @example
3097 access control disabled, clients can connect from any host
3098 @end example
3100 To deny all hosts access to your X server (except those explicitly
3101 allowed by name), use
3103 @example
3104 xhost -
3105 @end example
3107 On the test HP computer, this command generated the following message:
3109 @example
3110 access control enabled, only authorized clients can connect
3111 @end example
3113 @end itemize
3115 @node Dired claims that no file is on this line
3116 @section Dired says, @samp{no file on this line} when I try to do something.
3117 @cindex Dired does not see a file
3119 Dired uses a regular expression to find the beginning of a file name.
3120 In a long Unix-style directory listing (@samp{ls -l}), the file name
3121 starts after the date.  The regexp has thus been written to look for the
3122 date.  By default, it should understand dates and times regardless of
3123 the language, but if your directory listing has an unusual format, Dired
3124 may get confused.
3126 There are two approaches to solving this.  The first one involves
3127 setting things up so that @samp{ls -l} outputs a more standard format.
3128 See your OS manual for more information.
3130 The second approach involves changing the regular expression used by
3131 dired, @code{directory-listing-before-filename-regexp}.
3133 @c ------------------------------------------------------------
3134 @node Compiling and installing Emacs
3135 @chapter    Compiling and installing Emacs
3136 @cindex    Compiling and installing Emacs
3138 @menu
3139 * Installing Emacs::
3140 * Problems building Emacs::
3141 @end menu
3143 @node Installing Emacs
3144 @section How do I install Emacs?
3145 @cindex Installing Emacs
3146 @cindex Unix systems, installing Emacs on
3147 @cindex Downloading and installing Emacs
3148 @cindex Building Emacs from source
3149 @cindex Source code, building Emacs from
3151 This answer is meant for users of Unix and Unix-like systems.  Users of
3152 other operating systems should see the series of questions beginning
3153 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3154 and binaries, and how to install Emacs on those systems.
3156 Most GNU/Linux distributions provide pre-built Emacs packages.
3157 If Emacs is not installed already, you can install it by running (as
3158 root) a command such as @samp{yum install emacs} (Red Hat and
3159 derivatives) or @samp{apt-get install emacs} (Debian and derivatives).
3161 If you want to compile Emacs yourself, read the file @file{INSTALL} in
3162 the source distribution.  In brief:
3164 @itemize @bullet
3166 @item
3167 First download the Emacs sources.  @xref{Current GNU distributions}, for
3168 a list of ftp sites that make them available.  On @file{ftp.gnu.org},
3169 the main GNU distribution site, sources are available as
3171 @c Don't include VER in the file name, because pretests are not there.
3172 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
3174 (Replace @samp{VERSION} with the relevant version number, e.g., @samp{23.1}.)
3176 @item
3177 Next uncompress and extract the source files.  This requires
3178 the @code{gzip} and @code{tar} programs, which are standard utilities.
3179 If your system does not have them, these can also be downloaded from
3180 @file{ftp.gnu.org}.
3182 GNU @code{tar} can uncompress and extract in a single-step:
3184 @example
3185 tar -zxvf emacs-VERSION.tar.gz
3186 @end example
3188 @item
3189 At this point, the Emacs sources should be sitting in a directory called
3190 @file{emacs-VERSION}.  On most common Unix and Unix-like systems,
3191 you should be able to compile Emacs with the following commands:
3193 @example
3194 cd emacs-VERSION
3195 ./configure         # configure Emacs for your particular system
3196 make                # use Makefile to build components, then Emacs
3197 @end example
3199 If the @code{make} completes successfully, the odds are fairly good that
3200 the build has gone well.  (@xref{Problems building Emacs}, if you weren't
3201 successful.)
3203 @item
3204 By default, Emacs is installed in @file{/usr/local}.  To actually
3205 install files, become the superuser and type
3207 @example
3208 make install
3209 @end example
3211 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3212 and any Emacs Info files that might be in @file{/usr/local/share/info/}.
3214 @end itemize
3216 @node Problems building Emacs
3217 @section What should I do if I have trouble building Emacs?
3218 @cindex Problems building Emacs
3219 @cindex Errors when building Emacs
3221 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3222 source) to see if there is already a solution for your problem.  Next,
3223 look for other questions in this FAQ that have to do with Emacs
3224 installation and compilation problems.
3226 If you'd like to have someone look at your problem and help solve it,
3227 see @ref{Help installing Emacs}.
3229 If you cannot find a solution in the documentation, please report the
3230 problem (@pxref{Reporting bugs}).
3233 @c ------------------------------------------------------------
3234 @node Finding Emacs and related packages
3235 @chapter Finding Emacs and related packages
3236 @cindex Finding Emacs and related packages
3238 @menu
3239 * Finding Emacs on the Internet::
3240 * Finding a package with particular functionality::
3241 * Packages that do not come with Emacs::
3242 * Spell-checkers::
3243 * Current GNU distributions::
3244 * Difference between Emacs and XEmacs::
3245 * Emacs for minimalists::
3246 * Emacs for MS-DOS::
3247 * Emacs for MS-Windows::
3248 * Emacs for GNUstep::
3249 * Emacs for Mac OS X::
3250 @end menu
3252 @node Finding Emacs on the Internet
3253 @section Where can I get Emacs on the net?
3254 @cindex Finding Emacs on the Internet
3255 @cindex Downloading Emacs
3257 Information on downloading Emacs is available at
3258 @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}.
3260 @xref{Installing Emacs}, for information on how to obtain and build the latest
3261 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3262 archive sites that make GNU software available.
3264 @node Finding a package with particular functionality
3265 @section How do I find a Emacs Lisp package that does XXX?
3266 @cindex Package, finding
3267 @cindex Finding an Emacs Lisp package
3268 @cindex Functionality, finding a particular package
3270 First of all, you should check to make sure that the package isn't
3271 already available.  For example, typing @kbd{M-x apropos @key{RET}
3272 wordstar @key{RET}} lists all functions and variables containing the
3273 string @samp{wordstar}.
3275 It is also possible that the package is on your system, but has not been
3276 loaded.  To see which packages are available for loading, look through
3277 your computer's lisp directory (@pxref{File-name conventions}).  The Lisp
3278 source to most packages contains a short description of how they
3279 should be loaded, invoked, and configured---so before you use or
3280 modify a Lisp package, see if the author has provided any hints in the
3281 source code.
3283 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3284 the constituent Emacs packages.
3286 For advice on how to find extra packages that are not part of Emacs,
3287 see @ref{Packages that do not come with Emacs}.
3289 @node Packages that do not come with Emacs
3290 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3291 @cindex Unbundled packages
3292 @cindex Finding other packages
3293 @cindex Lisp packages that do not come with Emacs
3294 @cindex Packages, those that do not come with Emacs
3295 @cindex Emacs Lisp List
3296 @cindex Emacs Lisp Archive
3298 Your first port of call should be the @kbd{M-x list-packages} command.
3299 This connects to the @uref{http:///elpa.gnu.org, GNU ELPA} (``Emacs
3300 Lisp Package Archive'') server and fetches the list of additional
3301 packages that it offers.  These are GNU packages that are available
3302 for use with Emacs, but are distributed separately.  Select a package
3303 to get more details about the features that it offers, and then if you
3304 wish, Emacs can download and automatically install it for you.
3306 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs Lisp
3307 List (ELL)}, maintained by @email{S.J.Eglen@@damtp.cam.ac.uk, Stephen Eglen},
3308 aims to provide one compact list with links to all of the current Emacs
3309 Lisp files on the Internet.  The ELL can be browsed over the web, or
3310 from Emacs with @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.el,
3311 the @file{ell} package}.
3313 Many authors post their packages to the @uref{news:gnu.emacs.sources,
3314 Emacs sources newsgroup}.  You can search the archives of this
3315 group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google},
3316 or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example.
3318 Several packages are stored in
3319 @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}.
3321 Read the file @file{etc/MORE.STUFF} for more information about
3322 external packages.
3324 @node Spell-checkers
3325 @section Spell-checkers
3326 @cindex Spell-checker
3327 @cindex Checking spelling
3328 @cindex Ispell
3329 @cindex Aspell
3330 @cindex Hunspell
3332 Various spell-checkers are compatible with Emacs, including:
3334 @table @b
3336 @item GNU Aspell
3337 @uref{http://aspell.net/}
3339 @item Ispell
3340 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3342 @item Hunspell
3343 @uref{http://hunspell.sourceforge.net/}
3345 @end table
3347 @node Current GNU distributions
3348 @section Where can I get other up-to-date GNU stuff?
3349 @cindex Current GNU distributions
3350 @cindex Sources for current GNU distributions
3351 @cindex Stuff, current GNU
3352 @cindex Up-to-date GNU stuff
3353 @cindex Finding current GNU software
3354 @cindex Official GNU software sites
3356 The most up-to-date official GNU software is normally kept at
3358 @uref{ftp://ftp.gnu.org/pub/gnu}
3360 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3362 @uref{http://www.gnu.org/order/ftp.html}
3364 @node Difference between Emacs and XEmacs
3365 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3366 @cindex XEmacs
3367 @cindex Difference Emacs and XEmacs
3368 @cindex Lucid Emacs
3369 @cindex Epoch
3371 XEmacs is a branch version of Emacs.  It was first called Lucid Emacs,
3372 and was initially derived from a prerelease version of Emacs 19.  In
3373 this FAQ, we use the name ``Emacs'' only for the official version.
3375 Emacs and XEmacs each come with Lisp packages that are lacking in the
3376 other.  The two versions have some significant differences at the Lisp
3377 programming level.  Their current features are roughly comparable,
3378 though the support for some operating systems, character sets and
3379 specific packages might be quite different.
3381 Some XEmacs code has been contributed to Emacs, and we would like to
3382 use other parts, but the earlier XEmacs maintainers did not always
3383 keep track of the authors of contributed code, which makes it
3384 impossible for the FSF to get copyright papers signed for that code.
3385 (The FSF requires these papers for all the code included in the Emacs
3386 release, aside from generic C support packages that retain their
3387 separate identity and are not integrated into the code of Emacs
3388 proper.)
3390 If you want to talk about these two versions and distinguish them,
3391 please call them ``Emacs'' and ``XEmacs.''  To contrast ``XEmacs''
3392 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3393 origin in the work of the GNU Project.  Terms such as ``Emacsen'' and
3394 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3395 is better to write ``Emacs and XEmacs.''
3397 @node Emacs for minimalists
3398 @section I don't have enough disk space to install Emacs
3399 @cindex Zile
3400 @cindex Not enough disk space to install Emacs
3402 GNU Zile is a lightweight Emacs clone.  Zile is short for @samp{Zile Is
3403 Lossy Emacs}.  It has all of Emacs's basic editing features.  The Zile
3404 binary typically has a size of about 130 kbytes, so this can be useful
3405 if you are in an extremely space-restricted environment.  More
3406 information is available from
3408 @uref{http://www.gnu.org/software/zile/}
3411 @node Emacs for MS-DOS
3412 @section Where can I get Emacs for MS-DOS?
3413 @cindex MS-DOS, Emacs for
3414 @cindex DOS, Emacs for
3415 @cindex Compiling Emacs for DOS
3416 @cindex Emacs for MS-DOS
3418 To build Emacs from source for MS-DOS, see the instructions in the file
3419 @file{msdos/INSTALL} in the distribution.  The DOS port builds and runs
3420 on plain DOS, and also on all versions of MS-Windows from version 3.X
3421 onwards, including Windows XP and Vista.
3423 The file @file{etc/PROBLEMS} contains some additional information
3424 regarding Emacs under MS-DOS.
3426 A pre-built binary distribution of the old Emacs 20 is available, as
3427 described at
3429 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3431 For a list of other MS-DOS implementations of Emacs (and Emacs
3432 look-alikes), consult the list of ``Emacs implementations and literature,''
3433 available at
3435 @uref{http://www.finseth.com/emacs.html}
3437 Note that while many of these programs look similar to Emacs, they often
3438 lack certain features, such as the Emacs Lisp extension language.
3440 @node Emacs for MS-Windows
3441 @section Where can I get Emacs for Microsoft Windows?
3442 @cindex FAQ for Emacs on MS-Windows
3443 @cindex Emacs for MS-Windows
3444 @cindex Microsoft Windows, Emacs for
3446 There is a @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html,
3447 separate FAQ} for Emacs on MS-Windows.  For MS-DOS, @pxref{Emacs for MS-DOS}.
3450 @node Emacs for GNUstep
3451 @section Where can I get Emacs for GNUstep?
3452 @cindex GNUstep, Emacs for
3454 Beginning with version 23.1, Emacs supports GNUstep natively.
3455 See the file @file{nextstep/INSTALL} in the distribution.
3457 @node Emacs for Mac OS X
3458 @section Where can I get Emacs for Mac OS X?
3459 @cindex Apple computers, Emacs for
3460 @cindex Macintosh, Emacs for
3461 @cindex Mac OS X, Emacs for
3463 Beginning with version 22.1, Emacs supports Mac OS X natively.
3464 See the file @file{nextstep/INSTALL} in the distribution.
3466 @c ------------------------------------------------------------
3467 @node Key bindings
3468 @chapter Key bindings
3469 @cindex Key bindings
3471 @menu
3472 * Binding keys to commands::
3473 * Invalid prefix characters::
3474 * Terminal setup code works after Emacs has begun::
3475 * Working with function and arrow keys::
3476 * X key translations for Emacs::
3477 * Backspace invokes help::
3478 * Swapping keys::
3479 * Producing C-XXX with the keyboard::
3480 * No Meta key::
3481 * No Escape key::
3482 * Compose Character::
3483 * Binding combinations of modifiers and function keys::
3484 * Meta key does not work in xterm::
3485 * ExtendChar key does not work as Meta::
3486 * SPC no longer completes file names::
3487 @end menu
3489 @node Binding keys to commands
3490 @section How do I bind keys (including function keys) to commands?
3491 @cindex Binding keys to commands
3492 @cindex Keys, binding to commands
3493 @cindex Commands, binding keys to
3495 Keys can be bound to commands either interactively or in your
3496 @file{.emacs} file.  To interactively bind keys for all modes, type
3497 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3499 To bind a key just in the current major mode, type @kbd{M-x
3500 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3502 @xref{Key Bindings,,, emacs, The GNU Emacs Manual}.
3504 To make the process of binding keys interactively easier, use the
3505 following ``trick'': First bind the key interactively, then immediately
3506 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}.  Now, the command needed
3507 to bind the key is in the kill ring, and can be yanked into your
3508 @file{.emacs} file.  If the key binding is global, no changes to the
3509 command are required.  For example,
3511 @lisp
3512 (global-set-key (quote [f1]) (quote help-for-help))
3513 @end lisp
3515 @noindent
3516 can be placed directly into the @file{.emacs} file.  If the key binding is
3517 local, the command is used in conjunction with the @samp{add-hook} function.
3518 For example, in TeX mode, a local binding might be
3520 @lisp
3521 (add-hook 'tex-mode-hook
3522   (lambda ()
3523    (local-set-key (quote [f1]) (quote help-for-help))))
3524 @end lisp
3527 @itemize @bullet
3529 @item
3530 Control characters in key sequences, in the form yanked from the kill
3531 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3532 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc.  You may want
3533 to convert these into their vector or string forms.
3535 @item
3536 If a prefix key of the character sequence to be bound is already
3537 bound as a complete key, then you must unbind it before the new
3538 binding.  For example, if @kbd{ESC @{} is previously bound:
3540 @lisp
3541 (global-unset-key [?\e ?@{])   ;;   or
3542 (local-unset-key [?\e ?@{])
3543 @end lisp
3545 @item
3546 Aside from commands and ``lambda lists,'' a vector or string also
3547 can be bound to a key and thus treated as a macro.  For example:
3549 @lisp
3550 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g])  ;;  or
3551 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3552 @end lisp
3554 @end itemize
3556 @node Invalid prefix characters
3557 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3558 @cindex Prefix characters, invalid
3559 @cindex Invalid prefix characters
3560 @cindex Misspecified key sequences
3562 Usually, one of two things has happened.  In one case, the control
3563 character in the key sequence has been misspecified (e.g., @samp{C-f}
3564 used instead of @samp{\C-f} within a Lisp expression).  In the other
3565 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3566 was already bound as a @dfn{complete key}.  Historically, the @samp{ESC [}
3567 prefix was usually the problem, in which case you should evaluate either
3568 of these forms before attempting to bind the key sequence:
3570 @lisp
3571 (global-unset-key [?\e ?[])  ;;  or
3572 (global-unset-key "\e[")
3573 @end lisp
3575 @node Terminal setup code works after Emacs has begun
3576 @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?
3577 @cindex Terminal setup code in @file{.emacs}
3579 During startup, Emacs initializes itself according to a given code/file
3580 order.  If some of the code executed in your @file{.emacs} file needs to
3581 be postponed until the initial terminal or window-system setup code has
3582 been executed but is not, then you will experience this problem (this
3583 code/file execution order is not enforced after startup).
3585 To postpone the execution of Emacs Lisp code until after terminal or
3586 window-system setup, treat the code as a @dfn{lambda list} and set the
3587 value of either the @code{term-setup-hook} or @code{window-setup-hook}
3588 variable to this lambda function.  For example,
3590 @lisp
3591 (add-hook 'term-setup-hook
3592           (lambda ()
3593            (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3594              ;; Make vt220's "Do" key behave like M-x:
3595              (global-set-key [do] 'execute-extended-command))))
3596 @end lisp
3598 For information on what Emacs does every time it is started, see the
3599 @file{lisp/startup.el} file.
3601 @node Working with function and arrow keys
3602 @section How do I tell what characters or symbols my function or arrow keys emit?
3603 @cindex Working with arrow keys
3604 @cindex Arrow keys, symbols generated by
3605 @cindex Working with function keys
3606 @cindex Function keys, symbols generated by
3607 @cindex Symbols generated by function keys
3609 Type @kbd{C-h c} then the function or arrow keys.  The command will
3610 return either a function key symbol or character sequence (see the
3611 Emacs documentation for an explanation).  This works for other
3612 keys as well.
3614 @node X key translations for Emacs
3615 @section How do I set the X key ``translations'' for Emacs?
3616 @cindex X key translations
3617 @cindex Key translations under X
3618 @cindex Translations for keys under X
3620 Emacs is not written using the Xt library by default, so there are no
3621 ``translations'' to be set.  (We aren't sure how to set such translations
3622 if you do build Emacs with Xt; please let us know if you've done this!)
3624 The only way to affect the behavior of keys within Emacs is through
3625 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs).  The
3626 @code{define-key} command should be used in conjunction with the
3627 @code{function-key-map} map.  For instance,
3629 @lisp
3630 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3631 @end lisp
3633 @noindent
3634 defines the @kbd{M-@key{TAB}} key sequence.
3636 @node Backspace invokes help
3637 @section Why does the @key{Backspace} key invoke help?
3638 @cindex Backspace key invokes help
3639 @cindex Help invoked by Backspace
3640 @cindex DEL key does not delete
3642 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
3643 @kbd{C-h} sends the same code.  In Emacs by default @kbd{C-h} invokes
3644 help-command.  This is intended to be easy to remember since the first
3645 letter of @samp{help} is @samp{h}.  The easiest solution to this problem
3646 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
3647 @key{Delete} key) for deleting the previous character.
3649 For many people this solution may be problematic:
3651 @itemize @bullet
3653 @item
3654 They normally use @key{Backspace} outside of Emacs for deleting the
3655 previous character.  This can be solved by making @key{DEL} the command
3656 for deleting the previous character outside of Emacs.  On many Unix
3657 systems, this command will remap @key{DEL}:
3659 @example
3660 stty erase `^?'
3661 @end example
3663 @item
3664 The user may prefer the @key{Backspace} key for deleting the
3665 previous character because it is more conveniently located on their
3666 keyboard or because they don't even have a separate @key{Delete} key.
3667 In this case, the @key{Backspace} key should be made to behave like
3668 @key{Delete}.  There are several methods.
3670 @itemize @minus
3671 @item
3672 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
3673 TeraTerm) allow the character generated by the @key{Backspace} key to be
3674 changed from a setup menu.
3676 @item
3677 You may be able to get a keyboard that is completely programmable, or a
3678 terminal emulator that supports remapping of any key to any other key.
3680 @item
3681 With Emacs 21.1 and later, you can control the effect of the
3682 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
3683 windowed displays, by customizing the option
3684 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
3685 normal-erase-is-backspace}.  See the documentation of these symbols
3686 (@pxref{Emacs Lisp documentation}) for more info.
3688 @item
3689 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
3690 Emacs:
3692 @lisp
3693 (keyboard-translate ?\C-h ?\C-?)
3694 @end lisp
3696 @noindent
3697 This is the recommended method of forcing @key{Backspace} to act as
3698 @key{DEL}, because it works even in modes which bind @key{DEL} to
3699 something other than @code{delete-backward-char}.
3701 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
3702 default deletes forward:
3704 @lisp
3705 (keyboard-translate ?\C-? ?\C-d)
3706 @end lisp
3708 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
3710 @item
3711 Another approach is to switch key bindings and put help on @kbd{C-x h}
3712 instead:
3714 @lisp
3715 (global-set-key "\C-h" 'delete-backward-char)
3717 ;; overrides mark-whole-buffer
3718 (global-set-key "\C-xh" 'help-command)
3719 @end lisp
3721 @noindent
3722 This method is not recommended, though: it only solves the problem for
3723 those modes which bind @key{DEL} to @code{delete-backward-char}.  Modes
3724 which bind @key{DEL} to something else, such as @code{view-mode}, will
3725 not work as you expect when you press the @key{Backspace} key.  For this
3726 reason, we recommend the @code{keyboard-translate} method, shown
3727 above.
3729 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
3730 @end itemize
3732 Don't try to bind @key{DEL} to @code{help-command}, because there are
3733 many modes that have local bindings of @key{DEL} that will interfere.
3735 @end itemize
3737 When Emacs 21 or later runs on a windowed display, it binds the
3738 @key{Delete} key to a command which deletes the character at point, to
3739 make Emacs more consistent with keyboard operation on these systems.
3741 For more information about troubleshooting this problem, see @ref{DEL
3742 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
3743 Manual}.
3745 @node Swapping keys
3746 @section How do I swap two keys?
3747 @cindex Swapping keys
3748 @cindex Keys, swapping
3749 @cindex @code{keyboard-translate}
3751 You can swap two keys (or key sequences) by using the
3752 @code{keyboard-translate} function.  For example, to turn @kbd{C-h}
3753 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
3755 @lisp
3756 (keyboard-translate ?\C-h ?\C-?)  ; translate `C-h' to DEL
3757 (keyboard-translate ?\C-? ?\C-h)  ; translate DEL to `C-h'.
3758 @end lisp
3760 @noindent
3761 The first key sequence of the pair after the function identifies what is
3762 produced by the keyboard; the second, what is matched for in the
3763 keymaps.
3765 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
3766 toggle @code{normal-erase-is-backspace-mode} instead of calling
3767 @code{keyboard-translate}.
3768 @xref{DEL Does Not Delete,,, emacs, The GNU Emacs Manual}.
3770 Keyboard translations are not the same as key bindings in keymaps.
3771 Emacs contains numerous keymaps that apply in different situations, but
3772 there is only one set of keyboard translations, and it applies to every
3773 character that Emacs reads from the terminal.  Keyboard translations
3774 take place at the lowest level of input processing; the keys that are
3775 looked up in keymaps contain the characters that result from keyboard
3776 translation.
3778 @node Producing C-XXX with the keyboard
3779 @section How do I produce C-XXX with my keyboard?
3780 @cindex Producing control characters
3781 @cindex Generating control characters
3782 @cindex Control characters, generating
3784 On terminals (but not under X), some common ``aliases'' are:
3786 @table @asis
3788 @item @kbd{C-2}  or  @kbd{C-@key{SPC}}
3789 @kbd{C-@@}
3791 @item @kbd{C-6}
3792 @kbd{C-^}
3794 @item @kbd{C-7}  or  @kbd{C-S--}
3795 @kbd{C-_}
3797 @item @kbd{C-4}
3798 @kbd{C-\}
3800 @item @kbd{C-5}
3801 @kbd{C-]}
3803 @item @kbd{C-/}
3804 @kbd{C-?}
3806 @end table
3808 Often other aliases exist; use the @kbd{C-h c} command and try
3809 @key{CTRL} with all of the digits on your keyboard to see what gets
3810 generated.  You can also try the @kbd{C-h w} command if you know the
3811 name of the command.
3813 @node No Meta key
3814 @section What if I don't have a @key{Meta} key?
3815 @cindex No @key{Meta} key
3816 @cindex @key{Meta} key, what to do if you lack it
3818 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
3820 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}.  In fact,
3821 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
3822 (depending on the value of @code{meta-prefix-char}).  Note that you
3823 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
3824 @key{ESC}, release it, and then press @key{a}.
3826 @node No Escape key
3827 @section What if I don't have an @key{Escape} key?
3828 @cindex No Escape key
3829 @cindex Lacking an Escape key
3830 @cindex Escape key, lacking
3832 Type @kbd{C-[} instead.  This should send @acronym{ASCII} code 27 just like an
3833 Escape key would.  @kbd{C-3} may also work on some terminal (but not
3834 under X).  For many terminals (notably DEC terminals) @key{F11}
3835 generates @key{ESC}.  If not, the following form can be used to bind it:
3837 @lisp
3838 ;; F11 is the documented ESC replacement on DEC terminals.
3839 (define-key function-key-map [f11] [?\e])
3840 @end lisp
3842 @node Compose Character
3843 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
3844 @cindex @key{Compose Character} key, using as @key{Meta}
3845 @cindex @key{Meta}, using @key{Compose Character} for
3847 On a dumb terminal such as a VT220, no.  It is rumored that certain
3848 VT220 clones could have their @key{Compose} key configured this way.  If
3849 you're using X, you might be able to do this with the @code{xmodmap}
3850 command.
3852 @node Binding combinations of modifiers and function keys
3853 @section How do I bind a combination of modifier key and function key?
3854 @cindex Modifiers and function keys
3855 @cindex Function keys and modifiers
3856 @cindex Binding modifiers and function keys
3858 You can represent modified function keys in vector format by adding
3859 prefixes to the function key symbol.  For example (from the Emacs
3860 documentation):
3862 @lisp
3863 (global-set-key [?\C-x right] 'forward-page)
3864 @end lisp
3866 @noindent
3867 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
3869 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
3870 @key{Super}, @key{Alt}, and @key{Shift} with function keys.  To
3871 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
3872 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name.  Here
3873 is how to make @kbd{H-M-RIGHT} move forward a word:
3875 @lisp
3876 (global-set-key [H-M-right] 'forward-word)
3877 @end lisp
3879 @itemize @bullet
3881 @item
3882 Not all modifiers are permitted in all situations.  @key{Hyper},
3883 @key{Super}, and @key{Alt} are not available on Unix character
3884 terminals.  Non-@acronym{ASCII} keys and mouse events (e.g., @kbd{C-=} and
3885 @kbd{Mouse-1}) also fall under this category.
3887 @end itemize
3889 @xref{Binding keys to commands}, for general key binding instructions.
3891 @node Meta key does not work in xterm
3892 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
3893 @cindex @key{Meta} key and @code{xterm}
3894 @cindex Xterm and @key{Meta} key
3896 @xref{Unibyte Mode,, Single-Byte Character Set Support, emacs, The GNU Emacs Manual}.
3898 If the advice in the Emacs manual fails, try all of these methods before
3899 asking for further help:
3901 @itemize @bullet
3903 @item
3904 You may have big problems using @code{mwm} as your window manager.
3905 (Does anyone know a good generic solution to allow the use of the
3906 @key{Meta} key in Emacs with @file{mwm}?)
3908 @item
3909 For X11: Make sure it really is a @key{Meta} key.  Use @code{xev} to
3910 find out what keysym your @key{Meta} key generates.  It should be either
3911 @code{Meta_L} or @code{Meta_R}.  If it isn't, use @file{xmodmap} to fix
3912 the situation.  If @key{Meta} does generate @code{Meta_L} or
3913 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
3914 your @file{~/.Xdefaults} file:
3916 @example
3917  XTerm*eightBitInput:   false
3918  XTerm*eightBitOutput:  true
3919 @end example
3921 @item
3922 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
3923 characters.  @samp{stty -a} (or @samp{stty everything}) should show
3924 @samp{cs8} somewhere.  If it shows @samp{cs7} instead, use @samp{stty
3925 cs8 -istrip} (or @samp{stty pass8}) to fix it.
3927 @item
3928 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
3929 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
3930 of every character.
3932 @item
3933 If Emacs is running on Ultrix, it is reported that evaluating
3934 @code{(set-input-mode t nil)} helps.
3936 @item
3937 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
3938 you type @kbd{M-W}, which is the same conversion Emacs would make if it
3939 got the @kbd{M-W} anyway.  In X11R4, the following resource
3940 specification will do this:
3942 @example
3943 XTerm.VT100.EightBitInput: false
3944 @end example
3946 @noindent
3947 (This changes the behavior of the @code{insert-eight-bit} action.)
3949 With older @code{xterm}s, you can specify this behavior with a translation:
3951 @example
3952 XTerm.VT100.Translations: #override \
3953   Meta<KeyPress>: string(0x1b) insert()
3954 @end example
3956 @noindent
3957 You might have to replace @samp{Meta} with @samp{Alt}.
3959 @end itemize
3961 @node ExtendChar key does not work as Meta
3962 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
3963 @cindex @key{ExtendChar} key as @key{Meta}
3964 @cindex @key{Meta}, using @key{ExtendChar} for
3965 @cindex HP-UX, the @key{ExtendChar} key
3967 This is a result of an internationalization extension in X11R4 and the
3968 fact that HP is now using this extension.  Emacs assumes that the
3969 @code{XLookupString} function returns the same result regardless of the
3970 @key{Meta} key state which is no longer necessarily true.  Until Emacs
3971 is fixed, the temporary kludge is to run this command after each time
3972 the X server is started but preferably before any xterm clients are:
3974 @example
3975 xmodmap -e 'remove mod1 = Mode_switch'
3976 @end example
3978 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
3979 @c solved?
3981 This will disable the use of the extra keysyms systemwide, which may be
3982 undesirable if you actually intend to use them.
3984 @node SPC no longer completes file names
3985 @section Why doesn't SPC complete file names anymore?
3986 @cindex @kbd{SPC} file name completion
3988 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
3989 the minibuffer, so that file names with embedded spaces could be typed
3990 without the need to quote the spaces.
3992 You can get the old behavior by binding @kbd{SPC} to
3993 @code{minibuffer-complete-word} in the minibuffer, as follows:
3995 @lisp
3996 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
3997   'minibuffer-complete-word)
3999 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4000   'minibuffer-complete-word)
4001 @end lisp
4003 @c ------------------------------------------------------------
4004 @node Alternate character sets
4005 @chapter Alternate character sets
4006 @cindex Alternate character sets
4008 @menu
4009 * Emacs does not display 8-bit characters::
4010 * Inputting eight-bit characters::
4011 * Right-to-left alphabets::
4012 * How to add fonts::
4013 @end menu
4015 @node Emacs does not display 8-bit characters
4016 @section How do I make Emacs display 8-bit characters?
4017 @cindex Displaying eight-bit characters
4018 @cindex Eight-bit characters, displaying
4020 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4021 Emacs Manual}.  On a Unix, when Emacs runs on a text-only terminal
4022 display or is invoked with @samp{emacs -nw}, you typically need to use
4023 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4024 display, even after setting the language environment; otherwise
4025 non-@acronym{ASCII} characters will display as @samp{?}.  On other operating
4026 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4027 character set supported by the display, and sets up the required
4028 terminal coding system automatically.
4030 @node Inputting eight-bit characters
4031 @section How do I input eight-bit characters?
4032 @cindex Entering eight-bit characters
4033 @cindex Eight-bit characters, entering
4034 @cindex Input, 8-bit characters
4036 Various methods are available for input of eight-bit characters.
4037 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4038 Emacs Manual}.  For more sophisticated methods,
4039 @pxref{Input Methods,,, emacs, The GNU Emacs Manual}.
4041 @node Right-to-left alphabets
4042 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4043 @cindex Right-to-left alphabets
4044 @cindex Hebrew, handling with Emacs
4045 @cindex Semitic alphabets
4046 @cindex Arabic
4047 @cindex Farsi
4048 @cindex bidirectional scripts
4050 Emacs supports display and editing of bidirectional scripts, such as
4051 Arabic, Farsi, and Hebrew, since version 24.1.
4052 @xref{New in Emacs 24, bidirectional display}.
4055 @node How to add fonts
4056 @section How do I add fonts for use with Emacs?
4057 @cindex add fonts for use with Emacs
4058 @cindex intlfonts
4060 First, download and install the BDF font files and any auxiliary
4061 packages they need.  The GNU Intlfonts distribution can be found on
4062 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU
4063 Software Directory Web site}.
4065 Next, if you are on X Window system, issue the following two commands
4066 from the shell's prompt:
4068 @example
4069   xset +fp /usr/local/share/emacs/fonts
4070   xset fp rehash
4071 @end example
4073 @noindent
4074 (Modify the first command if you installed the fonts in a directory
4075 that is not @file{/usr/local/share/emacs/fonts}.)  You also need to
4076 arrange for these two commands to run whenever you log in, e.g., by
4077 adding them to your window-system startup file, such as
4078 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4080 Now, add the following line to your @file{~/.emacs} init file:
4082 @lisp
4083   (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4084 @end lisp
4086 @noindent
4087 (Again, modify the file name if you installed the fonts elsewhere.)
4089 Finally, if you wish to use the installed fonts with @code{ps-print},
4090 add the following line to your @file{~/.emacs}:
4092 @lisp
4093   (setq ps-multibyte-buffer 'bdf-font-except-latin)
4094 @end lisp
4096 A few additional steps are necessary for MS-Windows; they are listed
4097 below.
4099 First, make sure @emph{all} the directories with BDF font files are
4100 mentioned in @code{bdf-directory-list}.  On Unix and GNU/Linux
4101 systems, one normally runs @kbd{make install} to install the BDF fonts
4102 in the same directory.  By contrast, Windows users typically don't run
4103 the Intlfonts installation command, but unpack the distribution in
4104 some directory, which leaves the BDF fonts in its subdirectories.  For
4105 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4106 then you should set @code{bdf-directory-list} as follows:
4108 @lisp
4109   (setq bdf-directory-list
4110     '("C:/Intlfonts/Asian"
4111       "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4112       "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4113       "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4114       "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4115       "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4116       "C:/Intlfonts/Misc"))
4117 @end lisp
4119 @cindex @code{w32-bdf-filename-alist}
4120 @cindex @code{w32-find-bdf-fonts}
4121 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4122 an alist of the BDF fonts and their corresponding file names.
4123 Assuming you have set @code{bdf-directory-list} to name all the
4124 directories with the BDF font files, the following Lisp snippet will
4125 set up @code{w32-bdf-filename-alist}:
4127 @lisp
4128   (setq w32-bdf-filename-alist
4129      (w32-find-bdf-fonts bdf-directory-list))
4130 @end lisp
4132 Now, create fontsets for the BDF fonts:
4134 @smallexample
4135   (create-fontset-from-fontset-spec
4136    "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4137    japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4138    katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4139    latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4140    japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4141    thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4142    lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4143    tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4144    ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4145    tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4146 @end smallexample
4148 Many of the international bdf fonts from Intlfonts are type 0, and
4149 therefore need to be added to font-encoding-alist:
4151 @lisp
4152   (setq font-encoding-alist
4153         (append '(("MuleTibetan-0" (tibetan . 0))
4154                   ("GB2312"        (chinese-gb2312 . 0))
4155                   ("JISX0208"      (japanese-jisx0208 . 0))
4156                   ("JISX0212"      (japanese-jisx0212 . 0))
4157                   ("VISCII"        (vietnamese-viscii-lower . 0))
4158                   ("KSC5601"       (korean-ksc5601 . 0))
4159                   ("MuleArabic-0"  (arabic-digit . 0))
4160                   ("MuleArabic-1"  (arabic-1-column . 0))
4161                   ("MuleArabic-2"  (arabic-2-column . 0)))
4162                 font-encoding-alist))
4163 @end lisp
4165 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4166 fontset, or you can select it by setting the default font in your
4167 @file{~/.emacs}:
4169 @lisp
4170   (set-default-font "fontset-bdf")
4171 @end lisp
4174 @c ------------------------------------------------------------
4175 @node Mail and news
4176 @chapter Mail and news
4177 @cindex Mail and news
4179 @menu
4180 * Changing the included text prefix::
4181 * Saving a copy of outgoing mail::
4182 * Expanding aliases when sending mail::
4183 * Sorting the messages in an Rmail folder::
4184 * Rmail writes to /var/spool/mail::
4185 * Replying to the sender of a message::
4186 * Automatically starting a mail or news reader::
4187 * Reading news with Emacs::
4188 * Gnus does not work with NNTP::
4189 * Making Gnus faster::
4190 * Catching up in all newsgroups::
4191 @end menu
4193 @node Changing the included text prefix
4194 @section How do I change the included text prefix in mail/news followups?
4195 @cindex Prefix in mail/news followups, changing
4196 @cindex Included text prefix, changing
4197 @cindex Setting the included text character
4198 @cindex Quoting in mail messages
4200 If you read mail with Rmail, set the variable @code{mail-yank-prefix}.
4201 For Gnus, set @code{message-yank-prefix}.  For VM, set
4202 @code{vm-included-text-prefix}.  For mh-e, set @code{mh-ins-buf-prefix}.
4204 For fancier control of citations, use Supercite (@pxref{Top,, the Supercite
4205 Manual, sc, The Supercite Manual}).
4207 To prevent Emacs from including various headers of the replied-to
4208 message, set the value of @code{mail-yank-ignored-headers} to an
4209 appropriate regexp.
4211 @node Saving a copy of outgoing mail
4212 @section How do I save a copy of outgoing mail?
4213 @cindex Saving a copy of outgoing mail
4214 @cindex Copying outgoing mail to a file
4215 @cindex Filing outgoing mail
4216 @cindex Automatic filing of outgoing mail
4217 @cindex Mail, saving outgoing automatically
4219 You can either mail yourself a copy by including a @samp{BCC} header in the
4220 mail message, or store a copy of the message directly to a file by
4221 including an @samp{FCC} header.
4223 If you use standard mail, you can automatically create a @samp{BCC} to
4224 yourself by putting
4226 @lisp
4227 (setq mail-self-blind t)
4228 @end lisp
4230 @noindent
4231 in your @file{.emacs} file.  You can automatically include an @samp{FCC}
4232 field by putting something like the following in your @file{.emacs}
4233 file:
4235 @lisp
4236 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4237 @end lisp
4239 The output file will be in Unix mail format.
4241 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4242 components file.
4244 It does not work to put @samp{set record filename} in the @file{.mailrc}
4245 file.
4247 @node Expanding aliases when sending mail
4248 @section Why doesn't Emacs expand my aliases when sending mail?
4249 @cindex Expanding aliases when sending mail
4250 @cindex Mail alias expansion
4251 @cindex Sending mail with aliases
4253 @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}.
4255 @itemize @bullet
4257 @item
4258 Normally, Emacs expands aliases when you send the message.
4259 To expand them before this, use @kbd{M-x expand-mail-aliases}.
4261 @item
4262 Emacs normally only reads the @file{.mailrc} file once per session, when
4263 you start to compose your first mail message.  If you edit the file
4264 after this, you can use @kbd{M-x build-mail-aliases} to make Emacs
4265 reread it.  Prior to Emacs 24.1, this is not an interactive command, so
4266 you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}.
4268 @item
4269 If you like, you can expand mail aliases as abbrevs, as soon as you
4270 type them in.  To enable this feature, execute the following:
4272 @lisp
4273 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4274 @end lisp
4276 Note that the aliases are expanded automatically only after you type
4277 a word-separator character (e.g., @key{RET} or @kbd{,}).  You can force their
4278 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4279 (@kbd{M-x expand-abbrev}).
4280 @end itemize
4282 @node Sorting the messages in an Rmail folder
4283 @section How can I sort the messages in my Rmail folder?
4284 @cindex Rmail, sorting messages in
4285 @cindex Folder, sorting messages in an Rmail
4286 @cindex Sorting messages in an Rmail folder
4288 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4289 and their key bindings.
4291 @node Rmail writes to /var/spool/mail
4292 @section Why does Rmail need to write to @file{/var/spool/mail}?
4293 @cindex Rmail and @file{/var/spool/mail}
4294 @cindex @file{/var/spool/mail} and Rmail
4296 This is the behavior of the @code{movemail} program which Rmail uses.
4297 This indicates that @code{movemail} is configured to use lock files.
4299 RMS writes:
4301 @quotation
4302 Certain systems require lock files to interlock access to mail files.
4303 On these systems, @code{movemail} must write lock files, or you risk losing
4304 mail.  You simply must arrange to let @code{movemail} write them.
4306 Other systems use the @code{flock} system call to interlock access.  On
4307 these systems, you should configure @code{movemail} to use @code{flock}.
4308 @end quotation
4310 @node Replying to the sender of a message
4311 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4312 @cindex Replying only to the sender of a message
4313 @cindex Sender, replying only to
4314 @cindex Rmail, replying to the sender of a message in
4316 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit
4317 @key{r} to reply in Rmail, by default it CCs all of the original
4318 recipients (everyone on the original @samp{To} and @samp{CC}
4319 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4320 it replies only to the sender.  However, going through the whole
4321 @kbd{C-u} business every time you want to reply is a pain.  This is the
4322 best fix I've been able to come up with:
4324 @lisp
4325 (defun rmail-reply-t ()
4326   "Reply only to the sender of the current message. (See rmail-reply.)"
4327   (interactive)
4328   (rmail-reply t))
4330 (add-hook 'rmail-mode-hook
4331   (lambda ()
4332     (define-key rmail-mode-map "r" 'rmail-reply-t)
4333     (define-key rmail-mode-map "R" 'rmail-reply)))
4334 @end lisp
4336 @node Automatically starting a mail or news reader
4337 @section How do I make Emacs automatically start my mail/news reader?
4338 @cindex Mail reader, starting automatically
4339 @cindex News reader, starting automatically
4340 @cindex Starting mail/news reader automatically
4342 To start Emacs in Gnus:
4344 @example
4345 emacs -f gnus
4346 @end example
4348 @noindent
4349 in Rmail:
4351 @example
4352 emacs -f rmail
4353 @end example
4355 A more convenient way to start with Gnus:
4357 @example
4358 alias gnus 'emacs -f gnus'
4359 gnus
4360 @end example
4362 It is probably unwise to automatically start your mail or news reader
4363 from your @file{.emacs} file.  This would cause problems if you needed to run
4364 two copies of Emacs at the same time.  Also, this would make it difficult for
4365 you to start Emacs quickly when you needed to.
4367 @node Reading news with Emacs
4368 @section How do I read news under Emacs?
4369 @cindex Reading news under Emacs
4370 @cindex Usenet reader in Emacs
4371 @cindex Gnus newsreader
4372 @cindex FAQ for Gnus
4373 @cindex Gnus FAQ
4374 @cindex Learning more about Gnus
4376 Use @kbd{M-x gnus}.  For more information on Gnus, @pxref{Top,, the Gnus
4377 Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked
4378 Questions,, the Gnus FAQ, gnus, The Gnus Manual}.
4381 @node Gnus does not work with NNTP
4382 @section Why doesn't Gnus work via NNTP?
4383 @cindex Gnus and NNTP
4384 @cindex NNTP, Gnus fails to work with
4386 There is a bug in NNTP version 1.5.10, such that when multiple requests
4387 are sent to the NNTP server, the server only handles the first one
4388 before blocking waiting for more input which never comes.  NNTP version
4389 1.5.11 claims to fix this.
4391 You can work around the bug inside Emacs like this:
4393 @lisp
4394 (setq nntp-maximum-request 1)
4395 @end lisp
4397 You can find out what version of NNTP your news server is running by
4398 telnetting to the NNTP port (usually 119) on the news server machine
4399 (i.e., @kbd{telnet server-machine 119}).  The server should give its
4400 version number in the welcome message.  Type @kbd{quit} to get out.
4402 @node Making Gnus faster
4403 @section How do I make Gnus faster?
4404 @cindex Faster, starting Gnus
4405 @cindex Starting Gnus faster
4406 @cindex Gnus, starting faster
4407 @cindex Slow catch up in Gnus
4408 @cindex Gnus is slow when catching up
4409 @cindex Crosspostings make Gnus catching up slow
4411 From the Gnus FAQ (@pxref{Reading news with Emacs}):
4413 @quotation
4414 If you have a slow machine, or are just really impatient, there are a
4415 few things you can do to make Gnus run faster.
4417 Set @code{gnus-check-new-newsgroups} and
4418 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
4420 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
4421 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
4422 summary buffer faster.
4423 @end quotation
4425 @node Catching up in all newsgroups
4426 @section How do I catch up all newsgroups in Gnus?
4427 @cindex Catching up all newsgroups in Gnus
4428 @cindex Gnus, Catching up all newsgroups in
4430 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4432 Leave off the initial @kbd{M-<} if you only want to catch up from point
4433 to the end of the @file{*Newsgroup*} buffer.
4435 @node Concept index
4436 @unnumbered Concept Index
4437 @printindex cp
4439 @bye