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