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