Reduce use of @email in doc/misc
[emacs.git] / doc / misc / faq.texi
blobf51d3a91a6ef19e162366732179bf28a33be0807
1 \input texinfo   @c -*- mode: texinfo; -*-
2 @c %**start of header
3 @setfilename ../../info/efaq
4 @settitle GNU Emacs FAQ
5 @c %**end of header
7 @include emacsver.texi
9 @c This file is maintained by Romain Francoise <rfrancoise@gnu.org>.
10 @c Feel free to install changes without prior permission (but I'd
11 @c appreciate a notice if you do).
13 @copying
14 Copyright @copyright{} 2001--2013 Free Software Foundation, Inc.@*
15 Copyright @copyright{} 1994, 1995, 1996, 1997, 1998, 1999, 2000
16 Reuven M. Lerner@*
17 Copyright @copyright{} 1992, 1993 Steven Byrnes@*
18 Copyright @copyright{} 1990, 1991, 1992 Joseph Brian Wells@*
20 @quotation
21 This list of frequently asked questions about GNU Emacs with answers
22 (``FAQ'') may be translated into other languages, transformed into other
23 formats (e.g., Texinfo, Info, WWW, WAIS), and updated with new information.
25 The same conditions apply to any derivative of the FAQ as apply to the FAQ
26 itself.  Every copy of the FAQ must include this notice or an approved
27 translation, information on who is currently maintaining the FAQ and how to
28 contact them (including their e-mail address), and information on where the
29 latest version of the FAQ is archived (including FTP information).
31 The FAQ may be copied and redistributed under these conditions, except that
32 the FAQ may not be embedded in a larger literary work unless that work
33 itself allows free copying and redistribution.
35 [This version has been heavily edited since it was included in the Emacs
36 distribution.]
37 @end quotation
38 @end copying
40 @dircategory Emacs
41 @direntry
42 * Emacs FAQ: (efaq).            Frequently Asked Questions about Emacs.
43 @end direntry
45 @c The @titlepage stuff only appears in the printed version
46 @titlepage
47 @sp 10
48 @center @titlefont{GNU Emacs FAQ}
50 @c The following two commands start the copyright page.
51 @page
52 @vskip 0pt plus 1filll
53 @insertcopying
54 @end titlepage
56 @contents
58 @node Top, FAQ notation, (dir), (dir)
59 @top The GNU Emacs FAQ
61 @c FIXME @today is just the day we ran `makeinfo'.
62 This is the GNU Emacs FAQ, last updated on @today{}.
64 This FAQ is maintained as a part of GNU Emacs.  If you find any errors,
65 or have any suggestions, please use @kbd{M-x report-emacs-bug} to report
66 them.
68 This is the version of the FAQ distributed with Emacs @value{EMACSVER}, and
69 mainly describes that version.  Although there is some information on
70 older versions, details about very old releases (now only of historical
71 interest) have been removed.  If you are interested in this, consult
72 either the version of the FAQ distributed with older versions of Emacs,
73 or the history of this document in the Emacs source repository.
75 Since Emacs releases are very stable, we recommend always running the
76 latest release.
78 This FAQ is not updated very frequently.  When you have a question about
79 Emacs, the Emacs manual is often the best starting point.
81 @ifnottex
82 @insertcopying
83 @end ifnottex
85 @menu
86 * FAQ notation::
87 * General questions::
88 * Getting help::
89 * Status of Emacs::
90 * Common requests::
91 * Bugs and problems::
92 * Compiling and installing Emacs::
93 * Finding Emacs and related packages::
94 * 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 file @file{etc/MAILINGLISTS} describes the purpose of each GNU
396 mailing list (@pxref{Informational files for Emacs}).  For those lists
397 which are gatewayed with newsgroups, it lists both the newsgroup name
398 and the mailing list address.  The Emacs mailing lists are also
399 described at @uref{http://savannah.gnu.org/mail/?group=emacs, the Emacs
400 Savannah page}.
402 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
403 in general.  The newsgroup @uref{news:gnu.emacs.help} is specifically
404 for GNU Emacs.  It therefore makes no sense to cross-post to both
405 groups, since only one can be appropriate to any question.
407 Messages advocating ``non-free'' software are considered unacceptable on
408 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
409 which was created to hold the extensive flame-wars on the subject.
410 ``Non-free'' software includes any software for which the end user can't
411 freely modify the source code and exchange enhancements.  Be careful to
412 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
413 posting a followup that recommends such software.
415 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
416 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
418 @node Newsgroup archives
419 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
420 @cindex Archived postings from @code{gnu.emacs.help}
421 @cindex Usenet archives for GNU groups
422 @cindex Old Usenet postings for GNU groups
424 The FSF has maintained archives of all of the GNU mailing lists for many
425 years, although there may be some unintentional gaps in coverage.  The
426 archive can be browsed over the web at
427 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}.  Raw
428 files can be downloaded from @uref{ftp://lists.gnu.org/}.
430 Web-based Usenet search services, such as
431 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
432 archive the @code{gnu.*} groups.
434 You can also read the archives of the @code{gnu.*} groups and post new
435 messages at @uref{http://gmane.org/, Gmane}.  Gmane is a service that
436 presents mailing lists as newsgroups (even those without a traditional
437 mail-to-news gateway).
439 @node Reporting bugs
440 @section Where should I report bugs and other problems with Emacs?
441 @cindex Bug reporting
442 @cindex Good bug reports
443 @cindex How to submit a bug report
444 @cindex Reporting bugs
446 The correct way to report Emacs bugs is to use the command
447 @kbd{M-x report-emacs-bug}.  It sets up a mail buffer with the
448 essential information and the correct e-mail address,
449 @email{bug-gnu-emacs@@gnu.org}.
450 Anything sent there also appears in the
451 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
452 news to submit the bug report.  This ensures a reliable return address
453 so you can be contacted for further details.
455 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
456 a bug!  The manual describes in detail how to submit a useful bug
457 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
458 (@xref{Emacs manual}, if you don't know how to read the manual.)
460 RMS says:
462 @quotation
463 Sending bug reports to
464 @url{http://lists.gnu.org/mailman/listinfo/help-gnu-emacs,
465 the help-gnu-emacs mailing list}
466 (which has the effect of posting on @uref{news:gnu.emacs.help}) is
467 undesirable because it takes the time of an unnecessarily large group
468 of people, most of whom are just users and have no idea how to fix
469 these problem.
470 @url{http://lists.gnu.org/mailman/listinfo/bug-gnu-emacs, The
471 bug-gnu-emacs list} reaches a much smaller group of people who are
472 more likely to know what to do and have expressed a wish to receive
473 more messages about Emacs than the others.
474 @end quotation
476 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
478 @quotation
479 If you have reported a bug and you don't hear about a possible fix,
480 then after a suitable delay (such as a week) it is okay to post on
481 @code{gnu.emacs.help} asking if anyone can help you.
482 @end quotation
484 If you are unsure whether you have found a bug, consider the following
485 non-exhaustive list, courtesy of RMS:
487 @quotation
488 If Emacs crashes, that is a bug.  If Emacs gets compilation errors
489 while building, that is a bug.  If Emacs crashes while building, that
490 is a bug.  If Lisp code does not do what the documentation says it
491 does, that is a bug.
492 @end quotation
494 @node Unsubscribing from Emacs lists
495 @section  How do I unsubscribe from a mailing list?
496 @cindex Unsubscribing from GNU mailing lists
497 @cindex Removing yourself from GNU mailing lists
499 If you are receiving a GNU mailing list named @var{list}, you should be
500 able to unsubscribe from it by sending a request to the address
501 @email{@var{list}-request@@gnu.org}.  Mailing lists mails normally
502 contain information in either the message header
503 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
504 unsubscribe.
506 @node Contacting the FSF
507 @section  How do I contact the FSF?
508 @cindex Contracting the FSF
509 @cindex Free Software Foundation, contacting
511 For up-to-date information, see
512 @uref{http://www.fsf.org/about/contact.html, the FSF contact web-page}.
513 You can send general correspondence to @email{info@@fsf.org}.
515 @cindex Ordering GNU software
516 For details on how to order items directly from the FSF, see the
517 @uref{http://shop.fsf.org/, FSF on-line store}.
519 @c ------------------------------------------------------------
520 @node Getting help
521 @chapter Getting help
522 @cindex Getting help
524 This chapter tells you how to get help with Emacs.
526 @menu
527 * Basic editing::
528 * Learning how to do something::
529 * Getting a printed manual::
530 * Emacs Lisp documentation::
531 * Installing Texinfo documentation::
532 * Printing a Texinfo file::
533 * Viewing Info files outside of Emacs::
534 * Informational files for Emacs::
535 * Help installing Emacs::
536 * Obtaining the FAQ::
537 @end menu
539 @node Basic editing
540 @section I'm just starting Emacs; how do I do basic editing?
541 @cindex Basic editing with Emacs
542 @cindex Beginning editing
543 @cindex Tutorial, invoking the
544 @cindex Self-paced tutorial, invoking the
545 @cindex Help system, entering the
547 Type @kbd{C-h t} to invoke the self-paced tutorial.  Just typing
548 @kbd{C-h} enters the help system.  Starting with Emacs 22, the tutorial
549 is available in many foreign languages such as French, German, Japanese,
550 Russian, etc.  Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
551 to choose your language and start the tutorial.
553 Your system administrator may have changed @kbd{C-h} to act like
554 @key{DEL} to deal with local keyboards.  You can use @kbd{M-x
555 help-for-help} instead to invoke help.  To discover what key (if any)
556 invokes help on your system, type @kbd{M-x where-is @key{RET}
557 help-for-help @key{RET}}.  This will print a comma-separated list of key
558 sequences in the echo area.  Ignore the last character in each key
559 sequence listed.  Each of the resulting key sequences (e.g., @key{F1} is
560 common) invokes help.
562 Emacs help works best if it is invoked by a single key whose value
563 should be stored in the variable @code{help-char}.
565 @node Learning how to do something
566 @section How do I find out how to do something in Emacs?
567 @cindex Help for Emacs
568 @cindex Learning to do something in Emacs
569 @cindex Reference card for Emacs
570 @cindex Overview of help systems
572 There are several methods for finding out how to do things in Emacs.
574 @itemize @bullet
576 @cindex Reading the Emacs manual
577 @item
578 The complete text of the Emacs manual is available via the Info
579 hypertext reader.  Type @kbd{C-h r} to display the manual in Info mode.
580 Typing @key{h} immediately after entering Info will provide a short
581 tutorial on how to use it.
583 @cindex Lookup a subject in a manual
584 @cindex Index search in a manual
585 @item
586 To quickly locate the section of the manual which discusses a certain
587 issue, or describes a command or a variable, type @kbd{C-h i m emacs
588 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
589 topic, the command, or the variable which you are looking for.  If this
590 does not land you on the right place in the manual, press @kbd{,}
591 (comma) repeatedly until you find what you need.  (The @kbd{i} and
592 @kbd{,} keys invoke the index-searching functions, which look for the
593 @var{topic} you type in all the indices of the Emacs manual.)
595 @cindex Apropos
596 @item
597 You can list all of the commands whose names contain a certain word
598 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
599 command-apropos}).
601 @cindex Command description in the manual
602 @item
603 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
604 for the name of a command, and then attempts to find the section in the
605 Emacs manual where that command is described.
607 @cindex Finding commands and variables
608 @item
609 You can list all of the functions and variables whose names contain a
610 certain word using @kbd{M-x apropos}.
612 @item
613 You can list all of the functions and variables whose documentation
614 matches a regular expression or a string, using @kbd{M-x
615 apropos-documentation}.
617 @item
618 You can order a hardcopy of the manual from the FSF@.  @xref{Getting a
619 printed manual}.
621 @cindex Reference cards, in other languages
622 @item
623 You can get a printed reference card listing commands and keys to
624 invoke them.  You can order one from the FSF for $2 (or 10 for $18),
625 or you can print your own from the @file{etc/refcards/refcard.tex} or
626 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
627 Beginning with version 21.1, the Emacs distribution comes with
628 translations of the reference card into several languages; look for
629 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
630 is a two-letter code of the language.  For example, the German version
631 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
632 and @file{etc/refcards/de-refcard.pdf}.
634 @item
635 There are many other commands in Emacs for getting help and
636 information.  To get a list of these commands, type @samp{?} after
637 @kbd{C-h}.
639 @end itemize
641 @node Getting a printed manual
642 @section How do I get a printed copy of the Emacs manual?
643 @cindex Printed Emacs manual, obtaining
644 @cindex Manual, obtaining a printed or HTML copy of
645 @cindex Emacs manual, obtaining a printed or HTML copy of
647 You can order a printed copy of the Emacs manual from the FSF@.  For
648 details see the @uref{http://shop.fsf.org/, FSF on-line store}.
650 The full Texinfo source for the manual also comes in the @file{doc/emacs}
651 directory of the Emacs distribution, if you're daring enough to try to
652 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
653 file}).
655 If you absolutely have to print your own copy, and you don't have @TeX{},
656 you can get a PostScript or PDF (or HTML) version from
658 @uref{http://www.gnu.org/software/emacs/manual/}
660 @xref{Learning how to do something}, for how to view the manual from Emacs.
662 @node Emacs Lisp documentation
663 @section Where can I get documentation on Emacs Lisp?
664 @cindex Documentation on Emacs Lisp
665 @cindex Function documentation
666 @cindex Variable documentation
667 @cindex Emacs Lisp Reference Manual
668 @cindex Reference manual for Emacs Lisp
670 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
671 function, @kbd{C-h v} for a variable.
673 For more information, the Emacs Lisp Reference Manual is available
674 in Info format (@pxref{Top, Emacs Lisp,, elisp, The
675 Emacs Lisp Reference Manual}).
677 You can also order a hardcopy of the manual from the FSF, for details
678 see the @uref{http://shop.fsf.org/, FSF on-line store}.  (This manual is
679 not always in print.)
681 An HTML version of the Emacs Lisp Reference Manual is available at
683 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html}
685 @node Installing Texinfo documentation
686 @section How do I install a piece of Texinfo documentation?
687 @cindex Texinfo documentation, installing
688 @cindex Installing Texinfo documentation
689 @cindex New Texinfo files, installing
690 @cindex Documentation, installing new Texinfo files
691 @cindex Info files, how to install
693 Emacs releases come with pre-built Info files, and the normal install
694 process places them in the correct location.  This is true for most
695 applications that provide Info files.  The following section is only
696 relevant if you want to install extra Info files by hand.
698 First, you must turn the Texinfo source files into Info files.  You may
699 do this using the stand-alone @file{makeinfo} program, available as part
700 of the Texinfo package at
702 @uref{http://www.gnu.org/software/texinfo/}
704 For information about the Texinfo format, read the Texinfo manual which
705 comes with the Texinfo package.  This manual also comes installed in
706 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
707 @key{RET}}.
709 @c FIXME is this a complete alternative?
710 @c Probably not, given that we require makeinfo to build Emacs.
711 Alternatively, you could use the Emacs command @kbd{M-x
712 texinfo-format-buffer}, after visiting the Texinfo source file of the
713 manual you want to convert.
715 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
716 resulting Info files in Emacs's Info tree.  To install Info files,
717 perform these steps:
719 @enumerate
720 @item
721 Move the files to the @file{info} directory in the installed Emacs
722 distribution.  @xref{File-name conventions}, if you don't know where that
725 @item
726 Run the @code{install-info} command, which is part of the Texinfo
727 distribution, to update the main Info directory menu, like this:
729 @example
730  install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
731 @end example
733 @noindent
734 where @var{dir-path} is the full path to the directory where you copied
735 the produced Info file(s), and @var{file} is the name of the Info file
736 you produced and want to install.
738 If you don't have the @code{install-info} command installed, you can
739 edit the file @file{info/dir} in the installed Emacs distribution, and
740 add a line for the top level node in the Info package that you are
741 installing.  Follow the examples already in this file.  The format is:
743 @example
744 * Topic: (relative-pathname).  Short description of topic.
745 @end example
747 @end enumerate
749 If you want to install Info files and you don't have the necessary
750 privileges, you have several options:
752 @itemize @bullet
753 @item
754 Info files don't actually need to be installed before being used.
755 You can use a prefix argument for the @code{info} command and specify
756 the name of the Info file in the minibuffer.  This goes to the node
757 named @samp{Top} in that file.  For example, to view a Info file named
758 @file{@var{info-file}} in your home directory, you can type this:
760 @example
761 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
762 @end example
764 Alternatively, you can feed a file name to the @code{Info-goto-node}
765 command (invoked by pressing @key{g} in Info mode) by typing the name
766 of the file in parentheses, like this:
768 @example
769 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
770 @end example
772 @item
773 You can create your own Info directory.  You can tell Emacs where that
774 Info directory is by adding its pathname to the value of the variable
775 @code{Info-default-directory-list}.  For example, to use a private Info
776 directory which is a subdirectory of your home directory named @file{Info},
777 you could put this in your @file{.emacs} file:
779 @lisp
780 (add-to-list 'Info-default-directory-list "~/Info")
781 @end lisp
783 You will need a top-level Info file named @file{dir} in this directory
784 which has everything the system @file{dir} file has in it, except it
785 should list only entries for Info files in that directory.  You might
786 not need it if (fortuitously) all files in this directory were
787 referenced by other @file{dir} files.  The node lists from all
788 @file{dir} files in @code{Info-default-directory-list} are merged by the
789 Info system.
791 @end itemize
793 @node Printing a Texinfo file
794 @section How do I print a Texinfo file?
795 @cindex Printing a Texinfo file
796 @cindex Texinfo file, printing
797 @cindex Printing documentation
799 You can't get nicely printed output from Info files; you must still have
800 the original Texinfo source file for the manual you want to print.
802 Assuming you have @TeX{} installed on your system, follow these steps:
804 @enumerate
806 @item
807 Make sure the first line of the Texinfo file looks like this:
809 @example
810 \input texinfo
811 @end example
813 You may need to change @samp{texinfo} to the full pathname of the
814 @file{texinfo.tex} file, which comes with Emacs as
815 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
817 @item
818 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
819 the name of the Texinfo source file for which you want to produce a
820 printed copy.  The @samp{texi2dvi} script is part of the GNU Texinfo
821 distribution.
823 Alternatively, @samp{texi2pdf} produces PDF files.
825 @item
826 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
827 printing DVI files at your site.  For example, if you have a PostScript
828 printer, run the @code{dvips} program to print the DVI file on that
829 printer.
831 @end enumerate
833 To get more general instructions, retrieve the latest Texinfo package
834 (@pxref{Installing Texinfo documentation}).
836 @node Viewing Info files outside of Emacs
837 @section Can I view Info files without using Emacs?
838 @cindex Viewing Info files
839 @cindex Info file viewers
840 @cindex Alternative Info file viewers
842 Yes.  Here are some alternative programs:
844 @itemize @bullet
846 @item
847 @code{info}, a stand-alone version of the Info program, comes as part of
848 the Texinfo package.  @xref{Installing Texinfo documentation}, for
849 details.
851 @item
852 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
853 You can get Tkinfo at
854 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
856 @end itemize
858 @node Informational files for Emacs
859 @section What informational files are available for Emacs?
860 @cindex Informational files included with Emacs
861 @cindex Files included with Emacs
862 @cindex @file{COPYING}, description of file
863 @cindex @file{DISTRIB}, description of file
864 @cindex @file{GNU}, description of file
865 @cindex @file{INTERVIEW}, description of file
866 @cindex @file{MACHINES}, description of file
867 @cindex @file{MAILINGLISTS}, description of file
868 @cindex @file{NEWS}, description of file
870 This isn't a frequently asked question, but it should be!  A variety of
871 informational files about Emacs and relevant aspects of the GNU project
872 are available for you to read.
874 The following files (and others) are available in the @file{etc}
875 directory of the Emacs distribution (see @ref{File-name conventions}, if
876 you're not sure where that is).  Many of these files are available via
877 the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
878 help-for-help}).
880 @table @file
882 @item COPYING
883 GNU General Public License
885 @item DISTRIB
886 Emacs Availability Information
888 @item GNU
889 The GNU Manifesto
891 @item INTERVIEW
892 Richard Stallman discusses his public-domain UNIX-compatible software
893 system with BYTE editors
895 @item MACHINES
896 Status of Emacs on Various Machines and Systems
898 @item MAILINGLISTS
899 GNU Project Electronic Mailing Lists
901 @item NEWS
902 Emacs news, a history of recent user-visible changes
904 @end table
906 More GNU information, including back issues of the @cite{GNU's
907 Bulletin}, are at
909 @uref{http://www.gnu.org/bulletins/bulletins.html} and
911 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
913 @node Help installing Emacs
914 @section Where can I get help in installing Emacs?
915 @cindex Installation help
916 @cindex Help installing Emacs
918 @xref{Installing Emacs}, for some basic installation hints, and see
919 @ref{Problems building Emacs}, if you have problems with the installation.
921 @uref{http://www.fsf.org/resources/service/, The GNU Service directory}
922 lists companies and individuals willing to sell you help in installing
923 or using Emacs and other GNU software.
925 @node Obtaining the FAQ
926 @section Where can I get the latest version of this FAQ?
927 @cindex FAQ, obtaining the
928 @cindex Latest FAQ version, obtaining the
930 The Emacs FAQ is distributed with Emacs in Info format.  You can read it
931 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
932 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
933 C-f} (@kbd{M-x view-emacs-FAQ}).  The very latest version is available
934 in the Emacs development repository (@pxref{Latest version of Emacs}).
936 @c ------------------------------------------------------------
937 @node Status of Emacs
938 @chapter Status of Emacs
939 @cindex Status of Emacs
941 This chapter gives you basic information about Emacs, including the
942 status of its latest version.
944 @menu
945 * Origin of the term Emacs::
946 * Latest version of Emacs::
947 * New in Emacs 24::
948 * New in Emacs 23::
949 * New in Emacs 22::
950 * New in Emacs 21::
951 * New in Emacs 20::
952 @end menu
954 @node Origin of the term Emacs
955 @section Where does the name ``Emacs'' come from?
956 @cindex Origin of the term ``Emacs''
957 @cindex Emacs name origin
958 @cindex TECO
959 @cindex Original version of Emacs
961 Emacs originally was an acronym for Editor MACroS@.  RMS says he ``picked
962 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
963 the time.''  The first Emacs was a set of macros written in 1976 at MIT
964 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
965 Editor and COrrector) under ITS (the Incompatible Timesharing System) on
966 a PDP-10.  RMS had already extended TECO with a ``real-time''
967 full-screen mode with reprogrammable keys.  Emacs was started by
968 @c gls@@east.sun.com
969 Guy Steele as a project to unify the many
970 divergent TECO command sets and key bindings at MIT, and completed by
971 RMS.
973 Many people have said that TECO code looks a lot like line noise; you
974 can read more at @uref{news:alt.lang.teco}.  Someone has written a TECO
975 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
976 come with Emacs}); it would be an interesting project to run the
977 original TECO Emacs inside of Emacs.
979 @cindex Why Emacs?
980 For some not-so-serious alternative reasons for Emacs to have that
981 name, check out the file @file{etc/JOKES} (@pxref{File-name
982 conventions}).
984 @node Latest version of Emacs
985 @section What is the latest version of Emacs?
986 @cindex Version, latest
987 @cindex Latest version of Emacs
988 @cindex Development, Emacs
989 @cindex Repository, Emacs
990 @cindex Bazaar repository, Emacs
992 Emacs @value{EMACSVER} is the current version as of this writing.  A version
993 number with two components (e.g., @samp{22.1}) indicates a released
994 version; three components indicate a development
995 version (e.g., @samp{23.0.50} is what will eventually become @samp{23.1}).
997 Emacs is under active development, hosted at
998 @uref{http://savannah.gnu.org/projects/emacs/, Savannah}.  The source
999 code can be retrieved anonymously following the
1000 @uref{http://savannah.gnu.org/bzr/?group=emacs, instructions}.
1001 The repository is GNU Bazaar.
1003 Because Emacs undergoes many changes before a release, the version
1004 number of a development version is not especially meaningful.  It is
1005 better to refer to the date on which the sources were retrieved from the
1006 development repository.  The development version is usually quite robust
1007 for every-day use, but if stability is more important to you than the
1008 latest features, you may want to stick to the releases.
1010 The following sections list some of the major new features in the last
1011 few Emacs releases.  For full details of the changes in any version of
1012 Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}).  As of Emacs 22,
1013 you can give this command a prefix argument to read about which features
1014 were new in older versions.
1016 @node New in Emacs 24
1017 @section What is different about Emacs 24?
1018 @cindex Differences between Emacs 23 and Emacs 24
1019 @cindex Emacs 24, new features in
1021 @itemize
1022 @cindex packages, installing more
1023 @item
1024 Emacs now includes a package manager.  Type @kbd{M-x list-packages} to
1025 get started.  You can use this to download and automatically install
1026 many more Lisp packages.
1028 @cindex lexical binding
1029 @item
1030 Emacs Lisp now supports lexical binding on a per-file basis.  In
1031 @emph{lexical binding}, variable references must be located textually
1032 within the binding construct.  This contrasts with @emph{dynamic
1033 binding}, where programs can refer to variables defined outside their
1034 local textual scope.  A Lisp file can use a local variable setting of
1035 @code{lexical-binding: t} to indicate that the contents should be
1036 interpreted using lexical binding.  See the Emacs Lisp Reference
1037 Manual for more details.
1039 @cindex bidirectional display
1040 @cindex right-to-left languages
1041 @item
1042 Some human languages, such as English, are written from left to right.
1043 Others, such as Arabic, are written from right to left.  Emacs now has
1044 support for any mixture of these forms---this is ``bidirectional text''.
1046 @item
1047 Handling of text selections has been improved, and now integrates
1048 better with external clipboards.
1050 @cindex themes
1051 @item
1052 A new command @kbd{customize-themes} allows you to easily change the
1053 appearance of your Emacs.
1055 @item
1056 Emacs can be compiled with the GTK+ 3 toolkit.
1058 @item
1059 Support for several new external libraries can be included at compile
1060 time:
1062 @itemize
1064 @item
1065 ``Security-Enhanced Linux'' (SELinux) is a Linux kernel feature that
1066 provides more sophisticated file access controls than ordinary
1067 ``Unix-style'' file permissions.
1069 @item
1070 The ImageMagick display library.  This allows you to display many more
1071 image format in Emacs, as well as carry out transformations such as
1072 rotations.
1074 @item
1075 The GnuTLS library for secure network communications.  Emacs uses this
1076 transparently for email if your mail server supports it.
1078 @item
1079 The libxml2 library for parsing XML structures.
1080 @end itemize
1082 @item
1083 Much more flexibility in the handling of windows and buffer display.
1085 @end itemize
1087 As always, consult the @file{NEWS} file for more information.
1090 @node New in Emacs 23
1091 @section What is different about Emacs 23?
1092 @cindex Differences between Emacs 22 and Emacs 23
1093 @cindex Emacs 23, new features in
1095 @itemize
1097 @cindex Anti-aliased fonts
1098 @cindex Freetype fonts
1099 @item
1100 Emacs has a new font code that can use multiple font backends,
1101 including freetype and fontconfig.  Emacs can use the Xft library for
1102 anti-aliasing, and the otf and m17n libraries for complex text layout and
1103 text shaping.
1105 @cindex Unicode
1106 @cindex Character sets
1107 @item
1108 The Emacs character set is now a superset of Unicode.  Several new
1109 language environments have been added.
1111 @cindex Multi-tty support
1112 @cindex X and tty displays
1113 @item
1114 Emacs now supports using both X displays and ttys in the same session
1115 (@samp{multi-tty}).
1117 @cindex Daemon mode
1118 @item
1119 Emacs can be started as a daemon in the background.
1121 @cindex NeXTstep port
1122 @cindex GNUstep port
1123 @cindex Mac OS X Cocoa
1124 @item
1125 There is a new NeXTstep port of Emacs.  This supports GNUstep and Mac OS
1126 X (via the Cocoa libraries).  The Carbon port of Emacs, which supported
1127 Mac OS X in Emacs 22, has been removed.
1129 @cindex Directory-local variables
1130 @item
1131 Directory-local variables can now be defined, in a similar manner to
1132 file-local variables.
1134 @item
1135 Transient Mark mode (@pxref{Highlighting a region}) is on by default.
1137 @end itemize
1139 @noindent
1140 Other changes include: support for serial port access; D-Bus bindings; a
1141 new Visual Line mode for line-motion; improved completion; a new mode
1142 (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML
1143 mode (for editing XML documents) is included; VC has been updated for
1144 newer version control systems; etc.
1147 @node New in Emacs 22
1148 @section What is different about Emacs 22?
1149 @cindex Differences between Emacs 21 and Emacs 22
1150 @cindex Emacs 22, new features in
1152 @itemize
1153 @cindex GTK+ Toolkit
1154 @cindex Drag-and-drop
1155 @item
1156 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1157 operation on X.
1159 @cindex Supported systems
1160 @item
1161 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1162 machines, as well as support for the Mac OS X and Cygwin operating
1163 systems.
1165 @item
1166 The native MS-Windows, and Mac OS X builds include full support
1167 for images, toolbar, and tooltips.
1169 @item
1170 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1171 enabled by default.
1173 @item
1174 The maximum size of buffers is increased: on 32-bit machines, it is
1175 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above.
1177 @item
1178 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1180 @cindex Mouse wheel
1181 @item
1182 Mouse wheel support is enabled by default.
1184 @item
1185 Window fringes are customizable.
1187 @item
1188 The mode line of the selected window is now highlighted.
1190 @item
1191 The minibuffer prompt is displayed in a distinct face.
1193 @item
1194 Abbrev definitions are read automatically at startup.
1196 @item
1197 Grep mode is separate from Compilation mode and has many new options and
1198 commands specific to grep.
1200 @item
1201 The original Emacs macro system has been replaced by the new Kmacro
1202 package, which provides many new commands and features and a simple
1203 interface that uses the function keys F3 and F4.  Macros are stored in a
1204 macro ring, and can be debugged and edited interactively.
1206 @item
1207 The Grand Unified Debugger (GUD) can be used with a full graphical user
1208 interface to GDB; this provides many features found in traditional
1209 development environments, making it easy to manipulate breakpoints, add
1210 watch points, display the call stack, etc.  Breakpoints are visually
1211 indicated in the source buffer.
1213 @item
1214 @cindex New modes
1215 Many new modes and packages have been included in Emacs, such as Calc,
1216 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1217 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1218 savehist, Conf mode, Python mode, DNS mode, etc.
1220 @cindex Multilingual Environment
1221 @item
1222 Leim is now part of Emacs.  Unicode support has been much improved, and
1223 the following input methods have been added: belarusian, bulgarian-bds,
1224 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1225 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1226 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1227 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1228 ukrainian-computer, vietnamese-telex, and welsh.
1230 The following language environments have also been added: Belarusian,
1231 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1232 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1233 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1235 @cindex Documentation
1236 @cindex Emacs Lisp Manual
1237 @item
1238 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1239 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1240 @end itemize
1243 @node New in Emacs 21
1244 @section What is different about Emacs 21?
1245 @cindex Differences between Emacs 20 and Emacs 21
1246 @cindex Emacs 21, new features in
1248 @cindex Variable-size fonts
1249 @cindex Toolbar support
1250 Emacs 21 features a thorough rewrite of the display engine.  The new
1251 display engine supports variable-size fonts, images, and can play sounds
1252 on platforms which support that.  As a result, the visual appearance of
1253 Emacs, when it runs on a windowed display, is much more reminiscent of
1254 modern GUI programs, and includes 3D widgets (used for the mode line and
1255 the scroll bars), a configurable and extensible toolbar, tooltips
1256 (a.k.a.@: balloon help), and other niceties.
1258 @cindex Colors on text-only terminals
1259 @cindex TTY colors
1260 In addition, Emacs 21 supports faces on text-only terminals.  This means
1261 that you can now have colors when you run Emacs on a GNU/Linux console
1262 and on @code{xterm} with @kbd{emacs -nw}.
1265 @node New in Emacs 20
1266 @section What is different about Emacs 20?
1267 @cindex Differences between Emacs 19 and Emacs 20
1268 @cindex Emacs 20, new features in
1270 The differences between Emacs versions 18 and 19 were rather dramatic;
1271 the introduction of frames, faces, and colors on windowing systems was
1272 obvious to even the most casual user.
1274 There are differences between Emacs versions 19 and 20 as well, but many
1275 are more subtle or harder to find.  Among the changes are the inclusion
1276 of MULE code for languages that use non-Latin characters and for mixing
1277 several languages in the same document; the ``Customize'' facility for
1278 modifying variables without having to use Lisp; and automatic conversion
1279 of files from Macintosh, Microsoft, and Unix platforms.
1281 @c ------------------------------------------------------------
1282 @node Common requests
1283 @chapter Common requests
1284 @cindex Common requests
1286 @menu
1287 * Setting up a customization file::
1288 * Using Customize::
1289 * Colors on a TTY::
1290 * Debugging a customization file::
1291 * Displaying the current line or column::
1292 * Displaying the current file name in the titlebar::
1293 * Turning on abbrevs by default::
1294 * Associating modes with files::
1295 * Highlighting a region::
1296 * Replacing highlighted text::
1297 * Controlling case sensitivity::
1298 * Working with unprintable characters::
1299 * Searching for/replacing newlines::
1300 * Yanking text in isearch::
1301 * Wrapping words automatically::
1302 * Turning on auto-fill by default::
1303 * Changing load-path::
1304 * Using an already running Emacs process::
1305 * Compiler error messages::
1306 * Indenting switch statements::
1307 * Customizing C and C++ indentation::
1308 * Horizontal scrolling::
1309 * Overwrite mode::
1310 * Turning off beeping::
1311 * Turning the volume down::
1312 * Automatic indentation::
1313 * Matching parentheses::
1314 * Hiding #ifdef lines::
1315 * Repeating commands::
1316 * Valid X resources::
1317 * Evaluating Emacs Lisp code::
1318 * Changing the length of a Tab::
1319 * Inserting text at the beginning of each line::
1320 * Forcing the cursor to remain in the same column::
1321 * Forcing Emacs to iconify itself::
1322 * Using regular expressions::
1323 * Replacing text across multiple files::
1324 * Documentation for etags::
1325 * Disabling backups::
1326 * Disabling auto-save-mode::
1327 * Going to a line by number::
1328 * Modifying pull-down menus::
1329 * Deleting menus and menu options::
1330 * Turning on syntax highlighting::
1331 * Scrolling only one line::
1332 * Editing MS-DOS files::
1333 * Filling paragraphs with a single space::
1334 * Escape sequences in shell output::
1335 * Fullscreen mode on MS-Windows::
1336 @end menu
1338 @node Setting up a customization file
1339 @section How do I set up a @file{.emacs} file properly?
1340 @cindex @file{.emacs} file, setting up
1341 @cindex @file{.emacs} file, locating
1342 @cindex Init file, setting up
1343 @cindex Customization file, setting up
1345 @xref{Init File,,, emacs, The GNU Emacs Manual}.
1347 In general, new Emacs users should not be provided with @file{.emacs}
1348 files, because this can cause confusing non-standard behavior.  Then
1349 they send questions to
1350 @url{http://lists.gnu.org/mailman/listinfo/help-gnu-emacs,
1351 the help-gnu-emacs mailing list} asking why Emacs
1352 isn't behaving as documented.
1354 Emacs includes the Customize facility (@pxref{Using Customize}).  This
1355 allows users who are unfamiliar with Emacs Lisp to modify their
1356 @file{.emacs} files in a relatively straightforward way, using menus
1357 rather than Lisp code.
1359 While Customize might indeed make it easier to configure Emacs,
1360 consider taking a bit of time to learn Emacs Lisp and modifying your
1361 @file{.emacs} directly.  Simple configuration options are described
1362 rather completely in @ref{Init File,,, emacs, The GNU Emacs Manual},
1363 for users interested in performing frequently requested, basic tasks.
1365 Sometimes users are unsure as to where their @file{.emacs} file should
1366 be found.  Visiting the file as @file{~/.emacs} from Emacs will find
1367 the correct file.
1369 @node Using Customize
1370 @section How do I start using Customize?
1371 @cindex Customize groups
1372 @cindex Customizing variables
1373 @cindex Customizing faces
1375 The main Customize entry point is @kbd{M-x customize @key{RET}}.  This
1376 command takes you to a buffer listing all the available Customize
1377 groups.  From there, you can access all customizable options and faces,
1378 change their values, and save your changes to your init file.
1379 @xref{Easy Customization,,, emacs, The GNU Emacs Manual}.
1381 If you know the name of the group in advance (e.g., ``shell''), use
1382 @kbd{M-x customize-group @key{RET}}.
1384 If you wish to customize a single option, use @kbd{M-x customize-option
1385 @key{RET}}.  This command prompts you for the name of the option to
1386 customize, with completion.
1388 @node Colors on a TTY
1389 @section How do I get colors and syntax highlighting on a TTY?
1390 @cindex Colors on a TTY
1391 @cindex Syntax highlighting on a TTY
1392 @cindex Console, colors
1394 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1395 i.e., on Unix and GNU/Linux text-only terminals and consoles, and when
1396 invoked as @samp{emacs -nw} on X, and MS-Windows.  (Colors and faces were
1397 supported in the MS-DOS port since Emacs 19.29.)  Emacs automatically
1398 detects color support at startup and uses it if available.  If you think
1399 that your terminal supports colors, but Emacs won't use them, check the
1400 @code{termcap} entry for your display type for color-related
1401 capabilities.
1403 The command @kbd{M-x list-colors-display} pops up a window which
1404 exhibits all the colors Emacs knows about on the current display.
1406 Syntax highlighting is on by default since version 22.1.
1408 @node Debugging a customization file
1409 @section How do I debug a @file{.emacs} file?
1410 @cindex Debugging @file{.emacs} file
1411 @cindex @file{.emacs} debugging
1412 @cindex Init file debugging
1413 @cindex @samp{-debug-init} option
1415 Start Emacs with the @samp{-debug-init} command-line option.  This
1416 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1417 file, and places you in the debugger if something goes wrong.  The top
1418 line in the @file{trace-back} buffer will be the error message, and the
1419 second or third line of that buffer will display the Lisp code from your
1420 @file{.emacs} file that caused the problem.
1422 You can also evaluate an individual function or argument to a function
1423 in your @file{.emacs} file by moving the cursor to the end of the
1424 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1425 eval-last-sexp}).
1427 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1428 variables which you are trying to set or use.
1430 @node Displaying the current line or column
1431 @section How do I make Emacs display the current line (or column) number?
1432 @cindex @code{line-number-mode}
1433 @cindex Displaying the current line or column
1434 @cindex Line number, displaying the current
1435 @cindex Column, displaying the current
1436 @cindex @code{mode-line-format}
1438 By default, Emacs displays the current line number of the point in the
1439 mode line.  You can toggle this feature off or on with the command
1440 @kbd{M-x line-number-mode}, or by setting the variable
1441 @code{line-number-mode}.  Note that Emacs will not display the line
1442 number if the buffer's size in bytes is larger than the value of the
1443 variable @code{line-number-display-limit}.
1445 You can similarly display the current column with
1446 @kbd{M-x column-number-mode}, or by putting the form
1448 @lisp
1449 (setq column-number-mode t)
1450 @end lisp
1452 @noindent
1453 in your @file{.emacs} file.  This feature is off by default.
1455 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1456 will insert the current column's value into the mode line.  See the
1457 documentation for @code{mode-line-format} (using @kbd{C-h v
1458 mode-line-format @key{RET}}) for more information on how to set and use
1459 this variable.
1461 @cindex Set number capability in @code{vi} emulators
1462 The @samp{linum} package (distributed with Emacs since version 23.1)
1463 displays line numbers in the left margin, like the ``set number''
1464 capability of @code{vi}.  The packages @samp{setnu} and
1465 @samp{wb-line-number} (not distributed with Emacs) also implement this
1466 feature.
1468 @node Displaying the current file name in the titlebar
1469 @section How can I modify the titlebar to contain the current file name?
1470 @cindex Titlebar, displaying the current file name in
1471 @cindex File name, displaying in the titlebar
1472 @cindex @code{frame-title-format}
1474 The contents of an Emacs frame's titlebar is controlled by the variable
1475 @code{frame-title-format}, which has the same structure as the variable
1476 @code{mode-line-format}.  (Use @kbd{C-h v} or @kbd{M-x
1477 describe-variable} to get information about one or both of these
1478 variables.)
1480 By default, the titlebar for a frame does contain the name of the buffer
1481 currently being visited, except if there is a single frame.  In such a
1482 case, the titlebar contains Emacs invocation name and the name of the
1483 machine at which Emacs was invoked.  This is done by setting
1484 @code{frame-title-format} to the default value of
1486 @lisp
1487 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1488 @end lisp
1490 To modify the behavior such that frame titlebars contain the buffer's
1491 name regardless of the number of existing frames, include the following
1492 in your @file{.emacs}:
1494 @lisp
1495 (setq frame-title-format "%b")
1496 @end lisp
1498 @node Turning on abbrevs by default
1499 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1500 @cindex Abbrevs, turning on by default
1502 Abbrev mode expands abbreviations as you type them.  To turn it on in a
1503 specific buffer, use @kbd{M-x abbrev-mode}.  To turn it on in every
1504 buffer by default, put this in your @file{.emacs} file:
1506 @lisp
1507 (setq-default abbrev-mode t)
1508 @end lisp
1510 @noindent To turn it on in a specific mode, use:
1512 @lisp
1513 (add-hook '@var{mymode}-mode-hook
1514           (lambda ()
1515            (setq abbrev-mode t)))
1516 @end lisp
1518 @noindent If your Emacs version is older then 22.1, you will also need to use:
1520 @lisp
1521 (condition-case ()
1522    (quietly-read-abbrev-file)
1523   (file-error nil))
1524 @end lisp
1526 @node Associating modes with files
1527 @section How do I make Emacs use a certain major mode for certain files?
1528 @cindex Associating modes with files
1529 @cindex File extensions and modes
1530 @cindex @code{auto-mode-alist}, modifying
1531 @cindex Modes, associating with file extensions
1533 If you want to use a certain mode @var{foo} for all files whose names end
1534 with the extension @file{.@var{bar}}, this will do it for you:
1536 @lisp
1537 (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode))
1538 @end lisp
1540 Alternatively, put this somewhere in the first line of any file you want to
1541 edit in the mode @var{foo} (in the second line, if the first line begins
1542 with @samp{#!}):
1544 @example
1545 -*- @var{foo} -*-
1546 @end example
1548 @cindex Major mode for shell scripts
1549 The variable @code{interpreter-mode-alist} specifies which mode to use
1550 when loading an interpreted script (e.g., shell, python, etc.).  Emacs
1551 determines which interpreter you're using by examining the first line of
1552 the script.  Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on
1553 @code{interpreter-mode-alist} to learn more.
1555 @node Highlighting a region
1556 @section How can I highlight a region of text in Emacs?
1557 @cindex Highlighting text
1558 @cindex Text, highlighting
1559 @cindex @code{transient-mark-mode}
1560 @cindex Region, highlighting a
1562 You can cause the region to be highlighted when the mark is active by
1563 including
1565 @lisp
1566 (transient-mark-mode 1)
1567 @end lisp
1569 @noindent
1570 in your @file{.emacs} file.  Since Emacs 23.1, this feature is on by default.
1572 @node Replacing highlighted text
1573 @section How can I replace highlighted text with what I type?
1574 @cindex @code{delete-selection-mode}
1575 @cindex Replacing highlighted text
1576 @cindex Highlighting and replacing text
1578 Use @code{delete-selection-mode}, which you can start automatically by
1579 placing the following Lisp form in your @file{.emacs} file:
1581 @lisp
1582 (delete-selection-mode 1)
1583 @end lisp
1585 According to the documentation string for @code{delete-selection-mode}
1586 (which you can read using @kbd{M-x describe-function @key{RET}
1587 delete-selection-mode @key{RET}}):
1589 @quotation
1590 When Delete Selection mode is enabled, Transient Mark mode is also
1591 enabled and typed text replaces the selection if the selection is
1592 active.  Otherwise, typed text is just inserted at point regardless of
1593 any selection.
1594 @end quotation
1596 This mode also allows you to delete (not kill) the highlighted region by
1597 pressing @key{DEL}.
1599 @node Controlling case sensitivity
1600 @section How do I control Emacs's case-sensitivity when searching/replacing?
1601 @cindex @code{case-fold-search}
1602 @cindex Case sensitivity of searches
1603 @cindex Searching without case sensitivity
1604 @cindex Ignoring case in searches
1606 @c FIXME
1607 The value of the variable @code{case-fold-search} determines whether
1608 searches are case sensitive:
1610 @lisp
1611 (setq case-fold-search nil) ; make searches case sensitive
1612 (setq case-fold-search t)   ; make searches case insensitive
1613 @end lisp
1615 @cindex Case sensitivity in replacements
1616 @cindex Replacing, and case sensitivity
1617 @cindex @code{case-replace}
1618 Similarly, for replacing, the variable @code{case-replace} determines
1619 whether replacements preserve case.
1621 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1623 To change the case sensitivity just for one major mode, use the major
1624 mode's hook.  For example:
1626 @lisp
1627 (add-hook '@var{foo}-mode-hook
1628           (lambda ()
1629            (setq case-fold-search nil)))
1630 @end lisp
1632 @node Working with unprintable characters
1633 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1634 @cindex Unprintable characters, working with
1635 @cindex Working with unprintable characters
1636 @cindex Control characters, working with
1637 @cindex Eight-bit characters, working with
1638 @cindex Searching for unprintable characters
1639 @cindex Regexps and unprintable characters
1641 To search for a single character that appears in the buffer as, for
1642 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.
1643 Searching for @strong{all} unprintable characters is best done with a
1644 regular expression (@dfn{regexp}) search.  The easiest regexp to use for
1645 the unprintable chars is the complement of the regexp for the printable
1646 chars.
1648 @itemize @bullet
1650 @item
1651 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1653 @item
1654 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1656 @end itemize
1658 To type these special characters in an interactive argument to
1659 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1660 use @kbd{C-q}.  (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1661 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.)  So,
1662 to search for unprintable characters using @code{re-search-forward}:
1664 @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}}
1666 Using @code{isearch-forward-regexp}:
1668 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1670 To delete all unprintable characters, simply use replace-regexp:
1672 @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}}
1674 Replacing is similar to the above.  To replace all unprintable
1675 characters with a colon, use:
1677 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}
1679 @node Searching for/replacing newlines
1680 @section How do I input a newline character in isearch or query-replace?
1681 @cindex Searching for newlines
1682 @cindex Replacing newlines
1684 Use @kbd{C-q C-j}.  For more information,
1685 @pxref{Special Isearch,, Special Input for Incremental Search, emacs,
1686 The GNU Emacs Manual}.
1688 @node Yanking text in isearch
1689 @section How do I copy text from the kill ring into the search string?
1690 @cindex Yanking text into the search string
1691 @cindex isearch yanking
1693 Use @kbd{M-y}.  @xref{Isearch Yank,,, emacs, The GNU Emacs Manual}.
1695 @node Wrapping words automatically
1696 @section How do I make Emacs wrap words for me?
1697 @cindex Wrapping word automatically
1698 @cindex Wrapping lines
1699 @cindex Line wrap
1700 @cindex @code{auto-fill-mode}, introduction to
1701 @cindex Maximum line width, default value
1702 @cindex @code{fill-column}, default value
1704 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1705 The default maximum line width is 70, determined by the variable
1706 @code{fill-column}.  To learn how to turn this on automatically, see
1707 @ref{Turning on auto-fill by default}.
1709 @node Turning on auto-fill by default
1710 @section How do I turn on @code{auto-fill-mode} by default?
1711 @cindex @code{auto-fill-mode}, activating automatically
1712 @cindex Filling automatically
1713 @cindex Automatic entry to @code{auto-fill-mode}
1715 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1716 auto-fill-mode}.
1718 To turn it on for every buffer in a certain mode, you must use the hook
1719 for that mode.  For example, to turn on @code{auto-fill} mode for all
1720 text buffers, including the following in your @file{.emacs} file:
1722 @lisp
1723 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1724 @end lisp
1726 If you want @code{auto-fill} mode on in all major modes, do this:
1728 @lisp
1729 (setq-default auto-fill-function 'do-auto-fill)
1730 @end lisp
1732 @node Changing load-path
1733 @section How do I change @code{load-path}?
1734 @cindex @code{load-path}, modifying
1735 @cindex Modifying @code{load-path}
1736 @cindex Adding to @code{load-path}
1738 In general, you should only add to the @code{load-path}.  You can add
1739 directory @var{/dir/subdir} to the load path like this:
1741 @lisp
1742 (add-to-list 'load-path "/dir/subdir/")
1743 @end lisp
1745 To do this relative to your home directory:
1747 @lisp
1748 (add-to-list 'load-path "~/mysubdir/")
1749 @end lisp
1751 @node Using an already running Emacs process
1752 @section How do I use an already running Emacs from another window?
1753 @cindex @code{emacsclient}
1754 @cindex Emacs server functions
1755 @cindex Using an existing Emacs process
1757 @code{emacsclient}, which comes with Emacs, is for editing a file using
1758 an already running Emacs rather than starting up a new Emacs.  It does
1759 this by sending a request to the already running Emacs, which must be
1760 expecting the request.
1762 @itemize @bullet
1764 @item
1765 Setup:
1767 Emacs must have executed the @code{server-start} function for
1768 @samp{emacsclient} to work.  This can be done either by a command line
1769 option:
1771 @example
1772 emacs -f server-start
1773 @end example
1775 or by invoking @code{server-start} from @file{.emacs}:
1777 @lisp
1778 (if (@var{some conditions are met}) (server-start))
1779 @end lisp
1781 When this is done, Emacs creates a Unix domain socket named
1782 @file{server} in @file{/tmp/emacs@var{userid}}. See
1783 @code{server-socket-dir}.
1785 To get your news reader, mail reader, etc., to invoke
1786 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1787 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}.  You may
1788 have to specify the full pathname of the @samp{emacsclient} program
1789 instead.  Examples:
1791 @example
1792 # csh commands:
1793 setenv EDITOR emacsclient
1795 # using full pathname
1796 setenv EDITOR /usr/local/emacs/etc/emacsclient
1798 # sh command:
1799 EDITOR=emacsclient ; export EDITOR
1800 @end example
1802 @item
1803 Normal use:
1805 When @samp{emacsclient} is run, it connects to the socket and passes its
1806 command line options to Emacs, which at the next opportunity will visit
1807 the files specified.  (Line numbers can be specified just like with
1808 Emacs.)  The user will have to switch to the Emacs window by hand.  When
1809 the user is done editing a file, the user can type @kbd{C-x #} (or
1810 @kbd{M-x server-edit}) to indicate this.  If there is another buffer
1811 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1812 @code{emacsclient} will exit, signaling the calling program to continue.
1814 @cindex @code{gnuserv}
1815 There is an alternative version of @samp{emacsclient} called
1816 @c ange@@hplb.hpl.hp.com
1817 @samp{gnuserv}, written by Andy Norman
1818 (@pxref{Packages that do not come with Emacs}).  @samp{gnuserv} uses
1819 Internet domain sockets, so it can work across most network connections.
1821 The most recent @samp{gnuserv} package is available at
1823 @uref{http://meltin.net/hacks/emacs/}
1825 @end itemize
1827 @node Compiler error messages
1828 @section How do I make Emacs recognize my compiler's funny error messages?
1829 @cindex Compiler error messages, recognizing
1830 @cindex Recognizing non-standard compiler errors
1831 @cindex Regexps for recognizing compiler errors
1832 @cindex Errors, recognizing compiler
1834 Customize the @code{compilation-error-regexp-alist} variable.
1836 @node Indenting switch statements
1837 @section How do I change the indentation for @code{switch}?
1838 @cindex @code{switch}, indenting
1839 @cindex Indenting of @code{switch}
1841 Many people want to indent their @code{switch} statements like this:
1843 @example
1846   switch(x) @{
1847     case A:
1848       x1;
1849       break;
1850     case B:
1851       x2;
1852       break;
1853     default:
1854       x3;
1855   @}
1857 @end example
1859 @noindent To achieve this, add the following line to your @file{.emacs}:
1861 @lisp
1862 (c-set-offset 'case-label '+)
1863 @end lisp
1865 @node Customizing C and C++ indentation
1866 @section How to customize indentation in C, C@t{++}, and Java buffers?
1867 @cindex Indentation, how to customize
1868 @cindex Customize indentation
1870 The Emacs @code{cc-mode} features an interactive procedure for
1871 customizing the indentation style, which is fully explained in the
1872 @cite{CC Mode} manual that is part of the Emacs distribution, see
1873 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1874 The CC Mode Manual}.  Here's a short summary of the procedure:
1876 @enumerate
1877 @item
1878 Go to the beginning of the first line where you don't like the
1879 indentation and type @kbd{C-c C-o}.  Emacs will prompt you for the
1880 syntactic symbol; type @key{RET} to accept the default it suggests.
1882 @item
1883 Emacs now prompts for the offset of this syntactic symbol, showing the
1884 default (the current definition) inside parentheses.  You can choose
1885 one of these:
1887 @table @code
1888 @item 0
1889 No extra indentation.
1890 @item +
1891 Indent one basic offset.
1892 @item -
1893 Outdent one basic offset.
1894 @item ++
1895 Indent two basic offsets
1896 @item --
1897 Outdent two basic offsets.
1898 @item *
1899 Indent half basic offset.
1900 @item /
1901 Outdent half basic offset.
1902 @end table
1904 @item
1905 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1906 the line or the block according to what you just specified.
1908 @item
1909 If you don't like the result, go back to step 1.  Otherwise, add the
1910 following line to your @file{.emacs}:
1912 @lisp
1913 (c-set-offset '@var{syntactic-symbol} @var{offset})
1914 @end lisp
1916 @noindent
1917 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1918 when you type @kbd{C-c C-o} at the beginning of the line, and
1919 @var{offset} is one of the indentation symbols listed above (@code{+},
1920 @code{/}, @code{0}, etc.)@: that you've chosen during the interactive
1921 procedure.
1923 @item
1924 Go to the next line whose indentation is not to your liking and repeat
1925 the process there.
1926 @end enumerate
1928 It is recommended to put all the resulting @code{(c-set-offset ...)}
1929 customizations inside a C mode hook, like this:
1931 @lisp
1932 (defun my-c-mode-hook ()
1933   (c-set-offset ...)
1934   (c-set-offset ...))
1935 (add-hook 'c-mode-hook 'my-c-mode-hook)
1936 @end lisp
1938 @noindent
1939 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1940 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1941 might be unavailable when @code{cc-mode} is not loaded.
1943 Note that @code{c-mode-hook} runs for C source files only; use
1944 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1945 Java sources, etc.  If you want the same customizations to be in
1946 effect in @emph{all} languages supported by @code{cc-mode}, use
1947 @code{c-mode-common-hook}.
1949 @node Horizontal scrolling
1950 @section How can I make Emacs automatically scroll horizontally?
1951 @cindex @code{hscroll-mode}
1952 @cindex Horizontal scrolling
1953 @cindex Scrolling horizontally
1955 In Emacs 21 and later, this is on by default: if the variable
1956 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1957 automatically scrolls the display horizontally when point moves off the
1958 left or right edge of the window.
1960 Note that this is overridden by the variable
1961 @code{truncate-partial-width-windows} if that variable is non-nil
1962 and the current buffer is not full-frame width.
1964 In Emacs 20, use @code{hscroll-mode}.
1966 @node Overwrite mode
1967 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
1968 @cindex @key{Insert}
1969 @cindex @code{overwrite-mode}
1970 @cindex Overwriting existing text
1971 @cindex Toggling @code{overwrite-mode}
1973 @kbd{M-x overwrite-mode} (a minor mode).  This toggles
1974 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1975 is as easy as another @kbd{M-x overwrite-mode}.
1977 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1979 @node Turning off beeping
1980 @section How do I stop Emacs from beeping on a terminal?
1981 @cindex Beeping, turning off
1982 @cindex Visible bell
1983 @cindex Bell, visible
1985 @c martin@@cc.gatech.edu
1986 Martin R. Frank writes:
1988 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1989 and set the visible bell to nothing.
1991 That is, put the following in your @code{TERMCAP} environment variable
1992 (assuming you have one):
1994 @example
1995 ... :vb=: ...
1996 @end example
1998 And evaluate the following Lisp form:
2000 @example
2001 (setq visible-bell t)
2002 @end example
2004 @node Turning the volume down
2005 @section How do I turn down the bell volume in Emacs running under X?
2006 @cindex Bell, volume of
2007 @cindex Volume of bell
2009 On X Window system, you can adjust the bell volume and duration for all
2010 programs with the shell command @code{xset}.
2012 Invoking @code{xset} without any arguments produces some basic
2013 information, including the following:
2015 @example
2016 usage:  xset [-display host:dpy] option ...
2017   To turn bell off:
2018       -b                b off               b 0
2019   To set bell volume, pitch and duration:
2020        b [vol [pitch [dur]]]          b on
2021 @end example
2023 @node Automatic indentation
2024 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
2025 @cindex Indenting new lines
2026 @cindex New lines, indenting of
2027 @cindex Previous line, indenting according to
2028 @cindex Text indentation
2030 Such behavior is automatic (in Text mode) in Emacs 20 and later.  From the
2031 @file{etc/NEWS} file for Emacs 20.2:
2033 @example
2034 ** In Text mode, now only blank lines separate paragraphs.  This makes
2035 it possible to get the full benefit of Adaptive Fill mode in Text mode,
2036 and other modes derived from it (such as Mail mode).  @key{TAB} in Text
2037 mode now runs the command @code{indent-relative}; this makes a practical
2038 difference only when you use indented paragraphs.
2040 If you want spaces at the beginning of a line to start a paragraph, use
2041 the new mode, Paragraph Indent Text mode.
2042 @end example
2044 @cindex Prefixing lines
2045 @cindex Fill prefix
2046 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
2047 by default}), you can tell Emacs to prefix every line with a certain
2048 character sequence, the @dfn{fill prefix}.  Type the prefix at the
2049 beginning of a line, position point after it, and then type @kbd{C-x .}
2050 (@code{set-fill-prefix}) to set the fill prefix.  Thereafter,
2051 auto-filling will automatically put the fill prefix at the beginning of
2052 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
2053 prefix when refilling the paragraph.
2055 If you have paragraphs with different levels of indentation, you will
2056 have to set the fill prefix to the correct value each time you move to a
2057 new paragraph.  There are many packages available to deal with this
2058 (@pxref{Packages that do not come with Emacs}).  Look for ``fill'' and
2059 ``indent'' keywords for guidance.
2061 @node Matching parentheses
2062 @section How do I show which parenthesis matches the one I'm looking at?
2063 @cindex Parentheses, matching
2064 @cindex @file{paren.el}
2065 @cindex Highlighting matching parentheses
2066 @cindex Pairs of parentheses, highlighting
2067 @cindex Matching parentheses
2069 Call @code{show-paren-mode} in your @file{.emacs} file:
2071 @lisp
2072 (show-paren-mode 1)
2073 @end lisp
2075 You can also enable this mode by selecting the @samp{Paren Match
2076 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
2077 at the top of any Emacs frame.
2079 Alternatives to this mode include:
2081 @itemize @bullet
2083 @item
2084 If you're looking at a right parenthesis (or brace or bracket) you can
2085 delete it and reinsert it.  Emacs will momentarily move the cursor to
2086 the matching parenthesis.
2088 @item
2089 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2090 will skip over one set of balanced parentheses, so you can see which
2091 parentheses match.  (You can train it to skip over balanced brackets
2092 and braces at the same time by modifying the syntax table.)
2094 @cindex Show matching paren as in @code{vi}
2095 @item
2096 Here is some Emacs Lisp that will make the @key{%} key show the matching
2097 parenthesis, like in @code{vi}.  In addition, if the cursor isn't over a
2098 parenthesis, it simply inserts a % like normal.
2100 @lisp
2101 ;; By an unknown contributor
2103 (global-set-key "%" 'match-paren)
2105 (defun match-paren (arg)
2106   "Go to the matching paren if on a paren; otherwise insert %."
2107   (interactive "p")
2108   (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2109         ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2110         (t (self-insert-command (or arg 1)))))
2111 @end lisp
2113 @end itemize
2115 @node Hiding #ifdef lines
2116 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2117 @cindex @code{#ifdef}, selective display of
2118 @cindex @code{hide-ifdef-mode}
2119 @cindex Hiding @code{#ifdef} text
2120 @cindex Selectively displaying @code{#ifdef} code
2122 @kbd{M-x hide-ifdef-mode}.  (This is a minor mode.)  You might also want
2123 to investigate @file{cpp.el}, which is distributed with Emacs.
2125 @node Repeating commands
2126 @section How do I repeat a command as many times as possible?
2127 @cindex Repeating commands many times
2128 @cindex Commands, repeating many times
2129 @cindex @code{.}, equivalent to @code{vi} command
2131 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2132 that repeats the last command.  If you preface it with a prefix
2133 argument, the prefix arg is applied to the command.
2135 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2136 (@code{repeat-complex-command}) to reinvoke commands that used the
2137 minibuffer to get arguments.  In @code{repeat-complex-command} you can
2138 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2139 keyboard has these keys) to scan through all the different complex
2140 commands you've typed.
2142 To repeat a set of commands, use keyboard macros.  Use @kbd{C-x (} and
2143 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2144 type @kbd{C-x e}.  @xref{Keyboard Macros,,, emacs, The GNU Emacs Manual}.
2146 If you're really desperate for the @code{.} command in @code{vi} that
2147 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2148 mode which comes with Emacs, and which appears to support it.
2150 @node Valid X resources
2151 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2152 @cindex Resources, X
2153 @cindex X resources
2154 @cindex Setting X resources
2156 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2158 You can also use a resource editor, such as editres (for X11R5 and
2159 onwards), to look at the resource names for the menu bar, assuming Emacs
2160 was compiled with the X toolkit.
2162 @node Evaluating Emacs Lisp code
2163 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2164 @cindex Evaluating Lisp code
2165 @cindex Lisp forms, evaluating
2167 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2168 Emacs Lisp @dfn{form}:
2170 @itemize @bullet
2172 @item
2173 If you want it evaluated every time you run Emacs, put it in a file
2174 named @file{.emacs} in your home directory.  This is known as ``your
2175 @file{.emacs} file,'' and contains all of your personal customizations.
2177 @item
2178 You can type the form in the @file{*scratch*} buffer, and then type
2179 @key{LFD} (or @kbd{C-j}) after it.  The result of evaluating the form
2180 will be inserted in the buffer.
2182 @item
2183 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2184 before or around point.
2186 @item
2187 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2188 before point and prints its value in the echo area.
2190 @item
2191 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2192 form in the minibuffer which will be evaluated once you press @key{RET}.
2194 @item
2195 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2196 forms in a file.  (To do this from Lisp use the function @code{load}
2197 instead.)
2199 The functions @code{load-library}, @code{eval-region},
2200 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2201 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2202 about them.
2204 @end itemize
2206 @node Changing the length of a Tab
2207 @section How do I change Emacs's idea of the @key{TAB} character's length?
2208 @cindex Tab length
2209 @cindex Length of tab character
2211 Set the default value of the variable @code{tab-width}.  For example, to set
2212 @key{TAB} stops every 10 characters, insert the following in your
2213 @file{.emacs} file:
2215 @lisp
2216 (setq-default tab-width 10)
2217 @end lisp
2219 Do not confuse variable @code{tab-width} with variable
2220 @code{tab-stop-list}.  The former is used for the display of literal
2221 @key{TAB} characters.  The latter controls what characters are inserted
2222 when you press the @key{TAB} character in certain modes.
2224 @node Inserting text at the beginning of each line
2225 @section How do I insert <some text> at the beginning of every line?
2226 @cindex Prefixing a region with some text
2227 @cindex Prefix character, inserting in mail/news replies
2228 @cindex Replies to mail/news, inserting a prefix character
2229 @cindex @code{mail-yank-prefix}
2230 @cindex Mail replies, inserting a prefix character
2231 @cindex News replies, inserting a prefix character
2233 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2234 @key{RET} ^ @key{RET} your text @key{RET}}.
2236 To do this to a region, use @code{string-insert-rectangle}.
2237 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2238 want to prefix, move the cursor to last line to be prefixed, and type
2239 @kbd{M-x string-insert-rectangle @key{RET}}.  To do this for the whole
2240 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2242 If you are trying to prefix a yanked mail message with @samp{>}, you
2243 might want to set the variable @code{mail-yank-prefix}.  In Message
2244 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2245 runs the function @code{comment-region}, it is a general-purpose
2246 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2248 @node Forcing the cursor to remain in the same column
2249 @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?
2250 @cindex @code{picture-mode}
2251 @cindex Remaining in the same column, regardless of contents
2252 @cindex Vertical movement in empty documents
2254 Use @kbd{M-x picture-mode}.
2256 See also the variable @code{track-eol} and the command
2257 @code{set-goal-column} bound to @kbd{C-x C-n}
2258 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2260 @node Forcing Emacs to iconify itself
2261 @section How do I tell Emacs to iconify itself?
2262 @cindex Iconification under the X Window System
2263 @cindex X Window System and iconification
2264 @cindex Suspending Emacs
2266 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2267 otherwise.  @xref{Frame Commands,,, emacs, The GNU Emacs Manual}.
2269 @node Using regular expressions
2270 @section How do I use regexps (regular expressions) in Emacs?
2271 @cindex Regexps
2272 @cindex Regular expressions
2273 @cindex Differences between Unix and Emacs regexps
2274 @cindex Unix regexps, differences from Emacs
2275 @cindex Text strings, putting regexps in
2277 @xref{Regexp Backslash,,, emacs, The GNU Emacs Manual}.
2279 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2280 are @samp{\(} and @samp{\)}.  Also, the string syntax for a backslash is
2281 @samp{\\}.  To specify a regular expression like @samp{xxx\(foo\|bar\)}
2282 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2284 Note the doubled backslashes!
2286 @itemize @bullet
2288 @item
2289 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2290 (@samp{[^...]})  can match a newline character (@key{LFD} a.k.a.@:
2291 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2292 characters not to match.
2294 @item
2295 The character syntax regexps (e.g., @samp{\sw}) are not
2296 meaningful inside character set regexps (e.g., @samp{[aeiou]}).  (This
2297 is actually typical for regexp syntax.)
2299 @end itemize
2301 @node Replacing text across multiple files
2302 @section How do I perform a replace operation across more than one file?
2303 @cindex Replacing strings across files
2304 @cindex Multiple files, replacing across
2305 @cindex Files, replacing strings across multiple
2306 @cindex Recursive search/replace operations
2308 Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the
2309 command @code{dired-do-query-replace-regexp} (@kbd{Q}), which allows
2310 users to replace regular expressions in multiple files.
2312 You can use this command to perform search/replace operations on
2313 multiple files by following the following steps:
2315 @itemize @bullet
2316 @item
2317 Assemble a list of files you want to operate on with either
2318 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2320 @item
2321 Mark all files in the resulting Dired buffer using @kbd{t}.
2323 @item
2324 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2325 files.
2327 @item
2328 To accept all replacements in each file, hit @kbd{!}.
2329 @end itemize
2331 Another way to do the same thing is to use the ``tags'' feature of
2332 Emacs: it includes the command @code{tags-query-replace} which performs
2333 a query-replace across all the files mentioned in the @file{TAGS} file.
2334 @xref{Tags Search,,, emacs, The GNU Emacs Manual}.
2336 @node Documentation for etags
2337 @section Where is the documentation for @code{etags}?
2338 @cindex Documentation for @code{etags}
2339 @cindex @code{etags}, documentation for
2341 The @code{etags} man page should be in the same place as the
2342 @code{emacs} man page.
2344 Quick command-line switch descriptions are also available.  For example,
2345 @samp{etags -H}.
2347 @node Disabling backups
2348 @section How do I disable backup files?
2349 @cindex Backups, disabling
2350 @cindex Disabling backups
2352 You probably don't want to do this, since backups are useful, especially
2353 when something goes wrong.
2355 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2356 load @code{dired-x} by adding the following to your @file{.emacs} file:
2358 @lisp
2359 (add-hook 'dired-load-hook
2360           (lambda ()
2361            (require 'dired-x)))
2362 @end lisp
2364 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2365 You can make omitting the default for new dired buffers by putting the
2366 following in your @file{.emacs}:
2368 @lisp
2369 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2370 @end lisp
2372 If you're tired of seeing backup files whenever you do an @samp{ls} at
2373 the Unix shell, try GNU @code{ls} with the @samp{-B} option.  GNU
2374 @code{ls} is part of the GNU Fileutils package, available from
2375 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2377 To disable or change the way backups are made,
2378 @pxref{Backup Names,,, emacs, The GNU Emacs Manual}.
2380 @cindex Backup files in a single directory
2381 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2382 by customizing the variable @code{backup-directory-alist}.  This
2383 variable's value specifies that files whose names match specific patters
2384 should have their backups put in certain directories.  A typical use is
2385 to add the element @code{("." . @var{dir})} to force Emacs to put
2386 @strong{all} backup files in the directory @file{dir}.
2388 @node Disabling auto-save-mode
2389 @section How do I disable @code{auto-save-mode}?
2390 @cindex Disabling @code{auto-save-mode}
2391 @cindex Auto-saving
2392 @cindex Saving at frequent intervals
2394 You probably don't want to do this, since auto-saving is useful,
2395 especially when Emacs or your computer crashes while you are editing a
2396 document.
2398 Instead, you might want to change the variable
2399 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2400 waits before auto-saving.  Increasing this value forces Emacs to wait
2401 longer between auto-saves, which might annoy you less.
2403 You might also want to look into Sebastian Kremer's @code{auto-save}
2404 package (@pxref{Packages that do not come with Emacs}).  This
2405 package also allows you to place all auto-save files in one directory,
2406 such as @file{/tmp}.
2408 To disable or change how @code{auto-save-mode} works,
2409 @pxref{Auto Save,,, emacs, The GNU Emacs Manual}.
2411 @node Going to a line by number
2412 @section How can I go to a certain line given its number?
2413 @cindex Going to a line by number
2414 @cindex Compilation error messages
2415 @cindex Recompilation
2417 Are you sure you indeed need to go to a line by its number?  Perhaps all
2418 you want is to display a line in your source file for which a compiler
2419 printed an error message?  If so, compiling from within Emacs using the
2420 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2421 effective way of doing that.  Emacs automatically intercepts the compile
2422 error messages, inserts them into a special buffer called
2423 @code{*compilation*}, and lets you visit the locus of each message in
2424 the source.  Type @kbd{C-x `} to step through the offending lines one by
2425 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2426 @kbd{M-g M-n} to go to the previous and next matches directly).  Click
2427 @kbd{Mouse-2} or press @key{RET} on a message text in the
2428 @code{*compilation*} buffer to go to the line whose number is mentioned
2429 in that message.
2431 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2432 (which is the default binding of the @code{goto-line} function starting
2433 with Emacs 22).  Emacs will prompt you for the number of the line and go
2434 to that line.
2436 You can do this faster by invoking @code{goto-line} with a numeric
2437 argument that is the line's number.  For example, @kbd{C-u 286 M-g M-g}
2438 will jump to line number 286 in the current buffer.
2440 @node Modifying pull-down menus
2441 @section How can I create or modify new pull-down menu options?
2442 @cindex Pull-down menus, creating or modifying
2443 @cindex Menus, creating or modifying
2444 @cindex Creating new menu options
2445 @cindex Modifying pull-down menus
2446 @cindex Menus and keymaps
2447 @cindex Keymaps and menus
2449 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2450 represents a local or global keymap.  Selecting a menu title with the
2451 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2453 So to add a menu option to an existing menu, all you have to do is add a
2454 new definition to the appropriate keymap.  Adding a @samp{Forward Word}
2455 item to the @samp{Edit} menu thus requires the following Lisp code:
2457 @lisp
2458 (define-key global-map
2459   [menu-bar edit forward]
2460   '("Forward word" . forward-word))
2461 @end lisp
2463 @noindent
2464 The first line adds the entry to the global keymap, which includes
2465 global menu bar entries.  Replacing the reference to @code{global-map}
2466 with a local keymap would add this menu option only within a particular
2467 mode.
2469 The second line describes the path from the menu-bar to the new entry.
2470 Placing this menu entry underneath the @samp{File} menu would mean
2471 changing the word @code{edit} in the second line to @code{file}.
2473 The third line is a cons cell whose first element is the title that will
2474 be displayed, and whose second element is the function that will be
2475 called when that menu option is invoked.
2477 To add a new menu, rather than a new option to an existing menu, we must
2478 define an entirely new keymap:
2480 @lisp
2481 (define-key global-map [menu-bar words]
2482   (cons "Words" (make-sparse-keymap "Words")))
2483 @end lisp
2485 The above code creates a new sparse keymap, gives it the name
2486 @samp{Words}, and attaches it to the global menu bar.  Adding the
2487 @samp{Forward Word} item to this new menu would thus require the
2488 following code:
2490 @lisp
2491 (define-key global-map
2492   [menu-bar words forward]
2493   '("Forward word" . forward-word))
2494 @end lisp
2496 @noindent
2497 Note that because of the way keymaps work, menu options are displayed
2498 with the more recently defined items at the top.  Thus if you were to
2499 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2500 order), the menu option @samp{baz} would appear at the top, and
2501 @samp{foo} would be at the bottom.
2503 One way to avoid this problem is to use the function @code{define-key-after},
2504 which works the same as @code{define-key}, but lets you modify where items
2505 appear.  The following Lisp code would insert the @samp{Forward Word}
2506 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2508 @lisp
2509 (define-key-after
2510   (lookup-key global-map [menu-bar edit])
2511   [forward]
2512   '("Forward word" . forward-word)
2513   'undo)
2514 @end lisp
2516 Note how the second and third arguments to @code{define-key-after} are
2517 different from those of @code{define-key}, and that we have added a new
2518 (final) argument, the function after which our new key should be
2519 defined.
2521 To move a menu option from one position to another, simply evaluate
2522 @code{define-key-after} with the appropriate final argument.
2524 More detailed information---and more examples of how to create and
2525 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2526 ``Menu Keymaps.''  (@xref{Emacs Lisp documentation}, for information on
2527 this manual.)
2529 @node Deleting menus and menu options
2530 @section How do I delete menus and menu options?
2531 @cindex Deleting menus and menu options
2532 @cindex Menus, deleting
2534 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2535 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2536 menus}), use:
2538 @lisp
2539 (define-key global-map [menu-bar words] nil)
2540 @end lisp
2542 Similarly, removing a menu option requires redefining a keymap entry to
2543 @code{nil}.  For example, to delete the @samp{Forward word} menu option
2544 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2545 menus}), use:
2547 @lisp
2548 (define-key global-map [menu-bar edit forward] nil)
2549 @end lisp
2551 @node Turning on syntax highlighting
2552 @section How do I turn on syntax highlighting?
2553 @cindex Syntax highlighting
2554 @cindex @code{font-lock-mode}
2555 @cindex Highlighting based on syntax
2556 @cindex Colorizing text
2557 @cindex FAQ, @code{font-lock-mode}
2559 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2560 highlighting in the current buffer.  It is enabled by default in Emacs
2561 22.1 and later.
2563 With @code{font-lock-mode} turned on, different types of text will
2564 appear in different colors.  For instance, in a programming mode,
2565 variables will appear in one face, keywords in a second, and comments in
2566 a third.
2568 To turn @code{font-lock-mode} off within an existing buffer, use
2569 @kbd{M-x font-lock-mode @key{RET}}.
2571 In Emacs 21 and earlier versions, you could use the following code in
2572 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2574 @lisp
2575 (global-font-lock-mode 1)
2576 @end lisp
2578 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2579 and cause an annoying delay in display, so several features exist to
2580 work around this.
2582 @cindex Just-In-Time syntax highlighting
2583 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2584 activates the new @dfn{Just-In-Time fontification} provided by
2585 @code{jit-lock-mode}.  @code{jit-lock-mode} defers the fontification of
2586 portions of buffer until you actually need to see them, and can also
2587 fontify while Emacs is idle.  This makes display of the visible portion
2588 of a buffer almost instantaneous.  For details about customizing
2589 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2591 @cindex Levels of syntax highlighting
2592 @cindex Decoration level, in @code{font-lock-mode}
2593 In versions of Emacs before 21, different levels of decoration are
2594 available, from slight to gaudy.  More decoration means you need to wait
2595 more time for a buffer to be fontified (or a faster machine).  To
2596 control how decorated your buffers should become, set the value of
2597 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2598 @code{nil} value indicating default (usually minimum) decoration, and a
2599 @code{t} value indicating the maximum decoration.  For the gaudiest
2600 possible look, then, include the line
2602 @lisp
2603 (setq font-lock-maximum-decoration t)
2604 @end lisp
2606 @noindent
2607 in your @file{.emacs} file.  You can also set this variable such that
2608 different modes are highlighted in a different ways; for more
2609 information, see the documentation for
2610 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2611 describe-variable @key{RET}}).
2613 Also see the documentation for the function @code{font-lock-mode},
2614 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2615 describe-function @key{RET} font-lock-mode @key{RET}}).
2617 To print buffers with the faces (i.e., colors and fonts) intact, use
2618 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2619 ps-print-region-with-faces}.  You will need a way to send text to a
2620 PostScript printer, or a PostScript interpreter such as Ghostscript;
2621 consult the documentation of the variables @code{ps-printer-name},
2622 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2624 @node Scrolling only one line
2625 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2626 @cindex Scrolling only one line
2627 @cindex Reducing the increment when scrolling
2629 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2630 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2631 to a large value like, say, 10000.  For an explanation of what this
2632 means, @pxref{Auto Scrolling,,, emacs, The GNU Emacs Manual}.
2634 Alternatively, use the following Lisp form in your @file{.emacs}:
2636 @lisp
2637 (setq scroll-conservatively most-positive-fixnum)
2638 @end lisp
2640 @node Editing MS-DOS files
2641 @section How can I edit MS-DOS files using Emacs?
2642 @cindex Editing MS-DOS files
2643 @cindex MS-DOS files, editing
2644 @cindex Microsoft files, editing
2645 @cindex Windows files, editing
2647 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2648 performed transparently.  You can open MS-DOS files on a Unix system,
2649 edit it, and save it without having to worry about the file format.
2651 When editing an MS-DOS style file, the mode line will indicate that it
2652 is a DOS file.  On Unix and GNU/Linux systems, and also on a Macintosh,
2653 the string @samp{(DOS)} will appear near the left edge of the mode line;
2654 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2655 default, a backslash (@samp{\}) will appear in the mode line.
2657 @node Filling paragraphs with a single space
2658 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2659 @cindex One space following periods
2660 @cindex Single space following periods
2661 @cindex Periods, one space following
2663 Add the following line to your @file{.emacs} file:
2665 @lisp
2666 (setq sentence-end-double-space nil)
2667 @end lisp
2669 @node Escape sequences in shell output
2670 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2671 @cindex Escape sequences in @code{ls} output
2672 @cindex @code{ls} in Shell mode
2674 In many systems, @code{ls} is aliased to @samp{ls --color}, which
2675 prints using ANSI color escape sequences.  Emacs version 21.1 and
2676 later includes the @code{ansi-color} package, which lets Shell mode
2677 recognize these escape sequences.  In Emacs 23.2 and later, the
2678 package is enabled by default; in earlier versions you can enable it
2679 by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2680 by adding @code{(add-hook 'shell-mode-hook
2681 'ansi-color-for-comint-mode-on)} to your init file.
2683 In Emacs versions before 21.1, the @code{ansi-color} package is not
2684 included.  In that case, you need to unalias @code{ls} for interactive
2685 shells running in Emacs; this can be done by checking the @code{EMACS}
2686 variable in the environment.
2688 @node Fullscreen mode on MS-Windows
2689 @section How can I start Emacs in fullscreen mode on MS-Windows?
2690 @cindex Maximize frame
2691 @cindex Fullscreen mode
2693 Use the function @code{w32-send-sys-command}.  For example, you can
2694 put the following in your @file{.emacs} file:
2696 @lisp
2697 (add-hook 'term-setup-hook
2698           #'(lambda () (w32-send-sys-command ?\xF030)))
2699 @end lisp
2701 To avoid the slightly distracting visual effect of Emacs starting with
2702 its default frame size and then growing to fullscreen, you can add an
2703 @samp{Emacs.Geometry} entry to the Windows registry settings.
2704 @xref{X Resources,,, emacs, The GNU Emacs Manual}.
2706 To compute the correct values for width and height, first maximize the
2707 Emacs frame and then evaluate @code{(frame-height)} and
2708 @code{(frame-width)} with @kbd{M-:}.
2710 @c ------------------------------------------------------------
2711 @node Bugs and problems
2712 @chapter Bugs and problems
2713 @cindex Bugs and problems
2715 The Emacs manual lists some common kinds of trouble users could get
2716 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2717 Emacs Manual}, so you might look there if the problem you encounter
2718 isn't described in this chapter.  If you decide you've discovered a bug,
2719 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2720 instructions how to do that.
2722 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2723 known problems with building and using Emacs on specific platforms;
2724 type @kbd{C-h C-p} to read it.
2726 @menu
2727 * Problems with very large files::
2728 * ^M in the shell buffer::
2729 * Problems with Shell Mode::
2730 * Termcap/Terminfo entries for Emacs::
2731 * Errors with init files::
2732 * Emacs ignores X resources::
2733 * Emacs ignores frame parameters::
2734 * Editing files with $ in the name::
2735 * Shell mode loses the current directory::
2736 * Security risks with Emacs::
2737 * Dired claims that no file is on this line::
2738 @end menu
2740 @node Problems with very large files
2741 @section Does Emacs have problems with files larger than 8 megabytes?
2742 @cindex Very large files, opening
2743 @cindex Large files, opening
2744 @cindex Opening very large files
2745 @cindex Maximum file size
2746 @cindex Files, maximum size
2748 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2749 files larger than 8 megabytes.  In versions 19.29 and later, the maximum
2750 buffer size is at least 2^27@minus{}1, or 134,217,727 bytes, or 132 MBytes.
2751 The maximum buffer size on 32-bit machines increased to 256 MBytes in
2752 Emacs 22, and again to 512 MBytes in Emacs 23.2.
2754 Emacs compiled on a 64-bit machine can handle much larger buffers.
2756 @node ^M in the shell buffer
2757 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2758 @cindex Shell buffer, echoed commands and @samp{^M} in
2759 @cindex Echoed commands in @code{shell-mode}
2761 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2762 make them go away.  If that doesn't work, you have several options:
2764 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2765 file:
2767 @example
2768 if ($?EMACS) then
2769     if ("$EMACS" =~ /*) then
2770         if ($?tcsh) unset edit
2771         stty nl
2772     endif
2773 endif
2774 @end example
2776 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2778 @example
2779 unset edit
2780 stty nl
2781 @end example
2783 Alternatively, use @code{csh} in your shell buffers instead of
2784 @code{tcsh}.  One way is:
2786 @lisp
2787 (setq explicit-shell-file-name "/bin/csh")
2788 @end lisp
2790 @noindent
2791 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2792 file:
2794 @example
2795 setenv ESHELL /bin/csh
2796 @end example
2798 @noindent
2799 (You must start Emacs over again with the environment variable properly
2800 set for this to take effect.)
2802 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2803 with the following Lisp form,
2805 @lisp
2806 (setenv "ESHELL" "/bin/csh")
2807 @end lisp
2809 The above solutions try to prevent the shell from producing the
2810 @samp{^M} characters in the first place.  If this is not possible
2811 (e.g., if you use a Windows shell), you can get Emacs to remove these
2812 characters from the buffer by adding this to your @file{.emacs} init
2813 file:
2815 @smalllisp
2816 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2817 @end smalllisp
2819 On a related note: if your shell is echoing your input line in the shell
2820 buffer, you might want to customize the @code{comint-process-echoes}
2821 variable in your shell buffers, or try the following command in your
2822 shell start-up file:
2824 @example
2825 stty -icrnl -onlcr -echo susp ^Z
2826 @end example
2828 @node Problems with Shell Mode
2829 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2831 @cindex Shell Mode, problems
2832 @cindex @code{explicit-shell-file-name}
2833 This might happen because Emacs tries to look for the shell in a wrong
2834 place.  If you know where your shell executable is, set the variable
2835 @code{explicit-shell-file-name} in your @file{.emacs} file to point to
2836 its full file name.
2838 @cindex Antivirus programs, and Shell Mode
2839 Some people have trouble with Shell Mode on MS-Windows because of
2840 intrusive antivirus software; disabling the resident antivirus program
2841 solves the problems in those cases.
2843 @node Termcap/Terminfo entries for Emacs
2844 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2845 @cindex Termcap
2846 @cindex Terminfo
2847 @cindex Emacs entries for termcap/terminfo
2849 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2850 the @samp{TERMCAP} environment variable of subshells.  It may help in
2851 certain situations (e.g., using rlogin from shell buffer) to add an
2852 entry for @samp{emacs} to the system-wide termcap file.  Here is a
2853 correct termcap entry for @samp{emacs}:
2855 @example
2856 emacs:tc=unknown:
2857 @end example
2859 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2860 @code{captoinfo}.  You need to generate
2861 @file{/usr/lib/terminfo/e/emacs}.  It may work to simply copy
2862 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2864 Having a termcap/terminfo entry will not enable the use of full screen
2865 programs in shell buffers.  Use @kbd{M-x terminal-emulator} for that
2866 instead.
2868 A workaround to the problem of missing termcap/terminfo entries is to
2869 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2870 in your shell start up file.  @code{csh} users could put this in their
2871 @file{.cshrc} files:
2873 @example
2874 if ("$term" == emacs) set term=dumb
2875 @end example
2877 @node Errors with init files
2878 @section Why does Emacs say @samp{Error in init file}?
2879 @cindex Error in @file{.emacs}
2880 @cindex Error in init file
2881 @cindex Init file, errors in
2882 @cindex @file{.emacs} file, errors in
2883 @cindex Debugging @file{.emacs} file
2885 An error occurred while loading either your @file{.emacs} file or the
2886 system-wide file @file{site-lisp/default.el}.  Emacs 21.1 and later pops the
2887 @file{*Messages*} buffer, and puts there some additional information
2888 about the error, to provide some hints for debugging.
2890 For information on how to debug your @file{.emacs} file, see
2891 @ref{Debugging a customization file}.
2893 It may be the case that you need to load some package first, or use a
2894 hook that will be evaluated after the package is loaded.  A common case
2895 of this is explained in @ref{Terminal setup code works after Emacs has
2896 begun}.
2898 @node Emacs ignores X resources
2899 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
2900 @cindex X resources being ignored
2901 @cindex Ignored X resources
2902 @cindex @file{.Xdefaults}
2904 As of version 19, Emacs searches for X resources in the files specified
2905 by the following environment variables:
2907 @itemize @bullet
2909 @item @code{XFILESEARCHPATH}
2910 @item @code{XUSERFILESEARCHPATH}
2911 @item @code{XAPPLRESDIR}
2913 @end itemize
2915 This emulates the functionality provided by programs written using the
2916 Xt toolkit.
2918 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
2919 of file names separated by colons.  @code{XAPPLRESDIR} should be a list
2920 of directory names separated by colons.
2922 Emacs searches for X resources:
2924 @enumerate
2926 @item
2927 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
2929 @item
2930 then in the value of the @samp{XENVIRONMENT} environment variable,
2932 @itemize @minus
2934 @item
2935 or if that is unset, in the file named
2936 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
2937 the name of the machine Emacs is running on),
2939 @end itemize
2941 @item
2942 then in the screen-specific and server-wide resource properties provided
2943 by the server,
2945 @itemize @minus
2947 @item
2948 or if those properties are unset, in the file named @file{~/.Xdefaults}
2949 if it exists,
2951 @end itemize
2953 @item
2954 then in the files listed in @samp{XUSERFILESEARCHPATH},
2956 @itemize @minus
2958 @item
2959 or in files named @file{@var{lang}/Emacs} in directories listed in
2960 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
2961 environment variable), if the @samp{LANG} environment variable is set,
2962 @item
2963 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
2964 @item
2965 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
2966 is set),
2967 @item
2968 or in @file{~/Emacs},
2970 @end itemize
2972 @item
2973 then in the files listed in  @code{XFILESEARCHPATH}.
2975 @end enumerate
2977 @node Emacs ignores frame parameters
2978 @section Why don't my customizations of the frame parameters work?
2979 @cindex Frame parameters
2981 This probably happens because you have set the frame parameters in the
2982 variable @code{initial-frame-alist}.  That variable holds parameters
2983 used only for the first frame created when Emacs starts.  To customize
2984 the parameters of all frames, change the variable
2985 @code{default-frame-alist} instead.
2987 These two variables exist because many users customize the initial frame
2988 in a special way.  For example, you could determine the position and
2989 size of the initial frame, but would like to control the geometry of the
2990 other frames by individually positioning each one of them.
2993 @node Editing files with $ in the name
2994 @section How do I edit a file with a @samp{$} in its name?
2995 @cindex Editing files with @samp{$} in the name
2996 @cindex @samp{$} in file names
2997 @cindex File names containing @samp{$}, editing
2999 When entering a file name in the minibuffer, Emacs will attempt to expand
3000 a @samp{$} followed by a word as an environment variable.  To suppress
3001 this behavior, type @kbd{$$} instead.
3003 @node Shell mode loses the current directory
3004 @section Why does shell mode lose track of the shell's current directory?
3005 @cindex Current directory and @code{shell-mode}
3006 @cindex @code{shell-mode} and current directory
3007 @cindex Directory, current in @code{shell-mode}
3009 Emacs has no way of knowing when the shell actually changes its
3010 directory.  This is an intrinsic limitation of Unix.  So it tries to
3011 guess by recognizing @samp{cd} commands.  If you type @kbd{cd} followed
3012 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
3013 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
3014 correctly guess the shell's new current directory.  A huge variety of
3015 fixes and enhancements to shell mode for this problem have been written
3016 to handle this problem (@pxref{Finding a package with particular
3017 functionality}).
3019 You can tell Emacs the shell's current directory with the command
3020 @kbd{M-x dirs}.
3022 @node Security risks with Emacs
3023 @section Are there any security risks in Emacs?
3024 @cindex Security with Emacs
3025 @cindex @samp{movemail} and security
3026 @cindex @code{file-local-variable} and security
3027 @cindex Synthetic X events and security
3028 @cindex X events and security
3030 @itemize @bullet
3032 @item
3033 The @file{movemail} incident.  (No, this is not a risk.)
3035 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3036 chapter 4.  The site at LBL had installed the @file{/etc/movemail}
3037 program setuid root.  (As of version 19, @file{movemail} is in your
3038 architecture-specific directory; type @kbd{C-h v exec-directory
3039 @key{RET}} to see what it is.)  Since @code{movemail} had not been
3040 designed for this situation, a security hole was created and users could
3041 get root privileges.
3043 @code{movemail} has since been changed so that this security hole will
3044 not exist, even if it is installed setuid root.  However,
3045 @code{movemail} no longer needs to be installed setuid root, which
3046 should eliminate this particular risk.
3048 We have heard unverified reports that the 1988 Internet worm took
3049 advantage of this configuration problem.
3051 @item
3052 The @code{file-local-variable} feature.  (Yes, a risk, but easy to
3053 change.)
3055 There is an Emacs feature that allows the setting of local values for
3056 variables when editing a file by including specially formatted text near
3057 the end of the file.  This feature also includes the ability to have
3058 arbitrary Emacs Lisp code evaluated when the file is visited.
3059 Obviously, there is a potential for Trojan horses to exploit this
3060 feature.
3062 As of Emacs 22, Emacs has a list of local variables that are known to
3063 be safe to set.  If a file tries to set any variable outside this
3064 list, it asks the user to confirm whether the variables should be set.
3065 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
3066 code found at the bottom of files by setting the variable
3067 @code{enable-local-eval}.
3069 @xref{File Variables,,, emacs, The GNU Emacs Manual}.
3071 @item
3072 Synthetic X events.  (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3073 better.)
3075 Emacs accepts synthetic X events generated by the @code{SendEvent}
3076 request as though they were regular events.  As a result, if you are
3077 using the trivial host-based authentication, other users who can open X
3078 connections to your X workstation can make your Emacs process do
3079 anything, including run other processes with your privileges.
3081 The only fix for this is to prevent other users from being able to open
3082 X connections.  The standard way to prevent this is to use a real
3083 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}.  If using
3084 the @code{xauth} program has any effect, then you are probably using
3085 @samp{MIT-MAGIC-COOKIE-1}.  Your site may be using a superior
3086 authentication method; ask your system administrator.
3088 If real authentication is not a possibility, you may be satisfied by
3089 just allowing hosts access for brief intervals while you start your X
3090 programs, then removing the access.  This reduces the risk somewhat by
3091 narrowing the time window when hostile users would have access, but
3092 @emph{does not eliminate the risk}.
3094 On most computers running Unix and X, you enable and disable
3095 access using the @code{xhost} command.  To allow all hosts access to
3096 your X server, use
3098 @example
3099 xhost +
3100 @end example
3102 @noindent
3103 at the shell prompt, which (on an HP machine, at least) produces the
3104 following message:
3106 @example
3107 access control disabled, clients can connect from any host
3108 @end example
3110 To deny all hosts access to your X server (except those explicitly
3111 allowed by name), use
3113 @example
3114 xhost -
3115 @end example
3117 On the test HP computer, this command generated the following message:
3119 @example
3120 access control enabled, only authorized clients can connect
3121 @end example
3123 @end itemize
3125 @node Dired claims that no file is on this line
3126 @section Dired says, @samp{no file on this line} when I try to do something.
3127 @cindex Dired does not see a file
3129 Dired uses a regular expression to find the beginning of a file name.
3130 In a long Unix-style directory listing (@samp{ls -l}), the file name
3131 starts after the date.  The regexp has thus been written to look for the
3132 date.  By default, it should understand dates and times regardless of
3133 the language, but if your directory listing has an unusual format, Dired
3134 may get confused.
3136 There are two approaches to solving this.  The first one involves
3137 setting things up so that @samp{ls -l} outputs a more standard format.
3138 See your OS manual for more information.
3140 The second approach involves changing the regular expression used by
3141 dired, @code{directory-listing-before-filename-regexp}.
3143 @c ------------------------------------------------------------
3144 @node Compiling and installing Emacs
3145 @chapter    Compiling and installing Emacs
3146 @cindex    Compiling and installing Emacs
3148 @menu
3149 * Installing Emacs::
3150 * Problems building Emacs::
3151 @end menu
3153 @node Installing Emacs
3154 @section How do I install Emacs?
3155 @cindex Installing Emacs
3156 @cindex Unix systems, installing Emacs on
3157 @cindex Downloading and installing Emacs
3158 @cindex Building Emacs from source
3159 @cindex Source code, building Emacs from
3161 This answer is meant for users of Unix and Unix-like systems.  Users of
3162 other operating systems should see the series of questions beginning
3163 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3164 and binaries, and how to install Emacs on those systems.
3166 Most GNU/Linux distributions provide pre-built Emacs packages.
3167 If Emacs is not installed already, you can install it by running (as
3168 root) a command such as @samp{yum install emacs} (Red Hat and
3169 derivatives) or @samp{apt-get install emacs} (Debian and derivatives).
3171 If you want to compile Emacs yourself, read the file @file{INSTALL} in
3172 the source distribution.  In brief:
3174 @itemize @bullet
3176 @item
3177 First download the Emacs sources.  @xref{Current GNU distributions}, for
3178 a list of ftp sites that make them available.  On @file{ftp.gnu.org},
3179 the main GNU distribution site, sources are available as
3181 @c Don't include VER in the file name, because pretests are not there.
3182 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz}
3184 (Replace @samp{VERSION} with the relevant version number, e.g., @samp{23.1}.)
3186 @item
3187 Next uncompress and extract the source files.  This requires
3188 the @code{gzip} and @code{tar} programs, which are standard utilities.
3189 If your system does not have them, these can also be downloaded from
3190 @file{ftp.gnu.org}.
3192 GNU @code{tar} can uncompress and extract in a single-step:
3194 @example
3195 tar -zxvf emacs-VERSION.tar.gz
3196 @end example
3198 @item
3199 At this point, the Emacs sources should be sitting in a directory called
3200 @file{emacs-VERSION}.  On most common Unix and Unix-like systems,
3201 you should be able to compile Emacs with the following commands:
3203 @example
3204 cd emacs-VERSION
3205 ./configure         # configure Emacs for your particular system
3206 make                # use Makefile to build components, then Emacs
3207 @end example
3209 If the @code{make} completes successfully, the odds are fairly good that
3210 the build has gone well.  (@xref{Problems building Emacs}, if you weren't
3211 successful.)
3213 @item
3214 By default, Emacs is installed in @file{/usr/local}.  To actually
3215 install files, become the superuser and type
3217 @example
3218 make install
3219 @end example
3221 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3222 and any Emacs Info files that might be in @file{/usr/local/share/info/}.
3224 @end itemize
3226 @node Problems building Emacs
3227 @section What should I do if I have trouble building Emacs?
3228 @cindex Problems building Emacs
3229 @cindex Errors when building Emacs
3231 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3232 source) to see if there is already a solution for your problem.  Next,
3233 look for other questions in this FAQ that have to do with Emacs
3234 installation and compilation problems.
3236 If you'd like to have someone look at your problem and help solve it,
3237 see @ref{Help installing Emacs}.
3239 If you cannot find a solution in the documentation, please report the
3240 problem (@pxref{Reporting bugs}).
3243 @c ------------------------------------------------------------
3244 @node Finding Emacs and related packages
3245 @chapter Finding Emacs and related packages
3246 @cindex Finding Emacs and related packages
3248 @menu
3249 * Finding Emacs on the Internet::
3250 * Finding a package with particular functionality::
3251 * Packages that do not come with Emacs::
3252 * Spell-checkers::
3253 * Current GNU distributions::
3254 * Difference between Emacs and XEmacs::
3255 * Emacs for minimalists::
3256 * Emacs for MS-DOS::
3257 * Emacs for MS-Windows::
3258 * Emacs for GNUstep::
3259 * Emacs for Mac OS X::
3260 @end menu
3262 @node Finding Emacs on the Internet
3263 @section Where can I get Emacs on the net?
3264 @cindex Finding Emacs on the Internet
3265 @cindex Downloading Emacs
3267 Information on downloading Emacs is available at
3268 @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}.
3270 @xref{Installing Emacs}, for information on how to obtain and build the latest
3271 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3272 archive sites that make GNU software available.
3274 @node Finding a package with particular functionality
3275 @section How do I find a Emacs Lisp package that does XXX?
3276 @cindex Package, finding
3277 @cindex Finding an Emacs Lisp package
3278 @cindex Functionality, finding a particular package
3280 First of all, you should check to make sure that the package isn't
3281 already available.  For example, typing @kbd{M-x apropos @key{RET}
3282 wordstar @key{RET}} lists all functions and variables containing the
3283 string @samp{wordstar}.
3285 It is also possible that the package is on your system, but has not been
3286 loaded.  To see which packages are available for loading, look through
3287 your computer's lisp directory (@pxref{File-name conventions}).  The Lisp
3288 source to most packages contains a short description of how they
3289 should be loaded, invoked, and configured---so before you use or
3290 modify a Lisp package, see if the author has provided any hints in the
3291 source code.
3293 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3294 the constituent Emacs packages.
3296 For advice on how to find extra packages that are not part of Emacs,
3297 see @ref{Packages that do not come with Emacs}.
3299 @node Packages that do not come with Emacs
3300 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3301 @cindex Unbundled packages
3302 @cindex Finding other packages
3303 @cindex Lisp packages that do not come with Emacs
3304 @cindex Packages, those that do not come with Emacs
3305 @cindex Emacs Lisp List
3306 @cindex Emacs Lisp Archive
3308 Your first port of call should be the @kbd{M-x list-packages} command.
3309 This connects to the @uref{http:///elpa.gnu.org, GNU ELPA} (``Emacs
3310 Lisp Package Archive'') server and fetches the list of additional
3311 packages that it offers.  These are GNU packages that are available
3312 for use with Emacs, but are distributed separately.  Select a package
3313 to get more details about the features that it offers, and then if you
3314 wish, Emacs can download and automatically install it for you.
3316 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs Lisp
3317 List (ELL)}, maintained by Stephen Eglen,
3318 aims to provide one compact list with links to all of the current Emacs
3319 Lisp files on the Internet.  The ELL can be browsed over the web, or
3320 from Emacs with @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.el,
3321 the @file{ell} package}.
3323 Many authors post their packages to the @uref{news:gnu.emacs.sources,
3324 Emacs sources newsgroup}.  You can search the archives of this
3325 group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google},
3326 or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example.
3328 Several packages are stored in
3329 @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}.
3331 Read the file @file{etc/MORE.STUFF} for more information about
3332 external packages.
3334 @node Spell-checkers
3335 @section Spell-checkers
3336 @cindex Spell-checker
3337 @cindex Checking spelling
3338 @cindex Ispell
3339 @cindex Aspell
3340 @cindex Hunspell
3342 Various spell-checkers are compatible with Emacs, including:
3344 @table @b
3346 @item GNU Aspell
3347 @uref{http://aspell.net/}
3349 @item Ispell
3350 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3352 @item Hunspell
3353 @uref{http://hunspell.sourceforge.net/}
3355 @end table
3357 @node Current GNU distributions
3358 @section Where can I get other up-to-date GNU stuff?
3359 @cindex Current GNU distributions
3360 @cindex Sources for current GNU distributions
3361 @cindex Stuff, current GNU
3362 @cindex Up-to-date GNU stuff
3363 @cindex Finding current GNU software
3364 @cindex Official GNU software sites
3366 The most up-to-date official GNU software is normally kept at
3368 @uref{ftp://ftp.gnu.org/pub/gnu}
3370 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3372 @uref{http://www.gnu.org/order/ftp.html}
3374 @node Difference between Emacs and XEmacs
3375 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3376 @cindex XEmacs
3377 @cindex Difference Emacs and XEmacs
3378 @cindex Lucid Emacs
3379 @cindex Epoch
3381 XEmacs is a branch version of Emacs.  It was first called Lucid Emacs,
3382 and was initially derived from a prerelease version of Emacs 19.  In
3383 this FAQ, we use the name ``Emacs'' only for the official version.
3385 Emacs and XEmacs each come with Lisp packages that are lacking in the
3386 other.  The two versions have some significant differences at the Lisp
3387 programming level.  Their current features are roughly comparable,
3388 though the support for some operating systems, character sets and
3389 specific packages might be quite different.
3391 Some XEmacs code has been contributed to Emacs, and we would like to
3392 use other parts, but the earlier XEmacs maintainers did not always
3393 keep track of the authors of contributed code, which makes it
3394 impossible for the FSF to get copyright papers signed for that code.
3395 (The FSF requires these papers for all the code included in the Emacs
3396 release, aside from generic C support packages that retain their
3397 separate identity and are not integrated into the code of Emacs
3398 proper.)
3400 If you want to talk about these two versions and distinguish them,
3401 please call them ``Emacs'' and ``XEmacs.''  To contrast ``XEmacs''
3402 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3403 origin in the work of the GNU Project.  Terms such as ``Emacsen'' and
3404 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3405 is better to write ``Emacs and XEmacs.''
3407 @node Emacs for minimalists
3408 @section I don't have enough disk space to install Emacs
3409 @cindex Zile
3410 @cindex Not enough disk space to install Emacs
3412 GNU Zile is a lightweight Emacs clone.  Zile is short for @samp{Zile Is
3413 Lossy Emacs}.  It has all of Emacs's basic editing features.  The Zile
3414 binary typically has a size of about 130 kbytes, so this can be useful
3415 if you are in an extremely space-restricted environment.  More
3416 information is available from
3418 @uref{http://www.gnu.org/software/zile/}
3421 @node Emacs for MS-DOS
3422 @section Where can I get Emacs for MS-DOS?
3423 @cindex MS-DOS, Emacs for
3424 @cindex DOS, Emacs for
3425 @cindex Compiling Emacs for DOS
3426 @cindex Emacs for MS-DOS
3428 To build Emacs from source for MS-DOS, see the instructions in the file
3429 @file{msdos/INSTALL} in the distribution.  The DOS port builds and runs
3430 on plain DOS, and also on all versions of MS-Windows from version 3.X
3431 onwards, including Windows XP and Vista.
3433 The file @file{etc/PROBLEMS} contains some additional information
3434 regarding Emacs under MS-DOS.
3436 A pre-built binary distribution of the old Emacs 20 is available, as
3437 described at
3439 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3441 For a list of other MS-DOS implementations of Emacs (and Emacs
3442 look-alikes), consult the list of ``Emacs implementations and literature,''
3443 available at
3445 @uref{http://www.finseth.com/emacs.html}
3447 Note that while many of these programs look similar to Emacs, they often
3448 lack certain features, such as the Emacs Lisp extension language.
3450 @node Emacs for MS-Windows
3451 @section Where can I get Emacs for Microsoft Windows?
3452 @cindex FAQ for Emacs on MS-Windows
3453 @cindex Emacs for MS-Windows
3454 @cindex Microsoft Windows, Emacs for
3456 There is a @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html,
3457 separate FAQ} for Emacs on MS-Windows.  For MS-DOS, @pxref{Emacs for MS-DOS}.
3460 @node Emacs for GNUstep
3461 @section Where can I get Emacs for GNUstep?
3462 @cindex GNUstep, Emacs for
3464 Beginning with version 23.1, Emacs supports GNUstep natively.
3465 See the file @file{nextstep/INSTALL} in the distribution.
3467 @node Emacs for Mac OS X
3468 @section Where can I get Emacs for Mac OS X?
3469 @cindex Apple computers, Emacs for
3470 @cindex Macintosh, Emacs for
3471 @cindex Mac OS X, Emacs for
3473 Beginning with version 22.1, Emacs supports Mac OS X natively.
3474 See the file @file{nextstep/INSTALL} in the distribution.
3476 @c ------------------------------------------------------------
3477 @node Key bindings
3478 @chapter Key bindings
3479 @cindex Key bindings
3481 @menu
3482 * Binding keys to commands::
3483 * Invalid prefix characters::
3484 * Terminal setup code works after Emacs has begun::
3485 * Working with function and arrow keys::
3486 * X key translations for Emacs::
3487 * Backspace invokes help::
3488 * Swapping keys::
3489 * Producing C-XXX with the keyboard::
3490 * No Meta key::
3491 * No Escape key::
3492 * Compose Character::
3493 * Binding combinations of modifiers and function keys::
3494 * Meta key does not work in xterm::
3495 * ExtendChar key does not work as Meta::
3496 * SPC no longer completes file names::
3497 @end menu
3499 @node Binding keys to commands
3500 @section How do I bind keys (including function keys) to commands?
3501 @cindex Binding keys to commands
3502 @cindex Keys, binding to commands
3503 @cindex Commands, binding keys to
3505 Keys can be bound to commands either interactively or in your
3506 @file{.emacs} file.  To interactively bind keys for all modes, type
3507 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3509 To bind a key just in the current major mode, type @kbd{M-x
3510 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3512 @xref{Key Bindings,,, emacs, The GNU Emacs Manual}.
3514 To make the process of binding keys interactively easier, use the
3515 following ``trick'': First bind the key interactively, then immediately
3516 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}.  Now, the command needed
3517 to bind the key is in the kill ring, and can be yanked into your
3518 @file{.emacs} file.  If the key binding is global, no changes to the
3519 command are required.  For example,
3521 @lisp
3522 (global-set-key (quote [f1]) (quote help-for-help))
3523 @end lisp
3525 @noindent
3526 can be placed directly into the @file{.emacs} file.  If the key binding is
3527 local, the command is used in conjunction with the @samp{add-hook} function.
3528 For example, in TeX mode, a local binding might be
3530 @lisp
3531 (add-hook 'tex-mode-hook
3532   (lambda ()
3533    (local-set-key (quote [f1]) (quote help-for-help))))
3534 @end lisp
3537 @itemize @bullet
3539 @item
3540 Control characters in key sequences, in the form yanked from the kill
3541 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3542 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc.  You may want
3543 to convert these into their vector or string forms.
3545 @item
3546 If a prefix key of the character sequence to be bound is already
3547 bound as a complete key, then you must unbind it before the new
3548 binding.  For example, if @kbd{ESC @{} is previously bound:
3550 @lisp
3551 (global-unset-key [?\e ?@{])   ;;   or
3552 (local-unset-key [?\e ?@{])
3553 @end lisp
3555 @item
3556 Aside from commands and ``lambda lists,'' a vector or string also
3557 can be bound to a key and thus treated as a macro.  For example:
3559 @lisp
3560 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g])  ;;  or
3561 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3562 @end lisp
3564 @end itemize
3566 @node Invalid prefix characters
3567 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3568 @cindex Prefix characters, invalid
3569 @cindex Invalid prefix characters
3570 @cindex Misspecified key sequences
3572 Usually, one of two things has happened.  In one case, the control
3573 character in the key sequence has been misspecified (e.g., @samp{C-f}
3574 used instead of @samp{\C-f} within a Lisp expression).  In the other
3575 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3576 was already bound as a @dfn{complete key}.  Historically, the @samp{ESC [}
3577 prefix was usually the problem, in which case you should evaluate either
3578 of these forms before attempting to bind the key sequence:
3580 @lisp
3581 (global-unset-key [?\e ?[])  ;;  or
3582 (global-unset-key "\e[")
3583 @end lisp
3585 @node Terminal setup code works after Emacs has begun
3586 @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?
3587 @cindex Terminal setup code in @file{.emacs}
3589 During startup, Emacs initializes itself according to a given code/file
3590 order.  If some of the code executed in your @file{.emacs} file needs to
3591 be postponed until the initial terminal or window-system setup code has
3592 been executed but is not, then you will experience this problem (this
3593 code/file execution order is not enforced after startup).
3595 To postpone the execution of Emacs Lisp code until after terminal or
3596 window-system setup, treat the code as a @dfn{lambda list} and set the
3597 value of either the @code{term-setup-hook} or @code{window-setup-hook}
3598 variable to this lambda function.  For example,
3600 @lisp
3601 (add-hook 'term-setup-hook
3602           (lambda ()
3603            (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3604              ;; Make vt220's "Do" key behave like M-x:
3605              (global-set-key [do] 'execute-extended-command))))
3606 @end lisp
3608 For information on what Emacs does every time it is started, see the
3609 @file{lisp/startup.el} file.
3611 @node Working with function and arrow keys
3612 @section How do I tell what characters or symbols my function or arrow keys emit?
3613 @cindex Working with arrow keys
3614 @cindex Arrow keys, symbols generated by
3615 @cindex Working with function keys
3616 @cindex Function keys, symbols generated by
3617 @cindex Symbols generated by function keys
3619 Type @kbd{C-h c} then the function or arrow keys.  The command will
3620 return either a function key symbol or character sequence (see the
3621 Emacs documentation for an explanation).  This works for other
3622 keys as well.
3624 @node X key translations for Emacs
3625 @section How do I set the X key ``translations'' for Emacs?
3626 @cindex X key translations
3627 @cindex Key translations under X
3628 @cindex Translations for keys under X
3630 Emacs is not written using the Xt library by default, so there are no
3631 ``translations'' to be set.  (We aren't sure how to set such translations
3632 if you do build Emacs with Xt; please let us know if you've done this!)
3634 The only way to affect the behavior of keys within Emacs is through
3635 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs).  The
3636 @code{define-key} command should be used in conjunction with the
3637 @code{function-key-map} map.  For instance,
3639 @lisp
3640 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3641 @end lisp
3643 @noindent
3644 defines the @kbd{M-@key{TAB}} key sequence.
3646 @node Backspace invokes help
3647 @section Why does the @key{Backspace} key invoke help?
3648 @cindex Backspace key invokes help
3649 @cindex Help invoked by Backspace
3650 @cindex DEL key does not delete
3652 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
3653 @kbd{C-h} sends the same code.  In Emacs by default @kbd{C-h} invokes
3654 help-command.  This is intended to be easy to remember since the first
3655 letter of @samp{help} is @samp{h}.  The easiest solution to this problem
3656 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
3657 @key{Delete} key) for deleting the previous character.
3659 For many people this solution may be problematic:
3661 @itemize @bullet
3663 @item
3664 They normally use @key{Backspace} outside of Emacs for deleting the
3665 previous character.  This can be solved by making @key{DEL} the command
3666 for deleting the previous character outside of Emacs.  On many Unix
3667 systems, this command will remap @key{DEL}:
3669 @example
3670 stty erase `^?'
3671 @end example
3673 @item
3674 The user may prefer the @key{Backspace} key for deleting the
3675 previous character because it is more conveniently located on their
3676 keyboard or because they don't even have a separate @key{Delete} key.
3677 In this case, the @key{Backspace} key should be made to behave like
3678 @key{Delete}.  There are several methods.
3680 @itemize @minus
3681 @item
3682 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
3683 TeraTerm) allow the character generated by the @key{Backspace} key to be
3684 changed from a setup menu.
3686 @item
3687 You may be able to get a keyboard that is completely programmable, or a
3688 terminal emulator that supports remapping of any key to any other key.
3690 @item
3691 With Emacs 21.1 and later, you can control the effect of the
3692 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
3693 windowed displays, by customizing the option
3694 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
3695 normal-erase-is-backspace}.  See the documentation of these symbols
3696 (@pxref{Emacs Lisp documentation}) for more info.
3698 @item
3699 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
3700 Emacs:
3702 @lisp
3703 (keyboard-translate ?\C-h ?\C-?)
3704 @end lisp
3706 @noindent
3707 This is the recommended method of forcing @key{Backspace} to act as
3708 @key{DEL}, because it works even in modes which bind @key{DEL} to
3709 something other than @code{delete-backward-char}.
3711 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
3712 default deletes forward:
3714 @lisp
3715 (keyboard-translate ?\C-? ?\C-d)
3716 @end lisp
3718 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
3720 @item
3721 Another approach is to switch key bindings and put help on @kbd{C-x h}
3722 instead:
3724 @lisp
3725 (global-set-key "\C-h" 'delete-backward-char)
3727 ;; overrides mark-whole-buffer
3728 (global-set-key "\C-xh" 'help-command)
3729 @end lisp
3731 @noindent
3732 This method is not recommended, though: it only solves the problem for
3733 those modes which bind @key{DEL} to @code{delete-backward-char}.  Modes
3734 which bind @key{DEL} to something else, such as @code{view-mode}, will
3735 not work as you expect when you press the @key{Backspace} key.  For this
3736 reason, we recommend the @code{keyboard-translate} method, shown
3737 above.
3739 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
3740 @end itemize
3742 Don't try to bind @key{DEL} to @code{help-command}, because there are
3743 many modes that have local bindings of @key{DEL} that will interfere.
3745 @end itemize
3747 When Emacs 21 or later runs on a windowed display, it binds the
3748 @key{Delete} key to a command which deletes the character at point, to
3749 make Emacs more consistent with keyboard operation on these systems.
3751 For more information about troubleshooting this problem, see @ref{DEL
3752 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
3753 Manual}.
3755 @node Swapping keys
3756 @section How do I swap two keys?
3757 @cindex Swapping keys
3758 @cindex Keys, swapping
3759 @cindex @code{keyboard-translate}
3761 You can swap two keys (or key sequences) by using the
3762 @code{keyboard-translate} function.  For example, to turn @kbd{C-h}
3763 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
3765 @lisp
3766 (keyboard-translate ?\C-h ?\C-?)  ; translate `C-h' to DEL
3767 (keyboard-translate ?\C-? ?\C-h)  ; translate DEL to `C-h'.
3768 @end lisp
3770 @noindent
3771 The first key sequence of the pair after the function identifies what is
3772 produced by the keyboard; the second, what is matched for in the
3773 keymaps.
3775 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
3776 toggle @code{normal-erase-is-backspace-mode} instead of calling
3777 @code{keyboard-translate}.
3778 @xref{DEL Does Not Delete,,, emacs, The GNU Emacs Manual}.
3780 Keyboard translations are not the same as key bindings in keymaps.
3781 Emacs contains numerous keymaps that apply in different situations, but
3782 there is only one set of keyboard translations, and it applies to every
3783 character that Emacs reads from the terminal.  Keyboard translations
3784 take place at the lowest level of input processing; the keys that are
3785 looked up in keymaps contain the characters that result from keyboard
3786 translation.
3788 @node Producing C-XXX with the keyboard
3789 @section How do I produce C-XXX with my keyboard?
3790 @cindex Producing control characters
3791 @cindex Generating control characters
3792 @cindex Control characters, generating
3794 On terminals (but not under X), some common ``aliases'' are:
3796 @table @asis
3798 @item @kbd{C-2}  or  @kbd{C-@key{SPC}}
3799 @kbd{C-@@}
3801 @item @kbd{C-6}
3802 @kbd{C-^}
3804 @item @kbd{C-7}  or  @kbd{C-S--}
3805 @kbd{C-_}
3807 @item @kbd{C-4}
3808 @kbd{C-\}
3810 @item @kbd{C-5}
3811 @kbd{C-]}
3813 @item @kbd{C-/}
3814 @kbd{C-?}
3816 @end table
3818 Often other aliases exist; use the @kbd{C-h c} command and try
3819 @key{CTRL} with all of the digits on your keyboard to see what gets
3820 generated.  You can also try the @kbd{C-h w} command if you know the
3821 name of the command.
3823 @node No Meta key
3824 @section What if I don't have a @key{Meta} key?
3825 @cindex No @key{Meta} key
3826 @cindex @key{Meta} key, what to do if you lack it
3828 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
3830 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}.  In fact,
3831 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
3832 (depending on the value of @code{meta-prefix-char}).  Note that you
3833 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
3834 @key{ESC}, release it, and then press @key{a}.
3836 @node No Escape key
3837 @section What if I don't have an @key{Escape} key?
3838 @cindex No Escape key
3839 @cindex Lacking an Escape key
3840 @cindex Escape key, lacking
3842 Type @kbd{C-[} instead.  This should send @acronym{ASCII} code 27 just like an
3843 Escape key would.  @kbd{C-3} may also work on some terminal (but not
3844 under X).  For many terminals (notably DEC terminals) @key{F11}
3845 generates @key{ESC}.  If not, the following form can be used to bind it:
3847 @lisp
3848 ;; F11 is the documented ESC replacement on DEC terminals.
3849 (define-key function-key-map [f11] [?\e])
3850 @end lisp
3852 @node Compose Character
3853 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
3854 @cindex @key{Compose Character} key, using as @key{Meta}
3855 @cindex @key{Meta}, using @key{Compose Character} for
3857 On a dumb terminal such as a VT220, no.  It is rumored that certain
3858 VT220 clones could have their @key{Compose} key configured this way.  If
3859 you're using X, you might be able to do this with the @code{xmodmap}
3860 command.
3862 @node Binding combinations of modifiers and function keys
3863 @section How do I bind a combination of modifier key and function key?
3864 @cindex Modifiers and function keys
3865 @cindex Function keys and modifiers
3866 @cindex Binding modifiers and function keys
3868 You can represent modified function keys in vector format by adding
3869 prefixes to the function key symbol.  For example (from the Emacs
3870 documentation):
3872 @lisp
3873 (global-set-key [?\C-x right] 'forward-page)
3874 @end lisp
3876 @noindent
3877 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
3879 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
3880 @key{Super}, @key{Alt}, and @key{Shift} with function keys.  To
3881 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
3882 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name.  Here
3883 is how to make @kbd{H-M-RIGHT} move forward a word:
3885 @lisp
3886 (global-set-key [H-M-right] 'forward-word)
3887 @end lisp
3889 @itemize @bullet
3891 @item
3892 Not all modifiers are permitted in all situations.  @key{Hyper},
3893 @key{Super}, and @key{Alt} are not available on Unix character
3894 terminals.  Non-@acronym{ASCII} keys and mouse events (e.g., @kbd{C-=} and
3895 @kbd{Mouse-1}) also fall under this category.
3897 @end itemize
3899 @xref{Binding keys to commands}, for general key binding instructions.
3901 @node Meta key does not work in xterm
3902 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
3903 @cindex @key{Meta} key and @code{xterm}
3904 @cindex Xterm and @key{Meta} key
3906 @xref{Unibyte Mode,, Single-Byte Character Set Support, emacs, The GNU Emacs Manual}.
3908 If the advice in the Emacs manual fails, try all of these methods before
3909 asking for further help:
3911 @itemize @bullet
3913 @item
3914 You may have big problems using @code{mwm} as your window manager.
3915 (Does anyone know a good generic solution to allow the use of the
3916 @key{Meta} key in Emacs with @file{mwm}?)
3918 @item
3919 For X11: Make sure it really is a @key{Meta} key.  Use @code{xev} to
3920 find out what keysym your @key{Meta} key generates.  It should be either
3921 @code{Meta_L} or @code{Meta_R}.  If it isn't, use @file{xmodmap} to fix
3922 the situation.  If @key{Meta} does generate @code{Meta_L} or
3923 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
3924 your @file{~/.Xdefaults} file:
3926 @example
3927  XTerm*eightBitInput:   false
3928  XTerm*eightBitOutput:  true
3929 @end example
3931 @item
3932 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
3933 characters.  @samp{stty -a} (or @samp{stty everything}) should show
3934 @samp{cs8} somewhere.  If it shows @samp{cs7} instead, use @samp{stty
3935 cs8 -istrip} (or @samp{stty pass8}) to fix it.
3937 @item
3938 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
3939 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
3940 of every character.
3942 @item
3943 If Emacs is running on Ultrix, it is reported that evaluating
3944 @code{(set-input-mode t nil)} helps.
3946 @item
3947 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
3948 you type @kbd{M-W}, which is the same conversion Emacs would make if it
3949 got the @kbd{M-W} anyway.  In X11R4, the following resource
3950 specification will do this:
3952 @example
3953 XTerm.VT100.EightBitInput: false
3954 @end example
3956 @noindent
3957 (This changes the behavior of the @code{insert-eight-bit} action.)
3959 With older @code{xterm}s, you can specify this behavior with a translation:
3961 @example
3962 XTerm.VT100.Translations: #override \
3963   Meta<KeyPress>: string(0x1b) insert()
3964 @end example
3966 @noindent
3967 You might have to replace @samp{Meta} with @samp{Alt}.
3969 @end itemize
3971 @node ExtendChar key does not work as Meta
3972 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
3973 @cindex @key{ExtendChar} key as @key{Meta}
3974 @cindex @key{Meta}, using @key{ExtendChar} for
3975 @cindex HP-UX, the @key{ExtendChar} key
3977 This is a result of an internationalization extension in X11R4 and the
3978 fact that HP is now using this extension.  Emacs assumes that the
3979 @code{XLookupString} function returns the same result regardless of the
3980 @key{Meta} key state which is no longer necessarily true.  Until Emacs
3981 is fixed, the temporary kludge is to run this command after each time
3982 the X server is started but preferably before any xterm clients are:
3984 @example
3985 xmodmap -e 'remove mod1 = Mode_switch'
3986 @end example
3988 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
3989 @c solved?
3991 This will disable the use of the extra keysyms systemwide, which may be
3992 undesirable if you actually intend to use them.
3994 @node SPC no longer completes file names
3995 @section Why doesn't SPC complete file names anymore?
3996 @cindex @kbd{SPC} file name completion
3998 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
3999 the minibuffer, so that file names with embedded spaces could be typed
4000 without the need to quote the spaces.
4002 You can get the old behavior by binding @kbd{SPC} to
4003 @code{minibuffer-complete-word} in the minibuffer, as follows:
4005 @lisp
4006 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
4007   'minibuffer-complete-word)
4009 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4010   'minibuffer-complete-word)
4011 @end lisp
4013 @c ------------------------------------------------------------
4014 @node Alternate character sets
4015 @chapter Alternate character sets
4016 @cindex Alternate character sets
4018 @menu
4019 * Emacs does not display 8-bit characters::
4020 * Inputting eight-bit characters::
4021 * Right-to-left alphabets::
4022 * How to add fonts::
4023 @end menu
4025 @node Emacs does not display 8-bit characters
4026 @section How do I make Emacs display 8-bit characters?
4027 @cindex Displaying eight-bit characters
4028 @cindex Eight-bit characters, displaying
4030 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4031 Emacs Manual}.  On a Unix, when Emacs runs on a text-only terminal
4032 display or is invoked with @samp{emacs -nw}, you typically need to use
4033 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4034 display, even after setting the language environment; otherwise
4035 non-@acronym{ASCII} characters will display as @samp{?}.  On other operating
4036 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4037 character set supported by the display, and sets up the required
4038 terminal coding system automatically.
4040 @node Inputting eight-bit characters
4041 @section How do I input eight-bit characters?
4042 @cindex Entering eight-bit characters
4043 @cindex Eight-bit characters, entering
4044 @cindex Input, 8-bit characters
4046 Various methods are available for input of eight-bit characters.
4047 @xref{Unibyte Mode,, Single-byte Character Set Support, emacs, The GNU
4048 Emacs Manual}.  For more sophisticated methods,
4049 @pxref{Input Methods,,, emacs, The GNU Emacs Manual}.
4051 @node Right-to-left alphabets
4052 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4053 @cindex Right-to-left alphabets
4054 @cindex Hebrew, handling with Emacs
4055 @cindex Semitic alphabets
4056 @cindex Arabic
4057 @cindex Farsi
4058 @cindex bidirectional scripts
4060 Emacs supports display and editing of bidirectional scripts, such as
4061 Arabic, Farsi, and Hebrew, since version 24.1.
4062 @xref{New in Emacs 24, bidirectional display}.
4065 @node How to add fonts
4066 @section How do I add fonts for use with Emacs?
4067 @cindex add fonts for use with Emacs
4068 @cindex intlfonts
4070 First, download and install the BDF font files and any auxiliary
4071 packages they need.  The GNU Intlfonts distribution can be found on
4072 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU
4073 Software Directory Web site}.
4075 Next, if you are on X Window system, issue the following two commands
4076 from the shell's prompt:
4078 @example
4079   xset +fp /usr/local/share/emacs/fonts
4080   xset fp rehash
4081 @end example
4083 @noindent
4084 (Modify the first command if you installed the fonts in a directory
4085 that is not @file{/usr/local/share/emacs/fonts}.)  You also need to
4086 arrange for these two commands to run whenever you log in, e.g., by
4087 adding them to your window-system startup file, such as
4088 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4090 Now, add the following line to your @file{~/.emacs} init file:
4092 @lisp
4093   (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4094 @end lisp
4096 @noindent
4097 (Again, modify the file name if you installed the fonts elsewhere.)
4099 Finally, if you wish to use the installed fonts with @code{ps-print},
4100 add the following line to your @file{~/.emacs}:
4102 @lisp
4103   (setq ps-multibyte-buffer 'bdf-font-except-latin)
4104 @end lisp
4106 A few additional steps are necessary for MS-Windows; they are listed
4107 below.
4109 First, make sure @emph{all} the directories with BDF font files are
4110 mentioned in @code{bdf-directory-list}.  On Unix and GNU/Linux
4111 systems, one normally runs @kbd{make install} to install the BDF fonts
4112 in the same directory.  By contrast, Windows users typically don't run
4113 the Intlfonts installation command, but unpack the distribution in
4114 some directory, which leaves the BDF fonts in its subdirectories.  For
4115 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4116 then you should set @code{bdf-directory-list} as follows:
4118 @lisp
4119   (setq bdf-directory-list
4120     '("C:/Intlfonts/Asian"
4121       "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4122       "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4123       "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4124       "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4125       "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4126       "C:/Intlfonts/Misc"))
4127 @end lisp
4129 @cindex @code{w32-bdf-filename-alist}
4130 @cindex @code{w32-find-bdf-fonts}
4131 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4132 an alist of the BDF fonts and their corresponding file names.
4133 Assuming you have set @code{bdf-directory-list} to name all the
4134 directories with the BDF font files, the following Lisp snippet will
4135 set up @code{w32-bdf-filename-alist}:
4137 @lisp
4138   (setq w32-bdf-filename-alist
4139      (w32-find-bdf-fonts bdf-directory-list))
4140 @end lisp
4142 Now, create fontsets for the BDF fonts:
4144 @smallexample
4145   (create-fontset-from-fontset-spec
4146    "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4147    japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4148    katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4149    latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4150    japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4151    thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4152    lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4153    tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4154    ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4155    tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4156 @end smallexample
4158 Many of the international bdf fonts from Intlfonts are type 0, and
4159 therefore need to be added to font-encoding-alist:
4161 @lisp
4162   (setq font-encoding-alist
4163         (append '(("MuleTibetan-0" (tibetan . 0))
4164                   ("GB2312"        (chinese-gb2312 . 0))
4165                   ("JISX0208"      (japanese-jisx0208 . 0))
4166                   ("JISX0212"      (japanese-jisx0212 . 0))
4167                   ("VISCII"        (vietnamese-viscii-lower . 0))
4168                   ("KSC5601"       (korean-ksc5601 . 0))
4169                   ("MuleArabic-0"  (arabic-digit . 0))
4170                   ("MuleArabic-1"  (arabic-1-column . 0))
4171                   ("MuleArabic-2"  (arabic-2-column . 0)))
4172                 font-encoding-alist))
4173 @end lisp
4175 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4176 fontset, or you can select it by setting the default font in your
4177 @file{~/.emacs}:
4179 @lisp
4180   (set-default-font "fontset-bdf")
4181 @end lisp
4184 @c ------------------------------------------------------------
4185 @node Mail and news
4186 @chapter Mail and news
4187 @cindex Mail and news
4189 @menu
4190 * Changing the included text prefix::
4191 * Saving a copy of outgoing mail::
4192 * Expanding aliases when sending mail::
4193 * Sorting the messages in an Rmail folder::
4194 * Rmail writes to /var/spool/mail::
4195 * Replying to the sender of a message::
4196 * Automatically starting a mail or news reader::
4197 * Reading news with Emacs::
4198 * Gnus does not work with NNTP::
4199 * Making Gnus faster::
4200 * Catching up in all newsgroups::
4201 @end menu
4203 @node Changing the included text prefix
4204 @section How do I change the included text prefix in mail/news followups?
4205 @cindex Prefix in mail/news followups, changing
4206 @cindex Included text prefix, changing
4207 @cindex Setting the included text character
4208 @cindex Quoting in mail messages
4210 If you read mail with Rmail, set the variable @code{mail-yank-prefix}.
4211 For Gnus, set @code{message-yank-prefix}.  For VM, set
4212 @code{vm-included-text-prefix}.  For mh-e, set @code{mh-ins-buf-prefix}.
4214 For fancier control of citations, use Supercite (@pxref{Top,, the Supercite
4215 Manual, sc, The Supercite Manual}).
4217 To prevent Emacs from including various headers of the replied-to
4218 message, set the value of @code{mail-yank-ignored-headers} to an
4219 appropriate regexp.
4221 @node Saving a copy of outgoing mail
4222 @section How do I save a copy of outgoing mail?
4223 @cindex Saving a copy of outgoing mail
4224 @cindex Copying outgoing mail to a file
4225 @cindex Filing outgoing mail
4226 @cindex Automatic filing of outgoing mail
4227 @cindex Mail, saving outgoing automatically
4229 You can either mail yourself a copy by including a @samp{BCC} header in the
4230 mail message, or store a copy of the message directly to a file by
4231 including an @samp{FCC} header.
4233 If you use standard mail, you can automatically create a @samp{BCC} to
4234 yourself by putting
4236 @lisp
4237 (setq mail-self-blind t)
4238 @end lisp
4240 @noindent
4241 in your @file{.emacs} file.  You can automatically include an @samp{FCC}
4242 field by putting something like the following in your @file{.emacs}
4243 file:
4245 @lisp
4246 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4247 @end lisp
4249 The output file will be in Unix mail format.
4251 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4252 components file.
4254 It does not work to put @samp{set record filename} in the @file{.mailrc}
4255 file.
4257 @node Expanding aliases when sending mail
4258 @section Why doesn't Emacs expand my aliases when sending mail?
4259 @cindex Expanding aliases when sending mail
4260 @cindex Mail alias expansion
4261 @cindex Sending mail with aliases
4263 @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}.
4265 @itemize @bullet
4267 @item
4268 Normally, Emacs expands aliases when you send the message.
4269 To expand them before this, use @kbd{M-x expand-mail-aliases}.
4271 @item
4272 Emacs normally only reads the @file{.mailrc} file once per session, when
4273 you start to compose your first mail message.  If you edit the file
4274 after this, you can use @kbd{M-x build-mail-aliases} to make Emacs
4275 reread it.  Prior to Emacs 24.1, this is not an interactive command, so
4276 you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}.
4278 @item
4279 If you like, you can expand mail aliases as abbrevs, as soon as you
4280 type them in.  To enable this feature, execute the following:
4282 @lisp
4283 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4284 @end lisp
4286 Note that the aliases are expanded automatically only after you type
4287 a word-separator character (e.g., @key{RET} or @kbd{,}).  You can force their
4288 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4289 (@kbd{M-x expand-abbrev}).
4290 @end itemize
4292 @node Sorting the messages in an Rmail folder
4293 @section How can I sort the messages in my Rmail folder?
4294 @cindex Rmail, sorting messages in
4295 @cindex Folder, sorting messages in an Rmail
4296 @cindex Sorting messages in an Rmail folder
4298 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4299 and their key bindings.
4301 @node Rmail writes to /var/spool/mail
4302 @section Why does Rmail need to write to @file{/var/spool/mail}?
4303 @cindex Rmail and @file{/var/spool/mail}
4304 @cindex @file{/var/spool/mail} and Rmail
4306 This is the behavior of the @code{movemail} program which Rmail uses.
4307 This indicates that @code{movemail} is configured to use lock files.
4309 RMS writes:
4311 @quotation
4312 Certain systems require lock files to interlock access to mail files.
4313 On these systems, @code{movemail} must write lock files, or you risk losing
4314 mail.  You simply must arrange to let @code{movemail} write them.
4316 Other systems use the @code{flock} system call to interlock access.  On
4317 these systems, you should configure @code{movemail} to use @code{flock}.
4318 @end quotation
4320 @node Replying to the sender of a message
4321 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4322 @cindex Replying only to the sender of a message
4323 @cindex Sender, replying only to
4324 @cindex Rmail, replying to the sender of a message in
4326 @c isaacson@@seas.upenn.edu
4327 Ron Isaacson says: When you hit
4328 @key{r} to reply in Rmail, by default it CCs all of the original
4329 recipients (everyone on the original @samp{To} and @samp{CC}
4330 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4331 it replies only to the sender.  However, going through the whole
4332 @kbd{C-u} business every time you want to reply is a pain.  This is the
4333 best fix I've been able to come up with:
4335 @lisp
4336 (defun rmail-reply-t ()
4337   "Reply only to the sender of the current message. (See rmail-reply.)"
4338   (interactive)
4339   (rmail-reply t))
4341 (add-hook 'rmail-mode-hook
4342   (lambda ()
4343     (define-key rmail-mode-map "r" 'rmail-reply-t)
4344     (define-key rmail-mode-map "R" 'rmail-reply)))
4345 @end lisp
4347 @node Automatically starting a mail or news reader
4348 @section How do I make Emacs automatically start my mail/news reader?
4349 @cindex Mail reader, starting automatically
4350 @cindex News reader, starting automatically
4351 @cindex Starting mail/news reader automatically
4353 To start Emacs in Gnus:
4355 @example
4356 emacs -f gnus
4357 @end example
4359 @noindent
4360 in Rmail:
4362 @example
4363 emacs -f rmail
4364 @end example
4366 A more convenient way to start with Gnus:
4368 @example
4369 alias gnus 'emacs -f gnus'
4370 gnus
4371 @end example
4373 It is probably unwise to automatically start your mail or news reader
4374 from your @file{.emacs} file.  This would cause problems if you needed to run
4375 two copies of Emacs at the same time.  Also, this would make it difficult for
4376 you to start Emacs quickly when you needed to.
4378 @node Reading news with Emacs
4379 @section How do I read news under Emacs?
4380 @cindex Reading news under Emacs
4381 @cindex Usenet reader in Emacs
4382 @cindex Gnus newsreader
4383 @cindex FAQ for Gnus
4384 @cindex Gnus FAQ
4385 @cindex Learning more about Gnus
4387 Use @kbd{M-x gnus}.  For more information on Gnus, @pxref{Top,, the Gnus
4388 Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked
4389 Questions,, the Gnus FAQ, gnus, The Gnus Manual}.
4392 @node Gnus does not work with NNTP
4393 @section Why doesn't Gnus work via NNTP?
4394 @cindex Gnus and NNTP
4395 @cindex NNTP, Gnus fails to work with
4397 There is a bug in NNTP version 1.5.10, such that when multiple requests
4398 are sent to the NNTP server, the server only handles the first one
4399 before blocking waiting for more input which never comes.  NNTP version
4400 1.5.11 claims to fix this.
4402 You can work around the bug inside Emacs like this:
4404 @lisp
4405 (setq nntp-maximum-request 1)
4406 @end lisp
4408 You can find out what version of NNTP your news server is running by
4409 telnetting to the NNTP port (usually 119) on the news server machine
4410 (i.e., @kbd{telnet server-machine 119}).  The server should give its
4411 version number in the welcome message.  Type @kbd{quit} to get out.
4413 @node Making Gnus faster
4414 @section How do I make Gnus faster?
4415 @cindex Faster, starting Gnus
4416 @cindex Starting Gnus faster
4417 @cindex Gnus, starting faster
4418 @cindex Slow catch up in Gnus
4419 @cindex Gnus is slow when catching up
4420 @cindex Crosspostings make Gnus catching up slow
4422 From the Gnus FAQ (@pxref{Reading news with Emacs}):
4424 @quotation
4425 If you have a slow machine, or are just really impatient, there are a
4426 few things you can do to make Gnus run faster.
4428 Set @code{gnus-check-new-newsgroups} and
4429 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
4431 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
4432 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
4433 summary buffer faster.
4434 @end quotation
4436 @node Catching up in all newsgroups
4437 @section How do I catch up all newsgroups in Gnus?
4438 @cindex Catching up all newsgroups in Gnus
4439 @cindex Gnus, Catching up all newsgroups in
4441 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4443 Leave off the initial @kbd{M-<} if you only want to catch up from point
4444 to the end of the @file{*Newsgroup*} buffer.
4446 @node Concept index
4447 @unnumbered Concept Index
4448 @printindex cp
4450 @bye