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