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