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