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