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