lisp/server.el (server-ensure-safe-dir): Simplify.
[emacs.git] / doc / misc / faq.texi
blob5b7bb7ec9cebe221906685075b9ee05c6f004e39
1 \input texinfo   @c -*- mode: texinfo; -*-
2 @c %**start of header
3 @setfilename ../../info/efaq
4 @settitle GNU Emacs FAQ
5 @c %**end of header
7 @include emacsver.texi
9 @c This file is maintained by Romain Francoise <rfrancoise@gnu.org>.
10 @c Feel free to install changes without prior permission (but I'd
11 @c appreciate a notice if you do).
13 @copying
14 Copyright @copyright{} 2001-2012 Free Software Foundation, Inc.@*
15 Copyright @copyright{} 1994, 1995, 1996, 1997, 1998, 1999, 2000
16 Reuven M. Lerner@*
17 Copyright @copyright{} 1992, 1993 Steven Byrnes@*
18 Copyright @copyright{} 1990, 1991, 1992 Joseph Brian Wells@*
20 @quotation
21 This list of frequently asked questions about GNU Emacs with answers
22 (``FAQ'') may be translated into other languages, transformed into other
23 formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information.
25 The same conditions apply to any derivative of the FAQ as apply to the FAQ
26 itself.  Every copy of the FAQ must include this notice or an approved
27 translation, information on who is currently maintaining the FAQ and how to
28 contact them (including their e-mail address), and information on where the
29 latest version of the FAQ is archived (including FTP information).
31 The FAQ may be copied and redistributed under these conditions, except that
32 the FAQ may not be embedded in a larger literary work unless that work
33 itself allows free copying and redistribution.
35 [This version has been heavily edited since it was included in the Emacs
36 distribution.]
37 @end quotation
38 @end copying
40 @dircategory Emacs
41 @direntry
42 * Emacs FAQ: (efaq).            Frequently Asked Questions about Emacs.
43 @end direntry
45 @c The @titlepage stuff only appears in the printed version
46 @titlepage
47 @sp 10
48 @center @titlefont{GNU Emacs FAQ}
50 @c The following two commands start the copyright page.
51 @page
52 @vskip 0pt plus 1filll
53 @insertcopying
54 @end titlepage
56 @contents
58 @node Top, FAQ notation, (dir), (dir)
59 @top The GNU Emacs FAQ
61 @c FIXME @today is just the day we ran `makeinfo'.
62 This is the GNU Emacs FAQ, last updated on @today{}.
64 This FAQ is maintained as a part of GNU Emacs.  If you find any errors,
65 or have any suggestions, please use @kbd{M-x report-emacs-bug} to report
66 them.
68 This is the version of the FAQ distributed with Emacs @value{EMACSVER}, and
69 mainly describes that version.  Although there is some information on
70 older versions, details about very old releases (now only of historical
71 interest) have been removed.  If you are interested in this, consult
72 either the version of the FAQ distributed with older versions of Emacs,
73 or the history of this document in the Emacs source repository.
75 Since Emacs releases are very stable, we recommend always running the
76 latest release.
78 This FAQ is not updated very frequently.  When you have a question about
79 Emacs, the Emacs manual is often the best starting point.
81 @ifnottex
82 @insertcopying
83 @end ifnottex
85 @menu
86 * FAQ notation::
87 * General questions::
88 * Getting help::
89 * Status of Emacs::
90 * Common requests::
91 * Bugs and problems::
92 * Compiling and installing Emacs::
93 * Finding Emacs and related packages::
94 * Major packages and programs::
95 * Key bindings::
96 * Alternate character sets::
97 * Mail and news::
98 * Concept index::
99 @end menu
101 @c ------------------------------------------------------------
102 @node FAQ notation
103 @chapter FAQ notation
104 @cindex FAQ notation
106 This chapter describes notation used in the GNU Emacs FAQ, as well as in
107 the Emacs documentation.  Consult this section if this is the first time
108 you are reading the FAQ, or if you are confused by notation or terms
109 used in the FAQ.
111 @menu
112 * Basic keys::
113 * Extended commands::
114 * Emacs manual::
115 * File-name conventions::
116 * Common acronyms::
117 @end menu
119 @node Basic keys
120 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
121 @cindex Basic keys
122 @cindex Control key, notation for
123 @cindex @key{Meta} key, notation for
124 @cindex Control-Meta characters, notation for
125 @cindex @kbd{C-h}, definition of
126 @cindex @kbd{C-M-h}, definition of
127 @cindex @key{DEL}, definition of
128 @cindex @key{ESC}, definition of
129 @cindex @key{LFD}, definition of
130 @cindex @key{RET}, definition of
131 @cindex @key{SPC}, definition of
132 @cindex @key{TAB}, definition of
133 @cindex Notation for keys
135 @itemize @bullet
137 @item
138 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
140 @item
141 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
142 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
144 @item
145 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
146 and @key{Meta}
148 @item
149 @kbd{C-M-x}: a synonym for the above
151 @item
152 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
154 @item
155 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
157 @item
158 @key{DEL}: @key{Delete}, usually @strong{not} the same as
159 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
160 deleting invokes Emacs help)
162 @item
163 @key{ESC}: Escape; same as @kbd{C-[}
165 @item
166 @key{TAB}: Tab; same as @kbd{C-i}
168 @item
169 @key{SPC}: Space bar
171 @end itemize
173 Key sequences longer than one key (and some single-key sequences) are
174 written inside quotes or on lines by themselves, like this:
176 @display
177   @kbd{M-x frobnicate-while-foo RET}
178 @end display
180 @noindent
181 Any real spaces in such a key sequence should be ignored; only @key{SPC}
182 really means press the space key.
184 The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
185 that would be sent by pressing just @key{x} minus 96 (or 64 for
186 upper-case @key{X}) and will be from 0 to 31.  On Unix and GNU/Linux
187 terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the
188 @acronym{ASCII} code that would be sent by pressing just @key{x}.  Essentially,
189 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
190 7@footnote{
191 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
192 pressed.}.
194 @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127.  It is a misnomer to call
195 @kbd{C-?}  a ``control'' key, since 127 has both bits 5 and 6 turned ON.
196 Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127.
197 @c FIXME I cannot understand the previous sentence.
199 @inforef{Keys, Keys, emacs}, for more information.  (@xref{Emacs
200 manual}, for more information about Info.)
202 @node Extended commands
203 @section What does @file{M-x @var{command}} mean?
204 @cindex Extended commands
205 @cindex Commands, extended
206 @cindex M-x, meaning of
208 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
209 command, then type @key{RET}.  (@xref{Basic keys}, if you're not sure
210 what @kbd{M-x} and @key{RET} mean.)
212 @kbd{M-x} (by default) invokes the command
213 @code{execute-extended-command}.  This command allows you to run any
214 Emacs command if you can remember the command's name.  If you can't
215 remember the command's name, you can type @key{TAB} and @key{SPC} for
216 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
217 @kbd{M-n} (or up-arrow and down-arrow) to see previous commands entered.
218 An Emacs @dfn{command} is an @dfn{interactive} Emacs function.
220 @cindex @key{Do} key
221 Your system administrator may have bound other key sequences to invoke
222 @code{execute-extended-command}.  A function key labeled @kbd{Do} is a
223 good candidate for this, on keyboards that have such a key.
225 If you need to run non-interactive Emacs functions, see @ref{Evaluating
226 Emacs Lisp code}.
228 @node Emacs manual
229 @section How do I read topic XXX in the Emacs manual?
230 @cindex Emacs manual, reading topics in
231 @cindex Reading topics in the Emacs manual
232 @cindex Finding topics in the Emacs manual
233 @cindex Info, finding topics in
235 When we refer you to some @var{topic} in the Emacs manual, you can
236 read this manual node inside Emacs (assuming nothing is broken) by
237 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
239 This invokes Info, the GNU hypertext documentation browser.  If you don't
240 already know how to use Info, type @key{?} from within Info.
242 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
243 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
245 If these commands don't work as expected, your system administrator may
246 not have installed the Info files, or may have installed them
247 improperly.  In this case you should complain.
249 If you are reading this FAQ in Info, you can simply press @key{RET} on a
250 reference to follow it.
252 @xref{Getting a printed manual}, if you would like a paper copy of the
253 Emacs manual.
255 @node File-name conventions
256 @section What are @file{etc/GNU}, @file{src/config.h}, @file{site-lisp/default.el}, etc.?
257 @cindex File-name conventions
258 @cindex Conventions for file names
259 @cindex Directories and files that come with Emacs
261 These are files that come with Emacs.  The Emacs distribution is divided
262 into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}.
263 Some of these (e.g. @file{etc} and @file{lisp}) are present both in
264 an installed Emacs and in the sources, but some (e.g. @file{src}) are
265 only found in the sources.
267 If you use Emacs, but don't know where it is kept on your system, start
268 Emacs, then type @kbd{C-h v data-directory @key{RET}}.  The directory
269 name displayed by this will be the full pathname of the installed
270 @file{etc} directory.  (This full path is recorded in the Emacs variable
271 @code{data-directory}, and @kbd{C-h v} displays the value and the
272 documentation of a variable.)
274 The location of your Info directory (i.e., where Info documentation
275 is stored) is kept in the variable @code{Info-default-directory-list}.  Use
276 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
277 this variable, which will be a list of directory names.  The last
278 directory in that list is probably where most Info files are stored.  By
279 default, Emacs Info documentation is placed in @file{/usr/local/share/info}.
281 For information on some of the files in the @file{etc} directory,
282 @pxref{Informational files for Emacs}.
284 @node Common acronyms
285 @section What are FSF, LPF, GNU, RMS, FTP, and GPL?
286 @cindex FSF, definition of
287 @cindex LPF, definition of
288 @cindex GNU, definition of
289 @cindex RMS, definition of
290 @cindex Stallman, Richard, acronym for
291 @cindex Richard Stallman, acronym for
292 @cindex FTP, definition of
293 @cindex GPL, definition of
294 @cindex Acronyms, definitions for
295 @cindex Common acronyms, definitions for
297 @table @asis
299 @item FSF
300 Free Software Foundation
302 @item LPF
303 League for Programming Freedom
305 @item GNU
306 GNU's Not Unix
308 @item RMS
309 Richard Matthew Stallman
311 @item FTP
312 File Transfer Protocol
314 @item GPL
315 GNU General Public License
317 @end table
319 Avoid confusing the FSF and the LPF.  The LPF opposes
320 look-and-feel copyrights and software patents.  The FSF aims to make
321 high quality free software available for everyone.
323 The word ``free'' in the title of the Free Software Foundation refers to
324 ``freedom,'' not ``zero cost.''  Anyone can charge any price for
325 GPL-covered software that they want to.  However, in practice, the
326 freedom enforced by the GPL leads to low prices, because you can always
327 get the software for less money from someone else, since everyone has
328 the right to resell or give away GPL-covered software.
330 @c ------------------------------------------------------------
331 @node General questions
332 @chapter General questions
333 @cindex General questions
335 This chapter contains general questions having to do with Emacs, the
336 Free Software Foundation, and related organizations.
338 @menu
339 * The LPF::
340 * Real meaning of copyleft::
341 * Guidelines for newsgroup postings::
342 * Newsgroup archives::
343 * Reporting bugs::
344 * Unsubscribing from Emacs lists::
345 * Contacting the FSF::
346 @end menu
348 @node The LPF
349 @section What is the LPF?
350 @cindex LPF, description of
351 @cindex League for Programming Freedom
352 @cindex Software patents, opposition to
353 @cindex Patents for software, opposition to
355 The LPF opposes the expanding danger of software patents and
356 look-and-feel copyrights.  More information on the LPF's views is
357 available at @uref{http://progfree.org/, the LPF home page}.
359 @node Real meaning of copyleft
360 @section What is the real legal meaning of the GNU copyleft?
361 @cindex Copyleft, real meaning of
362 @cindex GPL, real meaning of
363 @cindex General Public License, real meaning of
364 @cindex Discussion of the GPL
366 The real legal meaning of the GNU General Public License (copyleft) will
367 only be known if and when a judge rules on its validity and scope.
368 There has never been a copyright infringement case involving the GPL to
369 set any precedents.  Although legal actions have been brought against
370 companies for violating the terms of the GPL, so far all have been
371 settled out of court (in favor of the plaintiffs).  Please take any
372 discussion regarding this issue to the newsgroup
373 @uref{news:gnu.misc.discuss}, which was created to hold the extensive
374 flame wars on the subject.
376 RMS writes:
378 @quotation
379 The legal meaning of the GNU copyleft is less important than the spirit,
380 which is that Emacs is a free software project and that work pertaining
381 to Emacs should also be free software.  ``Free'' means that all users
382 have the freedom to study, share, change and improve Emacs.  To make
383 sure everyone has this freedom, pass along source code when you
384 distribute any version of Emacs or a related program, and give the
385 recipients the same freedom that you enjoyed.
386 @end quotation
388 @node Guidelines for newsgroup postings
389 @section  What are appropriate messages for the various Emacs newsgroups?
390 @cindex Newsgroups, appropriate messages for
391 @cindex GNU newsgroups, appropriate messages for
392 @cindex Usenet groups, appropriate messages for
393 @cindex Mailing lists, appropriate messages for
394 @cindex Posting messages to newsgroups
396 @cindex GNU mailing lists
397 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU
398 mailing list (@pxref{Informational files for Emacs}).  For those lists
399 which are gatewayed with newsgroups, it lists both the newsgroup name
400 and the mailing list address.  The Emacs mailing lists are also
401 described at @uref{http://savannah.gnu.org/mail/?group=emacs, the Emacs
402 Savannah page}.
404 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
405 in general.  The newsgroup @uref{news:gnu.emacs.help} is specifically
406 for GNU Emacs.  It therefore makes no sense to cross-post to both
407 groups, since only one can be appropriate to any question.
409 Messages advocating ``non-free'' software are considered unacceptable on
410 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
411 which was created to hold the extensive flame-wars on the subject.
412 ``Non-free'' software includes any software for which the end user can't
413 freely modify the source code and exchange enhancements.  Be careful to
414 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
415 posting a followup that recommends such software.
417 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
418 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
420 @node Newsgroup archives
421 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
422 @cindex Archived postings from @code{gnu.emacs.help}
423 @cindex Usenet archives for GNU groups
424 @cindex Old Usenet postings for GNU groups
426 The FSF has maintained archives of all of the GNU mailing lists for many
427 years, although there may be some unintentional gaps in coverage.  The
428 archive can be browsed over the web at
429 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}.  Raw
430 files can be downloaded from @uref{ftp://lists.gnu.org/}.
432 Web-based Usenet search services, such as
433 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
434 archive the @code{gnu.*} groups.
436 You can also read the archives of the @code{gnu.*} groups and post new
437 messages at @uref{http://gmane.org/, Gmane}.  Gmane is a service that
438 presents mailing lists as newsgroups (even those without a traditional
439 mail-to-news gateway).
441 @node Reporting bugs
442 @section Where should I report bugs and other problems with Emacs?
443 @cindex Bug reporting
444 @cindex Good bug reports
445 @cindex How to submit a bug report
446 @cindex Reporting bugs
448 The correct way to report Emacs bugs is to use the command
449 @kbd{M-x report-emacs-bug}.  It sets up a mail buffer with the
450 essential information and the correct e-mail address, which is
451 @email{bug-gnu-emacs@@gnu.org} for the released versions of Emacs.
452 Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the
453 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
454 news to submit the bug report.  This ensures a reliable return address
455 so you can be contacted for further details.
457 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
458 a bug!  The manual describes in detail how to submit a useful bug
459 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
460 (@xref{Emacs manual}, if you don't know how to read the manual.)
462 RMS says:
464 @quotation
465 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the
466 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because
467 it takes the time of an unnecessarily large group of people, most of
468 whom are just users and have no idea how to fix these problem.
469 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people
470 who are more likely to know what to do and have expressed a wish to
471 receive more messages about Emacs than the others.
472 @end quotation
474 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
476 @quotation
477 If you have reported a bug and you don't hear about a possible fix,
478 then after a suitable delay (such as a week) it is okay to post on
479 @code{gnu.emacs.help} asking if anyone can help you.
480 @end quotation
482 If you are unsure whether you have found a bug, consider the following
483 non-exhaustive list, courtesy of RMS:
485 @quotation
486 If Emacs crashes, that is a bug.  If Emacs gets compilation errors
487 while building, that is a bug.  If Emacs crashes while building, that
488 is a bug.  If Lisp code does not do what the documentation says it
489 does, that is a bug.
490 @end quotation
492 @node Unsubscribing from Emacs lists
493 @section  How do I unsubscribe from a mailing list?
494 @cindex Unsubscribing from GNU mailing lists
495 @cindex Removing yourself from GNU mailing lists
497 If you are receiving a GNU mailing list named @var{list}, you should be
498 able to unsubscribe from it by sending a request to the address
499 @email{@var{list}-request@@gnu.org}.  Mailing lists mails normally
500 contain information in either the message header
501 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
502 unsubscribe.
504 @node Contacting the FSF
505 @section  How do I contact the FSF?
506 @cindex Contracting the FSF
507 @cindex Free Software Foundation, contacting
509 For up-to-date information, see
510 @uref{http://www.fsf.org/about/contact.html, the FSF contact web-page}.
511 You can send general correspondence to @email{info@@fsf.org}.
513 @cindex Ordering GNU software
514 For details on how to order items directly from the FSF, see the
515 @uref{http://shop.fsf.org/, FSF on-line store}.
517 @c ------------------------------------------------------------
518 @node Getting help
519 @chapter Getting help
520 @cindex Getting help
522 This chapter tells you how to get help with Emacs.
524 @menu
525 * Basic editing::
526 * Learning how to do something::
527 * Getting a printed manual::
528 * Emacs Lisp documentation::
529 * Installing Texinfo documentation::
530 * Printing a Texinfo file::
531 * Viewing Info files outside of Emacs::
532 * Informational files for Emacs::
533 * Help installing Emacs::
534 * Obtaining the FAQ::
535 @end menu
537 @node Basic editing
538 @section I'm just starting Emacs; how do I do basic editing?
539 @cindex Basic editing with Emacs
540 @cindex Beginning editing
541 @cindex Tutorial, invoking the
542 @cindex Self-paced tutorial, invoking the
543 @cindex Help system, entering the
545 Type @kbd{C-h t} to invoke the self-paced tutorial.  Just typing
546 @kbd{C-h} enters the help system.  Starting with Emacs 22, the tutorial
547 is available in many foreign languages such as French, German, Japanese,
548 Russian, etc.  Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
549 to choose your language and start the tutorial.
551 Your system administrator may have changed @kbd{C-h} to act like
552 @key{DEL} to deal with local keyboards.  You can use @kbd{M-x
553 help-for-help} instead to invoke help.  To discover what key (if any)
554 invokes help on your system, type @kbd{M-x where-is @key{RET}
555 help-for-help @key{RET}}.  This will print a comma-separated list of key
556 sequences in the echo area.  Ignore the last character in each key
557 sequence listed.  Each of the resulting key sequences (e.g. @key{F1} is
558 common) invokes help.
560 Emacs help works best if it is invoked by a single key whose value
561 should be stored in the variable @code{help-char}.
563 @node Learning how to do something
564 @section How do I find out how to do something in Emacs?
565 @cindex Help for Emacs
566 @cindex Learning to do something in Emacs
567 @cindex Reference card for Emacs
568 @cindex Overview of help systems
570 There are several methods for finding out how to do things in Emacs.
572 @itemize @bullet
574 @cindex Reading the Emacs manual
575 @item
576 The complete text of the Emacs manual is available via the Info
577 hypertext reader.  Type @kbd{C-h r} to display the manual in Info mode.
578 Typing @key{h} immediately after entering Info will provide a short
579 tutorial on how to use it.
581 @cindex Lookup a subject in a manual
582 @cindex Index search in a manual
583 @item
584 To quickly locate the section of the manual which discusses a certain
585 issue, or describes a command or a variable, type @kbd{C-h i m emacs
586 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
587 topic, the command, or the variable which you are looking for.  If this
588 does not land you on the right place in the manual, press @kbd{,}
589 (comma) repeatedly until you find what you need.  (The @kbd{i} and
590 @kbd{,} keys invoke the index-searching functions, which look for the
591 @var{topic} you type in all the indices of the Emacs manual.)
593 @cindex Apropos
594 @item
595 You can list all of the commands whose names contain a certain word
596 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
597 command-apropos}).
599 @cindex Command description in the manual
600 @item
601 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
602 for the name of a command, and then attempts to find the section in the
603 Emacs manual where that command is described.
605 @cindex Finding commands and variables
606 @item
607 You can list all of the functions and variables whose names contain a
608 certain word using @kbd{M-x apropos}.
610 @item
611 You can list all of the functions and variables whose documentation
612 matches a regular expression or a string, using @kbd{M-x
613 apropos-documentation}.
615 @item
616 You can order a hardcopy of the manual from the FSF.  @xref{Getting a
617 printed manual}.
619 @cindex Reference cards, in other languages
620 @item
621 You can get a printed reference card listing commands and keys to
622 invoke them.  You can order one from the FSF for $2 (or 10 for $18),
623 or you can print your own from the @file{etc/refcards/refcard.tex} or
624 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
625 Beginning with version 21.1, the Emacs distribution comes with
626 translations of the reference card into several languages; look for
627 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
628 is a two-letter code of the language.  For example, the German version
629 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
630 and @file{etc/refcards/de-refcard.pdf}.
632 @item
633 There are many other commands in Emacs for getting help and
634 information.  To get a list of these commands, type @samp{?} after
635 @kbd{C-h}.
637 @end itemize
639 @node Getting a printed manual
640 @section How do I get a printed copy of the Emacs manual?
641 @cindex Printed Emacs manual, obtaining
642 @cindex Manual, obtaining a printed or HTML copy of
643 @cindex Emacs manual, obtaining a printed or HTML copy of
645 You can order a printed copy of the Emacs manual from the FSF.  For
646 details see the @uref{http://shop.fsf.org/, FSF on-line store}.
648 The full Texinfo source for the manual also comes in the @file{doc/emacs}
649 directory of the Emacs distribution, if you're daring enough to try to
650 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
651 file}).
653 If you absolutely have to print your own copy, and you don't have @TeX{},
654 you can get a PostScript or PDF (or HTML) version from
656 @uref{http://www.gnu.org/software/emacs/manual/}
658 @xref{Learning how to do something}, for how to view the manual from Emacs.
660 @node Emacs Lisp documentation
661 @section Where can I get documentation on Emacs Lisp?
662 @cindex Documentation on Emacs Lisp
663 @cindex Function documentation
664 @cindex Variable documentation
665 @cindex Emacs Lisp Reference Manual
666 @cindex Reference manual for Emacs Lisp
668 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
669 function, @kbd{C-h v} for a variable.
671 For more information, the Emacs Lisp Reference Manual is available
672 in Info format (@pxref{Top, Emacs Lisp,, elisp, The
673 Emacs Lisp Reference Manual}).
675 You can also order a hardcopy of the manual from the FSF, for details
676 see the @uref{http://shop.fsf.org/, FSF on-line store}.  (This manual is
677 not always in print.)
679 An HTML version of the Emacs Lisp Reference Manual is available at
681 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html}
683 @node Installing Texinfo documentation
684 @section How do I install a piece of Texinfo documentation?
685 @cindex Texinfo documentation, installing
686 @cindex Installing Texinfo documentation
687 @cindex New Texinfo files, installing
688 @cindex Documentation, installing new Texinfo files
689 @cindex Info files, how to install
691 Emacs releases come with pre-built Info files, and the normal install
692 process places them in the correct location.  This is true for most
693 applications that provide Info files.  The following section is only
694 relevant if you want to install extra Info files by hand.
696 First, you must turn the Texinfo source files into Info files.  You may
697 do this using the stand-alone @file{makeinfo} program, available as part
698 of the Texinfo package at
700 @uref{http://www.gnu.org/software/texinfo/}
702 For information about the Texinfo format, read the Texinfo manual which
703 comes with the Texinfo package.  This manual also comes installed in
704 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
705 @key{RET}}.
707 @c FIXME is this a complete alternative?
708 @c Probably not, given that we require makeinfo to build Emacs.
709 Alternatively, you could use the Emacs command @kbd{M-x
710 texinfo-format-buffer}, after visiting the Texinfo source file of the
711 manual you want to convert.
713 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
714 resulting Info files in Emacs's Info tree.  To install Info files,
715 perform these steps:
717 @enumerate
718 @item
719 Move the files to the @file{info} directory in the installed Emacs
720 distribution.  @xref{File-name conventions}, if you don't know where that
723 @item
724 Run the @code{install-info} command, which is part of the Texinfo
725 distribution, to update the main Info directory menu, like this:
727 @example
728  install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
729 @end example
731 @noindent
732 where @var{dir-path} is the full path to the directory where you copied
733 the produced Info file(s), and @var{file} is the name of the Info file
734 you produced and want to install.
736 If you don't have the @code{install-info} command installed, you can
737 edit the file @file{info/dir} in the installed Emacs distribution, and
738 add a line for the top level node in the Info package that you are
739 installing.  Follow the examples already in this file.  The format is:
741 @example
742 * Topic: (relative-pathname).  Short description of topic.
743 @end example
745 @end enumerate
747 If you want to install Info files and you don't have the necessary
748 privileges, you have several options:
750 @itemize @bullet
751 @item
752 Info files don't actually need to be installed before being used.
753 You can use a prefix argument for the @code{info} command and specify
754 the name of the Info file in the minibuffer.  This goes to the node
755 named @samp{Top} in that file.  For example, to view a Info file named
756 @file{@var{info-file}} in your home directory, you can type this:
758 @example
759 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
760 @end example
762 Alternatively, you can feed a file name to the @code{Info-goto-node}
763 command (invoked by pressing @key{g} in Info mode) by typing the name
764 of the file in parentheses, like this:
766 @example
767 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
768 @end example
770 @item
771 You can create your own Info directory.  You can tell Emacs where that
772 Info directory is by adding its pathname to the value of the variable
773 @code{Info-default-directory-list}.  For example, to use a private Info
774 directory which is a subdirectory of your home directory named @file{Info},
775 you could put this in your @file{.emacs} file:
777 @lisp
778 (add-to-list 'Info-default-directory-list "~/Info")
779 @end lisp
781 You will need a top-level Info file named @file{dir} in this directory
782 which has everything the system @file{dir} file has in it, except it
783 should list only entries for Info files in that directory.  You might
784 not need it if (fortuitously) all files in this directory were
785 referenced by other @file{dir} files.  The node lists from all
786 @file{dir} files in @code{Info-default-directory-list} are merged by the
787 Info system.
789 @end itemize
791 @node Printing a Texinfo file
792 @section How do I print a Texinfo file?
793 @cindex Printing a Texinfo file
794 @cindex Texinfo file, printing
795 @cindex Printing documentation
797 You can't get nicely printed output from Info files; you must still have
798 the original Texinfo source file for the manual you want to print.
800 Assuming you have @TeX{} installed on your system, follow these steps:
802 @enumerate
804 @item
805 Make sure the first line of the Texinfo file looks like this:
807 @example
808 \input texinfo
809 @end example
811 You may need to change @samp{texinfo} to the full pathname of the
812 @file{texinfo.tex} file, which comes with Emacs as
813 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
815 @item
816 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
817 the name of the Texinfo source file for which you want to produce a
818 printed copy.  The @samp{texi2dvi} script is part of the GNU Texinfo
819 distribution.
821 Alternatively, @samp{texi2pdf} produces PDF files.
823 @item
824 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
825 printing DVI files at your site.  For example, if you have a PostScript
826 printer, run the @code{dvips} program to print the DVI file on that
827 printer.
829 @end enumerate
831 To get more general instructions, retrieve the latest Texinfo package
832 (@pxref{Installing Texinfo documentation}).
834 @node Viewing Info files outside of Emacs
835 @section Can I view Info files without using Emacs?
836 @cindex Viewing Info files
837 @cindex Info file viewers
838 @cindex Alternative Info file viewers
840 Yes.  Here are some alternative programs:
842 @itemize @bullet
844 @item
845 @code{info}, a stand-alone version of the Info program, comes as part of
846 the Texinfo package.  @xref{Installing Texinfo documentation}, for
847 details.
849 @item
850 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
851 You can get Tkinfo at
852 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
854 @end itemize
856 @node Informational files for Emacs
857 @section What informational files are available for Emacs?
858 @cindex Informational files included with Emacs
859 @cindex Files included with Emacs
860 @cindex @file{COPYING}, description of file
861 @cindex @file{DISTRIB}, description of file
862 @cindex @file{GNU}, description of file
863 @cindex @file{INTERVIEW}, description of file
864 @cindex @file{MACHINES}, description of file
865 @cindex @file{MAILINGLISTS}, description of file
866 @cindex @file{NEWS}, description of file
868 This isn't a frequently asked question, but it should be!  A variety of
869 informational files about Emacs and relevant aspects of the GNU project
870 are available for you to read.
872 The following files (and others) are available in the @file{etc}
873 directory of the Emacs distribution (see @ref{File-name conventions}, if
874 you're not sure where that is).  Many of these files are available via
875 the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
876 help-for-help}).
878 @table @file
880 @item COPYING
881 GNU General Public License
883 @item DISTRIB
884 Emacs Availability Information
886 @item GNU
887 The GNU Manifesto
889 @item INTERVIEW
890 Richard Stallman discusses his public-domain UNIX-compatible software
891 system with BYTE editors
893 @item MACHINES
894 Status of Emacs on Various Machines and Systems
896 @item MAILINGLISTS
897 GNU Project Electronic Mailing Lists
899 @item NEWS
900 Emacs news, a history of recent user-visible changes
902 @end table
904 More GNU information, including back issues of the @cite{GNU's
905 Bulletin}, are at
907 @uref{http://www.gnu.org/bulletins/bulletins.html} and
909 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
911 @node Help installing Emacs
912 @section Where can I get help in installing Emacs?
913 @cindex Installation help
914 @cindex Help installing Emacs
916 @xref{Installing Emacs}, for some basic installation hints, and see
917 @ref{Problems building Emacs}, if you have problems with the installation.
919 @uref{http://www.fsf.org/resources/service/, The GNU Service directory}
920 lists companies and individuals willing to sell you help in installing
921 or using Emacs and other GNU software.
923 @node Obtaining the FAQ
924 @section Where can I get the latest version of this FAQ?
925 @cindex FAQ, obtaining the
926 @cindex Latest FAQ version, obtaining the
928 The Emacs FAQ is distributed with Emacs in Info format.  You can read it
929 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
930 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
931 C-f} (@kbd{M-x view-emacs-FAQ}).  The very latest version is available
932 in the Emacs development repository (@pxref{Latest version of Emacs}).
934 @c ------------------------------------------------------------
935 @node Status of Emacs
936 @chapter Status of Emacs
937 @cindex Status of Emacs
939 This chapter gives you basic information about Emacs, including the
940 status of its latest version.
942 @menu
943 * Origin of the term Emacs::
944 * Latest version of Emacs::
945 * New in Emacs 23::
946 * New in Emacs 22::
947 * New in Emacs 21::
948 * New in Emacs 20::
949 @end menu
951 @node Origin of the term Emacs
952 @section Where does the name ``Emacs'' come from?
953 @cindex Origin of the term ``Emacs''
954 @cindex Emacs name origin
955 @cindex TECO
956 @cindex Original version of Emacs
958 Emacs originally was an acronym for Editor MACroS.  RMS says he ``picked
959 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
960 the time.''  The first Emacs was a set of macros written in 1976 at MIT
961 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
962 Editor and COrrector) under ITS (the Incompatible Timesharing System) on
963 a PDP-10.  RMS had already extended TECO with a ``real-time''
964 full-screen mode with reprogrammable keys.  Emacs was started by
965 @email{gls@@east.sun.com, Guy Steele} as a project to unify the many
966 divergent TECO command sets and key bindings at MIT, and completed by
967 RMS.
969 Many people have said that TECO code looks a lot like line noise; you
970 can read more at @uref{news:alt.lang.teco}.  Someone has written a TECO
971 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
972 come with Emacs}); it would be an interesting project to run the
973 original TECO Emacs inside of Emacs.
975 @cindex Why Emacs?
976 For some not-so-serious alternative reasons for Emacs to have that
977 name, check out the file @file{etc/JOKES} (@pxref{File-name
978 conventions}).
980 @node Latest version of Emacs
981 @section What is the latest version of Emacs?
982 @cindex Version, latest
983 @cindex Latest version of Emacs
984 @cindex Development, Emacs
985 @cindex Repository, Emacs
986 @cindex Bazaar repository, Emacs
988 Emacs @value{EMACSVER} is the current version as of this writing.  A version
989 number with two components (e.g. @samp{22.1}) indicates a released
990 version; three components indicate a development
991 version (e.g. @samp{23.0.50} is what will eventually become @samp{23.1}).
993 Emacs is under active development, hosted at
994 @uref{http://savannah.gnu.org/projects/emacs/, Savannah}.  The source
995 code can be retrieved anonymously following the
996 @uref{http://savannah.gnu.org/bzr/?group=emacs, instructions}.
997 The repository is GNU Bazaar.
999 Because Emacs undergoes many changes before a release, the version
1000 number of a development version is not especially meaningful.  It is
1001 better to refer to the date on which the sources were retrieved from the
1002 development repository.  The development version is usually quite robust
1003 for every-day use, but if stability is more important to you than the
1004 latest features, you may want to stick to the releases.
1006 The following sections list some of the major new features in the last
1007 few Emacs releases.  For full details of the changes in any version of
1008 Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}).  As of Emacs 22,
1009 you can give this command a prefix argument to read about which features
1010 were new in older versions.
1012 @node New in Emacs 23
1013 @section What is different about Emacs 23?
1014 @cindex Differences between Emacs 22 and Emacs 23
1015 @cindex Emacs 23, new features in
1016 @cindex Recently introduced features
1017 @cindex Default features
1019 @itemize
1021 @cindex Anti-aliased fonts
1022 @cindex Freetype fonts
1023 @item
1024 Emacs has a new font code that can use multiple font backends,
1025 including freetype and fontconfig.  Emacs can use the Xft library for
1026 anti-aliasing, and the otf and m17n libraries for complex text layout and
1027 text shaping.
1029 @cindex Unicode
1030 @cindex Character sets
1031 @item
1032 The Emacs character set is now a superset of Unicode.  Several new
1033 language environments have been added.
1035 @cindex Multi-tty support
1036 @cindex X and tty displays
1037 @item
1038 Emacs now supports using both X displays and ttys in the same session
1039 (@samp{multi-tty}).
1041 @cindex Daemon mode
1042 @item
1043 Emacs can be started as a daemon in the background.
1045 @cindex NeXTstep port
1046 @cindex GNUstep port
1047 @cindex Mac OS X Cocoa
1048 @item
1049 There is a new NeXTstep port of Emacs.  This supports GNUstep and Mac OS
1050 X (via the Cocoa libraries).  The Carbon port of Emacs, which supported
1051 Mac OS X in Emacs 22, has been removed.
1053 @cindex Directory-local variables
1054 @item
1055 Directory-local variables can now be defined, in a similar manner to
1056 file-local variables.
1058 @item
1059 Transient Mark mode (@pxref{Highlighting a region}) is on by default.
1061 @end itemize
1063 @noindent
1064 Other changes include: support for serial port access; D-Bus bindings; a
1065 new Visual Line mode for line-motion; improved completion; a new mode
1066 (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML
1067 mode (for editing XML documents) is included; VC has been updated for
1068 newer version control systems; etc.  As always, consult the @file{NEWS}
1069 file for more information.
1072 @node New in Emacs 22
1073 @section What is different about Emacs 22?
1074 @cindex Differences between Emacs 21 and Emacs 22
1075 @cindex Emacs 22, new features in
1077 @itemize
1078 @cindex GTK+ Toolkit
1079 @cindex Drag-and-drop
1080 @item
1081 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1082 operation on X.
1084 @cindex Supported systems
1085 @item
1086 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1087 machines, as well as support for the Mac OS X and Cygwin operating
1088 systems.
1090 @item
1091 The native MS-Windows, and Mac OS X builds include full support
1092 for images, toolbar, and tooltips.
1094 @item
1095 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1096 enabled by default.
1098 @item
1099 The maximum size of buffers is increased: on 32-bit machines, it is
1100 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above.
1102 @item
1103 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1105 @cindex Mouse wheel
1106 @item
1107 Mouse wheel support is enabled by default.
1109 @item
1110 Window fringes are customizable.
1112 @item
1113 The mode line of the selected window is now highlighted.
1115 @item
1116 The minibuffer prompt is displayed in a distinct face.
1118 @item
1119 Abbrev definitions are read automatically at startup.
1121 @item
1122 Grep mode is separate from Compilation mode and has many new options and
1123 commands specific to grep.
1125 @item
1126 The original Emacs macro system has been replaced by the new Kmacro
1127 package, which provides many new commands and features and a simple
1128 interface that uses the function keys F3 and F4.  Macros are stored in a
1129 macro ring, and can be debugged and edited interactively.
1131 @item
1132 The Grand Unified Debugger (GUD) can be used with a full graphical user
1133 interface to GDB; this provides many features found in traditional
1134 development environments, making it easy to manipulate breakpoints, add
1135 watch points, display the call stack, etc.  Breakpoints are visually
1136 indicated in the source buffer.
1138 @item
1139 @cindex New modes
1140 Many new modes and packages have been included in Emacs, such as Calc,
1141 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1142 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1143 savehist, Conf mode, Python mode, DNS mode, etc.
1145 @cindex Multilingual Environment
1146 @item
1147 Leim is now part of Emacs.  Unicode support has been much improved, and
1148 the following input methods have been added: belarusian, bulgarian-bds,
1149 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1150 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1151 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1152 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1153 ukrainian-computer, vietnamese-telex, and welsh.
1155 The following language environments have also been added: Belarusian,
1156 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1157 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1158 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1160 @cindex Documentation
1161 @cindex Emacs Lisp Manual
1162 @item
1163 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1164 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1165 @end itemize
1168 @node New in Emacs 21
1169 @section What is different about Emacs 21?
1170 @cindex Differences between Emacs 20 and Emacs 21
1171 @cindex Emacs 21, new features in
1173 @cindex Variable-size fonts
1174 @cindex Toolbar support
1175 Emacs 21 features a thorough rewrite of the display engine.  The new
1176 display engine supports variable-size fonts, images, and can play sounds
1177 on platforms which support that.  As a result, the visual appearance of
1178 Emacs, when it runs on a windowed display, is much more reminiscent of
1179 modern GUI programs, and includes 3D widgets (used for the mode line and
1180 the scroll bars), a configurable and extensible toolbar, tooltips
1181 (a.k.a.@: balloon help), and other niceties.
1183 @cindex Colors on text-only terminals
1184 @cindex TTY colors
1185 In addition, Emacs 21 supports faces on text-only terminals.  This means
1186 that you can now have colors when you run Emacs on a GNU/Linux console
1187 and on @code{xterm} with @kbd{emacs -nw}.
1190 @node New in Emacs 20
1191 @section What is different about Emacs 20?
1192 @cindex Differences between Emacs 19 and Emacs 20
1193 @cindex Emacs 20, new features in
1195 The differences between Emacs versions 18 and 19 were rather dramatic;
1196 the introduction of frames, faces, and colors on windowing systems was
1197 obvious to even the most casual user.
1199 There are differences between Emacs versions 19 and 20 as well, but many
1200 are more subtle or harder to find.  Among the changes are the inclusion
1201 of MULE code for languages that use non-Latin characters and for mixing
1202 several languages in the same document; the ``Customize'' facility for
1203 modifying variables without having to use Lisp; and automatic conversion
1204 of files from Macintosh, Microsoft, and Unix platforms.
1206 @c ------------------------------------------------------------
1207 @node Common requests
1208 @chapter Common requests
1209 @cindex Common requests
1211 @menu
1212 * Setting up a customization file::
1213 * Using Customize::
1214 * Colors on a TTY::
1215 * Debugging a customization file::
1216 * Displaying the current line or column::
1217 * Displaying the current file name in the titlebar::
1218 * Turning on abbrevs by default::
1219 * Associating modes with files::
1220 * Highlighting a region::
1221 * Replacing highlighted text::
1222 * Controlling case sensitivity::
1223 * Working with unprintable characters::
1224 * Searching for/replacing newlines::
1225 * Yanking text in isearch::
1226 * Wrapping words automatically::
1227 * Turning on auto-fill by default::
1228 * Changing load-path::
1229 * Using an already running Emacs process::
1230 * Compiler error messages::
1231 * Indenting switch statements::
1232 * Customizing C and C++ indentation::
1233 * Horizontal scrolling::
1234 * Overwrite mode::
1235 * Turning off beeping::
1236 * Turning the volume down::
1237 * Automatic indentation::
1238 * Matching parentheses::
1239 * Hiding #ifdef lines::
1240 * Repeating commands::
1241 * Valid X resources::
1242 * Evaluating Emacs Lisp code::
1243 * Changing the length of a Tab::
1244 * Inserting text at the beginning of each line::
1245 * Forcing the cursor to remain in the same column::
1246 * Forcing Emacs to iconify itself::
1247 * Using regular expressions::
1248 * Replacing text across multiple files::
1249 * Documentation for etags::
1250 * Disabling backups::
1251 * Disabling auto-save-mode::
1252 * Going to a line by number::
1253 * Modifying pull-down menus::
1254 * Deleting menus and menu options::
1255 * Turning on syntax highlighting::
1256 * Scrolling only one line::
1257 * Editing MS-DOS files::
1258 * Filling paragraphs with a single space::
1259 * Escape sequences in shell output::
1260 * Fullscreen mode on MS-Windows::
1261 @end menu
1263 @node Setting up a customization file
1264 @section How do I set up a @file{.emacs} file properly?
1265 @cindex @file{.emacs} file, setting up
1266 @cindex @file{.emacs} file, locating
1267 @cindex Init file, setting up
1268 @cindex Customization file, setting up
1270 @inforef{Init File, Init File, emacs}.
1272 In general, new Emacs users should not be provided with @file{.emacs}
1273 files, because this can cause confusing non-standard behavior.  Then
1274 they send questions to @email{help-gnu-emacs@@gnu.org} asking why Emacs
1275 isn't behaving as documented.
1277 Emacs includes the Customize facility (@pxref{Using Customize}).  This
1278 allows users who are unfamiliar with Emacs Lisp to modify their
1279 @file{.emacs} files in a relatively straightforward way, using menus
1280 rather than Lisp code.
1282 While Customize might indeed make it easier to configure Emacs,
1283 consider taking a bit of time to learn Emacs Lisp and modifying your
1284 @file{.emacs} directly.  Simple configuration options are described
1285 rather completely in @inforef{Init File, Init File, emacs}, for users
1286 interested in performing frequently requested, basic tasks.
1288 Sometimes users are unsure as to where their @file{.emacs} file should
1289 be found.  Visiting the file as @file{~/.emacs} from Emacs will find
1290 the correct file.
1292 @node Using Customize
1293 @section How do I start using Customize?
1294 @cindex Customize groups
1295 @cindex Customizing variables
1296 @cindex Customizing faces
1298 The main Customize entry point is @kbd{M-x customize @key{RET}}.  This
1299 command takes you to a buffer listing all the available Customize
1300 groups.  From there, you can access all customizable options and faces,
1301 change their values, and save your changes to your init file.
1302 @inforef{Easy Customization, Easy Customization, emacs}.
1304 If you know the name of the group in advance (e.g. ``shell''), use
1305 @kbd{M-x customize-group @key{RET}}.
1307 If you wish to customize a single option, use @kbd{M-x customize-option
1308 @key{RET}}.  This command prompts you for the name of the option to
1309 customize, with completion.
1311 @node Colors on a TTY
1312 @section How do I get colors and syntax highlighting on a TTY?
1313 @cindex Colors on a TTY
1314 @cindex Syntax highlighting on a TTY
1315 @cindex Console, colors
1317 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1318 i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when
1319 invoked as @samp{emacs -nw} on X, and MS-Windows.  (Colors and faces were
1320 supported in the MS-DOS port since Emacs 19.29.)  Emacs automatically
1321 detects color support at startup and uses it if available.  If you think
1322 that your terminal supports colors, but Emacs won't use them, check the
1323 @code{termcap} entry for your display type for color-related
1324 capabilities.
1326 The command @kbd{M-x list-colors-display} pops up a window which
1327 exhibits all the colors Emacs knows about on the current display.
1329 Syntax highlighting is on by default since version 22.1.
1331 @node Debugging a customization file
1332 @section How do I debug a @file{.emacs} file?
1333 @cindex Debugging @file{.emacs} file
1334 @cindex @file{.emacs} debugging
1335 @cindex Init file debugging
1336 @cindex @samp{-debug-init} option
1338 Start Emacs with the @samp{-debug-init} command-line option.  This
1339 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1340 file, and places you in the debugger if something goes wrong.  The top
1341 line in the @file{trace-back} buffer will be the error message, and the
1342 second or third line of that buffer will display the Lisp code from your
1343 @file{.emacs} file that caused the problem.
1345 You can also evaluate an individual function or argument to a function
1346 in your @file{.emacs} file by moving the cursor to the end of the
1347 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1348 eval-last-sexp}).
1350 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1351 variables which you are trying to set or use.
1353 @node Displaying the current line or column
1354 @section How do I make Emacs display the current line (or column) number?
1355 @cindex @code{line-number-mode}
1356 @cindex Displaying the current line or column
1357 @cindex Line number, displaying the current
1358 @cindex Column, displaying the current
1359 @cindex @code{mode-line-format}
1361 By default, Emacs displays the current line number of the point in the
1362 mode line.  You can toggle this feature off or on with the command
1363 @kbd{M-x line-number-mode}, or by setting the variable
1364 @code{line-number-mode}.  Note that Emacs will not display the line
1365 number if the buffer's size in bytes is larger than the value of the
1366 variable @code{line-number-display-limit}.
1368 You can similarly display the current column with
1369 @kbd{M-x column-number-mode}, or by putting the form
1371 @lisp
1372 (setq column-number-mode t)
1373 @end lisp
1375 @noindent
1376 in your @file{.emacs} file.  This feature is off by default.
1378 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1379 will insert the current column's value into the mode line.  See the
1380 documentation for @code{mode-line-format} (using @kbd{C-h v
1381 mode-line-format @key{RET}}) for more information on how to set and use
1382 this variable.
1384 @cindex Set number capability in @code{vi} emulators
1385 The @samp{linum} package (distributed with Emacs since version 23.1)
1386 displays line numbers in the left margin, like the ``set number''
1387 capability of @code{vi}.  The packages @samp{setnu} and
1388 @samp{wb-line-number} (not distributed with Emacs) also implement this
1389 feature.
1391 @node Displaying the current file name in the titlebar
1392 @section How can I modify the titlebar to contain the current file name?
1393 @cindex Titlebar, displaying the current file name in
1394 @cindex File name, displaying in the titlebar
1395 @cindex @code{frame-title-format}
1397 The contents of an Emacs frame's titlebar is controlled by the variable
1398 @code{frame-title-format}, which has the same structure as the variable
1399 @code{mode-line-format}.  (Use @kbd{C-h v} or @kbd{M-x
1400 describe-variable} to get information about one or both of these
1401 variables.)
1403 By default, the titlebar for a frame does contain the name of the buffer
1404 currently being visited, except if there is a single frame.  In such a
1405 case, the titlebar contains Emacs invocation name and the name of the
1406 machine at which Emacs was invoked.  This is done by setting
1407 @code{frame-title-format} to the default value of
1409 @lisp
1410 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1411 @end lisp
1413 To modify the behavior such that frame titlebars contain the buffer's
1414 name regardless of the number of existing frames, include the following
1415 in your @file{.emacs}:
1417 @lisp
1418 (setq frame-title-format "%b")
1419 @end lisp
1421 @node Turning on abbrevs by default
1422 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1423 @cindex Abbrevs, turning on by default
1425 Abbrev mode expands abbreviations as you type them.  To turn it on in a
1426 specific buffer, use @kbd{M-x abbrev-mode}.  To turn it on in every
1427 buffer by default, put this in your @file{.emacs} file:
1429 @lisp
1430 (setq-default abbrev-mode t)
1431 @end lisp
1433 @noindent To turn it on in a specific mode, use:
1435 @lisp
1436 (add-hook '@var{mymode}-mode-hook
1437           (lambda ()
1438            (setq abbrev-mode t)))
1439 @end lisp
1441 @noindent If your Emacs version is older then 22.1, you will also need to use:
1443 @lisp
1444 (condition-case ()
1445    (quietly-read-abbrev-file)
1446   (file-error nil))
1447 @end lisp
1449 @node Associating modes with files
1450 @section How do I make Emacs use a certain major mode for certain files?
1451 @cindex Associating modes with files
1452 @cindex File extensions and modes
1453 @cindex @code{auto-mode-alist}, modifying
1454 @cindex Modes, associating with file extensions
1456 If you want to use a certain mode @var{foo} for all files whose names end
1457 with the extension @file{.@var{bar}}, this will do it for you:
1459 @lisp
1460 (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode))
1461 @end lisp
1463 Alternatively, put this somewhere in the first line of any file you want to
1464 edit in the mode @var{foo} (in the second line, if the first line begins
1465 with @samp{#!}):
1467 @example
1468 -*- @var{foo} -*-
1469 @end example
1471 @cindex Major mode for shell scripts
1472 The variable @code{interpreter-mode-alist} specifies which mode to use
1473 when loading an interpreted script (e.g. shell, python, etc.).  Emacs
1474 determines which interpreter you're using by examining the first line of
1475 the script.  Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
1476 @code{interpreter-mode-alist} to learn more.
1478 @node Highlighting a region
1479 @section How can I highlight a region of text in Emacs?
1480 @cindex Highlighting text
1481 @cindex Text, highlighting
1482 @cindex @code{transient-mark-mode}
1483 @cindex Region, highlighting a
1485 You can cause the region to be highlighted when the mark is active by
1486 including
1488 @lisp
1489 (transient-mark-mode 1)
1490 @end lisp
1492 @noindent
1493 in your @file{.emacs} file.  Since Emacs 23.1, this feature is on by default.
1495 @node Replacing highlighted text
1496 @section How can I replace highlighted text with what I type?
1497 @cindex @code{delete-selection-mode}
1498 @cindex Replacing highlighted text
1499 @cindex Highlighting and replacing text
1501 Use @code{delete-selection-mode}, which you can start automatically by
1502 placing the following Lisp form in your @file{.emacs} file:
1504 @lisp
1505 (delete-selection-mode 1)
1506 @end lisp
1508 According to the documentation string for @code{delete-selection-mode}
1509 (which you can read using @kbd{M-x describe-function @key{RET}
1510 delete-selection-mode @key{RET}}):
1512 @quotation
1513 When Delete Selection mode is enabled, Transient Mark mode is also
1514 enabled and typed text replaces the selection if the selection is
1515 active.  Otherwise, typed text is just inserted at point regardless of
1516 any selection.
1517 @end quotation
1519 This mode also allows you to delete (not kill) the highlighted region by
1520 pressing @key{DEL}.
1522 @node Controlling case sensitivity
1523 @section How do I control Emacs's case-sensitivity when searching/replacing?
1524 @cindex @code{case-fold-search}
1525 @cindex Case sensitivity of searches
1526 @cindex Searching without case sensitivity
1527 @cindex Ignoring case in searches
1529 @c FIXME
1530 The value of the variable @code{case-fold-search} determines whether
1531 searches are case sensitive:
1533 @lisp
1534 (setq case-fold-search nil) ; make searches case sensitive
1535 (setq case-fold-search t)   ; make searches case insensitive
1536 @end lisp
1538 @cindex Case sensitivity in replacements
1539 @cindex Replacing, and case sensitivity
1540 @cindex @code{case-replace}
1541 Similarly, for replacing, the variable @code{case-replace} determines
1542 whether replacements preserve case.
1544 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1546 To change the case sensitivity just for one major mode, use the major
1547 mode's hook.  For example:
1549 @lisp
1550 (add-hook '@var{foo}-mode-hook
1551           (lambda ()
1552            (setq case-fold-search nil)))
1553 @end lisp
1555 @node Working with unprintable characters
1556 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1557 @cindex Unprintable characters, working with
1558 @cindex Working with unprintable characters
1559 @cindex Control characters, working with
1560 @cindex Eight-bit characters, working with
1561 @cindex Searching for unprintable characters
1562 @cindex Regexps and unprintable characters
1564 To search for a single character that appears in the buffer as, for
1565 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.
1566 Searching for @strong{all} unprintable characters is best done with a
1567 regular expression (@dfn{regexp}) search.  The easiest regexp to use for
1568 the unprintable chars is the complement of the regexp for the printable
1569 chars.
1571 @itemize @bullet
1573 @item
1574 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1576 @item
1577 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1579 @end itemize
1581 To type these special characters in an interactive argument to
1582 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1583 use @kbd{C-q}.  (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1584 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.)  So,
1585 to search for unprintable characters using @code{re-search-forward}:
1587 @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}}
1589 Using @code{isearch-forward-regexp}:
1591 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1593 To delete all unprintable characters, simply use replace-regexp:
1595 @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}}
1597 Replacing is similar to the above.  To replace all unprintable
1598 characters with a colon, use:
1600 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}
1602 @node Searching for/replacing newlines
1603 @section How do I input a newline character in isearch or query-replace?
1604 @cindex Searching for newlines
1605 @cindex Replacing newlines
1607 Use @kbd{C-q C-j}.  For more information, see @inforef{Special Isearch,
1608 Special Input for Incremental Search, emacs}.
1611 @node Yanking text in isearch
1612 @section How do I copy text from the kill ring into the search string?
1613 @cindex Yanking text into the search string
1614 @cindex isearch yanking
1616 Use @kbd{M-y}.  @inforef{Isearch Yank, Isearch Yanking, emacs}.
1618 @node Wrapping words automatically
1619 @section How do I make Emacs wrap words for me?
1620 @cindex Wrapping word automatically
1621 @cindex Wrapping lines
1622 @cindex Line wrap
1623 @cindex @code{auto-fill-mode}, introduction to
1624 @cindex Maximum line width, default value
1625 @cindex @code{fill-column}, default value
1627 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1628 The default maximum line width is 70, determined by the variable
1629 @code{fill-column}.  To learn how to turn this on automatically, see
1630 @ref{Turning on auto-fill by default}.
1632 @node Turning on auto-fill by default
1633 @section How do I turn on @code{auto-fill-mode} by default?
1634 @cindex @code{auto-fill-mode}, activating automatically
1635 @cindex Filling automatically
1636 @cindex Automatic entry to @code{auto-fill-mode}
1638 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1639 auto-fill-mode}.
1641 To turn it on for every buffer in a certain mode, you must use the hook
1642 for that mode.  For example, to turn on @code{auto-fill} mode for all
1643 text buffers, including the following in your @file{.emacs} file:
1645 @lisp
1646 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1647 @end lisp
1649 If you want @code{auto-fill} mode on in all major modes, do this:
1651 @lisp
1652 (setq-default auto-fill-function 'do-auto-fill)
1653 @end lisp
1655 @node Changing load-path
1656 @section How do I change @code{load-path}?
1657 @cindex @code{load-path}, modifying
1658 @cindex Modifying @code{load-path}
1659 @cindex Adding to @code{load-path}
1661 In general, you should only add to the @code{load-path}.  You can add
1662 directory @var{/dir/subdir} to the load path like this:
1664 @lisp
1665 (add-to-list 'load-path "/dir/subdir/")
1666 @end lisp
1668 To do this relative to your home directory:
1670 @lisp
1671 (add-to-list 'load-path "~/mysubdir/")
1672 @end lisp
1674 @node Using an already running Emacs process
1675 @section How do I use an already running Emacs from another window?
1676 @cindex @code{emacsclient}
1677 @cindex Emacs server functions
1678 @cindex Using an existing Emacs process
1680 @code{emacsclient}, which comes with Emacs, is for editing a file using
1681 an already running Emacs rather than starting up a new Emacs.  It does
1682 this by sending a request to the already running Emacs, which must be
1683 expecting the request.
1685 @itemize @bullet
1687 @item
1688 Setup:
1690 Emacs must have executed the @code{server-start} function for
1691 @samp{emacsclient} to work.  This can be done either by a command line
1692 option:
1694 @example
1695 emacs -f server-start
1696 @end example
1698 or by invoking @code{server-start} from @file{.emacs}:
1700 @lisp
1701 (if (@var{some conditions are met}) (server-start))
1702 @end lisp
1704 When this is done, Emacs creates a Unix domain socket named
1705 @file{server} in @file{/tmp/emacs@var{userid}}. See
1706 @code{server-socket-dir}.
1708 To get your news reader, mail reader, etc., to invoke
1709 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1710 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}.  You may
1711 have to specify the full pathname of the @samp{emacsclient} program
1712 instead.  Examples:
1714 @example
1715 # csh commands:
1716 setenv EDITOR emacsclient
1718 # using full pathname
1719 setenv EDITOR /usr/local/emacs/etc/emacsclient
1721 # sh command:
1722 EDITOR=emacsclient ; export EDITOR
1723 @end example
1725 @item
1726 Normal use:
1728 When @samp{emacsclient} is run, it connects to the socket and passes its
1729 command line options to Emacs, which at the next opportunity will visit
1730 the files specified.  (Line numbers can be specified just like with
1731 Emacs.)  The user will have to switch to the Emacs window by hand.  When
1732 the user is done editing a file, the user can type @kbd{C-x #} (or
1733 @kbd{M-x server-edit}) to indicate this.  If there is another buffer
1734 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1735 @code{emacsclient} will exit, signaling the calling program to continue.
1737 @cindex @code{gnuserv}
1738 There is an alternative version of @samp{emacsclient} called
1739 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman}
1740 (@pxref{Packages that do not come with Emacs}).  @samp{gnuserv} uses
1741 Internet domain sockets, so it can work across most network connections.
1743 The most recent @samp{gnuserv} package is available at
1745 @uref{http://meltin.net/hacks/emacs/}
1747 @end itemize
1749 @node Compiler error messages
1750 @section How do I make Emacs recognize my compiler's funny error messages?
1751 @cindex Compiler error messages, recognizing
1752 @cindex Recognizing non-standard compiler errors
1753 @cindex Regexps for recognizing compiler errors
1754 @cindex Errors, recognizing compiler
1756 Customize the @code{compilation-error-regexp-alist} variable.
1758 @node Indenting switch statements
1759 @section How do I change the indentation for @code{switch}?
1760 @cindex @code{switch}, indenting
1761 @cindex Indenting of @code{switch}
1763 Many people want to indent their @code{switch} statements like this:
1765 @example
1768   switch(x) @{
1769     case A:
1770       x1;
1771       break;
1772     case B:
1773       x2;
1774       break;
1775     default:
1776       x3;
1777   @}
1779 @end example
1781 @noindent To achieve this, add the following line to your @file{.emacs}:
1783 @lisp
1784 (c-set-offset 'case-label '+)
1785 @end lisp
1787 @node Customizing C and C++ indentation
1788 @section How to customize indentation in C, C@t{++}, and Java buffers?
1789 @cindex Indentation, how to customize
1790 @cindex Customize indentation
1792 The Emacs @code{cc-mode} features an interactive procedure for
1793 customizing the indentation style, which is fully explained in the
1794 @cite{CC Mode} manual that is part of the Emacs distribution, see
1795 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1796 The CC Mode Manual}.  Here's a short summary of the procedure:
1798 @enumerate
1799 @item
1800 Go to the beginning of the first line where you don't like the
1801 indentation and type @kbd{C-c C-o}.  Emacs will prompt you for the
1802 syntactic symbol; type @key{RET} to accept the default it suggests.
1804 @item
1805 Emacs now prompts for the offset of this syntactic symbol, showing the
1806 default (the current definition) inside parentheses.  You can choose
1807 one of these:
1809 @table @code
1810 @item 0
1811 No extra indentation.
1812 @item +
1813 Indent one basic offset.
1814 @item -
1815 Outdent one basic offset.
1816 @item ++
1817 Indent two basic offsets
1818 @item --
1819 Outdent two basic offsets.
1820 @item *
1821 Indent half basic offset.
1822 @item /
1823 Outdent half basic offset.
1824 @end table
1826 @item
1827 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1828 the line or the block according to what you just specified.
1830 @item
1831 If you don't like the result, go back to step 1.  Otherwise, add the
1832 following line to your @file{.emacs}:
1834 @lisp
1835 (c-set-offset '@var{syntactic-symbol} @var{offset})
1836 @end lisp
1838 @noindent
1839 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1840 when you type @kbd{C-c C-o} at the beginning of the line, and
1841 @var{offset} is one of the indentation symbols listed above (@code{+},
1842 @code{/}, @code{0}, etc.) that you've chosen during the interactive
1843 procedure.
1845 @item
1846 Go to the next line whose indentation is not to your liking and repeat
1847 the process there.
1848 @end enumerate
1850 It is recommended to put all the resulting @code{(c-set-offset ...)}
1851 customizations inside a C mode hook, like this:
1853 @lisp
1854 (defun my-c-mode-hook ()
1855   (c-set-offset ...)
1856   (c-set-offset ...))
1857 (add-hook 'c-mode-hook 'my-c-mode-hook)
1858 @end lisp
1860 @noindent
1861 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1862 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1863 might be unavailable when @code{cc-mode} is not loaded.
1865 Note that @code{c-mode-hook} runs for C source files only; use
1866 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1867 Java sources, etc.  If you want the same customizations to be in
1868 effect in @emph{all} languages supported by @code{cc-mode}, use
1869 @code{c-mode-common-hook}.
1871 @node Horizontal scrolling
1872 @section How can I make Emacs automatically scroll horizontally?
1873 @cindex @code{hscroll-mode}
1874 @cindex Horizontal scrolling
1875 @cindex Scrolling horizontally
1877 In Emacs 21 and later, this is on by default: if the variable
1878 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1879 automatically scrolls the display horizontally when point moves off the
1880 left or right edge of the window.
1882 Note that this is overridden by the variable
1883 @code{truncate-partial-width-windows} if that variable is non-nil
1884 and the current buffer is not full-frame width.
1886 In Emacs 20, use @code{hscroll-mode}.
1888 @node Overwrite mode
1889 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
1890 @cindex @key{Insert}
1891 @cindex @code{overwrite-mode}
1892 @cindex Overwriting existing text
1893 @cindex Toggling @code{overwrite-mode}
1895 @kbd{M-x overwrite-mode} (a minor mode).  This toggles
1896 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1897 is as easy as another @kbd{M-x overwrite-mode}.
1899 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1901 @node Turning off beeping
1902 @section How do I stop Emacs from beeping on a terminal?
1903 @cindex Beeping, turning off
1904 @cindex Visible bell
1905 @cindex Bell, visible
1907 @email{martin@@cc.gatech.edu, Martin R. Frank} writes:
1909 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1910 and set the visible bell to nothing.
1912 That is, put the following in your @code{TERMCAP} environment variable
1913 (assuming you have one):
1915 @example
1916 ... :vb=: ...
1917 @end example
1919 And evaluate the following Lisp form:
1921 @example
1922 (setq visible-bell t)
1923 @end example
1925 @node Turning the volume down
1926 @section How do I turn down the bell volume in Emacs running under X?
1927 @cindex Bell, volume of
1928 @cindex Volume of bell
1930 On X Window system, you can adjust the bell volume and duration for all
1931 programs with the shell command @code{xset}.
1933 Invoking @code{xset} without any arguments produces some basic
1934 information, including the following:
1936 @example
1937 usage:  xset [-display host:dpy] option ...
1938   To turn bell off:
1939       -b                b off               b 0
1940   To set bell volume, pitch and duration:
1941        b [vol [pitch [dur]]]          b on
1942 @end example
1944 @node Automatic indentation
1945 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
1946 @cindex Indenting new lines
1947 @cindex New lines, indenting of
1948 @cindex Previous line, indenting according to
1949 @cindex Text indentation
1951 Such behavior is automatic (in Text mode) in Emacs 20 and later.  From the
1952 @file{etc/NEWS} file for Emacs 20.2:
1954 @example
1955 ** In Text mode, now only blank lines separate paragraphs.  This makes
1956 it possible to get the full benefit of Adaptive Fill mode in Text mode,
1957 and other modes derived from it (such as Mail mode).  @key{TAB} in Text
1958 mode now runs the command @code{indent-relative}; this makes a practical
1959 difference only when you use indented paragraphs.
1961 If you want spaces at the beginning of a line to start a paragraph, use
1962 the new mode, Paragraph Indent Text mode.
1963 @end example
1965 @cindex Prefixing lines
1966 @cindex Fill prefix
1967 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
1968 by default}), you can tell Emacs to prefix every line with a certain
1969 character sequence, the @dfn{fill prefix}.  Type the prefix at the
1970 beginning of a line, position point after it, and then type @kbd{C-x .}
1971 (@code{set-fill-prefix}) to set the fill prefix.  Thereafter,
1972 auto-filling will automatically put the fill prefix at the beginning of
1973 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
1974 prefix when refilling the paragraph.
1976 If you have paragraphs with different levels of indentation, you will
1977 have to set the fill prefix to the correct value each time you move to a
1978 new paragraph.  There are many packages available to deal with this
1979 (@pxref{Packages that do not come with Emacs}).  Look for ``fill'' and
1980 ``indent'' keywords for guidance.
1982 @node Matching parentheses
1983 @section How do I show which parenthesis matches the one I'm looking at?
1984 @cindex Parentheses, matching
1985 @cindex @file{paren.el}
1986 @cindex Highlighting matching parentheses
1987 @cindex Pairs of parentheses, highlighting
1988 @cindex Matching parentheses
1990 Call @code{show-paren-mode} in your @file{.emacs} file:
1992 @lisp
1993 (show-paren-mode 1)
1994 @end lisp
1996 You can also enable this mode by selecting the @samp{Paren Match
1997 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
1998 at the top of any Emacs frame.
2000 Alternatives to this mode include:
2002 @itemize @bullet
2004 @item
2005 If you're looking at a right parenthesis (or brace or bracket) you can
2006 delete it and reinsert it.  Emacs will momentarily move the cursor to
2007 the matching parenthesis.
2009 @item
2010 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2011 will skip over one set of balanced parentheses, so you can see which
2012 parentheses match.  (You can train it to skip over balanced brackets
2013 and braces at the same time by modifying the syntax table.)
2015 @cindex Show matching paren as in @code{vi}
2016 @item
2017 Here is some Emacs Lisp that will make the @key{%} key show the matching
2018 parenthesis, like in @code{vi}.  In addition, if the cursor isn't over a
2019 parenthesis, it simply inserts a % like normal.
2021 @lisp
2022 ;; By an unknown contributor
2024 (global-set-key "%" 'match-paren)
2026 (defun match-paren (arg)
2027   "Go to the matching paren if on a paren; otherwise insert %."
2028   (interactive "p")
2029   (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2030         ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2031         (t (self-insert-command (or arg 1)))))
2032 @end lisp
2034 @end itemize
2036 @node Hiding #ifdef lines
2037 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2038 @cindex @code{#ifdef}, selective display of
2039 @cindex @code{hide-ifdef-mode}
2040 @cindex Hiding @code{#ifdef} text
2041 @cindex Selectively displaying @code{#ifdef} code
2043 @kbd{M-x hide-ifdef-mode}.  (This is a minor mode.)  You might also want
2044 to investigate @file{cpp.el}, which is distributed with Emacs.
2046 @node Repeating commands
2047 @section How do I repeat a command as many times as possible?
2048 @cindex Repeating commands many times
2049 @cindex Commands, repeating many times
2050 @cindex @code{.}, equivalent to @code{vi} command
2052 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2053 that repeats the last command.  If you preface it with a prefix
2054 argument, the prefix arg is applied to the command.
2056 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2057 (@code{repeat-complex-command}) to reinvoke commands that used the
2058 minibuffer to get arguments.  In @code{repeat-complex-command} you can
2059 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2060 keyboard has these keys) to scan through all the different complex
2061 commands you've typed.
2063 To repeat a set of commands, use keyboard macros.  Use @kbd{C-x (} and
2064 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2065 type @kbd{C-x e}.  (@inforef{Keyboard Macros, Keyboard Macros, emacs}.)
2067 If you're really desperate for the @code{.} command in @code{vi} that
2068 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2069 mode which comes with Emacs, and which appears to support it.
2071 @node Valid X resources
2072 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2073 @cindex Resources, X
2074 @cindex X resources
2075 @cindex Setting X resources
2077 @inforef{X Resources, X Resources, emacs}.
2079 You can also use a resource editor, such as editres (for X11R5 and
2080 onwards), to look at the resource names for the menu bar, assuming Emacs
2081 was compiled with the X toolkit.
2083 @node Evaluating Emacs Lisp code
2084 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2085 @cindex Evaluating Lisp code
2086 @cindex Lisp forms, evaluating
2088 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2089 Emacs Lisp @dfn{form}:
2091 @itemize @bullet
2093 @item
2094 If you want it evaluated every time you run Emacs, put it in a file
2095 named @file{.emacs} in your home directory.  This is known as ``your
2096 @file{.emacs} file,'' and contains all of your personal customizations.
2098 @item
2099 You can type the form in the @file{*scratch*} buffer, and then type
2100 @key{LFD} (or @kbd{C-j}) after it.  The result of evaluating the form
2101 will be inserted in the buffer.
2103 @item
2104 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2105 before or around point.
2107 @item
2108 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2109 before point and prints its value in the echo area.
2111 @item
2112 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2113 form in the minibuffer which will be evaluated once you press @key{RET}.
2115 @item
2116 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2117 forms in a file.  (To do this from Lisp use the function @code{load}
2118 instead.)
2120 The functions @code{load-library}, @code{eval-region},
2121 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2122 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2123 about them.
2125 @end itemize
2127 @node Changing the length of a Tab
2128 @section How do I change Emacs's idea of the @key{TAB} character's length?
2129 @cindex Tab length
2130 @cindex Length of tab character
2132 Set the default value of the variable @code{tab-width}.  For example, to set
2133 @key{TAB} stops every 10 characters, insert the following in your
2134 @file{.emacs} file:
2136 @lisp
2137 (setq-default tab-width 10)
2138 @end lisp
2140 Do not confuse variable @code{tab-width} with variable
2141 @code{tab-stop-list}.  The former is used for the display of literal
2142 @key{TAB} characters.  The latter controls what characters are inserted
2143 when you press the @key{TAB} character in certain modes.
2145 @node Inserting text at the beginning of each line
2146 @section How do I insert <some text> at the beginning of every line?
2147 @cindex Prefixing a region with some text
2148 @cindex Prefix character, inserting in mail/news replies
2149 @cindex Replies to mail/news, inserting a prefix character
2150 @cindex @code{mail-yank-prefix}
2151 @cindex Mail replies, inserting a prefix character
2152 @cindex News replies, inserting a prefix character
2154 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2155 @key{RET} ^ @key{RET} your text @key{RET}}.
2157 To do this to a region, use @code{string-insert-rectangle}.
2158 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2159 want to prefix, move the cursor to last line to be prefixed, and type
2160 @kbd{M-x string-insert-rectangle @key{RET}}.  To do this for the whole
2161 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2163 If you are trying to prefix a yanked mail message with @samp{>}, you
2164 might want to set the variable @code{mail-yank-prefix}.  In Message
2165 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2166 runs the function @code{comment-region}, it is a general-purpose
2167 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2169 @node Forcing the cursor to remain in the same column
2170 @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?
2171 @cindex @code{picture-mode}
2172 @cindex Remaining in the same column, regardless of contents
2173 @cindex Vertical movement in empty documents
2175 Use @kbd{M-x picture-mode}.
2177 See also the variable @code{track-eol} and the command
2178 @code{set-goal-column} bound to @kbd{C-x C-n}
2179 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2181 @node Forcing Emacs to iconify itself
2182 @section How do I tell Emacs to iconify itself?
2183 @cindex Iconification under the X Window System
2184 @cindex X Window System and iconification
2185 @cindex Suspending Emacs
2187 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2188 otherwise.  @inforef{Frame Commands, Frame Commands, emacs}.
2190 @node Using regular expressions
2191 @section How do I use regexps (regular expressions) in Emacs?
2192 @cindex Regexps
2193 @cindex Regular expressions
2194 @cindex Differences between Unix and Emacs regexps
2195 @cindex Unix regexps, differences from Emacs
2196 @cindex Text strings, putting regexps in
2198 @inforef{Regexp Backslash, Regexp Backslash, emacs}.
2200 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2201 are @samp{\(} and @samp{\)}.  Also, the string syntax for a backslash is
2202 @samp{\\}.  To specify a regular expression like @samp{xxx\(foo\|bar\)}
2203 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2205 Note the doubled backslashes!
2207 @itemize @bullet
2209 @item
2210 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2211 (@samp{[^...]})  can match a newline character (@key{LFD} a.k.a.@:
2212 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2213 characters not to match.
2215 @item
2216 The character syntax regexps (e.g., @samp{\sw}) are not
2217 meaningful inside character set regexps (e.g., @samp{[aeiou]}).  (This
2218 is actually typical for regexp syntax.)
2220 @end itemize
2222 @node Replacing text across multiple files
2223 @section How do I perform a replace operation across more than one file?
2224 @cindex Replacing strings across files
2225 @cindex Multiple files, replacing across
2226 @cindex Files, replacing strings across multiple
2227 @cindex Recursive search/replace operations
2229 Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the
2230 command @code{dired-do-query-replace-regexp} (@kbd{Q}), which allows
2231 users to replace regular expressions in multiple files.
2233 You can use this command to perform search/replace operations on
2234 multiple files by following the following steps:
2236 @itemize @bullet
2237 @item
2238 Assemble a list of files you want to operate on with either
2239 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2241 @item
2242 Mark all files in the resulting Dired buffer using @kbd{t}.
2244 @item
2245 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2246 files.
2248 @item
2249 To accept all replacements in each file, hit @kbd{!}.
2250 @end itemize
2252 Another way to do the same thing is to use the ``tags'' feature of
2253 Emacs: it includes the command @code{tags-query-replace} which performs
2254 a query-replace across all the files mentioned in the @file{TAGS} file.
2255 @inforef{Tags Search, Tags Search, emacs}.
2257 @node Documentation for etags
2258 @section Where is the documentation for @code{etags}?
2259 @cindex Documentation for @code{etags}
2260 @cindex @code{etags}, documentation for
2262 The @code{etags} man page should be in the same place as the
2263 @code{emacs} man page.
2265 Quick command-line switch descriptions are also available.  For example,
2266 @samp{etags -H}.
2268 @node Disabling backups
2269 @section How do I disable backup files?
2270 @cindex Backups, disabling
2271 @cindex Disabling backups
2273 You probably don't want to do this, since backups are useful, especially
2274 when something goes wrong.
2276 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2277 load @code{dired-x} by adding the following to your @file{.emacs} file:
2279 @lisp
2280 (add-hook 'dired-load-hook
2281           (lambda ()
2282            (require 'dired-x)))
2283 @end lisp
2285 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2286 You can make omitting the default for new dired buffers by putting the
2287 following in your @file{.emacs}:
2289 @lisp
2290 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2291 @end lisp
2293 If you're tired of seeing backup files whenever you do an @samp{ls} at
2294 the Unix shell, try GNU @code{ls} with the @samp{-B} option.  GNU
2295 @code{ls} is part of the GNU Fileutils package, available from
2296 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2298 To disable or change the way backups are made, @inforef{Backup Names, ,
2299 emacs}.
2301 @cindex Backup files in a single directory
2302 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2303 by customizing the variable @code{backup-directory-alist}.  This
2304 variable's value specifies that files whose names match specific patters
2305 should have their backups put in certain directories.  A typical use is
2306 to add the element @code{("." . @var{dir})} to force Emacs to put
2307 @strong{all} backup files in the directory @file{dir}.
2309 @node Disabling auto-save-mode
2310 @section How do I disable @code{auto-save-mode}?
2311 @cindex Disabling @code{auto-save-mode}
2312 @cindex Auto-saving
2313 @cindex Saving at frequent intervals
2315 You probably don't want to do this, since auto-saving is useful,
2316 especially when Emacs or your computer crashes while you are editing a
2317 document.
2319 Instead, you might want to change the variable
2320 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2321 waits before auto-saving.  Increasing this value forces Emacs to wait
2322 longer between auto-saves, which might annoy you less.
2324 You might also want to look into Sebastian Kremer's @code{auto-save}
2325 package (@pxref{Packages that do not come with Emacs}).  This
2326 package also allows you to place all auto-save files in one directory,
2327 such as @file{/tmp}.
2329 To disable or change how @code{auto-save-mode} works, @inforef{Auto
2330 Save, , emacs}.
2332 @node Going to a line by number
2333 @section How can I go to a certain line given its number?
2334 @cindex Going to a line by number
2335 @cindex Compilation error messages
2336 @cindex Recompilation
2338 Are you sure you indeed need to go to a line by its number?  Perhaps all
2339 you want is to display a line in your source file for which a compiler
2340 printed an error message?  If so, compiling from within Emacs using the
2341 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2342 effective way of doing that.  Emacs automatically intercepts the compile
2343 error messages, inserts them into a special buffer called
2344 @code{*compilation*}, and lets you visit the locus of each message in
2345 the source.  Type @kbd{C-x `} to step through the offending lines one by
2346 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2347 @kbd{M-g M-n} to go to the previous and next matches directly).  Click
2348 @kbd{Mouse-2} or press @key{RET} on a message text in the
2349 @code{*compilation*} buffer to go to the line whose number is mentioned
2350 in that message.
2352 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2353 (which is the default binding of the @code{goto-line} function starting
2354 with Emacs 22).  Emacs will prompt you for the number of the line and go
2355 to that line.
2357 You can do this faster by invoking @code{goto-line} with a numeric
2358 argument that is the line's number.  For example, @kbd{C-u 286 M-g M-g}
2359 will jump to line number 286 in the current buffer.
2361 @node Modifying pull-down menus
2362 @section How can I create or modify new pull-down menu options?
2363 @cindex Pull-down menus, creating or modifying
2364 @cindex Menus, creating or modifying
2365 @cindex Creating new menu options
2366 @cindex Modifying pull-down menus
2367 @cindex Menus and keymaps
2368 @cindex Keymaps and menus
2370 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2371 represents a local or global keymap.  Selecting a menu title with the
2372 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2374 So to add a menu option to an existing menu, all you have to do is add a
2375 new definition to the appropriate keymap.  Adding a @samp{Forward Word}
2376 item to the @samp{Edit} menu thus requires the following Lisp code:
2378 @lisp
2379 (define-key global-map
2380   [menu-bar edit forward]
2381   '("Forward word" . forward-word))
2382 @end lisp
2384 @noindent
2385 The first line adds the entry to the global keymap, which includes
2386 global menu bar entries.  Replacing the reference to @code{global-map}
2387 with a local keymap would add this menu option only within a particular
2388 mode.
2390 The second line describes the path from the menu-bar to the new entry.
2391 Placing this menu entry underneath the @samp{File} menu would mean
2392 changing the word @code{edit} in the second line to @code{file}.
2394 The third line is a cons cell whose first element is the title that will
2395 be displayed, and whose second element is the function that will be
2396 called when that menu option is invoked.
2398 To add a new menu, rather than a new option to an existing menu, we must
2399 define an entirely new keymap:
2401 @lisp
2402 (define-key global-map [menu-bar words]
2403   (cons "Words" (make-sparse-keymap "Words")))
2404 @end lisp
2406 The above code creates a new sparse keymap, gives it the name
2407 @samp{Words}, and attaches it to the global menu bar.  Adding the
2408 @samp{Forward Word} item to this new menu would thus require the
2409 following code:
2411 @lisp
2412 (define-key global-map
2413   [menu-bar words forward]
2414   '("Forward word" . forward-word))
2415 @end lisp
2417 @noindent
2418 Note that because of the way keymaps work, menu options are displayed
2419 with the more recently defined items at the top.  Thus if you were to
2420 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2421 order), the menu option @samp{baz} would appear at the top, and
2422 @samp{foo} would be at the bottom.
2424 One way to avoid this problem is to use the function @code{define-key-after},
2425 which works the same as @code{define-key}, but lets you modify where items
2426 appear.  The following Lisp code would insert the @samp{Forward Word}
2427 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2429 @lisp
2430 (define-key-after
2431   (lookup-key global-map [menu-bar edit])
2432   [forward]
2433   '("Forward word" . forward-word)
2434   'undo)
2435 @end lisp
2437 Note how the second and third arguments to @code{define-key-after} are
2438 different from those of @code{define-key}, and that we have added a new
2439 (final) argument, the function after which our new key should be
2440 defined.
2442 To move a menu option from one position to another, simply evaluate
2443 @code{define-key-after} with the appropriate final argument.
2445 More detailed information---and more examples of how to create and
2446 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2447 ``Menu Keymaps.''  (@xref{Emacs Lisp documentation}, for information on
2448 this manual.)
2450 @node Deleting menus and menu options
2451 @section How do I delete menus and menu options?
2452 @cindex Deleting menus and menu options
2453 @cindex Menus, deleting
2455 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2456 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2457 menus}), use:
2459 @lisp
2460 (define-key global-map [menu-bar words] nil)
2461 @end lisp
2463 Similarly, removing a menu option requires redefining a keymap entry to
2464 @code{nil}.  For example, to delete the @samp{Forward word} menu option
2465 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2466 menus}), use:
2468 @lisp
2469 (define-key global-map [menu-bar edit forward] nil)
2470 @end lisp
2472 @node Turning on syntax highlighting
2473 @section How do I turn on syntax highlighting?
2474 @cindex Syntax highlighting
2475 @cindex @code{font-lock-mode}
2476 @cindex Highlighting based on syntax
2477 @cindex Colorizing text
2478 @cindex FAQ, @code{font-lock-mode}
2480 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2481 highlighting in the current buffer.  It is enabled by default in Emacs
2482 22.1 and later.
2484 With @code{font-lock-mode} turned on, different types of text will
2485 appear in different colors.  For instance, in a programming mode,
2486 variables will appear in one face, keywords in a second, and comments in
2487 a third.
2489 To turn @code{font-lock-mode} off within an existing buffer, use
2490 @kbd{M-x font-lock-mode @key{RET}}.
2492 In Emacs 21 and earlier versions, you could use the following code in
2493 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2495 @lisp
2496 (global-font-lock-mode 1)
2497 @end lisp
2499 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2500 and cause an annoying delay in display, so several features exist to
2501 work around this.
2503 @cindex Just-In-Time syntax highlighting
2504 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2505 activates the new @dfn{Just-In-Time fontification} provided by
2506 @code{jit-lock-mode}.  @code{jit-lock-mode} defers the fontification of
2507 portions of buffer until you actually need to see them, and can also
2508 fontify while Emacs is idle.  This makes display of the visible portion
2509 of a buffer almost instantaneous.  For details about customizing
2510 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2512 @cindex Levels of syntax highlighting
2513 @cindex Decoration level, in @code{font-lock-mode}
2514 In versions of Emacs before 21, different levels of decoration are
2515 available, from slight to gaudy.  More decoration means you need to wait
2516 more time for a buffer to be fontified (or a faster machine).  To
2517 control how decorated your buffers should become, set the value of
2518 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2519 @code{nil} value indicating default (usually minimum) decoration, and a
2520 @code{t} value indicating the maximum decoration.  For the gaudiest
2521 possible look, then, include the line
2523 @lisp
2524 (setq font-lock-maximum-decoration t)
2525 @end lisp
2527 @noindent
2528 in your @file{.emacs} file.  You can also set this variable such that
2529 different modes are highlighted in a different ways; for more
2530 information, see the documentation for
2531 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2532 describe-variable @key{RET}}).
2534 Also see the documentation for the function @code{font-lock-mode},
2535 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2536 describe-function @key{RET} font-lock-mode @key{RET}}).
2538 To print buffers with the faces (i.e., colors and fonts) intact, use
2539 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2540 ps-print-region-with-faces}.  You will need a way to send text to a
2541 PostScript printer, or a PostScript interpreter such as Ghostscript;
2542 consult the documentation of the variables @code{ps-printer-name},
2543 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2545 @node Scrolling only one line
2546 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2547 @cindex Scrolling only one line
2548 @cindex Reducing the increment when scrolling
2550 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2551 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2552 to a large value like, say, 10000.  For an explanation of what this
2553 means, @inforef{Auto Scrolling, Auto Scrolling, emacs}.
2555 Alternatively, use the following Lisp form in your @file{.emacs}:
2557 @lisp
2558 (setq scroll-conservatively most-positive-fixnum)
2559 @end lisp
2561 @node Editing MS-DOS files
2562 @section How can I edit MS-DOS files using Emacs?
2563 @cindex Editing MS-DOS files
2564 @cindex MS-DOS files, editing
2565 @cindex Microsoft files, editing
2566 @cindex Windows files, editing
2568 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2569 performed transparently.  You can open MS-DOS files on a Unix system,
2570 edit it, and save it without having to worry about the file format.
2572 When editing an MS-DOS style file, the mode line will indicate that it
2573 is a DOS file.  On Unix and GNU/Linux systems, and also on a Macintosh,
2574 the string @samp{(DOS)} will appear near the left edge of the mode line;
2575 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2576 default, a backslash (@samp{\}) will appear in the mode line.
2578 @node Filling paragraphs with a single space
2579 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2580 @cindex One space following periods
2581 @cindex Single space following periods
2582 @cindex Periods, one space following
2584 Add the following line to your @file{.emacs} file:
2586 @lisp
2587 (setq sentence-end-double-space nil)
2588 @end lisp
2590 @node Escape sequences in shell output
2591 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2592 @cindex Escape sequences in @code{ls} output
2593 @cindex @code{ls} in Shell mode
2595 In many systems, @code{ls} is aliased to @samp{ls --color}, which
2596 prints using ANSI color escape sequences.  Emacs version 21.1 and
2597 later includes the @code{ansi-color} package, which lets Shell mode
2598 recognize these escape sequences.  In Emacs 23.2 and later, the
2599 package is enabled by default; in earlier versions you can enable it
2600 by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2601 by adding @code{(add-hook 'shell-mode-hook
2602 'ansi-color-for-comint-mode-on)} to your init file.
2604 In Emacs versions before 21.1, the @code{ansi-color} package is not
2605 included.  In that case, you need to unalias @code{ls} for interactive
2606 shells running in Emacs; this can be done by checking the @code{EMACS}
2607 variable in the environment.
2609 @node Fullscreen mode on MS-Windows
2610 @section How can I start Emacs in fullscreen mode on MS-Windows?
2611 @cindex Maximize frame
2612 @cindex Fullscreen mode
2614 Use the function @code{w32-send-sys-command}.  For example, you can
2615 put the following in your @file{.emacs} file:
2617 @lisp
2618 (add-hook 'term-setup-hook
2619           #'(lambda () (w32-send-sys-command ?\xF030)))
2620 @end lisp
2622 To avoid the slightly distracting visual effect of Emacs starting with
2623 its default frame size and then growing to fullscreen, you can add an
2624 @samp{Emacs.Geometry} entry to the Windows registry settings (see
2625 @pxref{(emacs)X Resources}).
2627 To compute the correct values for width and height, first maximize the
2628 Emacs frame and then evaluate @code{(frame-height)} and
2629 @code{(frame-width)} with @kbd{M-:}.
2631 @c ------------------------------------------------------------
2632 @node Bugs and problems
2633 @chapter Bugs and problems
2634 @cindex Bugs and problems
2636 The Emacs manual lists some common kinds of trouble users could get
2637 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2638 Emacs Manual}, so you might look there if the problem you encounter
2639 isn't described in this chapter.  If you decide you've discovered a bug,
2640 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2641 instructions how to do that.
2643 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2644 known problems with building and using Emacs on specific platforms;
2645 type @kbd{C-h C-p} to read it.
2647 @menu
2648 * Problems with very large files::
2649 * ^M in the shell buffer::
2650 * Problems with Shell Mode::
2651 * Termcap/Terminfo entries for Emacs::
2652 * Errors with init files::
2653 * Emacs ignores X resources::
2654 * Emacs ignores frame parameters::
2655 * Editing files with $ in the name::
2656 * Shell mode loses the current directory::
2657 * Security risks with Emacs::
2658 * Dired claims that no file is on this line::
2659 @end menu
2661 @node Problems with very large files
2662 @section Does Emacs have problems with files larger than 8 megabytes?
2663 @cindex Very large files, opening
2664 @cindex Large files, opening
2665 @cindex Opening very large files
2666 @cindex Maximum file size
2667 @cindex Files, maximum size
2669 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2670 files larger than 8 megabytes.  In versions 19.29 and later, the maximum
2671 buffer size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes.
2672 The maximum buffer size on 32-bit machines increased to 256 MBytes in
2673 Emacs 22, and again to 512 MBytes in Emacs 23.2.
2675 Emacs compiled on a 64-bit machine can handle much larger buffers.
2677 @node ^M in the shell buffer
2678 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2679 @cindex Shell buffer, echoed commands and @samp{^M} in
2680 @cindex Echoed commands in @code{shell-mode}
2682 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2683 make them go away.  If that doesn't work, you have several options:
2685 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2686 file:
2688 @example
2689 if ($?EMACS) then
2690     if ("$EMACS" =~ /*) then
2691         if ($?tcsh) unset edit
2692         stty nl
2693     endif
2694 endif
2695 @end example
2697 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2699 @example
2700 unset edit
2701 stty nl
2702 @end example
2704 Alternatively, use @code{csh} in your shell buffers instead of
2705 @code{tcsh}.  One way is:
2707 @lisp
2708 (setq explicit-shell-file-name "/bin/csh")
2709 @end lisp
2711 @noindent
2712 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2713 file:
2715 @example
2716 setenv ESHELL /bin/csh
2717 @end example
2719 @noindent
2720 (You must start Emacs over again with the environment variable properly
2721 set for this to take effect.)
2723 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2724 with the following Lisp form,
2726 @lisp
2727 (setenv "ESHELL" "/bin/csh")
2728 @end lisp
2730 The above solutions try to prevent the shell from producing the
2731 @samp{^M} characters in the first place.  If this is not possible
2732 (e.g., if you use a Windows shell), you can get Emacs to remove these
2733 characters from the buffer by adding this to your @file{.emacs} init
2734 file:
2736 @smalllisp
2737 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2738 @end smalllisp
2740 On a related note: if your shell is echoing your input line in the shell
2741 buffer, you might want to customize the @code{comint-process-echoes}
2742 variable in your shell buffers, or try the following command in your
2743 shell start-up file:
2745 @example
2746 stty -icrnl -onlcr -echo susp ^Z
2747 @end example
2749 @node Problems with Shell Mode
2750 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2752 @cindex Shell Mode, problems
2753 @cindex @code{explicit-shell-file-name}
2754 This might happen because Emacs tries to look for the shell in a wrong
2755 place.  If you know where your shell executable is, set the variable
2756 @code{explicit-shell-file-name} in your @file{.emacs} file to point to
2757 its full file name.
2759 @cindex Antivirus programs, and Shell Mode
2760 Some people have trouble with Shell Mode on MS-Windows because of
2761 intrusive antivirus software; disabling the resident antivirus program
2762 solves the problems in those cases.
2764 @node Termcap/Terminfo entries for Emacs
2765 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2766 @cindex Termcap
2767 @cindex Terminfo
2768 @cindex Emacs entries for termcap/terminfo
2770 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2771 the @samp{TERMCAP} environment variable of subshells.  It may help in
2772 certain situations (e.g., using rlogin from shell buffer) to add an
2773 entry for @samp{emacs} to the system-wide termcap file.  Here is a
2774 correct termcap entry for @samp{emacs}:
2776 @example
2777 emacs:tc=unknown:
2778 @end example
2780 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2781 @code{captoinfo}.  You need to generate
2782 @file{/usr/lib/terminfo/e/emacs}.  It may work to simply copy
2783 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2785 Having a termcap/terminfo entry will not enable the use of full screen
2786 programs in shell buffers.  Use @kbd{M-x terminal-emulator} for that
2787 instead.
2789 A workaround to the problem of missing termcap/terminfo entries is to
2790 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2791 in your shell start up file.  @code{csh} users could put this in their
2792 @file{.cshrc} files:
2794 @example
2795 if ("$term" == emacs) set term=dumb
2796 @end example
2798 @node Errors with init files
2799 @section Why does Emacs say @samp{Error in init file}?
2800 @cindex Error in @file{.emacs}
2801 @cindex Error in init file
2802 @cindex Init file, errors in
2803 @cindex @file{.emacs} file, errors in
2804 @cindex Debugging @file{.emacs} file
2806 An error occurred while loading either your @file{.emacs} file or the
2807 system-wide file @file{site-lisp/default.el}.  Emacs 21.1 and later pops the
2808 @file{*Messages*} buffer, and puts there some additional information
2809 about the error, to provide some hints for debugging.
2811 For information on how to debug your @file{.emacs} file, see
2812 @ref{Debugging a customization file}.
2814 It may be the case that you need to load some package first, or use a
2815 hook that will be evaluated after the package is loaded.  A common case
2816 of this is explained in @ref{Terminal setup code works after Emacs has
2817 begun}.
2819 @node Emacs ignores X resources
2820 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
2821 @cindex X resources being ignored
2822 @cindex Ignored X resources
2823 @cindex @file{.Xdefaults}
2825 As of version 19, Emacs searches for X resources in the files specified
2826 by the following environment variables:
2828 @itemize @bullet
2830 @item @code{XFILESEARCHPATH}
2831 @item @code{XUSERFILESEARCHPATH}
2832 @item @code{XAPPLRESDIR}
2834 @end itemize
2836 This emulates the functionality provided by programs written using the
2837 Xt toolkit.
2839 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
2840 of file names separated by colons.  @code{XAPPLRESDIR} should be a list
2841 of directory names separated by colons.
2843 Emacs searches for X resources:
2845 @enumerate
2847 @item
2848 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
2850 @item
2851 then in the value of the @samp{XENVIRONMENT} environment variable,
2853 @itemize @minus
2855 @item
2856 or if that is unset, in the file named
2857 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
2858 the name of the machine Emacs is running on),
2860 @end itemize
2862 @item
2863 then in the screen-specific and server-wide resource properties provided
2864 by the server,
2866 @itemize @minus
2868 @item
2869 or if those properties are unset, in the file named @file{~/.Xdefaults}
2870 if it exists,
2872 @end itemize
2874 @item
2875 then in the files listed in @samp{XUSERFILESEARCHPATH},
2877 @itemize @minus
2879 @item
2880 or in files named @file{@var{lang}/Emacs} in directories listed in
2881 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
2882 environment variable), if the @samp{LANG} environment variable is set,
2883 @item
2884 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
2885 @item
2886 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
2887 is set),
2888 @item
2889 or in @file{~/Emacs},
2891 @end itemize
2893 @item
2894 then in the files listed in  @code{XFILESEARCHPATH}.
2896 @end enumerate
2898 @node Emacs ignores frame parameters
2899 @section Why don't my customizations of the frame parameters work?
2900 @cindex Frame parameters
2902 This probably happens because you have set the frame parameters in the
2903 variable @code{initial-frame-alist}.  That variable holds parameters
2904 used only for the first frame created when Emacs starts.  To customize
2905 the parameters of all frames, change the variable
2906 @code{default-frame-alist} instead.
2908 These two variables exist because many users customize the initial frame
2909 in a special way.  For example, you could determine the position and
2910 size of the initial frame, but would like to control the geometry of the
2911 other frames by individually positioning each one of them.
2914 @node Editing files with $ in the name
2915 @section How do I edit a file with a @samp{$} in its name?
2916 @cindex Editing files with @samp{$} in the name
2917 @cindex @samp{$} in file names
2918 @cindex File names containing @samp{$}, editing
2920 When entering a file name in the minibuffer, Emacs will attempt to expand
2921 a @samp{$} followed by a word as an environment variable.  To suppress
2922 this behavior, type @kbd{$$} instead.
2924 @node Shell mode loses the current directory
2925 @section Why does shell mode lose track of the shell's current directory?
2926 @cindex Current directory and @code{shell-mode}
2927 @cindex @code{shell-mode} and current directory
2928 @cindex Directory, current in @code{shell-mode}
2930 Emacs has no way of knowing when the shell actually changes its
2931 directory.  This is an intrinsic limitation of Unix.  So it tries to
2932 guess by recognizing @samp{cd} commands.  If you type @kbd{cd} followed
2933 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
2934 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
2935 correctly guess the shell's new current directory.  A huge variety of
2936 fixes and enhancements to shell mode for this problem have been written
2937 to handle this problem (@pxref{Finding a package with particular
2938 functionality}).
2940 You can tell Emacs the shell's current directory with the command
2941 @kbd{M-x dirs}.
2943 @node Security risks with Emacs
2944 @section Are there any security risks in Emacs?
2945 @cindex Security with Emacs
2946 @cindex @samp{movemail} and security
2947 @cindex @code{file-local-variable} and security
2948 @cindex Synthetic X events and security
2949 @cindex X events and security
2951 @itemize @bullet
2953 @item
2954 The @file{movemail} incident.  (No, this is not a risk.)
2956 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
2957 chapter 4.  The site at LBL had installed the @file{/etc/movemail}
2958 program setuid root.  (As of version 19, @file{movemail} is in your
2959 architecture-specific directory; type @kbd{C-h v exec-directory
2960 @key{RET}} to see what it is.)  Since @code{movemail} had not been
2961 designed for this situation, a security hole was created and users could
2962 get root privileges.
2964 @code{movemail} has since been changed so that this security hole will
2965 not exist, even if it is installed setuid root.  However,
2966 @code{movemail} no longer needs to be installed setuid root, which
2967 should eliminate this particular risk.
2969 We have heard unverified reports that the 1988 Internet worm took
2970 advantage of this configuration problem.
2972 @item
2973 The @code{file-local-variable} feature.  (Yes, a risk, but easy to
2974 change.)
2976 There is an Emacs feature that allows the setting of local values for
2977 variables when editing a file by including specially formatted text near
2978 the end of the file.  This feature also includes the ability to have
2979 arbitrary Emacs Lisp code evaluated when the file is visited.
2980 Obviously, there is a potential for Trojan horses to exploit this
2981 feature.
2983 As of Emacs 22, Emacs has a list of local variables that are known to
2984 be safe to set.  If a file tries to set any variable outside this
2985 list, it asks the user to confirm whether the variables should be set.
2986 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
2987 code found at the bottom of files by setting the variable
2988 @code{enable-local-eval}.
2990 For more information, @inforef{File Variables, File Variables, emacs}.
2992 @item
2993 Synthetic X events.  (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
2994 better.)
2996 Emacs accepts synthetic X events generated by the @code{SendEvent}
2997 request as though they were regular events.  As a result, if you are
2998 using the trivial host-based authentication, other users who can open X
2999 connections to your X workstation can make your Emacs process do
3000 anything, including run other processes with your privileges.
3002 The only fix for this is to prevent other users from being able to open
3003 X connections.  The standard way to prevent this is to use a real
3004 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}.  If using
3005 the @code{xauth} program has any effect, then you are probably using
3006 @samp{MIT-MAGIC-COOKIE-1}.  Your site may be using a superior
3007 authentication method; ask your system administrator.
3009 If real authentication is not a possibility, you may be satisfied by
3010 just allowing hosts access for brief intervals while you start your X
3011 programs, then removing the access.  This reduces the risk somewhat by
3012 narrowing the time window when hostile users would have access, but
3013 @emph{does not eliminate the risk}.
3015 On most computers running Unix and X, you enable and disable
3016 access using the @code{xhost} command.  To allow all hosts access to
3017 your X server, use
3019 @example
3020 xhost +
3021 @end example
3023 @noindent
3024 at the shell prompt, which (on an HP machine, at least) produces the
3025 following message:
3027 @example
3028 access control disabled, clients can connect from any host
3029 @end example
3031 To deny all hosts access to your X server (except those explicitly
3032 allowed by name), use
3034 @example
3035 xhost -
3036 @end example
3038 On the test HP computer, this command generated the following message:
3040 @example
3041 access control enabled, only authorized clients can connect
3042 @end example
3044 @end itemize
3046 @node Dired claims that no file is on this line
3047 @section Dired says, @samp{no file on this line} when I try to do something.
3048 @cindex Dired does not see a file
3050 Dired uses a regular expression to find the beginning of a file name.
3051 In a long Unix-style directory listing (@samp{ls -l}), the file name
3052 starts after the date.  The regexp has thus been written to look for the
3053 date.  By default, it should understand dates and times regardless of
3054 the language, but if your directory listing has an unusual format, Dired
3055 may get confused.
3057 There are two approaches to solving this.  The first one involves
3058 setting things up so that @samp{ls -l} outputs a more standard format.
3059 See your OS manual for more information.
3061 The second approach involves changing the regular expression used by
3062 dired, @code{directory-listing-before-filename-regexp}.
3064 @c ------------------------------------------------------------
3065 @node Compiling and installing Emacs
3066 @chapter    Compiling and installing Emacs
3067 @cindex    Compiling and installing Emacs
3069 @menu
3070 * Installing Emacs::
3071 * Problems building Emacs::
3072 @end menu
3074 @node Installing Emacs
3075 @section How do I install Emacs?
3076 @cindex Installing Emacs
3077 @cindex Unix systems, installing Emacs on
3078 @cindex Downloading and installing Emacs
3079 @cindex Building Emacs from source
3080 @cindex Source code, building Emacs from
3082 This answer is meant for users of Unix and Unix-like systems.  Users of
3083 other operating systems should see the series of questions beginning
3084 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3085 and binaries, and how to install Emacs on those systems.
3087 Most GNU/Linux distributions provide pre-built Emacs packages.
3088 If Emacs is not installed already, you can install it by running (as
3089 root) a command such as @samp{yum install emacs} (Red Hat and
3090 derivatives) or @samp{apt-get install emacs} (Debian and derivatives).
3092 If you want to compile Emacs yourself, read the file @file{INSTALL} in
3093 the source distribution.  In brief:
3095 @itemize @bullet
3097 @item
3098 First download the Emacs sources.  @xref{Current GNU distributions}, for
3099 a list of ftp sites that make them available.  On @file{ftp.gnu.org},
3100 the main GNU distribution site, sources are available as
3102 @c Don't include VER in the file name, because pretests are not there.
3103 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
3105 (Replace @samp{VERSION} with the relevant version number, e.g. @samp{23.1}.)
3107 @item
3108 Next uncompress and extract the source files.  This requires
3109 the @code{gzip} and @code{tar} programs, which are standard utilities.
3110 If your system does not have them, these can also be downloaded from
3111 @file{ftp.gnu.org}.
3113 GNU @code{tar} can uncompress and extract in a single-step:
3115 @example
3116 tar -zxvf emacs-VERSION.tar.gz
3117 @end example
3119 @item
3120 At this point, the Emacs sources should be sitting in a directory called
3121 @file{emacs-VERSION}.  On most common Unix and Unix-like systems,
3122 you should be able to compile Emacs with the following commands:
3124 @example
3125 cd emacs-VERSION
3126 ./configure         # configure Emacs for your particular system
3127 make                # use Makefile to build components, then Emacs
3128 @end example
3130 If the @code{make} completes successfully, the odds are fairly good that
3131 the build has gone well.  (@xref{Problems building Emacs}, if you weren't
3132 successful.)
3134 @item
3135 By default, Emacs is installed in @file{/usr/local}.  To actually
3136 install files, become the superuser and type
3138 @example
3139 make install
3140 @end example
3142 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3143 and any Emacs Info files that might be in @file{/usr/local/share/info/}.
3145 @end itemize
3147 @node Problems building Emacs
3148 @section What should I do if I have trouble building Emacs?
3149 @cindex Problems building Emacs
3150 @cindex Errors when building Emacs
3152 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3153 source) to see if there is already a solution for your problem.  Next,
3154 look for other questions in this FAQ that have to do with Emacs
3155 installation and compilation problems.
3157 If you'd like to have someone look at your problem and help solve it,
3158 see @ref{Help installing Emacs}.
3160 If you cannot find a solution in the documentation, please report the
3161 problem (@pxref{Reporting bugs}).
3164 @c ------------------------------------------------------------
3165 @node Finding Emacs and related packages
3166 @chapter Finding Emacs and related packages
3167 @cindex Finding Emacs and related packages
3169 @menu
3170 * Finding Emacs on the Internet::
3171 * Finding a package with particular functionality::
3172 * Packages that do not come with Emacs::
3173 * Current GNU distributions::
3174 * Difference between Emacs and XEmacs::
3175 * Emacs for minimalists::
3176 * Emacs for MS-DOS::
3177 * Emacs for MS-Windows::
3178 * Emacs for GNUstep::
3179 * Emacs for Mac OS X::
3180 @end menu
3182 @node Finding Emacs on the Internet
3183 @section Where can I get Emacs on the net?
3184 @cindex Finding Emacs on the Internet
3185 @cindex Downloading Emacs
3187 Information on downloading Emacs is available at
3188 @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}.
3190 @xref{Installing Emacs}, for information on how to obtain and build the latest
3191 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3192 archive sites that make GNU software available.
3194 @node Finding a package with particular functionality
3195 @section How do I find a Emacs Lisp package that does XXX?
3196 @cindex Package, finding
3197 @cindex Finding an Emacs Lisp package
3198 @cindex Functionality, finding a particular package
3200 First of all, you should check to make sure that the package isn't
3201 already available.  For example, typing @kbd{M-x apropos @key{RET}
3202 wordstar @key{RET}} lists all functions and variables containing the
3203 string @samp{wordstar}.
3205 It is also possible that the package is on your system, but has not been
3206 loaded.  To see which packages are available for loading, look through
3207 your computer's lisp directory (@pxref{File-name conventions}).  The Lisp
3208 source to most packages contains a short description of how they
3209 should be loaded, invoked, and configured---so before you use or
3210 modify a Lisp package, see if the author has provided any hints in the
3211 source code.
3213 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3214 the constituent Emacs packages.
3216 For advice on how to find extra packages that are not part of Emacs,
3217 see @ref{Packages that do not come with Emacs}.
3219 @node Packages that do not come with Emacs
3220 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3221 @cindex Unbundled packages
3222 @cindex Finding other packages
3223 @cindex Lisp packages that do not come with Emacs
3224 @cindex Packages, those that do not come with Emacs
3225 @cindex Emacs Lisp List
3226 @cindex Emacs Lisp Archive
3228 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs Lisp
3229 List (ELL)}, maintained by @email{S.J.Eglen@@damtp.cam.ac.uk, Stephen Eglen},
3230 aims to provide one compact list with links to all of the current Emacs
3231 Lisp files on the Internet.  The ELL can be browsed over the web, or
3232 from Emacs with @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.el,
3233 the @file{ell} package}.
3235 Many authors post their packages to the @uref{news:gnu.emacs.sources,
3236 Emacs sources newsgroup}.  You can search the archives of this
3237 group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google},
3238 or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example.
3240 Several packages are stored in
3241 @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}.
3243 Read the file @file{etc/MORE.STUFF} for more information about
3244 external packages.
3246 @node Current GNU distributions
3247 @section Where can I get other up-to-date GNU stuff?
3248 @cindex Current GNU distributions
3249 @cindex Sources for current GNU distributions
3250 @cindex Stuff, current GNU
3251 @cindex Up-to-date GNU stuff
3252 @cindex Finding current GNU software
3253 @cindex Official GNU software sites
3255 The most up-to-date official GNU software is normally kept at
3257 @uref{ftp://ftp.gnu.org/pub/gnu}
3259 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3261 @uref{http://www.gnu.org/order/ftp.html}
3263 @node Difference between Emacs and XEmacs
3264 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3265 @cindex XEmacs
3266 @cindex Difference Emacs and XEmacs
3267 @cindex Lucid Emacs
3268 @cindex Epoch
3270 XEmacs is a branch version of Emacs.  It was first called Lucid Emacs,
3271 and was initially derived from a prerelease version of Emacs 19.  In
3272 this FAQ, we use the name ``Emacs'' only for the official version.
3274 Emacs and XEmacs each come with Lisp packages that are lacking in the
3275 other.  The two versions have some significant differences at the Lisp
3276 programming level.  Their current features are roughly comparable,
3277 though the support for some operating systems, character sets and
3278 specific packages might be quite different.
3280 Some XEmacs code has been contributed to Emacs, and we would like to
3281 use other parts, but the earlier XEmacs maintainers did not always
3282 keep track of the authors of contributed code, which makes it
3283 impossible for the FSF to get copyright papers signed for that code.
3284 (The FSF requires these papers for all the code included in the Emacs
3285 release, aside from generic C support packages that retain their
3286 separate identity and are not integrated into the code of Emacs
3287 proper.)
3289 If you want to talk about these two versions and distinguish them,
3290 please call them ``Emacs'' and ``XEmacs.''  To contrast ``XEmacs''
3291 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3292 origin in the work of the GNU Project.  Terms such as ``Emacsen'' and
3293 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3294 is better to write ``Emacs and XEmacs.''
3296 @node Emacs for minimalists
3297 @section I don't have enough disk space to install Emacs
3298 @cindex Zile
3299 @cindex Not enough disk space to install Emacs
3301 GNU Zile is a lightweight Emacs clone.  Zile is short for @samp{Zile Is
3302 Lossy Emacs}.  It has all of Emacs's basic editing features.  The Zile
3303 binary typically has a size of about 130 kbytes, so this can be useful
3304 if you are in an extremely space-restricted environment.  More
3305 information is available from
3307 @uref{http://www.gnu.org/software/zile/}
3310 @node Emacs for MS-DOS
3311 @section Where can I get Emacs for MS-DOS?
3312 @cindex MS-DOS, Emacs for
3313 @cindex DOS, Emacs for
3314 @cindex Compiling Emacs for DOS
3315 @cindex Emacs for MS-DOS
3317 To build Emacs from source for MS-DOS, see the instructions in the file
3318 @file{msdos/INSTALL} in the distribution.  The DOS port builds and runs
3319 on plain DOS, and also on all versions of MS-Windows from version 3.X
3320 onwards, including Windows XP and Vista.
3322 The file @file{etc/PROBLEMS} contains some additional information
3323 regarding Emacs under MS-DOS.
3325 A pre-built binary distribution of the old Emacs 20 is available, as
3326 described at
3328 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3330 For a list of other MS-DOS implementations of Emacs (and Emacs
3331 look-alikes), consult the list of ``Emacs implementations and literature,''
3332 available at
3334 @uref{http://www.finseth.com/emacs.html}
3336 Note that while many of these programs look similar to Emacs, they often
3337 lack certain features, such as the Emacs Lisp extension language.
3339 @node Emacs for MS-Windows
3340 @section Where can I get Emacs for Microsoft Windows?
3341 @cindex FAQ for Emacs on MS-Windows
3342 @cindex Emacs for MS-Windows
3343 @cindex Microsoft Windows, Emacs for
3345 There is a @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html,
3346 separate FAQ} for Emacs on MS-Windows.  For MS-DOS, @pxref{Emacs for MS-DOS}.
3349 @node Emacs for GNUstep
3350 @section Where can I get Emacs for GNUstep?
3351 @cindex GNUstep, Emacs for
3353 Beginning with version 23.1, Emacs supports GNUstep natively.
3354 See the file @file{nextstep/INSTALL} in the distribution.
3356 @node Emacs for Mac OS X
3357 @section Where can I get Emacs for Mac OS X?
3358 @cindex Apple computers, Emacs for
3359 @cindex Macintosh, Emacs for
3360 @cindex Mac OS X, Emacs for
3362 Beginning with version 22.1, Emacs supports Mac OS X natively.
3363 See the file @file{nextstep/INSTALL} in the distribution.
3365 @c ------------------------------------------------------------
3366 @node Major packages and programs
3367 @chapter Major packages and programs
3368 @cindex Major packages and programs
3370 @menu
3371 * VM::
3372 * AUCTeX::
3373 * BBDB::
3374 * Spell-checkers::
3375 * Emacs/W3::
3376 * EDB::
3377 * JDEE::
3378 @end menu
3380 @node VM
3381 @section VM (View Mail) --- another mail reader within Emacs, with MIME support
3382 @cindex VM
3383 @cindex Alternative mail software
3384 @cindex View Mail
3385 @cindex E-mail reader, VM
3387 @table @b
3389 @item Web site
3390 @uref{http://launchpad.net/vm}
3391 (was @uref{http://www.nongnu.org/viewmail/})
3393 @item Informational newsgroup
3394 @uref{news:gnu.emacs.vm.info}@*
3396 @item Bug reports newsgroup
3397 @uref{news:gnu.emacs.vm.bug}@*
3398 @end table
3400 VM was originally written by @uref{http://www.wonderworks.com/vm/,Kyle Jones}.
3401 @uref{ftp://ftp.wonderworks.com/pub/vm/,Older versions} of VM remain
3402 available.
3405 @node AUCTeX
3406 @section AUC@TeX{} --- enhanced @TeX{} modes with debugging facilities
3407 @cindex Mode for @TeX{}
3408 @cindex @TeX{} mode
3409 @cindex AUC@TeX{} mode for editing @TeX{}
3410 @cindex Writing and debugging @TeX{}
3412 AUC@TeX{} is a set of sophisticated major modes for @TeX{}, LaTeX,
3413 ConTeXt, and Texinfo offering context-sensitive syntax highlighting,
3414 indentation, formatting and folding, macro completion, @TeX{} shell
3415 functionality, and debugging.  Be also sure to check out
3416 @ref{Introduction, RefTeX, Introduction, reftex, Ref@TeX{} User Manual}.
3417 Current versions of AUC@TeX{} include the
3418 @uref{http://www.gnu.org/software/auctex/preview-latex.html,preview-latex}
3419 package for WYSIWYG previews of various LaTeX constructs in the Emacs
3420 source buffer.
3422 @uref{http://www.gnu.org/software/auctex/, AUCTeX}
3424 @node BBDB
3425 @section BBDB --- personal Info Rolodex integrated with mail/news readers
3426 @cindex BBDB
3427 @cindex Rolodex-like functionality
3428 @cindex Integrated contact database
3429 @cindex Contact database
3430 @cindex Big Brother Database
3431 @cindex Address book
3433 @uref{http://bbdb.sourceforge.net/, The Insidious Big Brother Database}
3435 @node Spell-checkers
3436 @section Spell-checkers
3437 @cindex Spell-checker
3438 @cindex Checking spelling
3439 @cindex Ispell
3440 @cindex Aspell
3441 @cindex Hunspell
3443 Various spell-checkers are compatible with Emacs, including:
3445 @table @b
3447 @item GNU Aspell
3448 @uref{http://aspell.net/}
3450 @item Ispell
3451 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3453 @item Hunspell
3454 @uref{http://hunspell.sourceforge.net/}
3456 @end table
3458 @node Emacs/W3
3459 @section Emacs/W3 --- A World Wide Web browser inside of Emacs
3460 @cindex WWW browser
3461 @cindex Web browser
3462 @cindex HTML browser in Emacs
3463 @cindex @code{w3-mode}
3465 @uref{http://www.gnu.org/software/w3/, Emacs/W3}
3467 @node EDB
3468 @section EDB --- Database program for Emacs; replaces forms editing modes
3469 @cindex EDB
3470 @cindex Database
3471 @cindex Forms mode
3473 @uref{http://gnuvola.org/software/edb/, The Emacs Database}
3475 @node JDEE
3476 @section JDEE --- Integrated development environment for Java
3477 @cindex Java development environment
3478 @cindex Integrated Java development environment
3479 @cindex JDEE
3481 @uref{http://jdee.sourceforge.net/, A Java Development Environment for Emacs}
3483 @c ------------------------------------------------------------
3484 @node Key bindings
3485 @chapter Key bindings
3486 @cindex Key bindings
3488 @menu
3489 * Binding keys to commands::
3490 * Invalid prefix characters::
3491 * Terminal setup code works after Emacs has begun::
3492 * Working with function and arrow keys::
3493 * X key translations for Emacs::
3494 * Backspace invokes help::
3495 * Swapping keys::
3496 * Producing C-XXX with the keyboard::
3497 * No Meta key::
3498 * No Escape key::
3499 * Compose Character::
3500 * Binding combinations of modifiers and function keys::
3501 * Meta key does not work in xterm::
3502 * ExtendChar key does not work as Meta::
3503 * SPC no longer completes file names::
3504 @end menu
3506 @node Binding keys to commands
3507 @section How do I bind keys (including function keys) to commands?
3508 @cindex Binding keys to commands
3509 @cindex Keys, binding to commands
3510 @cindex Commands, binding keys to
3512 Keys can be bound to commands either interactively or in your
3513 @file{.emacs} file.  To interactively bind keys for all modes, type
3514 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3516 To bind a key just in the current major mode, type @kbd{M-x
3517 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3519 @inforef{Key Bindings, Key Bindings, emacs}, for further details.
3521 To make the process of binding keys interactively easier, use the
3522 following ``trick'': First bind the key interactively, then immediately
3523 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}.  Now, the command needed
3524 to bind the key is in the kill ring, and can be yanked into your
3525 @file{.emacs} file.  If the key binding is global, no changes to the
3526 command are required.  For example,
3528 @lisp
3529 (global-set-key (quote [f1]) (quote help-for-help))
3530 @end lisp
3532 @noindent
3533 can be placed directly into the @file{.emacs} file.  If the key binding is
3534 local, the command is used in conjunction with the @samp{add-hook} function.
3535 For example, in TeX mode, a local binding might be
3537 @lisp
3538 (add-hook 'tex-mode-hook
3539   (lambda ()
3540    (local-set-key (quote [f1]) (quote help-for-help))))
3541 @end lisp
3544 @itemize @bullet
3546 @item
3547 Control characters in key sequences, in the form yanked from the kill
3548 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3549 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc.  You may want
3550 to convert these into their vector or string forms.
3552 @item
3553 If a prefix key of the character sequence to be bound is already
3554 bound as a complete key, then you must unbind it before the new
3555 binding.  For example, if @kbd{ESC @{} is previously bound:
3557 @lisp
3558 (global-unset-key [?\e ?@{])   ;;   or
3559 (local-unset-key [?\e ?@{])
3560 @end lisp
3562 @item
3563 Aside from commands and ``lambda lists,'' a vector or string also
3564 can be bound to a key and thus treated as a macro.  For example:
3566 @lisp
3567 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g])  ;;  or
3568 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3569 @end lisp
3571 @end itemize
3573 @node Invalid prefix characters
3574 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3575 @cindex Prefix characters, invalid
3576 @cindex Invalid prefix characters
3577 @cindex Misspecified key sequences
3579 Usually, one of two things has happened.  In one case, the control
3580 character in the key sequence has been misspecified (e.g. @samp{C-f}
3581 used instead of @samp{\C-f} within a Lisp expression).  In the other
3582 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3583 was already bound as a @dfn{complete key}.  Historically, the @samp{ESC [}
3584 prefix was usually the problem, in which case you should evaluate either
3585 of these forms before attempting to bind the key sequence:
3587 @lisp
3588 (global-unset-key [?\e ?[])  ;;  or
3589 (global-unset-key "\e[")
3590 @end lisp
3592 @node Terminal setup code works after Emacs has begun
3593 @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?
3594 @cindex Terminal setup code in @file{.emacs}
3596 During startup, Emacs initializes itself according to a given code/file
3597 order.  If some of the code executed in your @file{.emacs} file needs to
3598 be postponed until the initial terminal or window-system setup code has
3599 been executed but is not, then you will experience this problem (this
3600 code/file execution order is not enforced after startup).
3602 To postpone the execution of Emacs Lisp code until after terminal or
3603 window-system setup, treat the code as a @dfn{lambda list} and set the
3604 value of either the @code{term-setup-hook} or @code{window-setup-hook}
3605 variable to this lambda function.  For example,
3607 @lisp
3608 (add-hook 'term-setup-hook
3609           (lambda ()
3610            (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3611              ;; Make vt220's "Do" key behave like M-x:
3612              (global-set-key [do] 'execute-extended-command))))
3613 @end lisp
3615 For information on what Emacs does every time it is started, see the
3616 @file{lisp/startup.el} file.
3618 @node Working with function and arrow keys
3619 @section How do I tell what characters or symbols my function or arrow keys emit?
3620 @cindex Working with arrow keys
3621 @cindex Arrow keys, symbols generated by
3622 @cindex Working with function keys
3623 @cindex Function keys, symbols generated by
3624 @cindex Symbols generated by function keys
3626 Type @kbd{C-h c} then the function or arrow keys.  The command will
3627 return either a function key symbol or character sequence (see the
3628 Emacs documentation for an explanation).  This works for other
3629 keys as well.
3631 @node X key translations for Emacs
3632 @section How do I set the X key ``translations'' for Emacs?
3633 @cindex X key translations
3634 @cindex Key translations under X
3635 @cindex Translations for keys under X
3637 Emacs is not written using the Xt library by default, so there are no
3638 ``translations'' to be set.  (We aren't sure how to set such translations
3639 if you do build Emacs with Xt; please let us know if you've done this!)
3641 The only way to affect the behavior of keys within Emacs is through
3642 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs).  The
3643 @code{define-key} command should be used in conjunction with the
3644 @code{function-key-map} map.  For instance,
3646 @lisp
3647 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3648 @end lisp
3650 @noindent
3651 defines the @kbd{M-@key{TAB}} key sequence.
3653 @node Backspace invokes help
3654 @section Why does the @key{Backspace} key invoke help?
3655 @cindex Backspace key invokes help
3656 @cindex Help invoked by Backspace
3657 @cindex DEL key does not delete
3659 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
3660 @kbd{C-h} sends the same code.  In Emacs by default @kbd{C-h} invokes
3661 help-command.  This is intended to be easy to remember since the first
3662 letter of @samp{help} is @samp{h}.  The easiest solution to this problem
3663 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
3664 @key{Delete} key) for deleting the previous character.
3666 For many people this solution may be problematic:
3668 @itemize @bullet
3670 @item
3671 They normally use @key{Backspace} outside of Emacs for deleting the
3672 previous character.  This can be solved by making @key{DEL} the command
3673 for deleting the previous character outside of Emacs.  On many Unix
3674 systems, this command will remap @key{DEL}:
3676 @example
3677 stty erase `^?'
3678 @end example
3680 @item
3681 The user may prefer the @key{Backspace} key for deleting the
3682 previous character because it is more conveniently located on their
3683 keyboard or because they don't even have a separate @key{Delete} key.
3684 In this case, the @key{Backspace} key should be made to behave like
3685 @key{Delete}.  There are several methods.
3687 @itemize @minus
3688 @item
3689 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
3690 TeraTerm) allow the character generated by the @key{Backspace} key to be
3691 changed from a setup menu.
3693 @item
3694 You may be able to get a keyboard that is completely programmable, or a
3695 terminal emulator that supports remapping of any key to any other key.
3697 @item
3698 With Emacs 21.1 and later, you can control the effect of the
3699 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
3700 windowed displays, by customizing the option
3701 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
3702 normal-erase-is-backspace}.  See the documentation of these symbols
3703 (@pxref{Emacs Lisp documentation}) for more info.
3705 @item
3706 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
3707 Emacs:
3709 @lisp
3710 (keyboard-translate ?\C-h ?\C-?)
3711 @end lisp
3713 @noindent
3714 This is the recommended method of forcing @key{Backspace} to act as
3715 @key{DEL}, because it works even in modes which bind @key{DEL} to
3716 something other than @code{delete-backward-char}.
3718 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
3719 default deletes forward:
3721 @lisp
3722 (keyboard-translate ?\C-? ?\C-d)
3723 @end lisp
3725 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
3727 @item
3728 Another approach is to switch key bindings and put help on @kbd{C-x h}
3729 instead:
3731 @lisp
3732 (global-set-key "\C-h" 'delete-backward-char)
3734 ;; overrides mark-whole-buffer
3735 (global-set-key "\C-xh" 'help-command)
3736 @end lisp
3738 @noindent
3739 This method is not recommended, though: it only solves the problem for
3740 those modes which bind @key{DEL} to @code{delete-backward-char}.  Modes
3741 which bind @key{DEL} to something else, such as @code{view-mode}, will
3742 not work as you expect when you press the @key{Backspace} key.  For this
3743 reason, we recommend the @code{keyboard-translate} method, shown
3744 above.
3746 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
3747 @end itemize
3749 Don't try to bind @key{DEL} to @code{help-command}, because there are
3750 many modes that have local bindings of @key{DEL} that will interfere.
3752 @end itemize
3754 When Emacs 21 or later runs on a windowed display, it binds the
3755 @key{Delete} key to a command which deletes the character at point, to
3756 make Emacs more consistent with keyboard operation on these systems.
3758 For more information about troubleshooting this problem, see @ref{DEL
3759 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
3760 Manual}.
3762 @node Swapping keys
3763 @section How do I swap two keys?
3764 @cindex Swapping keys
3765 @cindex Keys, swapping
3766 @cindex @code{keyboard-translate}
3768 You can swap two keys (or key sequences) by using the
3769 @code{keyboard-translate} function.  For example, to turn @kbd{C-h}
3770 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
3772 @lisp
3773 (keyboard-translate ?\C-h ?\C-?)  ; translate `C-h' to DEL
3774 (keyboard-translate ?\C-? ?\C-h)  ; translate DEL to `C-h'.
3775 @end lisp
3777 @noindent
3778 The first key sequence of the pair after the function identifies what is
3779 produced by the keyboard; the second, what is matched for in the
3780 keymaps.
3782 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
3783 toggle @code{normal-erase-is-backspace-mode} instead of calling
3784 @code{keyboard-translate}.  @inforef{DEL Does Not Delete, DEL Does Not Delete,
3785 emacs}.
3787 Keyboard translations are not the same as key bindings in keymaps.
3788 Emacs contains numerous keymaps that apply in different situations, but
3789 there is only one set of keyboard translations, and it applies to every
3790 character that Emacs reads from the terminal.  Keyboard translations
3791 take place at the lowest level of input processing; the keys that are
3792 looked up in keymaps contain the characters that result from keyboard
3793 translation.
3795 @node Producing C-XXX with the keyboard
3796 @section How do I produce C-XXX with my keyboard?
3797 @cindex Producing control characters
3798 @cindex Generating control characters
3799 @cindex Control characters, generating
3801 On terminals (but not under X), some common ``aliases'' are:
3803 @table @asis
3805 @item @kbd{C-2}  or  @kbd{C-@key{SPC}}
3806 @kbd{C-@@}
3808 @item @kbd{C-6}
3809 @kbd{C-^}
3811 @item @kbd{C-7}  or  @kbd{C-S--}
3812 @kbd{C-_}
3814 @item @kbd{C-4}
3815 @kbd{C-\}
3817 @item @kbd{C-5}
3818 @kbd{C-]}
3820 @item @kbd{C-/}
3821 @kbd{C-?}
3823 @end table
3825 Often other aliases exist; use the @kbd{C-h c} command and try
3826 @key{CTRL} with all of the digits on your keyboard to see what gets
3827 generated.  You can also try the @kbd{C-h w} command if you know the
3828 name of the command.
3830 @node No Meta key
3831 @section What if I don't have a @key{Meta} key?
3832 @cindex No @key{Meta} key
3833 @cindex @key{Meta} key, what to do if you lack it
3835 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
3837 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}.  In fact,
3838 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
3839 (depending on the value of @code{meta-prefix-char}).  Note that you
3840 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
3841 @key{ESC}, release it, and then press @key{a}.
3843 @node No Escape key
3844 @section What if I don't have an @key{Escape} key?
3845 @cindex No Escape key
3846 @cindex Lacking an Escape key
3847 @cindex Escape key, lacking
3849 Type @kbd{C-[} instead.  This should send @acronym{ASCII} code 27 just like an
3850 Escape key would.  @kbd{C-3} may also work on some terminal (but not
3851 under X).  For many terminals (notably DEC terminals) @key{F11}
3852 generates @key{ESC}.  If not, the following form can be used to bind it:
3854 @lisp
3855 ;; F11 is the documented ESC replacement on DEC terminals.
3856 (define-key function-key-map [f11] [?\e])
3857 @end lisp
3859 @node Compose Character
3860 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
3861 @cindex @key{Compose Character} key, using as @key{Meta}
3862 @cindex @key{Meta}, using @key{Compose Character} for
3864 On a dumb terminal such as a VT220, no.  It is rumored that certain
3865 VT220 clones could have their @key{Compose} key configured this way.  If
3866 you're using X, you might be able to do this with the @code{xmodmap}
3867 command.
3869 @node Binding combinations of modifiers and function keys
3870 @section How do I bind a combination of modifier key and function key?
3871 @cindex Modifiers and function keys
3872 @cindex Function keys and modifiers
3873 @cindex Binding modifiers and function keys
3875 You can represent modified function keys in vector format by adding
3876 prefixes to the function key symbol.  For example (from the Emacs
3877 documentation):
3879 @lisp
3880 (global-set-key [?\C-x right] 'forward-page)
3881 @end lisp
3883 @noindent
3884 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
3886 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
3887 @key{Super}, @key{Alt}, and @key{Shift} with function keys.  To
3888 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
3889 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name.  Here
3890 is how to make @kbd{H-M-RIGHT} move forward a word:
3892 @lisp
3893 (global-set-key [H-M-right] 'forward-word)
3894 @end lisp
3896 @itemize @bullet
3898 @item
3899 Not all modifiers are permitted in all situations.  @key{Hyper},
3900 @key{Super}, and @key{Alt} are not available on Unix character
3901 terminals.  Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and
3902 @kbd{Mouse-1}) also fall under this category.
3904 @end itemize
3906 @xref{Binding keys to commands}, for general key binding instructions.
3908 @node Meta key does not work in xterm
3909 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
3910 @cindex @key{Meta} key and @code{xterm}
3911 @cindex Xterm and @key{Meta} key
3913 @inforef{Unibyte Mode, Single-Byte Character Set Support, emacs}.
3915 If the advice in the Emacs manual fails, try all of these methods before
3916 asking for further help:
3918 @itemize @bullet
3920 @item
3921 You may have big problems using @code{mwm} as your window manager.
3922 (Does anyone know a good generic solution to allow the use of the
3923 @key{Meta} key in Emacs with @file{mwm}?)
3925 @item
3926 For X11: Make sure it really is a @key{Meta} key.  Use @code{xev} to
3927 find out what keysym your @key{Meta} key generates.  It should be either
3928 @code{Meta_L} or @code{Meta_R}.  If it isn't, use @file{xmodmap} to fix
3929 the situation.  If @key{Meta} does generate @code{Meta_L} or
3930 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
3931 your @file{~/.Xdefaults} file:
3933 @example
3934  XTerm*eightBitInput:   false
3935  XTerm*eightBitOutput:  true
3936 @end example
3938 @item
3939 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
3940 characters.  @samp{stty -a} (or @samp{stty everything}) should show
3941 @samp{cs8} somewhere.  If it shows @samp{cs7} instead, use @samp{stty
3942 cs8 -istrip} (or @samp{stty pass8}) to fix it.
3944 @item
3945 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
3946 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
3947 of every character.
3949 @item
3950 If Emacs is running on Ultrix, it is reported that evaluating
3951 @code{(set-input-mode t nil)} helps.
3953 @item
3954 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
3955 you type @kbd{M-W}, which is the same conversion Emacs would make if it
3956 got the @kbd{M-W} anyway.  In X11R4, the following resource
3957 specification will do this:
3959 @example
3960 XTerm.VT100.EightBitInput: false
3961 @end example
3963 @noindent
3964 (This changes the behavior of the @code{insert-eight-bit} action.)
3966 With older @code{xterm}s, you can specify this behavior with a translation:
3968 @example
3969 XTerm.VT100.Translations: #override \
3970   Meta<KeyPress>: string(0x1b) insert()
3971 @end example
3973 @noindent
3974 You might have to replace @samp{Meta} with @samp{Alt}.
3976 @end itemize
3978 @node ExtendChar key does not work as Meta
3979 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
3980 @cindex @key{ExtendChar} key as @key{Meta}
3981 @cindex @key{Meta}, using @key{ExtendChar} for
3982 @cindex HP-UX, the @key{ExtendChar} key
3984 This is a result of an internationalization extension in X11R4 and the
3985 fact that HP is now using this extension.  Emacs assumes that the
3986 @code{XLookupString} function returns the same result regardless of the
3987 @key{Meta} key state which is no longer necessarily true.  Until Emacs
3988 is fixed, the temporary kludge is to run this command after each time
3989 the X server is started but preferably before any xterm clients are:
3991 @example
3992 xmodmap -e 'remove mod1 = Mode_switch'
3993 @end example
3995 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
3996 @c solved?
3998 This will disable the use of the extra keysyms systemwide, which may be
3999 undesirable if you actually intend to use them.
4001 @node SPC no longer completes file names
4002 @section Why doesn't SPC complete file names anymore?
4003 @cindex @kbd{SPC} file name completion
4005 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
4006 the minibuffer, so that file names with embedded spaces could be typed
4007 without the need to quote the spaces.
4009 You can get the old behavior by binding @kbd{SPC} to
4010 @code{minibuffer-complete-word} in the minibuffer, as follows:
4012 @lisp
4013 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
4014   'minibuffer-complete-word)
4016 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4017   'minibuffer-complete-word)
4018 @end lisp
4020 @c ------------------------------------------------------------
4021 @node Alternate character sets
4022 @chapter Alternate character sets
4023 @cindex Alternate character sets
4025 @menu
4026 * Emacs does not display 8-bit characters::
4027 * Inputting eight-bit characters::
4028 * Right-to-left alphabets::
4029 * How to add fonts::
4030 @end menu
4032 @node Emacs does not display 8-bit characters
4033 @section How do I make Emacs display 8-bit characters?
4034 @cindex Displaying eight-bit characters
4035 @cindex Eight-bit characters, displaying
4037 @inforef{Unibyte Mode, Single-byte Character Set
4038 Support, emacs}.  On a Unix, when Emacs runs on a text-only terminal
4039 display or is invoked with @samp{emacs -nw}, you typically need to use
4040 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4041 display, even after setting the language environment; otherwise
4042 non-@acronym{ASCII} characters will display as @samp{?}.  On other operating
4043 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4044 character set supported by the display, and sets up the required
4045 terminal coding system automatically.
4047 @node Inputting eight-bit characters
4048 @section How do I input eight-bit characters?
4049 @cindex Entering eight-bit characters
4050 @cindex Eight-bit characters, entering
4051 @cindex Input, 8-bit characters
4053 Various methods are available for input of eight-bit characters.  See
4054 @inforef{Unibyte Mode, Single-byte Character Set
4055 Support, emacs}.  For more sophisticated methods, @inforef{Input
4056 Methods, Input Methods, emacs}.
4058 @node Right-to-left alphabets
4059 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4060 @cindex Right-to-left alphabets
4061 @cindex Hebrew, handling with Emacs
4062 @cindex Semitic alphabets
4063 @cindex Arabic alphabets
4064 @cindex Bidirectional text
4066 Emacs supports Hebrew characters (ISO 8859-8) since version 20, but does
4067 not yet support right-to-left character entry and display.  The
4068 @uref{http://lists.gnu.org/mailman/listinfo/emacs-bidi, emacs-bidi
4069 mailing list} discusses development of support for this feature.
4072 @node How to add fonts
4073 @section How do I add fonts for use with Emacs?
4074 @cindex add fonts for use with Emacs
4075 @cindex intlfonts
4077 First, download and install the BDF font files and any auxiliary
4078 packages they need.  The GNU Intlfonts distribution can be found on
4079 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU
4080 Software Directory Web site}.
4082 Next, if you are on X Window system, issue the following two commands
4083 from the shell's prompt:
4085 @example
4086   xset +fp /usr/local/share/emacs/fonts
4087   xset fp rehash
4088 @end example
4090 @noindent
4091 (Modify the first command if you installed the fonts in a directory
4092 that is not @file{/usr/local/share/emacs/fonts}.)  You also need to
4093 arrange for these two commands to run whenever you log in, e.g., by
4094 adding them to your window-system startup file, such as
4095 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4097 Now, add the following line to your @file{~/.emacs} init file:
4099 @lisp
4100   (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4101 @end lisp
4103 @noindent
4104 (Again, modify the file name if you installed the fonts elsewhere.)
4106 Finally, if you wish to use the installed fonts with @code{ps-print},
4107 add the following line to your @file{~/.emacs}:
4109 @lisp
4110   (setq ps-multibyte-buffer 'bdf-font-except-latin)
4111 @end lisp
4113 A few additional steps are necessary for MS-Windows; they are listed
4114 below.
4116 First, make sure @emph{all} the directories with BDF font files are
4117 mentioned in @code{bdf-directory-list}.  On Unix and GNU/Linux
4118 systems, one normally runs @kbd{make install} to install the BDF fonts
4119 in the same directory.  By contrast, Windows users typically don't run
4120 the Intlfonts installation command, but unpack the distribution in
4121 some directory, which leaves the BDF fonts in its subdirectories.  For
4122 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4123 then you should set @code{bdf-directory-list} as follows:
4125 @lisp
4126   (setq bdf-directory-list
4127     '("C:/Intlfonts/Asian"
4128       "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4129       "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4130       "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4131       "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4132       "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4133       "C:/Intlfonts/Misc"))
4134 @end lisp
4136 @cindex @code{w32-bdf-filename-alist}
4137 @cindex @code{w32-find-bdf-fonts}
4138 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4139 an alist of the BDF fonts and their corresponding file names.
4140 Assuming you have set @code{bdf-directory-list} to name all the
4141 directories with the BDF font files, the following Lisp snippet will
4142 set up @code{w32-bdf-filename-alist}:
4144 @lisp
4145   (setq w32-bdf-filename-alist
4146      (w32-find-bdf-fonts bdf-directory-list))
4147 @end lisp
4149 Now, create fontsets for the BDF fonts:
4151 @lisp
4152   (create-fontset-from-fontset-spec
4153    "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4154    japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4155    katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4156    latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4157    japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4158    thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4159    lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4160    tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4161    ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4162    tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4163 @end lisp
4165 Many of the international bdf fonts from Intlfonts are type 0, and
4166 therefore need to be added to font-encoding-alist:
4168 @lisp
4169   (setq font-encoding-alist
4170         (append '(("MuleTibetan-0" (tibetan . 0))
4171                   ("GB2312"        (chinese-gb2312 . 0))
4172                   ("JISX0208"      (japanese-jisx0208 . 0))
4173                   ("JISX0212"      (japanese-jisx0212 . 0))
4174                   ("VISCII"        (vietnamese-viscii-lower . 0))
4175                   ("KSC5601"       (korean-ksc5601 . 0))
4176                   ("MuleArabic-0"  (arabic-digit . 0))
4177                   ("MuleArabic-1"  (arabic-1-column . 0))
4178                   ("MuleArabic-2"  (arabic-2-column . 0)))
4179                 font-encoding-alist))
4180 @end lisp
4182 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4183 fontset, or you can select it by setting the default font in your
4184 @file{~/.emacs}:
4186 @lisp
4187   (set-default-font "fontset-bdf")
4188 @end lisp
4191 @c ------------------------------------------------------------
4192 @node Mail and news
4193 @chapter Mail and news
4194 @cindex Mail and news
4196 @menu
4197 * Changing the included text prefix::
4198 * Saving a copy of outgoing mail::
4199 * Expanding aliases when sending mail::
4200 * Sorting the messages in an Rmail folder::
4201 * Rmail writes to /var/spool/mail::
4202 * Replying to the sender of a message::
4203 * Automatically starting a mail or news reader::
4204 * Reading news with Emacs::
4205 * Gnus does not work with NNTP::
4206 * Making Gnus faster::
4207 * Catching up in all newsgroups::
4208 @end menu
4210 @node Changing the included text prefix
4211 @section How do I change the included text prefix in mail/news followups?
4212 @cindex Prefix in mail/news followups, changing
4213 @cindex Included text prefix, changing
4214 @cindex Setting the included text character
4215 @cindex Quoting in mail messages
4217 If you read mail with Rmail, set the variable @code{mail-yank-prefix}.
4218 For Gnus, set @code{message-yank-prefix}.  For VM, set
4219 @code{vm-included-text-prefix}.  For mh-e, set @code{mh-ins-buf-prefix}.
4221 For fancier control of citations, use Supercite (@pxref{Top,, the Supercite
4222 Manual, sc, The Supercite Manual}).
4224 To prevent Emacs from including various headers of the replied-to
4225 message, set the value of @code{mail-yank-ignored-headers} to an
4226 appropriate regexp.
4228 @node Saving a copy of outgoing mail
4229 @section How do I save a copy of outgoing mail?
4230 @cindex Saving a copy of outgoing mail
4231 @cindex Copying outgoing mail to a file
4232 @cindex Filing outgoing mail
4233 @cindex Automatic filing of outgoing mail
4234 @cindex Mail, saving outgoing automatically
4236 You can either mail yourself a copy by including a @samp{BCC} header in the
4237 mail message, or store a copy of the message directly to a file by
4238 including an @samp{FCC} header.
4240 If you use standard mail, you can automatically create a @samp{BCC} to
4241 yourself by putting
4243 @lisp
4244 (setq mail-self-blind t)
4245 @end lisp
4247 @noindent
4248 in your @file{.emacs} file.  You can automatically include an @samp{FCC}
4249 field by putting something like the following in your @file{.emacs}
4250 file:
4252 @lisp
4253 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4254 @end lisp
4256 The output file will be in Unix mail format.
4258 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4259 components file.
4261 It does not work to put @samp{set record filename} in the @file{.mailrc}
4262 file.
4264 @node Expanding aliases when sending mail
4265 @section Why doesn't Emacs expand my aliases when sending mail?
4266 @cindex Expanding aliases when sending mail
4267 @cindex Mail alias expansion
4268 @cindex Sending mail with aliases
4270 @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}.
4272 @itemize @bullet
4274 @item
4275 Normally, Emacs expands aliases when you send the message.
4276 To expand them before this, use @kbd{M-x expand-mail-aliases}.
4278 @item
4279 Emacs normally only reads the @file{.mailrc} file once per session, when
4280 you start to compose your first mail message.  If you edit the file
4281 after this, you can use @kbd{M-x build-mail-aliases} to make Emacs
4282 reread it.  Prior to Emacs 24.1, this is not an interactive command, so
4283 you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}.
4285 @item
4286 If you like, you can expand mail aliases as abbrevs, as soon as you
4287 type them in.  To enable this feature, execute the following:
4289 @lisp
4290 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4291 @end lisp
4293 Note that the aliases are expanded automatically only after you type
4294 a word-separator character (e.g. @key{RET} or @kbd{,}).  You can force their
4295 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4296 (@kbd{M-x expand-abbrev}).
4297 @end itemize
4299 @node Sorting the messages in an Rmail folder
4300 @section How can I sort the messages in my Rmail folder?
4301 @cindex Rmail, sorting messages in
4302 @cindex Folder, sorting messages in an Rmail
4303 @cindex Sorting messages in an Rmail folder
4305 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4306 and their key bindings.
4308 @node Rmail writes to /var/spool/mail
4309 @section Why does Rmail need to write to @file{/var/spool/mail}?
4310 @cindex Rmail and @file{/var/spool/mail}
4311 @cindex @file{/var/spool/mail} and Rmail
4313 This is the behavior of the @code{movemail} program which Rmail uses.
4314 This indicates that @code{movemail} is configured to use lock files.
4316 RMS writes:
4318 @quotation
4319 Certain systems require lock files to interlock access to mail files.
4320 On these systems, @code{movemail} must write lock files, or you risk losing
4321 mail.  You simply must arrange to let @code{movemail} write them.
4323 Other systems use the @code{flock} system call to interlock access.  On
4324 these systems, you should configure @code{movemail} to use @code{flock}.
4325 @end quotation
4327 @node Replying to the sender of a message
4328 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4329 @cindex Replying only to the sender of a message
4330 @cindex Sender, replying only to
4331 @cindex Rmail, replying to the sender of a message in
4333 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit
4334 @key{r} to reply in Rmail, by default it CCs all of the original
4335 recipients (everyone on the original @samp{To} and @samp{CC}
4336 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4337 it replies only to the sender.  However, going through the whole
4338 @kbd{C-u} business every time you want to reply is a pain.  This is the
4339 best fix I've been able to come up with:
4341 @lisp
4342 (defun rmail-reply-t ()
4343   "Reply only to the sender of the current message. (See rmail-reply.)"
4344   (interactive)
4345   (rmail-reply t))
4347 (add-hook 'rmail-mode-hook
4348   (lambda ()
4349     (define-key rmail-mode-map "r" 'rmail-reply-t)
4350     (define-key rmail-mode-map "R" 'rmail-reply)))
4351 @end lisp
4353 @node Automatically starting a mail or news reader
4354 @section How do I make Emacs automatically start my mail/news reader?
4355 @cindex Mail reader, starting automatically
4356 @cindex News reader, starting automatically
4357 @cindex Starting mail/news reader automatically
4359 To start Emacs in Gnus:
4361 @example
4362 emacs -f gnus
4363 @end example
4365 @noindent
4366 in Rmail:
4368 @example
4369 emacs -f rmail
4370 @end example
4372 A more convenient way to start with Gnus:
4374 @example
4375 alias gnus 'emacs -f gnus'
4376 gnus
4377 @end example
4379 It is probably unwise to automatically start your mail or news reader
4380 from your @file{.emacs} file.  This would cause problems if you needed to run
4381 two copies of Emacs at the same time.  Also, this would make it difficult for
4382 you to start Emacs quickly when you needed to.
4384 @node Reading news with Emacs
4385 @section How do I read news under Emacs?
4386 @cindex Reading news under Emacs
4387 @cindex Usenet reader in Emacs
4388 @cindex Gnus newsreader
4389 @cindex FAQ for Gnus
4390 @cindex Gnus FAQ
4391 @cindex Learning more about Gnus
4393 Use @kbd{M-x gnus}.  For more information on Gnus, @pxref{Top,, the Gnus
4394 Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked
4395 Questions,, the Gnus FAQ, gnus}.
4398 @node Gnus does not work with NNTP
4399 @section Why doesn't Gnus work via NNTP?
4400 @cindex Gnus and NNTP
4401 @cindex NNTP, Gnus fails to work with
4403 There is a bug in NNTP version 1.5.10, such that when multiple requests
4404 are sent to the NNTP server, the server only handles the first one
4405 before blocking waiting for more input which never comes.  NNTP version
4406 1.5.11 claims to fix this.
4408 You can work around the bug inside Emacs like this:
4410 @lisp
4411 (setq nntp-maximum-request 1)
4412 @end lisp
4414 You can find out what version of NNTP your news server is running by
4415 telnetting to the NNTP port (usually 119) on the news server machine
4416 (i.e., @kbd{telnet server-machine 119}).  The server should give its
4417 version number in the welcome message.  Type @kbd{quit} to get out.
4419 @node Making Gnus faster
4420 @section How do I make Gnus faster?
4421 @cindex Faster, starting Gnus
4422 @cindex Starting Gnus faster
4423 @cindex Gnus, starting faster
4424 @cindex Slow catch up in Gnus
4425 @cindex Gnus is slow when catching up
4426 @cindex Crosspostings make Gnus catching up slow
4428 From the Gnus FAQ (@pxref{Reading news with Emacs}):
4430 @quotation
4431 If you have a slow machine, or are just really impatient, there are a
4432 few things you can do to make Gnus run faster.
4434 Set @code{gnus-check-new-newsgroups} and
4435 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
4437 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
4438 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
4439 summary buffer faster.
4440 @end quotation
4442 @node Catching up in all newsgroups
4443 @section How do I catch up all newsgroups in Gnus?
4444 @cindex Catching up all newsgroups in Gnus
4445 @cindex Gnus, Catching up all newsgroups in
4447 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4449 Leave off the initial @kbd{M-<} if you only want to catch up from point
4450 to the end of the @file{*Newsgroup*} buffer.
4452 @node Concept index
4453 @unnumbered Concept Index
4454 @printindex cp
4456 @bye