(delayed-after-hook-functions): Tighten the code a bit
[emacs.git] / doc / misc / efaq.texi
blobdf3d09a6337d51fa66141e8ea5c029cc8b34425b
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--2017 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{https://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{https://lists.gnu.org/r/, the GNU mail archive}.
426 Web-based Usenet search services, such as
427 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
428 archive the @code{gnu.*} groups.
430 You can also read the archives of the @code{gnu.*} groups and post new
431 messages at @uref{http://gmane.org/, Gmane}.  Gmane is a service that
432 presents mailing lists as newsgroups (even those without a traditional
433 mail-to-news gateway).
435 @node Reporting bugs
436 @section Where should I report bugs and other problems with Emacs?
437 @cindex Bug reporting
438 @cindex Good bug reports
439 @cindex How to submit a bug report
440 @cindex Reporting bugs
442 The correct way to report Emacs bugs is to use the command
443 @kbd{M-x report-emacs-bug}.  It sets up a mail buffer with the
444 essential information and the correct e-mail address,
445 @email{bug-gnu-emacs@@gnu.org}.
446 Anything sent there also appears in the
447 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
448 news to submit the bug report.  This ensures a reliable return address
449 so you can be contacted for further details.
451 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
452 a bug!  The manual describes in detail how to submit a useful bug
453 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
454 (@xref{Emacs manual}, if you don't know how to read the manual.)
456 RMS says:
458 @quotation
459 Sending bug reports to
460 @url{https://lists.gnu.org/mailman/listinfo/help-gnu-emacs,
461 the help-gnu-emacs mailing list}
462 (which has the effect of posting on @uref{news:gnu.emacs.help}) is
463 undesirable because it takes the time of an unnecessarily large group
464 of people, most of whom are just users and have no idea how to fix
465 these problem.
466 @url{https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs, The
467 bug-gnu-emacs list} reaches a much smaller group of people who are
468 more likely to know what to do and have expressed a wish to receive
469 more messages about Emacs than the others.
470 @end quotation
472 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
474 @quotation
475 If you have reported a bug and you don't hear about a possible fix,
476 then after a suitable delay (such as a week) it is okay to post on
477 @code{gnu.emacs.help} asking if anyone can help you.
478 @end quotation
480 If you are unsure whether you have found a bug, consider the following
481 non-exhaustive list, courtesy of RMS:
483 @quotation
484 If Emacs crashes, that is a bug.  If Emacs gets compilation errors
485 while building, that is a bug.  If Emacs crashes while building, that
486 is a bug.  If Lisp code does not do what the documentation says it
487 does, that is a bug.
488 @end quotation
490 @node Unsubscribing from Emacs lists
491 @section  How do I unsubscribe from a mailing list?
492 @cindex Unsubscribing from GNU mailing lists
493 @cindex Removing yourself from GNU mailing lists
495 If you are receiving a GNU mailing list named @var{list}, you should be
496 able to unsubscribe from it by sending a request to the address
497 @email{@var{list}-request@@gnu.org}.  Mailing lists mails normally
498 contain information in either the message header
499 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
500 unsubscribe.
502 @node Contacting the FSF
503 @section  How do I contact the FSF?
504 @cindex Contracting the FSF
505 @cindex Free Software Foundation, contacting
507 For up-to-date information, see
508 @uref{https://www.fsf.org/about/contact.html, the FSF contact web-page}.
509 You can send general correspondence to @email{info@@fsf.org}.
511 @cindex Ordering GNU software
512 For details on how to order items directly from the FSF, see the
513 @uref{https://shop.fsf.org/, FSF on-line store}.
515 @c ------------------------------------------------------------
516 @node Getting help
517 @chapter Getting help
518 @cindex Getting help
520 This chapter tells you how to get help with Emacs.
522 @menu
523 * Basic editing::
524 * Learning how to do something::
525 * Getting a printed manual::
526 * Emacs Lisp documentation::
527 * Installing Texinfo documentation::
528 * Printing a Texinfo file::
529 * Viewing Info files outside of Emacs::
530 * Informational files for Emacs::
531 * Help installing Emacs::
532 * Obtaining the FAQ::
533 @end menu
535 @node Basic editing
536 @section I'm just starting Emacs; how do I do basic editing?
537 @cindex Basic editing with Emacs
538 @cindex Beginning editing
539 @cindex Tutorial, invoking the
540 @cindex Self-paced tutorial, invoking the
541 @cindex Help system, entering the
543 Type @kbd{C-h t} to invoke the self-paced tutorial.  Just typing
544 @kbd{C-h} enters the help system.  Starting with Emacs 22, the tutorial
545 is available in many foreign languages such as French, German, Japanese,
546 Russian, etc.  Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
547 to choose your language and start the tutorial.
549 Your system administrator may have changed @kbd{C-h} to act like
550 @key{DEL} to deal with local keyboards.  You can use @kbd{M-x
551 help-for-help} instead to invoke help.  To discover what key (if any)
552 invokes help on your system, type @kbd{M-x where-is @key{RET}
553 help-for-help @key{RET}}.  This will print a comma-separated list of key
554 sequences in the echo area.  Ignore the last character in each key
555 sequence listed.  Each of the resulting key sequences (e.g., @key{F1} is
556 common) invokes help.
558 Emacs help works best if it is invoked by a single key whose value
559 should be stored in the variable @code{help-char}.
561 Some Emacs slides and tutorials can be found at
562 @uref{http://web.psung.name/emacs/}.
564 @node Learning how to do something
565 @section How do I find out how to do something in Emacs?
566 @cindex Help for Emacs
567 @cindex Learning to do something in Emacs
568 @cindex Reference card for Emacs
569 @cindex Overview of help systems
571 There are several methods for finding out how to do things in Emacs.
573 @itemize @bullet
575 @cindex Reading the Emacs manual
576 @item
577 The complete text of the Emacs manual is available via the Info
578 hypertext reader.  Type @kbd{C-h r} to display the manual in Info mode.
579 Typing @key{h} immediately after entering Info will provide a short
580 tutorial on how to use it.
582 @cindex Lookup a subject in a manual
583 @cindex Index search in a manual
584 @item
585 To quickly locate the section of the manual which discusses a certain
586 issue, or describes a command or a variable, type @kbd{C-h i m emacs
587 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
588 topic, the command, or the variable which you are looking for.  If this
589 does not land you on the right place in the manual, press @kbd{,}
590 (comma) repeatedly until you find what you need.  (The @kbd{i} and
591 @kbd{,} keys invoke the index-searching functions, which look for the
592 @var{topic} you type in all the indices of the Emacs manual.)
594 @cindex Apropos
595 @item
596 You can list all of the commands whose names contain a certain word
597 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
598 command-apropos}).
600 @cindex Command description in the manual
601 @item
602 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
603 for the name of a command, and then attempts to find the section in the
604 Emacs manual where that command is described.
606 @cindex Finding commands and variables
607 @item
608 You can list all of the functions and variables whose names contain a
609 certain word using @kbd{M-x apropos}.
611 @item
612 You can list all of the functions and variables whose documentation
613 matches a regular expression or a string, using @kbd{M-x
614 apropos-documentation}.
616 @item
617 You can order a hardcopy of the manual from the FSF@.  @xref{Getting a
618 printed manual}.
620 @cindex Reference cards, in other languages
621 @item
622 You can get a printed reference card listing commands and keys to
623 invoke them.  You can order one from the FSF for $2 (or 10 for $18),
624 or you can print your own from the @file{etc/refcards/refcard.tex} or
625 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
626 Beginning with version 21.1, the Emacs distribution comes with
627 translations of the reference card into several languages; look for
628 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
629 is a two-letter code of the language.  For example, the German version
630 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
631 and @file{etc/refcards/de-refcard.pdf}.
633 @item
634 There are many other commands in Emacs for getting help and
635 information.  To get a list of these commands, type @samp{?} after
636 @kbd{C-h}.
638 @end itemize
640 @node Getting a printed manual
641 @section How do I get a printed copy of the Emacs manual?
642 @cindex Printed Emacs manual, obtaining
643 @cindex Manual, obtaining a printed or HTML copy of
644 @cindex Emacs manual, obtaining a printed or HTML copy of
646 You can order a printed copy of the Emacs manual from the FSF@.  For
647 details see the @uref{https://shop.fsf.org/, FSF on-line store}.
649 The full Texinfo source for the manual also comes in the @file{doc/emacs}
650 directory of the Emacs distribution, if you're daring enough to try to
651 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
652 file}).
654 If you absolutely have to print your own copy, and you don't have @TeX{},
655 you can get a PostScript or PDF (or HTML) version from
657 @uref{https://www.gnu.org/software/emacs/manual/}
659 @xref{Learning how to do something}, for how to view the manual from Emacs.
661 @node Emacs Lisp documentation
662 @section Where can I get documentation on Emacs Lisp?
663 @cindex Documentation on Emacs Lisp
664 @cindex Function documentation
665 @cindex Variable documentation
666 @cindex Emacs Lisp Reference Manual
667 @cindex Reference manual for Emacs Lisp
669 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
670 function, @kbd{C-h v} for a variable.
672 For more information, the Emacs Lisp Reference Manual is available
673 in Info format (@pxref{Top, Emacs Lisp,, elisp, The
674 Emacs Lisp Reference Manual}).
676 You can also order a hardcopy of the manual from the FSF, for details
677 see the @uref{https://shop.fsf.org/, FSF on-line store}.  (This manual is
678 not always in print.)
680 An HTML version of the Emacs Lisp Reference Manual is available at
682 @uref{https://www.gnu.org/software/emacs/elisp-manual/elisp.html}
684 @node Installing Texinfo documentation
685 @section How do I install a piece of Texinfo documentation?
686 @cindex Texinfo documentation, installing
687 @cindex Installing Texinfo documentation
688 @cindex New Texinfo files, installing
689 @cindex Documentation, installing new Texinfo files
690 @cindex Info files, how to install
692 Emacs releases come with pre-built Info files, and the normal install
693 process places them in the correct location.  This is true for most
694 applications that provide Info files.  The following section is only
695 relevant if you want to install extra Info files by hand.
697 First, you must turn the Texinfo source files into Info files.  You may
698 do this using the stand-alone @file{makeinfo} program, available as part
699 of the Texinfo package at
701 @uref{https://www.gnu.org/software/texinfo/}
703 For information about the Texinfo format, read the Texinfo manual which
704 comes with the Texinfo package.  This manual also comes installed in
705 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
706 @key{RET}}.
708 @c FIXME is this a complete alternative?
709 @c Probably not, given that we require makeinfo to build Emacs.
710 Alternatively, you could use the Emacs command @kbd{M-x
711 texinfo-format-buffer}, after visiting the Texinfo source file of the
712 manual you want to convert.
714 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
715 resulting Info files in Emacs's Info tree.  To install Info files,
716 perform these steps:
718 @enumerate
719 @item
720 Move the files to the @file{info} directory in the installed Emacs
721 distribution.  @xref{File-name conventions}, if you don't know where that
724 @item
725 Run the @code{install-info} command, which is part of the Texinfo
726 distribution, to update the main Info directory menu, like this:
728 @example
729  install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
730 @end example
732 @noindent
733 where @var{dir-path} is the full path to the directory where you copied
734 the produced Info file(s), and @var{file} is the name of the Info file
735 you produced and want to install.
737 If you don't have the @code{install-info} command installed, you can
738 edit the file @file{info/dir} in the installed Emacs distribution, and
739 add a line for the top level node in the Info package that you are
740 installing.  Follow the examples already in this file.  The format is:
742 @example
743 * Topic: (relative-pathname).  Short description of topic.
744 @end example
746 @end enumerate
748 If you want to install Info files and you don't have the necessary
749 privileges, you have several options:
751 @itemize @bullet
752 @item
753 Info files don't actually need to be installed before being used.
754 You can use a prefix argument for the @code{info} command and specify
755 the name of the Info file in the minibuffer.  This goes to the node
756 named @samp{Top} in that file.  For example, to view a Info file named
757 @file{@var{info-file}} in your home directory, you can type this:
759 @example
760 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
761 @end example
763 Alternatively, you can feed a file name to the @code{Info-goto-node}
764 command (invoked by pressing @key{g} in Info mode) by typing the name
765 of the file in parentheses, like this:
767 @example
768 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
769 @end example
771 @item
772 You can create your own Info directory.  You can tell Emacs where that
773 Info directory is by adding its pathname to the value of the variable
774 @code{Info-default-directory-list}.  For example, to use a private Info
775 directory which is a subdirectory of your home directory named @file{Info},
776 you could put this in your @file{.emacs} file:
778 @lisp
779 (add-to-list 'Info-default-directory-list "~/Info")
780 @end lisp
782 You will need a top-level Info file named @file{dir} in this directory
783 which has everything the system @file{dir} file has in it, except it
784 should list only entries for Info files in that directory.  You might
785 not need it if (fortuitously) all files in this directory were
786 referenced by other @file{dir} files.  The node lists from all
787 @file{dir} files in @code{Info-default-directory-list} are merged by the
788 Info system.
790 @end itemize
792 @node Printing a Texinfo file
793 @section How do I print a Texinfo file?
794 @cindex Printing a Texinfo file
795 @cindex Texinfo file, printing
796 @cindex Printing documentation
798 You can't get nicely printed output from Info files; you must still have
799 the original Texinfo source file for the manual you want to print.
801 Assuming you have @TeX{} installed on your system, follow these steps:
803 @enumerate
805 @item
806 Make sure the first line of the Texinfo file looks like this:
808 @example
809 \input texinfo
810 @end example
812 You may need to change @samp{texinfo} to the full pathname of the
813 @file{texinfo.tex} file, which comes with Emacs as
814 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
816 @item
817 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
818 the name of the Texinfo source file for which you want to produce a
819 printed copy.  The @samp{texi2dvi} script is part of the GNU Texinfo
820 distribution.
822 Alternatively, @samp{texi2pdf} produces PDF files.
824 @item
825 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
826 printing DVI files at your site.  For example, if you have a PostScript
827 printer, run the @code{dvips} program to print the DVI file on that
828 printer.
830 @end enumerate
832 To get more general instructions, retrieve the latest Texinfo package
833 (@pxref{Installing Texinfo documentation}).
835 @node Viewing Info files outside of Emacs
836 @section Can I view Info files without using Emacs?
837 @cindex Viewing Info files
838 @cindex Info file viewers
839 @cindex Alternative Info file viewers
841 Yes.  Here are some alternative programs:
843 @itemize @bullet
845 @item
846 @code{info}, a stand-alone version of the Info program, comes as part of
847 the Texinfo package.  @xref{Installing Texinfo documentation}, for
848 details.
850 @item
851 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
852 You can get Tkinfo at
853 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
855 @end itemize
857 @node Informational files for Emacs
858 @section What informational files are available for Emacs?
859 @cindex Informational files included with Emacs
860 @cindex Files included with Emacs
861 @cindex @file{COPYING}, description of file
862 @cindex @file{DISTRIB}, description of file
863 @cindex @file{MACHINES}, description of file
864 @cindex @file{NEWS}, description of file
866 This isn't a frequently asked question, but it should be!  A variety of
867 informational files about Emacs and relevant aspects of the GNU project
868 are available for you to read.
870 The following files (and others) are available in the @file{etc}
871 directory of the Emacs distribution (see @ref{File-name conventions}, if
872 you're not sure where that is).  Many of these files are available via
873 the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
874 help-for-help}).
876 @table @file
878 @item COPYING
879 GNU General Public License
881 @item DISTRIB
882 Emacs Availability Information
884 @item MACHINES
885 Status of Emacs on Various Machines and Systems
887 @item NEWS
888 Emacs news, a history of recent user-visible changes
890 @end table
892 More GNU information, including back issues of the @cite{GNU's
893 Bulletin}, are at
895 @uref{https://www.gnu.org/bulletins/bulletins.html} and
897 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
899 @node Help installing Emacs
900 @section Where can I get help in installing Emacs?
901 @cindex Installation help
902 @cindex Help installing Emacs
904 @xref{Installing Emacs}, for some basic installation hints, and see
905 @ref{Problems building Emacs}, if you have problems with the installation.
907 @uref{https://www.fsf.org/resources/service/, The GNU Service directory}
908 lists companies and individuals willing to sell you help in installing
909 or using Emacs and other GNU software.
911 @node Obtaining the FAQ
912 @section Where can I get the latest version of this FAQ?
913 @cindex FAQ, obtaining the
914 @cindex Latest FAQ version, obtaining the
916 The Emacs FAQ is distributed with Emacs in Info format.  You can read it
917 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
918 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
919 C-f} (@kbd{M-x view-emacs-FAQ}).  The very latest version is available
920 in the Emacs development repository (@pxref{Latest version of Emacs}).
922 @c ------------------------------------------------------------
923 @node Status of Emacs
924 @chapter Status of Emacs
925 @cindex Status of Emacs
927 This chapter gives you basic information about Emacs, including the
928 status of its latest version.
930 @menu
931 * Origin of the term Emacs::
932 * Latest version of Emacs::
933 * New in Emacs 25::
934 * New in Emacs 24::
935 * New in Emacs 23::
936 * New in Emacs 22::
937 * New in Emacs 21::
938 * New in Emacs 20::
939 @end menu
941 @node Origin of the term Emacs
942 @section Where does the name ``Emacs'' come from?
943 @cindex Origin of the term ``Emacs''
944 @cindex Emacs name origin
945 @cindex TECO
946 @cindex Original version of Emacs
948 Emacs originally was an acronym for Editor MACroS@.  RMS says he ``picked
949 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
950 the time.''  The first Emacs was a set of macros written in 1976 at MIT
951 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
952 Editor and COrrector) under ITS (the Incompatible Timesharing System) on
953 a PDP-10.  RMS had already extended TECO with a ``real-time''
954 full-screen mode with reprogrammable keys.  Emacs was started by
955 @c gls@@east.sun.com
956 Guy Steele as a project to unify the many
957 divergent TECO command sets and key bindings at MIT, and completed by
958 RMS.
960 Many people have said that TECO code looks a lot like line noise; you
961 can read more at @uref{news:alt.lang.teco}.  Someone has written a TECO
962 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
963 come with Emacs}); it would be an interesting project to run the
964 original TECO Emacs inside of Emacs.
966 @cindex Why Emacs?
967 For some not-so-serious alternative reasons for Emacs to have that
968 name, check out the file @file{etc/JOKES} (@pxref{File-name
969 conventions}).
971 @node Latest version of Emacs
972 @section What is the latest version of Emacs?
973 @cindex Version, latest
974 @cindex Latest version of Emacs
975 @cindex Development, Emacs
976 @cindex Repository, Emacs
977 @cindex Bazaar repository, Emacs
979 Emacs @value{EMACSVER} is the current version as of this writing.  A version
980 number with two components (e.g., @samp{24.5}) indicates a released
981 version; three components indicate a development
982 version (e.g., @samp{26.0.50} is what will eventually become @samp{26.1}).
984 Emacs is under active development, hosted at
985 @uref{https://savannah.gnu.org/projects/emacs/, Savannah}.
986 Follow the instructions given there to clone the project repository.
988 Because Emacs undergoes many changes before a release, the version
989 number of a development version is not especially meaningful.  It is
990 better to refer to the date on which the sources were retrieved from the
991 development repository.  The development version is usually quite robust
992 for every-day use, but if stability is more important to you than the
993 latest features, you may want to stick to the releases.
995 The following sections list some of the major new features in the last
996 few Emacs releases.  For full details of the changes in any version of
997 Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}).  As of Emacs 22,
998 you can give this command a prefix argument to read about which features
999 were new in older versions.
1001 @node New in Emacs 25
1002 @section What is different about Emacs 25?
1003 @cindex Differences between Emacs 24 and Emacs 25
1004 @cindex Emacs 25, new features in
1006 @itemize
1007 @cindex xwidgets
1008 @item
1009 Emacs can now embed native widgets inside Emacs buffers, if you have
1010 gtk3 and webkitgtk3 installed.  E.g., to access the embedded webkit
1011 browser widget, type @kbd{M-x xwidget-webkit-browse-url}.
1013 @cindex loadable modules
1014 @item
1015 Emacs can now dynamically load external modules compiled as shared
1016 libraries.
1018 @cindex Unicode characters, typing easily
1019 @item
1020 @kbd{C-x 8} has new shorthands for several popular characters, type
1021 @kbd{C-x 8 C-h} to list shorthands.
1023 @cindex automatic display of Lisp APIs
1024 @item
1025 A new minor mode @code{global-eldoc-mode} is enabled by default, and
1026 shows in the echo area or in the mode line the argument list of the
1027 Emacs Lisp form at point.
1029 @cindex pasting text on text terminals
1030 @cindex bracketed paste mode
1031 @item
1032 On text terminals that support the ``bracketed paste mode'' EMacs now
1033 uses that mode by default.  This mode allows Emacs to distinguish
1034 between pasted text and text typed by the user.
1036 @cindex Unicode 9.0.0
1037 @item
1038 Emacs 25 comes with data files imported from the latest Unicode
1039 Standard version 9.0.0.
1041 @cindex bidirectional editing
1042 @item
1043 The support for bidirectional editing was updated to include all the
1044 features mandated by the latest Unicode Standard version 9.0.0.
1046 @cindex character folding in searches
1047 @item
1048 Search command can now perform character folding in matches.  This is
1049 analogous to case folding, but instead of disregarding case variants,
1050 it disregards wider classes of distinctions between similar
1051 characters, such as matching different variants of double quote
1052 characters, ignoring diacritics, etc.
1054 @cindex eww
1055 @item
1056 The Emacs Web Browser EWW was extended to render text using
1057 variable-pitch fonts, and got other new features.
1059 @cindex rmail, and HTML mails
1060 @item
1061 Rmail can now render HTML mail messages, if Emacs is built with
1062 libxml2 or if you have the Lynx browser installed.
1064 @cindex support for push commands in VC
1065 @item
1066 VC now has basic support for @code{push} commands, implemented for
1067 Bzr, Git, and Hg.
1069 @cindex hide-ifdef, C/C@t{++} expressions in macros
1070 @item
1071 Hide-IfDef mode now support full C/C@t{++} expressions in macros,
1072 macro argument expansion, interactive macro evaluation and automatic
1073 scanning of @code{#define}d symbols.
1075 @cindex xref
1076 @item
1077 New package Xref replaces Etags's front-end and UI.  Xref provides a
1078 generic framework and new commands to find and move to definitions of
1079 functions, macros, data structures etc., as well as go back to the
1080 location where you were before moving to a definition.  It supersedes
1081 and obsoletes many Etags commands, while still using the etags.el code
1082 that reads the TAGS tables as one of its back-ends.  As result, the
1083 popular key bindings @kbd{M-.} and @kbd{M-,} have been changed to
1084 invoke Xref commands.
1086 @cindex project
1087 @item
1088 The new package Project provides generic infrastructure for dealing
1089 with projects.
1091 @cindex horizontal scroll bars
1092 @item
1093 Emacs can now draw horizontal scroll bars on some platforms that
1094 provide toolkit scroll bars, namely Gtk+, Lucid, Motif and Windows.
1096 @end itemize
1098 Consult the Emacs @file{NEWS} file (@kbd{C-h n}) for the full list of
1099 changes in Emacs 25.
1101 @node New in Emacs 24
1102 @section What is different about Emacs 24?
1103 @cindex Differences between Emacs 23 and Emacs 24
1104 @cindex Emacs 24, new features in
1106 @itemize
1107 @cindex packages, installing more
1108 @item
1109 Emacs now includes a package manager.  Type @kbd{M-x list-packages} to
1110 get started.  You can use this to download and automatically install
1111 many more Lisp packages.
1113 @cindex lexical binding
1114 @item
1115 Emacs Lisp now supports lexical binding on a per-file basis.  In
1116 @emph{lexical binding}, variable references must be located textually
1117 within the binding construct.  This contrasts with @emph{dynamic
1118 binding}, where programs can refer to variables defined outside their
1119 local textual scope.  A Lisp file can use a local variable setting of
1120 @code{lexical-binding: t} to indicate that the contents should be
1121 interpreted using lexical binding.  See the Emacs Lisp Reference
1122 Manual for more details.
1124 @cindex bidirectional display
1125 @cindex right-to-left languages
1126 @item
1127 Some human languages, such as English, are written from left to right.
1128 Others, such as Arabic, are written from right to left.  Emacs now has
1129 support for any mixture of these forms---this is ``bidirectional text''.
1131 @item
1132 Handling of text selections has been improved, and now integrates
1133 better with external clipboards.
1135 @cindex themes
1136 @item
1137 A new command @kbd{customize-themes} allows you to easily change the
1138 appearance of your Emacs.
1140 @item
1141 Emacs can be compiled with the GTK+ 3 toolkit.
1143 @item
1144 Support for several new external libraries can be included at compile
1145 time:
1147 @itemize
1149 @item
1150 ``Security-Enhanced Linux'' (SELinux) is a Linux kernel feature that
1151 provides more sophisticated file access controls than ordinary
1152 ``Unix-style'' file permissions.
1154 @item
1155 The ImageMagick display library.  This allows you to display many more
1156 image format in Emacs, as well as carry out transformations such as
1157 rotations.
1159 @item
1160 The GnuTLS library for secure network communications.  Emacs uses this
1161 transparently for email if your mail server supports it.
1163 @item
1164 The libxml2 library for parsing XML structures.
1165 @end itemize
1167 @item
1168 Much more flexibility in the handling of windows and buffer display.
1170 @end itemize
1172 As always, consult the @file{NEWS} file for more information.
1175 @node New in Emacs 23
1176 @section What is different about Emacs 23?
1177 @cindex Differences between Emacs 22 and Emacs 23
1178 @cindex Emacs 23, new features in
1180 @itemize
1182 @cindex Anti-aliased fonts
1183 @cindex Freetype fonts
1184 @item
1185 Emacs has a new font code that can use multiple font backends,
1186 including freetype and fontconfig.  Emacs can use the Xft library for
1187 anti-aliasing, and the otf and m17n libraries for complex text layout and
1188 text shaping.
1190 @cindex Unicode
1191 @cindex Character sets
1192 @item
1193 The Emacs character set is now a superset of Unicode.  Several new
1194 language environments have been added.
1196 @cindex Multi-tty support
1197 @cindex X and tty displays
1198 @item
1199 Emacs now supports using both X displays and ttys in the same session
1200 (@samp{multi-tty}).
1202 @cindex Daemon mode
1203 @item
1204 Emacs can be started as a daemon in the background.
1206 @cindex NeXTstep port
1207 @cindex GNUstep port
1208 @cindex macOS Cocoa
1209 @item
1210 There is a new NeXTstep port of Emacs.  This supports GNUstep and Mac OS
1211 X (via the Cocoa libraries).  The Carbon port of Emacs, which supported
1212 Mac OS X in Emacs 22, has been removed.
1214 @cindex Directory-local variables
1215 @item
1216 Directory-local variables can now be defined, in a similar manner to
1217 file-local variables.
1219 @item
1220 Transient Mark mode (@pxref{Highlighting a region}) is on by default.
1222 @end itemize
1224 @noindent
1225 Other changes include: support for serial port access; D-Bus bindings; a
1226 new Visual Line mode for line-motion; improved completion; a new mode
1227 (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML
1228 mode (for editing XML documents) is included; VC has been updated for
1229 newer version control systems; etc.
1232 @node New in Emacs 22
1233 @section What is different about Emacs 22?
1234 @cindex Differences between Emacs 21 and Emacs 22
1235 @cindex Emacs 22, new features in
1237 @itemize
1238 @cindex GTK+ Toolkit
1239 @cindex Drag-and-drop
1240 @item
1241 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1242 operation on X.
1244 @cindex Supported systems
1245 @item
1246 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1247 machines, as well as support for the Mac OS X and Cygwin operating
1248 systems.
1250 @item
1251 The native MS-Windows, and Mac OS X builds include full support
1252 for images, toolbar, and tooltips.
1254 @item
1255 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1256 enabled by default.
1258 @item
1259 The maximum size of buffers is increased: on 32-bit machines, it is
1260 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above.
1262 @item
1263 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1265 @cindex Mouse wheel
1266 @item
1267 Mouse wheel support is enabled by default.
1269 @item
1270 Window fringes are customizable.
1272 @item
1273 The mode line of the selected window is now highlighted.
1275 @item
1276 The minibuffer prompt is displayed in a distinct face.
1278 @item
1279 Abbrev definitions are read automatically at startup.
1281 @item
1282 Grep mode is separate from Compilation mode and has many new options and
1283 commands specific to grep.
1285 @item
1286 The original Emacs macro system has been replaced by the new Kmacro
1287 package, which provides many new commands and features and a simple
1288 interface that uses the function keys F3 and F4.  Macros are stored in a
1289 macro ring, and can be debugged and edited interactively.
1291 @item
1292 The Grand Unified Debugger (GUD) can be used with a full graphical user
1293 interface to GDB; this provides many features found in traditional
1294 development environments, making it easy to manipulate breakpoints, add
1295 watch points, display the call stack, etc.  Breakpoints are visually
1296 indicated in the source buffer.
1298 @item
1299 @cindex New modes
1300 Many new modes and packages have been included in Emacs, such as Calc,
1301 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1302 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1303 savehist, Conf mode, Python mode, DNS mode, etc.
1305 @cindex Multilingual Environment
1306 @item
1307 Leim is now part of Emacs.  Unicode support has been much improved, and
1308 the following input methods have been added: belarusian, bulgarian-bds,
1309 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1310 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1311 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1312 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1313 ukrainian-computer, vietnamese-telex, and welsh.
1315 The following language environments have also been added: Belarusian,
1316 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1317 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1318 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1320 @cindex Documentation
1321 @cindex Emacs Lisp Manual
1322 @item
1323 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1324 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1325 @end itemize
1328 @node New in Emacs 21
1329 @section What is different about Emacs 21?
1330 @cindex Differences between Emacs 20 and Emacs 21
1331 @cindex Emacs 21, new features in
1333 @cindex Variable-size fonts
1334 @cindex Toolbar support
1335 Emacs 21 features a thorough rewrite of the display engine.  The new
1336 display engine supports variable-size fonts, images, and can play sounds
1337 on platforms which support that.  As a result, the visual appearance of
1338 Emacs, when it runs on a windowed display, is much more reminiscent of
1339 modern GUI programs, and includes 3D widgets (used for the mode line and
1340 the scroll bars), a configurable and extensible toolbar, tooltips
1341 (a.k.a.@: balloon help), and other niceties.
1343 @cindex Colors on text-only terminals
1344 @cindex TTY colors
1345 In addition, Emacs 21 supports faces on text-only terminals.  This means
1346 that you can now have colors when you run Emacs on a GNU/Linux console
1347 and on @code{xterm} with @kbd{emacs -nw}.
1350 @node New in Emacs 20
1351 @section What is different about Emacs 20?
1352 @cindex Differences between Emacs 19 and Emacs 20
1353 @cindex Emacs 20, new features in
1355 The differences between Emacs versions 18 and 19 were rather dramatic;
1356 the introduction of frames, faces, and colors on windowing systems was
1357 obvious to even the most casual user.
1359 There are differences between Emacs versions 19 and 20 as well, but many
1360 are more subtle or harder to find.  Among the changes are the inclusion
1361 of MULE code for languages that use non-Latin characters and for mixing
1362 several languages in the same document; the ``Customize'' facility for
1363 modifying variables without having to use Lisp; and automatic conversion
1364 of files from Macintosh, Microsoft, and Unix platforms.
1366 @c ------------------------------------------------------------
1367 @node Common requests
1368 @chapter Common requests
1369 @cindex Common requests
1371 @menu
1372 * Setting up a customization file::
1373 * Using Customize::
1374 * Colors on a TTY::
1375 * Debugging a customization file::
1376 * Displaying the current line or column::
1377 * Displaying the current file name in the titlebar::
1378 * Turning on abbrevs by default::
1379 * Associating modes with files::
1380 * Highlighting a region::
1381 * Replacing highlighted text::
1382 * Controlling case sensitivity::
1383 * Working with unprintable characters::
1384 * Searching for/replacing newlines::
1385 * Yanking text in isearch::
1386 * Wrapping words automatically::
1387 * Turning on auto-fill by default::
1388 * Changing load-path::
1389 * Using an already running Emacs process::
1390 * Compiler error messages::
1391 * Indenting switch statements::
1392 * Customizing C and C++ indentation::
1393 * Horizontal scrolling::
1394 * Overwrite mode::
1395 * Turning off beeping::
1396 * Turning the volume down::
1397 * Automatic indentation::
1398 * Matching parentheses::
1399 * Hiding #ifdef lines::
1400 * Repeating commands::
1401 * Valid X resources::
1402 * Evaluating Emacs Lisp code::
1403 * Changing the length of a Tab::
1404 * Inserting text at the beginning of each line::
1405 * Forcing the cursor to remain in the same column::
1406 * Forcing Emacs to iconify itself::
1407 * Using regular expressions::
1408 * Replacing text across multiple files::
1409 * Documentation for etags::
1410 * Disabling backups::
1411 * Disabling auto-save-mode::
1412 * Going to a line by number::
1413 * Modifying pull-down menus::
1414 * Deleting menus and menu options::
1415 * Turning on syntax highlighting::
1416 * Scrolling only one line::
1417 * Editing MS-DOS files::
1418 * Filling paragraphs with a single space::
1419 * Escape sequences in shell output::
1420 * Fullscreen mode on MS-Windows::
1421 @end menu
1423 @node Setting up a customization file
1424 @section How do I set up a @file{.emacs} file properly?
1425 @cindex @file{.emacs} file, setting up
1426 @cindex @file{.emacs} file, locating
1427 @cindex Init file, setting up
1428 @cindex Customization file, setting up
1430 @xref{Init File,,, emacs, The GNU Emacs Manual}.
1432 In general, new Emacs users should not be provided with @file{.emacs}
1433 files, because this can cause confusing non-standard behavior.  Then
1434 they send questions to
1435 @url{https://lists.gnu.org/mailman/listinfo/help-gnu-emacs,
1436 the help-gnu-emacs mailing list} asking why Emacs
1437 isn't behaving as documented.
1439 Emacs includes the Customize facility (@pxref{Using Customize}).  This
1440 allows users who are unfamiliar with Emacs Lisp to modify their
1441 @file{.emacs} files in a relatively straightforward way, using menus
1442 rather than Lisp code.
1444 While Customize might indeed make it easier to configure Emacs,
1445 consider taking a bit of time to learn Emacs Lisp and modifying your
1446 @file{.emacs} directly.  Simple configuration options are described
1447 rather completely in @ref{Init File,,, emacs, The GNU Emacs Manual},
1448 for users interested in performing frequently requested, basic tasks.
1450 Sometimes users are unsure as to where their @file{.emacs} file should
1451 be found.  Visiting the file as @file{~/.emacs} from Emacs will find
1452 the correct file.
1454 @node Using Customize
1455 @section How do I start using Customize?
1456 @cindex Customize groups
1457 @cindex Customizing variables
1458 @cindex Customizing faces
1460 The main Customize entry point is @kbd{M-x customize @key{RET}}.  This
1461 command takes you to a buffer listing all the available Customize
1462 groups.  From there, you can access all customizable options and faces,
1463 change their values, and save your changes to your init file.
1464 @xref{Easy Customization,,, emacs, The GNU Emacs Manual}.
1466 If you know the name of the group in advance (e.g., ``shell''), use
1467 @kbd{M-x customize-group @key{RET}}.
1469 If you wish to customize a single option, use @kbd{M-x customize-option
1470 @key{RET}}.  This command prompts you for the name of the option to
1471 customize, with completion.
1473 @node Colors on a TTY
1474 @section How do I get colors and syntax highlighting on a TTY?
1475 @cindex Colors on a TTY
1476 @cindex Syntax highlighting on a TTY
1477 @cindex Console, colors
1479 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1480 i.e., on Unix and GNU/Linux text-only terminals and consoles, and when
1481 invoked as @samp{emacs -nw} on X, and MS-Windows.  (Colors and faces were
1482 supported in the MS-DOS port since Emacs 19.29.)  Emacs automatically
1483 detects color support at startup and uses it if available.  If you think
1484 that your terminal supports colors, but Emacs won't use them, check the
1485 @code{termcap} entry for your display type for color-related
1486 capabilities.
1488 The command @kbd{M-x list-colors-display} pops up a window which
1489 exhibits all the colors Emacs knows about on the current display.
1491 Syntax highlighting is on by default since version 22.1.
1493 Emacs 26.1 and later support direct color mode in terminals.  If Emacs
1494 finds Terminfo capabilities @samp{setb24} and @samp{setf24}, 24-bit
1495 direct color mode is used.  The capability strings are expected to
1496 take one 24-bit pixel value as argument and transform the pixel to a
1497 string that can be used to send 24-bit colors to the terminal.
1499 There aren't yet any standard terminal type definitions that would
1500 support the capabilities, but Emacs can be invoked with a custom
1501 definition as shown below.
1503 @example
1504 $ cat terminfo-24bit.src
1506 # Use colon separators.
1507 xterm-24bit|xterm with 24-bit direct color mode,
1508   use=xterm-256color,
1509   setb24=\E[48:2:%p1%@{65536@}%/%d:%p1%@{256@}%/%@{255@}%&%d:%p1%@{255@}%&%dm,
1510   setf24=\E[38:2:%p1%@{65536@}%/%d:%p1%@{256@}%/%@{255@}%&%d:%p1%@{255@}%&%dm,
1511 # Use semicolon separators.
1512 xterm-24bits|xterm with 24-bit direct color mode,
1513   use=xterm-256color,
1514   setb24=\E[48;2;%p1%@{65536@}%/%d;%p1%@{256@}%/%@{255@}%&%d;%p1%@{255@}%&%dm,
1515   setf24=\E[38;2;%p1%@{65536@}%/%d;%p1%@{256@}%/%@{255@}%&%d;%p1%@{255@}%&%dm,
1517 $ tic -x -o ~/.terminfo terminfo-24bit.src
1519 $ TERM=xterm-24bit emacs -nw
1520 @end example
1522 Currently there's no standard way to determine whether a terminal
1523 supports direct color mode.  If such standard arises later on, support
1524 for @samp{setb24} and @samp{setf24} may be removed.
1526 @node Debugging a customization file
1527 @section How do I debug a @file{.emacs} file?
1528 @cindex Debugging @file{.emacs} file
1529 @cindex @file{.emacs} debugging
1530 @cindex Init file debugging
1531 @cindex @samp{-debug-init} option
1533 Start Emacs with the @samp{-debug-init} command-line option.  This
1534 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1535 file, and places you in the debugger if something goes wrong.  The top
1536 line in the @file{trace-back} buffer will be the error message, and the
1537 second or third line of that buffer will display the Lisp code from your
1538 @file{.emacs} file that caused the problem.
1540 You can also evaluate an individual function or argument to a function
1541 in your @file{.emacs} file by moving the cursor to the end of the
1542 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1543 eval-last-sexp}).
1545 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1546 variables which you are trying to set or use.
1548 @node Displaying the current line or column
1549 @section How do I make Emacs display the current line (or column) number?
1550 @cindex @code{line-number-mode}
1551 @cindex Displaying the current line or column
1552 @cindex Line number, displaying the current
1553 @cindex Column, displaying the current
1554 @cindex @code{mode-line-format}
1556 By default, Emacs displays the current line number of the point in the
1557 mode line.  You can toggle this feature off or on with the command
1558 @kbd{M-x line-number-mode}, or by setting the variable
1559 @code{line-number-mode}.  Note that Emacs will not display the line
1560 number if the buffer's size in bytes is larger than the value of the
1561 variable @code{line-number-display-limit}.
1563 You can similarly display the current column with
1564 @kbd{M-x column-number-mode}, or by putting the form
1566 @lisp
1567 (setq column-number-mode t)
1568 @end lisp
1570 @noindent
1571 in your @file{.emacs} file.  This feature is off by default.
1573 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1574 will insert the current column's value into the mode line.  See the
1575 documentation for @code{mode-line-format} (using @kbd{C-h v
1576 mode-line-format @key{RET}}) for more information on how to set and use
1577 this variable.
1579 @cindex Set number capability in @code{vi} emulators
1580 The @samp{linum} package (distributed with Emacs since version 23.1)
1581 displays line numbers in the left margin, like the ``set number''
1582 capability of @code{vi}.  The packages @samp{setnu} and
1583 @samp{wb-line-number} (not distributed with Emacs) also implement this
1584 feature.
1586 @node Displaying the current file name in the titlebar
1587 @section How can I modify the titlebar to contain the current file name?
1588 @cindex Titlebar, displaying the current file name in
1589 @cindex File name, displaying in the titlebar
1590 @cindex @code{frame-title-format}
1592 The contents of an Emacs frame's titlebar is controlled by the variable
1593 @code{frame-title-format}, which has the same structure as the variable
1594 @code{mode-line-format}.  (Use @kbd{C-h v} or @kbd{M-x
1595 describe-variable} to get information about one or both of these
1596 variables.)
1598 By default, the titlebar for a frame does contain the name of the buffer
1599 currently being visited, except if there is a single frame.  In such a
1600 case, the titlebar contains Emacs invocation name and the name of the
1601 machine at which Emacs was invoked.  This is done by setting
1602 @code{frame-title-format} to the default value of
1604 @lisp
1605 (multiple-frames "%b" ("" invocation-name "@@" (system-name)))
1606 @end lisp
1608 To modify the behavior such that frame titlebars contain the buffer's
1609 name regardless of the number of existing frames, include the following
1610 in your @file{.emacs}:
1612 @lisp
1613 (setq frame-title-format "%b")
1614 @end lisp
1616 @node Turning on abbrevs by default
1617 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1618 @cindex Abbrevs, turning on by default
1620 Abbrev mode expands abbreviations as you type them.  To turn it on in a
1621 specific buffer, use @kbd{M-x abbrev-mode}.  To turn it on in every
1622 buffer by default, put this in your @file{.emacs} file:
1624 @lisp
1625 (setq-default abbrev-mode t)
1626 @end lisp
1628 @noindent To turn it on in a specific mode, use:
1630 @lisp
1631 (add-hook '@var{mymode}-mode-hook
1632           (lambda ()
1633            (setq abbrev-mode t)))
1634 @end lisp
1636 @noindent If your Emacs version is older then 22.1, you will also need to use:
1638 @lisp
1639 (condition-case ()
1640    (quietly-read-abbrev-file)
1641   (file-error nil))
1642 @end lisp
1644 @node Associating modes with files
1645 @section How do I make Emacs use a certain major mode for certain files?
1646 @cindex Associating modes with files
1647 @cindex File extensions and modes
1648 @cindex @code{auto-mode-alist}, modifying
1649 @cindex Modes, associating with file extensions
1651 If you want to use a certain mode @var{foo} for all files whose names end
1652 with the extension @file{.@var{bar}}, this will do it for you:
1654 @lisp
1655 (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode))
1656 @end lisp
1658 Alternatively, put this somewhere in the first line of any file you want to
1659 edit in the mode @var{foo} (in the second line, if the first line begins
1660 with @samp{#!}):
1662 @example
1663 -*- @var{foo} -*-
1664 @end example
1666 @cindex Major mode for shell scripts
1667 The variable @code{interpreter-mode-alist} specifies which mode to use
1668 when loading an interpreted script (e.g., shell, python, etc.).  Emacs
1669 determines which interpreter you're using by examining the first line of
1670 the script.  Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
1671 @code{interpreter-mode-alist} to learn more.
1673 @node Highlighting a region
1674 @section How can I highlight a region of text in Emacs?
1675 @cindex Highlighting text
1676 @cindex Text, highlighting
1677 @cindex @code{transient-mark-mode}
1678 @cindex Region, highlighting a
1680 You can cause the region to be highlighted when the mark is active by
1681 including
1683 @lisp
1684 (transient-mark-mode 1)
1685 @end lisp
1687 @noindent
1688 in your @file{.emacs} file.  Since Emacs 23.1, this feature is on by default.
1690 @node Replacing highlighted text
1691 @section How can I replace highlighted text with what I type?
1692 @cindex @code{delete-selection-mode}
1693 @cindex Replacing highlighted text
1694 @cindex Highlighting and replacing text
1696 Use @code{delete-selection-mode}, which you can start automatically by
1697 placing the following Lisp form in your @file{.emacs} file:
1699 @lisp
1700 (delete-selection-mode 1)
1701 @end lisp
1703 According to the documentation string for @code{delete-selection-mode}
1704 (which you can read using @kbd{M-x describe-function @key{RET}
1705 delete-selection-mode @key{RET}}):
1707 @quotation
1708 When Delete Selection mode is enabled, typed text replaces the selection
1709 if the selection is active.  Otherwise, typed text is just inserted at
1710 point regardless of any selection.
1711 @end quotation
1713 This mode also allows you to delete (not kill) the highlighted region by
1714 pressing @key{DEL}.
1716 @node Controlling case sensitivity
1717 @section How do I control Emacs's case-sensitivity when searching/replacing?
1718 @cindex @code{case-fold-search}
1719 @cindex Case sensitivity of searches
1720 @cindex Searching without case sensitivity
1721 @cindex Ignoring case in searches
1723 @c FIXME
1724 The value of the variable @code{case-fold-search} determines whether
1725 searches are case sensitive:
1727 @lisp
1728 (setq case-fold-search nil) ; make searches case sensitive
1729 (setq case-fold-search t)   ; make searches case insensitive
1730 @end lisp
1732 @cindex Case sensitivity in replacements
1733 @cindex Replacing, and case sensitivity
1734 @cindex @code{case-replace}
1735 Similarly, for replacing, the variable @code{case-replace} determines
1736 whether replacements preserve case.
1738 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1740 To change the case sensitivity just for one major mode, use the major
1741 mode's hook.  For example:
1743 @lisp
1744 (add-hook '@var{foo}-mode-hook
1745           (lambda ()
1746            (setq case-fold-search nil)))
1747 @end lisp
1749 @node Working with unprintable characters
1750 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1751 @cindex Unprintable characters, working with
1752 @cindex Working with unprintable characters
1753 @cindex Control characters, working with
1754 @cindex Eight-bit characters, working with
1755 @cindex Searching for unprintable characters
1756 @cindex Regexps and unprintable characters
1758 To search for a single character that appears in the buffer as, for
1759 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.
1760 Searching for @strong{all} unprintable characters is best done with a
1761 regular expression (@dfn{regexp}) search.  The easiest regexp to use for
1762 the unprintable chars is the complement of the regexp for the printable
1763 chars.
1765 @itemize @bullet
1767 @item
1768 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1770 @item
1771 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1773 @end itemize
1775 To type these special characters in an interactive argument to
1776 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1777 use @kbd{C-q}.  (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1778 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.)  So,
1779 to search for unprintable characters using @code{re-search-forward}:
1781 @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}}
1783 Using @code{isearch-forward-regexp}:
1785 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1787 To delete all unprintable characters, simply use replace-regexp:
1789 @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}}
1791 Replacing is similar to the above.  To replace all unprintable
1792 characters with a colon, use:
1794 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}
1796 @node Searching for/replacing newlines
1797 @section How do I input a newline character in isearch or query-replace?
1798 @cindex Searching for newlines
1799 @cindex Replacing newlines
1801 Use @kbd{C-q C-j}.  For more information,
1802 @pxref{Special Isearch,, Special Input for Incremental Search, emacs,
1803 The GNU Emacs Manual}.
1805 @node Yanking text in isearch
1806 @section How do I copy text from the kill ring into the search string?
1807 @cindex Yanking text into the search string
1808 @cindex isearch yanking
1810 Use @kbd{M-y}.  @xref{Isearch Yank,,, emacs, The GNU Emacs Manual}.
1812 @node Wrapping words automatically
1813 @section How do I make Emacs wrap words for me?
1814 @cindex Wrapping word automatically
1815 @cindex Wrapping lines
1816 @cindex Line wrap
1817 @cindex @code{auto-fill-mode}, introduction to
1818 @cindex Maximum line width, default value
1819 @cindex @code{fill-column}, default value
1821 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1822 The default maximum line width is 70, determined by the variable
1823 @code{fill-column}.  To learn how to turn this on automatically, see
1824 @ref{Turning on auto-fill by default}.
1826 @node Turning on auto-fill by default
1827 @section How do I turn on @code{auto-fill-mode} by default?
1828 @cindex @code{auto-fill-mode}, activating automatically
1829 @cindex Filling automatically
1830 @cindex Automatic entry to @code{auto-fill-mode}
1832 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1833 auto-fill-mode}.
1835 To turn it on for every buffer in a certain mode, you must use the hook
1836 for that mode.  For example, to turn on @code{auto-fill} mode for all
1837 text buffers, including the following in your @file{.emacs} file:
1839 @lisp
1840 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1841 @end lisp
1843 If you want @code{auto-fill} mode on in all major modes, do this:
1845 @lisp
1846 (setq-default auto-fill-function 'do-auto-fill)
1847 @end lisp
1849 @node Changing load-path
1850 @section How do I change @code{load-path}?
1851 @cindex @code{load-path}, modifying
1852 @cindex Modifying @code{load-path}
1853 @cindex Adding to @code{load-path}
1855 In general, you should only add to the @code{load-path}.  You can add
1856 directory @var{/dir/subdir} to the load path like this:
1858 @lisp
1859 (add-to-list 'load-path "/dir/subdir/")
1860 @end lisp
1862 To do this relative to your home directory:
1864 @lisp
1865 (add-to-list 'load-path "~/mysubdir/")
1866 @end lisp
1868 @node Using an already running Emacs process
1869 @section How do I use an already running Emacs from another window?
1870 @cindex @code{emacsclient}
1871 @cindex Emacs server functions
1872 @cindex Using an existing Emacs process
1874 @code{emacsclient}, which comes with Emacs, is for editing a file using
1875 an already running Emacs rather than starting up a new Emacs.  It does
1876 this by sending a request to the already running Emacs, which must be
1877 expecting the request.
1879 @itemize @bullet
1881 @item
1882 Setup:
1884 Emacs must have executed the @code{server-start} function for
1885 @samp{emacsclient} to work.  This can be done either by a command line
1886 option:
1888 @example
1889 emacs -f server-start
1890 @end example
1892 or by invoking @code{server-start} from @file{.emacs}:
1894 @lisp
1895 (if (@var{some conditions are met}) (server-start))
1896 @end lisp
1898 When this is done, Emacs creates a Unix domain socket named
1899 @file{server} in @file{/tmp/emacs@var{userid}}. See
1900 @code{server-socket-dir}.
1902 To get your news reader, mail reader, etc., to invoke
1903 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1904 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}.  You may
1905 have to specify the full pathname of the @samp{emacsclient} program
1906 instead.  Examples:
1908 @example
1909 # csh commands:
1910 setenv EDITOR emacsclient
1912 # using full pathname
1913 setenv EDITOR /usr/local/emacs/etc/emacsclient
1915 # sh command:
1916 EDITOR=emacsclient ; export EDITOR
1917 @end example
1919 @item
1920 Normal use:
1922 When @samp{emacsclient} is run, it connects to the socket and passes its
1923 command line options to Emacs, which at the next opportunity will visit
1924 the files specified.  (Line numbers can be specified just like with
1925 Emacs.)  The user will have to switch to the Emacs window by hand.  When
1926 the user is done editing a file, the user can type @kbd{C-x #} (or
1927 @kbd{M-x server-edit}) to indicate this.  If there is another buffer
1928 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1929 @code{emacsclient} will exit, signaling the calling program to continue.
1931 @cindex @code{gnuserv}
1932 There is an alternative version of @samp{emacsclient} called
1933 @c ange@@hplb.hpl.hp.com
1934 @samp{gnuserv}, written by Andy Norman
1935 (@pxref{Packages that do not come with Emacs}).  @samp{gnuserv} uses
1936 Internet domain sockets, so it can work across most network connections.
1938 The most recent @samp{gnuserv} package is available at
1940 @uref{http://meltin.net/hacks/emacs/}
1942 @end itemize
1944 @node Compiler error messages
1945 @section How do I make Emacs recognize my compiler's funny error messages?
1946 @cindex Compiler error messages, recognizing
1947 @cindex Recognizing non-standard compiler errors
1948 @cindex Regexps for recognizing compiler errors
1949 @cindex Errors, recognizing compiler
1951 Customize the @code{compilation-error-regexp-alist} variable.
1953 @node Indenting switch statements
1954 @section How do I change the indentation for @code{switch}?
1955 @cindex @code{switch}, indenting
1956 @cindex Indenting of @code{switch}
1958 Many people want to indent their @code{switch} statements like this:
1960 @example
1963   switch(x) @{
1964     case A:
1965       x1;
1966       break;
1967     case B:
1968       x2;
1969       break;
1970     default:
1971       x3;
1972   @}
1974 @end example
1976 @noindent To achieve this, add the following line to your @file{.emacs}:
1978 @lisp
1979 (c-set-offset 'case-label '+)
1980 @end lisp
1982 @node Customizing C and C++ indentation
1983 @section How to customize indentation in C, C@t{++}, and Java buffers?
1984 @cindex Indentation, how to customize
1985 @cindex Customize indentation
1987 The Emacs @code{cc-mode} features an interactive procedure for
1988 customizing the indentation style, which is fully explained in the
1989 @cite{CC Mode} manual that is part of the Emacs distribution, see
1990 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1991 The CC Mode Manual}.  Here's a short summary of the procedure:
1993 @enumerate
1994 @item
1995 Go to the beginning of the first line where you don't like the
1996 indentation and type @kbd{C-c C-o}.  Emacs will prompt you for the
1997 syntactic symbol; type @key{RET} to accept the default it suggests.
1999 @item
2000 Emacs now prompts for the offset of this syntactic symbol, showing the
2001 default (the current definition) inside parentheses.  You can choose
2002 one of these:
2004 @table @code
2005 @item 0
2006 No extra indentation.
2007 @item +
2008 Indent one basic offset.
2009 @item -
2010 Outdent one basic offset.
2011 @item ++
2012 Indent two basic offsets
2013 @item --
2014 Outdent two basic offsets.
2015 @item *
2016 Indent half basic offset.
2017 @item /
2018 Outdent half basic offset.
2019 @end table
2021 @item
2022 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
2023 the line or the block according to what you just specified.
2025 @item
2026 If you don't like the result, go back to step 1.  Otherwise, add the
2027 following line to your @file{.emacs}:
2029 @lisp
2030 (c-set-offset '@var{syntactic-symbol} @var{offset})
2031 @end lisp
2033 @noindent
2034 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
2035 when you type @kbd{C-c C-o} at the beginning of the line, and
2036 @var{offset} is one of the indentation symbols listed above (@code{+},
2037 @code{/}, @code{0}, etc.)@: that you've chosen during the interactive
2038 procedure.
2040 @item
2041 Go to the next line whose indentation is not to your liking and repeat
2042 the process there.
2043 @end enumerate
2045 It is recommended to put all the resulting @code{(c-set-offset ...)}
2046 customizations inside a C mode hook, like this:
2048 @lisp
2049 (defun my-c-mode-hook ()
2050   (c-set-offset ...)
2051   (c-set-offset ...))
2052 (add-hook 'c-mode-hook 'my-c-mode-hook)
2053 @end lisp
2055 @noindent
2056 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
2057 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
2058 might be unavailable when @code{cc-mode} is not loaded.
2060 Note that @code{c-mode-hook} runs for C source files only; use
2061 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
2062 Java sources, etc.  If you want the same customizations to be in
2063 effect in @emph{all} languages supported by @code{cc-mode}, use
2064 @code{c-mode-common-hook}.
2066 @node Horizontal scrolling
2067 @section How can I make Emacs automatically scroll horizontally?
2068 @cindex @code{hscroll-mode}
2069 @cindex Horizontal scrolling
2070 @cindex Scrolling horizontally
2072 In Emacs 21 and later, this is on by default: if the variable
2073 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
2074 automatically scrolls the display horizontally when point moves off the
2075 left or right edge of the window.
2077 Note that this is overridden by the variable
2078 @code{truncate-partial-width-windows} if that variable is non-@code{nil}
2079 and the current buffer is not full-frame width.
2081 In Emacs 20, use @code{hscroll-mode}.
2083 @node Overwrite mode
2084 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
2085 @cindex @key{Insert}
2086 @cindex @code{overwrite-mode}
2087 @cindex Overwriting existing text
2088 @cindex Toggling @code{overwrite-mode}
2090 @kbd{M-x overwrite-mode} (a minor mode).  This toggles
2091 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
2092 is as easy as another @kbd{M-x overwrite-mode}.
2094 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
2096 @node Turning off beeping
2097 @section How do I stop Emacs from beeping on a terminal?
2098 @cindex Beeping, turning off
2099 @cindex Visible bell
2100 @cindex Bell, visible
2102 @c martin@@cc.gatech.edu
2103 Martin R. Frank writes:
2105 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
2106 and set the visible bell to nothing.
2108 That is, put the following in your @code{TERMCAP} environment variable
2109 (assuming you have one):
2111 @example
2112 ... :vb=: ...
2113 @end example
2115 And evaluate the following Lisp form:
2117 @example
2118 (setq visible-bell t)
2119 @end example
2121 @node Turning the volume down
2122 @section How do I turn down the bell volume in Emacs running under X?
2123 @cindex Bell, volume of
2124 @cindex Volume of bell
2126 On X Window system, you can adjust the bell volume and duration for all
2127 programs with the shell command @code{xset}.
2129 Invoking @code{xset} without any arguments produces some basic
2130 information, including the following:
2132 @example
2133 usage:  xset [-display host:dpy] option ...
2134   To turn bell off:
2135       -b                b off               b 0
2136   To set bell volume, pitch and duration:
2137        b [vol [pitch [dur]]]          b on
2138 @end example
2140 @node Automatic indentation
2141 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
2142 @cindex Indenting new lines
2143 @cindex New lines, indenting of
2144 @cindex Previous line, indenting according to
2145 @cindex Text indentation
2147 Such behavior is automatic (in Text mode) in Emacs 20 and later.  From the
2148 @file{etc/NEWS} file for Emacs 20.2:
2150 @example
2151 ** In Text mode, now only blank lines separate paragraphs.  This makes
2152 it possible to get the full benefit of Adaptive Fill mode in Text mode,
2153 and other modes derived from it (such as Mail mode).  @key{TAB} in Text
2154 mode now runs the command @code{indent-relative}; this makes a practical
2155 difference only when you use indented paragraphs.
2157 If you want spaces at the beginning of a line to start a paragraph, use
2158 the new mode, Paragraph Indent Text mode.
2159 @end example
2161 @cindex Prefixing lines
2162 @cindex Fill prefix
2163 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
2164 by default}), you can tell Emacs to prefix every line with a certain
2165 character sequence, the @dfn{fill prefix}.  Type the prefix at the
2166 beginning of a line, position point after it, and then type @kbd{C-x .}
2167 (@code{set-fill-prefix}) to set the fill prefix.  Thereafter,
2168 auto-filling will automatically put the fill prefix at the beginning of
2169 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
2170 prefix when refilling the paragraph.
2172 If you have paragraphs with different levels of indentation, you will
2173 have to set the fill prefix to the correct value each time you move to a
2174 new paragraph.  There are many packages available to deal with this
2175 (@pxref{Packages that do not come with Emacs}).  Look for ``fill'' and
2176 ``indent'' keywords for guidance.
2178 @node Matching parentheses
2179 @section How do I show which parenthesis matches the one I'm looking at?
2180 @cindex Parentheses, matching
2181 @cindex @file{paren.el}
2182 @cindex Highlighting matching parentheses
2183 @cindex Pairs of parentheses, highlighting
2184 @cindex Matching parentheses
2186 Call @code{show-paren-mode} in your @file{.emacs} file:
2188 @lisp
2189 (show-paren-mode 1)
2190 @end lisp
2192 You can also enable this mode by selecting the @samp{Paren Match
2193 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
2194 at the top of any Emacs frame.
2196 Alternatives to this mode include:
2198 @itemize @bullet
2200 @item
2201 If you're looking at a right parenthesis (or brace or bracket) you can
2202 delete it and reinsert it.  Emacs will momentarily move the cursor to
2203 the matching parenthesis.
2205 @item
2206 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2207 will skip over one set of balanced parentheses, so you can see which
2208 parentheses match.  (You can train it to skip over balanced brackets
2209 and braces at the same time by modifying the syntax table.)
2211 @cindex Show matching paren as in @code{vi}
2212 @item
2213 Here is some Emacs Lisp that will make the @key{%} key show the matching
2214 parenthesis, like in @code{vi}.  In addition, if the cursor isn't over a
2215 parenthesis, it simply inserts a % like normal.
2217 @lisp
2218 ;; By an unknown contributor
2220 (global-set-key "%" 'match-paren)
2222 (defun match-paren (arg)
2223   "Go to the matching paren if on a paren; otherwise insert %."
2224   (interactive "p")
2225   (cond ((looking-at "\\s(") (forward-list 1) (backward-char 1))
2226         ((looking-at "\\s)") (forward-char 1) (backward-list 1))
2227         (t (self-insert-command (or arg 1)))))
2228 @end lisp
2230 @end itemize
2232 @node Hiding #ifdef lines
2233 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2234 @cindex @code{#ifdef}, selective display of
2235 @cindex @code{hide-ifdef-mode}
2236 @cindex Hiding @code{#ifdef} text
2237 @cindex Selectively displaying @code{#ifdef} code
2239 @kbd{M-x hide-ifdef-mode}.  (This is a minor mode.)  You might also want
2240 to investigate @file{cpp.el}, which is distributed with Emacs.
2242 @node Repeating commands
2243 @section How do I repeat a command as many times as possible?
2244 @cindex Repeating commands many times
2245 @cindex Commands, repeating many times
2246 @cindex @code{.}, equivalent to @code{vi} command
2248 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2249 that repeats the last command.  If you preface it with a prefix
2250 argument, the prefix arg is applied to the command.
2252 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2253 (@code{repeat-complex-command}) to reinvoke commands that used the
2254 minibuffer to get arguments.  In @code{repeat-complex-command} you can
2255 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2256 keyboard has these keys) to scan through all the different complex
2257 commands you've typed.
2259 To repeat a set of commands, use keyboard macros.  Use @kbd{C-x (} and
2260 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2261 type @kbd{C-x e}.  @xref{Keyboard Macros,,, emacs, The GNU Emacs Manual}.
2263 If you're really desperate for the @code{.} command in @code{vi} that
2264 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2265 mode which comes with Emacs, and which appears to support it.
2267 @node Valid X resources
2268 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2269 @cindex Resources, X
2270 @cindex X resources
2271 @cindex Setting X resources
2273 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2275 You can also use a resource editor, such as editres (for X11R5 and
2276 onwards), to look at the resource names for the menu bar, assuming Emacs
2277 was compiled with the X toolkit.
2279 @node Evaluating Emacs Lisp code
2280 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2281 @cindex Evaluating Lisp code
2282 @cindex Lisp forms, evaluating
2284 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2285 Emacs Lisp @dfn{form}:
2287 @itemize @bullet
2289 @item
2290 If you want it evaluated every time you run Emacs, put it in a file
2291 named @file{.emacs} in your home directory.  This is known as ``your
2292 @file{.emacs} file,'' and contains all of your personal customizations.
2294 @item
2295 You can type the form in the @file{*scratch*} buffer, and then type
2296 @key{LFD} (or @kbd{C-j}) after it.  The result of evaluating the form
2297 will be inserted in the buffer.
2299 @item
2300 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2301 before or around point.
2303 @item
2304 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2305 before point and prints its value in the echo area.
2307 @item
2308 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2309 form in the minibuffer which will be evaluated once you press @key{RET}.
2311 @item
2312 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2313 forms in a file.  (To do this from Lisp use the function @code{load}
2314 instead.)
2316 The functions @code{load-library}, @code{eval-region},
2317 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2318 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2319 about them.
2321 @end itemize
2323 @node Changing the length of a Tab
2324 @section How do I change Emacs's idea of the @key{TAB} character's length?
2325 @cindex Tab length
2326 @cindex Length of tab character
2328 Set the default value of the variable @code{tab-width}.  For example, to set
2329 @key{TAB} stops every 10 characters, insert the following in your
2330 @file{.emacs} file:
2332 @lisp
2333 (setq-default tab-width 10)
2334 @end lisp
2336 Do not confuse variable @code{tab-width} with variable
2337 @code{tab-stop-list}.  The former is used for the display of literal
2338 @key{TAB} characters.  The latter controls what characters are inserted
2339 when you press the @key{TAB} character in certain modes.
2341 @node Inserting text at the beginning of each line
2342 @section How do I insert <some text> at the beginning of every line?
2343 @cindex Prefixing a region with some text
2344 @cindex Prefix character, inserting in mail/news replies
2345 @cindex Replies to mail/news, inserting a prefix character
2346 @cindex @code{mail-yank-prefix}
2347 @cindex Mail replies, inserting a prefix character
2348 @cindex News replies, inserting a prefix character
2350 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2351 @key{RET} ^ @key{RET} your text @key{RET}}.
2353 To do this to a region, use @code{string-insert-rectangle}.
2354 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2355 want to prefix, move the cursor to last line to be prefixed, and type
2356 @kbd{M-x string-insert-rectangle @key{RET}}.  To do this for the whole
2357 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2359 If you are trying to prefix a yanked mail message with @samp{>}, you
2360 might want to set the variable @code{mail-yank-prefix}.  In Message
2361 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2362 runs the function @code{comment-region}, it is a general-purpose
2363 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2365 @node Forcing the cursor to remain in the same column
2366 @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?
2367 @cindex @code{picture-mode}
2368 @cindex Remaining in the same column, regardless of contents
2369 @cindex Vertical movement in empty documents
2371 Use @kbd{M-x picture-mode}.
2373 See also the variable @code{track-eol} and the command
2374 @code{set-goal-column} bound to @kbd{C-x C-n}
2375 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2377 @node Forcing Emacs to iconify itself
2378 @section How do I tell Emacs to iconify itself?
2379 @cindex Iconification under the X Window System
2380 @cindex X Window System and iconification
2381 @cindex Suspending Emacs
2383 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2384 otherwise.  @xref{Frame Commands,,, emacs, The GNU Emacs Manual}.
2386 @node Using regular expressions
2387 @section How do I use regexps (regular expressions) in Emacs?
2388 @cindex Regexps
2389 @cindex Regular expressions
2390 @cindex Differences between Unix and Emacs regexps
2391 @cindex Unix regexps, differences from Emacs
2392 @cindex Text strings, putting regexps in
2394 @xref{Regexp Backslash,,, emacs, The GNU Emacs Manual}.
2396 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2397 are @samp{\(} and @samp{\)}.  Also, the string syntax for a backslash is
2398 @samp{\\}.  To specify a regular expression like @samp{xxx\(foo\|bar\)}
2399 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2401 Note the doubled backslashes!
2403 @itemize @bullet
2405 @item
2406 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2407 (@samp{[^...]})  can match a newline character (@key{LFD} a.k.a.@:
2408 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2409 characters not to match.
2411 @item
2412 The character syntax regexps (e.g., @samp{\sw}) are not
2413 meaningful inside character set regexps (e.g., @samp{[aeiou]}).  (This
2414 is actually typical for regexp syntax.)
2416 @end itemize
2418 @node Replacing text across multiple files
2419 @section How do I perform a replace operation across more than one file?
2420 @cindex Replacing strings across files
2421 @cindex Multiple files, replacing across
2422 @cindex Files, replacing strings across multiple
2423 @cindex Recursive search/replace operations
2425 Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the
2426 command @code{dired-do-find-regexp-and-replace} (@kbd{Q}), which allows
2427 users to replace regular expressions in multiple files.
2429 You can use this command to perform search/replace operations on
2430 multiple files by following the following steps:
2432 @itemize @bullet
2433 @item
2434 Assemble a list of files you want to operate on with either
2435 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2437 @item
2438 Mark all files in the resulting Dired buffer using @kbd{t}.
2440 @item
2441 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2442 files.
2444 @item
2445 To accept all replacements in each file, hit @kbd{!}.
2446 @end itemize
2448 Another way to do the same thing is to use the ``tags'' feature of
2449 Emacs: it includes the command @code{tags-query-replace} which performs
2450 a query-replace across all the files mentioned in the @file{TAGS} file.
2451 @xref{Identifier Search,,, emacs, The GNU Emacs Manual}.
2453 @node Documentation for etags
2454 @section Where is the documentation for @code{etags}?
2455 @cindex Documentation for @code{etags}
2456 @cindex @code{etags}, documentation for
2458 The @code{etags} man page should be in the same place as the
2459 @code{emacs} man page.
2461 Quick command-line switch descriptions are also available.  For example,
2462 @samp{etags -H}.
2464 @node Disabling backups
2465 @section How do I disable backup files?
2466 @cindex Backups, disabling
2467 @cindex Disabling backups
2469 You probably don't want to do this, since backups are useful, especially
2470 when something goes wrong.
2472 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2473 load @code{dired-x} by adding the following to your @file{.emacs} file:
2475 @lisp
2476 (add-hook 'dired-load-hook
2477           (lambda ()
2478            (require 'dired-x)))
2479 @end lisp
2481 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2482 You can make omitting the default for new dired buffers by putting the
2483 following in your @file{.emacs}:
2485 @lisp
2486 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2487 @end lisp
2489 If you're tired of seeing backup files whenever you do an @samp{ls} at
2490 the Unix shell, try GNU @code{ls} with the @samp{-B} option.  GNU
2491 @code{ls} is part of the GNU Fileutils package, available from
2492 @url{https://ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2494 To disable or change the way backups are made,
2495 @pxref{Backup Names,,, emacs, The GNU Emacs Manual}.
2497 @cindex Backup files in a single directory
2498 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2499 by customizing the variable @code{backup-directory-alist}.  This
2500 variable's value specifies that files whose names match specific patters
2501 should have their backups put in certain directories.  A typical use is
2502 to add the element @code{("." . @var{dir})} to force Emacs to put
2503 @strong{all} backup files in the directory @file{dir}.
2505 @node Disabling auto-save-mode
2506 @section How do I disable @code{auto-save-mode}?
2507 @cindex Disabling @code{auto-save-mode}
2508 @cindex Auto-saving
2509 @cindex Saving at frequent intervals
2511 You probably don't want to do this, since auto-saving is useful,
2512 especially when Emacs or your computer crashes while you are editing a
2513 document.
2515 Instead, you might want to change the variable
2516 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2517 waits before auto-saving.  Increasing this value forces Emacs to wait
2518 longer between auto-saves, which might annoy you less.
2520 You might also want to look into Sebastian Kremer's @code{auto-save}
2521 package (@pxref{Packages that do not come with Emacs}).  This
2522 package also allows you to place all auto-save files in one directory,
2523 such as @file{/tmp}.
2525 To disable or change how @code{auto-save-mode} works,
2526 @pxref{Auto Save,,, emacs, The GNU Emacs Manual}.
2528 @node Going to a line by number
2529 @section How can I go to a certain line given its number?
2530 @cindex Going to a line by number
2531 @cindex Compilation error messages
2532 @cindex Recompilation
2534 Are you sure you indeed need to go to a line by its number?  Perhaps all
2535 you want is to display a line in your source file for which a compiler
2536 printed an error message?  If so, compiling from within Emacs using the
2537 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2538 effective way of doing that.  Emacs automatically intercepts the compile
2539 error messages, inserts them into a special buffer called
2540 @file{*compilation*}, and lets you visit the locus of each message in
2541 the source.  Type @kbd{C-x `} to step through the offending lines one by
2542 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2543 @kbd{M-g M-n} to go to the previous and next matches directly).  Click
2544 @kbd{mouse-2} or press @key{RET} on a message text in the
2545 @file{*compilation*} buffer to go to the line whose number is mentioned
2546 in that message.
2548 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2549 (which is the default binding of the @code{goto-line} function starting
2550 with Emacs 22).  Emacs will prompt you for the number of the line and go
2551 to that line.
2553 You can do this faster by invoking @code{goto-line} with a numeric
2554 argument that is the line's number.  For example, @kbd{C-u 286 M-g M-g}
2555 will jump to line number 286 in the current buffer.
2557 @node Modifying pull-down menus
2558 @section How can I create or modify new pull-down menu options?
2559 @cindex Pull-down menus, creating or modifying
2560 @cindex Menus, creating or modifying
2561 @cindex Creating new menu options
2562 @cindex Modifying pull-down menus
2563 @cindex Menus and keymaps
2564 @cindex Keymaps and menus
2566 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2567 represents a local or global keymap.  Selecting a menu title with the
2568 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2570 So to add a menu option to an existing menu, all you have to do is add a
2571 new definition to the appropriate keymap.  Adding a @samp{Forward Word}
2572 item to the @samp{Edit} menu thus requires the following Lisp code:
2574 @lisp
2575 (define-key global-map
2576   [menu-bar edit forward]
2577   '("Forward word" . forward-word))
2578 @end lisp
2580 @noindent
2581 The first line adds the entry to the global keymap, which includes
2582 global menu bar entries.  Replacing the reference to @code{global-map}
2583 with a local keymap would add this menu option only within a particular
2584 mode.
2586 The second line describes the path from the menu-bar to the new entry.
2587 Placing this menu entry underneath the @samp{File} menu would mean
2588 changing the word @code{edit} in the second line to @code{file}.
2590 The third line is a cons cell whose first element is the title that will
2591 be displayed, and whose second element is the function that will be
2592 called when that menu option is invoked.
2594 To add a new menu, rather than a new option to an existing menu, we must
2595 define an entirely new keymap:
2597 @lisp
2598 (define-key global-map [menu-bar words]
2599   (cons "Words" (make-sparse-keymap "Words")))
2600 @end lisp
2602 The above code creates a new sparse keymap, gives it the name
2603 @samp{Words}, and attaches it to the global menu bar.  Adding the
2604 @samp{Forward Word} item to this new menu would thus require the
2605 following code:
2607 @lisp
2608 (define-key global-map
2609   [menu-bar words forward]
2610   '("Forward word" . forward-word))
2611 @end lisp
2613 @noindent
2614 Note that because of the way keymaps work, menu options are displayed
2615 with the more recently defined items at the top.  Thus if you were to
2616 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2617 order), the menu option @samp{baz} would appear at the top, and
2618 @samp{foo} would be at the bottom.
2620 One way to avoid this problem is to use the function @code{define-key-after},
2621 which works the same as @code{define-key}, but lets you modify where items
2622 appear.  The following Lisp code would insert the @samp{Forward Word}
2623 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2625 @lisp
2626 (define-key-after
2627   (lookup-key global-map [menu-bar edit])
2628   [forward]
2629   '("Forward word" . forward-word)
2630   'undo)
2631 @end lisp
2633 Note how the second and third arguments to @code{define-key-after} are
2634 different from those of @code{define-key}, and that we have added a new
2635 (final) argument, the function after which our new key should be
2636 defined.
2638 To move a menu option from one position to another, simply evaluate
2639 @code{define-key-after} with the appropriate final argument.
2641 More detailed information---and more examples of how to create and
2642 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2643 ``Menu Keymaps.''  (@xref{Emacs Lisp documentation}, for information on
2644 this manual.)
2646 @node Deleting menus and menu options
2647 @section How do I delete menus and menu options?
2648 @cindex Deleting menus and menu options
2649 @cindex Menus, deleting
2651 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2652 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2653 menus}), use:
2655 @lisp
2656 (define-key global-map [menu-bar words] nil)
2657 @end lisp
2659 Similarly, removing a menu option requires redefining a keymap entry to
2660 @code{nil}.  For example, to delete the @samp{Forward word} menu option
2661 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2662 menus}), use:
2664 @lisp
2665 (define-key global-map [menu-bar edit forward] nil)
2666 @end lisp
2668 @node Turning on syntax highlighting
2669 @section How do I turn on syntax highlighting?
2670 @cindex Syntax highlighting
2671 @cindex @code{font-lock-mode}
2672 @cindex Highlighting based on syntax
2673 @cindex Colorizing text
2674 @cindex FAQ, @code{font-lock-mode}
2676 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2677 highlighting in the current buffer.  It is enabled by default in Emacs
2678 22.1 and later.
2680 With @code{font-lock-mode} turned on, different types of text will
2681 appear in different colors.  For instance, in a programming mode,
2682 variables will appear in one face, keywords in a second, and comments in
2683 a third.
2685 To turn @code{font-lock-mode} off within an existing buffer, use
2686 @kbd{M-x font-lock-mode @key{RET}}.
2688 In Emacs 21 and earlier versions, you could use the following code in
2689 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2691 @lisp
2692 (global-font-lock-mode 1)
2693 @end lisp
2695 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2696 and cause an annoying delay in display, so several features exist to
2697 work around this.
2699 @cindex Just-In-Time syntax highlighting
2700 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2701 activates the new @dfn{Just-In-Time fontification} provided by
2702 @code{jit-lock-mode}.  @code{jit-lock-mode} defers the fontification of
2703 portions of buffer until you actually need to see them, and can also
2704 fontify while Emacs is idle.  This makes display of the visible portion
2705 of a buffer almost instantaneous.  For details about customizing
2706 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2708 @cindex Levels of syntax highlighting
2709 @cindex Decoration level, in @code{font-lock-mode}
2710 In versions of Emacs before 21, different levels of decoration are
2711 available, from slight to gaudy.  More decoration means you need to wait
2712 more time for a buffer to be fontified (or a faster machine).  To
2713 control how decorated your buffers should become, set the value of
2714 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2715 @code{nil} value indicating default (usually minimum) decoration, and a
2716 @code{t} value indicating the maximum decoration.  For the gaudiest
2717 possible look, then, include the line
2719 @lisp
2720 (setq font-lock-maximum-decoration t)
2721 @end lisp
2723 @noindent
2724 in your @file{.emacs} file.  You can also set this variable such that
2725 different modes are highlighted in a different ways; for more
2726 information, see the documentation for
2727 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2728 describe-variable @key{RET}}).
2730 Also see the documentation for the function @code{font-lock-mode},
2731 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2732 describe-function @key{RET} font-lock-mode @key{RET}}).
2734 To print buffers with the faces (i.e., colors and fonts) intact, use
2735 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2736 ps-print-region-with-faces}.  You will need a way to send text to a
2737 PostScript printer, or a PostScript interpreter such as Ghostscript;
2738 consult the documentation of the variables @code{ps-printer-name},
2739 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2741 @node Scrolling only one line
2742 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2743 @cindex Scrolling only one line
2744 @cindex Reducing the increment when scrolling
2746 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2747 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2748 to a large value like, say, 10000.  For an explanation of what this
2749 means, @pxref{Auto Scrolling,,, emacs, The GNU Emacs Manual}.
2751 Alternatively, use the following Lisp form in your @file{.emacs}:
2753 @lisp
2754 (setq scroll-conservatively most-positive-fixnum)
2755 @end lisp
2757 @node Editing MS-DOS files
2758 @section How can I edit MS-DOS files using Emacs?
2759 @cindex Editing MS-DOS files
2760 @cindex MS-DOS files, editing
2761 @cindex Microsoft files, editing
2762 @cindex Windows files, editing
2764 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2765 performed transparently.  You can open MS-DOS files on a Unix system,
2766 edit it, and save it without having to worry about the file format.
2768 When editing an MS-DOS style file, the mode line will indicate that it
2769 is a DOS file.  On Unix and GNU/Linux systems, and also on a Macintosh,
2770 the string @samp{(DOS)} will appear near the left edge of the mode line;
2771 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2772 default, a backslash (@samp{\}) will appear in the mode line.
2774 @node Filling paragraphs with a single space
2775 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2776 @cindex One space following periods
2777 @cindex Single space following periods
2778 @cindex Periods, one space following
2780 Add the following line to your @file{.emacs} file:
2782 @lisp
2783 (setq sentence-end-double-space nil)
2784 @end lisp
2786 @node Escape sequences in shell output
2787 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2788 @cindex Escape sequences in @code{ls} output
2789 @cindex @code{ls} in Shell mode
2791 In many systems, @code{ls} is aliased to @samp{ls --color}, which
2792 prints using ANSI color escape sequences.  Emacs version 21.1 and
2793 later includes the @code{ansi-color} package, which lets Shell mode
2794 recognize these escape sequences.  In Emacs 23.2 and later, the
2795 package is enabled by default; in earlier versions you can enable it
2796 by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2797 by adding @code{(add-hook 'shell-mode-hook
2798 'ansi-color-for-comint-mode-on)} to your init file.
2800 @node Fullscreen mode on MS-Windows
2801 @section How can I start Emacs in fullscreen mode on MS-Windows?
2802 @cindex Maximize frame
2803 @cindex Fullscreen mode
2805 Beginning with Emacs 24.4 either run Emacs with the @samp{--maximized}
2806 command-line option or put the following form in your @file{.emacs}
2807 file:
2809 @lisp
2810 (add-hook 'emacs-startup-hook 'toggle-frame-maximized)
2811 @end lisp
2813 With older versions use the function @code{w32-send-sys-command}.  For
2814 example, you can put the following in your @file{.emacs} file:
2816 @lisp
2817 (add-hook 'emacs-startup-hook
2818           (lambda () (w32-send-sys-command ?\xF030)))
2819 @end lisp
2821 To avoid the slightly distracting visual effect of Emacs starting with
2822 its default frame size and then growing to fullscreen, you can add an
2823 @samp{Emacs.Geometry} entry to the Windows registry settings.
2824 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2826 To compute the correct values for width and height, first maximize the
2827 Emacs frame and then evaluate @code{(frame-height)} and
2828 @code{(frame-width)} with @kbd{M-:}.
2830 @c ------------------------------------------------------------
2831 @node Bugs and problems
2832 @chapter Bugs and problems
2833 @cindex Bugs and problems
2835 The Emacs manual lists some common kinds of trouble users could get
2836 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2837 Emacs Manual}, so you might look there if the problem you encounter
2838 isn't described in this chapter.  If you decide you've discovered a bug,
2839 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2840 instructions how to do that.
2842 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2843 known problems with building and using Emacs on specific platforms;
2844 type @kbd{C-h C-p} to read it.
2846 @menu
2847 * Problems with very large files::
2848 * ^M in the shell buffer::
2849 * Problems with Shell Mode::
2850 * Termcap/Terminfo entries for Emacs::
2851 * Errors with init files::
2852 * Emacs ignores X resources::
2853 * Emacs ignores frame parameters::
2854 * Editing files with $ in the name::
2855 * Shell mode loses the current directory::
2856 * Security risks with Emacs::
2857 * Dired claims that no file is on this line::
2858 @end menu
2860 @node Problems with very large files
2861 @section Does Emacs have problems with files larger than 8 megabytes?
2862 @cindex Very large files, opening
2863 @cindex Large files, opening
2864 @cindex Opening very large files
2865 @cindex Maximum file size
2866 @cindex Files, maximum size
2868 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2869 files larger than 8 megabytes.  In versions 19.29 and later, the maximum
2870 buffer size is at least @math{2^{27}-1}, or 134,217,727 bytes, or 132 MBytes.
2871 The maximum buffer size on 32-bit machines increased to 256 MBytes in
2872 Emacs 22, and again to 512 MBytes in Emacs 23.2.
2874 Emacs compiled on a 64-bit machine can handle much larger buffers.
2876 @node ^M in the shell buffer
2877 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2878 @cindex Shell buffer, echoed commands and @samp{^M} in
2879 @cindex Echoed commands in @code{shell-mode}
2881 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2882 make them go away.  If that doesn't work, you have several options:
2884 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2885 file:
2887 @example
2888 if ($?INSIDE_EMACS && $?tcsh)
2889     unset edit
2890     stty -icrnl -onlcr -echo susp ^Z
2891 endif
2892 @end example
2894 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2896 @example
2897 unset edit
2898 stty -icrnl -onlcr -echo susp ^Z
2899 @end example
2901 Alternatively, use @code{csh} in your shell buffers instead of
2902 @code{tcsh}.  One way is:
2904 @lisp
2905 (setq explicit-shell-file-name "/bin/csh")
2906 @end lisp
2908 @noindent
2909 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2910 file:
2912 @example
2913 setenv ESHELL /bin/csh
2914 @end example
2916 @noindent
2917 (You must start Emacs over again with the environment variable properly
2918 set for this to take effect.)
2920 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2921 with the following Lisp form,
2923 @lisp
2924 (setenv "ESHELL" "/bin/csh")
2925 @end lisp
2927 The above solutions try to prevent the shell from producing the
2928 @samp{^M} characters in the first place.  If this is not possible
2929 (e.g., if you use a Windows shell), you can get Emacs to remove these
2930 characters from the buffer by adding this to your @file{.emacs} init
2931 file:
2933 @smalllisp
2934 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2935 @end smalllisp
2937 On a related note: if your shell is echoing your input line in the shell
2938 buffer, you might want to customize the @code{comint-process-echoes}
2939 variable in your shell buffers, or try the following command in your
2940 shell start-up file:
2942 @example
2943 stty -icrnl -onlcr -echo susp ^Z
2944 @end example
2946 @node Problems with Shell Mode
2947 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2949 @cindex Shell Mode, problems
2950 @cindex @code{explicit-shell-file-name}
2951 This might happen because Emacs tries to look for the shell in a wrong
2952 place.  If you know where your shell executable is, set the variable
2953 @code{explicit-shell-file-name} in your @file{.emacs} file to point to
2954 its full file name.
2956 @cindex Antivirus programs, and Shell Mode
2957 Some people have trouble with Shell Mode on MS-Windows because of
2958 intrusive antivirus software; disabling the resident antivirus program
2959 solves the problems in those cases.
2961 @node Termcap/Terminfo entries for Emacs
2962 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2963 @cindex Termcap
2964 @cindex Terminfo
2965 @cindex Emacs entries for termcap/terminfo
2967 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2968 the @samp{TERMCAP} environment variable of subshells.  It may help in
2969 certain situations (e.g., using rlogin from shell buffer) to add an
2970 entry for @samp{emacs} to the system-wide termcap file.  Here is a
2971 correct termcap entry for @samp{emacs}:
2973 @example
2974 emacs:tc=unknown:
2975 @end example
2977 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2978 @code{captoinfo}.  You need to generate
2979 @file{/usr/lib/terminfo/e/emacs}.  It may work to simply copy
2980 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2982 Having a termcap/terminfo entry will not enable the use of full screen
2983 programs in shell buffers.  Use @kbd{M-x term} for that instead.
2985 A workaround to the problem of missing termcap/terminfo entries is to
2986 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2987 in your shell start up file.  @code{csh} users could put this in their
2988 @file{.cshrc} files:
2990 @example
2991 if ("$term" == emacs) set term=dumb
2992 @end example
2994 @node Errors with init files
2995 @section Why does Emacs say @samp{Error in init file}?
2996 @cindex Error in @file{.emacs}
2997 @cindex Error in init file
2998 @cindex Init file, errors in
2999 @cindex @file{.emacs} file, errors in
3000 @cindex Debugging @file{.emacs} file
3002 An error occurred while loading either your @file{.emacs} file or the
3003 system-wide file @file{site-lisp/default.el}.  Emacs 21.1 and later pops the
3004 @file{*Messages*} buffer, and puts there some additional information
3005 about the error, to provide some hints for debugging.
3007 For information on how to debug your @file{.emacs} file, see
3008 @ref{Debugging a customization file}.
3010 It may be the case that you need to load some package first, or use a
3011 hook that will be evaluated after the package is loaded.  A common case
3012 of this is explained in @ref{Terminal setup code works after Emacs has
3013 begun}.
3015 @node Emacs ignores X resources
3016 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
3017 @cindex X resources being ignored
3018 @cindex Ignored X resources
3019 @cindex @file{.Xdefaults}
3021 As of version 19, Emacs searches for X resources in the files specified
3022 by the following environment variables:
3024 @itemize @bullet
3026 @item @code{XFILESEARCHPATH}
3027 @item @code{XUSERFILESEARCHPATH}
3028 @item @code{XAPPLRESDIR}
3030 @end itemize
3032 This emulates the functionality provided by programs written using the
3033 Xt toolkit.
3035 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
3036 of file names separated by colons.  @code{XAPPLRESDIR} should be a list
3037 of directories separated by colons.
3039 Emacs searches for X resources:
3041 @enumerate
3043 @item
3044 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
3046 @item
3047 then in the value of the @samp{XENVIRONMENT} environment variable,
3049 @itemize @minus
3051 @item
3052 or if that is unset, in the file named
3053 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
3054 the name of the machine Emacs is running on),
3056 @end itemize
3058 @item
3059 then in the screen-specific and server-wide resource properties provided
3060 by the server,
3062 @itemize @minus
3064 @item
3065 or if those properties are unset, in the file named @file{~/.Xdefaults}
3066 if it exists,
3068 @end itemize
3070 @item
3071 then in the files listed in @samp{XUSERFILESEARCHPATH},
3073 @itemize @minus
3075 @item
3076 or in files named @file{@var{lang}/Emacs} in directories listed in
3077 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
3078 environment variable), if the @samp{LANG} environment variable is set,
3079 @item
3080 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
3081 @item
3082 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
3083 is set),
3084 @item
3085 or in @file{~/Emacs},
3087 @end itemize
3089 @item
3090 then in the files listed in  @code{XFILESEARCHPATH}.
3092 @end enumerate
3094 @node Emacs ignores frame parameters
3095 @section Why don't my customizations of the frame parameters work?
3096 @cindex Frame parameters
3098 This probably happens because you have set the frame parameters in the
3099 variable @code{initial-frame-alist}.  That variable holds parameters
3100 used only for the first frame created when Emacs starts.  To customize
3101 the parameters of all frames, change the variable
3102 @code{default-frame-alist} instead.
3104 These two variables exist because many users customize the initial frame
3105 in a special way.  For example, you could determine the position and
3106 size of the initial frame, but would like to control the geometry of the
3107 other frames by individually positioning each one of them.
3110 @node Editing files with $ in the name
3111 @section How do I edit a file with a @samp{$} in its name?
3112 @cindex Editing files with @samp{$} in the name
3113 @cindex @samp{$} in file names
3114 @cindex File names containing @samp{$}, editing
3116 When entering a file name in the minibuffer, Emacs will attempt to expand
3117 a @samp{$} followed by a word as an environment variable.  To suppress
3118 this behavior, type @kbd{$$} instead.
3120 @node Shell mode loses the current directory
3121 @section Why does shell mode lose track of the shell's current directory?
3122 @cindex Current directory and @code{shell-mode}
3123 @cindex @code{shell-mode} and current directory
3124 @cindex Directory, current in @code{shell-mode}
3126 Emacs has no way of knowing when the shell actually changes its
3127 directory.  This is an intrinsic limitation of Unix.  So it tries to
3128 guess by recognizing @samp{cd} commands.  If you type @kbd{cd} followed
3129 by directory with a variable reference (@kbd{cd $HOME/bin}) or
3130 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
3131 correctly guess the shell's new current directory.  A huge variety of
3132 fixes and enhancements to shell mode for this problem have been written
3133 to handle this problem (@pxref{Finding a package with particular
3134 functionality}).
3136 You can tell Emacs the shell's current directory with the command
3137 @kbd{M-x dirs}.
3139 @node Security risks with Emacs
3140 @section Are there any security risks in Emacs?
3141 @cindex Security with Emacs
3142 @cindex @samp{movemail} and security
3143 @cindex @code{file-local-variable} and security
3144 @cindex Synthetic X events and security
3145 @cindex X events and security
3147 @itemize @bullet
3149 @item
3150 The @file{movemail} incident.  (No, this is not a risk.)
3152 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3153 chapter 4.  The site at LBL had installed the @file{/etc/movemail}
3154 program setuid root.  (As of version 19, @file{movemail} is in your
3155 architecture-specific directory; type @kbd{C-h v exec-directory
3156 @key{RET}} to see what it is.)  Since @code{movemail} had not been
3157 designed for this situation, a security hole was created and users could
3158 get root privileges.
3160 @code{movemail} has since been changed so that this security hole will
3161 not exist, even if it is installed setuid root.  However,
3162 @code{movemail} no longer needs to be installed setuid root, which
3163 should eliminate this particular risk.
3165 We have heard unverified reports that the 1988 Internet worm took
3166 advantage of this configuration problem.
3168 @item
3169 The @code{file-local-variable} feature.  (Yes, a risk, but easy to
3170 change.)
3172 There is an Emacs feature that allows the setting of local values for
3173 variables when editing a file by including specially formatted text near
3174 the end of the file.  This feature also includes the ability to have
3175 arbitrary Emacs Lisp code evaluated when the file is visited.
3176 Obviously, there is a potential for Trojan horses to exploit this
3177 feature.
3179 As of Emacs 22, Emacs has a list of local variables that are known to
3180 be safe to set.  If a file tries to set any variable outside this
3181 list, it asks the user to confirm whether the variables should be set.
3182 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
3183 code found at the bottom of files by setting the variable
3184 @code{enable-local-eval}.
3186 @xref{File Variables,,, emacs, The GNU Emacs Manual}.
3188 @item
3189 Synthetic X events.  (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3190 better.)
3192 Emacs accepts synthetic X events generated by the @code{SendEvent}
3193 request as though they were regular events.  As a result, if you are
3194 using the trivial host-based authentication, other users who can open X
3195 connections to your X workstation can make your Emacs process do
3196 anything, including run other processes with your privileges.
3198 The only fix for this is to prevent other users from being able to open
3199 X connections.  The standard way to prevent this is to use a real
3200 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}.  If using
3201 the @code{xauth} program has any effect, then you are probably using
3202 @samp{MIT-MAGIC-COOKIE-1}.  Your site may be using a superior
3203 authentication method; ask your system administrator.
3205 If real authentication is not a possibility, you may be satisfied by
3206 just allowing hosts access for brief intervals while you start your X
3207 programs, then removing the access.  This reduces the risk somewhat by
3208 narrowing the time window when hostile users would have access, but
3209 @emph{does not eliminate the risk}.
3211 On most computers running Unix and X, you enable and disable
3212 access using the @code{xhost} command.  To allow all hosts access to
3213 your X server, use
3215 @example
3216 xhost +
3217 @end example
3219 @noindent
3220 at the shell prompt, which (on an HP machine, at least) produces the
3221 following message:
3223 @example
3224 access control disabled, clients can connect from any host
3225 @end example
3227 To deny all hosts access to your X server (except those explicitly
3228 allowed by name), use
3230 @example
3231 xhost -
3232 @end example
3234 On the test HP computer, this command generated the following message:
3236 @example
3237 access control enabled, only authorized clients can connect
3238 @end example
3240 @end itemize
3242 @node Dired claims that no file is on this line
3243 @section Dired says, @samp{no file on this line} when I try to do something.
3244 @cindex Dired does not see a file
3246 Dired uses a regular expression to find the beginning of a file name.
3247 In a long Unix-style directory listing (@samp{ls -l}), the file name
3248 starts after the date.  The regexp has thus been written to look for the
3249 date.  By default, it should understand dates and times regardless of
3250 the language, but if your directory listing has an unusual format, Dired
3251 may get confused.
3253 There are two approaches to solving this.  The first one involves
3254 setting things up so that @samp{ls -l} outputs a more standard format.
3255 See your OS manual for more information.
3257 The second approach involves changing the regular expression used by
3258 dired, @code{directory-listing-before-filename-regexp}.
3260 @c ------------------------------------------------------------
3261 @node Compiling and installing Emacs
3262 @chapter    Compiling and installing Emacs
3263 @cindex    Compiling and installing Emacs
3265 @menu
3266 * Installing Emacs::
3267 * Problems building Emacs::
3268 @end menu
3270 @node Installing Emacs
3271 @section How do I install Emacs?
3272 @cindex Installing Emacs
3273 @cindex Unix systems, installing Emacs on
3274 @cindex Downloading and installing Emacs
3275 @cindex Building Emacs from source
3276 @cindex Source code, building Emacs from
3278 This answer is meant for users of Unix and Unix-like systems.  Users of
3279 other operating systems should see the series of questions beginning
3280 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3281 and binaries, and how to install Emacs on those systems.
3283 Most GNU/Linux distributions provide pre-built Emacs packages.
3284 If Emacs is not installed already, you can install it by running (as
3285 root) a command such as @samp{yum install emacs} (Red Hat and
3286 derivatives) or @samp{apt-get install emacs} (Debian and derivatives).
3288 If you want to compile Emacs yourself, read the file @file{INSTALL} in
3289 the source distribution.  In brief:
3291 @itemize @bullet
3293 @item
3294 First download the Emacs sources.  @xref{Current GNU distributions}, for
3295 a list of sites that make them available.  On @url{https://ftp.gnu.org},
3296 the main GNU distribution site, sources are available as
3298 @c Don't include VER in the file name, because pretests are not there.
3299 @uref{https://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
3301 (Replace @samp{VERSION} with the relevant version number, e.g., @samp{23.1}.)
3303 @item
3304 Next uncompress and extract the source files.  This requires
3305 the @code{gzip} and @code{tar} programs, which are standard utilities.
3306 If your system does not have them, these can also be downloaded from
3307 @url{https://ftp.gnu.org}.
3309 GNU @code{tar} can uncompress and extract in a single-step:
3311 @example
3312 tar -zxvf emacs-VERSION.tar.gz
3313 @end example
3315 @item
3316 At this point, the Emacs sources should be sitting in a directory called
3317 @file{emacs-VERSION}.  On most common Unix and Unix-like systems,
3318 you should be able to compile Emacs with the following commands:
3320 @example
3321 cd emacs-VERSION
3322 ./configure         # configure Emacs for your particular system
3323 make                # use Makefile to build components, then Emacs
3324 @end example
3326 If the @code{make} completes successfully, the odds are fairly good that
3327 the build has gone well.  (@xref{Problems building Emacs}, if you weren't
3328 successful.)
3330 @item
3331 By default, Emacs is installed in @file{/usr/local}.  To actually
3332 install files, become the superuser and type
3334 @example
3335 make install
3336 @end example
3338 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3339 and any Emacs Info files that might be in @file{/usr/local/share/info/}.
3341 @end itemize
3343 @node Problems building Emacs
3344 @section What should I do if I have trouble building Emacs?
3345 @cindex Problems building Emacs
3346 @cindex Errors when building Emacs
3348 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3349 source) to see if there is already a solution for your problem.  Next,
3350 look for other questions in this FAQ that have to do with Emacs
3351 installation and compilation problems.
3353 If you'd like to have someone look at your problem and help solve it,
3354 see @ref{Help installing Emacs}.
3356 If you cannot find a solution in the documentation, please report the
3357 problem (@pxref{Reporting bugs}).
3360 @c ------------------------------------------------------------
3361 @node Finding Emacs and related packages
3362 @chapter Finding Emacs and related packages
3363 @cindex Finding Emacs and related packages
3365 @menu
3366 * Finding Emacs on the Internet::
3367 * Finding a package with particular functionality::
3368 * Packages that do not come with Emacs::
3369 * Spell-checkers::
3370 * Current GNU distributions::
3371 * Difference between Emacs and XEmacs::
3372 * Emacs for minimalists::
3373 * Emacs for MS-DOS::
3374 * Emacs for MS-Windows::
3375 * Emacs for GNUstep::
3376 * Emacs for macOS::
3377 @end menu
3379 @node Finding Emacs on the Internet
3380 @section Where can I get Emacs on the net?
3381 @cindex Finding Emacs on the Internet
3382 @cindex Downloading Emacs
3384 Information on downloading Emacs is available at
3385 @uref{https://www.gnu.org/software/emacs/, the Emacs home-page}.
3387 @xref{Installing Emacs}, for information on how to obtain and build the latest
3388 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3389 archive sites that make GNU software available.
3391 @node Finding a package with particular functionality
3392 @section How do I find a Emacs Lisp package that does XXX?
3393 @cindex Package, finding
3394 @cindex Finding an Emacs Lisp package
3395 @cindex Functionality, finding a particular package
3397 First of all, you should check to make sure that the package isn't
3398 already available.  For example, typing @kbd{M-x apropos @key{RET}
3399 python @key{RET}} lists all functions and variables containing the
3400 string @samp{python}.
3402 It is also possible that the package is on your system, but has not been
3403 loaded.  To see which packages are available for loading, look through
3404 your computer's lisp directory (@pxref{File-name conventions}).  The Lisp
3405 source to most packages contains a short description of how they
3406 should be loaded, invoked, and configured---so before you use or
3407 modify a Lisp package, see if the author has provided any hints in the
3408 source code.
3410 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3411 the constituent Emacs packages.
3413 For advice on how to find extra packages that are not part of Emacs,
3414 see @ref{Packages that do not come with Emacs}.
3416 @c Note that M-x view-external-packages references this node.
3417 @node Packages that do not come with Emacs
3418 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3419 @cindex Unbundled packages
3420 @cindex Finding other packages
3421 @cindex Lisp packages that do not come with Emacs
3422 @cindex Packages, those that do not come with Emacs
3423 @cindex Emacs Lisp List
3424 @cindex Emacs Lisp Archive
3426 The easiest way to add more features to your Emacs is to use the
3427 command @kbd{M-x list-packages}.  This contacts the
3428 @uref{https:///elpa.gnu.org, GNU ELPA} (``Emacs Lisp Package Archive'')
3429 server and fetches the list of additional packages that it offers.
3430 These are GNU packages that are available for use with Emacs, but are
3431 distributed separately from Emacs itself, for reasons of space, etc.
3432 You can browse the resulting @file{*Packages*} buffer to see what is
3433 available, and then Emacs can automatically download and install the
3434 packages that you select.  @xref{Packages,,, emacs, The GNU Emacs Manual}.
3436 There are other, non-GNU, Emacs Lisp package servers, including:
3437 @uref{http://melpa.org/, MELPA}; and
3438 @uref{https://marmalade-repo.org/, Marmalade}.  To use additional
3439 package servers, customize the @code{package-archives} variable.  Be
3440 aware that installing a package can run arbitrary code, so only add
3441 sources that you trust.
3443 The @uref{https://lists.gnu.org/mailman/listinfo/gnu-emacs-sources,
3444 GNU Emacs sources mailing list}, which is gatewayed to the
3445 @uref{news:gnu.emacs.sources, Emacs sources newsgroup} (although the
3446 connection between the two can be unreliable) is an official place
3447 where people can post or announce their extensions to Emacs.
3449 The @uref{http://emacswiki.org, Emacs Wiki} contains pointers to some
3450 additional extensions.  @uref{http://wikemacs.org, WikEmacs} is an
3451 alternative wiki for Emacs.
3453 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs
3454 Lisp List (ELL)}, has pointers to many Emacs Lisp files, but at time
3455 of writing it is no longer being updated.
3457 It is impossible for us to list here all the sites that offer Emacs
3458 Lisp packages.  If you are interested in a specific feature, then
3459 after checking Emacs itself and GNU ELPA, a web search is often the
3460 best way to find results.
3462 @node Spell-checkers
3463 @section Spell-checkers
3464 @cindex Spell-checker
3465 @cindex Checking spelling
3466 @cindex Hunspell
3467 @cindex Aspell
3468 @cindex Ispell
3469 @cindex Enchant
3471 Various spell-checkers are compatible with Emacs, including:
3473 @table @b
3475 @item Hunspell
3476 @uref{http://hunspell.sourceforge.net/}
3478 @item GNU Aspell
3479 @uref{http://aspell.net/}
3481 @item Ispell
3482 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3484 @item Enchant
3485 @uref{https://abiword.github.io/enchant/}
3487 @end table
3489 @node Current GNU distributions
3490 @section Where can I get other up-to-date GNU stuff?
3491 @cindex Current GNU distributions
3492 @cindex Sources for current GNU distributions
3493 @cindex Stuff, current GNU
3494 @cindex Up-to-date GNU stuff
3495 @cindex Finding current GNU software
3496 @cindex Official GNU software sites
3498 The most up-to-date official GNU software is normally kept at
3500 @uref{https://ftp.gnu.org/pub/gnu}
3502 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3504 @uref{https://www.gnu.org/prep/ftp}
3506 @node Difference between Emacs and XEmacs
3507 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3508 @cindex XEmacs
3509 @cindex Difference Emacs and XEmacs
3510 @cindex Lucid Emacs
3511 @cindex Epoch
3513 XEmacs is a branch version of Emacs.  It was first called Lucid Emacs,
3514 and was initially derived from a prerelease version of Emacs 19.  In
3515 this FAQ, we use the name ``Emacs'' only for the official version.
3517 Emacs and XEmacs each come with Lisp packages that are lacking in the
3518 other.  The two versions have some significant differences at the Lisp
3519 programming level.  Their current features are roughly comparable,
3520 though the support for some operating systems, character sets and
3521 specific packages might be quite different.
3523 Some XEmacs code has been contributed to Emacs, and we would like to
3524 use other parts, but the earlier XEmacs maintainers did not always
3525 keep track of the authors of contributed code, which makes it
3526 impossible for the FSF to get copyright papers signed for that code.
3527 (The FSF requires these papers for all the code included in the Emacs
3528 release, aside from generic C support packages that retain their
3529 separate identity and are not integrated into the code of Emacs
3530 proper.)
3532 If you want to talk about these two versions and distinguish them,
3533 please call them ``Emacs'' and ``XEmacs.''  To contrast ``XEmacs''
3534 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3535 origin in the work of the GNU Project.  Terms such as ``Emacsen'' and
3536 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3537 is better to write ``Emacs and XEmacs.''
3539 @node Emacs for minimalists
3540 @section I don't have enough disk space to install Emacs
3541 @cindex Zile
3542 @cindex Not enough disk space to install Emacs
3544 GNU Zile is a lightweight Emacs clone.  Zile is short for @samp{Zile Is
3545 Lossy Emacs}.  It has all of Emacs's basic editing features.  The Zile
3546 binary typically has a size of about 130 kbytes, so this can be useful
3547 if you are in an extremely space-restricted environment.  More
3548 information is available from
3550 @uref{https://www.gnu.org/software/zile/}
3553 @node Emacs for MS-DOS
3554 @section Where can I get Emacs for MS-DOS?
3555 @cindex MS-DOS, Emacs for
3556 @cindex DOS, Emacs for
3557 @cindex Compiling Emacs for DOS
3558 @cindex Emacs for MS-DOS
3560 To build Emacs from source for MS-DOS, see the instructions in the file
3561 @file{msdos/INSTALL} in the distribution.  The DOS port builds and runs
3562 on plain DOS, and also on all versions of MS-Windows from version 3.X
3563 onwards, including Windows XP and Vista.
3565 The file @file{etc/PROBLEMS} contains some additional information
3566 regarding Emacs under MS-DOS.
3568 A pre-built binary distribution of the old Emacs 24 is available, as
3569 described at
3571 @uref{http://www.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3573 For a list of other MS-DOS implementations of Emacs (and Emacs
3574 look-alikes), consult the list of ``Emacs implementations and literature,''
3575 available at
3577 @uref{http://www.finseth.com/emacs.html}
3579 Note that while many of these programs look similar to Emacs, they often
3580 lack certain features, such as the Emacs Lisp extension language.
3582 @node Emacs for MS-Windows
3583 @section Where can I get Emacs for Microsoft Windows?
3584 @cindex FAQ for Emacs on MS-Windows
3585 @cindex Emacs for MS-Windows
3586 @cindex Microsoft Windows, Emacs for
3588 There is a separate FAQ for Emacs on MS-Windows,
3589 @pxref{Top,,,efaq-w32,FAQ for Emacs on MS Windows}.
3590 For MS-DOS, @pxref{Emacs for MS-DOS}.
3593 @node Emacs for GNUstep
3594 @section Where can I get Emacs for GNUstep?
3595 @cindex GNUstep, Emacs for
3597 Beginning with version 23.1, Emacs supports GNUstep natively.
3598 See the file @file{nextstep/INSTALL} in the distribution.
3600 @node Emacs for macOS
3601 @section Where can I get Emacs for macOS?
3602 @cindex Apple computers, Emacs for
3603 @cindex Macintosh, Emacs for
3604 @cindex macOS, Emacs for
3606 Beginning with version 22.1, Emacs supports macOS natively.
3607 See the file @file{nextstep/INSTALL} in the distribution.
3609 @c ------------------------------------------------------------
3610 @node Key bindings
3611 @chapter Key bindings
3612 @cindex Key bindings
3614 @menu
3615 * Binding keys to commands::
3616 * Invalid prefix characters::
3617 * Terminal setup code works after Emacs has begun::
3618 * Working with function and arrow keys::
3619 * X key translations for Emacs::
3620 * Backspace invokes help::
3621 * Swapping keys::
3622 * Producing C-XXX with the keyboard::
3623 * No Meta key::
3624 * No Escape key::
3625 * Compose Character::
3626 * Binding combinations of modifiers and function keys::
3627 * Meta key does not work in xterm::
3628 * ExtendChar key does not work as Meta::
3629 * SPC no longer completes file names::
3630 @end menu
3632 @node Binding keys to commands
3633 @section How do I bind keys (including function keys) to commands?
3634 @cindex Binding keys to commands
3635 @cindex Keys, binding to commands
3636 @cindex Commands, binding keys to
3638 Keys can be bound to commands either interactively or in your
3639 @file{.emacs} file.  To interactively bind keys for all modes, type
3640 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3642 To bind a key just in the current major mode, type @kbd{M-x
3643 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3645 @xref{Key Bindings,,, emacs, The GNU Emacs Manual}.
3647 To make the process of binding keys interactively easier, use the
3648 following ``trick'': First bind the key interactively, then immediately
3649 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}.  Now, the command needed
3650 to bind the key is in the kill ring, and can be yanked into your
3651 @file{.emacs} file.  If the key binding is global, no changes to the
3652 command are required.  For example,
3654 @lisp
3655 (global-set-key (quote [f1]) (quote help-for-help))
3656 @end lisp
3658 @noindent
3659 can be placed directly into the @file{.emacs} file.  If the key binding is
3660 local, the command is used in conjunction with the @samp{add-hook} function.
3661 For example, in TeX mode, a local binding might be
3663 @lisp
3664 (add-hook 'tex-mode-hook
3665   (lambda ()
3666    (local-set-key (quote [f1]) (quote help-for-help))))
3667 @end lisp
3670 @itemize @bullet
3672 @item
3673 Control characters in key sequences, in the form yanked from the kill
3674 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3675 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc.  You may want
3676 to convert these into their vector or string forms.
3678 @item
3679 If a prefix key of the character sequence to be bound is already
3680 bound as a complete key, then you must unbind it before the new
3681 binding.  For example, if @kbd{ESC @{} is previously bound:
3683 @lisp
3684 (global-unset-key [?\e ?@{])   ;;   or
3685 (local-unset-key [?\e ?@{])
3686 @end lisp
3688 @item
3689 Aside from commands and ``lambda lists,'' a vector or string also
3690 can be bound to a key and thus treated as a macro.  For example:
3692 @lisp
3693 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g])  ;;  or
3694 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3695 @end lisp
3697 @end itemize
3699 @node Invalid prefix characters
3700 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3701 @cindex Prefix characters, invalid
3702 @cindex Invalid prefix characters
3703 @cindex Misspecified key sequences
3705 Usually, one of two things has happened.  In one case, the control
3706 character in the key sequence has been misspecified (e.g., @samp{C-f}
3707 used instead of @samp{\C-f} within a Lisp expression).  In the other
3708 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3709 was already bound as a @dfn{complete key}.  Historically, the @samp{ESC [}
3710 prefix was usually the problem, in which case you should evaluate either
3711 of these forms before attempting to bind the key sequence:
3713 @lisp
3714 (global-unset-key [?\e ?[])  ;;  or
3715 (global-unset-key "\e[")
3716 @end lisp
3718 @node Terminal setup code works after Emacs has begun
3719 @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?
3720 @cindex Terminal setup code in @file{.emacs}
3722 During startup, Emacs initializes itself according to a given code/file
3723 order.  If some of the code executed in your @file{.emacs} file needs to
3724 be postponed until the initial terminal or window-system setup code has
3725 been executed but is not, then you will experience this problem (this
3726 code/file execution order is not enforced after startup).
3728 To postpone the execution of Emacs Lisp code until after terminal or
3729 window-system setup, treat the code as a @dfn{lambda list} and add it to
3730 @code{emacs-startup-hook} (or @code{tty-setup-hook} in Emacs 24.4 and
3731 newer).  For example,
3733 @lisp
3734 (add-hook 'emacs-startup-hook
3735           (lambda ()
3736            (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3737              ;; Make vt220's "Do" key behave like M-x:
3738              (global-set-key [do] 'execute-extended-command))))
3739 @end lisp
3741 For information on what Emacs does every time it is started, see the
3742 @file{lisp/startup.el} file.
3744 @node Working with function and arrow keys
3745 @section How do I tell what characters or symbols my function or arrow keys emit?
3746 @cindex Working with arrow keys
3747 @cindex Arrow keys, symbols generated by
3748 @cindex Working with function keys
3749 @cindex Function keys, symbols generated by
3750 @cindex Symbols generated by function keys
3752 Type @kbd{C-h c} then the function or arrow keys.  The command will
3753 return either a function key symbol or character sequence (see the
3754 Emacs documentation for an explanation).  This works for other
3755 keys as well.
3757 @node X key translations for Emacs
3758 @section How do I set the X key ``translations'' for Emacs?
3759 @cindex X key translations
3760 @cindex Key translations under X
3761 @cindex Translations for keys under X
3763 Emacs is not written using the Xt library by default, so there are no
3764 ``translations'' to be set.  (We aren't sure how to set such translations
3765 if you do build Emacs with Xt; please let us know if you've done this!)
3767 The only way to affect the behavior of keys within Emacs is through
3768 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs).  The
3769 @code{define-key} command should be used in conjunction with the
3770 @code{function-key-map} map.  For instance,
3772 @lisp
3773 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3774 @end lisp
3776 @noindent
3777 defines the @kbd{M-@key{TAB}} key sequence.
3779 @node Backspace invokes help
3780 @section Why does the @key{Backspace} key invoke help?
3781 @cindex Backspace key invokes help
3782 @cindex Help invoked by Backspace
3783 @cindex DEL key does not delete
3785 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
3786 @kbd{C-h} sends the same code.  In Emacs by default @kbd{C-h} invokes
3787 help-command.  This is intended to be easy to remember since the first
3788 letter of @samp{help} is @samp{h}.  The easiest solution to this problem
3789 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
3790 @key{Delete} key) for deleting the previous character.
3792 For many people this solution may be problematic:
3794 @itemize @bullet
3796 @item
3797 They normally use @key{Backspace} outside of Emacs for deleting the
3798 previous character.  This can be solved by making @key{DEL} the command
3799 for deleting the previous character outside of Emacs.  On many Unix
3800 systems, this command will remap @key{DEL}:
3802 @example
3803 stty erase '^?'
3804 @end example
3806 @item
3807 The user may prefer the @key{Backspace} key for deleting the
3808 previous character because it is more conveniently located on their
3809 keyboard or because they don't even have a separate @key{Delete} key.
3810 In this case, the @key{Backspace} key should be made to behave like
3811 @key{Delete}.  There are several methods.
3813 @itemize @minus
3814 @item
3815 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
3816 TeraTerm) allow the character generated by the @key{Backspace} key to be
3817 changed from a setup menu.
3819 @item
3820 You may be able to get a keyboard that is completely programmable, or a
3821 terminal emulator that supports remapping of any key to any other key.
3823 @item
3824 With Emacs 21.1 and later, you can control the effect of the
3825 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
3826 windowed displays, by customizing the option
3827 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
3828 normal-erase-is-backspace}.  See the documentation of these symbols
3829 (@pxref{Emacs Lisp documentation}) for more info.
3831 @item
3832 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
3833 Emacs:
3835 @lisp
3836 (keyboard-translate ?\C-h ?\C-?)
3837 @end lisp
3839 @noindent
3840 This is the recommended method of forcing @key{Backspace} to act as
3841 @key{DEL}, because it works even in modes which bind @key{DEL} to
3842 something other than @code{delete-backward-char}.
3844 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
3845 default deletes forward:
3847 @lisp
3848 (keyboard-translate ?\C-? ?\C-d)
3849 @end lisp
3851 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
3853 @item
3854 Another approach is to switch key bindings and put help on @kbd{C-x h}
3855 instead:
3857 @lisp
3858 (global-set-key "\C-h" 'delete-backward-char)
3860 ;; overrides mark-whole-buffer
3861 (global-set-key "\C-xh" 'help-command)
3862 @end lisp
3864 @noindent
3865 This method is not recommended, though: it only solves the problem for
3866 those modes which bind @key{DEL} to @code{delete-backward-char}.  Modes
3867 which bind @key{DEL} to something else, such as @code{view-mode}, will
3868 not work as you expect when you press the @key{Backspace} key.  For this
3869 reason, we recommend the @code{keyboard-translate} method, shown
3870 above.
3872 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
3873 @end itemize
3875 Don't try to bind @key{DEL} to @code{help-command}, because there are
3876 many modes that have local bindings of @key{DEL} that will interfere.
3878 @end itemize
3880 When Emacs 21 or later runs on a windowed display, it binds the
3881 @key{Delete} key to a command which deletes the character at point, to
3882 make Emacs more consistent with keyboard operation on these systems.
3884 For more information about troubleshooting this problem, see @ref{DEL
3885 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
3886 Manual}.
3888 @node Swapping keys
3889 @section How do I swap two keys?
3890 @cindex Swapping keys
3891 @cindex Keys, swapping
3892 @cindex @code{keyboard-translate}
3894 You can swap two keys (or key sequences) by using the
3895 @code{keyboard-translate} function.  For example, to turn @kbd{C-h}
3896 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
3898 @lisp
3899 (keyboard-translate ?\C-h ?\C-?)  ; translate 'C-h' to DEL
3900 (keyboard-translate ?\C-? ?\C-h)  ; translate DEL to 'C-h'.
3901 @end lisp
3903 @noindent
3904 The first key sequence of the pair after the function identifies what is
3905 produced by the keyboard; the second, what is matched for in the
3906 keymaps.
3908 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
3909 toggle @code{normal-erase-is-backspace-mode} instead of calling
3910 @code{keyboard-translate}.
3911 @xref{DEL Does Not Delete,,, emacs, The GNU Emacs Manual}.
3913 Keyboard translations are not the same as key bindings in keymaps.
3914 Emacs contains numerous keymaps that apply in different situations, but
3915 there is only one set of keyboard translations, and it applies to every
3916 character that Emacs reads from the terminal.  Keyboard translations
3917 take place at the lowest level of input processing; the keys that are
3918 looked up in keymaps contain the characters that result from keyboard
3919 translation.
3921 @node Producing C-XXX with the keyboard
3922 @section How do I produce C-XXX with my keyboard?
3923 @cindex Producing control characters
3924 @cindex Generating control characters
3925 @cindex Control characters, generating
3927 On terminals (but not under X), some common ``aliases'' are:
3929 @table @asis
3931 @item @kbd{C-2}  or  @kbd{C-@key{SPC}}
3932 @kbd{C-@@}
3934 @item @kbd{C-6}
3935 @kbd{C-^}
3937 @item @kbd{C-7}  or  @kbd{C-S--}
3938 @kbd{C-_}
3940 @item @kbd{C-4}
3941 @kbd{C-\}
3943 @item @kbd{C-5}
3944 @kbd{C-]}
3946 @item @kbd{C-/}
3947 @kbd{C-?}
3949 @end table
3951 Often other aliases exist; use the @kbd{C-h c} command and try
3952 @key{CTRL} with all of the digits on your keyboard to see what gets
3953 generated.  You can also try the @kbd{C-h w} command if you know the
3954 name of the command.
3956 @node No Meta key
3957 @section What if I don't have a @key{Meta} key?
3958 @cindex No @key{Meta} key
3959 @cindex @key{Meta} key, what to do if you lack it
3961 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
3963 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}.  In fact,
3964 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
3965 (depending on the value of @code{meta-prefix-char}).  Note that you
3966 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
3967 @key{ESC}, release it, and then press @key{a}.
3969 @node No Escape key
3970 @section What if I don't have an @key{Escape} key?
3971 @cindex No Escape key
3972 @cindex Lacking an Escape key
3973 @cindex Escape key, lacking
3975 Type @kbd{C-[} instead.  This should send @acronym{ASCII} code 27 just like an
3976 Escape key would.  @kbd{C-3} may also work on some terminal (but not
3977 under X).  For many terminals (notably DEC terminals) @key{F11}
3978 generates @key{ESC}.  If not, the following form can be used to bind it:
3980 @lisp
3981 ;; F11 is the documented ESC replacement on DEC terminals.
3982 (define-key function-key-map [f11] [?\e])
3983 @end lisp
3985 @node Compose Character
3986 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
3987 @cindex @key{Compose Character} key, using as @key{Meta}
3988 @cindex @key{Meta}, using @key{Compose Character} for
3990 On a dumb terminal such as a VT220, no.  It is rumored that certain
3991 VT220 clones could have their @key{Compose} key configured this way.  If
3992 you're using X, you might be able to do this with the @code{xmodmap}
3993 command.
3995 @node Binding combinations of modifiers and function keys
3996 @section How do I bind a combination of modifier key and function key?
3997 @cindex Modifiers and function keys
3998 @cindex Function keys and modifiers
3999 @cindex Binding modifiers and function keys
4001 You can represent modified function keys in vector format by adding
4002 prefixes to the function key symbol.  For example (from the Emacs
4003 documentation):
4005 @lisp
4006 (global-set-key [?\C-x right] 'forward-page)
4007 @end lisp
4009 @noindent
4010 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
4012 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
4013 @key{Super}, @key{Alt}, and @key{Shift} with function keys.  To
4014 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
4015 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name.  Here
4016 is how to make @kbd{H-M-RIGHT} move forward a word:
4018 @lisp
4019 (global-set-key [H-M-right] 'forward-word)
4020 @end lisp
4022 @itemize @bullet
4024 @item
4025 Not all modifiers are permitted in all situations.  @key{Hyper},
4026 @key{Super}, and @key{Alt} are not available on Unix character
4027 terminals.  Non-@acronym{ASCII} keys and mouse events (e.g., @kbd{C-=} and
4028 @kbd{mouse-1}) also fall under this category.
4030 @end itemize
4032 @xref{Binding keys to commands}, for general key binding instructions.
4034 @node Meta key does not work in xterm
4035 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
4036 @cindex @key{Meta} key and @code{xterm}
4037 @cindex Xterm and @key{Meta} key
4039 @xref{Unibyte Mode,, Single-Byte Character Set Support, emacs, The GNU Emacs Manual}.
4041 If the advice in the Emacs manual fails, try all of these methods before
4042 asking for further help:
4044 @itemize @bullet
4046 @item
4047 You may have big problems using @code{mwm} as your window manager.
4048 (Does anyone know a good generic solution to allow the use of the
4049 @key{Meta} key in Emacs with @file{mwm}?)
4051 @item
4052 For X11: Make sure it really is a @key{Meta} key.  Use @code{xev} to
4053 find out what keysym your @key{Meta} key generates.  It should be either
4054 @code{Meta_L} or @code{Meta_R}.  If it isn't, use @file{xmodmap} to fix
4055 the situation.  If @key{Meta} does generate @code{Meta_L} or
4056 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
4057 your @file{~/.Xdefaults} file:
4059 @example
4060  XTerm*eightBitInput:   false
4061  XTerm*eightBitOutput:  true
4062 @end example
4064 @item
4065 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
4066 characters.  @samp{stty -a} (or @samp{stty everything}) should show
4067 @samp{cs8} somewhere.  If it shows @samp{cs7} instead, use @samp{stty
4068 cs8 -istrip} (or @samp{stty pass8}) to fix it.
4070 @item
4071 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
4072 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
4073 of every character.
4075 @item
4076 If Emacs is running on Ultrix, it is reported that evaluating
4077 @code{(set-input-mode t nil)} helps.
4079 @item
4080 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
4081 you type @kbd{M-W}, which is the same conversion Emacs would make if it
4082 got the @kbd{M-W} anyway.  In X11R4, the following resource
4083 specification will do this:
4085 @example
4086 XTerm.VT100.EightBitInput: false
4087 @end example
4089 @noindent
4090 (This changes the behavior of the @code{insert-eight-bit} action.)
4092 With older @code{xterm}s, you can specify this behavior with a translation:
4094 @example
4095 XTerm.VT100.Translations: #override \
4096   Meta<KeyPress>: string(0x1b) insert()
4097 @end example
4099 @noindent
4100 You might have to replace @samp{Meta} with @samp{Alt}.
4102 @end itemize
4104 @node ExtendChar key does not work as Meta
4105 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
4106 @cindex @key{ExtendChar} key as @key{Meta}
4107 @cindex @key{Meta}, using @key{ExtendChar} for
4108 @cindex HP-UX, the @key{ExtendChar} key
4110 This is a result of an internationalization extension in X11R4 and the
4111 fact that HP is now using this extension.  Emacs assumes that the
4112 @code{XLookupString} function returns the same result regardless of the
4113 @key{Meta} key state which is no longer necessarily true.  Until Emacs
4114 is fixed, the temporary kludge is to run this command after each time
4115 the X server is started but preferably before any xterm clients are:
4117 @example
4118 xmodmap -e 'remove mod1 = Mode_switch'
4119 @end example
4121 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
4122 @c solved?
4124 This will disable the use of the extra keysyms systemwide, which may be
4125 undesirable if you actually intend to use them.
4127 @node SPC no longer completes file names
4128 @section Why doesn't SPC complete file names anymore?
4129 @cindex @kbd{SPC} file name completion
4131 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
4132 the minibuffer, so that file names with embedded spaces could be typed
4133 without the need to quote the spaces.
4135 You can get the old behavior by binding @kbd{SPC} to
4136 @code{minibuffer-complete-word} in the minibuffer, as follows:
4138 @lisp
4139 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
4140   'minibuffer-complete-word)
4142 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4143   'minibuffer-complete-word)
4144 @end lisp
4146 @c ------------------------------------------------------------
4147 @node Alternate character sets
4148 @chapter Alternate character sets
4149 @cindex Alternate character sets
4151 @menu
4152 * Emacs does not display 8-bit characters::
4153 * Inputting eight-bit characters::
4154 * Right-to-left alphabets::
4155 * How to add fonts::
4156 @end menu
4158 @node Emacs does not display 8-bit characters
4159 @section How do I make Emacs display 8-bit characters?
4160 @cindex Displaying eight-bit characters
4161 @cindex Eight-bit characters, displaying
4163 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4164 Emacs Manual}.  On a Unix, when Emacs runs on a text-only terminal
4165 display or is invoked with @samp{emacs -nw}, you typically need to use
4166 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4167 display, even after setting the language environment; otherwise
4168 non-@acronym{ASCII} characters will display as @samp{?}.  On other operating
4169 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4170 character set supported by the display, and sets up the required
4171 terminal coding system automatically.
4173 @node Inputting eight-bit characters
4174 @section How do I input eight-bit characters?
4175 @cindex Entering eight-bit characters
4176 @cindex Eight-bit characters, entering
4177 @cindex Input, 8-bit characters
4179 Various methods are available for input of eight-bit characters.
4180 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4181 Emacs Manual}.  For more sophisticated methods,
4182 @pxref{Input Methods,,, emacs, The GNU Emacs Manual}.
4184 @node Right-to-left alphabets
4185 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4186 @cindex Right-to-left alphabets
4187 @cindex Hebrew, handling with Emacs
4188 @cindex Semitic alphabets
4189 @cindex Arabic
4190 @cindex Farsi
4191 @cindex bidirectional scripts
4193 Emacs supports display and editing of bidirectional scripts, such as
4194 Arabic, Farsi, and Hebrew, since version 24.1.
4195 @xref{New in Emacs 24, bidirectional display}.
4198 @node How to add fonts
4199 @section How do I add fonts for use with Emacs?
4200 @cindex add fonts for use with Emacs
4201 @cindex intlfonts
4203 First, download and install the BDF font files and any auxiliary
4204 packages they need.  The GNU Intlfonts distribution can be found on
4205 @uref{https://directory.fsf.org/localization/intlfonts.html, the GNU
4206 Software Directory Web site}.
4208 Next, if you are on X Window system, issue the following two commands
4209 from the shell's prompt:
4211 @example
4212   xset +fp /usr/local/share/emacs/fonts
4213   xset fp rehash
4214 @end example
4216 @noindent
4217 (Modify the first command if you installed the fonts in a directory
4218 that is not @file{/usr/local/share/emacs/fonts}.)  You also need to
4219 arrange for these two commands to run whenever you log in, e.g., by
4220 adding them to your window-system startup file, such as
4221 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4223 Now, add the following line to your @file{~/.emacs} init file:
4225 @lisp
4226   (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4227 @end lisp
4229 @noindent
4230 (Again, modify the file name if you installed the fonts elsewhere.)
4232 Finally, if you wish to use the installed fonts with @code{ps-print},
4233 add the following line to your @file{~/.emacs}:
4235 @lisp
4236   (setq ps-multibyte-buffer 'bdf-font-except-latin)
4237 @end lisp
4239 A few additional steps are necessary for MS-Windows; they are listed
4240 below.
4242 First, make sure @emph{all} the directories with BDF font files are
4243 mentioned in @code{bdf-directory-list}.  On Unix and GNU/Linux
4244 systems, one normally runs @kbd{make install} to install the BDF fonts
4245 in the same directory.  By contrast, Windows users typically don't run
4246 the Intlfonts installation command, but unpack the distribution in
4247 some directory, which leaves the BDF fonts in its subdirectories.  For
4248 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4249 then you should set @code{bdf-directory-list} as follows:
4251 @lisp
4252   (setq bdf-directory-list
4253     '("C:/Intlfonts/Asian"
4254       "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4255       "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4256       "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4257       "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4258       "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4259       "C:/Intlfonts/Misc"))
4260 @end lisp
4262 @cindex @code{w32-bdf-filename-alist}
4263 @cindex @code{w32-find-bdf-fonts}
4264 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4265 an alist of the BDF fonts and their corresponding file names.
4266 Assuming you have set @code{bdf-directory-list} to name all the
4267 directories with the BDF font files, the following Lisp snippet will
4268 set up @code{w32-bdf-filename-alist}:
4270 @lisp
4271   (setq w32-bdf-filename-alist
4272      (w32-find-bdf-fonts bdf-directory-list))
4273 @end lisp
4275 Now, create fontsets for the BDF fonts:
4277 @smallexample
4278   (create-fontset-from-fontset-spec
4279    "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4280    japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4281    katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4282    latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4283    japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4284    thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4285    lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4286    tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4287    ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4288    tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4289 @end smallexample
4291 Many of the international bdf fonts from Intlfonts are type 0, and
4292 therefore need to be added to font-encoding-alist:
4294 @lisp
4295   (setq font-encoding-alist
4296         (append '(("MuleTibetan-0" (tibetan . 0))
4297                   ("GB2312"        (chinese-gb2312 . 0))
4298                   ("JISX0208"      (japanese-jisx0208 . 0))
4299                   ("JISX0212"      (japanese-jisx0212 . 0))
4300                   ("VISCII"        (vietnamese-viscii-lower . 0))
4301                   ("KSC5601"       (korean-ksc5601 . 0))
4302                   ("MuleArabic-0"  (arabic-digit . 0))
4303                   ("MuleArabic-1"  (arabic-1-column . 0))
4304                   ("MuleArabic-2"  (arabic-2-column . 0)))
4305                 font-encoding-alist))
4306 @end lisp
4308 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4309 fontset, or you can select it by setting the default font in your
4310 @file{~/.emacs}:
4312 @lisp
4313   (set-default-font "fontset-bdf")
4314 @end lisp
4317 @c ------------------------------------------------------------
4318 @node Mail and news
4319 @chapter Mail and news
4320 @cindex Mail and news
4322 @menu
4323 * Changing the included text prefix::
4324 * Saving a copy of outgoing mail::
4325 * Expanding aliases when sending mail::
4326 * Sorting the messages in an Rmail folder::
4327 * Rmail writes to /var/spool/mail::
4328 * Replying to the sender of a message::
4329 * Automatically starting a mail or news reader::
4330 * Reading news with Emacs::
4331 * Making Gnus faster::
4332 * Catching up in all newsgroups::
4333 @end menu
4335 @node Changing the included text prefix
4336 @section How do I change the included text prefix in mail/news followups?
4337 @cindex Prefix in mail/news followups, changing
4338 @cindex Included text prefix, changing
4339 @cindex Setting the included text character
4340 @cindex Quoting in mail messages
4342 If you read mail with Rmail, set the variable @code{mail-yank-prefix}.
4343 For Gnus, set @code{message-yank-prefix}.  For VM, set
4344 @code{vm-included-text-prefix}.  For mh-e, set @code{mh-ins-buf-prefix}.
4346 For fancier control of citations, use Supercite (@pxref{Top,, the Supercite
4347 Manual, sc, The Supercite Manual}).
4349 To prevent Emacs from including various headers of the replied-to
4350 message, set the value of @code{mail-yank-ignored-headers} to an
4351 appropriate regexp.
4353 @node Saving a copy of outgoing mail
4354 @section How do I save a copy of outgoing mail?
4355 @cindex Saving a copy of outgoing mail
4356 @cindex Copying outgoing mail to a file
4357 @cindex Filing outgoing mail
4358 @cindex Automatic filing of outgoing mail
4359 @cindex Mail, saving outgoing automatically
4361 You can either mail yourself a copy by including a @samp{BCC} header in the
4362 mail message, or store a copy of the message directly to a file by
4363 including an @samp{FCC} header.
4365 If you use standard mail, you can automatically create a @samp{BCC} to
4366 yourself by putting
4368 @lisp
4369 (setq mail-self-blind t)
4370 @end lisp
4372 @noindent
4373 in your @file{.emacs} file.  You can automatically include an @samp{FCC}
4374 field by putting something like the following in your @file{.emacs}
4375 file:
4377 @lisp
4378 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4379 @end lisp
4381 The output file will be in Unix mail format.
4383 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4384 components file.
4386 It does not work to put @samp{set record filename} in the @file{.mailrc}
4387 file.
4389 @node Expanding aliases when sending mail
4390 @section Why doesn't Emacs expand my aliases when sending mail?
4391 @cindex Expanding aliases when sending mail
4392 @cindex Mail alias expansion
4393 @cindex Sending mail with aliases
4395 @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}.
4397 @itemize @bullet
4399 @item
4400 Normally, Emacs expands aliases when you send the message.
4401 To expand them before this, use @kbd{M-x expand-mail-aliases}.
4403 @item
4404 Emacs normally only reads the @file{.mailrc} file once per session, when
4405 you start to compose your first mail message.  If you edit the file
4406 after this, you can use @kbd{M-x build-mail-aliases} to make Emacs
4407 reread it.  Prior to Emacs 24.1, this is not an interactive command, so
4408 you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}.
4410 @item
4411 If you like, you can expand mail aliases as abbrevs, as soon as you
4412 type them in.  To enable this feature, execute the following:
4414 @lisp
4415 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4416 @end lisp
4418 Note that the aliases are expanded automatically only after you type
4419 a word-separator character (e.g., @key{RET} or @kbd{,}).  You can force their
4420 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4421 (@kbd{M-x expand-abbrev}).
4422 @end itemize
4424 @node Sorting the messages in an Rmail folder
4425 @section How can I sort the messages in my Rmail folder?
4426 @cindex Rmail, sorting messages in
4427 @cindex Folder, sorting messages in an Rmail
4428 @cindex Sorting messages in an Rmail folder
4430 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4431 and their key bindings.
4433 @node Rmail writes to /var/spool/mail
4434 @section Why does Rmail need to write to @file{/var/spool/mail}?
4435 @cindex Rmail and @file{/var/spool/mail}
4436 @cindex @file{/var/spool/mail} and Rmail
4438 This is the behavior of the @code{movemail} program which Rmail uses.
4439 This indicates that @code{movemail} is configured to use lock files.
4441 RMS writes:
4443 @quotation
4444 Certain systems require lock files to interlock access to mail files.
4445 On these systems, @code{movemail} must write lock files, or you risk losing
4446 mail.  You simply must arrange to let @code{movemail} write them.
4448 Other systems use the @code{flock} system call to interlock access.  On
4449 these systems, you should configure @code{movemail} to use @code{flock}.
4450 @end quotation
4452 @node Replying to the sender of a message
4453 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4454 @cindex Replying only to the sender of a message
4455 @cindex Sender, replying only to
4456 @cindex Rmail, replying to the sender of a message in
4458 @c isaacson@@seas.upenn.edu
4459 Ron Isaacson says: When you hit
4460 @key{r} to reply in Rmail, by default it CCs all of the original
4461 recipients (everyone on the original @samp{To} and @samp{CC}
4462 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4463 it replies only to the sender.  However, going through the whole
4464 @kbd{C-u} business every time you want to reply is a pain.  This is the
4465 best fix I've been able to come up with:
4467 @lisp
4468 (defun rmail-reply-t ()
4469   "Reply only to the sender of the current message. (See rmail-reply.)"
4470   (interactive)
4471   (rmail-reply t))
4473 (add-hook 'rmail-mode-hook
4474   (lambda ()
4475     (define-key rmail-mode-map "r" 'rmail-reply-t)
4476     (define-key rmail-mode-map "R" 'rmail-reply)))
4477 @end lisp
4479 @node Automatically starting a mail or news reader
4480 @section How do I make Emacs automatically start my mail/news reader?
4481 @cindex Mail reader, starting automatically
4482 @cindex News reader, starting automatically
4483 @cindex Starting mail/news reader automatically
4485 To start Emacs in Gnus:
4487 @example
4488 emacs -f gnus
4489 @end example
4491 @noindent
4492 in Rmail:
4494 @example
4495 emacs -f rmail
4496 @end example
4498 A more convenient way to start with Gnus:
4500 @example
4501 alias gnus 'emacs -f gnus'
4502 gnus
4503 @end example
4505 It is probably unwise to automatically start your mail or news reader
4506 from your @file{.emacs} file.  This would cause problems if you needed to run
4507 two copies of Emacs at the same time.  Also, this would make it difficult for
4508 you to start Emacs quickly when you needed to.
4510 @node Reading news with Emacs
4511 @section How do I read news under Emacs?
4512 @cindex Reading news under Emacs
4513 @cindex Usenet reader in Emacs
4514 @cindex Gnus newsreader
4515 @cindex FAQ for Gnus
4516 @cindex Gnus FAQ
4517 @cindex Learning more about Gnus
4519 Use @kbd{M-x gnus}.  For more information on Gnus, @pxref{Top,, the Gnus
4520 Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked
4521 Questions,, the Gnus FAQ, gnus, The Gnus Manual}.
4524 @node Making Gnus faster
4525 @section How do I make Gnus faster?
4526 @cindex Faster, starting Gnus
4527 @cindex Starting Gnus faster
4528 @cindex Gnus, starting faster
4529 @cindex Slow catch up in Gnus
4530 @cindex Gnus is slow when catching up
4531 @cindex Crosspostings make Gnus catching up slow
4533 From the Gnus FAQ (@pxref{Reading news with Emacs}):
4535 @quotation
4536 If you have a slow machine, or are just really impatient, there are a
4537 few things you can do to make Gnus run faster.
4539 Set @code{gnus-check-new-newsgroups} and
4540 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
4542 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
4543 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
4544 summary buffer faster.
4545 @end quotation
4547 @node Catching up in all newsgroups
4548 @section How do I catch up all newsgroups in Gnus?
4549 @cindex Catching up all newsgroups in Gnus
4550 @cindex Gnus, Catching up all newsgroups in
4552 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4554 Leave off the initial @kbd{M-<} if you only want to catch up from point
4555 to the end of the @file{*Newsgroup*} buffer.
4557 @node Concept index
4558 @unnumbered Concept Index
4559 @printindex cp
4561 @bye