Gnus: Improve parts deletion and stripping behavior
[emacs.git] / doc / misc / efaq.texi
blob84178277aab0712287e2838ed71cc42daabc7d66
1 \input texinfo   @c -*- mode: texinfo; -*-
2 @c %**start of header
3 @setfilename ../../info/efaq.info
4 @settitle GNU Emacs FAQ
5 @documentencoding UTF-8
6 @c %**end of header
8 @include emacsver.texi
10 @c This file is maintained by Romain Francoise <rfrancoise@gnu.org>.
11 @c Feel free to install changes without prior permission (but I'd
12 @c appreciate a notice if you do).
14 @copying
15 Copyright @copyright{} 2001--2015 Free Software Foundation, Inc.@*
16 Copyright @copyright{} 1994, 1995, 1996, 1997, 1998, 1999, 2000
17 Reuven M. Lerner@*
18 Copyright @copyright{} 1992, 1993 Steven Byrnes@*
19 Copyright @copyright{} 1990, 1991, 1992 Joseph Brian Wells@*
21 @quotation
22 This list of frequently asked questions about GNU Emacs with answers
23 (``FAQ'') may be translated into other languages, transformed into other
24 formats (e.g., Texinfo, Info, WWW, WAIS), and updated with new information.
26 The same conditions apply to any derivative of the FAQ as apply to the FAQ
27 itself.  Every copy of the FAQ must include this notice or an approved
28 translation, information on who is currently maintaining the FAQ and how to
29 contact them (including their e-mail address), and information on where the
30 latest version of the FAQ is archived (including FTP information).
32 The FAQ may be copied and redistributed under these conditions, except that
33 the FAQ may not be embedded in a larger literary work unless that work
34 itself allows free copying and redistribution.
36 [This version has been heavily edited since it was included in the Emacs
37 distribution.]
38 @end quotation
39 @end copying
41 @dircategory Emacs
42 @direntry
43 * Emacs FAQ: (efaq).            Frequently Asked Questions about Emacs.
44 @end direntry
46 @c The @titlepage stuff only appears in the printed version
47 @titlepage
48 @sp 10
49 @center @titlefont{GNU Emacs FAQ}
51 @c The following two commands start the copyright page.
52 @page
53 @vskip 0pt plus 1filll
54 @insertcopying
55 @end titlepage
57 @contents
59 @node Top, FAQ notation, (dir), (dir)
60 @top The GNU Emacs FAQ
62 This is the GNU Emacs FAQ.
64 This FAQ is maintained as a part of GNU Emacs.  If you find any errors,
65 or have any suggestions, please use @kbd{M-x report-emacs-bug} to report
66 them.
68 This is the version of the FAQ distributed with Emacs @value{EMACSVER}, and
69 mainly describes that version.  Although there is some information on
70 older versions, details about very old releases (now only of historical
71 interest) have been removed.  If you are interested in this, consult
72 either the version of the FAQ distributed with older versions of Emacs,
73 or the history of this document in the Emacs source repository.
75 Since Emacs releases are very stable, we recommend always running the
76 latest release.
78 This FAQ is not updated very frequently.  When you have a question about
79 Emacs, the Emacs manual is often the best starting point.
81 @ifnottex
82 @insertcopying
83 @end ifnottex
85 @menu
86 * FAQ notation::
87 * General questions::
88 * Getting help::
89 * Status of Emacs::
90 * Common requests::
91 * Bugs and problems::
92 * Compiling and installing Emacs::
93 * Finding Emacs and related packages::
94 * Key bindings::
95 * Alternate character sets::
96 * Mail and news::
97 * Concept index::
98 @end menu
100 @c ------------------------------------------------------------
101 @node FAQ notation
102 @chapter FAQ notation
103 @cindex FAQ notation
105 This chapter describes notation used in the GNU Emacs FAQ, as well as in
106 the Emacs documentation.  Consult this section if this is the first time
107 you are reading the FAQ, or if you are confused by notation or terms
108 used in the FAQ.
110 @menu
111 * Basic keys::
112 * Extended commands::
113 * Emacs manual::
114 * File-name conventions::
115 * Common acronyms::
116 @end menu
118 @node Basic keys
119 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
120 @cindex Basic keys
121 @cindex Control key, notation for
122 @cindex @key{Meta} key, notation for
123 @cindex Control-Meta characters, notation for
124 @cindex @kbd{C-h}, definition of
125 @cindex @kbd{C-M-h}, definition of
126 @cindex @key{DEL}, definition of
127 @cindex @key{ESC}, definition of
128 @cindex @key{LFD}, definition of
129 @cindex @key{RET}, definition of
130 @cindex @key{SPC}, definition of
131 @cindex @key{TAB}, definition of
132 @cindex Notation for keys
134 @itemize @bullet
136 @item
137 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
139 @item
140 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
141 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
143 @item
144 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
145 and @key{Meta}
147 @item
148 @kbd{C-M-x}: a synonym for the above
150 @item
151 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
153 @item
154 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
156 @item
157 @key{DEL}: @key{Delete}, usually @strong{not} the same as
158 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
159 deleting invokes Emacs help)
161 @item
162 @key{ESC}: Escape; same as @kbd{C-[}
164 @item
165 @key{TAB}: Tab; same as @kbd{C-i}
167 @item
168 @key{SPC}: Space bar
170 @end itemize
172 Key sequences longer than one key (and some single-key sequences) are
173 written inside quotes or on lines by themselves, like this:
175 @display
176   @kbd{M-x frobnicate-while-foo RET}
177 @end display
179 @noindent
180 Any real spaces in such a key sequence should be ignored; only @key{SPC}
181 really means press the space key.
183 The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
184 that would be sent by pressing just @key{x} minus 96 (or 64 for
185 upper-case @key{X}) and will be from 0 to 31.  On Unix and GNU/Linux
186 terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the
187 @acronym{ASCII} code that would be sent by pressing just @key{x}.  Essentially,
188 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
189 7@footnote{
190 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
191 pressed.}.
193 @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127.  It is a misnomer to call
194 @kbd{C-?}  a ``control'' key, since 127 has both bits 5 and 6 turned ON@.
195 Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127.
196 @c FIXME I cannot understand the previous sentence.
198 @xref{Keys,,, emacs, The GNU Emacs Manual}.
200 @node Extended commands
201 @section What does @file{M-x @var{command}} mean?
202 @cindex Extended commands
203 @cindex Commands, extended
204 @cindex M-x, meaning of
206 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
207 command, then type @key{RET}.  (@xref{Basic keys}, if you're not sure
208 what @kbd{M-x} and @key{RET} mean.)
210 @kbd{M-x} (by default) invokes the command
211 @code{execute-extended-command}.  This command allows you to run any
212 Emacs command if you can remember the command's name.  If you can't
213 remember the command's name, you can type @key{TAB} and @key{SPC} for
214 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
215 @kbd{M-n} (or up-arrow and down-arrow) to see previous commands entered.
216 An Emacs @dfn{command} is an @dfn{interactive} Emacs function.
218 @cindex @key{Do} key
219 Your system administrator may have bound other key sequences to invoke
220 @code{execute-extended-command}.  A function key labeled @kbd{Do} is a
221 good candidate for this, on keyboards that have such a key.
223 If you need to run non-interactive Emacs functions, see @ref{Evaluating
224 Emacs Lisp code}.
226 @node Emacs manual
227 @section How do I read topic XXX in the Emacs manual?
228 @cindex Emacs manual, reading topics in
229 @cindex Reading topics in the Emacs manual
230 @cindex Finding topics in the Emacs manual
231 @cindex Info, finding topics in
233 When we refer you to some @var{topic} in the Emacs manual, you can
234 read this manual node inside Emacs (assuming nothing is broken) by
235 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
237 This invokes Info, the GNU hypertext documentation browser.  If you don't
238 already know how to use Info, type @key{?} from within Info.
240 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
241 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
243 If these commands don't work as expected, your system administrator may
244 not have installed the Info files, or may have installed them
245 improperly.  In this case you should complain.
247 If you are reading this FAQ in Info, you can simply press @key{RET} on a
248 reference to follow it.
250 @xref{Getting a printed manual}, if you would like a paper copy of the
251 Emacs manual.
253 @node File-name conventions
254 @section What are @file{src/config.h}, @file{site-lisp/default.el}, etc.?
255 @cindex File-name conventions
256 @cindex Conventions for file names
257 @cindex Directories and files that come with Emacs
259 These are files that come with Emacs.  The Emacs distribution is divided
260 into subdirectories; e.g., @file{etc}, @file{lisp}, and @file{src}.
261 Some of these (e.g., @file{etc} and @file{lisp}) are present both in
262 an installed Emacs and in the sources, but some (e.g., @file{src}) are
263 only found in the sources.
265 If you use Emacs, but don't know where it is kept on your system, start
266 Emacs, then type @kbd{C-h v data-directory @key{RET}}.  The directory
267 name displayed by this will be the full pathname of the installed
268 @file{etc} directory.  (This full path is recorded in the Emacs variable
269 @code{data-directory}, and @kbd{C-h v} displays the value and the
270 documentation of a variable.)
272 The location of your Info directory (i.e., where Info documentation
273 is stored) is kept in the variable @code{Info-default-directory-list}.  Use
274 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
275 this variable, which will be a list of directory names.  The last
276 directory in that list is probably where most Info files are stored.  By
277 default, Emacs Info documentation is placed in @file{/usr/local/share/info}.
279 For information on some of the files in the @file{etc} directory,
280 @pxref{Informational files for Emacs}.
282 @node Common acronyms
283 @section What are FSF, LPF, GNU, RMS, FTP, and GPL?
284 @cindex FSF, definition of
285 @cindex LPF, definition of
286 @cindex GNU, definition of
287 @cindex RMS, definition of
288 @cindex Stallman, Richard, acronym for
289 @cindex Richard Stallman, acronym for
290 @cindex FTP, definition of
291 @cindex GPL, definition of
292 @cindex Acronyms, definitions for
293 @cindex Common acronyms, definitions for
295 @table @asis
297 @item FSF
298 Free Software Foundation
300 @item LPF
301 League for Programming Freedom
303 @item GNU
304 GNU's Not Unix
306 @item RMS
307 Richard Matthew Stallman
309 @item FTP
310 File Transfer Protocol
312 @item GPL
313 GNU General Public License
315 @end table
317 Avoid confusing the FSF and the LPF@.  The LPF opposes
318 look-and-feel copyrights and software patents.  The FSF aims to make
319 high quality free software available for everyone.
321 The word ``free'' in the title of the Free Software Foundation refers to
322 ``freedom,'' not ``zero cost.''  Anyone can charge any price for
323 GPL-covered software that they want to.  However, in practice, the
324 freedom enforced by the GPL leads to low prices, because you can always
325 get the software for less money from someone else, since everyone has
326 the right to resell or give away GPL-covered software.
328 @c ------------------------------------------------------------
329 @node General questions
330 @chapter General questions
331 @cindex General questions
333 This chapter contains general questions having to do with Emacs, the
334 Free Software Foundation, and related organizations.
336 @menu
337 * The LPF::
338 * Real meaning of copyleft::
339 * Guidelines for newsgroup postings::
340 * Newsgroup archives::
341 * Reporting bugs::
342 * Unsubscribing from Emacs lists::
343 * Contacting the FSF::
344 @end menu
346 @node The LPF
347 @section What is the LPF?
348 @cindex LPF, description of
349 @cindex League for Programming Freedom
350 @cindex Software patents, opposition to
351 @cindex Patents for software, opposition to
353 The LPF opposes the expanding danger of software patents and
354 look-and-feel copyrights.  More information on the LPF's views is
355 available at @uref{http://progfree.org/, the LPF home page}.
357 @node Real meaning of copyleft
358 @section What is the real legal meaning of the GNU copyleft?
359 @cindex Copyleft, real meaning of
360 @cindex GPL, real meaning of
361 @cindex General Public License, real meaning of
362 @cindex Discussion of the GPL
364 The real legal meaning of the GNU General Public License (copyleft) will
365 only be known if and when a judge rules on its validity and scope.
366 There has never been a copyright infringement case involving the GPL to
367 set any precedents.  Although legal actions have been brought against
368 companies for violating the terms of the GPL, so far all have been
369 settled out of court (in favor of the plaintiffs).  Please take any
370 discussion regarding this issue to the newsgroup
371 @uref{news:gnu.misc.discuss}, which was created to hold the extensive
372 flame wars on the subject.
374 RMS writes:
376 @quotation
377 The legal meaning of the GNU copyleft is less important than the spirit,
378 which is that Emacs is a free software project and that work pertaining
379 to Emacs should also be free software.  ``Free'' means that all users
380 have the freedom to study, share, change and improve Emacs.  To make
381 sure everyone has this freedom, pass along source code when you
382 distribute any version of Emacs or a related program, and give the
383 recipients the same freedom that you enjoyed.
384 @end quotation
386 @node Guidelines for newsgroup postings
387 @section  What are appropriate messages for the various Emacs newsgroups?
388 @cindex Newsgroups, appropriate messages for
389 @cindex GNU newsgroups, appropriate messages for
390 @cindex Usenet groups, appropriate messages for
391 @cindex Mailing lists, appropriate messages for
392 @cindex Posting messages to newsgroups
394 @cindex GNU mailing lists
395 The Emacs mailing lists are described at
396 @uref{http://savannah.gnu.org/mail/?group=emacs, the Emacs Savannah
397 page}. Some of them are gatewayed to newsgroups.
399 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
400 in general.  The newsgroup @uref{news:gnu.emacs.help} is specifically
401 for GNU Emacs.  It therefore makes no sense to cross-post to both
402 groups, since only one can be appropriate to any question.
404 Messages advocating ``non-free'' software are considered unacceptable on
405 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
406 which was created to hold the extensive flame-wars on the subject.
407 ``Non-free'' software includes any software for which the end user can't
408 freely modify the source code and exchange enhancements.  Be careful to
409 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
410 posting a followup that recommends such software.
412 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
413 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
415 @node Newsgroup archives
416 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
417 @cindex Archived postings from @code{gnu.emacs.help}
418 @cindex Usenet archives for GNU groups
419 @cindex Old Usenet postings for GNU groups
421 The FSF has maintained archives of all of the GNU mailing lists for many
422 years, although there may be some unintentional gaps in coverage.  The
423 archive can be browsed over the web at
424 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}.  Raw
425 files can be downloaded from @uref{ftp://lists.gnu.org/}.
427 Web-based Usenet search services, such as
428 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
429 archive the @code{gnu.*} groups.
431 You can also read the archives of the @code{gnu.*} groups and post new
432 messages at @uref{http://gmane.org/, Gmane}.  Gmane is a service that
433 presents mailing lists as newsgroups (even those without a traditional
434 mail-to-news gateway).
436 @node Reporting bugs
437 @section Where should I report bugs and other problems with Emacs?
438 @cindex Bug reporting
439 @cindex Good bug reports
440 @cindex How to submit a bug report
441 @cindex Reporting bugs
443 The correct way to report Emacs bugs is to use the command
444 @kbd{M-x report-emacs-bug}.  It sets up a mail buffer with the
445 essential information and the correct e-mail address,
446 @email{bug-gnu-emacs@@gnu.org}.
447 Anything sent there also appears in the
448 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
449 news to submit the bug report.  This ensures a reliable return address
450 so you can be contacted for further details.
452 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
453 a bug!  The manual describes in detail how to submit a useful bug
454 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
455 (@xref{Emacs manual}, if you don't know how to read the manual.)
457 RMS says:
459 @quotation
460 Sending bug reports to
461 @url{http://lists.gnu.org/mailman/listinfo/help-gnu-emacs,
462 the help-gnu-emacs mailing list}
463 (which has the effect of posting on @uref{news:gnu.emacs.help}) is
464 undesirable because it takes the time of an unnecessarily large group
465 of people, most of whom are just users and have no idea how to fix
466 these problem.
467 @url{http://lists.gnu.org/mailman/listinfo/bug-gnu-emacs, The
468 bug-gnu-emacs list} reaches a much smaller group of people who are
469 more likely to know what to do and have expressed a wish to receive
470 more messages about Emacs than the others.
471 @end quotation
473 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
475 @quotation
476 If you have reported a bug and you don't hear about a possible fix,
477 then after a suitable delay (such as a week) it is okay to post on
478 @code{gnu.emacs.help} asking if anyone can help you.
479 @end quotation
481 If you are unsure whether you have found a bug, consider the following
482 non-exhaustive list, courtesy of RMS:
484 @quotation
485 If Emacs crashes, that is a bug.  If Emacs gets compilation errors
486 while building, that is a bug.  If Emacs crashes while building, that
487 is a bug.  If Lisp code does not do what the documentation says it
488 does, that is a bug.
489 @end quotation
491 @node Unsubscribing from Emacs lists
492 @section  How do I unsubscribe from a mailing list?
493 @cindex Unsubscribing from GNU mailing lists
494 @cindex Removing yourself from GNU mailing lists
496 If you are receiving a GNU mailing list named @var{list}, you should be
497 able to unsubscribe from it by sending a request to the address
498 @email{@var{list}-request@@gnu.org}.  Mailing lists mails normally
499 contain information in either the message header
500 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
501 unsubscribe.
503 @node Contacting the FSF
504 @section  How do I contact the FSF?
505 @cindex Contracting the FSF
506 @cindex Free Software Foundation, contacting
508 For up-to-date information, see
509 @uref{http://www.fsf.org/about/contact.html, the FSF contact web-page}.
510 You can send general correspondence to @email{info@@fsf.org}.
512 @cindex Ordering GNU software
513 For details on how to order items directly from the FSF, see the
514 @uref{http://shop.fsf.org/, FSF on-line store}.
516 @c ------------------------------------------------------------
517 @node Getting help
518 @chapter Getting help
519 @cindex Getting help
521 This chapter tells you how to get help with Emacs.
523 @menu
524 * Basic editing::
525 * Learning how to do something::
526 * Getting a printed manual::
527 * Emacs Lisp documentation::
528 * Installing Texinfo documentation::
529 * Printing a Texinfo file::
530 * Viewing Info files outside of Emacs::
531 * Informational files for Emacs::
532 * Help installing Emacs::
533 * Obtaining the FAQ::
534 @end menu
536 @node Basic editing
537 @section I'm just starting Emacs; how do I do basic editing?
538 @cindex Basic editing with Emacs
539 @cindex Beginning editing
540 @cindex Tutorial, invoking the
541 @cindex Self-paced tutorial, invoking the
542 @cindex Help system, entering the
544 Type @kbd{C-h t} to invoke the self-paced tutorial.  Just typing
545 @kbd{C-h} enters the help system.  Starting with Emacs 22, the tutorial
546 is available in many foreign languages such as French, German, Japanese,
547 Russian, etc.  Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
548 to choose your language and start the tutorial.
550 Your system administrator may have changed @kbd{C-h} to act like
551 @key{DEL} to deal with local keyboards.  You can use @kbd{M-x
552 help-for-help} instead to invoke help.  To discover what key (if any)
553 invokes help on your system, type @kbd{M-x where-is @key{RET}
554 help-for-help @key{RET}}.  This will print a comma-separated list of key
555 sequences in the echo area.  Ignore the last character in each key
556 sequence listed.  Each of the resulting key sequences (e.g., @key{F1} is
557 common) invokes help.
559 Emacs help works best if it is invoked by a single key whose value
560 should be stored in the variable @code{help-char}.
562 Some Emacs slides and tutorials can be found at
563 @uref{http://web.psung.name/emacs/}.
565 @node Learning how to do something
566 @section How do I find out how to do something in Emacs?
567 @cindex Help for Emacs
568 @cindex Learning to do something in Emacs
569 @cindex Reference card for Emacs
570 @cindex Overview of help systems
572 There are several methods for finding out how to do things in Emacs.
574 @itemize @bullet
576 @cindex Reading the Emacs manual
577 @item
578 The complete text of the Emacs manual is available via the Info
579 hypertext reader.  Type @kbd{C-h r} to display the manual in Info mode.
580 Typing @key{h} immediately after entering Info will provide a short
581 tutorial on how to use it.
583 @cindex Lookup a subject in a manual
584 @cindex Index search in a manual
585 @item
586 To quickly locate the section of the manual which discusses a certain
587 issue, or describes a command or a variable, type @kbd{C-h i m emacs
588 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
589 topic, the command, or the variable which you are looking for.  If this
590 does not land you on the right place in the manual, press @kbd{,}
591 (comma) repeatedly until you find what you need.  (The @kbd{i} and
592 @kbd{,} keys invoke the index-searching functions, which look for the
593 @var{topic} you type in all the indices of the Emacs manual.)
595 @cindex Apropos
596 @item
597 You can list all of the commands whose names contain a certain word
598 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
599 command-apropos}).
601 @cindex Command description in the manual
602 @item
603 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
604 for the name of a command, and then attempts to find the section in the
605 Emacs manual where that command is described.
607 @cindex Finding commands and variables
608 @item
609 You can list all of the functions and variables whose names contain a
610 certain word using @kbd{M-x apropos}.
612 @item
613 You can list all of the functions and variables whose documentation
614 matches a regular expression or a string, using @kbd{M-x
615 apropos-documentation}.
617 @item
618 You can order a hardcopy of the manual from the FSF@.  @xref{Getting a
619 printed manual}.
621 @cindex Reference cards, in other languages
622 @item
623 You can get a printed reference card listing commands and keys to
624 invoke them.  You can order one from the FSF for $2 (or 10 for $18),
625 or you can print your own from the @file{etc/refcards/refcard.tex} or
626 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
627 Beginning with version 21.1, the Emacs distribution comes with
628 translations of the reference card into several languages; look for
629 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
630 is a two-letter code of the language.  For example, the German version
631 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
632 and @file{etc/refcards/de-refcard.pdf}.
634 @item
635 There are many other commands in Emacs for getting help and
636 information.  To get a list of these commands, type @samp{?} after
637 @kbd{C-h}.
639 @end itemize
641 @node Getting a printed manual
642 @section How do I get a printed copy of the Emacs manual?
643 @cindex Printed Emacs manual, obtaining
644 @cindex Manual, obtaining a printed or HTML copy of
645 @cindex Emacs manual, obtaining a printed or HTML copy of
647 You can order a printed copy of the Emacs manual from the FSF@.  For
648 details see the @uref{http://shop.fsf.org/, FSF on-line store}.
650 The full Texinfo source for the manual also comes in the @file{doc/emacs}
651 directory of the Emacs distribution, if you're daring enough to try to
652 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
653 file}).
655 If you absolutely have to print your own copy, and you don't have @TeX{},
656 you can get a PostScript or PDF (or HTML) version from
658 @uref{http://www.gnu.org/software/emacs/manual/}
660 @xref{Learning how to do something}, for how to view the manual from Emacs.
662 @node Emacs Lisp documentation
663 @section Where can I get documentation on Emacs Lisp?
664 @cindex Documentation on Emacs Lisp
665 @cindex Function documentation
666 @cindex Variable documentation
667 @cindex Emacs Lisp Reference Manual
668 @cindex Reference manual for Emacs Lisp
670 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
671 function, @kbd{C-h v} for a variable.
673 For more information, the Emacs Lisp Reference Manual is available
674 in Info format (@pxref{Top, Emacs Lisp,, elisp, The
675 Emacs Lisp Reference Manual}).
677 You can also order a hardcopy of the manual from the FSF, for details
678 see the @uref{http://shop.fsf.org/, FSF on-line store}.  (This manual is
679 not always in print.)
681 An HTML version of the Emacs Lisp Reference Manual is available at
683 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html}
685 @node Installing Texinfo documentation
686 @section How do I install a piece of Texinfo documentation?
687 @cindex Texinfo documentation, installing
688 @cindex Installing Texinfo documentation
689 @cindex New Texinfo files, installing
690 @cindex Documentation, installing new Texinfo files
691 @cindex Info files, how to install
693 Emacs releases come with pre-built Info files, and the normal install
694 process places them in the correct location.  This is true for most
695 applications that provide Info files.  The following section is only
696 relevant if you want to install extra Info files by hand.
698 First, you must turn the Texinfo source files into Info files.  You may
699 do this using the stand-alone @file{makeinfo} program, available as part
700 of the Texinfo package at
702 @uref{http://www.gnu.org/software/texinfo/}
704 For information about the Texinfo format, read the Texinfo manual which
705 comes with the Texinfo package.  This manual also comes installed in
706 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
707 @key{RET}}.
709 @c FIXME is this a complete alternative?
710 @c Probably not, given that we require makeinfo to build Emacs.
711 Alternatively, you could use the Emacs command @kbd{M-x
712 texinfo-format-buffer}, after visiting the Texinfo source file of the
713 manual you want to convert.
715 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
716 resulting Info files in Emacs's Info tree.  To install Info files,
717 perform these steps:
719 @enumerate
720 @item
721 Move the files to the @file{info} directory in the installed Emacs
722 distribution.  @xref{File-name conventions}, if you don't know where that
725 @item
726 Run the @code{install-info} command, which is part of the Texinfo
727 distribution, to update the main Info directory menu, like this:
729 @example
730  install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
731 @end example
733 @noindent
734 where @var{dir-path} is the full path to the directory where you copied
735 the produced Info file(s), and @var{file} is the name of the Info file
736 you produced and want to install.
738 If you don't have the @code{install-info} command installed, you can
739 edit the file @file{info/dir} in the installed Emacs distribution, and
740 add a line for the top level node in the Info package that you are
741 installing.  Follow the examples already in this file.  The format is:
743 @example
744 * Topic: (relative-pathname).  Short description of topic.
745 @end example
747 @end enumerate
749 If you want to install Info files and you don't have the necessary
750 privileges, you have several options:
752 @itemize @bullet
753 @item
754 Info files don't actually need to be installed before being used.
755 You can use a prefix argument for the @code{info} command and specify
756 the name of the Info file in the minibuffer.  This goes to the node
757 named @samp{Top} in that file.  For example, to view a Info file named
758 @file{@var{info-file}} in your home directory, you can type this:
760 @example
761 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
762 @end example
764 Alternatively, you can feed a file name to the @code{Info-goto-node}
765 command (invoked by pressing @key{g} in Info mode) by typing the name
766 of the file in parentheses, like this:
768 @example
769 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
770 @end example
772 @item
773 You can create your own Info directory.  You can tell Emacs where that
774 Info directory is by adding its pathname to the value of the variable
775 @code{Info-default-directory-list}.  For example, to use a private Info
776 directory which is a subdirectory of your home directory named @file{Info},
777 you could put this in your @file{.emacs} file:
779 @lisp
780 (add-to-list 'Info-default-directory-list "~/Info")
781 @end lisp
783 You will need a top-level Info file named @file{dir} in this directory
784 which has everything the system @file{dir} file has in it, except it
785 should list only entries for Info files in that directory.  You might
786 not need it if (fortuitously) all files in this directory were
787 referenced by other @file{dir} files.  The node lists from all
788 @file{dir} files in @code{Info-default-directory-list} are merged by the
789 Info system.
791 @end itemize
793 @node Printing a Texinfo file
794 @section How do I print a Texinfo file?
795 @cindex Printing a Texinfo file
796 @cindex Texinfo file, printing
797 @cindex Printing documentation
799 You can't get nicely printed output from Info files; you must still have
800 the original Texinfo source file for the manual you want to print.
802 Assuming you have @TeX{} installed on your system, follow these steps:
804 @enumerate
806 @item
807 Make sure the first line of the Texinfo file looks like this:
809 @example
810 \input texinfo
811 @end example
813 You may need to change @samp{texinfo} to the full pathname of the
814 @file{texinfo.tex} file, which comes with Emacs as
815 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
817 @item
818 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
819 the name of the Texinfo source file for which you want to produce a
820 printed copy.  The @samp{texi2dvi} script is part of the GNU Texinfo
821 distribution.
823 Alternatively, @samp{texi2pdf} produces PDF files.
825 @item
826 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
827 printing DVI files at your site.  For example, if you have a PostScript
828 printer, run the @code{dvips} program to print the DVI file on that
829 printer.
831 @end enumerate
833 To get more general instructions, retrieve the latest Texinfo package
834 (@pxref{Installing Texinfo documentation}).
836 @node Viewing Info files outside of Emacs
837 @section Can I view Info files without using Emacs?
838 @cindex Viewing Info files
839 @cindex Info file viewers
840 @cindex Alternative Info file viewers
842 Yes.  Here are some alternative programs:
844 @itemize @bullet
846 @item
847 @code{info}, a stand-alone version of the Info program, comes as part of
848 the Texinfo package.  @xref{Installing Texinfo documentation}, for
849 details.
851 @item
852 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
853 You can get Tkinfo at
854 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
856 @end itemize
858 @node Informational files for Emacs
859 @section What informational files are available for Emacs?
860 @cindex Informational files included with Emacs
861 @cindex Files included with Emacs
862 @cindex @file{COPYING}, description of file
863 @cindex @file{DISTRIB}, description of file
864 @cindex @file{MACHINES}, description of file
865 @cindex @file{NEWS}, description of file
867 This isn't a frequently asked question, but it should be!  A variety of
868 informational files about Emacs and relevant aspects of the GNU project
869 are available for you to read.
871 The following files (and others) are available in the @file{etc}
872 directory of the Emacs distribution (see @ref{File-name conventions}, if
873 you're not sure where that is).  Many of these files are available via
874 the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
875 help-for-help}).
877 @table @file
879 @item COPYING
880 GNU General Public License
882 @item DISTRIB
883 Emacs Availability Information
885 @item MACHINES
886 Status of Emacs on Various Machines and Systems
888 @item NEWS
889 Emacs news, a history of recent user-visible changes
891 @end table
893 More GNU information, including back issues of the @cite{GNU's
894 Bulletin}, are at
896 @uref{http://www.gnu.org/bulletins/bulletins.html} and
898 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
900 @node Help installing Emacs
901 @section Where can I get help in installing Emacs?
902 @cindex Installation help
903 @cindex Help installing Emacs
905 @xref{Installing Emacs}, for some basic installation hints, and see
906 @ref{Problems building Emacs}, if you have problems with the installation.
908 @uref{http://www.fsf.org/resources/service/, The GNU Service directory}
909 lists companies and individuals willing to sell you help in installing
910 or using Emacs and other GNU software.
912 @node Obtaining the FAQ
913 @section Where can I get the latest version of this FAQ?
914 @cindex FAQ, obtaining the
915 @cindex Latest FAQ version, obtaining the
917 The Emacs FAQ is distributed with Emacs in Info format.  You can read it
918 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
919 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
920 C-f} (@kbd{M-x view-emacs-FAQ}).  The very latest version is available
921 in the Emacs development repository (@pxref{Latest version of Emacs}).
923 @c ------------------------------------------------------------
924 @node Status of Emacs
925 @chapter Status of Emacs
926 @cindex Status of Emacs
928 This chapter gives you basic information about Emacs, including the
929 status of its latest version.
931 @menu
932 * Origin of the term Emacs::
933 * Latest version of Emacs::
934 * New in Emacs 24::
935 * New in Emacs 23::
936 * New in Emacs 22::
937 * New in Emacs 21::
938 * New in Emacs 20::
939 @end menu
941 @node Origin of the term Emacs
942 @section Where does the name ``Emacs'' come from?
943 @cindex Origin of the term ``Emacs''
944 @cindex Emacs name origin
945 @cindex TECO
946 @cindex Original version of Emacs
948 Emacs originally was an acronym for Editor MACroS@.  RMS says he ``picked
949 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
950 the time.''  The first Emacs was a set of macros written in 1976 at MIT
951 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
952 Editor and COrrector) under ITS (the Incompatible Timesharing System) on
953 a PDP-10.  RMS had already extended TECO with a ``real-time''
954 full-screen mode with reprogrammable keys.  Emacs was started by
955 @c gls@@east.sun.com
956 Guy Steele as a project to unify the many
957 divergent TECO command sets and key bindings at MIT, and completed by
958 RMS.
960 Many people have said that TECO code looks a lot like line noise; you
961 can read more at @uref{news:alt.lang.teco}.  Someone has written a TECO
962 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
963 come with Emacs}); it would be an interesting project to run the
964 original TECO Emacs inside of Emacs.
966 @cindex Why Emacs?
967 For some not-so-serious alternative reasons for Emacs to have that
968 name, check out the file @file{etc/JOKES} (@pxref{File-name
969 conventions}).
971 @node Latest version of Emacs
972 @section What is the latest version of Emacs?
973 @cindex Version, latest
974 @cindex Latest version of Emacs
975 @cindex Development, Emacs
976 @cindex Repository, Emacs
977 @cindex Bazaar repository, Emacs
979 Emacs @value{EMACSVER} is the current version as of this writing.  A version
980 number with two components (e.g., @samp{22.1}) indicates a released
981 version; three components indicate a development
982 version (e.g., @samp{23.0.50} is what will eventually become @samp{23.1}).
984 Emacs is under active development, hosted at
985 @uref{http://savannah.gnu.org/projects/emacs/, Savannah}.
986 Follow the instructions given there to clone the project repository.
988 Because Emacs undergoes many changes before a release, the version
989 number of a development version is not especially meaningful.  It is
990 better to refer to the date on which the sources were retrieved from the
991 development repository.  The development version is usually quite robust
992 for every-day use, but if stability is more important to you than the
993 latest features, you may want to stick to the releases.
995 The following sections list some of the major new features in the last
996 few Emacs releases.  For full details of the changes in any version of
997 Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}).  As of Emacs 22,
998 you can give this command a prefix argument to read about which features
999 were new in older versions.
1001 @node New in Emacs 24
1002 @section What is different about Emacs 24?
1003 @cindex Differences between Emacs 23 and Emacs 24
1004 @cindex Emacs 24, new features in
1006 @itemize
1007 @cindex packages, installing more
1008 @item
1009 Emacs now includes a package manager.  Type @kbd{M-x list-packages} to
1010 get started.  You can use this to download and automatically install
1011 many more Lisp packages.
1013 @cindex lexical binding
1014 @item
1015 Emacs Lisp now supports lexical binding on a per-file basis.  In
1016 @emph{lexical binding}, variable references must be located textually
1017 within the binding construct.  This contrasts with @emph{dynamic
1018 binding}, where programs can refer to variables defined outside their
1019 local textual scope.  A Lisp file can use a local variable setting of
1020 @code{lexical-binding: t} to indicate that the contents should be
1021 interpreted using lexical binding.  See the Emacs Lisp Reference
1022 Manual for more details.
1024 @cindex bidirectional display
1025 @cindex right-to-left languages
1026 @item
1027 Some human languages, such as English, are written from left to right.
1028 Others, such as Arabic, are written from right to left.  Emacs now has
1029 support for any mixture of these forms---this is ``bidirectional text''.
1031 @item
1032 Handling of text selections has been improved, and now integrates
1033 better with external clipboards.
1035 @cindex themes
1036 @item
1037 A new command @kbd{customize-themes} allows you to easily change the
1038 appearance of your Emacs.
1040 @item
1041 Emacs can be compiled with the GTK+ 3 toolkit.
1043 @item
1044 Support for several new external libraries can be included at compile
1045 time:
1047 @itemize
1049 @item
1050 ``Security-Enhanced Linux'' (SELinux) is a Linux kernel feature that
1051 provides more sophisticated file access controls than ordinary
1052 ``Unix-style'' file permissions.
1054 @item
1055 The ImageMagick display library.  This allows you to display many more
1056 image format in Emacs, as well as carry out transformations such as
1057 rotations.
1059 @item
1060 The GnuTLS library for secure network communications.  Emacs uses this
1061 transparently for email if your mail server supports it.
1063 @item
1064 The libxml2 library for parsing XML structures.
1065 @end itemize
1067 @item
1068 Much more flexibility in the handling of windows and buffer display.
1070 @end itemize
1072 As always, consult the @file{NEWS} file for more information.
1075 @node New in Emacs 23
1076 @section What is different about Emacs 23?
1077 @cindex Differences between Emacs 22 and Emacs 23
1078 @cindex Emacs 23, new features in
1080 @itemize
1082 @cindex Anti-aliased fonts
1083 @cindex Freetype fonts
1084 @item
1085 Emacs has a new font code that can use multiple font backends,
1086 including freetype and fontconfig.  Emacs can use the Xft library for
1087 anti-aliasing, and the otf and m17n libraries for complex text layout and
1088 text shaping.
1090 @cindex Unicode
1091 @cindex Character sets
1092 @item
1093 The Emacs character set is now a superset of Unicode.  Several new
1094 language environments have been added.
1096 @cindex Multi-tty support
1097 @cindex X and tty displays
1098 @item
1099 Emacs now supports using both X displays and ttys in the same session
1100 (@samp{multi-tty}).
1102 @cindex Daemon mode
1103 @item
1104 Emacs can be started as a daemon in the background.
1106 @cindex NeXTstep port
1107 @cindex GNUstep port
1108 @cindex Mac OS X Cocoa
1109 @item
1110 There is a new NeXTstep port of Emacs.  This supports GNUstep and Mac OS
1111 X (via the Cocoa libraries).  The Carbon port of Emacs, which supported
1112 Mac OS X in Emacs 22, has been removed.
1114 @cindex Directory-local variables
1115 @item
1116 Directory-local variables can now be defined, in a similar manner to
1117 file-local variables.
1119 @item
1120 Transient Mark mode (@pxref{Highlighting a region}) is on by default.
1122 @end itemize
1124 @noindent
1125 Other changes include: support for serial port access; D-Bus bindings; a
1126 new Visual Line mode for line-motion; improved completion; a new mode
1127 (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML
1128 mode (for editing XML documents) is included; VC has been updated for
1129 newer version control systems; etc.
1132 @node New in Emacs 22
1133 @section What is different about Emacs 22?
1134 @cindex Differences between Emacs 21 and Emacs 22
1135 @cindex Emacs 22, new features in
1137 @itemize
1138 @cindex GTK+ Toolkit
1139 @cindex Drag-and-drop
1140 @item
1141 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1142 operation on X.
1144 @cindex Supported systems
1145 @item
1146 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1147 machines, as well as support for the Mac OS X and Cygwin operating
1148 systems.
1150 @item
1151 The native MS-Windows, and Mac OS X builds include full support
1152 for images, toolbar, and tooltips.
1154 @item
1155 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1156 enabled by default.
1158 @item
1159 The maximum size of buffers is increased: on 32-bit machines, it is
1160 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above.
1162 @item
1163 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1165 @cindex Mouse wheel
1166 @item
1167 Mouse wheel support is enabled by default.
1169 @item
1170 Window fringes are customizable.
1172 @item
1173 The mode line of the selected window is now highlighted.
1175 @item
1176 The minibuffer prompt is displayed in a distinct face.
1178 @item
1179 Abbrev definitions are read automatically at startup.
1181 @item
1182 Grep mode is separate from Compilation mode and has many new options and
1183 commands specific to grep.
1185 @item
1186 The original Emacs macro system has been replaced by the new Kmacro
1187 package, which provides many new commands and features and a simple
1188 interface that uses the function keys F3 and F4.  Macros are stored in a
1189 macro ring, and can be debugged and edited interactively.
1191 @item
1192 The Grand Unified Debugger (GUD) can be used with a full graphical user
1193 interface to GDB; this provides many features found in traditional
1194 development environments, making it easy to manipulate breakpoints, add
1195 watch points, display the call stack, etc.  Breakpoints are visually
1196 indicated in the source buffer.
1198 @item
1199 @cindex New modes
1200 Many new modes and packages have been included in Emacs, such as Calc,
1201 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1202 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1203 savehist, Conf mode, Python mode, DNS mode, etc.
1205 @cindex Multilingual Environment
1206 @item
1207 Leim is now part of Emacs.  Unicode support has been much improved, and
1208 the following input methods have been added: belarusian, bulgarian-bds,
1209 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1210 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1211 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1212 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1213 ukrainian-computer, vietnamese-telex, and welsh.
1215 The following language environments have also been added: Belarusian,
1216 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1217 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1218 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1220 @cindex Documentation
1221 @cindex Emacs Lisp Manual
1222 @item
1223 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1224 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1225 @end itemize
1228 @node New in Emacs 21
1229 @section What is different about Emacs 21?
1230 @cindex Differences between Emacs 20 and Emacs 21
1231 @cindex Emacs 21, new features in
1233 @cindex Variable-size fonts
1234 @cindex Toolbar support
1235 Emacs 21 features a thorough rewrite of the display engine.  The new
1236 display engine supports variable-size fonts, images, and can play sounds
1237 on platforms which support that.  As a result, the visual appearance of
1238 Emacs, when it runs on a windowed display, is much more reminiscent of
1239 modern GUI programs, and includes 3D widgets (used for the mode line and
1240 the scroll bars), a configurable and extensible toolbar, tooltips
1241 (a.k.a.@: balloon help), and other niceties.
1243 @cindex Colors on text-only terminals
1244 @cindex TTY colors
1245 In addition, Emacs 21 supports faces on text-only terminals.  This means
1246 that you can now have colors when you run Emacs on a GNU/Linux console
1247 and on @code{xterm} with @kbd{emacs -nw}.
1250 @node New in Emacs 20
1251 @section What is different about Emacs 20?
1252 @cindex Differences between Emacs 19 and Emacs 20
1253 @cindex Emacs 20, new features in
1255 The differences between Emacs versions 18 and 19 were rather dramatic;
1256 the introduction of frames, faces, and colors on windowing systems was
1257 obvious to even the most casual user.
1259 There are differences between Emacs versions 19 and 20 as well, but many
1260 are more subtle or harder to find.  Among the changes are the inclusion
1261 of MULE code for languages that use non-Latin characters and for mixing
1262 several languages in the same document; the ``Customize'' facility for
1263 modifying variables without having to use Lisp; and automatic conversion
1264 of files from Macintosh, Microsoft, and Unix platforms.
1266 @c ------------------------------------------------------------
1267 @node Common requests
1268 @chapter Common requests
1269 @cindex Common requests
1271 @menu
1272 * Setting up a customization file::
1273 * Using Customize::
1274 * Colors on a TTY::
1275 * Debugging a customization file::
1276 * Displaying the current line or column::
1277 * Displaying the current file name in the titlebar::
1278 * Turning on abbrevs by default::
1279 * Associating modes with files::
1280 * Highlighting a region::
1281 * Replacing highlighted text::
1282 * Controlling case sensitivity::
1283 * Working with unprintable characters::
1284 * Searching for/replacing newlines::
1285 * Yanking text in isearch::
1286 * Wrapping words automatically::
1287 * Turning on auto-fill by default::
1288 * Changing load-path::
1289 * Using an already running Emacs process::
1290 * Compiler error messages::
1291 * Indenting switch statements::
1292 * Customizing C and C++ indentation::
1293 * Horizontal scrolling::
1294 * Overwrite mode::
1295 * Turning off beeping::
1296 * Turning the volume down::
1297 * Automatic indentation::
1298 * Matching parentheses::
1299 * Hiding #ifdef lines::
1300 * Repeating commands::
1301 * Valid X resources::
1302 * Evaluating Emacs Lisp code::
1303 * Changing the length of a Tab::
1304 * Inserting text at the beginning of each line::
1305 * Forcing the cursor to remain in the same column::
1306 * Forcing Emacs to iconify itself::
1307 * Using regular expressions::
1308 * Replacing text across multiple files::
1309 * Documentation for etags::
1310 * Disabling backups::
1311 * Disabling auto-save-mode::
1312 * Going to a line by number::
1313 * Modifying pull-down menus::
1314 * Deleting menus and menu options::
1315 * Turning on syntax highlighting::
1316 * Scrolling only one line::
1317 * Editing MS-DOS files::
1318 * Filling paragraphs with a single space::
1319 * Escape sequences in shell output::
1320 * Fullscreen mode on MS-Windows::
1321 @end menu
1323 @node Setting up a customization file
1324 @section How do I set up a @file{.emacs} file properly?
1325 @cindex @file{.emacs} file, setting up
1326 @cindex @file{.emacs} file, locating
1327 @cindex Init file, setting up
1328 @cindex Customization file, setting up
1330 @xref{Init File,,, emacs, The GNU Emacs Manual}.
1332 In general, new Emacs users should not be provided with @file{.emacs}
1333 files, because this can cause confusing non-standard behavior.  Then
1334 they send questions to
1335 @url{http://lists.gnu.org/mailman/listinfo/help-gnu-emacs,
1336 the help-gnu-emacs mailing list} asking why Emacs
1337 isn't behaving as documented.
1339 Emacs includes the Customize facility (@pxref{Using Customize}).  This
1340 allows users who are unfamiliar with Emacs Lisp to modify their
1341 @file{.emacs} files in a relatively straightforward way, using menus
1342 rather than Lisp code.
1344 While Customize might indeed make it easier to configure Emacs,
1345 consider taking a bit of time to learn Emacs Lisp and modifying your
1346 @file{.emacs} directly.  Simple configuration options are described
1347 rather completely in @ref{Init File,,, emacs, The GNU Emacs Manual},
1348 for users interested in performing frequently requested, basic tasks.
1350 Sometimes users are unsure as to where their @file{.emacs} file should
1351 be found.  Visiting the file as @file{~/.emacs} from Emacs will find
1352 the correct file.
1354 @node Using Customize
1355 @section How do I start using Customize?
1356 @cindex Customize groups
1357 @cindex Customizing variables
1358 @cindex Customizing faces
1360 The main Customize entry point is @kbd{M-x customize @key{RET}}.  This
1361 command takes you to a buffer listing all the available Customize
1362 groups.  From there, you can access all customizable options and faces,
1363 change their values, and save your changes to your init file.
1364 @xref{Easy Customization,,, emacs, The GNU Emacs Manual}.
1366 If you know the name of the group in advance (e.g., ``shell''), use
1367 @kbd{M-x customize-group @key{RET}}.
1369 If you wish to customize a single option, use @kbd{M-x customize-option
1370 @key{RET}}.  This command prompts you for the name of the option to
1371 customize, with completion.
1373 @node Colors on a TTY
1374 @section How do I get colors and syntax highlighting on a TTY?
1375 @cindex Colors on a TTY
1376 @cindex Syntax highlighting on a TTY
1377 @cindex Console, colors
1379 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1380 i.e., on Unix and GNU/Linux text-only terminals and consoles, and when
1381 invoked as @samp{emacs -nw} on X, and MS-Windows.  (Colors and faces were
1382 supported in the MS-DOS port since Emacs 19.29.)  Emacs automatically
1383 detects color support at startup and uses it if available.  If you think
1384 that your terminal supports colors, but Emacs won't use them, check the
1385 @code{termcap} entry for your display type for color-related
1386 capabilities.
1388 The command @kbd{M-x list-colors-display} pops up a window which
1389 exhibits all the colors Emacs knows about on the current display.
1391 Syntax highlighting is on by default since version 22.1.
1393 @node Debugging a customization file
1394 @section How do I debug a @file{.emacs} file?
1395 @cindex Debugging @file{.emacs} file
1396 @cindex @file{.emacs} debugging
1397 @cindex Init file debugging
1398 @cindex @samp{-debug-init} option
1400 Start Emacs with the @samp{-debug-init} command-line option.  This
1401 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1402 file, and places you in the debugger if something goes wrong.  The top
1403 line in the @file{trace-back} buffer will be the error message, and the
1404 second or third line of that buffer will display the Lisp code from your
1405 @file{.emacs} file that caused the problem.
1407 You can also evaluate an individual function or argument to a function
1408 in your @file{.emacs} file by moving the cursor to the end of the
1409 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1410 eval-last-sexp}).
1412 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1413 variables which you are trying to set or use.
1415 @node Displaying the current line or column
1416 @section How do I make Emacs display the current line (or column) number?
1417 @cindex @code{line-number-mode}
1418 @cindex Displaying the current line or column
1419 @cindex Line number, displaying the current
1420 @cindex Column, displaying the current
1421 @cindex @code{mode-line-format}
1423 By default, Emacs displays the current line number of the point in the
1424 mode line.  You can toggle this feature off or on with the command
1425 @kbd{M-x line-number-mode}, or by setting the variable
1426 @code{line-number-mode}.  Note that Emacs will not display the line
1427 number if the buffer's size in bytes is larger than the value of the
1428 variable @code{line-number-display-limit}.
1430 You can similarly display the current column with
1431 @kbd{M-x column-number-mode}, or by putting the form
1433 @lisp
1434 (setq column-number-mode t)
1435 @end lisp
1437 @noindent
1438 in your @file{.emacs} file.  This feature is off by default.
1440 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1441 will insert the current column's value into the mode line.  See the
1442 documentation for @code{mode-line-format} (using @kbd{C-h v
1443 mode-line-format @key{RET}}) for more information on how to set and use
1444 this variable.
1446 @cindex Set number capability in @code{vi} emulators
1447 The @samp{linum} package (distributed with Emacs since version 23.1)
1448 displays line numbers in the left margin, like the ``set number''
1449 capability of @code{vi}.  The packages @samp{setnu} and
1450 @samp{wb-line-number} (not distributed with Emacs) also implement this
1451 feature.
1453 @node Displaying the current file name in the titlebar
1454 @section How can I modify the titlebar to contain the current file name?
1455 @cindex Titlebar, displaying the current file name in
1456 @cindex File name, displaying in the titlebar
1457 @cindex @code{frame-title-format}
1459 The contents of an Emacs frame's titlebar is controlled by the variable
1460 @code{frame-title-format}, which has the same structure as the variable
1461 @code{mode-line-format}.  (Use @kbd{C-h v} or @kbd{M-x
1462 describe-variable} to get information about one or both of these
1463 variables.)
1465 By default, the titlebar for a frame does contain the name of the buffer
1466 currently being visited, except if there is a single frame.  In such a
1467 case, the titlebar contains Emacs invocation name and the name of the
1468 machine at which Emacs was invoked.  This is done by setting
1469 @code{frame-title-format} to the default value of
1471 @lisp
1472 (multiple-frames "%b" ("" invocation-name "@@" (system-name)))
1473 @end lisp
1475 To modify the behavior such that frame titlebars contain the buffer's
1476 name regardless of the number of existing frames, include the following
1477 in your @file{.emacs}:
1479 @lisp
1480 (setq frame-title-format "%b")
1481 @end lisp
1483 @node Turning on abbrevs by default
1484 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1485 @cindex Abbrevs, turning on by default
1487 Abbrev mode expands abbreviations as you type them.  To turn it on in a
1488 specific buffer, use @kbd{M-x abbrev-mode}.  To turn it on in every
1489 buffer by default, put this in your @file{.emacs} file:
1491 @lisp
1492 (setq-default abbrev-mode t)
1493 @end lisp
1495 @noindent To turn it on in a specific mode, use:
1497 @lisp
1498 (add-hook '@var{mymode}-mode-hook
1499           (lambda ()
1500            (setq abbrev-mode t)))
1501 @end lisp
1503 @noindent If your Emacs version is older then 22.1, you will also need to use:
1505 @lisp
1506 (condition-case ()
1507    (quietly-read-abbrev-file)
1508   (file-error nil))
1509 @end lisp
1511 @node Associating modes with files
1512 @section How do I make Emacs use a certain major mode for certain files?
1513 @cindex Associating modes with files
1514 @cindex File extensions and modes
1515 @cindex @code{auto-mode-alist}, modifying
1516 @cindex Modes, associating with file extensions
1518 If you want to use a certain mode @var{foo} for all files whose names end
1519 with the extension @file{.@var{bar}}, this will do it for you:
1521 @lisp
1522 (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode))
1523 @end lisp
1525 Alternatively, put this somewhere in the first line of any file you want to
1526 edit in the mode @var{foo} (in the second line, if the first line begins
1527 with @samp{#!}):
1529 @example
1530 -*- @var{foo} -*-
1531 @end example
1533 @cindex Major mode for shell scripts
1534 The variable @code{interpreter-mode-alist} specifies which mode to use
1535 when loading an interpreted script (e.g., shell, python, etc.).  Emacs
1536 determines which interpreter you're using by examining the first line of
1537 the script.  Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
1538 @code{interpreter-mode-alist} to learn more.
1540 @node Highlighting a region
1541 @section How can I highlight a region of text in Emacs?
1542 @cindex Highlighting text
1543 @cindex Text, highlighting
1544 @cindex @code{transient-mark-mode}
1545 @cindex Region, highlighting a
1547 You can cause the region to be highlighted when the mark is active by
1548 including
1550 @lisp
1551 (transient-mark-mode 1)
1552 @end lisp
1554 @noindent
1555 in your @file{.emacs} file.  Since Emacs 23.1, this feature is on by default.
1557 @node Replacing highlighted text
1558 @section How can I replace highlighted text with what I type?
1559 @cindex @code{delete-selection-mode}
1560 @cindex Replacing highlighted text
1561 @cindex Highlighting and replacing text
1563 Use @code{delete-selection-mode}, which you can start automatically by
1564 placing the following Lisp form in your @file{.emacs} file:
1566 @lisp
1567 (delete-selection-mode 1)
1568 @end lisp
1570 According to the documentation string for @code{delete-selection-mode}
1571 (which you can read using @kbd{M-x describe-function @key{RET}
1572 delete-selection-mode @key{RET}}):
1574 @quotation
1575 When Delete Selection mode is enabled, typed text replaces the selection
1576 if the selection is active.  Otherwise, typed text is just inserted at
1577 point regardless of any selection.
1578 @end quotation
1580 This mode also allows you to delete (not kill) the highlighted region by
1581 pressing @key{DEL}.
1583 @node Controlling case sensitivity
1584 @section How do I control Emacs's case-sensitivity when searching/replacing?
1585 @cindex @code{case-fold-search}
1586 @cindex Case sensitivity of searches
1587 @cindex Searching without case sensitivity
1588 @cindex Ignoring case in searches
1590 @c FIXME
1591 The value of the variable @code{case-fold-search} determines whether
1592 searches are case sensitive:
1594 @lisp
1595 (setq case-fold-search nil) ; make searches case sensitive
1596 (setq case-fold-search t)   ; make searches case insensitive
1597 @end lisp
1599 @cindex Case sensitivity in replacements
1600 @cindex Replacing, and case sensitivity
1601 @cindex @code{case-replace}
1602 Similarly, for replacing, the variable @code{case-replace} determines
1603 whether replacements preserve case.
1605 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1607 To change the case sensitivity just for one major mode, use the major
1608 mode's hook.  For example:
1610 @lisp
1611 (add-hook '@var{foo}-mode-hook
1612           (lambda ()
1613            (setq case-fold-search nil)))
1614 @end lisp
1616 @node Working with unprintable characters
1617 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1618 @cindex Unprintable characters, working with
1619 @cindex Working with unprintable characters
1620 @cindex Control characters, working with
1621 @cindex Eight-bit characters, working with
1622 @cindex Searching for unprintable characters
1623 @cindex Regexps and unprintable characters
1625 To search for a single character that appears in the buffer as, for
1626 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.
1627 Searching for @strong{all} unprintable characters is best done with a
1628 regular expression (@dfn{regexp}) search.  The easiest regexp to use for
1629 the unprintable chars is the complement of the regexp for the printable
1630 chars.
1632 @itemize @bullet
1634 @item
1635 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1637 @item
1638 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1640 @end itemize
1642 To type these special characters in an interactive argument to
1643 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1644 use @kbd{C-q}.  (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1645 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.)  So,
1646 to search for unprintable characters using @code{re-search-forward}:
1648 @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}}
1650 Using @code{isearch-forward-regexp}:
1652 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1654 To delete all unprintable characters, simply use replace-regexp:
1656 @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}}
1658 Replacing is similar to the above.  To replace all unprintable
1659 characters with a colon, use:
1661 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}
1663 @node Searching for/replacing newlines
1664 @section How do I input a newline character in isearch or query-replace?
1665 @cindex Searching for newlines
1666 @cindex Replacing newlines
1668 Use @kbd{C-q C-j}.  For more information,
1669 @pxref{Special Isearch,, Special Input for Incremental Search, emacs,
1670 The GNU Emacs Manual}.
1672 @node Yanking text in isearch
1673 @section How do I copy text from the kill ring into the search string?
1674 @cindex Yanking text into the search string
1675 @cindex isearch yanking
1677 Use @kbd{M-y}.  @xref{Isearch Yank,,, emacs, The GNU Emacs Manual}.
1679 @node Wrapping words automatically
1680 @section How do I make Emacs wrap words for me?
1681 @cindex Wrapping word automatically
1682 @cindex Wrapping lines
1683 @cindex Line wrap
1684 @cindex @code{auto-fill-mode}, introduction to
1685 @cindex Maximum line width, default value
1686 @cindex @code{fill-column}, default value
1688 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1689 The default maximum line width is 70, determined by the variable
1690 @code{fill-column}.  To learn how to turn this on automatically, see
1691 @ref{Turning on auto-fill by default}.
1693 @node Turning on auto-fill by default
1694 @section How do I turn on @code{auto-fill-mode} by default?
1695 @cindex @code{auto-fill-mode}, activating automatically
1696 @cindex Filling automatically
1697 @cindex Automatic entry to @code{auto-fill-mode}
1699 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1700 auto-fill-mode}.
1702 To turn it on for every buffer in a certain mode, you must use the hook
1703 for that mode.  For example, to turn on @code{auto-fill} mode for all
1704 text buffers, including the following in your @file{.emacs} file:
1706 @lisp
1707 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1708 @end lisp
1710 If you want @code{auto-fill} mode on in all major modes, do this:
1712 @lisp
1713 (setq-default auto-fill-function 'do-auto-fill)
1714 @end lisp
1716 @node Changing load-path
1717 @section How do I change @code{load-path}?
1718 @cindex @code{load-path}, modifying
1719 @cindex Modifying @code{load-path}
1720 @cindex Adding to @code{load-path}
1722 In general, you should only add to the @code{load-path}.  You can add
1723 directory @var{/dir/subdir} to the load path like this:
1725 @lisp
1726 (add-to-list 'load-path "/dir/subdir/")
1727 @end lisp
1729 To do this relative to your home directory:
1731 @lisp
1732 (add-to-list 'load-path "~/mysubdir/")
1733 @end lisp
1735 @node Using an already running Emacs process
1736 @section How do I use an already running Emacs from another window?
1737 @cindex @code{emacsclient}
1738 @cindex Emacs server functions
1739 @cindex Using an existing Emacs process
1741 @code{emacsclient}, which comes with Emacs, is for editing a file using
1742 an already running Emacs rather than starting up a new Emacs.  It does
1743 this by sending a request to the already running Emacs, which must be
1744 expecting the request.
1746 @itemize @bullet
1748 @item
1749 Setup:
1751 Emacs must have executed the @code{server-start} function for
1752 @samp{emacsclient} to work.  This can be done either by a command line
1753 option:
1755 @example
1756 emacs -f server-start
1757 @end example
1759 or by invoking @code{server-start} from @file{.emacs}:
1761 @lisp
1762 (if (@var{some conditions are met}) (server-start))
1763 @end lisp
1765 When this is done, Emacs creates a Unix domain socket named
1766 @file{server} in @file{/tmp/emacs@var{userid}}. See
1767 @code{server-socket-dir}.
1769 To get your news reader, mail reader, etc., to invoke
1770 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1771 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}.  You may
1772 have to specify the full pathname of the @samp{emacsclient} program
1773 instead.  Examples:
1775 @example
1776 # csh commands:
1777 setenv EDITOR emacsclient
1779 # using full pathname
1780 setenv EDITOR /usr/local/emacs/etc/emacsclient
1782 # sh command:
1783 EDITOR=emacsclient ; export EDITOR
1784 @end example
1786 @item
1787 Normal use:
1789 When @samp{emacsclient} is run, it connects to the socket and passes its
1790 command line options to Emacs, which at the next opportunity will visit
1791 the files specified.  (Line numbers can be specified just like with
1792 Emacs.)  The user will have to switch to the Emacs window by hand.  When
1793 the user is done editing a file, the user can type @kbd{C-x #} (or
1794 @kbd{M-x server-edit}) to indicate this.  If there is another buffer
1795 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1796 @code{emacsclient} will exit, signaling the calling program to continue.
1798 @cindex @code{gnuserv}
1799 There is an alternative version of @samp{emacsclient} called
1800 @c ange@@hplb.hpl.hp.com
1801 @samp{gnuserv}, written by Andy Norman
1802 (@pxref{Packages that do not come with Emacs}).  @samp{gnuserv} uses
1803 Internet domain sockets, so it can work across most network connections.
1805 The most recent @samp{gnuserv} package is available at
1807 @uref{http://meltin.net/hacks/emacs/}
1809 @end itemize
1811 @node Compiler error messages
1812 @section How do I make Emacs recognize my compiler's funny error messages?
1813 @cindex Compiler error messages, recognizing
1814 @cindex Recognizing non-standard compiler errors
1815 @cindex Regexps for recognizing compiler errors
1816 @cindex Errors, recognizing compiler
1818 Customize the @code{compilation-error-regexp-alist} variable.
1820 @node Indenting switch statements
1821 @section How do I change the indentation for @code{switch}?
1822 @cindex @code{switch}, indenting
1823 @cindex Indenting of @code{switch}
1825 Many people want to indent their @code{switch} statements like this:
1827 @example
1830   switch(x) @{
1831     case A:
1832       x1;
1833       break;
1834     case B:
1835       x2;
1836       break;
1837     default:
1838       x3;
1839   @}
1841 @end example
1843 @noindent To achieve this, add the following line to your @file{.emacs}:
1845 @lisp
1846 (c-set-offset 'case-label '+)
1847 @end lisp
1849 @node Customizing C and C++ indentation
1850 @section How to customize indentation in C, C@t{++}, and Java buffers?
1851 @cindex Indentation, how to customize
1852 @cindex Customize indentation
1854 The Emacs @code{cc-mode} features an interactive procedure for
1855 customizing the indentation style, which is fully explained in the
1856 @cite{CC Mode} manual that is part of the Emacs distribution, see
1857 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1858 The CC Mode Manual}.  Here's a short summary of the procedure:
1860 @enumerate
1861 @item
1862 Go to the beginning of the first line where you don't like the
1863 indentation and type @kbd{C-c C-o}.  Emacs will prompt you for the
1864 syntactic symbol; type @key{RET} to accept the default it suggests.
1866 @item
1867 Emacs now prompts for the offset of this syntactic symbol, showing the
1868 default (the current definition) inside parentheses.  You can choose
1869 one of these:
1871 @table @code
1872 @item 0
1873 No extra indentation.
1874 @item +
1875 Indent one basic offset.
1876 @item -
1877 Outdent one basic offset.
1878 @item ++
1879 Indent two basic offsets
1880 @item --
1881 Outdent two basic offsets.
1882 @item *
1883 Indent half basic offset.
1884 @item /
1885 Outdent half basic offset.
1886 @end table
1888 @item
1889 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1890 the line or the block according to what you just specified.
1892 @item
1893 If you don't like the result, go back to step 1.  Otherwise, add the
1894 following line to your @file{.emacs}:
1896 @lisp
1897 (c-set-offset '@var{syntactic-symbol} @var{offset})
1898 @end lisp
1900 @noindent
1901 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1902 when you type @kbd{C-c C-o} at the beginning of the line, and
1903 @var{offset} is one of the indentation symbols listed above (@code{+},
1904 @code{/}, @code{0}, etc.)@: that you've chosen during the interactive
1905 procedure.
1907 @item
1908 Go to the next line whose indentation is not to your liking and repeat
1909 the process there.
1910 @end enumerate
1912 It is recommended to put all the resulting @code{(c-set-offset ...)}
1913 customizations inside a C mode hook, like this:
1915 @lisp
1916 (defun my-c-mode-hook ()
1917   (c-set-offset ...)
1918   (c-set-offset ...))
1919 (add-hook 'c-mode-hook 'my-c-mode-hook)
1920 @end lisp
1922 @noindent
1923 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1924 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1925 might be unavailable when @code{cc-mode} is not loaded.
1927 Note that @code{c-mode-hook} runs for C source files only; use
1928 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1929 Java sources, etc.  If you want the same customizations to be in
1930 effect in @emph{all} languages supported by @code{cc-mode}, use
1931 @code{c-mode-common-hook}.
1933 @node Horizontal scrolling
1934 @section How can I make Emacs automatically scroll horizontally?
1935 @cindex @code{hscroll-mode}
1936 @cindex Horizontal scrolling
1937 @cindex Scrolling horizontally
1939 In Emacs 21 and later, this is on by default: if the variable
1940 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1941 automatically scrolls the display horizontally when point moves off the
1942 left or right edge of the window.
1944 Note that this is overridden by the variable
1945 @code{truncate-partial-width-windows} if that variable is non-@code{nil}
1946 and the current buffer is not full-frame width.
1948 In Emacs 20, use @code{hscroll-mode}.
1950 @node Overwrite mode
1951 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
1952 @cindex @key{Insert}
1953 @cindex @code{overwrite-mode}
1954 @cindex Overwriting existing text
1955 @cindex Toggling @code{overwrite-mode}
1957 @kbd{M-x overwrite-mode} (a minor mode).  This toggles
1958 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1959 is as easy as another @kbd{M-x overwrite-mode}.
1961 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1963 @node Turning off beeping
1964 @section How do I stop Emacs from beeping on a terminal?
1965 @cindex Beeping, turning off
1966 @cindex Visible bell
1967 @cindex Bell, visible
1969 @c martin@@cc.gatech.edu
1970 Martin R. Frank writes:
1972 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1973 and set the visible bell to nothing.
1975 That is, put the following in your @code{TERMCAP} environment variable
1976 (assuming you have one):
1978 @example
1979 ... :vb=: ...
1980 @end example
1982 And evaluate the following Lisp form:
1984 @example
1985 (setq visible-bell t)
1986 @end example
1988 @node Turning the volume down
1989 @section How do I turn down the bell volume in Emacs running under X?
1990 @cindex Bell, volume of
1991 @cindex Volume of bell
1993 On X Window system, you can adjust the bell volume and duration for all
1994 programs with the shell command @code{xset}.
1996 Invoking @code{xset} without any arguments produces some basic
1997 information, including the following:
1999 @example
2000 usage:  xset [-display host:dpy] option ...
2001   To turn bell off:
2002       -b                b off               b 0
2003   To set bell volume, pitch and duration:
2004        b [vol [pitch [dur]]]          b on
2005 @end example
2007 @node Automatic indentation
2008 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
2009 @cindex Indenting new lines
2010 @cindex New lines, indenting of
2011 @cindex Previous line, indenting according to
2012 @cindex Text indentation
2014 Such behavior is automatic (in Text mode) in Emacs 20 and later.  From the
2015 @file{etc/NEWS} file for Emacs 20.2:
2017 @example
2018 ** In Text mode, now only blank lines separate paragraphs.  This makes
2019 it possible to get the full benefit of Adaptive Fill mode in Text mode,
2020 and other modes derived from it (such as Mail mode).  @key{TAB} in Text
2021 mode now runs the command @code{indent-relative}; this makes a practical
2022 difference only when you use indented paragraphs.
2024 If you want spaces at the beginning of a line to start a paragraph, use
2025 the new mode, Paragraph Indent Text mode.
2026 @end example
2028 @cindex Prefixing lines
2029 @cindex Fill prefix
2030 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
2031 by default}), you can tell Emacs to prefix every line with a certain
2032 character sequence, the @dfn{fill prefix}.  Type the prefix at the
2033 beginning of a line, position point after it, and then type @kbd{C-x .}
2034 (@code{set-fill-prefix}) to set the fill prefix.  Thereafter,
2035 auto-filling will automatically put the fill prefix at the beginning of
2036 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
2037 prefix when refilling the paragraph.
2039 If you have paragraphs with different levels of indentation, you will
2040 have to set the fill prefix to the correct value each time you move to a
2041 new paragraph.  There are many packages available to deal with this
2042 (@pxref{Packages that do not come with Emacs}).  Look for ``fill'' and
2043 ``indent'' keywords for guidance.
2045 @node Matching parentheses
2046 @section How do I show which parenthesis matches the one I'm looking at?
2047 @cindex Parentheses, matching
2048 @cindex @file{paren.el}
2049 @cindex Highlighting matching parentheses
2050 @cindex Pairs of parentheses, highlighting
2051 @cindex Matching parentheses
2053 Call @code{show-paren-mode} in your @file{.emacs} file:
2055 @lisp
2056 (show-paren-mode 1)
2057 @end lisp
2059 You can also enable this mode by selecting the @samp{Paren Match
2060 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
2061 at the top of any Emacs frame.
2063 Alternatives to this mode include:
2065 @itemize @bullet
2067 @item
2068 If you're looking at a right parenthesis (or brace or bracket) you can
2069 delete it and reinsert it.  Emacs will momentarily move the cursor to
2070 the matching parenthesis.
2072 @item
2073 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2074 will skip over one set of balanced parentheses, so you can see which
2075 parentheses match.  (You can train it to skip over balanced brackets
2076 and braces at the same time by modifying the syntax table.)
2078 @cindex Show matching paren as in @code{vi}
2079 @item
2080 Here is some Emacs Lisp that will make the @key{%} key show the matching
2081 parenthesis, like in @code{vi}.  In addition, if the cursor isn't over a
2082 parenthesis, it simply inserts a % like normal.
2084 @lisp
2085 ;; By an unknown contributor
2087 (global-set-key "%" 'match-paren)
2089 (defun match-paren (arg)
2090   "Go to the matching paren if on a paren; otherwise insert %."
2091   (interactive "p")
2092   (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2093         ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2094         (t (self-insert-command (or arg 1)))))
2095 @end lisp
2097 @end itemize
2099 @node Hiding #ifdef lines
2100 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2101 @cindex @code{#ifdef}, selective display of
2102 @cindex @code{hide-ifdef-mode}
2103 @cindex Hiding @code{#ifdef} text
2104 @cindex Selectively displaying @code{#ifdef} code
2106 @kbd{M-x hide-ifdef-mode}.  (This is a minor mode.)  You might also want
2107 to investigate @file{cpp.el}, which is distributed with Emacs.
2109 @node Repeating commands
2110 @section How do I repeat a command as many times as possible?
2111 @cindex Repeating commands many times
2112 @cindex Commands, repeating many times
2113 @cindex @code{.}, equivalent to @code{vi} command
2115 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2116 that repeats the last command.  If you preface it with a prefix
2117 argument, the prefix arg is applied to the command.
2119 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2120 (@code{repeat-complex-command}) to reinvoke commands that used the
2121 minibuffer to get arguments.  In @code{repeat-complex-command} you can
2122 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2123 keyboard has these keys) to scan through all the different complex
2124 commands you've typed.
2126 To repeat a set of commands, use keyboard macros.  Use @kbd{C-x (} and
2127 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2128 type @kbd{C-x e}.  @xref{Keyboard Macros,,, emacs, The GNU Emacs Manual}.
2130 If you're really desperate for the @code{.} command in @code{vi} that
2131 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2132 mode which comes with Emacs, and which appears to support it.
2134 @node Valid X resources
2135 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2136 @cindex Resources, X
2137 @cindex X resources
2138 @cindex Setting X resources
2140 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2142 You can also use a resource editor, such as editres (for X11R5 and
2143 onwards), to look at the resource names for the menu bar, assuming Emacs
2144 was compiled with the X toolkit.
2146 @node Evaluating Emacs Lisp code
2147 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2148 @cindex Evaluating Lisp code
2149 @cindex Lisp forms, evaluating
2151 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2152 Emacs Lisp @dfn{form}:
2154 @itemize @bullet
2156 @item
2157 If you want it evaluated every time you run Emacs, put it in a file
2158 named @file{.emacs} in your home directory.  This is known as ``your
2159 @file{.emacs} file,'' and contains all of your personal customizations.
2161 @item
2162 You can type the form in the @file{*scratch*} buffer, and then type
2163 @key{LFD} (or @kbd{C-j}) after it.  The result of evaluating the form
2164 will be inserted in the buffer.
2166 @item
2167 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2168 before or around point.
2170 @item
2171 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2172 before point and prints its value in the echo area.
2174 @item
2175 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2176 form in the minibuffer which will be evaluated once you press @key{RET}.
2178 @item
2179 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2180 forms in a file.  (To do this from Lisp use the function @code{load}
2181 instead.)
2183 The functions @code{load-library}, @code{eval-region},
2184 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2185 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2186 about them.
2188 @end itemize
2190 @node Changing the length of a Tab
2191 @section How do I change Emacs's idea of the @key{TAB} character's length?
2192 @cindex Tab length
2193 @cindex Length of tab character
2195 Set the default value of the variable @code{tab-width}.  For example, to set
2196 @key{TAB} stops every 10 characters, insert the following in your
2197 @file{.emacs} file:
2199 @lisp
2200 (setq-default tab-width 10)
2201 @end lisp
2203 Do not confuse variable @code{tab-width} with variable
2204 @code{tab-stop-list}.  The former is used for the display of literal
2205 @key{TAB} characters.  The latter controls what characters are inserted
2206 when you press the @key{TAB} character in certain modes.
2208 @node Inserting text at the beginning of each line
2209 @section How do I insert <some text> at the beginning of every line?
2210 @cindex Prefixing a region with some text
2211 @cindex Prefix character, inserting in mail/news replies
2212 @cindex Replies to mail/news, inserting a prefix character
2213 @cindex @code{mail-yank-prefix}
2214 @cindex Mail replies, inserting a prefix character
2215 @cindex News replies, inserting a prefix character
2217 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2218 @key{RET} ^ @key{RET} your text @key{RET}}.
2220 To do this to a region, use @code{string-insert-rectangle}.
2221 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2222 want to prefix, move the cursor to last line to be prefixed, and type
2223 @kbd{M-x string-insert-rectangle @key{RET}}.  To do this for the whole
2224 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2226 If you are trying to prefix a yanked mail message with @samp{>}, you
2227 might want to set the variable @code{mail-yank-prefix}.  In Message
2228 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2229 runs the function @code{comment-region}, it is a general-purpose
2230 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2232 @node Forcing the cursor to remain in the same column
2233 @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?
2234 @cindex @code{picture-mode}
2235 @cindex Remaining in the same column, regardless of contents
2236 @cindex Vertical movement in empty documents
2238 Use @kbd{M-x picture-mode}.
2240 See also the variable @code{track-eol} and the command
2241 @code{set-goal-column} bound to @kbd{C-x C-n}
2242 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2244 @node Forcing Emacs to iconify itself
2245 @section How do I tell Emacs to iconify itself?
2246 @cindex Iconification under the X Window System
2247 @cindex X Window System and iconification
2248 @cindex Suspending Emacs
2250 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2251 otherwise.  @xref{Frame Commands,,, emacs, The GNU Emacs Manual}.
2253 @node Using regular expressions
2254 @section How do I use regexps (regular expressions) in Emacs?
2255 @cindex Regexps
2256 @cindex Regular expressions
2257 @cindex Differences between Unix and Emacs regexps
2258 @cindex Unix regexps, differences from Emacs
2259 @cindex Text strings, putting regexps in
2261 @xref{Regexp Backslash,,, emacs, The GNU Emacs Manual}.
2263 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2264 are @samp{\(} and @samp{\)}.  Also, the string syntax for a backslash is
2265 @samp{\\}.  To specify a regular expression like @samp{xxx\(foo\|bar\)}
2266 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2268 Note the doubled backslashes!
2270 @itemize @bullet
2272 @item
2273 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2274 (@samp{[^...]})  can match a newline character (@key{LFD} a.k.a.@:
2275 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2276 characters not to match.
2278 @item
2279 The character syntax regexps (e.g., @samp{\sw}) are not
2280 meaningful inside character set regexps (e.g., @samp{[aeiou]}).  (This
2281 is actually typical for regexp syntax.)
2283 @end itemize
2285 @node Replacing text across multiple files
2286 @section How do I perform a replace operation across more than one file?
2287 @cindex Replacing strings across files
2288 @cindex Multiple files, replacing across
2289 @cindex Files, replacing strings across multiple
2290 @cindex Recursive search/replace operations
2292 Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the
2293 command @code{dired-do-query-replace-regexp} (@kbd{Q}), which allows
2294 users to replace regular expressions in multiple files.
2296 You can use this command to perform search/replace operations on
2297 multiple files by following the following steps:
2299 @itemize @bullet
2300 @item
2301 Assemble a list of files you want to operate on with either
2302 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2304 @item
2305 Mark all files in the resulting Dired buffer using @kbd{t}.
2307 @item
2308 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2309 files.
2311 @item
2312 To accept all replacements in each file, hit @kbd{!}.
2313 @end itemize
2315 Another way to do the same thing is to use the ``tags'' feature of
2316 Emacs: it includes the command @code{tags-query-replace} which performs
2317 a query-replace across all the files mentioned in the @file{TAGS} file.
2318 @xref{Tags Search,,, emacs, The GNU Emacs Manual}.
2320 @node Documentation for etags
2321 @section Where is the documentation for @code{etags}?
2322 @cindex Documentation for @code{etags}
2323 @cindex @code{etags}, documentation for
2325 The @code{etags} man page should be in the same place as the
2326 @code{emacs} man page.
2328 Quick command-line switch descriptions are also available.  For example,
2329 @samp{etags -H}.
2331 @node Disabling backups
2332 @section How do I disable backup files?
2333 @cindex Backups, disabling
2334 @cindex Disabling backups
2336 You probably don't want to do this, since backups are useful, especially
2337 when something goes wrong.
2339 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2340 load @code{dired-x} by adding the following to your @file{.emacs} file:
2342 @lisp
2343 (add-hook 'dired-load-hook
2344           (lambda ()
2345            (require 'dired-x)))
2346 @end lisp
2348 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2349 You can make omitting the default for new dired buffers by putting the
2350 following in your @file{.emacs}:
2352 @lisp
2353 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2354 @end lisp
2356 If you're tired of seeing backup files whenever you do an @samp{ls} at
2357 the Unix shell, try GNU @code{ls} with the @samp{-B} option.  GNU
2358 @code{ls} is part of the GNU Fileutils package, available from
2359 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2361 To disable or change the way backups are made,
2362 @pxref{Backup Names,,, emacs, The GNU Emacs Manual}.
2364 @cindex Backup files in a single directory
2365 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2366 by customizing the variable @code{backup-directory-alist}.  This
2367 variable's value specifies that files whose names match specific patters
2368 should have their backups put in certain directories.  A typical use is
2369 to add the element @code{("." . @var{dir})} to force Emacs to put
2370 @strong{all} backup files in the directory @file{dir}.
2372 @node Disabling auto-save-mode
2373 @section How do I disable @code{auto-save-mode}?
2374 @cindex Disabling @code{auto-save-mode}
2375 @cindex Auto-saving
2376 @cindex Saving at frequent intervals
2378 You probably don't want to do this, since auto-saving is useful,
2379 especially when Emacs or your computer crashes while you are editing a
2380 document.
2382 Instead, you might want to change the variable
2383 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2384 waits before auto-saving.  Increasing this value forces Emacs to wait
2385 longer between auto-saves, which might annoy you less.
2387 You might also want to look into Sebastian Kremer's @code{auto-save}
2388 package (@pxref{Packages that do not come with Emacs}).  This
2389 package also allows you to place all auto-save files in one directory,
2390 such as @file{/tmp}.
2392 To disable or change how @code{auto-save-mode} works,
2393 @pxref{Auto Save,,, emacs, The GNU Emacs Manual}.
2395 @node Going to a line by number
2396 @section How can I go to a certain line given its number?
2397 @cindex Going to a line by number
2398 @cindex Compilation error messages
2399 @cindex Recompilation
2401 Are you sure you indeed need to go to a line by its number?  Perhaps all
2402 you want is to display a line in your source file for which a compiler
2403 printed an error message?  If so, compiling from within Emacs using the
2404 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2405 effective way of doing that.  Emacs automatically intercepts the compile
2406 error messages, inserts them into a special buffer called
2407 @file{*compilation*}, and lets you visit the locus of each message in
2408 the source.  Type @kbd{C-x `} to step through the offending lines one by
2409 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2410 @kbd{M-g M-n} to go to the previous and next matches directly).  Click
2411 @kbd{Mouse-2} or press @key{RET} on a message text in the
2412 @file{*compilation*} buffer to go to the line whose number is mentioned
2413 in that message.
2415 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2416 (which is the default binding of the @code{goto-line} function starting
2417 with Emacs 22).  Emacs will prompt you for the number of the line and go
2418 to that line.
2420 You can do this faster by invoking @code{goto-line} with a numeric
2421 argument that is the line's number.  For example, @kbd{C-u 286 M-g M-g}
2422 will jump to line number 286 in the current buffer.
2424 @node Modifying pull-down menus
2425 @section How can I create or modify new pull-down menu options?
2426 @cindex Pull-down menus, creating or modifying
2427 @cindex Menus, creating or modifying
2428 @cindex Creating new menu options
2429 @cindex Modifying pull-down menus
2430 @cindex Menus and keymaps
2431 @cindex Keymaps and menus
2433 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2434 represents a local or global keymap.  Selecting a menu title with the
2435 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2437 So to add a menu option to an existing menu, all you have to do is add a
2438 new definition to the appropriate keymap.  Adding a @samp{Forward Word}
2439 item to the @samp{Edit} menu thus requires the following Lisp code:
2441 @lisp
2442 (define-key global-map
2443   [menu-bar edit forward]
2444   '("Forward word" . forward-word))
2445 @end lisp
2447 @noindent
2448 The first line adds the entry to the global keymap, which includes
2449 global menu bar entries.  Replacing the reference to @code{global-map}
2450 with a local keymap would add this menu option only within a particular
2451 mode.
2453 The second line describes the path from the menu-bar to the new entry.
2454 Placing this menu entry underneath the @samp{File} menu would mean
2455 changing the word @code{edit} in the second line to @code{file}.
2457 The third line is a cons cell whose first element is the title that will
2458 be displayed, and whose second element is the function that will be
2459 called when that menu option is invoked.
2461 To add a new menu, rather than a new option to an existing menu, we must
2462 define an entirely new keymap:
2464 @lisp
2465 (define-key global-map [menu-bar words]
2466   (cons "Words" (make-sparse-keymap "Words")))
2467 @end lisp
2469 The above code creates a new sparse keymap, gives it the name
2470 @samp{Words}, and attaches it to the global menu bar.  Adding the
2471 @samp{Forward Word} item to this new menu would thus require the
2472 following code:
2474 @lisp
2475 (define-key global-map
2476   [menu-bar words forward]
2477   '("Forward word" . forward-word))
2478 @end lisp
2480 @noindent
2481 Note that because of the way keymaps work, menu options are displayed
2482 with the more recently defined items at the top.  Thus if you were to
2483 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2484 order), the menu option @samp{baz} would appear at the top, and
2485 @samp{foo} would be at the bottom.
2487 One way to avoid this problem is to use the function @code{define-key-after},
2488 which works the same as @code{define-key}, but lets you modify where items
2489 appear.  The following Lisp code would insert the @samp{Forward Word}
2490 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2492 @lisp
2493 (define-key-after
2494   (lookup-key global-map [menu-bar edit])
2495   [forward]
2496   '("Forward word" . forward-word)
2497   'undo)
2498 @end lisp
2500 Note how the second and third arguments to @code{define-key-after} are
2501 different from those of @code{define-key}, and that we have added a new
2502 (final) argument, the function after which our new key should be
2503 defined.
2505 To move a menu option from one position to another, simply evaluate
2506 @code{define-key-after} with the appropriate final argument.
2508 More detailed information---and more examples of how to create and
2509 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2510 ``Menu Keymaps.''  (@xref{Emacs Lisp documentation}, for information on
2511 this manual.)
2513 @node Deleting menus and menu options
2514 @section How do I delete menus and menu options?
2515 @cindex Deleting menus and menu options
2516 @cindex Menus, deleting
2518 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2519 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2520 menus}), use:
2522 @lisp
2523 (define-key global-map [menu-bar words] nil)
2524 @end lisp
2526 Similarly, removing a menu option requires redefining a keymap entry to
2527 @code{nil}.  For example, to delete the @samp{Forward word} menu option
2528 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2529 menus}), use:
2531 @lisp
2532 (define-key global-map [menu-bar edit forward] nil)
2533 @end lisp
2535 @node Turning on syntax highlighting
2536 @section How do I turn on syntax highlighting?
2537 @cindex Syntax highlighting
2538 @cindex @code{font-lock-mode}
2539 @cindex Highlighting based on syntax
2540 @cindex Colorizing text
2541 @cindex FAQ, @code{font-lock-mode}
2543 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2544 highlighting in the current buffer.  It is enabled by default in Emacs
2545 22.1 and later.
2547 With @code{font-lock-mode} turned on, different types of text will
2548 appear in different colors.  For instance, in a programming mode,
2549 variables will appear in one face, keywords in a second, and comments in
2550 a third.
2552 To turn @code{font-lock-mode} off within an existing buffer, use
2553 @kbd{M-x font-lock-mode @key{RET}}.
2555 In Emacs 21 and earlier versions, you could use the following code in
2556 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2558 @lisp
2559 (global-font-lock-mode 1)
2560 @end lisp
2562 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2563 and cause an annoying delay in display, so several features exist to
2564 work around this.
2566 @cindex Just-In-Time syntax highlighting
2567 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2568 activates the new @dfn{Just-In-Time fontification} provided by
2569 @code{jit-lock-mode}.  @code{jit-lock-mode} defers the fontification of
2570 portions of buffer until you actually need to see them, and can also
2571 fontify while Emacs is idle.  This makes display of the visible portion
2572 of a buffer almost instantaneous.  For details about customizing
2573 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2575 @cindex Levels of syntax highlighting
2576 @cindex Decoration level, in @code{font-lock-mode}
2577 In versions of Emacs before 21, different levels of decoration are
2578 available, from slight to gaudy.  More decoration means you need to wait
2579 more time for a buffer to be fontified (or a faster machine).  To
2580 control how decorated your buffers should become, set the value of
2581 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2582 @code{nil} value indicating default (usually minimum) decoration, and a
2583 @code{t} value indicating the maximum decoration.  For the gaudiest
2584 possible look, then, include the line
2586 @lisp
2587 (setq font-lock-maximum-decoration t)
2588 @end lisp
2590 @noindent
2591 in your @file{.emacs} file.  You can also set this variable such that
2592 different modes are highlighted in a different ways; for more
2593 information, see the documentation for
2594 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2595 describe-variable @key{RET}}).
2597 Also see the documentation for the function @code{font-lock-mode},
2598 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2599 describe-function @key{RET} font-lock-mode @key{RET}}).
2601 To print buffers with the faces (i.e., colors and fonts) intact, use
2602 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2603 ps-print-region-with-faces}.  You will need a way to send text to a
2604 PostScript printer, or a PostScript interpreter such as Ghostscript;
2605 consult the documentation of the variables @code{ps-printer-name},
2606 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2608 @node Scrolling only one line
2609 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2610 @cindex Scrolling only one line
2611 @cindex Reducing the increment when scrolling
2613 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2614 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2615 to a large value like, say, 10000.  For an explanation of what this
2616 means, @pxref{Auto Scrolling,,, emacs, The GNU Emacs Manual}.
2618 Alternatively, use the following Lisp form in your @file{.emacs}:
2620 @lisp
2621 (setq scroll-conservatively most-positive-fixnum)
2622 @end lisp
2624 @node Editing MS-DOS files
2625 @section How can I edit MS-DOS files using Emacs?
2626 @cindex Editing MS-DOS files
2627 @cindex MS-DOS files, editing
2628 @cindex Microsoft files, editing
2629 @cindex Windows files, editing
2631 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2632 performed transparently.  You can open MS-DOS files on a Unix system,
2633 edit it, and save it without having to worry about the file format.
2635 When editing an MS-DOS style file, the mode line will indicate that it
2636 is a DOS file.  On Unix and GNU/Linux systems, and also on a Macintosh,
2637 the string @samp{(DOS)} will appear near the left edge of the mode line;
2638 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2639 default, a backslash (@samp{\}) will appear in the mode line.
2641 @node Filling paragraphs with a single space
2642 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2643 @cindex One space following periods
2644 @cindex Single space following periods
2645 @cindex Periods, one space following
2647 Add the following line to your @file{.emacs} file:
2649 @lisp
2650 (setq sentence-end-double-space nil)
2651 @end lisp
2653 @node Escape sequences in shell output
2654 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2655 @cindex Escape sequences in @code{ls} output
2656 @cindex @code{ls} in Shell mode
2658 In many systems, @code{ls} is aliased to @samp{ls --color}, which
2659 prints using ANSI color escape sequences.  Emacs version 21.1 and
2660 later includes the @code{ansi-color} package, which lets Shell mode
2661 recognize these escape sequences.  In Emacs 23.2 and later, the
2662 package is enabled by default; in earlier versions you can enable it
2663 by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2664 by adding @code{(add-hook 'shell-mode-hook
2665 'ansi-color-for-comint-mode-on)} to your init file.
2667 In Emacs versions before 21.1, the @code{ansi-color} package is not
2668 included.  In that case, you need to unalias @code{ls} for interactive
2669 shells running in Emacs; this can be done by checking the @code{EMACS}
2670 variable in the environment.
2672 @node Fullscreen mode on MS-Windows
2673 @section How can I start Emacs in fullscreen mode on MS-Windows?
2674 @cindex Maximize frame
2675 @cindex Fullscreen mode
2677 Use the function @code{w32-send-sys-command}.  For example, you can
2678 put the following in your @file{.emacs} file:
2680 @lisp
2681 (add-hook 'emacs-startup-hook
2682           (lambda () (w32-send-sys-command ?\xF030)))
2683 @end lisp
2685 To avoid the slightly distracting visual effect of Emacs starting with
2686 its default frame size and then growing to fullscreen, you can add an
2687 @samp{Emacs.Geometry} entry to the Windows registry settings.
2688 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2690 To compute the correct values for width and height, first maximize the
2691 Emacs frame and then evaluate @code{(frame-height)} and
2692 @code{(frame-width)} with @kbd{M-:}.
2694 @c ------------------------------------------------------------
2695 @node Bugs and problems
2696 @chapter Bugs and problems
2697 @cindex Bugs and problems
2699 The Emacs manual lists some common kinds of trouble users could get
2700 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2701 Emacs Manual}, so you might look there if the problem you encounter
2702 isn't described in this chapter.  If you decide you've discovered a bug,
2703 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2704 instructions how to do that.
2706 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2707 known problems with building and using Emacs on specific platforms;
2708 type @kbd{C-h C-p} to read it.
2710 @menu
2711 * Problems with very large files::
2712 * ^M in the shell buffer::
2713 * Problems with Shell Mode::
2714 * Termcap/Terminfo entries for Emacs::
2715 * Errors with init files::
2716 * Emacs ignores X resources::
2717 * Emacs ignores frame parameters::
2718 * Editing files with $ in the name::
2719 * Shell mode loses the current directory::
2720 * Security risks with Emacs::
2721 * Dired claims that no file is on this line::
2722 @end menu
2724 @node Problems with very large files
2725 @section Does Emacs have problems with files larger than 8 megabytes?
2726 @cindex Very large files, opening
2727 @cindex Large files, opening
2728 @cindex Opening very large files
2729 @cindex Maximum file size
2730 @cindex Files, maximum size
2732 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2733 files larger than 8 megabytes.  In versions 19.29 and later, the maximum
2734 buffer size is at least @math{2^{27}-1}, or 134,217,727 bytes, or 132 MBytes.
2735 The maximum buffer size on 32-bit machines increased to 256 MBytes in
2736 Emacs 22, and again to 512 MBytes in Emacs 23.2.
2738 Emacs compiled on a 64-bit machine can handle much larger buffers.
2740 @node ^M in the shell buffer
2741 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2742 @cindex Shell buffer, echoed commands and @samp{^M} in
2743 @cindex Echoed commands in @code{shell-mode}
2745 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2746 make them go away.  If that doesn't work, you have several options:
2748 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2749 file:
2751 @example
2752 if ($?EMACS) then
2753     if ("$EMACS" =~ /*) then
2754         if ($?tcsh) unset edit
2755         stty nl
2756     endif
2757 endif
2758 @end example
2760 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2762 @example
2763 unset edit
2764 stty nl
2765 @end example
2767 Alternatively, use @code{csh} in your shell buffers instead of
2768 @code{tcsh}.  One way is:
2770 @lisp
2771 (setq explicit-shell-file-name "/bin/csh")
2772 @end lisp
2774 @noindent
2775 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2776 file:
2778 @example
2779 setenv ESHELL /bin/csh
2780 @end example
2782 @noindent
2783 (You must start Emacs over again with the environment variable properly
2784 set for this to take effect.)
2786 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2787 with the following Lisp form,
2789 @lisp
2790 (setenv "ESHELL" "/bin/csh")
2791 @end lisp
2793 The above solutions try to prevent the shell from producing the
2794 @samp{^M} characters in the first place.  If this is not possible
2795 (e.g., if you use a Windows shell), you can get Emacs to remove these
2796 characters from the buffer by adding this to your @file{.emacs} init
2797 file:
2799 @smalllisp
2800 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2801 @end smalllisp
2803 On a related note: if your shell is echoing your input line in the shell
2804 buffer, you might want to customize the @code{comint-process-echoes}
2805 variable in your shell buffers, or try the following command in your
2806 shell start-up file:
2808 @example
2809 stty -icrnl -onlcr -echo susp ^Z
2810 @end example
2812 @node Problems with Shell Mode
2813 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2815 @cindex Shell Mode, problems
2816 @cindex @code{explicit-shell-file-name}
2817 This might happen because Emacs tries to look for the shell in a wrong
2818 place.  If you know where your shell executable is, set the variable
2819 @code{explicit-shell-file-name} in your @file{.emacs} file to point to
2820 its full file name.
2822 @cindex Antivirus programs, and Shell Mode
2823 Some people have trouble with Shell Mode on MS-Windows because of
2824 intrusive antivirus software; disabling the resident antivirus program
2825 solves the problems in those cases.
2827 @node Termcap/Terminfo entries for Emacs
2828 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2829 @cindex Termcap
2830 @cindex Terminfo
2831 @cindex Emacs entries for termcap/terminfo
2833 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2834 the @samp{TERMCAP} environment variable of subshells.  It may help in
2835 certain situations (e.g., using rlogin from shell buffer) to add an
2836 entry for @samp{emacs} to the system-wide termcap file.  Here is a
2837 correct termcap entry for @samp{emacs}:
2839 @example
2840 emacs:tc=unknown:
2841 @end example
2843 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2844 @code{captoinfo}.  You need to generate
2845 @file{/usr/lib/terminfo/e/emacs}.  It may work to simply copy
2846 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2848 Having a termcap/terminfo entry will not enable the use of full screen
2849 programs in shell buffers.  Use @kbd{M-x term} for that instead.
2851 A workaround to the problem of missing termcap/terminfo entries is to
2852 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2853 in your shell start up file.  @code{csh} users could put this in their
2854 @file{.cshrc} files:
2856 @example
2857 if ("$term" == emacs) set term=dumb
2858 @end example
2860 @node Errors with init files
2861 @section Why does Emacs say @samp{Error in init file}?
2862 @cindex Error in @file{.emacs}
2863 @cindex Error in init file
2864 @cindex Init file, errors in
2865 @cindex @file{.emacs} file, errors in
2866 @cindex Debugging @file{.emacs} file
2868 An error occurred while loading either your @file{.emacs} file or the
2869 system-wide file @file{site-lisp/default.el}.  Emacs 21.1 and later pops the
2870 @file{*Messages*} buffer, and puts there some additional information
2871 about the error, to provide some hints for debugging.
2873 For information on how to debug your @file{.emacs} file, see
2874 @ref{Debugging a customization file}.
2876 It may be the case that you need to load some package first, or use a
2877 hook that will be evaluated after the package is loaded.  A common case
2878 of this is explained in @ref{Terminal setup code works after Emacs has
2879 begun}.
2881 @node Emacs ignores X resources
2882 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
2883 @cindex X resources being ignored
2884 @cindex Ignored X resources
2885 @cindex @file{.Xdefaults}
2887 As of version 19, Emacs searches for X resources in the files specified
2888 by the following environment variables:
2890 @itemize @bullet
2892 @item @code{XFILESEARCHPATH}
2893 @item @code{XUSERFILESEARCHPATH}
2894 @item @code{XAPPLRESDIR}
2896 @end itemize
2898 This emulates the functionality provided by programs written using the
2899 Xt toolkit.
2901 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
2902 of file names separated by colons.  @code{XAPPLRESDIR} should be a list
2903 of directory names separated by colons.
2905 Emacs searches for X resources:
2907 @enumerate
2909 @item
2910 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
2912 @item
2913 then in the value of the @samp{XENVIRONMENT} environment variable,
2915 @itemize @minus
2917 @item
2918 or if that is unset, in the file named
2919 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
2920 the name of the machine Emacs is running on),
2922 @end itemize
2924 @item
2925 then in the screen-specific and server-wide resource properties provided
2926 by the server,
2928 @itemize @minus
2930 @item
2931 or if those properties are unset, in the file named @file{~/.Xdefaults}
2932 if it exists,
2934 @end itemize
2936 @item
2937 then in the files listed in @samp{XUSERFILESEARCHPATH},
2939 @itemize @minus
2941 @item
2942 or in files named @file{@var{lang}/Emacs} in directories listed in
2943 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
2944 environment variable), if the @samp{LANG} environment variable is set,
2945 @item
2946 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
2947 @item
2948 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
2949 is set),
2950 @item
2951 or in @file{~/Emacs},
2953 @end itemize
2955 @item
2956 then in the files listed in  @code{XFILESEARCHPATH}.
2958 @end enumerate
2960 @node Emacs ignores frame parameters
2961 @section Why don't my customizations of the frame parameters work?
2962 @cindex Frame parameters
2964 This probably happens because you have set the frame parameters in the
2965 variable @code{initial-frame-alist}.  That variable holds parameters
2966 used only for the first frame created when Emacs starts.  To customize
2967 the parameters of all frames, change the variable
2968 @code{default-frame-alist} instead.
2970 These two variables exist because many users customize the initial frame
2971 in a special way.  For example, you could determine the position and
2972 size of the initial frame, but would like to control the geometry of the
2973 other frames by individually positioning each one of them.
2976 @node Editing files with $ in the name
2977 @section How do I edit a file with a @samp{$} in its name?
2978 @cindex Editing files with @samp{$} in the name
2979 @cindex @samp{$} in file names
2980 @cindex File names containing @samp{$}, editing
2982 When entering a file name in the minibuffer, Emacs will attempt to expand
2983 a @samp{$} followed by a word as an environment variable.  To suppress
2984 this behavior, type @kbd{$$} instead.
2986 @node Shell mode loses the current directory
2987 @section Why does shell mode lose track of the shell's current directory?
2988 @cindex Current directory and @code{shell-mode}
2989 @cindex @code{shell-mode} and current directory
2990 @cindex Directory, current in @code{shell-mode}
2992 Emacs has no way of knowing when the shell actually changes its
2993 directory.  This is an intrinsic limitation of Unix.  So it tries to
2994 guess by recognizing @samp{cd} commands.  If you type @kbd{cd} followed
2995 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
2996 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
2997 correctly guess the shell's new current directory.  A huge variety of
2998 fixes and enhancements to shell mode for this problem have been written
2999 to handle this problem (@pxref{Finding a package with particular
3000 functionality}).
3002 You can tell Emacs the shell's current directory with the command
3003 @kbd{M-x dirs}.
3005 @node Security risks with Emacs
3006 @section Are there any security risks in Emacs?
3007 @cindex Security with Emacs
3008 @cindex @samp{movemail} and security
3009 @cindex @code{file-local-variable} and security
3010 @cindex Synthetic X events and security
3011 @cindex X events and security
3013 @itemize @bullet
3015 @item
3016 The @file{movemail} incident.  (No, this is not a risk.)
3018 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3019 chapter 4.  The site at LBL had installed the @file{/etc/movemail}
3020 program setuid root.  (As of version 19, @file{movemail} is in your
3021 architecture-specific directory; type @kbd{C-h v exec-directory
3022 @key{RET}} to see what it is.)  Since @code{movemail} had not been
3023 designed for this situation, a security hole was created and users could
3024 get root privileges.
3026 @code{movemail} has since been changed so that this security hole will
3027 not exist, even if it is installed setuid root.  However,
3028 @code{movemail} no longer needs to be installed setuid root, which
3029 should eliminate this particular risk.
3031 We have heard unverified reports that the 1988 Internet worm took
3032 advantage of this configuration problem.
3034 @item
3035 The @code{file-local-variable} feature.  (Yes, a risk, but easy to
3036 change.)
3038 There is an Emacs feature that allows the setting of local values for
3039 variables when editing a file by including specially formatted text near
3040 the end of the file.  This feature also includes the ability to have
3041 arbitrary Emacs Lisp code evaluated when the file is visited.
3042 Obviously, there is a potential for Trojan horses to exploit this
3043 feature.
3045 As of Emacs 22, Emacs has a list of local variables that are known to
3046 be safe to set.  If a file tries to set any variable outside this
3047 list, it asks the user to confirm whether the variables should be set.
3048 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
3049 code found at the bottom of files by setting the variable
3050 @code{enable-local-eval}.
3052 @xref{File Variables,,, emacs, The GNU Emacs Manual}.
3054 @item
3055 Synthetic X events.  (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3056 better.)
3058 Emacs accepts synthetic X events generated by the @code{SendEvent}
3059 request as though they were regular events.  As a result, if you are
3060 using the trivial host-based authentication, other users who can open X
3061 connections to your X workstation can make your Emacs process do
3062 anything, including run other processes with your privileges.
3064 The only fix for this is to prevent other users from being able to open
3065 X connections.  The standard way to prevent this is to use a real
3066 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}.  If using
3067 the @code{xauth} program has any effect, then you are probably using
3068 @samp{MIT-MAGIC-COOKIE-1}.  Your site may be using a superior
3069 authentication method; ask your system administrator.
3071 If real authentication is not a possibility, you may be satisfied by
3072 just allowing hosts access for brief intervals while you start your X
3073 programs, then removing the access.  This reduces the risk somewhat by
3074 narrowing the time window when hostile users would have access, but
3075 @emph{does not eliminate the risk}.
3077 On most computers running Unix and X, you enable and disable
3078 access using the @code{xhost} command.  To allow all hosts access to
3079 your X server, use
3081 @example
3082 xhost +
3083 @end example
3085 @noindent
3086 at the shell prompt, which (on an HP machine, at least) produces the
3087 following message:
3089 @example
3090 access control disabled, clients can connect from any host
3091 @end example
3093 To deny all hosts access to your X server (except those explicitly
3094 allowed by name), use
3096 @example
3097 xhost -
3098 @end example
3100 On the test HP computer, this command generated the following message:
3102 @example
3103 access control enabled, only authorized clients can connect
3104 @end example
3106 @end itemize
3108 @node Dired claims that no file is on this line
3109 @section Dired says, @samp{no file on this line} when I try to do something.
3110 @cindex Dired does not see a file
3112 Dired uses a regular expression to find the beginning of a file name.
3113 In a long Unix-style directory listing (@samp{ls -l}), the file name
3114 starts after the date.  The regexp has thus been written to look for the
3115 date.  By default, it should understand dates and times regardless of
3116 the language, but if your directory listing has an unusual format, Dired
3117 may get confused.
3119 There are two approaches to solving this.  The first one involves
3120 setting things up so that @samp{ls -l} outputs a more standard format.
3121 See your OS manual for more information.
3123 The second approach involves changing the regular expression used by
3124 dired, @code{directory-listing-before-filename-regexp}.
3126 @c ------------------------------------------------------------
3127 @node Compiling and installing Emacs
3128 @chapter    Compiling and installing Emacs
3129 @cindex    Compiling and installing Emacs
3131 @menu
3132 * Installing Emacs::
3133 * Problems building Emacs::
3134 @end menu
3136 @node Installing Emacs
3137 @section How do I install Emacs?
3138 @cindex Installing Emacs
3139 @cindex Unix systems, installing Emacs on
3140 @cindex Downloading and installing Emacs
3141 @cindex Building Emacs from source
3142 @cindex Source code, building Emacs from
3144 This answer is meant for users of Unix and Unix-like systems.  Users of
3145 other operating systems should see the series of questions beginning
3146 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3147 and binaries, and how to install Emacs on those systems.
3149 Most GNU/Linux distributions provide pre-built Emacs packages.
3150 If Emacs is not installed already, you can install it by running (as
3151 root) a command such as @samp{yum install emacs} (Red Hat and
3152 derivatives) or @samp{apt-get install emacs} (Debian and derivatives).
3154 If you want to compile Emacs yourself, read the file @file{INSTALL} in
3155 the source distribution.  In brief:
3157 @itemize @bullet
3159 @item
3160 First download the Emacs sources.  @xref{Current GNU distributions}, for
3161 a list of ftp sites that make them available.  On @file{ftp.gnu.org},
3162 the main GNU distribution site, sources are available as
3164 @c Don't include VER in the file name, because pretests are not there.
3165 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
3167 (Replace @samp{VERSION} with the relevant version number, e.g., @samp{23.1}.)
3169 @item
3170 Next uncompress and extract the source files.  This requires
3171 the @code{gzip} and @code{tar} programs, which are standard utilities.
3172 If your system does not have them, these can also be downloaded from
3173 @file{ftp.gnu.org}.
3175 GNU @code{tar} can uncompress and extract in a single-step:
3177 @example
3178 tar -zxvf emacs-VERSION.tar.gz
3179 @end example
3181 @item
3182 At this point, the Emacs sources should be sitting in a directory called
3183 @file{emacs-VERSION}.  On most common Unix and Unix-like systems,
3184 you should be able to compile Emacs with the following commands:
3186 @example
3187 cd emacs-VERSION
3188 ./configure         # configure Emacs for your particular system
3189 make                # use Makefile to build components, then Emacs
3190 @end example
3192 If the @code{make} completes successfully, the odds are fairly good that
3193 the build has gone well.  (@xref{Problems building Emacs}, if you weren't
3194 successful.)
3196 @item
3197 By default, Emacs is installed in @file{/usr/local}.  To actually
3198 install files, become the superuser and type
3200 @example
3201 make install
3202 @end example
3204 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3205 and any Emacs Info files that might be in @file{/usr/local/share/info/}.
3207 @end itemize
3209 @node Problems building Emacs
3210 @section What should I do if I have trouble building Emacs?
3211 @cindex Problems building Emacs
3212 @cindex Errors when building Emacs
3214 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3215 source) to see if there is already a solution for your problem.  Next,
3216 look for other questions in this FAQ that have to do with Emacs
3217 installation and compilation problems.
3219 If you'd like to have someone look at your problem and help solve it,
3220 see @ref{Help installing Emacs}.
3222 If you cannot find a solution in the documentation, please report the
3223 problem (@pxref{Reporting bugs}).
3226 @c ------------------------------------------------------------
3227 @node Finding Emacs and related packages
3228 @chapter Finding Emacs and related packages
3229 @cindex Finding Emacs and related packages
3231 @menu
3232 * Finding Emacs on the Internet::
3233 * Finding a package with particular functionality::
3234 * Packages that do not come with Emacs::
3235 * Spell-checkers::
3236 * Current GNU distributions::
3237 * Difference between Emacs and XEmacs::
3238 * Emacs for minimalists::
3239 * Emacs for MS-DOS::
3240 * Emacs for MS-Windows::
3241 * Emacs for GNUstep::
3242 * Emacs for Mac OS X::
3243 @end menu
3245 @node Finding Emacs on the Internet
3246 @section Where can I get Emacs on the net?
3247 @cindex Finding Emacs on the Internet
3248 @cindex Downloading Emacs
3250 Information on downloading Emacs is available at
3251 @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}.
3253 @xref{Installing Emacs}, for information on how to obtain and build the latest
3254 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3255 archive sites that make GNU software available.
3257 @node Finding a package with particular functionality
3258 @section How do I find a Emacs Lisp package that does XXX?
3259 @cindex Package, finding
3260 @cindex Finding an Emacs Lisp package
3261 @cindex Functionality, finding a particular package
3263 First of all, you should check to make sure that the package isn't
3264 already available.  For example, typing @kbd{M-x apropos @key{RET}
3265 python @key{RET}} lists all functions and variables containing the
3266 string @samp{python}.
3268 It is also possible that the package is on your system, but has not been
3269 loaded.  To see which packages are available for loading, look through
3270 your computer's lisp directory (@pxref{File-name conventions}).  The Lisp
3271 source to most packages contains a short description of how they
3272 should be loaded, invoked, and configured---so before you use or
3273 modify a Lisp package, see if the author has provided any hints in the
3274 source code.
3276 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3277 the constituent Emacs packages.
3279 For advice on how to find extra packages that are not part of Emacs,
3280 see @ref{Packages that do not come with Emacs}.
3282 @c Note that M-x view-external-packages references this node.
3283 @node Packages that do not come with Emacs
3284 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3285 @cindex Unbundled packages
3286 @cindex Finding other packages
3287 @cindex Lisp packages that do not come with Emacs
3288 @cindex Packages, those that do not come with Emacs
3289 @cindex Emacs Lisp List
3290 @cindex Emacs Lisp Archive
3292 The easiest way to add more features to your Emacs is to use the
3293 command @kbd{M-x list-packages}.  This contacts the
3294 @uref{http:///elpa.gnu.org, GNU ELPA} (``Emacs Lisp Package Archive'')
3295 server and fetches the list of additional packages that it offers.
3296 These are GNU packages that are available for use with Emacs, but are
3297 distributed separately from Emacs itself, for reasons of space, etc.
3298 You can browse the resulting @file{*Packages*} buffer to see what is
3299 available, and then Emacs can automatically download and install the
3300 packages that you select.  @xref{Packages,,, emacs, The GNU Emacs Manual}.
3302 There are other, non-GNU, Emacs Lisp package servers, including:
3303 @uref{http://melpa.milkbox.net, MELPA}; and
3304 @uref{http://marmalade-repo.org, Marmalade}.  To use additional
3305 package servers, customize the @code{package-archives} variable.
3306 Be aware that installing a package can run arbitrary code, so only add
3307 sources that you trust.
3309 The @uref{https://lists.gnu.org/mailman/listinfo/gnu-emacs-sources,
3310 GNU Emacs sources mailing list}, which is gatewayed to the
3311 @uref{news:gnu.emacs.sources, Emacs sources newsgroup} (although the
3312 connection between the two can be unreliable) is an official place
3313 where people can post or announce their extensions to Emacs.
3315 The @uref{http://emacswiki.org, Emacs Wiki} contains pointers to some
3316 additional extensions.  @uref{http://wikemacs.org, WikEmacs} is an
3317 alternative wiki for Emacs.
3319 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs
3320 Lisp List (ELL)}, has pointers to many Emacs Lisp files, but at time
3321 of writing it is no longer being updated.
3323 It is impossible for us to list here all the sites that offer Emacs
3324 Lisp packages.  If you are interested in a specific feature, then
3325 after checking Emacs itself and GNU ELPA, a web search is often the
3326 best way to find results.
3328 @node Spell-checkers
3329 @section Spell-checkers
3330 @cindex Spell-checker
3331 @cindex Checking spelling
3332 @cindex Ispell
3333 @cindex Aspell
3334 @cindex Hunspell
3336 Various spell-checkers are compatible with Emacs, including:
3338 @table @b
3340 @item GNU Aspell
3341 @uref{http://aspell.net/}
3343 @item Ispell
3344 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3346 @item Hunspell
3347 @uref{http://hunspell.sourceforge.net/}
3349 @end table
3351 @node Current GNU distributions
3352 @section Where can I get other up-to-date GNU stuff?
3353 @cindex Current GNU distributions
3354 @cindex Sources for current GNU distributions
3355 @cindex Stuff, current GNU
3356 @cindex Up-to-date GNU stuff
3357 @cindex Finding current GNU software
3358 @cindex Official GNU software sites
3360 The most up-to-date official GNU software is normally kept at
3362 @uref{ftp://ftp.gnu.org/pub/gnu}
3364 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3366 @uref{http://www.gnu.org/order/ftp.html}
3368 @node Difference between Emacs and XEmacs
3369 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3370 @cindex XEmacs
3371 @cindex Difference Emacs and XEmacs
3372 @cindex Lucid Emacs
3373 @cindex Epoch
3375 XEmacs is a branch version of Emacs.  It was first called Lucid Emacs,
3376 and was initially derived from a prerelease version of Emacs 19.  In
3377 this FAQ, we use the name ``Emacs'' only for the official version.
3379 Emacs and XEmacs each come with Lisp packages that are lacking in the
3380 other.  The two versions have some significant differences at the Lisp
3381 programming level.  Their current features are roughly comparable,
3382 though the support for some operating systems, character sets and
3383 specific packages might be quite different.
3385 Some XEmacs code has been contributed to Emacs, and we would like to
3386 use other parts, but the earlier XEmacs maintainers did not always
3387 keep track of the authors of contributed code, which makes it
3388 impossible for the FSF to get copyright papers signed for that code.
3389 (The FSF requires these papers for all the code included in the Emacs
3390 release, aside from generic C support packages that retain their
3391 separate identity and are not integrated into the code of Emacs
3392 proper.)
3394 If you want to talk about these two versions and distinguish them,
3395 please call them ``Emacs'' and ``XEmacs.''  To contrast ``XEmacs''
3396 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3397 origin in the work of the GNU Project.  Terms such as ``Emacsen'' and
3398 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3399 is better to write ``Emacs and XEmacs.''
3401 @node Emacs for minimalists
3402 @section I don't have enough disk space to install Emacs
3403 @cindex Zile
3404 @cindex Not enough disk space to install Emacs
3406 GNU Zile is a lightweight Emacs clone.  Zile is short for @samp{Zile Is
3407 Lossy Emacs}.  It has all of Emacs's basic editing features.  The Zile
3408 binary typically has a size of about 130 kbytes, so this can be useful
3409 if you are in an extremely space-restricted environment.  More
3410 information is available from
3412 @uref{http://www.gnu.org/software/zile/}
3415 @node Emacs for MS-DOS
3416 @section Where can I get Emacs for MS-DOS?
3417 @cindex MS-DOS, Emacs for
3418 @cindex DOS, Emacs for
3419 @cindex Compiling Emacs for DOS
3420 @cindex Emacs for MS-DOS
3422 To build Emacs from source for MS-DOS, see the instructions in the file
3423 @file{msdos/INSTALL} in the distribution.  The DOS port builds and runs
3424 on plain DOS, and also on all versions of MS-Windows from version 3.X
3425 onwards, including Windows XP and Vista.
3427 The file @file{etc/PROBLEMS} contains some additional information
3428 regarding Emacs under MS-DOS.
3430 A pre-built binary distribution of the old Emacs 20 is available, as
3431 described at
3433 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3435 For a list of other MS-DOS implementations of Emacs (and Emacs
3436 look-alikes), consult the list of ``Emacs implementations and literature,''
3437 available at
3439 @uref{http://www.finseth.com/emacs.html}
3441 Note that while many of these programs look similar to Emacs, they often
3442 lack certain features, such as the Emacs Lisp extension language.
3444 @node Emacs for MS-Windows
3445 @section Where can I get Emacs for Microsoft Windows?
3446 @cindex FAQ for Emacs on MS-Windows
3447 @cindex Emacs for MS-Windows
3448 @cindex Microsoft Windows, Emacs for
3450 There is a separate FAQ for Emacs on MS-Windows,
3451 @pxref{Top,,,efaq-w32,FAQ for Emacs on MS Windows}.
3452 For MS-DOS, @pxref{Emacs for MS-DOS}.
3455 @node Emacs for GNUstep
3456 @section Where can I get Emacs for GNUstep?
3457 @cindex GNUstep, Emacs for
3459 Beginning with version 23.1, Emacs supports GNUstep natively.
3460 See the file @file{nextstep/INSTALL} in the distribution.
3462 @node Emacs for Mac OS X
3463 @section Where can I get Emacs for Mac OS X?
3464 @cindex Apple computers, Emacs for
3465 @cindex Macintosh, Emacs for
3466 @cindex Mac OS X, Emacs for
3468 Beginning with version 22.1, Emacs supports Mac OS X natively.
3469 See the file @file{nextstep/INSTALL} in the distribution.
3471 @c ------------------------------------------------------------
3472 @node Key bindings
3473 @chapter Key bindings
3474 @cindex Key bindings
3476 @menu
3477 * Binding keys to commands::
3478 * Invalid prefix characters::
3479 * Terminal setup code works after Emacs has begun::
3480 * Working with function and arrow keys::
3481 * X key translations for Emacs::
3482 * Backspace invokes help::
3483 * Swapping keys::
3484 * Producing C-XXX with the keyboard::
3485 * No Meta key::
3486 * No Escape key::
3487 * Compose Character::
3488 * Binding combinations of modifiers and function keys::
3489 * Meta key does not work in xterm::
3490 * ExtendChar key does not work as Meta::
3491 * SPC no longer completes file names::
3492 @end menu
3494 @node Binding keys to commands
3495 @section How do I bind keys (including function keys) to commands?
3496 @cindex Binding keys to commands
3497 @cindex Keys, binding to commands
3498 @cindex Commands, binding keys to
3500 Keys can be bound to commands either interactively or in your
3501 @file{.emacs} file.  To interactively bind keys for all modes, type
3502 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3504 To bind a key just in the current major mode, type @kbd{M-x
3505 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3507 @xref{Key Bindings,,, emacs, The GNU Emacs Manual}.
3509 To make the process of binding keys interactively easier, use the
3510 following ``trick'': First bind the key interactively, then immediately
3511 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}.  Now, the command needed
3512 to bind the key is in the kill ring, and can be yanked into your
3513 @file{.emacs} file.  If the key binding is global, no changes to the
3514 command are required.  For example,
3516 @lisp
3517 (global-set-key (quote [f1]) (quote help-for-help))
3518 @end lisp
3520 @noindent
3521 can be placed directly into the @file{.emacs} file.  If the key binding is
3522 local, the command is used in conjunction with the @samp{add-hook} function.
3523 For example, in TeX mode, a local binding might be
3525 @lisp
3526 (add-hook 'tex-mode-hook
3527   (lambda ()
3528    (local-set-key (quote [f1]) (quote help-for-help))))
3529 @end lisp
3532 @itemize @bullet
3534 @item
3535 Control characters in key sequences, in the form yanked from the kill
3536 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3537 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc.  You may want
3538 to convert these into their vector or string forms.
3540 @item
3541 If a prefix key of the character sequence to be bound is already
3542 bound as a complete key, then you must unbind it before the new
3543 binding.  For example, if @kbd{ESC @{} is previously bound:
3545 @lisp
3546 (global-unset-key [?\e ?@{])   ;;   or
3547 (local-unset-key [?\e ?@{])
3548 @end lisp
3550 @item
3551 Aside from commands and ``lambda lists,'' a vector or string also
3552 can be bound to a key and thus treated as a macro.  For example:
3554 @lisp
3555 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g])  ;;  or
3556 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3557 @end lisp
3559 @end itemize
3561 @node Invalid prefix characters
3562 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3563 @cindex Prefix characters, invalid
3564 @cindex Invalid prefix characters
3565 @cindex Misspecified key sequences
3567 Usually, one of two things has happened.  In one case, the control
3568 character in the key sequence has been misspecified (e.g., @samp{C-f}
3569 used instead of @samp{\C-f} within a Lisp expression).  In the other
3570 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3571 was already bound as a @dfn{complete key}.  Historically, the @samp{ESC [}
3572 prefix was usually the problem, in which case you should evaluate either
3573 of these forms before attempting to bind the key sequence:
3575 @lisp
3576 (global-unset-key [?\e ?[])  ;;  or
3577 (global-unset-key "\e[")
3578 @end lisp
3580 @node Terminal setup code works after Emacs has begun
3581 @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?
3582 @cindex Terminal setup code in @file{.emacs}
3584 During startup, Emacs initializes itself according to a given code/file
3585 order.  If some of the code executed in your @file{.emacs} file needs to
3586 be postponed until the initial terminal or window-system setup code has
3587 been executed but is not, then you will experience this problem (this
3588 code/file execution order is not enforced after startup).
3590 To postpone the execution of Emacs Lisp code until after terminal or
3591 window-system setup, treat the code as a @dfn{lambda list} and add it to
3592 @code{emacs-startup-hook} (or @code{tty-setup-hook} in Emacs 24.4 and
3593 newer).  For example,
3595 @lisp
3596 (add-hook 'emacs-startup-hook
3597           (lambda ()
3598            (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3599              ;; Make vt220's "Do" key behave like M-x:
3600              (global-set-key [do] 'execute-extended-command))))
3601 @end lisp
3603 For information on what Emacs does every time it is started, see the
3604 @file{lisp/startup.el} file.
3606 @node Working with function and arrow keys
3607 @section How do I tell what characters or symbols my function or arrow keys emit?
3608 @cindex Working with arrow keys
3609 @cindex Arrow keys, symbols generated by
3610 @cindex Working with function keys
3611 @cindex Function keys, symbols generated by
3612 @cindex Symbols generated by function keys
3614 Type @kbd{C-h c} then the function or arrow keys.  The command will
3615 return either a function key symbol or character sequence (see the
3616 Emacs documentation for an explanation).  This works for other
3617 keys as well.
3619 @node X key translations for Emacs
3620 @section How do I set the X key ``translations'' for Emacs?
3621 @cindex X key translations
3622 @cindex Key translations under X
3623 @cindex Translations for keys under X
3625 Emacs is not written using the Xt library by default, so there are no
3626 ``translations'' to be set.  (We aren't sure how to set such translations
3627 if you do build Emacs with Xt; please let us know if you've done this!)
3629 The only way to affect the behavior of keys within Emacs is through
3630 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs).  The
3631 @code{define-key} command should be used in conjunction with the
3632 @code{function-key-map} map.  For instance,
3634 @lisp
3635 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3636 @end lisp
3638 @noindent
3639 defines the @kbd{M-@key{TAB}} key sequence.
3641 @node Backspace invokes help
3642 @section Why does the @key{Backspace} key invoke help?
3643 @cindex Backspace key invokes help
3644 @cindex Help invoked by Backspace
3645 @cindex DEL key does not delete
3647 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
3648 @kbd{C-h} sends the same code.  In Emacs by default @kbd{C-h} invokes
3649 help-command.  This is intended to be easy to remember since the first
3650 letter of @samp{help} is @samp{h}.  The easiest solution to this problem
3651 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
3652 @key{Delete} key) for deleting the previous character.
3654 For many people this solution may be problematic:
3656 @itemize @bullet
3658 @item
3659 They normally use @key{Backspace} outside of Emacs for deleting the
3660 previous character.  This can be solved by making @key{DEL} the command
3661 for deleting the previous character outside of Emacs.  On many Unix
3662 systems, this command will remap @key{DEL}:
3664 @example
3665 stty erase `^?'
3666 @end example
3668 @item
3669 The user may prefer the @key{Backspace} key for deleting the
3670 previous character because it is more conveniently located on their
3671 keyboard or because they don't even have a separate @key{Delete} key.
3672 In this case, the @key{Backspace} key should be made to behave like
3673 @key{Delete}.  There are several methods.
3675 @itemize @minus
3676 @item
3677 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
3678 TeraTerm) allow the character generated by the @key{Backspace} key to be
3679 changed from a setup menu.
3681 @item
3682 You may be able to get a keyboard that is completely programmable, or a
3683 terminal emulator that supports remapping of any key to any other key.
3685 @item
3686 With Emacs 21.1 and later, you can control the effect of the
3687 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
3688 windowed displays, by customizing the option
3689 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
3690 normal-erase-is-backspace}.  See the documentation of these symbols
3691 (@pxref{Emacs Lisp documentation}) for more info.
3693 @item
3694 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
3695 Emacs:
3697 @lisp
3698 (keyboard-translate ?\C-h ?\C-?)
3699 @end lisp
3701 @noindent
3702 This is the recommended method of forcing @key{Backspace} to act as
3703 @key{DEL}, because it works even in modes which bind @key{DEL} to
3704 something other than @code{delete-backward-char}.
3706 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
3707 default deletes forward:
3709 @lisp
3710 (keyboard-translate ?\C-? ?\C-d)
3711 @end lisp
3713 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
3715 @item
3716 Another approach is to switch key bindings and put help on @kbd{C-x h}
3717 instead:
3719 @lisp
3720 (global-set-key "\C-h" 'delete-backward-char)
3722 ;; overrides mark-whole-buffer
3723 (global-set-key "\C-xh" 'help-command)
3724 @end lisp
3726 @noindent
3727 This method is not recommended, though: it only solves the problem for
3728 those modes which bind @key{DEL} to @code{delete-backward-char}.  Modes
3729 which bind @key{DEL} to something else, such as @code{view-mode}, will
3730 not work as you expect when you press the @key{Backspace} key.  For this
3731 reason, we recommend the @code{keyboard-translate} method, shown
3732 above.
3734 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
3735 @end itemize
3737 Don't try to bind @key{DEL} to @code{help-command}, because there are
3738 many modes that have local bindings of @key{DEL} that will interfere.
3740 @end itemize
3742 When Emacs 21 or later runs on a windowed display, it binds the
3743 @key{Delete} key to a command which deletes the character at point, to
3744 make Emacs more consistent with keyboard operation on these systems.
3746 For more information about troubleshooting this problem, see @ref{DEL
3747 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
3748 Manual}.
3750 @node Swapping keys
3751 @section How do I swap two keys?
3752 @cindex Swapping keys
3753 @cindex Keys, swapping
3754 @cindex @code{keyboard-translate}
3756 You can swap two keys (or key sequences) by using the
3757 @code{keyboard-translate} function.  For example, to turn @kbd{C-h}
3758 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
3760 @lisp
3761 (keyboard-translate ?\C-h ?\C-?)  ; translate `C-h' to DEL
3762 (keyboard-translate ?\C-? ?\C-h)  ; translate DEL to `C-h'.
3763 @end lisp
3765 @noindent
3766 The first key sequence of the pair after the function identifies what is
3767 produced by the keyboard; the second, what is matched for in the
3768 keymaps.
3770 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
3771 toggle @code{normal-erase-is-backspace-mode} instead of calling
3772 @code{keyboard-translate}.
3773 @xref{DEL Does Not Delete,,, emacs, The GNU Emacs Manual}.
3775 Keyboard translations are not the same as key bindings in keymaps.
3776 Emacs contains numerous keymaps that apply in different situations, but
3777 there is only one set of keyboard translations, and it applies to every
3778 character that Emacs reads from the terminal.  Keyboard translations
3779 take place at the lowest level of input processing; the keys that are
3780 looked up in keymaps contain the characters that result from keyboard
3781 translation.
3783 @node Producing C-XXX with the keyboard
3784 @section How do I produce C-XXX with my keyboard?
3785 @cindex Producing control characters
3786 @cindex Generating control characters
3787 @cindex Control characters, generating
3789 On terminals (but not under X), some common ``aliases'' are:
3791 @table @asis
3793 @item @kbd{C-2}  or  @kbd{C-@key{SPC}}
3794 @kbd{C-@@}
3796 @item @kbd{C-6}
3797 @kbd{C-^}
3799 @item @kbd{C-7}  or  @kbd{C-S--}
3800 @kbd{C-_}
3802 @item @kbd{C-4}
3803 @kbd{C-\}
3805 @item @kbd{C-5}
3806 @kbd{C-]}
3808 @item @kbd{C-/}
3809 @kbd{C-?}
3811 @end table
3813 Often other aliases exist; use the @kbd{C-h c} command and try
3814 @key{CTRL} with all of the digits on your keyboard to see what gets
3815 generated.  You can also try the @kbd{C-h w} command if you know the
3816 name of the command.
3818 @node No Meta key
3819 @section What if I don't have a @key{Meta} key?
3820 @cindex No @key{Meta} key
3821 @cindex @key{Meta} key, what to do if you lack it
3823 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
3825 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}.  In fact,
3826 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
3827 (depending on the value of @code{meta-prefix-char}).  Note that you
3828 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
3829 @key{ESC}, release it, and then press @key{a}.
3831 @node No Escape key
3832 @section What if I don't have an @key{Escape} key?
3833 @cindex No Escape key
3834 @cindex Lacking an Escape key
3835 @cindex Escape key, lacking
3837 Type @kbd{C-[} instead.  This should send @acronym{ASCII} code 27 just like an
3838 Escape key would.  @kbd{C-3} may also work on some terminal (but not
3839 under X).  For many terminals (notably DEC terminals) @key{F11}
3840 generates @key{ESC}.  If not, the following form can be used to bind it:
3842 @lisp
3843 ;; F11 is the documented ESC replacement on DEC terminals.
3844 (define-key function-key-map [f11] [?\e])
3845 @end lisp
3847 @node Compose Character
3848 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
3849 @cindex @key{Compose Character} key, using as @key{Meta}
3850 @cindex @key{Meta}, using @key{Compose Character} for
3852 On a dumb terminal such as a VT220, no.  It is rumored that certain
3853 VT220 clones could have their @key{Compose} key configured this way.  If
3854 you're using X, you might be able to do this with the @code{xmodmap}
3855 command.
3857 @node Binding combinations of modifiers and function keys
3858 @section How do I bind a combination of modifier key and function key?
3859 @cindex Modifiers and function keys
3860 @cindex Function keys and modifiers
3861 @cindex Binding modifiers and function keys
3863 You can represent modified function keys in vector format by adding
3864 prefixes to the function key symbol.  For example (from the Emacs
3865 documentation):
3867 @lisp
3868 (global-set-key [?\C-x right] 'forward-page)
3869 @end lisp
3871 @noindent
3872 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
3874 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
3875 @key{Super}, @key{Alt}, and @key{Shift} with function keys.  To
3876 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
3877 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name.  Here
3878 is how to make @kbd{H-M-RIGHT} move forward a word:
3880 @lisp
3881 (global-set-key [H-M-right] 'forward-word)
3882 @end lisp
3884 @itemize @bullet
3886 @item
3887 Not all modifiers are permitted in all situations.  @key{Hyper},
3888 @key{Super}, and @key{Alt} are not available on Unix character
3889 terminals.  Non-@acronym{ASCII} keys and mouse events (e.g., @kbd{C-=} and
3890 @kbd{Mouse-1}) also fall under this category.
3892 @end itemize
3894 @xref{Binding keys to commands}, for general key binding instructions.
3896 @node Meta key does not work in xterm
3897 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
3898 @cindex @key{Meta} key and @code{xterm}
3899 @cindex Xterm and @key{Meta} key
3901 @xref{Unibyte Mode,, Single-Byte Character Set Support, emacs, The GNU Emacs Manual}.
3903 If the advice in the Emacs manual fails, try all of these methods before
3904 asking for further help:
3906 @itemize @bullet
3908 @item
3909 You may have big problems using @code{mwm} as your window manager.
3910 (Does anyone know a good generic solution to allow the use of the
3911 @key{Meta} key in Emacs with @file{mwm}?)
3913 @item
3914 For X11: Make sure it really is a @key{Meta} key.  Use @code{xev} to
3915 find out what keysym your @key{Meta} key generates.  It should be either
3916 @code{Meta_L} or @code{Meta_R}.  If it isn't, use @file{xmodmap} to fix
3917 the situation.  If @key{Meta} does generate @code{Meta_L} or
3918 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
3919 your @file{~/.Xdefaults} file:
3921 @example
3922  XTerm*eightBitInput:   false
3923  XTerm*eightBitOutput:  true
3924 @end example
3926 @item
3927 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
3928 characters.  @samp{stty -a} (or @samp{stty everything}) should show
3929 @samp{cs8} somewhere.  If it shows @samp{cs7} instead, use @samp{stty
3930 cs8 -istrip} (or @samp{stty pass8}) to fix it.
3932 @item
3933 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
3934 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
3935 of every character.
3937 @item
3938 If Emacs is running on Ultrix, it is reported that evaluating
3939 @code{(set-input-mode t nil)} helps.
3941 @item
3942 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
3943 you type @kbd{M-W}, which is the same conversion Emacs would make if it
3944 got the @kbd{M-W} anyway.  In X11R4, the following resource
3945 specification will do this:
3947 @example
3948 XTerm.VT100.EightBitInput: false
3949 @end example
3951 @noindent
3952 (This changes the behavior of the @code{insert-eight-bit} action.)
3954 With older @code{xterm}s, you can specify this behavior with a translation:
3956 @example
3957 XTerm.VT100.Translations: #override \
3958   Meta<KeyPress>: string(0x1b) insert()
3959 @end example
3961 @noindent
3962 You might have to replace @samp{Meta} with @samp{Alt}.
3964 @end itemize
3966 @node ExtendChar key does not work as Meta
3967 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
3968 @cindex @key{ExtendChar} key as @key{Meta}
3969 @cindex @key{Meta}, using @key{ExtendChar} for
3970 @cindex HP-UX, the @key{ExtendChar} key
3972 This is a result of an internationalization extension in X11R4 and the
3973 fact that HP is now using this extension.  Emacs assumes that the
3974 @code{XLookupString} function returns the same result regardless of the
3975 @key{Meta} key state which is no longer necessarily true.  Until Emacs
3976 is fixed, the temporary kludge is to run this command after each time
3977 the X server is started but preferably before any xterm clients are:
3979 @example
3980 xmodmap -e 'remove mod1 = Mode_switch'
3981 @end example
3983 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
3984 @c solved?
3986 This will disable the use of the extra keysyms systemwide, which may be
3987 undesirable if you actually intend to use them.
3989 @node SPC no longer completes file names
3990 @section Why doesn't SPC complete file names anymore?
3991 @cindex @kbd{SPC} file name completion
3993 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
3994 the minibuffer, so that file names with embedded spaces could be typed
3995 without the need to quote the spaces.
3997 You can get the old behavior by binding @kbd{SPC} to
3998 @code{minibuffer-complete-word} in the minibuffer, as follows:
4000 @lisp
4001 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
4002   'minibuffer-complete-word)
4004 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4005   'minibuffer-complete-word)
4006 @end lisp
4008 @c ------------------------------------------------------------
4009 @node Alternate character sets
4010 @chapter Alternate character sets
4011 @cindex Alternate character sets
4013 @menu
4014 * Emacs does not display 8-bit characters::
4015 * Inputting eight-bit characters::
4016 * Right-to-left alphabets::
4017 * How to add fonts::
4018 @end menu
4020 @node Emacs does not display 8-bit characters
4021 @section How do I make Emacs display 8-bit characters?
4022 @cindex Displaying eight-bit characters
4023 @cindex Eight-bit characters, displaying
4025 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4026 Emacs Manual}.  On a Unix, when Emacs runs on a text-only terminal
4027 display or is invoked with @samp{emacs -nw}, you typically need to use
4028 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4029 display, even after setting the language environment; otherwise
4030 non-@acronym{ASCII} characters will display as @samp{?}.  On other operating
4031 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4032 character set supported by the display, and sets up the required
4033 terminal coding system automatically.
4035 @node Inputting eight-bit characters
4036 @section How do I input eight-bit characters?
4037 @cindex Entering eight-bit characters
4038 @cindex Eight-bit characters, entering
4039 @cindex Input, 8-bit characters
4041 Various methods are available for input of eight-bit characters.
4042 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4043 Emacs Manual}.  For more sophisticated methods,
4044 @pxref{Input Methods,,, emacs, The GNU Emacs Manual}.
4046 @node Right-to-left alphabets
4047 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4048 @cindex Right-to-left alphabets
4049 @cindex Hebrew, handling with Emacs
4050 @cindex Semitic alphabets
4051 @cindex Arabic
4052 @cindex Farsi
4053 @cindex bidirectional scripts
4055 Emacs supports display and editing of bidirectional scripts, such as
4056 Arabic, Farsi, and Hebrew, since version 24.1.
4057 @xref{New in Emacs 24, bidirectional display}.
4060 @node How to add fonts
4061 @section How do I add fonts for use with Emacs?
4062 @cindex add fonts for use with Emacs
4063 @cindex intlfonts
4065 First, download and install the BDF font files and any auxiliary
4066 packages they need.  The GNU Intlfonts distribution can be found on
4067 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU
4068 Software Directory Web site}.
4070 Next, if you are on X Window system, issue the following two commands
4071 from the shell's prompt:
4073 @example
4074   xset +fp /usr/local/share/emacs/fonts
4075   xset fp rehash
4076 @end example
4078 @noindent
4079 (Modify the first command if you installed the fonts in a directory
4080 that is not @file{/usr/local/share/emacs/fonts}.)  You also need to
4081 arrange for these two commands to run whenever you log in, e.g., by
4082 adding them to your window-system startup file, such as
4083 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4085 Now, add the following line to your @file{~/.emacs} init file:
4087 @lisp
4088   (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4089 @end lisp
4091 @noindent
4092 (Again, modify the file name if you installed the fonts elsewhere.)
4094 Finally, if you wish to use the installed fonts with @code{ps-print},
4095 add the following line to your @file{~/.emacs}:
4097 @lisp
4098   (setq ps-multibyte-buffer 'bdf-font-except-latin)
4099 @end lisp
4101 A few additional steps are necessary for MS-Windows; they are listed
4102 below.
4104 First, make sure @emph{all} the directories with BDF font files are
4105 mentioned in @code{bdf-directory-list}.  On Unix and GNU/Linux
4106 systems, one normally runs @kbd{make install} to install the BDF fonts
4107 in the same directory.  By contrast, Windows users typically don't run
4108 the Intlfonts installation command, but unpack the distribution in
4109 some directory, which leaves the BDF fonts in its subdirectories.  For
4110 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4111 then you should set @code{bdf-directory-list} as follows:
4113 @lisp
4114   (setq bdf-directory-list
4115     '("C:/Intlfonts/Asian"
4116       "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4117       "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4118       "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4119       "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4120       "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4121       "C:/Intlfonts/Misc"))
4122 @end lisp
4124 @cindex @code{w32-bdf-filename-alist}
4125 @cindex @code{w32-find-bdf-fonts}
4126 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4127 an alist of the BDF fonts and their corresponding file names.
4128 Assuming you have set @code{bdf-directory-list} to name all the
4129 directories with the BDF font files, the following Lisp snippet will
4130 set up @code{w32-bdf-filename-alist}:
4132 @lisp
4133   (setq w32-bdf-filename-alist
4134      (w32-find-bdf-fonts bdf-directory-list))
4135 @end lisp
4137 Now, create fontsets for the BDF fonts:
4139 @smallexample
4140   (create-fontset-from-fontset-spec
4141    "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4142    japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4143    katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4144    latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4145    japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4146    thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4147    lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4148    tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4149    ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4150    tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4151 @end smallexample
4153 Many of the international bdf fonts from Intlfonts are type 0, and
4154 therefore need to be added to font-encoding-alist:
4156 @lisp
4157   (setq font-encoding-alist
4158         (append '(("MuleTibetan-0" (tibetan . 0))
4159                   ("GB2312"        (chinese-gb2312 . 0))
4160                   ("JISX0208"      (japanese-jisx0208 . 0))
4161                   ("JISX0212"      (japanese-jisx0212 . 0))
4162                   ("VISCII"        (vietnamese-viscii-lower . 0))
4163                   ("KSC5601"       (korean-ksc5601 . 0))
4164                   ("MuleArabic-0"  (arabic-digit . 0))
4165                   ("MuleArabic-1"  (arabic-1-column . 0))
4166                   ("MuleArabic-2"  (arabic-2-column . 0)))
4167                 font-encoding-alist))
4168 @end lisp
4170 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4171 fontset, or you can select it by setting the default font in your
4172 @file{~/.emacs}:
4174 @lisp
4175   (set-default-font "fontset-bdf")
4176 @end lisp
4179 @c ------------------------------------------------------------
4180 @node Mail and news
4181 @chapter Mail and news
4182 @cindex Mail and news
4184 @menu
4185 * Changing the included text prefix::
4186 * Saving a copy of outgoing mail::
4187 * Expanding aliases when sending mail::
4188 * Sorting the messages in an Rmail folder::
4189 * Rmail writes to /var/spool/mail::
4190 * Replying to the sender of a message::
4191 * Automatically starting a mail or news reader::
4192 * Reading news with Emacs::
4193 * Making Gnus faster::
4194 * Catching up in all newsgroups::
4195 @end menu
4197 @node Changing the included text prefix
4198 @section How do I change the included text prefix in mail/news followups?
4199 @cindex Prefix in mail/news followups, changing
4200 @cindex Included text prefix, changing
4201 @cindex Setting the included text character
4202 @cindex Quoting in mail messages
4204 If you read mail with Rmail, set the variable @code{mail-yank-prefix}.
4205 For Gnus, set @code{message-yank-prefix}.  For VM, set
4206 @code{vm-included-text-prefix}.  For mh-e, set @code{mh-ins-buf-prefix}.
4208 For fancier control of citations, use Supercite (@pxref{Top,, the Supercite
4209 Manual, sc, The Supercite Manual}).
4211 To prevent Emacs from including various headers of the replied-to
4212 message, set the value of @code{mail-yank-ignored-headers} to an
4213 appropriate regexp.
4215 @node Saving a copy of outgoing mail
4216 @section How do I save a copy of outgoing mail?
4217 @cindex Saving a copy of outgoing mail
4218 @cindex Copying outgoing mail to a file
4219 @cindex Filing outgoing mail
4220 @cindex Automatic filing of outgoing mail
4221 @cindex Mail, saving outgoing automatically
4223 You can either mail yourself a copy by including a @samp{BCC} header in the
4224 mail message, or store a copy of the message directly to a file by
4225 including an @samp{FCC} header.
4227 If you use standard mail, you can automatically create a @samp{BCC} to
4228 yourself by putting
4230 @lisp
4231 (setq mail-self-blind t)
4232 @end lisp
4234 @noindent
4235 in your @file{.emacs} file.  You can automatically include an @samp{FCC}
4236 field by putting something like the following in your @file{.emacs}
4237 file:
4239 @lisp
4240 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4241 @end lisp
4243 The output file will be in Unix mail format.
4245 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4246 components file.
4248 It does not work to put @samp{set record filename} in the @file{.mailrc}
4249 file.
4251 @node Expanding aliases when sending mail
4252 @section Why doesn't Emacs expand my aliases when sending mail?
4253 @cindex Expanding aliases when sending mail
4254 @cindex Mail alias expansion
4255 @cindex Sending mail with aliases
4257 @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}.
4259 @itemize @bullet
4261 @item
4262 Normally, Emacs expands aliases when you send the message.
4263 To expand them before this, use @kbd{M-x expand-mail-aliases}.
4265 @item
4266 Emacs normally only reads the @file{.mailrc} file once per session, when
4267 you start to compose your first mail message.  If you edit the file
4268 after this, you can use @kbd{M-x build-mail-aliases} to make Emacs
4269 reread it.  Prior to Emacs 24.1, this is not an interactive command, so
4270 you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}.
4272 @item
4273 If you like, you can expand mail aliases as abbrevs, as soon as you
4274 type them in.  To enable this feature, execute the following:
4276 @lisp
4277 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4278 @end lisp
4280 Note that the aliases are expanded automatically only after you type
4281 a word-separator character (e.g., @key{RET} or @kbd{,}).  You can force their
4282 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4283 (@kbd{M-x expand-abbrev}).
4284 @end itemize
4286 @node Sorting the messages in an Rmail folder
4287 @section How can I sort the messages in my Rmail folder?
4288 @cindex Rmail, sorting messages in
4289 @cindex Folder, sorting messages in an Rmail
4290 @cindex Sorting messages in an Rmail folder
4292 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4293 and their key bindings.
4295 @node Rmail writes to /var/spool/mail
4296 @section Why does Rmail need to write to @file{/var/spool/mail}?
4297 @cindex Rmail and @file{/var/spool/mail}
4298 @cindex @file{/var/spool/mail} and Rmail
4300 This is the behavior of the @code{movemail} program which Rmail uses.
4301 This indicates that @code{movemail} is configured to use lock files.
4303 RMS writes:
4305 @quotation
4306 Certain systems require lock files to interlock access to mail files.
4307 On these systems, @code{movemail} must write lock files, or you risk losing
4308 mail.  You simply must arrange to let @code{movemail} write them.
4310 Other systems use the @code{flock} system call to interlock access.  On
4311 these systems, you should configure @code{movemail} to use @code{flock}.
4312 @end quotation
4314 @node Replying to the sender of a message
4315 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4316 @cindex Replying only to the sender of a message
4317 @cindex Sender, replying only to
4318 @cindex Rmail, replying to the sender of a message in
4320 @c isaacson@@seas.upenn.edu
4321 Ron Isaacson says: When you hit
4322 @key{r} to reply in Rmail, by default it CCs all of the original
4323 recipients (everyone on the original @samp{To} and @samp{CC}
4324 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4325 it replies only to the sender.  However, going through the whole
4326 @kbd{C-u} business every time you want to reply is a pain.  This is the
4327 best fix I've been able to come up with:
4329 @lisp
4330 (defun rmail-reply-t ()
4331   "Reply only to the sender of the current message. (See rmail-reply.)"
4332   (interactive)
4333   (rmail-reply t))
4335 (add-hook 'rmail-mode-hook
4336   (lambda ()
4337     (define-key rmail-mode-map "r" 'rmail-reply-t)
4338     (define-key rmail-mode-map "R" 'rmail-reply)))
4339 @end lisp
4341 @node Automatically starting a mail or news reader
4342 @section How do I make Emacs automatically start my mail/news reader?
4343 @cindex Mail reader, starting automatically
4344 @cindex News reader, starting automatically
4345 @cindex Starting mail/news reader automatically
4347 To start Emacs in Gnus:
4349 @example
4350 emacs -f gnus
4351 @end example
4353 @noindent
4354 in Rmail:
4356 @example
4357 emacs -f rmail
4358 @end example
4360 A more convenient way to start with Gnus:
4362 @example
4363 alias gnus 'emacs -f gnus'
4364 gnus
4365 @end example
4367 It is probably unwise to automatically start your mail or news reader
4368 from your @file{.emacs} file.  This would cause problems if you needed to run
4369 two copies of Emacs at the same time.  Also, this would make it difficult for
4370 you to start Emacs quickly when you needed to.
4372 @node Reading news with Emacs
4373 @section How do I read news under Emacs?
4374 @cindex Reading news under Emacs
4375 @cindex Usenet reader in Emacs
4376 @cindex Gnus newsreader
4377 @cindex FAQ for Gnus
4378 @cindex Gnus FAQ
4379 @cindex Learning more about Gnus
4381 Use @kbd{M-x gnus}.  For more information on Gnus, @pxref{Top,, the Gnus
4382 Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked
4383 Questions,, the Gnus FAQ, gnus, The Gnus Manual}.
4386 @node Making Gnus faster
4387 @section How do I make Gnus faster?
4388 @cindex Faster, starting Gnus
4389 @cindex Starting Gnus faster
4390 @cindex Gnus, starting faster
4391 @cindex Slow catch up in Gnus
4392 @cindex Gnus is slow when catching up
4393 @cindex Crosspostings make Gnus catching up slow
4395 From the Gnus FAQ (@pxref{Reading news with Emacs}):
4397 @quotation
4398 If you have a slow machine, or are just really impatient, there are a
4399 few things you can do to make Gnus run faster.
4401 Set @code{gnus-check-new-newsgroups} and
4402 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
4404 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
4405 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
4406 summary buffer faster.
4407 @end quotation
4409 @node Catching up in all newsgroups
4410 @section How do I catch up all newsgroups in Gnus?
4411 @cindex Catching up all newsgroups in Gnus
4412 @cindex Gnus, Catching up all newsgroups in
4414 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4416 Leave off the initial @kbd{M-<} if you only want to catch up from point
4417 to the end of the @file{*Newsgroup*} buffer.
4419 @node Concept index
4420 @unnumbered Concept Index
4421 @printindex cp
4423 @bye