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