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