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