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