1 \input texinfo @c -*- coding: latin-1; mode: texinfo; -*-
3 @setfilename ../info/efaq
4 @settitle GNU Emacs FAQ
9 @c This is used in many places
12 @c The @ifinfo stuff only appears in the Info version
16 * Emacs FAQ: (efaq). Frequently Asked Questions about Emacs.
19 Copyright 2001, 2002 Free Software Foundation, Inc.
20 Copyright 1994,1995,1996,1997,1998,1999,2000 Reuven M. Lerner@*
21 Copyright 1992,1993 Steven Byrnes@*
22 Copyright 1990,1991,1992 Joseph Brian Wells@*
24 This list of frequently asked questions about GNU Emacs with answers
25 ("FAQ") may be translated into other languages, transformed into other
26 formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information.
28 The same conditions apply to any derivative of the FAQ as apply to the FAQ
29 itself. Every copy of the FAQ must include this notice or an approved
30 translation, information on who is currently maintaining the FAQ and how to
31 contact them (including their e-mail address), and information on where the
32 latest version of the FAQ is archived (including FTP information).
34 The FAQ may be copied and redistributed under these conditions, except that
35 the FAQ may not be embedded in a larger literary work unless that work
36 itself allows free copying and redistribution.
38 [This version has been somewhat edited from the last-posted version
39 (as of August 1999) for inclusion in the Emacs distribution.]
43 @c The @titlepage stuff only appears in the printed version
46 @center @titlefont{GNU Emacs FAQ}
48 @c The following two commands start the copyright page.
50 @vskip 0pt plus 1filll
51 Copyright @copyright{} 2001,2002 Free Software Foundation, inc.@*
52 Copyright @copyright{} 1994,1995,1996,1997,1998,1999,2000 Reuven M. Lerner@*
53 Copyright @copyright{} 1992,1993 Steven Byrnes@*
54 Copyright @copyright{} 1990,1991,1992 Joseph Brian Wells@*
56 This list of frequently asked questions about GNU Emacs with answers
57 ("FAQ") may be translated into other languages, transformed into other
58 formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information.
60 The same conditions apply to any derivative of the FAQ as apply to the FAQ
61 itself. Every copy of the FAQ must include this notice or an approved
62 translation, information on who is currently maintaining the FAQ and how to
63 contact them (including their e-mail address), and information on where the
64 latest version of the FAQ is archived (including FTP information).
66 The FAQ may be copied and redistributed under these conditions, except that
67 the FAQ may not be embedded in a larger literary work unless that work
68 itself allows free copying and redistribution.
70 [This version has been somewhat edited from the last-posted version
71 (as of August 1999) for inclusion in the Emacs distribution.]
74 @node Top, FAQ notation, (dir), (dir)
76 This is the GNU Emacs FAQ, last updated on @today{}.
78 The FAQ is maintained as a Texinfo document, allowing us to create HTML,
79 Info, and TeX documents from a single source file, and is slowly but
80 surely being improved. Please bear with us as we improve on this
81 format. If you have any suggestions or questions, please contact
82 @email{emacs-faq@@lerner.co.il, the FAQ maintainers}.
91 * Compiling and installing Emacs::
92 * Finding Emacs and related packages::
93 * Major packages and programs::
95 * Alternate character sets::
100 @c ------------------------------------------------------------
101 @node FAQ notation, General questions, Top, Top
102 @chapter FAQ notation
105 This chapter describes notation used in the GNU Emacs FAQ, as well as in
106 the Emacs documentation. Consult this section if this is the first time
107 you are reading the FAQ, or if you are confused by notation or terms
112 * Extended commands::
114 * File-name conventions::
118 @node Basic keys, Extended commands, FAQ notation, FAQ notation
119 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
121 @cindex Control key, notation for
122 @cindex @key{Meta} key, notation for
123 @cindex Control-Meta characters, notation for
124 @cindex @kbd{C-h}, definition of
125 @cindex @kbd{C-M-h}, definition of
126 @cindex @key{DEL}, definition of
127 @cindex @key{ESC}, definition of
128 @cindex @key{LFD}, definition of
129 @cindex @key{RET}, definition of
130 @cindex @key{SPC}, definition of
131 @cindex @key{TAB}, definition of
132 @cindex Notation for keys
137 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
140 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
141 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
144 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
148 @kbd{C-M-x}: a synonym for the above
151 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
154 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
157 @key{DEL}: @key{Delete}, usually @strong{not} the same as
158 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
159 deleting invokes Emacs help)
162 @key{ESC}: Escape; same as @kbd{C-[}
165 @key{TAB}: Tab; same as @kbd{C-i}
172 Key sequences longer than one key (and some single-key sequences) are
173 written inside quotes or on lines by themselves, like this:
176 @kbd{M-x frobnicate-while-foo RET}
180 Any real spaces in such a key sequence should be ignored; only @key{SPC}
181 really means press the space key.
183 The ASCII code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
184 that would be sent by pressing just @key{x} minus 96 (or 64 for
185 upper-case @key{X}) and will be from 0 to 31. On Unix and GNU/Linux
186 terminals, the ASCII code sent by @kbd{M-x} is the sum of 128 and the
187 ASCII code that would be sent by pressing just @key{x}. Essentially,
188 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
190 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
193 @kbd{C-?} (aka @key{DEL}) is ASCII code 127. It is a misnomer to call
194 @kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON.
195 Also, on very few keyboards does @kbd{C-?} generate ASCII code 127.
197 @inforef{Text Characters, Text Characters, emacs}, and @inforef{Keys,
198 Keys, emacs}, for more information. (@xref{On-line manual}, for more
199 information about Info.)
201 @node Extended commands, On-line manual, Basic keys, FAQ notation
202 @section What does @file{M-x @var{command}} mean?
203 @cindex Extended commands
204 @cindex Commands, extended
205 @cindex M-x, meaning of
207 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
208 command, then type @key{RET}. (@xref{Basic keys}, if you're not sure
209 what @kbd{M-x} and @key{RET} mean.)
211 @kbd{M-x} (by default) invokes the command
212 @code{execute-extended-command}. This command allows you to run any
213 Emacs command if you can remember the command's name. If you can't
214 remember the command's name, you can type @key{TAB} and @key{SPC} for
215 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
216 @kbd{M-n} (or up-arrow and down-arrow on terminals that have these
217 editing keys) to see previous commands entered. An Emacs @dfn{command}
218 is an @dfn{interactive} Emacs function.
221 Your system administrator may have bound other key sequences to invoke
222 @code{execute-extended-command}. A function key labeled @kbd{Do} is a
223 good candidate for this, on keyboards that have such a key.
225 If you need to run non-interactive Emacs functions, see @ref{Evaluating
228 @node On-line manual, File-name conventions, Extended commands, FAQ notation
229 @section How do I read topic XXX in the on-line manual?
230 @cindex On-line manual, reading topics in
231 @cindex Reading topics in the on-line manual
232 @cindex Finding topics in the on-line manual
233 @cindex Info, finding topics in
235 When we refer you to some @var{topic} in the on-line manual, you can
236 read this manual node inside Emacs (assuming nothing is broken) by
237 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
239 This invokes Info, the GNU hypertext documentation browser. If you don't
240 already know how to use Info, type @key{?} from within Info.
242 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
243 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
245 If these commands don't work as expected, your system administrator may
246 not have installed the Info files, or may have installed them
247 improperly. In this case you should complain.
249 @xref{Getting a printed manual}, if you would like a paper copy of the
252 @node File-name conventions, Common acronyms, On-line manual, FAQ notation
253 @section What are @file{etc/SERVICE}, @file{src/config.h}, and @file{lisp/default.el}?
254 @cindex File-name conventions
255 @cindex Conventions for file names
256 @cindex Directories and files that come with Emacs
258 These are files that come with Emacs. The Emacs distribution is divided
259 into subdirectories; the important ones are @file{etc}, @file{lisp}, and
262 If you use Emacs, but don't know where it is kept on your system, start
263 Emacs, then type @kbd{C-h v data-directory @key{RET}}. The directory
264 name displayed by this will be the full pathname of the installed
265 @file{etc} directory. (This full path is recorded in the Emacs variable
266 @code{data-directory}, and @kbd{C-h v} displays the value and the
267 documentation of a variable.)
269 The location of your Info directory (i.e., where on-line documentation
270 is stored) is kept in the variable @code{Info-default-directory-list}. Use
271 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
272 this variable, which will be a list of directory names. The last
273 directory in that list is probably where most Info files are stored. By
274 default, Info documentation is placed in @file{/usr/local/info}.
276 Some of these files are available individually via FTP or e-mail; see
277 @ref{Informational files for Emacs}. They all are available in the
278 source distribution. Many of the files in the @file{etc} directory are
279 also available via the Emacs @samp{Help} menu, or by typing @kbd{C-h ?}
280 (@kbd{M-x help-for-help}).
282 Your system administrator may have removed the @file{src} directory and
283 many files from the @file{etc} directory.
285 @node Common acronyms, , File-name conventions, FAQ notation
286 @section What are FSF, LPF, OSF, GNU, RMS, FTP, and GPL?
287 @cindex FSF, definition of
288 @cindex LPF, definition of
289 @cindex OSF, definition of
290 @cindex GNU, definition of
291 @cindex RMS, definition of
292 @cindex Stallman, Richard, acronym for
293 @cindex Richard Stallman, acronym for
294 @cindex FTP, definition of
295 @cindex GPL, definition of
296 @cindex Acronyms, definitions for
297 @cindex Common acronyms, definitions for
302 Free Software Foundation
305 League for Programming Freedom
308 Open Software Foundation
314 Richard Matthew Stallman
317 File Transfer Protocol
320 GNU General Public License
324 Avoid confusing the FSF, the LPF, and the OSF. The LPF opposes
325 look-and-feel copyrights and software patents. The FSF aims to make
326 high quality free software available for everyone. The OSF is a
327 consortium of computer vendors which develops commercial software for
330 The word ``free'' in the title of the Free Software Foundation refers to
331 ``freedom,'' not ``zero dollars.'' Anyone can charge any price for
332 GPL-covered software that they want to. However, in practice, the
333 freedom enforced by the GPL leads to low prices, because you can always
334 get the software for less money from someone else, since everyone has
335 the right to resell or give away GPL-covered software.
337 @c ------------------------------------------------------------
338 @node General questions, Getting help, FAQ notation, Top
339 @chapter General questions
340 @cindex General questions
342 This chapter contains general questions having to do with Emacs, the
343 Free Software Foundation, and related organizations.
347 * Real meaning of copyleft::
348 * Guidelines for newsgroup postings::
349 * Newsgroup archives::
351 * Unsubscribing from Emacs lists::
352 * Contacting the FSF::
355 @node The LPF, Real meaning of copyleft, General questions, General questions
356 @section What is the LPF?
357 @cindex LPF, description of
358 @cindex League for Programming Freedom
359 @cindex Software patents, opposition to
360 @cindex Patents for software, opposition to
362 The LPF opposes the expanding danger of software patents and
363 look-and-feel copyrights. To get more information, feel free to contact
364 the LPF via e-mail or otherwise. You may also contact
365 @email{jbw@@cs.bu.edu, Joe Wells}; he will be happy to talk to you
368 You can find more information about the LPF in the file @file{etc/LPF}.
369 More papers describing the LPF's views are available on the Internet and
370 also from @uref{http://lpf.ai.mit.edu/, the LPF home page}.
372 @node Real meaning of copyleft, Guidelines for newsgroup postings, The LPF, General questions
373 @section What is the real legal meaning of the GNU copyleft?
374 @cindex Copyleft, real meaning of
375 @cindex GPL, real meaning of
376 @cindex General Public License, real meaning of
377 @cindex Discussion of the GPL
379 The real legal meaning of the GNU General Public License (copyleft) will
380 only be known if and when a judge rules on its validity and scope.
381 There has never been a copyright infringement case involving the GPL to
382 set any precedents. Please take any discussion regarding this issue to
383 the newsgroup @uref{news:gnu.misc.discuss}, which was created to hold the
384 extensive flame wars on the subject.
389 The legal meaning of the GNU copyleft is less important than the spirit,
390 which is that Emacs is a free software project and that work pertaining
391 to Emacs should also be free software. ``Free'' means that all users
392 have the freedom to study, share, change and improve Emacs. To make
393 sure everyone has this freedom, pass along source code when you
394 distribute any version of Emacs or a related program, and give the
395 recipients the same freedom that you enjoyed.
398 @node Guidelines for newsgroup postings, Newsgroup archives, Real meaning of copyleft, General questions
399 @section What are appropriate messages for @uref{news:gnu.emacs.help}, @uref{news:gnu.emacs.bug}, @uref{news:comp.emacs}, etc.?
400 @cindex Newsgroups, appropriate messages for
401 @cindex GNU newsgroups, appropriate messages for
402 @cindex Usenet groups, appropriate messages for
403 @cindex Mailing lists, appropriate messages for
404 @cindex Posting messages to newsgroups
406 @cindex GNU mailing lists
407 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU
408 mailing list. (@xref{Informational files for Emacs}, if you want a copy
409 of the file.) For those lists which are gatewayed with newsgroups, it
410 lists both the newsgroup name and the mailing list address.
412 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
413 in general. This includes Emacs along with various other
414 implementations, such as XEmacs, JOVE, MicroEmacs, Freemacs, MG,
415 Unipress, CCA, and Epsilon.
417 Many people post Emacs questions to @uref{news:comp.emacs} because they
418 don't receive any of the @code{gnu.*} newsgroups. Arguments have been
419 made both for and against posting GNU-Emacs-specific material to
420 @uref{news:comp.emacs}. You have to decide for yourself.
422 Messages advocating ``non-free'' software are considered unacceptable on
423 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
424 which was created to hold the extensive flame-wars on the subject.
425 ``Non-free'' software includes any software for which the end user can't
426 freely modify the source code and exchange enhancements. Be careful to
427 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
428 posting a followup that recommends such software.
430 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
431 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
433 @node Newsgroup archives, Reporting bugs, Guidelines for newsgroup postings, General questions
434 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
435 @cindex Archived postings from @code{gnu.emacs.help}
436 @cindex Usenet archives for GNU groups
437 @cindex Old Usenet postings for GNU groups
439 The FSF has maintained archives of all of the GNU mailing lists for many
440 years, although there may be some unintentional gaps in coverage. The
441 archive is not particularly well organized or easy to retrieve
442 individual postings from, but pretty much everything is there.
444 The archive is at @uref{ftp://ftp-mailing-list-archives.gnu.org}.
446 As of this writing, the archives are not yet working.
448 Web-based Usenet search services, such as
449 @uref{http://www.dejanews.com, DejaNews}, also archive the
452 @node Reporting bugs, Unsubscribing from Emacs lists, Newsgroup archives, General questions
453 @section Where should I report bugs and other problems with Emacs?
454 @cindex Bug reporting
455 @cindex Good bug reports
456 @cindex How to submit a bug report
457 @cindex Reporting bugs
459 The correct way to report Emacs bugs is by e-mail to
460 @email{bug-gnu-emacs@@gnu.org}. Anything sent here also appears in the
461 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
462 news to submit the bug report. This ensures a reliable return address
463 so you can be contacted for further details.
465 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
466 a bug to bug-gnu-emacs! The manual describes in detail how to submit a
467 useful bug report. (@xref{On-line manual}, if you don't know how to read the
473 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the
474 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because
475 it takes the time of an unnecessarily large group of people, most of
476 whom are just users and have no idea how to fix these problem.
477 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people
478 who are more likely to know what to do and have expressed a wish to
479 receive more messages about Emacs than the others.
482 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
485 If you have reported a bug and you don't hear about a possible fix,
486 then after a suitable delay (such as a week) it is okay to post on
487 @code{gnu.emacs.help} asking if anyone can help you.
490 If you are unsure whether you have found a bug, consider the following
491 non-exhaustive list, courtesy of RMS:
494 If Emacs crashes, that is a bug. If Emacs gets compilation errors
495 while building, that is a bug. If Emacs crashes while building, that
496 is a bug. If Lisp code does not do what the documentation says it
500 @node Unsubscribing from Emacs lists, Contacting the FSF, Reporting bugs, General questions
501 @section How do I unsubscribe from this mailing list?
502 @cindex Unsubscribing from GNU mailing lists
503 @cindex Removing yourself from GNU mailing lists
505 If you are receiving a GNU mailing list named @var{list}, you might be
506 able to unsubscribe from it by sending a request to the address
507 @email{@var{list}-request@@gnu.org}. However, this will not work if you are
508 not listed on the main mailing list, but instead receive the mail from a
509 distribution point. In that case, you will have to track down at which
510 distribution point you are listed. Inspecting the @samp{Received} headers
511 on the mail messages may help, along with liberal use of the @samp{EXPN} or
512 @samp{VRFY} sendmail commands through @samp{telnet @var{site-address}
513 smtp}. Ask your postmaster for help, if you cannot figure out these
516 @node Contacting the FSF, , Unsubscribing from Emacs lists, General questions
517 @section What is the current address of the FSF?
518 @cindex Snail mail address of the FSF
519 @cindex Postal address of the FSF
520 @cindex Contracting the FSF
521 @cindex Free Software Foundation, contacting
535 @uref{http://www.gnu.org/}
538 Free Software Foundation@*
539 59 Temple Place - Suite 330@*
540 Boston, MA 02111-1307@*
545 @cindex Ordering GNU software
546 For details on how to order items directly from the FSF, see the
547 @uref{http://www.gnu.org/order/order.html, GNU Web site}, and also the
548 files @file{etc/ORDERS}, @file{ORDERS.EUROPE}, and @file{ORDERS.JAPAN}.
550 @c ------------------------------------------------------------
551 @node Getting help, Status of Emacs, General questions, Top
552 @chapter Getting help
555 This chapter tells you how to get help with Emacs
559 * Learning how to do something::
560 * Getting a printed manual::
561 * Emacs Lisp documentation::
562 * Installing Texinfo documentation::
563 * Printing a Texinfo file::
564 * Viewing Info files outside of Emacs::
565 * Informational files for Emacs::
566 * Help installing Emacs::
567 * Obtaining the FAQ::
570 @node Basic editing, Learning how to do something, Getting help, Getting help
571 @section I'm just starting Emacs; how do I do basic editing?
572 @cindex Basic editing with Emacs
573 @cindex Beginning editing
574 @cindex Tutorial, invoking the
575 @cindex Self-paced tutorial, invoking the
576 @cindex Help system, entering the
578 Type @kbd{C-h t} to invoke the self-paced tutorial. Just typing @kbd{C-h}
579 enters the help system.
581 Your system administrator may have changed @kbd{C-h} to act like
582 @key{DEL} to deal with local keyboards. You can use @kbd{M-x
583 help-for-help} instead to invoke help. To discover what key (if any)
584 invokes help on your system, type @kbd{M-x where-is @key{RET}
585 help-for-help @key{RET}}. This will print a comma-separated list of key
586 sequences in the echo area. Ignore the last character in each key
587 sequence listed. Each of the resulting key sequences invokes help.
589 Emacs help works best if it is invoked by a single key whose value
590 should be stored in the variable @code{help-char}.
592 There is also a WWW-based tutorial for Emacs 18, much of which is also
593 relevant for later versions of Emacs, available at
595 @uref{http://kufacts.cc.ukans.edu/cwis/writeups/misc/emacsguide.html}
597 @node Learning how to do something, Getting a printed manual, Basic editing, Getting help
598 @section How do I find out how to do something in Emacs?
599 @cindex Help for Emacs
600 @cindex Learning to do something in Emacs
601 @cindex Reference card for Emacs
602 @cindex Overview of help systems
604 There are several methods for finding out how to do things in Emacs.
608 @cindex Reading the Emacs manual
610 The complete text of the Emacs manual is available on-line via the Info
611 hypertext reader. Type @kbd{C-h i} to invoke Info. Typing @key{h}
612 immediately after entering Info will provide a short tutorial on how to
615 @cindex Lookup a subject in a manual
616 @cindex Index search in a manual
618 To quickly locate the section of the manual which discusses a certain
619 issue, or describes a command or a variable, type @kbd{C-h i m emacs
620 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
621 topic, the command, or the variable which you are looking for. If this
622 does not land you on the right place in the manual, press @kbd{,}
623 (comma) repeatedly until you find what you need. (The @kbd{i} and
624 @kbd{,} keys invoke the index-searching functions, which look for the
625 @var{topic} you type in all the indices of the Emacs manual.)
629 You can list all of the commands whose names contain a certain word
630 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
633 @cindex Command description in the manual
635 The command @kbd{C-h C-f} (@code{Info-goto-emacs-command-node}) prompts
636 for the name of a command, and then attempts to find the section in the
637 Emacs manual where that command is described.
639 @cindex Finding commands and variables
641 You can list all of the functions and variables whose names contain a
642 certain word using @kbd{M-x apropos}.
645 You can list all of the functions and variables whose documentation
646 matches a regular expression or a string, using @kbd{M-x
647 apropos-documentation}.
650 You can order a hardcopy of the manual from the FSF. @xref{Getting a
653 @cindex Reference cards, in other languages
655 You can get a printed reference card listing commands and keys to
656 invoke them. You can order one from the FSF for $1 (or 10 for $5),
657 or you can print your own from the @file{etc/refcard.tex} or
658 @file{etc/refcard.ps} files in the Emacs distribution. Beginning with
659 version 21.1, the Emacs distribution comes with translations of the
660 reference card into several languages; look for files named
661 @file{etc/@var{lang}-refcard.*}, where @var{lang} is a two-letter code
662 of the language. For example, the German version of the reference card
663 is in the files @file{etc/de-refcard.tex} and @file{etc/de-refcard.ps}.
666 There are many other commands in Emacs for getting help and
667 information. To get a list of these commands, type @samp{?} after
672 @node Getting a printed manual, Emacs Lisp documentation, Learning how to do something, Getting help
673 @section How do I get a printed copy of the Emacs manual?
674 @cindex Printed Emacs manual, obtaining
675 @cindex Manual, obtaining a printed or HTML copy of
676 @cindex Emacs manual, obtaining a printed or HTML copy of
678 You can order a printed copy of the Emacs manual from the FSF. For
679 details see the @uref{http://www.gnu.org/order/order.html, GNU Web site}
680 and the file @file{etc/ORDERS}.
682 @c The number 620 below is version-dependent!
683 The full Texinfo source for the manual also comes in the @file{man}
684 directory of the Emacs distribution, if you're daring enough to try to
685 print out this 620-page manual yourself (@pxref{Printing a Texinfo
688 If you absolutely have to print your own copy, and you don't have @TeX{},
689 you can get a PostScript version from
691 @uref{http://www.gnu.org/manual/emacs/ps/emacs.ps.gz}
693 @cindex HTML version of Emacs manual, obtaining
694 An HTML version of the manual is at
696 @uref{www.gnu.org/manual/emacs/index.html}
698 @xref{Learning how to do something}, for how to view the manual on-line.
700 @node Emacs Lisp documentation, Installing Texinfo documentation, Getting a printed manual, Getting help
701 @section Where can I get documentation on Emacs Lisp?
702 @cindex Documentation on Emacs Lisp
703 @cindex Function documentation
704 @cindex Variable documentation
705 @cindex Emacs Lisp Reference Manual
706 @cindex Reference manual for Emacs Lisp
708 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
709 function, @kbd{C-h v} for a variable.
711 For more information, obtain the Emacs Lisp Reference Manual. Details
712 on ordering it from FSF are on the
713 @uref{http://www.gnu.org/order/order.html, GNU Web site} and in the file
716 The Emacs Lisp Reference Manual is also available on-line, in Info
717 format. Texinfo source for the manual (along with pregenerated Info
718 files) is available at
720 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/elisp-manual-21-2.6.tar.gz}
722 and all mirrors of @samp{ftp.gnu.org} (for a list, @pxref{Current GNU
723 distributions}). @xref{Installing Texinfo documentation}, if you want
724 to install the Info files, or @ref{Printing a Texinfo file}, if you want
725 to use the Texinfo source to print the manual yourself.
727 An HTML version of the Emacs Lisp Reference Manual is available at
729 @uref{http://www.gnu.org/manual/elisp-manual-21-2.6/elisp.html}
731 @node Installing Texinfo documentation, Printing a Texinfo file, Emacs Lisp documentation, Getting help
732 @section How do I install a piece of Texinfo documentation?
733 @cindex Texinfo documentation, installing
734 @cindex Installing Texinfo documentation
735 @cindex New Texinfo files, installing
736 @cindex Documentation, installing new Texinfo files
737 @cindex Info files, how to install
739 First, you must turn the Texinfo files into Info files. You may do this
740 using the stand-alone @file{makeinfo} program, available as part of the latest
743 @uref{ftp://ftp.gnu.org/pub/gnu/texinfo/texinfo-4.0.tar.gz}
745 and all mirrors of @samp{ftp.gnu.org} (for a list, @pxref{Current GNU
748 For information about the Texinfo format, read the Texinfo manual which
749 comes with the Texinfo package. This manual also comes installed in
750 Info format, so you can read it on-line; type @kbd{C-h i m texinfo
753 Alternatively, you could use the Emacs command @kbd{M-x
754 texinfo-format-buffer}, after visiting the Texinfo source file of the
755 manual you want to convert.
757 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
758 resulting Info files in Emacs's Info tree. To install Info files,
763 Move the files to the @file{info} directory in the installed Emacs
764 distribution. @xref{File-name conventions}, if you don't know where that
768 Run the @code{install-info} command, which is part of the Texinfo
769 distribution, to update the main Info directory menu, like this:
772 install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
776 where @var{dir-path} is the full path to the directory where you copied
777 the produced Info file(s), and @var{file} is the name of the Info file
778 you produced and want to install.
780 If you don't have the @code{install-info} command installed, you can
781 edit the file @file{info/dir} in the installed Emacs distribution, and
782 add a line for the top level node in the Info package that you are
783 installing. Follow the examples already in this file. The format is:
786 * Topic: (relative-pathname). Short description of topic.
791 If you want to install Info files and you don't have the necessary
792 privileges, you have several options:
796 Info files don't actually need to be installed before being used. You
797 can feed a file name to the @code{Info-goto-node} command (invoked by
798 pressing @key{g} in Info mode) by typing the name of the file in
799 parentheses. This goes to the node named ``Top'' in that file. For
800 example, to view a Info file named @file{@var{info-file}} in your home
801 directory, you can type this:
804 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
808 You can create your own Info directory. You can tell Emacs where that
809 Info directory is by adding its pathname to the value of the variable
810 @code{Info-default-directory-list}. For example, to use a private Info
811 directory which is a subdirectory of your home directory named @file{Info},
812 you could put this in your @file{.emacs} file:
815 (setq Info-default-directory-list
816 (cons "~/Info" Info-default-directory-list))
819 You will need a top-level Info file named @file{dir} in this directory
820 which has everything the system @file{dir} file has in it, except it should
821 list only entries for Info files in that directory. You might not need
822 it if all files in this directory were referenced by other @file{dir}
823 files. The node lists from all @file{dir} files in
824 @code{Info-default-directory-list} are merged by the Info system.
828 @node Printing a Texinfo file, Viewing Info files outside of Emacs, Installing Texinfo documentation, Getting help
829 @section How do I print a Texinfo file?
830 @cindex Printing a Texinfo file
831 @cindex Texinfo file, printing
832 @cindex Printing documentation
834 You can't get nicely printed output from Info files; you must still have
835 the original Texinfo source file for the manual you want to print.
837 Assuming you have @TeX{} installed on your system, follow these steps:
842 Make sure the first line of the Texinfo file looks like this:
848 You may need to change @samp{texinfo} to the full pathname of the
849 @file{texinfo.tex} file, which comes with Emacs as
850 @file{man/texinfo.tex} (or copy or link it into the current directory).
853 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
854 the name of the Texinfo source file for which you want to produce a
857 The @samp{texi2dvi} script is part of the GNU Texinfo distribution
858 (@pxref{Installing Texinfo documentation}).
861 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
862 printing DVI files at your site. For example, if you have a PostScript
863 printer, run the @code{dvips} program to print the DVI file on that
868 To get more general instructions, retrieve the latest Texinfo package
869 (@pxref{Installing Texinfo documentation}).
871 @node Viewing Info files outside of Emacs, Informational files for Emacs, Printing a Texinfo file, Getting help
872 @section Can I view Info files without using Emacs?
873 @cindex Viewing Info files
874 @cindex Info file viewers
875 @cindex Alternative Info file viewers
877 Yes. Here are some alternative programs:
882 @code{info}, a stand-alone version of the Info program, comes as part of
883 the Texinfo package. @xref{Installing Texinfo documentation}, for
887 Xinfo, a stand-alone version of the Info program that runs under X
888 Window system. You can get it at
889 @uref{ftp://ftp.gnu.org/pub/gnu/xinfo/xinfo-1.01.01.tar.gz} and all
890 mirrors of @samp{ftp.gnu.org} (see @ref{Current GNU distributions}, for a
894 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
895 You can get Tkinfo at
896 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
900 @node Informational files for Emacs, Help installing Emacs, Viewing Info files outside of Emacs, Getting help
901 @section What informational files are available for Emacs?
902 @cindex Informational files included with Emacs
903 @cindex Files included with Emacs
904 @cindex @file{COPYING}, description of file
905 @cindex @file{DISTRIB}, description of file
906 @cindex @file{FTP}, description of file
907 @cindex @file{GNU}, description of file
908 @cindex @file{INTERVIEW}, description of file
909 @cindex @file{LPF}, description of file
910 @cindex @file{MACHINES}, description of file
911 @cindex @file{MAILINGLISTS}, description of file
912 @cindex @file{NEWS}, description of file
913 @cindex @file{SERVICE}, description of file
914 @cindex @file{SUN-SUPPORT}, description of file
916 This isn't a frequently asked question, but it should be! A variety of
917 informational files about Emacs and relevant aspects of the GNU project
918 are available for you to read.
920 The following files are available in the @file{etc} directory of the
921 Emacs distribution (see @ref{File-name conventions}, if you're not sure
927 Emacs General Public License
930 Emacs Availability Information, including the popular "Free Software
931 Foundation Order Form"
934 How to get GNU Software by Internet FTP or by UUCP
940 Richard Stallman discusses his public-domain UNIX-compatible software
941 system with BYTE editors
944 Why you should join the League for Programming Freedom
947 Status of Emacs on Various Machines and Systems
950 GNU Project Electronic Mailing Lists
953 Emacs news, a history of recent user-visible changes
956 GNU Service Directory
959 including "Using Emacstool with GNU Emacs"
963 Latest versions of the above files also available at
965 @uref{ftp://ftp.gnu.org/pub/gnu/GNUinfo/}
967 More GNU information, including back issues of the @cite{GNU's
970 @uref{http://www.gnu.org/bulletins/bulletins.html} and
972 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
974 @node Help installing Emacs, Obtaining the FAQ, Informational files for Emacs, Getting help
975 @section Where can I get help in installing Emacs?
976 @cindex Installation help
977 @cindex Help installing Emacs
979 @xref{Installing Emacs}, for some basic installation hints, and see
980 @ref{Problems building Emacs}, or @ref{Linking with -lX11 fails}, if you
981 have problems with the installation.
983 The file @file{etc/SERVICE} (see @ref{File-name conventions}, if you're
984 not sure where that is) lists companies and individuals willing to sell
985 you help in installing or using Emacs. An up-to-date version this file
986 is available on @samp{ftp.gnu.org} (@pxref{Informational files for
989 @node Obtaining the FAQ, , Help installing Emacs, Getting help
990 @section Where can I get the latest version of this FAQ?
991 @cindex FAQ, obtaining the
992 @cindex Latest FAQ version, obtaining the
993 @cindex Retrieving the latest FAQ version
994 @cindex E-mail, retrieving the FAQ via
995 @cindex Web, reading the FAQ on the
997 The Emacs FAQ is available in several ways:
1002 Inside of Emacs itself. You can get it from selecting the @samp{Emacs
1003 FAQ} option from the @samp{Help} menu of the Emacs menu bar at the top
1004 of any Emacs frame, or by typing @kbd{C-h F} (@kbd{M-x view-emacs-FAQ}).
1007 Via USENET. If you can read news, the FAQ should be available in your
1008 news spool, in both the @uref{news:gnu.emacs.help} and
1009 @uref{news:comp.emacs} newsgroups. Every news reader should allow you
1010 to read any news article that is still in the news spool, even if you
1011 have read the article before. You may need to read the instructions for
1012 your news reader to discover how to do this. In @file{rn}, this command
1013 will do this for you at the article selection level:
1016 ?GNU Emacs Frequently Asked Questions?rc:m
1019 In Gnus, you should type @kbd{C-u C-x C-s} from the @file{*Summary*}
1020 buffer or @kbd{C-u @key{SPC}} from the @file{*Newsgroup*} buffer to view
1021 all articles in a newsgroup.
1023 If the FAQ articles have expired and have been deleted from your news
1024 spool, it might (or might not) do some good to complain to your news
1025 administrator, because the most recent FAQ should not expire for a
1029 Via HTTP or FTP. You can always fetch the latest FAQ from
1031 @uref{http://www.lerner.co.il/emacs/} and
1033 @uref{ftp://ftp.lerner.co.il/pub/emacs/}
1036 In the Emacs distribution. Since Emacs 18.56, the FAQ at the time
1037 of release has been part of the Emacs distribution as either
1038 @file{etc/FAQ} or @file{man/faq.texi} (@pxref{File-name conventions}).
1041 Via the World Wide Web. A hypertext version is available at
1043 @uref{http://www.lerner.co.il/emacs/}
1046 Via anonymous ftp and e-mail from @file{rtfm.mit.edu} (and its mirror in
1047 Europe), the main repository for FAQs and other items posted to
1048 news.answers. The Emacs FAQs are available at
1050 @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/} and
1052 @uref{ftp://ftp.uni-paderborn.de/pub/doc/FAQ/comp/emacs/}
1054 If you do not have access to anonymous FTP, you can access the archives
1055 using the @file{rtfm.mit.edu} mail server. The Emacs FAQ can be
1056 retrieved by sending mail to @email{mail-server@@rtfm.mit.edu} with a
1057 blank subject and containing
1060 send usenet/news.answers/GNU-Emacs-FAQ/diffs
1061 send usenet/news.answers/GNU-Emacs-FAQ/part1
1062 send usenet/news.answers/GNU-Emacs-FAQ/part2
1063 send usenet/news.answers/GNU-Emacs-FAQ/part3
1064 send usenet/news.answers/GNU-Emacs-FAQ/part4
1065 send usenet/news.answers/GNU-Emacs-FAQ/part5
1068 For more information, send email to @email{mail-server@@rtfm.mit.edu}
1069 with "help" and "index" in the body on separate lines.
1072 As the very last resort, you can e-mail a request to
1073 @email{emacs-faq@@lerner.co.il}. Don't do this unless you have made a
1074 good-faith effort to obtain the FAQ list via one of the methods listed
1079 @c ------------------------------------------------------------
1080 @node Status of Emacs, Common requests, Getting help, Top
1081 @chapter Status of Emacs
1082 @cindex Status of Emacs
1084 This chapter gives you basic information about Emacs, including its
1085 latest version status.
1088 * Origin of the term Emacs::
1089 * Latest version of Emacs::
1094 @node Origin of the term Emacs, Latest version of Emacs, Status of Emacs, Status of Emacs
1095 @section Where does the name ``Emacs'' come from?
1096 @cindex Origin of the term ``Emacs''
1097 @cindex Emacs name origin
1099 @cindex Original version of Emacs
1101 Emacs originally was an acronym for Editor MACroS. RMS says he ``picked
1102 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
1103 the time.'' The first Emacs was a set of macros written in 1976 at MIT
1104 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
1105 Editor and COrrector) under ITS on a PDP-10. RMS had already extended
1106 TECO with a ``real-time'' full-screen mode with reprogrammable keys.
1107 Emacs was started by @email{gls@@east.sun.com, Guy Steele} as a project
1108 to unify the many divergent TECO command sets and key bindings at MIT,
1109 and completed by RMS.
1111 Many people have said that TECO code looks a lot like line noise; you
1112 can read more at @uref{news:alt.lang.teco}. Someone has written a TECO
1113 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
1114 come with Emacs}); it would be an interesting project to run the
1115 original TECO Emacs inside of Emacs.
1118 For some not-so-serious alternative reasons for Emacs to have that
1119 name, check out the file @file{etc/JOKES} (@pxref{File-name
1122 @node Latest version of Emacs, New in Emacs 20, Origin of the term Emacs, Status of Emacs
1123 @section What is the latest version of Emacs?
1124 @cindex Version, latest
1125 @cindex Latest version of Emacs
1127 Emacs @value{VER} is the current version as of this writing.
1129 @node New in Emacs 20, New in Emacs 21, Latest version of Emacs, Status of Emacs
1130 @section What is different about Emacs 20?
1131 @cindex Differences between Emacs 19 and Emacs 20
1132 @cindex Emacs 20, new features in
1134 To find out what has changed in recent versions, type @kbd{C-h n}
1135 (@kbd{M-x view-emacs-news}). The oldest changes are at the bottom of
1136 the file, so you might want to read it starting there, rather than at
1139 The differences between Emacs versions 18 and 19 was rather dramatic;
1140 the introduction of frames, faces, and colors on windowing systems was
1141 obvious to even the most casual user.
1143 There are differences between Emacs versions 19 and 20 as well, but many
1144 are more subtle or harder to find. Among the changes are the inclusion
1145 of MULE code for languages that use non-Latin characters and for mixing
1146 several languages in the same document; the ``Customize'' facility for
1147 modifying variables without having to use Lisp; and automatic conversion
1148 of files from Macintosh, Microsoft, and Unix platforms.
1150 A number of older Lisp packages, such as Gnus, Supercite and the
1151 calendar/diary, have been updated and enhanced to work with Emacs 20,
1152 and are now included with the standard distribution.
1155 @node New in Emacs 21, , New in Emacs 20, Status of Emacs
1156 @section What is different about Emacs 21?
1157 @cindex Differences between Emacs 20 and Emacs 21
1158 @cindex Emacs 21, new features in
1159 @cindex Recently introduced features
1161 @cindex Variable-size fonts
1162 @cindex Toolbar support
1163 Emacs 21 features a thorough rewrite of the display engine. The new
1164 display engine supports variable-size fonts, images, and can play sounds
1165 on platforms which support that. As a result, the visual appearance of
1166 Emacs, when it runs on a windowed display, is much more reminiscent of
1167 modern GUI programs, and includes 3D widgets (used for the mode line and
1168 the scroll bars), a configurable and extensible toolbar, tooltips
1169 (a.k.a.@: balloon help), and other niceties.
1171 @cindex Colors on text-only terminals
1173 In addition, Emacs 21 supports faces on text-only terminals. This means
1174 that you can now have colors when you run Emacs on a GNU/Linux console
1175 and on @code{xterm} with @kbd{emacs -nw}.
1177 @c ------------------------------------------------------------
1178 @node Common requests, Bugs and problems, Status of Emacs, Top
1179 @chapter Common requests
1180 @cindex Common requests
1183 * Setting up a customization file::
1184 * Debugging a customization file::
1186 * Displaying the current line or column::
1187 * Displaying the current file name in the titlebar::
1188 * Turning on abbrevs by default::
1189 * Turning on auto-fill by default::
1190 * Associating modes with files::
1191 * Working with unprintable characters::
1192 * Highlighting a region::
1193 * Controlling case sensitivity::
1194 * Wrapping words automatically::
1196 * Checking TeX and *roff documents::
1197 * Changing load-path::
1198 * Using an already running Emacs process::
1199 * Compiler error messages::
1200 * Indenting switch statements::
1201 * Customizing C and C++ indentation::
1202 * Horizontal scrolling::
1204 * Turning off beeping::
1205 * Turning the volume down::
1206 * Automatic indentation::
1207 * Matching parentheses::
1208 * Hiding #ifdef lines::
1209 * Repeating commands::
1210 * Valid X resources::
1211 * Evaluating Emacs Lisp code::
1212 * Changing the length of a Tab::
1213 * Inserting > at the beginning of each line::
1214 * Underlining paragraphs::
1215 * Repeating a command as many times as possible::
1216 * Forcing the cursor to remain in the same column::
1217 * Forcing Emacs to iconify itself::
1218 * Using regular expressions::
1219 * Replacing text across multiple files::
1220 * Documentation for etags::
1221 * Disabling backups::
1222 * Disabling auto-save-mode::
1223 * Going to a line by number::
1224 * Modifying pull-down menus::
1225 * Deleting menus and menu options::
1226 * Turning on syntax highlighting::
1227 * Scrolling only one line::
1228 * Replacing highlighted text::
1229 * Editing MS-DOS files::
1230 * Filling paragraphs with a single space::
1231 * Escape sequences in shell output::
1234 @node Setting up a customization file, Colors on a TTY, Common requests, Common requests
1235 @section How do I set up a @file{.emacs} file properly?
1236 @cindex @file{.emacs} file, setting up
1237 @cindex Init file, setting up
1238 @cindex Customization file, setting up
1240 @inforef{Init File, Init File, emacs}
1242 In general, new Emacs users should not have @file{.emacs} files, because
1243 it causes confusing non-standard behavior. Then they send questions to
1244 @email{help-gnu-emacs@@gnu.org} asking why Emacs isn't behaving as
1247 Beginning with version 20.1, Emacs includes the new Customize
1248 facility, which can be invoked using @kbd{M-x customize @key{RET}}.
1249 This allows users who are unfamiliar with Emacs Lisp to modify their
1250 @file{.emacs} files in a relatively straightforward way, using menus
1251 rather than Lisp code. Not all packages support Customize as of this
1252 writing, but the number is growing fairly steadily.
1254 While Customize might indeed make it easier to configure Emacs,
1255 consider taking a bit of time to learn Emacs Lisp and modifying your
1256 @file{.emacs} directly. Simple configuration options are described
1257 rather completely in @inforef{Init File, Init File, emacs}, for users
1258 interested in performing frequently requested, basic tasks.
1260 @node Colors on a TTY, Debugging a customization file, Setting up a customization file, Common requests
1261 @section How do I get colors and syntax highlighting on a TTY?
1262 @cindex Colors on a TTY
1263 @cindex Syntax highlighting on a TTY
1264 @cindex Console, colors
1266 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1267 i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when
1268 invoked as @samp{emacs -nw} on X and MS-Windows. (Colors and faces were
1269 supported in the MS-DOS port since Emacs 19.29.) Emacs automatically
1270 detects color support at startup and uses it if available. If you think
1271 that your terminal supports colors, but Emacs won't use them, check the
1272 @code{termcap} entry for your display type for color-related
1275 The command @kbd{M-x list-colors-display} pops up a window which
1276 exhibits all the colors Emacs knows about on the current display.
1278 Syntax highlighting is usually turned off by default; see @ref{Turning
1279 on syntax highlighting}, for instructions how to turn it on.
1281 @node Debugging a customization file, Displaying the current line or column, Colors on a TTY, Common requests
1282 @section How do I debug a @file{.emacs} file?
1283 @cindex Debugging @file{.emacs} file
1284 @cindex @file{.emacs} debugging
1285 @cindex Init file debugging
1286 @cindex @samp{-debug-init} option
1288 Start Emacs with the @samp{-debug-init} command-line option. This
1289 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1290 file, and places you in the debugger if something goes wrong. The top
1291 line in the @file{trace-back} buffer will be the error message, and the
1292 second or third line of that buffer will display the Lisp code from your
1293 @file{.emacs} file that caused the problem.
1295 You can also evaluate an individual function or argument to a function
1296 in your @file{.emacs} file by moving the cursor to the end of the
1297 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1300 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1301 variables which you are trying to set or use.
1303 @node Displaying the current line or column, Displaying the current file name in the titlebar, Debugging a customization file, Common requests
1304 @section How do I make Emacs display the current line (or column) number?
1305 @cindex @code{line-number-mode}
1306 @cindex Displaying the current line or column
1307 @cindex Line number, displaying the current
1308 @cindex Column, displaying the current
1309 @cindex @code{mode-line-format}
1311 To have Emacs automatically display the current line number of the point
1312 in the mode line, do @kbd{M-x line-number-mode}. You can also put the
1316 (setq line-number-mode t)
1320 in your @file{.emacs} file to achieve this whenever you start Emacs.
1321 (Line number display is on by default, unless your site-specific
1322 initialization disables it.) Note that Emacs will not display the line
1323 number if the buffer's size in bytes is larger than the value of the
1324 variable @code{line-number-display-limit}.
1326 As of Emacs 20, you can similarly display the current column with
1327 @kbd{M-x column-number-mode}, or by putting the form
1330 (setq column-number-mode t)
1334 in your @file{.emacs} file.
1336 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1337 will insert the current column's value into the mode line. See the
1338 documentation for @code{mode-line-format} (using @kbd{C-h v
1339 mode-line-format @key{RET}}) for more information on how to set and use
1342 Users of all Emacs versions can display the current column using the
1343 @samp{column} package written by @email{abraham@@dina.kvl.dk, Per
1344 Abrahamsen}. @xref{Packages that do not come with Emacs}, for
1345 instructions on how to get it.
1347 @cindex Set number capability in @code{vi} emulators
1348 None of the @code{vi} emulation modes provide the ``set number''
1349 capability of @code{vi} (as far as we know).
1351 @node Displaying the current file name in the titlebar, Turning on abbrevs by default, Displaying the current line or column, Common requests
1352 @section How can I modify the titlebar to contain the current file name?
1353 @cindex Titlebar, displaying the current file name in
1354 @cindex File name, displaying in the titlebar
1355 @cindex @code{frame-title-format}
1357 The contents of an Emacs frame's titlebar is controlled by the variable
1358 @code{frame-title-format}, which has the same structure as the variable
1359 @code{mode-line-format}. (Use @kbd{C-h v} or @kbd{M-x
1360 describe-variable} to get information about one or both of these
1363 By default, the titlebar for a frame does contain the name of the buffer
1364 currently being visited, except if there is a single frame. In such a
1365 case, the titlebar contains Emacs invocation name and the name of the
1366 machine at which Emacs was invoked. This is done by setting
1367 @code{frame-title-format} to the default value of
1370 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1373 To modify the behavior such that frame titlebars contain the buffer's
1374 name regardless of the number of existing frames, include the following
1375 in your @file{.emacs}:
1378 (setq frame-title-format "%b")
1381 @node Turning on abbrevs by default, Turning on auto-fill by default, Displaying the current file name in the titlebar, Common requests
1382 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1383 @cindex Abbrevs, turning on by default
1385 Put this in your @file{.emacs} file:
1389 (quietly-read-abbrev-file)
1392 (add-hook '@var{mymode}-mode-hook
1394 (setq abbrev-mode t)))
1397 @node Turning on auto-fill by default, Associating modes with files, Turning on abbrevs by default, Common requests
1398 @section How do I turn on @code{auto-fill-mode} by default?
1399 @cindex @code{auto-fill-mode}, activating automatically
1400 @cindex Filling automatically
1401 @cindex Automatic entry to @code{auto-fill-mode}
1403 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1406 To turn it on for every buffer in a certain mode, you must use the hook
1407 for that mode. For example, to turn on @code{auto-fill} mode for all
1408 text buffers, including the following in your @file{.emacs} file:
1411 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1414 If you want @code{auto-fill} mode on in all major modes, do this:
1417 (setq-default auto-fill-function 'do-auto-fill)
1420 @node Associating modes with files, Working with unprintable characters, Turning on auto-fill by default, Common requests
1421 @section How do I make Emacs use a certain major mode for certain files?
1422 @cindex Associating modes with files
1423 @cindex File extensions and modes
1424 @cindex @code{auto-mode-alist}, modifying
1425 @cindex Modes, associating with file extensions
1427 If you want to use a certain mode @var{foo} for all files whose names end
1428 with the extension @file{.@var{bar}}, this will do it for you:
1431 (setq auto-mode-alist (cons '("\\.@var{bar}\\'" . @var{foo}-mode) auto-mode-alist))
1434 Otherwise put this somewhere in the first line of any file you want to
1435 edit in the mode @var{foo} (in the second line, if the first line begins
1442 @cindex Major mode for shell scripts
1443 Beginning with Emacs 19, the variable @code{interpreter-mode-alist}
1444 specifies which mode to use when loading a shell script. (Emacs
1445 determines which interpreter you're using by examining the first line of
1446 the script.) This feature only applies when the file name doesn't
1447 indicate which mode to use. Use @kbd{C-h v} (or @kbd{M-x
1448 describe-variable}) on @code{interpreter-mode-alist} to learn more.
1450 @node Working with unprintable characters, Highlighting a region, Associating modes with files, Common requests
1451 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1452 @cindex Unprintable characters, working with
1453 @cindex Working with unprintable characters
1454 @cindex Control characters, working with
1455 @cindex Eight-bit characters, working with
1456 @cindex Searching for unprintable characters
1457 @cindex Regexps and unprintable characters
1459 To search for a single character that appears in the buffer as, for
1460 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}. (This assumes
1461 the value of @code{search-quote-char} is 17 (i.e., @kbd{C-q}).)
1462 Searching for @strong{all} unprintable characters is best done with a
1463 regular expression (@dfn{regexp}) search. The easiest regexp to use for
1464 the unprintable chars is the complement of the regexp for the printable
1470 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1473 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1477 To type these special characters in an interactive argument to
1478 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1479 use @kbd{C-q}. (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1480 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.) So,
1481 to search for unprintable characters using @code{re-search-forward}:
1483 @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}}
1485 Using @code{isearch-forward-regexp}:
1487 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1489 To delete all unprintable characters, simply use replace-regexp:
1491 @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}}
1493 Replacing is similar to the above. To replace all unprintable
1494 characters with a colon, use:
1496 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}
1501 You don't need to quote @key{TAB} with either isearch or typing
1502 something in the minibuffer.
1506 @node Highlighting a region, Controlling case sensitivity, Working with unprintable characters, Common requests
1507 @section How can I highlight a region of text in Emacs?
1508 @cindex Highlighting text
1509 @cindex Text, highlighting
1510 @cindex @code{transient-mark-mode}
1511 @cindex Region, highlighting a
1513 You can cause the region to be highlighted when the mark is active by
1517 (transient-mark-mode t)
1521 in your @file{.emacs} file. (Also see @ref{Turning on syntax
1524 @node Controlling case sensitivity, Wrapping words automatically, Highlighting a region, Common requests
1525 @section How do I control Emacs's case-sensitivity when searching/replacing?
1526 @cindex @code{case-fold-search}
1527 @cindex Case sensitivity of searches
1528 @cindex Searching without case sensitivity
1529 @cindex Ignoring case in searches
1531 For searching, the value of the variable @code{case-fold-search}
1532 determines whether they are case sensitive:
1535 (setq case-fold-search nil) ; make searches case sensitive
1536 (setq case-fold-search t) ; make searches case insensitive
1539 @cindex Case sensitivity in replacements
1540 @cindex Replacing, and case sensitivity
1541 @cindex @code{case-replace}
1542 Similarly, for replacing, the variable @code{case-replace} determines
1543 whether replacements preserve case.
1545 To change the case sensitivity just for one major mode, use the major
1546 mode's hook. For example:
1549 (add-hook '@var{foo}-mode-hook
1551 (setq case-fold-search nil)))
1554 @node Wrapping words automatically, Spell-checkers, Controlling case sensitivity, Common requests
1555 @section How do I make Emacs wrap words for me?
1556 @cindex Wrapping word automatically
1557 @cindex Wrapping lines
1559 @cindex @code{auto-fill-mode}, introduction to
1560 @cindex Maximum line width, default value
1561 @cindex @code{fill-column}, default value
1563 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1564 The default maximum line width is 70, determined by the variable
1565 @code{fill-column}. To learn how to turn this on automatically, see
1566 @ref{Turning on auto-fill by default}.
1568 @node Spell-checkers, Checking TeX and *roff documents, Wrapping words automatically, Common requests
1569 @section Where can I get a better spelling checker for Emacs?
1570 @cindex Checking spelling
1571 @cindex Spelling, checking text documents
1573 Use Ispell. @xref{Ispell}.
1575 @node Checking TeX and *roff documents, Changing load-path, Spell-checkers, Common requests
1576 @section How can I spell-check @TeX{} or *roff documents?
1577 @cindex Spelling, checking @TeX{} documents
1578 @cindex @TeX{} documents, checking spelling in
1580 Use Ispell. Ispell can handle @TeX{} and *roff documents.
1583 @node Changing load-path, Using an already running Emacs process, Checking TeX and *roff documents, Common requests
1584 @section How do I change @code{load-path}?
1585 @cindex @code{load-path}, modifying
1586 @cindex Modifying @code{load-path}
1587 @cindex Adding to @code{load-path}
1589 In general, you should only add to the @code{load-path}. You can add
1590 directory @var{/dir/subdir} to the load path like this:
1593 (setq load-path (cons "/dir/subdir/" load-path))
1596 To do this relative to your home directory:
1599 (setq load-path (cons "~/mysubdir/" load-path)
1602 @node Using an already running Emacs process, Compiler error messages, Changing load-path, Common requests
1603 @section How do I use an already running Emacs from another window?
1604 @cindex @code{emacsclient}
1605 @cindex Emacs server functions
1606 @cindex Using an existing Emacs process
1608 @code{emacsclient}, which comes with Emacs, is for editing a file using
1609 an already running Emacs rather than starting up a new Emacs. It does
1610 this by sending a request to the already running Emacs, which must be
1611 expecting the request.
1618 Emacs must have executed the @code{server-start} function for
1619 @samp{emacsclient} to work. This can be done either by a command line
1623 emacs -f server-start
1626 or by invoking @code{server-start} from @file{.emacs}:
1629 (if (@var{some conditions are met}) (server-start))
1632 When this is done, Emacs creates a Unix domain socket.
1633 The socket is either named @file{.emacs_server}, in the user's home directory,
1634 or @file{esrv-@var{userid}-@var{systemname}}, in the @file{/tmp}
1635 directory, depending on your system. See @var{server-socket-name}.
1637 To get your news reader, mail reader, etc., to invoke
1638 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1639 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}. You may
1640 have to specify the full pathname of the @samp{emacsclient} program
1645 setenv EDITOR emacsclient
1647 # using full pathname
1648 setenv EDITOR /usr/local/emacs/etc/emacsclient
1651 EDITOR=emacsclient ; export EDITOR
1657 When @samp{emacsclient} is run, it connects to the @file{.emacs_server}
1658 socket and passes its command line options to @samp{server}. When
1659 @samp{server} receives these requests, it sends this information to the
1660 the Emacs process, which at the next opportunity will visit the files
1661 specified. (Line numbers can be specified just like with Emacs.) The
1662 user will have to switch to the Emacs window by hand. When the user is
1663 done editing a file, the user can type @kbd{C-x #} (or @kbd{M-x
1664 server-edit}) to indicate this. If there is another buffer requested by
1665 @code{emacsclient}, Emacs will switch to it; otherwise
1666 @code{emacsclient} will exit, signaling the calling program to continue.
1668 @samp{emacsclient} and @samp{server} must be running on machines which
1669 share the same filesystem for this to work. The pathnames that
1670 @samp{emacsclient} specifies should be correct for the filesystem that
1671 the Emacs process sees. The Emacs process should not be suspended at
1672 the time @samp{emacsclient} is invoked. On Unix and GNU/Linux systems,
1673 @samp{emacsclient} should either be invoked from another X window, or
1674 from a shell window inside Emacs itself, or from another interactive
1675 session, e.g., by means of a @code{screen} program.
1677 @cindex @code{gnuserv}
1678 There is an enhanced version of @samp{emacsclient}/server called
1679 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman}
1680 which is available in the Emacs Lisp Archive (@pxref{Packages that do
1681 not come with Emacs}). @samp{gnuserv} uses Internet domain sockets, so
1682 it can work across most network connections. It also supports the
1683 execution of arbitrary Emacs Lisp forms and does not require the client
1684 program to wait for completion.
1686 The alpha version of an enhanced @samp{gnuserv} is available at
1688 @uref{ftp://ftp.wellfleet.com/netman/psmith/emacs/gnuserv-2.1alpha.tar.gz}
1692 @node Compiler error messages, Indenting switch statements, Using an already running Emacs process, Common requests
1693 @section How do I make Emacs recognize my compiler's funny error messages?
1694 @cindex Compiler error messages, recognizing
1695 @cindex Recognizing non-standard compiler errors
1696 @cindex Regexps for recognizing compiler errors
1697 @cindex Errors, recognizing compiler
1699 The variable @code{compilation-error-regexp-alist} helps control how
1700 Emacs parses your compiler output. It is a list of triplets of the form:
1701 @code{(@var{regexp} @var{file-idx} @var{line-idx})}, where @var{regexp},
1702 @var{file-idx} and @var{line-idx} are strings. To help determine what
1703 the constituent elements should be, load @file{compile.el} and then type
1704 @kbd{C-h v compilation-error-regexp-alist @key{RET}} to see the current
1705 value. A good idea is to look at @file{compile.el} itself as the
1706 comments included for this variable are quite useful---the regular
1707 expressions required for your compiler's output may be very close to one
1708 already provided. Once you have determined the proper regexps, use the
1709 following to inform Emacs of your changes:
1712 (setq compilation-error-regexp-alist
1713 (cons '(@var{regexp} @var{file-idx} @var{line-idx})
1714 compilation-error-regexp-alist))
1717 @node Indenting switch statements, Customizing C and C++ indentation, Compiler error messages, Common requests
1718 @section How do I change the indentation for @code{switch}?
1719 @cindex @code{switch}, indenting
1720 @cindex Indenting of @code{switch}
1722 Many people want to indent their @code{switch} statements like this:
1740 The solution at first appears to be: set @code{c-indent-level} to 4 and
1741 @code{c-label-offset} to -2. However, this will give you an indentation
1742 spacing of four instead of two.
1744 The @emph{real} solution is to use @code{cc-mode} (the default mode for
1745 C programming in Emacs 20 and later) and add the following line to yoyr
1749 (c-set-offset 'case-label '+)
1752 There appears to be no way to do this with the old @code{c-mode}.
1754 @node Customizing C and C++ indentation, Horizontal scrolling, Indenting switch statements, Common requests
1755 @section How to customize indentation in C, C@t{++}, and Java buffers?
1756 @cindex Indentation, how to customize
1757 @cindex Customize indentation
1759 The Emacs @code{cc-mode} features an interactive procedure for
1760 customizing the indentation style, which is fully explained in the
1761 @cite{CC Mode} manual that is part of the Emacs distribution, see
1762 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1763 The CC Mode Manual}. Here's a short summary of the procedure:
1767 Go to the beginning of the first line where you don't like the
1768 indentation and type @kbd{C-c C-o}. Emacs will prompt you for the
1769 syntactic symbol; type @key{RET} to accept the default it suggests.
1772 Emacs now prompts for the offset of this syntactic symbol, showing the
1773 default (the current definition) inside parentheses. You can choose
1778 No extra indentation.
1780 Indent one basic offset.
1782 Outdent one basic offset.
1784 Indent two basic offsets
1786 Outdent two basic offsets.
1788 Indent half basic offset.
1790 Outdent half basic offset.
1794 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1795 the line or the block according to what you just specified.
1798 If you don't like the result, go back to step 1. Otherwise, add the
1799 following line to your @file{.emacs}:
1802 (c-set-offset '@var{syntactic-symbol} @var{offset})
1806 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1807 when you type @kbd{C-c C-o} at the beginning of the line, and
1808 @var{offset} is one of the indentation symbols listed above (@code{+},
1809 @code{/}, @code{0}, etc.) that you've chosen during the interactive
1813 Go to the next line whose indentation is not to your liking and repeat
1817 It is recommended to put all the resulting @code{(c-set-offset ...)}
1818 customizations inside a C mode hook, like this:
1821 (defun my-c-mode-hook ()
1824 (add-hook 'c-mode-hook 'my-c-mode-hook)
1828 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1829 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1830 might be unavailable when @code{cc-mode} is not loaded.
1832 Note that @code{c-mode-hook} runs for C source files only; use
1833 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1834 Java sources, etc. If you want the same customizations to be in
1835 effect in @emph{all} languages supported by @code{cc-mode}, use
1836 @code{c-mode-common-hook}.
1838 @node Horizontal scrolling, Overwrite mode, Customizing C and C++ indentation, Common requests
1839 @section How can I make Emacs automatically scroll horizontally?
1840 @cindex @code{hscroll-mode}
1841 @cindex Horizontal scrolling
1842 @cindex Scrolling horizontally
1844 In Emacs 21 and later, this is on by default: if the variable
1845 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1846 automatically scrolls the display horizontally when point moves off the
1847 left or right edge of the window.
1849 In Emacs 20, use the @code{hscroll-mode}. Here is some information from
1850 the documentation, available by typing @kbd{C-h f hscroll-mode @key{RET}}:
1852 Automatically scroll horizontally when the point moves off the
1853 left or right edge of the window.
1857 Type @kbd{M-x hscroll-mode} to enable it in the current buffer.
1860 Type @kbd{M-x hscroll-global-mode} to enable it in every buffer.
1863 @code{turn-on-hscroll} is useful in mode hooks as in:
1866 (add-hook 'text-mode-hook 'turn-on-hscroll)
1870 @code{hscroll-margin} controls how close the cursor can get to the
1874 @code{hscroll-step-percent} controls how far to jump once we decide to do so.
1877 @node Overwrite mode, Turning off beeping, Horizontal scrolling, Common requests
1878 @section How do I make Emacs "typeover" or "overwrite" instead of inserting?
1879 @cindex @key{Insert}
1880 @cindex @code{overwrite-mode}
1881 @cindex Overwriting existing text
1882 @cindex Toggling @code{overwrite-mode}
1884 @kbd{M-x overwrite-mode} (a minor mode). This toggles
1885 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1886 is as easy as another @kbd{M-x overwrite-mode}.
1888 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1890 @node Turning off beeping, Turning the volume down, Overwrite mode, Common requests
1891 @section How do I stop Emacs from beeping on a terminal?
1892 @cindex Beeping, turning off
1893 @cindex Visible bell
1894 @cindex Bell, visible
1896 @email{martin@@cc.gatech.edu, Martin R. Frank} writes:
1898 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1899 and set the visible bell to nothing.
1901 That is, put the following in your @code{TERMCAP} environment variable
1902 (assuming you have one):
1908 And evaluate the following Lisp form:
1911 (setq visible-bell t)
1914 @node Turning the volume down, Automatic indentation, Turning off beeping, Common requests
1915 @section How do I turn down the bell volume in Emacs running under X?
1916 @cindex Bell, volume of
1917 @cindex Volume of bell
1919 On X Window system, you can adjust the bell volume and duration for all
1920 programs with the shell command @code{xset}.
1922 Invoking @code{xset} without any arguments produces some basic
1923 information, including the following:
1926 usage: xset [-display host:dpy] option ...
1929 To set bell volume, pitch and duration:
1930 b [vol [pitch [dur]]] b on
1933 @node Automatic indentation, Matching parentheses, Turning the volume down, Common requests
1934 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
1935 @cindex Indenting new lines
1936 @cindex New lines, indenting of
1937 @cindex Previous line, indenting according to
1938 @cindex Text indentation
1940 Such behavior is automatic in Emacs 20 and later. From the
1941 @file{etc/NEWS} file for Emacs 20.2:
1944 ** In Text mode, now only blank lines separate paragraphs. This makes
1945 it possible to get the full benefit of Adaptive Fill mode in Text mode,
1946 and other modes derived from it (such as Mail mode). @key{TAB} in Text
1947 mode now runs the command @code{indent-relative}; this makes a practical
1948 difference only when you use indented paragraphs.
1950 As a result, the old Indented Text mode is now identical to Text mode,
1951 and is an alias for it.
1953 If you want spaces at the beginning of a line to start a paragraph, use
1954 the new mode, Paragraph Indent Text mode.
1957 @cindex Prefixing lines
1959 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
1960 by default}), you can tell Emacs to prefix every line with a certain
1961 character sequence, the @dfn{fill prefix}. Type the prefix at the
1962 beginning of a line, position point after it, and then type @kbd{C-x .}
1963 (@code{set-fill-prefix}) to set the fill prefix. Thereafter,
1964 auto-filling will automatically put the fill prefix at the beginning of
1965 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
1966 prefix when refilling the paragraph.
1968 If you have paragraphs with different levels of indentation, you will
1969 have to set the fill prefix to the correct value each time you move to a
1970 new paragraph. To avoid this hassle, try one of the many packages
1971 available from the Emacs Lisp Archive (@pxref{Packages that do not come
1972 with Emacs}.) Look up ``fill'' and ``indent'' in the Lisp Code
1973 Directory for guidance.
1975 @node Matching parentheses, Hiding #ifdef lines, Automatic indentation, Common requests
1976 @section How do I show which parenthesis matches the one I'm looking at?
1977 @cindex Parentheses, matching
1978 @cindex @file{paren.el}
1979 @cindex Highlighting matching parentheses
1980 @cindex Pairs of parentheses, highlighting
1981 @cindex Matching parentheses
1983 As of version 19, Emacs comes with @file{paren.el}, which (when loaded)
1984 will automatically highlight matching parentheses whenever point (i.e.,
1985 the cursor) is located over one. To load @file{paren.el} automatically,
1992 in your @file{.emacs} file. @email{shutkoa@@ugsolutions.com, Alan Shutko}
1993 reports that as of version 20.1, you must also call @code{show-paren-mode} in
1994 your @file{.emacs} file:
2000 Customize will let you turn on @code{show-paren-mode}. Use @kbd{M-x
2001 customize-group @key{RET} paren-showing @key{RET}}. From within
2002 Customize, you can also go directly to the ``paren-showing'' group.
2004 Alternatives to paren include:
2009 If you're looking at a right parenthesis (or brace or bracket) you can
2010 delete it and reinsert it. Emacs will momentarily move the cursor to
2011 the matching parenthesis.
2014 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
2015 will skip over one set of balanced parentheses, so you can see which
2016 parentheses match. (You can train it to skip over balanced brackets
2017 and braces at the same time by modifying the syntax table.)
2019 @cindex Show matching paren as in @code{vi}
2021 Here is some Emacs Lisp that will make the @key{%} key show the matching
2022 parenthesis, like in @code{vi}. In addition, if the cursor isn't over a
2023 parenthesis, it simply inserts a % like normal.
2026 ;; By an unknown contributor
2028 (global-set-key "%" 'match-paren)
2030 (defun match-paren (arg)
2031 "Go to the matching paren if on a paren; otherwise insert %."
2033 (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2034 ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2035 (t (self-insert-command (or arg 1)))))
2040 @node Hiding #ifdef lines, Repeating commands, Matching parentheses, Common requests
2041 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2042 @cindex @code{#ifdef}, selective display of
2043 @cindex @code{hide-ifdef-mode}
2044 @cindex Hiding @code{#ifdef} text
2045 @cindex Selectively displaying @code{#ifdef} code
2047 @kbd{M-x hide-ifdef-mode}. (This is a minor mode.) You might also want
2048 to try @file{cpp.el}, available at the Emacs Lisp Archive
2049 (@pxref{Packages that do not come with Emacs}).
2051 @node Repeating commands, Valid X resources, Hiding #ifdef lines, Common requests
2052 @section Is there an equivalent to the @code{.} (dot) command of vi?
2053 @cindex Repeating commands as with @code{vi}
2054 @cindex Command, repeat last
2055 @cindex @code{.}, equivalent to @code{vi} command
2057 (@code{.} is the redo command in @code{vi}. It redoes the last
2058 insertion/deletion.)
2060 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2061 that repeats the last command. If you preface it with a prefix
2062 argument, the prefix arg is applied to the command.
2064 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2065 (@code{repeat-complex-command}) to reinvoke commands that used the
2066 minibuffer to get arguments. In @code{repeat-complex-command} you can
2067 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2068 keyboard has these keys) to scan through all the different complex
2069 commands you've typed.
2071 To repeat a set of commands, use keyboard macros. (@inforef{Keyboard
2072 Macros, Keyboard Macros, emacs}.)
2074 If you're really desperate for the @code{.} command, use VIPER, a
2075 @code{vi} emulation mode which comes with Emacs, and which appears to
2076 support it. (@xref{VIPER}.)
2078 @node Valid X resources, Evaluating Emacs Lisp code, Repeating commands, Common requests
2079 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2080 @cindex Resources, X
2082 @cindex Setting X resources
2084 @inforef{Resources X, Resources X, emacs}.
2086 You can also use a resource editor, such as editres (for X11R5 and
2087 onwards), to look at the resource names for the menu bar, assuming Emacs
2088 was compiled with the X toolkit.
2090 @node Evaluating Emacs Lisp code, Changing the length of a Tab, Valid X resources, Common requests
2091 @section How do I execute ("evaluate") a piece of Emacs Lisp code?
2092 @cindex Evaluating Lisp code
2093 @cindex Lisp forms, evaluating
2095 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2096 Emacs Lisp @dfn{form}:
2101 If you want it evaluated every time you run Emacs, put it in a file
2102 named @file{.emacs} in your home directory. This is known as ``your
2103 @file{.emacs} file,'' and contains all of your personal customizations.
2106 You can type the form in the @file{*scratch*} buffer, and then type
2107 @key{LFD} (or @kbd{C-j}) after it. The result of evaluating the form
2108 will be inserted in the buffer.
2111 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2112 before or around point.
2115 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2116 before point and prints its value in the echo area.
2119 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2120 form in the minibuffer which will be evaluated once you press @key{RET}.
2123 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2124 forms in a file. (To do this from Lisp use the function @code{load}
2127 The functions @code{load-library}, @code{eval-region},
2128 @code{eval-current-buffer}, @code{require}, and @code{autoload} are also
2129 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2134 @node Changing the length of a Tab, Inserting > at the beginning of each line, Evaluating Emacs Lisp code, Common requests
2135 @section How do I change Emacs's idea of the @key{TAB} character's length?
2137 @cindex Length of tab character
2138 @cindex @code{default-tab-width}
2140 Set the variable @code{default-tab-width}. For example, to set
2141 @key{TAB} stops every 10 characters, insert the following in your
2145 (setq default-tab-width 10)
2148 Do not confuse variable @code{tab-width} with variable
2149 @code{tab-stop-list}. The former is used for the display of literal
2150 @key{TAB} characters. The latter controls what characters are inserted
2151 when you press the @key{TAB} character in certain modes.
2153 @node Inserting > at the beginning of each line, Underlining paragraphs, Changing the length of a Tab, Common requests
2154 @section How do I insert @samp{>} at the beginning of every line?
2155 @cindex Prefix character, inserting in mail/news replies
2156 @cindex Replies to mail/news, inserting a prefix character
2157 @cindex @code{mail-yank-prefix}
2158 @cindex Mail replies, inserting a prefix character
2159 @cindex News replies, inserting a prefix character
2161 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2162 @key{RET} ^ @key{RET} > @key{RET}}.
2164 To do this to a region, use @code{string-insert-rectangle}.
2165 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2166 want to prefix, move the cursor to last line to be prefixed, and type
2167 @kbd{M-x string-insert-rectangle @key{RET}}. To do this for the whole
2168 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2170 If you are trying to prefix a yanked mail message with @samp{>}, you
2171 might want to set the variable @code{mail-yank-prefix}. Better yet, use
2172 the Supercite package (@pxref{Supercite}), which provides flexible
2173 citation for yanked mail and news messages; it is included in Emacs
2174 since version 19.20. @xref{Changing the included text prefix}, for
2175 additional information.
2177 @node Underlining paragraphs, Repeating a command as many times as possible, Inserting > at the beginning of each line, Common requests
2178 @section How do I insert "_^H" before each character in a region to get an underlined paragraph?
2179 @cindex Underlining a region of text
2180 @cindex @code{underline-region}
2182 Mark the region and then type @kbd{M-x underline-region @key{RET}}.
2184 @node Repeating a command as many times as possible, Forcing the cursor to remain in the same column, Underlining paragraphs, Common requests
2185 @section How do I repeat a command as many times as possible?
2186 @cindex Repeating commands many times
2187 @cindex Commands, repeating many times
2189 Use @kbd{C-x (} and @kbd{C-x )} to make a keyboard macro that invokes
2190 the command and then type @kbd{M-0 C-x e}.
2192 Any messages your command prints in the echo area will be suppressed.
2194 If you need to repeat a command a small number of times, you can use
2195 @kbd{C-x z}, see @ref{Repeating commands}.
2197 @node Forcing the cursor to remain in the same column, Forcing Emacs to iconify itself, Repeating a command as many times as possible, Common requests
2198 @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?
2199 @cindex @code{picture-mode}
2200 @cindex Remaining in the same column, regardless of contents
2201 @cindex Vertical movement in empty documents
2203 @kbd{M-x picture-mode}.
2205 @node Forcing Emacs to iconify itself, Using regular expressions, Forcing the cursor to remain in the same column, Common requests
2206 @section How do I tell Emacs to iconify itself?
2207 @cindex Iconification under the X Window System
2208 @cindex X Window System and iconification
2209 @cindex Suspending Emacs
2211 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2212 otherwise. @inforef{Misc X, Misc X, emacs}.
2214 @node Using regular expressions, Replacing text across multiple files, Forcing Emacs to iconify itself, Common requests
2215 @section How do I use regexps (regular expressions) in Emacs?
2217 @cindex Regular expressions
2218 @cindex Differences between Unix and Emacs regexps
2219 @cindex Unix regeps, differences from Emacs
2220 @cindex Text strings, putting regexps in
2222 @inforef{Regexps, Regexps, emacs}.
2224 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2225 are @samp{\(} and @samp{\)}. Also, the string syntax for a backslash is
2226 @samp{\\}. To specify a regular expression like @samp{xxx\(foo\|bar\)}
2227 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2229 Note the doubled backslashes!
2234 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2235 (@samp{[^...]}) can match a newline character (@key{LFD} a.k.a.@:
2236 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2237 characters not to match.
2240 The character syntax regexps (e.g., @samp{\sw}) are not
2241 meaningful inside character set regexps (e.g., @samp{[aeiou]}). (This
2242 is actually typical for regexp syntax.)
2246 @node Replacing text across multiple files, Documentation for etags, Using regular expressions, Common requests
2247 @section How do I perform a replace operation across more than one file?
2248 @cindex Replacing strings across files
2249 @cindex Multiple files, replacing across
2250 @cindex Files, replacing strings across multiple
2252 The ``tags'' feature of Emacs includes the command
2253 @code{tags-query-replace} which performs a query-replace across all the
2254 files mentioned in the @file{TAGS} file. @inforef{Tags Search, Tags Search,
2257 As of Emacs 19.29, Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x
2258 d}) supports the command @code{dired-do-query-replace}, which allows
2259 users to replace regular expressions in multiple files.
2261 @node Documentation for etags, Disabling backups, Replacing text across multiple files, Common requests
2262 @section Where is the documentation for @code{etags}?
2263 @cindex Documentation for @code{etags}
2264 @cindex @code{etags}, documentation for
2266 The @code{etags} man page should be in the same place as the
2267 @code{emacs} man page.
2269 Quick command-line switch descriptions are also available. For example,
2272 @node Disabling backups, Disabling auto-save-mode, Documentation for etags, Common requests
2273 @section How do I disable backup files?
2274 @cindex Backups, disabling
2275 @cindex Disabling backups
2277 You probably don't want to do this, since backups are useful, especially
2278 when something goes wrong.
2280 To avoid seeing backup files (and other "uninteresting" files) in Dired,
2281 load @code{dired-x} by adding the following to your @file{.emacs} file:
2284 (add-hook 'dired-load-hook
2289 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2290 You can make omitting the default for new dired buffers by putting the
2291 following in your @file{.emacs}:
2294 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2297 If you're tired of seeing backup files whenever you do an @samp{ls} at
2298 the Unix shell, try GNU @code{ls} with the @samp{-B} option. GNU
2299 @code{ls} is part of the GNU Fileutils package, available from
2300 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2302 To disable or change the way backups are made, @inforef{Backup Names, ,
2305 @cindex Backup files in a single directory
2306 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2307 by customizing the variable @code{backup-directory-alist}. This
2308 variable's value specifies that files whose names match specific patters
2309 should have their backups put in certain directories. A typical use is
2310 to add the element @code{("." . @var{dir})} to force Emacs to put
2311 @strong{all} backup files in the directory @file{dir}.
2313 @node Disabling auto-save-mode, Going to a line by number, Disabling backups, Common requests
2314 @section How do I disable @code{auto-save-mode}?
2315 @cindex Disabling @code{auto-save-mode}
2317 @cindex Saving at frequent intervals
2319 You probably don't want to do this, since auto-saving is useful,
2320 especially when Emacs or your computer crashes while you are editing a
2323 Instead, you might want to change the variable
2324 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2325 waits before auto-saving. Increasing this value forces Emacs to wait
2326 longer between auto-saves, which might annoy you less.
2328 You might also want to look into Sebastian Kremer's @code{auto-save}
2329 package, available from the Lisp Code Archive (@pxref{Packages that do not come
2331 package also allows you to place all auto-save files in one directory,
2332 such as @file{/tmp}.
2334 To disable or change how @code{auto-save-mode} works, @inforef{Auto
2337 @node Going to a line by number, Modifying pull-down menus, Disabling auto-save-mode, Common requests
2338 @section How can I go to a certain line given its number?
2339 @cindex Going to a line by number
2340 @cindex Compilation error messages
2341 @cindex Recompilation
2343 Are you sure you indeed need to go to a line by its number? Perhaps all
2344 you want is to display a line in your source file for which a compiler
2345 printed an error message? If so, compiling from within Emacs using the
2346 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2347 effective way of doing that. Emacs automatically intercepts the compile
2348 error messages, inserts them into a special buffer called
2349 @code{*compilation*}, and lets you visit the locus of each message in
2350 the source. Type @kbd{C-x `} to step through the offending lines one by
2351 one. Click @kbd{Mouse-2} or press @key{RET} on a message text in the
2352 @code{*compilation*} buffer to go to the line whose number is mentioned
2355 But if you indeed need to go to a certain text line, type @kbd{M-x
2356 goto-line @key{RET}}. Emacs will prompt you for the number of the line
2357 and go to that line.
2359 You can do this faster by invoking @code{goto-line} with a numeric
2360 argument that is the line's number. For example, @kbd{C-u 286 M-x
2361 goto-line @key{RET}} will jump to line number 286 in the current
2364 If you need to use this command frequently, you might consider binding
2365 it to a key. The following snippet, if added to your @file{~/.emacs}
2366 file, will bind the sequence @kbd{C-x g} to @code{goto-line}:
2369 (global-set-key "\C-xg" 'goto-line)
2373 @node Modifying pull-down menus, Deleting menus and menu options, Going to a line by number, Common requests
2374 @section How can I create or modify new pull-down menu options?
2375 @cindex Pull-down menus, creating or modifying
2376 @cindex Menus, creating or modifying
2377 @cindex Creating new menu options
2378 @cindex Modifying pull-down menus
2379 @cindex Menus and keymaps
2380 @cindex Keymaps and menus
2382 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2383 represents a local or global keymap. Selecting a menu title with the
2384 mouse displays that keymap's non-nil contents in the form of a menu.
2386 So to add a menu option to an existing menu, all you have to do is add a
2387 new definition to the appropriate keymap. Adding a @samp{Forward Word}
2388 item to the @samp{Edit} menu thus requires the following Lisp code:
2391 (define-key global-map
2392 [menu-bar edit forward]
2393 '("Forward word" . forward-word))
2397 The first line adds the entry to the global keymap, which includes
2398 global menu bar entries. Replacing the reference to @code{global-map}
2399 with a local keymap would add this menu option only within a particular
2402 The second line describes the path from the menu-bar to the new entry.
2403 Placing this menu entry underneath the @samp{File} menu would mean
2404 changing the word @code{edit} in the second line to @code{file}.
2406 The third line is a cons cell whose first element is the title that will
2407 be displayed, and whose second element is the function that will be
2408 called when that menu option is invoked.
2410 To add a new menu, rather than a new option to an existing menu, we must
2411 define an entirely new keymap:
2414 (define-key global-map [menu-bar words]
2415 (cons "Words" (make-sparse-keymap "Words")))
2418 The above code creates a new sparse keymap, gives it the name
2419 @samp{Words}, and attaches it to the global menu bar. Adding the
2420 @samp{Forward Word} item to this new menu would thus require the
2424 (define-key global-map
2425 [menu-bar words forward]
2426 '("Forward word" . forward-word))
2430 Note that because of the way keymaps work, menu options are displayed
2431 with the more recently defined items at the top. Thus if you were to
2432 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2433 order), the menu option @samp{baz} would appear at the top, and
2434 @samp{foo} would be at the bottom.
2436 One way to avoid this problem is to use the function @code{define-key-after},
2437 which works the same as @code{define-key}, but lets you modify where items
2438 appear. The following Lisp code would insert the @samp{Forward Word}
2439 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2443 (lookup-key global-map [menu-bar edit])
2445 '("Forward word" . forward-word)
2449 Note how the second and third arguments to @code{define-key-after} are
2450 different from those of @code{define-key}, and that we have added a new
2451 (final) argument, the function after which our new key should be
2454 To move a menu option from one position to another, simply evaluate
2455 @code{define-key-after} with the appropriate final argument.
2457 More detailed information---and more examples of how to create and
2458 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2459 ``Menu Keymaps''. (@xref{Emacs Lisp documentation}, for information on
2462 @node Deleting menus and menu options, Turning on syntax highlighting, Modifying pull-down menus, Common requests
2463 @section How do I delete menus and menu options?
2464 @cindex Deleting menus and menu options
2465 @cindex Menus, deleting
2467 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2468 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2472 (define-key global-map [menu-bar words] nil)
2475 Similarly, removing a menu option requires redefining a keymap entry to
2476 @code{nil}. For example, to delete the @samp{Forward word} menu option
2477 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2481 (define-key global-map [menu-bar edit forward] nil)
2484 @node Turning on syntax highlighting, Scrolling only one line, Deleting menus and menu options, Common requests
2485 @section How do I turn on syntax highlighting?
2486 @cindex Syntax highlighting
2487 @cindex @code{font-lock-mode}
2488 @cindex Highlighting based on syntax
2489 @cindex Colorizing text
2490 @cindex FAQ, @code{font-lock-mode}
2492 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2493 highlighting in the current buffer. With @code{font-lock-mode} turned
2494 on, different types of text will appear in different colors. For
2495 instance, if you turn on @code{font-lock-mode} in a programming mode,
2496 variables will appear in one face, keywords in a second, and comments in
2499 @cindex hilit19 is deprecated
2500 Earlier versions of Emacs supported hilit19, a similar package. Use of
2501 hilit19 is now considered non-standard, although @file{hilit19.el} comes
2502 with the stock Emacs distribution. It is no longer maintained.
2504 To turn @code{font-lock-mode} on within an existing buffer, use @kbd{M-x
2505 font-lock-mode @key{RET}}.
2507 To automatically invoke @code{font-lock-mode} when a particular major
2508 mode is invoked, set the major mode's hook. For example, to fontify all
2509 @code{c-mode} buffers, add the following to your @file{.emacs} file:
2512 (add-hook 'c-mode-hook 'turn-on-font-lock)
2515 To automatically invoke @code{font-lock-mode} for all major modes, you
2516 can turn on @code{global-font-lock-mode} by including the following line
2517 in your @file{.emacs} file:
2520 (global-font-lock-mode 1)
2524 This instructs Emacs to turn on font-lock mode in those buffers for
2525 which a font-lock mode definition has been provided (in the variable
2526 @code{font-lock-global-modes}). If you edit a file in
2527 @code{pie-ala-mode}, and no font-lock definitions have been provided for
2528 @code{pie-ala} files, then the above setting will have no effect on that
2531 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2532 and cause an annoying delay in display, so several features exist to
2535 @cindex Just-In-Time syntax highlighting
2536 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2537 activates the new @dfn{Just-In-Time fontification} provided by
2538 @code{jit-lock-mode}. @code{jit-lock-mode} defers the fontification of
2539 portions of buffer until you actually need to see them, and can also
2540 fontify while Emacs is idle. This makes display of the visible portion
2541 of a buffer almost instantaneous. For details about customizing
2542 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2544 @cindex Levels of syntax highlighting
2545 @cindex Decoration level, in @code{font-lock-mode}
2546 In versions of Emacs before 21, different levels of decoration are
2547 available, from slight to gaudy. More decoration means you need to wait
2548 more time for a buffer to be fontified (or a faster machine). To
2549 control how decorated your buffers should become, set the value of
2550 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2551 @code{nil} value indicating default (usually minimum) decoration, and a
2552 @code{t} value indicating the maximum decoration. For the gaudiest
2553 possible look, then, include the line
2556 (setq font-lock-maximum-decoration t)
2560 in your @file{.emacs} file. You can also set this variable such that
2561 different modes are highlighted in a different ways; for more
2562 information, see the documentation for
2563 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2564 describe-variable @key{RET}}).
2566 @cindex Lazy font-lock
2567 You might also want to investigate @code{fast-lock-mode} and
2568 @code{lazy-lock-mode}, versions of @code{font-lock-mode} that speed up
2569 highlighting. These are the alternatives for @code{jit-lock-mode} in
2570 versions of Emacs before 21.1. The advantage of @code{lazy-lock-mode}
2571 is that it only fontifies buffers when certain conditions are met, such
2572 as after a certain amount of idle time, or after you have finished
2573 scrolling through text. See the documentation for @code{lazy-lock-mode}
2574 by typing @kbd{C-h f @code{lazy-lock-mode}} (@kbd{M-x describe-function
2575 @key{RET} lazy-lock-mode @key{RET}}).
2577 Also see the documentation for the function @code{font-lock-mode},
2578 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2579 describe-function @key{RET} font-lock-mode @key{RET}}).
2581 For more information on font-lock mode, take a look at the
2582 @code{font-lock-mode} FAQ, maintained by
2583 @email{jari.aalto@@ntc.nokia.com, Jari Aalto} at
2585 @uref{ftp://cs.uta.fi/pub/ssjaaa/ema-font.gui}
2587 To print buffers with the faces (i.e., colors and fonts) intact, use
2588 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2589 ps-print-region-with-faces}. You will need a way to send text to a
2590 PostScript printer, or a PostScript interpreter such as Ghostscript;
2591 consult the documentation of the variables @code{ps-printer-name},
2592 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2594 @node Scrolling only one line, Replacing highlighted text, Turning on syntax highlighting, Common requests
2595 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2596 @cindex Scrolling only one line
2597 @cindex Reducing the increment when scrolling
2599 Place the following Lisp form in your @file{.emacs} file:
2602 (setq scroll-step 1)
2605 @inforef{Scrolling, Scrolling, emacs}.
2607 @node Replacing highlighted text, Editing MS-DOS files, Scrolling only one line, Common requests
2608 @section How can I replace highlighted text with what I type?
2609 @cindex @code{delete-selection-mode}
2610 @cindex Replacing highlighted text
2611 @cindex Highlighting and replacing text
2613 Use @code{delete-selection-mode}, which you can start automatically by
2614 placing the following Lisp form in your @file{.emacs} file:
2617 (delete-selection-mode t)
2620 According to the documentation string for @code{delete-selection-mode}
2621 (which you can read using @kbd{M-x describe-function @key{RET}
2622 delete-selection-mode @key{RET}}):
2625 When ON, typed text replaces the selection if the selection is active.
2626 When OFF, typed text is just inserted at point.
2629 This mode also allows you to delete (not kill) the highlighted region by
2632 @node Editing MS-DOS files, Filling paragraphs with a single space, Replacing highlighted text, Common requests
2633 @section How can I edit MS-DOS files using Emacs?
2634 @cindex Editing MS-DOS files
2635 @cindex MS-DOS files, editing
2636 @cindex Microsoft files, editing
2637 @cindex Windows files, editing
2639 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2640 performed transparently. You can open MS-DOS files on a Unix system,
2641 edit it, and save it without having to worry about the file format.
2643 When editing an MS-DOS style file, the mode line will indicate that it
2644 is a DOS file. On Unix and GNU/Linux systems, and also on a Macintosh,
2645 the string @samp{(DOS)} will appear near the left edge of the mode line;
2646 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2647 default, a backslash (@samp{\}) will appear in the mode line.
2649 If you are running a version of Emacs before 20.1, get @code{crypt++}
2650 from the Emacs Lisp Archive (@pxref{Packages that do not come with
2651 Emacs}). Among other things, @code{crypt++} transparently modifies
2652 MS-DOS files as they are loaded and saved, allowing you to ignore the
2653 different conventions that Unix and MS-DOS have for delineating the end
2656 @node Filling paragraphs with a single space, Escape sequences in shell output, Editing MS-DOS files, Common requests
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
2662 @email{ulm@@vsnhd1.cern.ch, Ulrich Mueller} suggests adding the
2663 following two lines to your @file{.emacs} file:
2666 (setq sentence-end "[.?!][]\"')@}]*\\($\\|[ \t]\\)[ \t\n]*")
2667 (setq sentence-end-double-space nil)
2670 @node Escape sequences in shell output, , Filling paragraphs with a single space, Common requests
2671 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2672 @cindex Escape sequences in @code{ls} output
2673 @cindex @code{ls} in Shell mode
2675 This happens because @code{ls} is aliased to @samp{ls --color} in your
2676 shell init file. You have two alternatives to solve this:
2680 Make the alias conditioned on the @code{EMACS} variable in the
2681 environment. When Emacs runs a subsidiary shell, it exports the
2682 @code{EMACS} variable with the value @code{t} to that shell. You can
2683 unalias @code{ls} when that happens, thus limiting the alias to your
2684 interactive sessions.
2687 Install the @code{ansi-color} package (bundled with Emacs 21.1 and
2688 later), which converts these ANSI escape sequences into colors.
2691 @c ------------------------------------------------------------
2692 @node Bugs and problems, Compiling and installing Emacs, Common requests, Top
2693 @chapter Bugs and problems
2694 @cindex Bugs and problems
2696 The Emacs manual lists some common kinds of trouble users could get
2697 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2698 Emacs Manual}, so you might look there if the problem you encounter
2699 isn't described in this chapter. If you decide you've discovered a bug,
2700 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2701 instructions how to do that.
2703 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2704 known problems with building and using Emacs on specific platforms;
2705 type @kbd{C-h P} to read it.
2708 * Problems with very large files::
2709 * ^M in the shell buffer::
2710 * Shell process exits abnormally::
2711 * Problems with Shell Mode on MS-Windows::
2712 * Termcap/Terminfo entries for Emacs::
2713 * Spontaneous entry into isearch-mode::
2714 * Problems talking to certain hosts::
2715 * Errors with init files::
2716 * Emacs ignores X resources::
2717 * Emacs ignores frame parameters::
2718 * Emacs takes a long time to visit files::
2719 * Editing files with $ in the name::
2720 * Shell mode loses the current directory::
2721 * Security risks with Emacs::
2722 * Dired claims that no file is on this line::
2725 @node Problems with very large files, ^M in the shell buffer, Bugs and problems, Bugs and problems
2726 @section Does Emacs have problems with files larger than 8 megabytes?
2727 @cindex Very large files, opening
2728 @cindex Large files, opening
2729 @cindex Opening very large files
2730 @cindex Maximum file size
2731 @cindex Files, maximum size
2733 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2734 files larger than 8 megabytes. As of version 19.29, the maximum buffer
2735 size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes. Emacs 20
2736 can be compiled on some 64-bit systems in a way that enlarges the buffer
2737 size up to 576,460,752,303,423,487 bytes, or 549,755,813 GBytes.
2739 If you are using a version of Emacs older than 19.29 and cannot upgrade,
2740 you will have to recompile. @email{lnz@@lucid.com, Leonard N. Zubkoff}
2741 suggests putting the following two lines in @file{src/config.h} before
2742 compiling Emacs to allow for 26-bit integers and pointers (and thus file
2743 sizes of up to 33,554,431 bytes):
2747 #define GCTYPEBITS 5
2751 This method may result in "ILLEGAL DATATYPE" and other random errors on
2754 @email{daveg@@csvax.cs.caltech.edu, David Gillespie} explains how this
2755 problems crops up; while his numbers are true only for pre-19.29
2756 versions of Emacs, the theory remains the same with current versions.
2759 Emacs is largely written in a dialect of Lisp; Lisp is a freely-typed
2760 language in the sense that you can put any value of any type into any
2761 variable, or return it from a function, and so on. So each value
2762 must carry a @dfn{tag} along with it identifying what kind of thing it
2763 is, e.g., integer, pointer to a list, pointer to an editing buffer, and
2764 so on. Emacs uses standard 32-bit integers for data objects, taking the
2765 top 8 bits for the tag and the bottom 24 bits for the value. So
2766 integers (and pointers) are somewhat restricted compared to true C
2767 integers and pointers.
2770 @node ^M in the shell buffer, Shell process exits abnormally, Problems with very large files, Bugs and problems
2771 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2772 @cindex Shell buffer, echoed commands and @samp{^M} in
2773 @cindex Echoed commands in @code{shell-mode}
2775 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2776 make them go away. If that doesn't work, you have several options:
2778 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2783 if ("$EMACS" == t) then
2784 if ($?tcsh) unset edit
2790 Or put this in your @file{.emacs_tcsh} file:
2797 Alternatively, use @code{csh} in your shell buffers instead of
2798 @code{tcsh}. One way is:
2801 (setq explicit-shell-file-name "/bin/csh")
2805 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2809 setenv ESHELL /bin/csh
2813 (You must start Emacs over again with the environment variable properly
2814 set for this to take effect.)
2816 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2817 with the following Lisp form,
2820 (setenv "ESHELL" "/bin/csh")
2823 The above solutions try to prevent the shell from producing the
2824 @samp{^M} characters in the first place. If this is not possible
2825 (e.g., if you use a Windows shell), you can get Emacs to remove these
2826 characters from the buffer by adding this to your @file{.emacs} init
2830 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2833 On a related note: If your shell is echoing your input line in the shell
2834 buffer, you might want to try the following command in your shell
2838 stty -icrnl -onlcr -echo susp ^Z
2841 @node Shell process exits abnormally, Problems with Shell Mode on MS-Windows, ^M in the shell buffer, Bugs and problems
2842 @section Why do I get "Process shell exited abnormally with code 1"?
2843 @cindex Abnormal exits from @code{shell-mode}
2844 @cindex @code{shell-mode} exits
2845 @cindex Process shell exited
2847 The most likely reason for this message is that the @samp{env} program
2848 is not properly installed. Compile this program for your architecture,
2849 and install it with @samp{a+x} permission in the architecture-dependent
2850 Emacs program directory. (You can find what this directory is at your
2851 site by inspecting the value of the variable @code{exec-directory} by
2852 typing @kbd{C-h v exec-directory @key{RET}}.)
2854 You should also check for other programs named @samp{env} in your path
2855 (e.g., SunOS has a program named @file{/usr/bin/env}). We don't
2856 understand why this can cause a failure and don't know a general
2857 solution for working around the problem in this case.
2859 The @samp{make clean} command will remove @samp{env} and other vital
2860 programs, so be careful when using it.
2862 It has been reported that this sometimes happened when Emacs was started
2863 as an X client from an xterm window (i.e., had a controlling tty) but the
2864 xterm was later terminated.
2866 See also @samp{PROBLEMS} (in the @file{etc} subdirectory of the
2867 top-level directory when you unpack the Emacs source) for other
2868 possible causes of this message.
2870 @node Problems with Shell Mode on MS-Windows, Termcap/Terminfo entries for Emacs, Shell process exits abnormally, Bugs and problems
2871 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2873 @cindex Shell Mode, and MS-Windows
2874 @cindex @code{explicit-shell-file-name}
2875 On MS-Windows, this might happen because Emacs tries to look for the
2876 shell in a wrong place. The default file name @file{/bin/sh} is
2877 usually incorrect for non-Unix systems. If you know where your shell
2878 executable is, set the variable @code{explicit-shell-file-name} in
2879 your @file{.emacs} file to point to its full file name, like this:
2882 (setq explicit-shell-file-name "d:/shells/bash.exe")
2885 If you don't know what shell does Emacs use, try the @kbd{M-!}
2886 command; if that works, put the following line into your
2890 (setq explicit-shell-file-name shell-file-name)
2893 @cindex Antivirus programs, and Shell Mode
2894 Some people have trouble with Shell Mode because of intrusive
2895 antivirus software; disabling the resident antivirus program solves
2896 the problems in those cases.
2898 @node Termcap/Terminfo entries for Emacs, Spontaneous entry into isearch-mode, Problems with Shell Mode on MS-Windows, Bugs and problems
2899 @section Where is the termcap/terminfo entry for terminal type "emacs"?
2902 @cindex Emacs entries for termcap/terminfo
2904 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2905 the @samp{TERMCAP} environment variable of subshells. It may help in
2906 certain situations (e.g., using rlogin from shell buffer) to add an
2907 entry for @samp{emacs} to the system-wide termcap file. Here is a
2908 correct termcap entry for @samp{emacs}:
2914 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2915 @code{captoinfo}. You need to generate
2916 @file{/usr/lib/terminfo/e/emacs}. It may work to simply copy
2917 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2919 Having a termcap/terminfo entry will not enable the use of full screen
2920 programs in shell buffers. Use @kbd{M-x terminal-emulator} for that
2923 A workaround to the problem of missing termcap/terminfo entries is to
2924 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2925 in your shell start up file. @code{csh} users could put this in their
2926 @file{.cshrc} files:
2929 if ("$term" == emacs) set term=dumb
2932 @node Spontaneous entry into isearch-mode, Problems talking to certain hosts, Termcap/Terminfo entries for Emacs, Bugs and problems
2933 @section Why does Emacs spontaneously start displaying "I-search:" and beeping?
2934 @cindex Spontaneous entry into isearch-mode
2935 @cindex isearch-mode, spontaneous entry into
2936 @cindex Beeping without obvious reason
2938 Your terminal (or something between your terminal and the computer) is
2939 sending @kbd{C-s} and @kbd{C-q} for flow control, and Emacs is receiving
2940 these characters and interpreting them as commands. (The @kbd{C-s}
2941 character normally invokes the @code{isearch-forward} command.) For
2942 possible solutions, see @ref{Handling C-s and C-q with flow control}.
2944 @node Problems talking to certain hosts, Errors with init files, Spontaneous entry into isearch-mode, Bugs and problems
2945 @section Why can't Emacs talk to certain hosts (or certain hostnames)?
2946 @cindex Hosts, Emacs cannot talk to
2947 @cindex @code{gethostbyname}, problematic version
2949 The problem may be that Emacs is linked with a wimpier version of
2950 @code{gethostbyname} than the rest of the programs on the machine. This
2951 is often manifested as a message on startup of ``X server not responding.
2952 Check your @samp{DISPLAY} environment variable.'' or a message of
2953 ``Unknown host'' from @code{open-network-stream}.
2955 On a Sun, this may be because Emacs had to be linked with the static C
2956 library. The version of @code{gethostbyname} in the static C library
2957 may only look in @file{/etc/hosts} and the NIS (YP) maps, while the
2958 version in the dynamic C library may be smart enough to check DNS in
2959 addition to or instead of NIS. On a Motorola Delta running System V
2960 R3.6, the version of @code{gethostbyname} in the standard library works,
2961 but the one that works with NIS doesn't (the one you get with -linet).
2962 Other operating systems have similar problems.
2969 Explicitly add the host you want to communicate with to @file{/etc/hosts}.
2972 Relink Emacs with this line in @file{src/config.h}:
2975 #define LIBS_SYSTEM -lresolv
2979 Replace @code{gethostbyname} and friends in @file{libc.a} with more
2980 useful versions such as the ones in @file{libresolv.a}. Then relink
2984 If you are actually running NIS, make sure that @code{ypbind} is
2985 properly told to do DNS lookups with the correct command line switch.
2989 @node Errors with init files, Emacs ignores X resources, Problems talking to certain hosts, Bugs and problems
2990 @section Why does Emacs say "Error in init file"?
2991 @cindex Error in @file{.emacs}
2992 @cindex Error in init file
2993 @cindex Init file, errors in
2994 @cindex @file{.emacs} file, errors in
2995 @cindex Debugging @file{.emacs} file
2997 An error occurred while loading either your @file{.emacs} file or the
2998 system-wide file @file{lisp/default.el}. Emacs 21.1 and later pops the
2999 @file{*Messages*} buffer, and puts there some additional information
3000 about the error, to provide some hints for debugging.
3002 For information on how to debug your @file{.emacs} file, see
3003 @ref{Debugging a customization file}.
3005 It may be the case that you need to load some package first, or use a
3006 hook that will be evaluated after the package is loaded. A common case
3007 of this is explained in @ref{Terminal setup code works after Emacs has
3010 @node Emacs ignores X resources, Emacs ignores frame parameters, Errors with init files, Bugs and problems
3011 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
3012 @cindex X resources being ignored
3013 @cindex Ignored X resources
3014 @cindex @file{.Xdefaults}
3016 As of version 19, Emacs searches for X resources in the files specified
3017 by the following environment variables:
3021 @item @code{XFILESEARCHPATH}
3022 @item @code{XUSERFILESEARCHPATH}
3023 @item @code{XAPPLRESDIR}
3027 This emulates the functionality provided by programs written using the
3030 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
3031 of file names separated by colons. @code{XAPPLRESDIR} should be a list
3032 of directory names separated by colons.
3034 Emacs searches for X resources:
3039 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
3042 then in the value of the @samp{XENVIRONMENT} environment variable,
3047 or if that is unset, in the file named
3048 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
3049 the name of the machine Emacs is running on),
3054 then in the screen-specific and server-wide resource properties provided
3060 or if those properties are unset, in the file named @file{~/.Xdefaults}
3066 then in the files listed in @samp{XUSERFILESEARCHPATH},
3071 or in files named @file{@var{lang}/Emacs} in directories listed in
3072 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
3073 environment variable), if the @samp{LANG} environment variable is set,
3075 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
3077 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
3080 or in @file{~/Emacs},
3085 then in the files listed in @code{XFILESEARCHPATH}.
3089 @node Emacs ignores frame parameters, Emacs takes a long time to visit files, Emacs ignores X resources, Bugs and problems
3090 @section Why don't my customizations of the frame parameters work?
3091 @cindex Frame parameters
3093 This probably happens because you have set the frame parameters in the
3094 variable @code{initial-frame-alist}. That variable holds parameters
3095 used only for the first frame created when Emacs starts. To customize
3096 the parameters of all frames, change the variable
3097 @code{default-frame-alist} instead.
3099 These two variables exist because many users customize the initial frame
3100 in a special way. For example, you could determine the position and
3101 size of the initial frame, but would like to control the geometry of the
3102 other frames by individually positioning each one of them.
3105 @node Emacs takes a long time to visit files, Editing files with $ in the name, Emacs ignores frame parameters, Bugs and problems
3106 @section Why does Emacs take 20 seconds to visit a file?
3107 @cindex Visiting files takes a long time
3108 @cindex Delay when visiting files
3109 @cindex Files, take a long time to visit
3111 Old versions of Emacs (i.e., versions before Emacs 20.x) often
3112 encountered this when the master lock file, @file{!!!SuperLock!!!}, has
3113 been left in the lock directory somehow. Delete it.
3115 @email{meuer@@geom.umn.edu, Mark Meuer} says that NeXT NFS has a bug
3116 where an exclusive create succeeds but returns an error status. This
3117 can cause the same problem. Since Emacs's file locking doesn't work
3118 over NFS anyway, the best solution is to recompile Emacs with
3119 @code{CLASH_DETECTION} undefined.
3121 @node Editing files with $ in the name, Shell mode loses the current directory, Emacs takes a long time to visit files, Bugs and problems
3122 @section How do I edit a file with a @samp{$} in its name?
3123 @cindex Editing files with @samp{$} in the name
3124 @cindex @samp{$} in file names
3125 @cindex File names containing @samp{$}, editing
3127 When entering a file name in the minibuffer, Emacs will attempt to expand
3128 a @samp{$} followed by a word as an environment variable. To suppress
3129 this behavior, type @kbd{$$} instead.
3131 @node Shell mode loses the current directory, Security risks with Emacs, Editing files with $ in the name, Bugs and problems
3132 @section Why does shell mode lose track of the shell's current directory?
3133 @cindex Current directory and @code{shell-mode}
3134 @cindex @code{shell-mode} and current directory
3135 @cindex Directory, current in @code{shell-mode}
3137 Emacs has no way of knowing when the shell actually changes its
3138 directory. This is an intrinsic limitation of Unix. So it tries to
3139 guess by recognizing @samp{cd} commands. If you type @kbd{cd} followed
3140 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
3141 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
3142 correctly guess the shell's new current directory. A huge variety of
3143 fixes and enhancements to shell mode for this problem have been written
3144 to handle this problem. Check the Lisp Code Directory (@pxref{Finding a
3145 package with particular functionality}).
3147 You can tell Emacs the shell's current directory with the command
3150 @node Security risks with Emacs, Dired claims that no file is on this line, Shell mode loses the current directory, Bugs and problems
3151 @section Are there any security risks in Emacs?
3152 @cindex Security with Emacs
3153 @cindex @samp{movemail} and security
3154 @cindex @code{file-local-variable} and security
3155 @cindex Synthetic X events and security
3156 @cindex X events and security
3161 The @file{movemail} incident. (No, this is not a risk.)
3163 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3164 chapter 4. The site at LBL had installed the @file{/etc/movemail}
3165 program setuid root. (As of version 19, @file{movemail} is in your
3166 architecture-specific directory; type @kbd{C-h v exec-directory
3167 @key{RET}} to see what it is.) Since @code{movemail} had not been
3168 designed for this situation, a security hole was created and users could
3169 get root privileges.
3171 @code{movemail} has since been changed so that this security hole will
3172 not exist, even if it is installed setuid root. However,
3173 @code{movemail} no longer needs to be installed setuid root, which
3174 should eliminate this particular risk.
3176 We have heard unverified reports that the 1988 Internet worm took
3177 advantage of this configuration problem.
3180 The @code{file-local-variable} feature. (Yes, a risk, but easy to
3183 There is an Emacs feature that allows the setting of local values for
3184 variables when editing a file by including specially formatted text near
3185 the end of the file. This feature also includes the ability to have
3186 arbitrary Emacs Lisp code evaluated when the file is visited.
3187 Obviously, there is a potential for Trojan horses to exploit this
3190 Emacs 18 allowed this feature by default; users could disable it by
3191 setting the variable @code{inhibit-local-variables} to a non-nil value.
3193 As of Emacs 19, Emacs has a list of local variables that create a
3194 security risk. If a file tries to set one of them, it asks the user to
3195 confirm whether the variables should be set. You can also tell Emacs
3196 whether to allow the evaluation of Emacs Lisp code found at the bottom
3197 of files by setting the variable @code{enable-local-eval}.
3199 For more information, @inforef{File Variables, File Variables, emacs}.
3202 Synthetic X events. (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3205 Emacs accepts synthetic X events generated by the @code{SendEvent}
3206 request as though they were regular events. As a result, if you are
3207 using the trivial host-based authentication, other users who can open X
3208 connections to your X workstation can make your Emacs process do
3209 anything, including run other processes with your privileges.
3211 The only fix for this is to prevent other users from being able to open
3212 X connections. The standard way to prevent this is to use a real
3213 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}. If using
3214 the @code{xauth} program has any effect, then you are probably using
3215 @samp{MIT-MAGIC-COOKIE-1}. Your site may be using a superior
3216 authentication method; ask your system administrator.
3218 If real authentication is not a possibility, you may be satisfied by
3219 just allowing hosts access for brief intervals while you start your X
3220 programs, then removing the access. This reduces the risk somewhat by
3221 narrowing the time window when hostile users would have access, but
3222 @emph{does not eliminate the risk}.
3224 On most computers running Unix and X, you enable and disable
3225 access using the @code{xhost} command. To allow all hosts access to
3233 at the shell prompt, which (on an HP machine, at least) produces the
3237 access control disabled, clients can connect from any host
3240 To deny all hosts access to your X server (except those explicitly
3241 allowed by name), use
3247 On the test HP computer, this command generated the following message:
3250 access control enabled, only authorized clients can connect
3255 @node Dired claims that no file is on this line, , Security risks with Emacs, Bugs and problems
3256 @section Dired says, "no file on this line" when I try to do something.
3257 @cindex Dired does not see a file
3259 @c FIXME: I think this is fixed in Emacs 21, but I didn't have time to
3261 Chances are you're using a localized version of Unix that doesn't use US
3262 date format in dired listings. You can check this by looking at dired
3263 listings or by typing @kbd{ls -l} to a shell and looking at the dates that
3266 Dired uses a regular expression to find the beginning of a file name.
3267 In a long Unix-style directory listing (@samp{ls -l}), the file name
3268 starts after the date. The regexp has thus been written to look for the
3269 date, the format of which can vary on non-US systems.
3271 There are two approaches to solving this. The first one involves
3272 setting things up so that @samp{ls -l} outputs US date format. This can
3273 be done by setting the locale. See your OS manual for more information.
3275 The second approach involves changing the regular expression used by
3276 dired, @code{dired-move-to-filename-regexp}.
3278 @c ------------------------------------------------------------
3279 @node Compiling and installing Emacs, Finding Emacs and related packages, Bugs and problems, Top
3280 @chapter Compiling and installing Emacs
3281 @cindex Compiling and installing Emacs
3284 * Installing Emacs::
3286 * Problems building Emacs::
3287 * Linking with -lX11 fails::
3290 @node Installing Emacs, Updating Emacs, Compiling and installing Emacs, Compiling and installing Emacs
3291 @section How do I install Emacs?
3292 @cindex Installing Emacs
3293 @cindex Unix systems, installing Emacs on
3294 @cindex Downloading and installing Emacs
3295 @cindex Retrieving and installing Emacs
3296 @cindex Building Emacs from source
3297 @cindex Source code, building Emacs from
3298 @cindex Unpacking and installing Emacs
3300 This answer is meant for users of Unix and Unix-like systems. Users of
3301 other operating systems should see the series of questions beginning
3302 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3303 and binaries, and how to install Emacs on those systems.
3305 For Unix and Unix-like systems, the easiest way is often to compile it
3306 from scratch. You will need:
3311 Emacs sources. @xref{Current GNU distributions}, for a list of ftp sites
3312 that make them available. On @file{ftp.gnu.org}, the main GNU
3313 distribution site, sources are available as
3315 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-@value{VER}.tar.gz}
3317 The above will obviously change as new versions of Emacs come out. For
3318 instance, when Emacs 21.42 is released, it will most probably be
3321 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-21.42.tar.gz}
3323 Again, you should use one of the GNU mirror sites (see @ref{Current GNU
3324 distributions}, and adjust the URL accordingly) so as to reduce load on
3328 @code{gzip}, the GNU compression utility. You can get @code{gzip} via
3329 anonymous ftp at mirrors of @file{ftp.gnu.org} sites; it should compile
3330 and install without much trouble on most systems. Once you have
3331 retrieved the Emacs sources, you will probably be able to uncompress
3332 them with the command
3335 gunzip --verbose emacs-@value{VER}.tar.gz
3339 changing the Emacs version (@value{VER}), as necessary. Once
3340 @code{gunzip} has finished doing its job, a file by the name of
3341 @file{emacs-@value{VER}.tar} should be in your build directory.
3344 @code{tar}, the @dfn{tape archiving} program, which moves multiple files
3345 into and out of archive files, or @dfn{tarfiles}. All of the files
3346 comprising the Emacs source come in a single tarfile, and must be
3347 extracted using @code{tar} before you can build Emacs. Typically, the
3348 extraction command would look like
3351 tar -xvvf emacs-@value{VER}.tar
3355 The @samp{x} indicates that we want to extract files from this tarfile,
3356 the two @samp{v}s force verbose output, and the @samp{f} tells
3357 @code{tar} to use a disk file, rather than one on the tape drive.
3359 If you're using GNU @code{tar} (available at mirrors of
3360 @file{ftp.gnu.org}), you can combine this step and the previous one by
3364 tar -zxvvf emacs-@value{VER}.tar.gz
3368 The additional @samp{z} at the beginning of the options list tells GNU
3369 @code{tar} to uncompress the file with @code{gunzip} before extracting
3370 the tarfile's components.
3374 At this point, the Emacs sources (all 70+ megabytes of them) should be
3375 sitting in a directory called @file{emacs-@value{VER}}. On most common
3376 Unix and Unix-like systems, you should be able to compile Emacs (with X
3377 Window system support) with the following commands:
3380 cd emacs-@value{VER} # change directory to emacs-@value{VER}
3381 ./configure # configure Emacs for your particular system
3382 make # use Makefile to build components, then Emacs
3385 If the @code{make} completes successfully, the odds are fairly good that
3386 the build has gone well. (@xref{Problems building Emacs}, if you weren't
3389 By default, Emacs is installed in the following directories:
3392 @item /usr/local/bin
3395 @item /usr/local/share/emacs/@value{VER}
3396 Lisp code and support files.
3398 @item /usr/local/info
3402 To install files in those default directories, become the superuser and
3409 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3410 and any Emacs Info files that might be in @file{/usr/local/info}.
3412 Much more verbose instructions (with many more hints and suggestions)
3413 come with the Emacs sources, in the file @file{INSTALL}.
3415 @node Updating Emacs, Problems building Emacs, Installing Emacs, Compiling and installing Emacs
3416 @section How do I update Emacs to the latest version?
3417 @cindex Updating Emacs
3419 @xref{Installing Emacs}, and follow the instructions there for
3422 Most files are placed in version-specific directories. Emacs
3423 @value{VER}, for instance, places files in
3424 @file{/usr/local/share/emacs/@value{VER}}.
3426 Upgrading should overwrite only, @file{/usr/local/bin/emacs} (the Emacs
3427 binary) and documentation in @file{/usr/local/info}. Back up these
3428 files before you upgrade, and you shouldn't have too much trouble.
3430 @node Problems building Emacs, Linking with -lX11 fails, Updating Emacs, Compiling and installing Emacs
3431 @section What should I do if I have trouble building Emacs?
3432 @cindex Problems building Emacs
3433 @cindex Errors when building Emacs
3435 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3436 source) to see if there is already a solution for your problem. Next,
3437 look for other questions in this FAQ that have to do with Emacs
3438 installation and compilation problems.
3440 If you'd like to have someone look at your problem and help solve it,
3441 see @ref{Help installing Emacs}.
3443 If you cannot find a solution in the documentation, send a message to
3444 @email{bug-gnu-emacs@@gnu.org}.
3446 Please don't post it to @uref{news:gnu.emacs.help} or send e-mail to
3447 @email{help-gnu-emacs@@gnu.org}. For further guidelines, see
3448 @ref{Guidelines for newsgroup postings} and @ref{Reporting bugs}.
3450 @node Linking with -lX11 fails, , Problems building Emacs, Compiling and installing Emacs
3451 @section Why does linking Emacs with -lX11 fail?
3452 @cindex Linking with -lX11 fails
3453 @cindex lX11, linking fails with
3455 Emacs needs to be linked with the static version of the X11 library,
3456 @file{libX11.a}. This may be missing.
3458 On OpenWindows, you may need to use @code{add_services} to add the
3459 "OpenWindows Programmers" optional software category from the CD-ROM.
3461 On HP-UX 8.0, you may need to run @code{update} again to load the
3462 X11-PRG ``fileset''. This may be missing even if you specified ``all
3463 filesets'' the first time. If @file{libcurses.a} is missing, you may
3464 need to load the ``Berkeley Development Option.''
3466 @email{zoo@@armadillo.com, David Zuhn} says that MIT X builds shared
3467 libraries by default, and only shared libraries, on those platforms that
3468 support them. These shared libraries can't be used when undumping
3469 @code{temacs} (the last stage of the Emacs build process). To get
3470 regular libraries in addition to shared libraries, add this to
3474 #define ForceNormalLib YES
3477 Other systems may have similar problems. You can always define
3478 @code{CANNOT_DUMP} and link with the shared libraries instead.
3480 @cindex X Menus don't work
3481 To get the Xmenu stuff to work, you need to find a copy of MIT's
3484 @c ------------------------------------------------------------
3485 @node Finding Emacs and related packages, Major packages and programs, Compiling and installing Emacs, Top
3486 @chapter Finding Emacs and related packages
3487 @cindex Finding Emacs and related packages
3490 * Finding Emacs on the Internet::
3491 * Finding a package with particular functionality::
3492 * Packages that do not come with Emacs::
3493 * Submitting to the Emacs Lisp Archive::
3494 * Current GNU distributions::
3495 * Difference between Emacs and XEmacs::
3496 * Emacs for MS-DOS::
3497 * Emacs for Windows::
3499 * Emacs for Atari ST::
3500 * Emacs for the Amiga ::
3501 * Emacs for NeXTSTEP::
3502 * Emacs for Apple computers::
3503 * Emacs for VMS and DECwindows::
3504 * Modes for various languages::
3505 * Translating names to IP addresses::
3508 @node Finding Emacs on the Internet, Finding a package with particular functionality, Finding Emacs and related packages, Finding Emacs and related packages
3509 @section Where can I get Emacs on the net (or by snail mail)?
3510 @cindex Finding Emacs on the Internet
3511 @cindex Snail mail, ordering Emacs via
3512 @cindex Postal service, ordering Emacs via
3513 @cindex Distribution, retrieving Emacs
3514 @cindex Internet, retrieving from
3516 Look in the files @file{etc/DISTRIB} and @file{etc/FTP} for information
3517 on nearby archive sites and @file{etc/ORDERS} for mail orders. If you
3518 don't already have Emacs, see @ref{Informational files for Emacs}, for how
3521 @xref{Installing Emacs}, for information on how to obtain and build the latest
3522 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3523 archive sites that make GNU software available.
3525 @node Finding a package with particular functionality, Packages that do not come with Emacs, Finding Emacs on the Internet, Finding Emacs and related packages
3526 @section How do I find a Emacs Lisp package that does XXX?
3527 @cindex Package, finding
3528 @cindex Finding an Emacs Lisp package
3529 @cindex Functionality, finding a particular package
3531 First of all, you should check to make sure that the package isn't
3532 already available. For example, typing @kbd{M-x apropos @key{RET}
3533 wordstar @key{RET}} lists all functions and variables containing the
3534 string @samp{wordstar}.
3536 It is also possible that the package is on your system, but has not been
3537 loaded. To see which packages are available for loading, look through
3538 your computer's lisp directory (@pxref{File-name conventions}). The Lisp
3539 source to most packages contains a short description of how they
3540 should be loaded, invoked, and configured---so before you use or
3541 modify a Lisp package, see if the author has provided any hints in the
3544 If a package does not come with Emacs, check the Lisp Code Directory.
3545 The LCD was originally maintained by @email{brennan@@hal.com, Dave
3546 Brennan}, but was recently taken over by @email{toby@@world.std.com,
3547 toby knudsen}, who maintains @uref{http://www.emacs.org}. The LCD is
3548 currently being reorganized and updated, but you can meanwhile find many
3549 packages at @uref{ftp://ftp.emacs.org/pub}.
3551 For now, you can search through the LCD with @file{lispdir.el}, which is
3552 in the process of being updated. Download it from the LCD, in the
3553 @file{emacs-lisp-attic/misc} directory, and then evaluate the following
3554 Lisp form (@pxref{Evaluating Emacs Lisp code}):
3557 (setq lisp-code-directory
3558 "/anonymous@@ftp.emacs.org:pub/emacs-lisp-attic/emacs-lisp/LCD-datafile.gz"
3559 elisp-archive-host "ftp.emacs.org"
3560 elisp-archive-directory "/pub/emacs-lisp-attic/emacs-lisp/")
3563 Once you have installed @file{lispdir.el}, you can use @kbd{M-x
3564 lisp-dir-apropos} to search the listing. For example, @kbd{M-x
3565 lisp-dir-apropos @key{RET} ange-ftp @key{RET}} produces this output:
3568 GNU Emacs Lisp Code Directory Apropos --- "ange-ftp"
3569 "~/" refers to archive.cis.ohio-state.edu:pub/elisp-archive/
3571 ange-ftp (4.18) 15-Jul-1992
3572 Andy Norman, <ange@@hplb.hpl.hp.com>
3573 ~/packages/ange-ftp.tar.Z
3574 transparent FTP Support for GNU Emacs
3575 auto-save (1.19) 01-May-1992
3576 Sebastian Kremer, <sk@@thp.uni-koeln.de>
3577 ~/misc/auto-save.el.Z
3578 Safer autosaving with support for ange-ftp and /tmp
3579 ftp-quik (1.0) 28-Jul-1993
3580 Terrence Brannon, <tb06@@pl122f.eecs.lehigh.edu>
3581 ~/modes/ftp-quik.el.Z
3582 Quik access to dired'ing of ange-ftp and normal paths
3585 @node Packages that do not come with Emacs, Submitting to the Emacs Lisp Archive, Finding a package with particular functionality, Finding Emacs and related packages
3586 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3587 @cindex Unbundled packages
3588 @cindex Finding other packages
3589 @cindex Lisp packages that do not come with Emacs
3590 @cindex Packages, those that do not come with Emacs
3591 @cindex Emacs Lisp Archive, description of
3592 @cindex Archive, description of the Emacs Lisp
3594 First, check the Lisp Code Directory to find the name of the package you
3595 are looking for (@pxref{Finding a package with particular
3596 functionality}). Next, check local archives and the Emacs Lisp Archive
3597 to find a copy of the relevant files. If you still haven't found it,
3598 you can send e-mail to the author asking for a copy. If you find Emacs
3599 Lisp code that doesn't appear in the LCD, please submit a copy to the
3600 LCD (@pxref{Submitting to the Emacs Lisp Archive}).
3602 You can access the Emacs Lisp Archive at
3604 @uref{ftp://archive.cis.ohio-state.edu/pub/emacs-lisp/}
3609 @uref{http://www.cis.ohio-state.edu/emacs-lisp}
3612 Retrieve and read the file @file{README} first.
3617 The archive maintainers do not have time to answer individual
3618 requests for packages or the list of packages in the archive. If you
3619 cannot use FTP or UUCP to access the archive yourself, try to find a
3620 friend who can, but please don't ask the maintainers.
3623 Any files with names ending in @file{.Z}, @file{.z}, or @file{.gz} are
3624 compressed, so you should use "binary" mode in FTP to retrieve them.
3625 You should also use binary mode whenever you retrieve any files with
3626 names ending in @file{.elc}.
3630 @node Submitting to the Emacs Lisp Archive, Current GNU distributions, Packages that do not come with Emacs, Finding Emacs and related packages
3631 @section How do I submit code to the Emacs Lisp Archive?
3632 @cindex Submitting code to the Emacs Lisp Archive
3633 @cindex Emacs Lisp Archive, submissions to
3634 @cindex Lisp Archive, submissions to
3635 @cindex Archive, submitting to the Emacs Lisp
3637 Guidelines and procedures for submission to the archive can be found in
3638 the file @file{GUIDELINES} in the archive directory (@pxref{Packages that
3639 do not come with Emacs}). It covers documentation, copyrights,
3640 packaging, submission, and the Lisp Code Directory Record. Anonymous
3641 FTP uploads are not permitted. Instead, all submissions are mailed to
3642 @email{elisp-archive@@cis.ohio-state.edu}. The @file{lispdir.el}
3643 package has a function named @code{submit-lcd-entry} which will help you
3646 @node Current GNU distributions, Difference between Emacs and XEmacs, Submitting to the Emacs Lisp Archive, Finding Emacs and related packages
3647 @section Where can I get other up-to-date GNU stuff?
3648 @cindex Current GNU distributions
3649 @cindex Sources for current GNU distributions
3650 @cindex Stuff, current GNU
3651 @cindex Up-to-date GNU stuff
3652 @cindex Finding current GNU software
3653 @cindex Official GNU software sites
3655 The most up-to-date official GNU software is normally kept at
3657 @uref{ftp://ftp.gnu.org/pub/gnu}
3659 Read the files @file{etc/DISTRIB} and @file{etc/FTP} for more
3662 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3664 @uref{http://www.gnu.org/order/ftp.html}
3666 @node Difference between Emacs and XEmacs, Emacs for MS-DOS, Current GNU distributions, Finding Emacs and related packages
3667 @section What is the difference between Emacs and XEmacs (formerly "Lucid Emacs")?
3669 @cindex Difference Emacs and XEmacs
3673 First of all, they're both GNU Emacs. XEmacs is just as much a later
3674 version of GNU Emacs as the FSF-distributed version. This FAQ refers to
3675 the latest version to be distributed by the FSF as ``Emacs,'' partly
3676 because the XEmacs maintainers now refer to their product using the
3677 ``XEmacs'' name, and partly because there isn't any accurate way to
3678 differentiate between the two without getting mired in paragraphs of
3679 legalese and history.
3681 XEmacs, which began life as Lucid Emacs, is based on an early version of
3682 Emacs 19 and Epoch, an X-aware version of Emacs 18.
3684 Emacs (i.e., the version distributed by the FSF) has a larger installed
3685 base and now always contains the MULE multilingual facilities.
3686 XEmacs can do some clever tricks with X and MS-Windows, such as
3687 putting arbitrary graphics in a buffer. Similar facilities have been
3688 implemented for Emacs as part of a new redisplay implementation for
3689 Emacs 21, and are available in the latest Emacs releases.
3690 Emacs and XEmacs each come with
3691 Lisp packages that are lacking in the other; RMS says that the FSF would
3692 include more packages that come with XEmacs, but that the XEmacs
3693 maintainers don't always keep track of the authors of contributed code,
3694 which makes it impossible for the FSF to have certain legal papers
3695 signed. (Without these legal papers, the FSF will not distribute Lisp
3696 packages with Emacs.) The two versions have some
3697 significant differences at the Lisp programming level.
3699 Many XEmacs features have found their way into recent versions of Emacs,
3700 and more features can be expected in the future, but there are still many
3701 differences between the two.
3703 The latest stable branch of XEmacs as of this writing is 21.1; you can
3706 @uref{ftp://ftp.xemacs.org/pub/xemacs/xemacs-21.1.14.tar.gz}
3708 More information about XEmacs, including a list of frequently asked
3709 questions (FAQ), is available at
3711 @uref{http://www.xemacs.org/}
3713 @node Emacs for MS-DOS, Emacs for Windows, Difference between Emacs and XEmacs, Finding Emacs and related packages
3714 @section Where can I get Emacs for my PC running MS-DOS?
3715 @cindex MS-DOS, Emacs for
3716 @cindex DOS, Emacs for
3717 @cindex Compiling Emacs for DOS
3718 @cindex Emacs for MS-DOS
3719 @cindex Tools needed to compile Emacs under DOS
3721 A pre-built binary distribution of Emacs is available from the
3722 SimTel.NET archives. This version apparently works under MS-DOS and
3723 Windows (3.X, 9X, ME, NT, and 2000) and supports long file names under
3724 Windows 9X, Windows ME, and Windows 2000. More information is available
3727 @uref{http://www.simtel.net/pub/gnu/djgpp/v2gnu/emacs.README}
3729 The binary itself is available in the files @file{em*.zip} in the
3732 @uref{http://www.simtel.net/pub/gnu/djgpp/v2gnu/}
3734 If you prefer to compile Emacs for yourself, you can do so with the
3735 current distribution directly. You will need a 386 (or
3736 better) processor, and to be running MS-DOS 3.0 or later. According to
3737 @email{eliz@@is.elta.co.il, Eli Zaretskii} and
3738 @email{hankedr@@dms.auburn.edu, Darrel Hankerson}, you will need the
3744 DJGPP version 1.12 maint 1 or later. Djgpp 2.0 or later is
3745 recommended, since 1.x is very old an unmaintained. Djgpp 2 supports
3746 long file names on Windows 9X/ME/2K.
3748 You can get the latest release of DJGPP by retrieving all of
3751 @uref{http://www.simtel.net/pub/gnu/djgpp/v2*}
3753 @item Unpacking program
3754 The easiest way is to use @code{djtar} which comes with DJGPP v2.x,
3755 because it can open gzip'ed tarfiles (i.e., those ending with
3756 @file{.tar.gz}) in one step. @code{Djtar} comes in
3757 @file{djdev@var{nnn}.zip} archive (where @var{nnn} is the DJGPP version
3758 number), from the URL mentioned above.
3760 @strong{Warning!} Do @strong{not} use the popular WinZip program to
3761 unpack the Emacs distribution! WinZip is known to corrupt some of the
3762 files by converting them to the DOS CR-LF format, it doesn't always
3763 preserve the directory structure recorded in the compressed Emacs
3764 archive, and commits other atrocities. Some of these problems could
3765 actually prevent Emacs from building successfully!
3767 @item make, mv, sed, and rm
3768 All of these utilities are available at
3770 @uref{http://www.simtel.net/pub/gnu/djgpp/v2gnu}
3772 16-bit utilities can be found in GNUish, at
3774 @uref{http://www.simtel.net/pub/gnu/gnuish}
3777 (@code{mv} and @code{rm} are in the Fileutils package, @code{sed} and
3778 @code{make} are each one in a separate package named after them.)
3782 The files @file{INSTALL} (near its end) and @file{etc/PROBLEMS} in the
3783 directory of the Emacs sources contains some additional information
3784 regarding Emacs under MS-DOS.
3786 For a list of other MS-DOS implementations of Emacs (and Emacs
3787 look-alikes), consult the list of "Emacs implementations and literature,"
3790 @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/}
3792 Note that while many of these programs look similar to Emacs, they often
3793 lack certain features, such as the Emacs Lisp extension language.
3795 @node Emacs for Windows, Emacs for OS/2, Emacs for MS-DOS, Finding Emacs and related packages
3796 @section Where can I get Emacs for Microsoft Windows
3797 @cindex FAQ for NT Emacs
3798 @cindex Emacs for MS-Windows
3799 @cindex Microsoft Windows, Emacs for
3800 @cindex Windows 9X, ME, NT, 2K, and CE, Emacs for
3802 For information on Emacs for Windows 95 and NT, read the FAQ produced by
3803 @email{voelker@@cs.washington.edu, Geoff Voelker}, available at
3805 @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html}
3807 @xref{Emacs for MS-DOS}, for Windows 3.1.
3809 A port of Emacs 20.7 for Windows CE, based on NTEmacs, is available at
3811 @uref{http://www.rainer-keuchel.de/software.html}
3814 This port was done by @email{coyxc@@rainer-keuchel.de, Rainer Keuchel},
3815 and supports all Emacs features except async subprocesses and menus.
3816 You will need MSVC 6.0 and a Windows CE SDK to build this port.
3818 @node Emacs for OS/2, Emacs for Atari ST, Emacs for Windows, Finding Emacs and related packages
3819 @section Where can I get Emacs for my PC running OS/2?
3820 @cindex OS/2, Emacs for
3822 Emacs 20.6 is ported for emx on OS/2 2.0 or 2.1, and is available at
3824 @uref{ftp://hobbes.nmsu.edu/pub/os2/apps/editors/emacs/e206*.zip}
3829 @uref{http://archiv.leo.org/pub/comp/os/os2/leo/gnu/emacs%2d20/}
3831 Instructions for installation, basic setup, and other useful information
3832 for OS/2 users of Emacs can be found at
3834 @uref{http://userpage.fu-berlin.de/~oheiabbd/emacs/emacs206-os2.html}
3836 @node Emacs for Atari ST, Emacs for the Amiga , Emacs for OS/2, Finding Emacs and related packages
3837 @section Where can I get Emacs for my Atari ST?
3838 @cindex Atari ST, Emacs for
3839 @cindex TOS, Emacs for
3841 Roland Schäuble reports that Emacs 18.58 running on plain TOS and MiNT
3843 @uref{ftp://atari.archive.umich.edu/Editors/Emacs-18-58/1858b-d3.zoo}.
3845 @node Emacs for the Amiga , Emacs for NeXTSTEP, Emacs for Atari ST, Finding Emacs and related packages
3846 @section Where can I get Emacs for my Amiga?
3847 @cindex Amiga, Emacs for
3849 The files you need are available at
3851 @uref{ftp://ftp.wustl.edu/pub/aminet/util/gnu/}
3853 @email{dgilbert@@gamiga.guelphnet.dweomer.org, David Gilbert} has released a
3854 beta version of Emacs 19.25 for the Amiga. You can get the binary at
3856 @uref{ftp://ftp.wustl.edu/pub/aminet/util/gnu/a2.0bEmacs-bin.lha}
3858 @node Emacs for NeXTSTEP, Emacs for Apple computers, Emacs for the Amiga , Finding Emacs and related packages
3859 @section Where can I get Emacs for NeXTSTEP?
3860 @cindex NeXTSTEP, Emacs for
3862 Emacs.app is a NeXTSTEP version of Emacs 19.34 which supports colors,
3863 menus, and multiple frames. You can get it from
3865 @uref{ftp://next-ftp.peak.org/pub/next/apps/emacs/Emacs_for_NeXTstep.4.20a1.NIHS.b.tar.gz}
3867 @node Emacs for Apple computers, Emacs for VMS and DECwindows, Emacs for NeXTSTEP, Finding Emacs and related packages
3868 @section Where can I get Emacs for my Apple computer?
3869 @cindex Apple computers, Emacs for
3870 @cindex Macintosh, Emacs for
3872 An unofficial port of GNU Emacs 18.59 to the Macintosh is available at a
3873 number of ftp sites, the home being
3874 @uref{ftp://ftp.cs.cornell.edu/pub/parmet/Emacs-1.17.sit.bin}.
3876 A port of Emacs 20.4 is available at
3877 @uref{http://www.cs.hku.hk/~choi/emacs/index.html}.
3879 Beginning with version 21.1, the Macintosh is supported in the official
3880 Emacs distribution; see the files @file{mac/README} and
3881 @file{mac/INSTALL} in the Emacs distribution for build instructions.
3883 Apple's forthcoming "OS X" is based largely on NeXTSTEP and OpenStep.
3884 @xref{Emacs for NeXTSTEP}, for more details about that version.
3886 @node Emacs for VMS and DECwindows, Modes for various languages, Emacs for Apple computers, Finding Emacs and related packages
3887 @section Where do I get Emacs that runs on VMS under DECwindows?
3888 @cindex DECwindows, Emacs for
3889 @cindex VMS, Emacs for
3891 Up-to-date information about GNU software (including Emacs) for VMS is
3892 available at @uref{http://vms.gnu.org/}.
3894 @node Modes for various languages, Translating names to IP addresses, Emacs for VMS and DECwindows, Finding Emacs and related packages
3895 @section Where can I get modes for Lex, Yacc/Bison, Bourne shell, csh, C@t{++}, Objective-C, Pascal, Java, and Awk?
3896 @cindex Awk, mode for
3897 @cindex @code{awk-mode}
3898 @cindex Bison, mode for
3899 @cindex Bourne Shell, mode for
3900 @cindex C@t{++}, mode for
3901 @cindex Java, mode for
3903 @cindex Objective-C, mode for
3904 @cindex @code{pascal-mode}
3907 @cindex @file{csh} mode
3908 @cindex @code{sh-mode}
3909 @cindex @code{cc-mode}
3911 Most of these modes are now available in standard Emacs distribution.
3912 To get additional modes, look in the Lisp Code Directory (@pxref{Finding
3913 a package with particular functionality}). For C@t{++}, if you use
3914 @code{lisp-dir-apropos}, you must specify the pattern with something
3915 like @kbd{M-x lisp-dir-apropos @key{RET} c\+\+ @key{RET}}.@footnote{
3916 The backslashes in @samp{\+\+} are required because @kbd{M-x
3917 lisp-dir-apropos} expects a regular expression as its argument
3918 (@pxref{Using regular expressions}), and @samp{+} has a special meaning
3919 in regular expressions.}
3921 Barry Warsaw's @code{cc-mode} now works for C, C@t{++}, Objective-C, and
3922 Java code. You can get the latest version from the Emacs Lisp Archive;
3923 @pxref{Packages that do not come with Emacs} for details. A FAQ for
3924 @code{cc-mode} is available at
3925 @uref{http://www.python.org/emacs/cc-mode/}.
3927 @node Translating names to IP addresses, , Modes for various languages, Finding Emacs and related packages
3928 @section What is the IP address of XXX.YYY.ZZZ?
3929 @cindex Translating names to IP addresses
3930 @cindex IP addresses from names
3931 @cindex Using BIND to translate addresses
3932 @cindex DNS and IP addresses
3934 If you are on a Unix machine, try using the @samp{nslookup} command,
3935 included in the Berkeley BIND package. For example, to find the IP
3936 address of @samp{ftp.gnu.org}, you would type @code{nslookup
3939 Your computer should then provide the IP address of that machine.
3941 If your site's nameserver is deficient, you can use IP addresses to FTP
3942 files. You can get this information by e-mail:
3945 To: dns@@[134.214.84.25] (to grasp.insa-lyon.fr)
3946 Body: ip XXX.YYY.ZZZ (or "help" for more information
3947 and options - no quotes)
3954 To: resolve@@[147.31.254.130] (to laverne.cs.widener.edu)
3955 Body: site XXX.YYY.ZZZ
3958 @c ------------------------------------------------------------
3959 @node Major packages and programs, Key bindings, Finding Emacs and related packages, Top
3960 @chapter Major packages and programs
3961 @cindex Major packages and programs
3978 @node VM, Supercite, Major packages and programs, Major packages and programs
3979 @section VM (View Mail) --- another mail reader within Emacs, with MIME support
3981 @cindex Alternative mail software
3983 @cindex E-mail reader, VM
3988 @email{kyle@@uunet.uu.net, Kyle Jones}
3990 @item Latest version
3994 @uref{ftp://ftp.wonderworks.com/pub/vm/vm.tar.gz}
3996 @item Informational newsgroup/mailing list
3997 @uref{news:gnu.emacs.vm.info}@*
3998 Subscription requests to @email{info-vm-request@@uunet.uu.net}@*
3999 Submissions to @email{info-vm@@uunet.uu.net}
4001 @item Bug reports newsgroup/mailing list
4002 @uref{news:gnu.emacs.vm.bug}@*
4003 Subscription requests to @email{bug-vm-request@@uunet.uu.net}@*
4004 Submissions to @email{bug-vm@@uunet.uu.net}
4007 VM 6 works with Emacs 20.4, and may cause problems with Emacs 20.3 and
4008 below. (But note that many people seem to use Emacs 20.3 with VM 6,
4009 without any problems.) Risk-averse users might wish to try VM 5.97,
4010 available from @uref{ftp://ftp.wonderworks.com/pub/vm/, the same FTP
4013 @node Supercite, Calc, VM, Major packages and programs
4014 @section Supercite --- mail and news citation package within Emacs
4017 @cindex Mail and news citations
4018 @cindex News and mail citations
4019 @cindex Citations in mail and news
4024 @email{bwarsaw@@cen.com, Barry Warsaw}
4026 @item Latest version
4027 3.54 (comes bundled with Emacs 20)
4030 @uref{http://www.python.org/emacs/supercite.tar.gz}
4033 Subscription requests to @email{supercite-request@@python.org}@*
4034 Submissions @email{supercite@@python.org}
4038 Superyank is an old version of Supercite.
4040 @node Calc, VIPER, Supercite, Major packages and programs
4041 @section Calc --- poor man's Mathematica within Emacs
4042 @cindex Programmable calculator
4044 @cindex Mathematical package
4049 @email{daveg@@csvax.cs.caltech.edu, Dave Gillespie}
4051 @item Latest version
4055 @uref{ftp://ftp.gnu.org/pub/gnu/calc/calc-2.02f.tar.gz}
4059 Note that Calc 2.02f needs patching to work with Emacs 21 and later.
4061 @cindex @code{calculator}, a package
4062 Emacs 21.1 and later comes with a package called @file{calculator.el}.
4063 It doesn't support all the mathematical wizardry offered by Calc, such
4064 as matrices, special functions, and statistics, but is more than
4065 adequate as a replacement for @code{xcalc} and similar programs.
4067 @node VIPER, AUC-TeX, Calc, Major packages and programs
4068 @section VIPER --- @code{vi} emulation for Emacs
4069 @cindex @code{vi} emulation
4071 @cindex Emulation of @code{vi}
4073 Since Emacs 19.29, the preferred @code{vi} emulation in Emacs is VIPER
4074 (@kbd{M-x viper-mode @key{RET}}), which comes with Emacs. It extends
4075 and supersedes VIP (including VIP 4.3) and provides @code{vi} emulation
4076 at several levels, from one that closely follows @code{vi} to one that
4077 departs from @code{vi} in several significant ways.
4079 For Emacs 19.28 and earlier, the following version of VIP is generally
4080 better than the one distributed with Emacs:
4084 @email{sane@@cs.uiuc.edu, Aamod Sane}
4086 @item Latest version
4090 @uref{ftp://archive.cis.ohio-state.edu/pub/emacs-lisp/modes/vip-mode.tar.Z}
4094 @node AUC-TeX, BBDB, VIPER, Major packages and programs
4095 @section AUC TeX --- enhanced LaTeX mode with debugging facilities
4096 @cindex Mode for @TeX{}
4098 @cindex AUC-TeX mode for editing @TeX{}
4099 @cindex Writing and debugging @TeX{}
4104 @email{krab@@iesd.auc.dk, Kresten Krab Thorup} and@*
4105 @email{abraham@@dina.kvl.dk, Per Abrahamsen}
4107 @item Latest version
4111 @uref{ftp://sunsite.auc.dk/packages/auctex/auctex.tar.gz}
4114 @uref{http://sunsite.auc.dk/auctex/}
4117 Subscription requests to @email{auc-tex-request@@iesd.auc.dk}@*
4118 Submissions to @email{auc-tex@@iesd.auc.dk}@*
4119 Development team is at @email{auc-tex_mgr@@iesd.auc.dk}
4123 @node BBDB, Ispell, AUC-TeX, Major packages and programs
4124 @section BBDB --- personal Info Rolodex integrated with mail/news readers
4126 @cindex Rolodex-like functionality
4127 @cindex Integrated contact database
4128 @cindex Contact database
4129 @cindex Big Brother Database
4130 @cindex Address book
4135 @email{simmonmt@@acm.org, Matt Simmons}
4137 @item Latest version
4141 @uref{http://www.netcom.com/~simmonmt/bbdb/index.html}
4144 Subscription requests to @email{info-bbdb-request@@xemacs.org}@*
4145 Submissions to @email{info-bbdb@@xemacs.org}@*
4146 Release announcements: @email{bbdb-announce-request@@xemacs.org}
4150 @node Ispell, w3-mode, BBDB, Major packages and programs
4151 @section Ispell --- spell checker in C with interface for Emacs
4152 @cindex Spell-checker
4153 @cindex Checking spelling
4159 @email{geoff@@itcorp.com, Geoff Kuenning}
4161 @item Latest version
4165 @uref{ftp://ftp.cs.ucla.edu/pub/ispell/ispell-3.1.20.tar.gz}@*
4168 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
4175 Do not ask Geoff to send you the latest version of Ispell. He does not
4179 This Ispell program is distinct from GNU Ispell 4.0. GNU Ispell 4.0 is
4180 no longer a supported product.
4184 @node w3-mode, EDB, Ispell, Major packages and programs
4185 @section w3-mode --- A World Wide Web browser inside of Emacs
4188 @cindex HTML browser in Emacs
4189 @cindex @code{w3-mode}
4194 @email{wmperry@@spry.com, Bill Perry}
4196 @item Latest version
4200 @uref{ftp://ftp.cs.indiana.edu/pub/elisp/w3/w3.tar.gz}
4203 Receive announcements from @email{w3-announce-request@@indiana.edu}@*
4204 Become a beta tester at @email{w3-beta-request@@indiana.edu}@*
4205 Help to develop @code{w3-mode} at @email{w3-dev@@indiana.edu}
4209 @node EDB, Mailcrypt, w3-mode, Major packages and programs
4210 @section EDB --- Database program for Emacs; replaces forms editing modes
4217 @email{mernst@@theory.lcs.mit.edu, Michael Ernst}
4219 @item Latest version
4223 @uref{ftp://theory.lcs.mit.edu/pub/emacs/edb}
4227 @node Mailcrypt, JDE, EDB, Major packages and programs
4228 @section Mailcrypt --- PGP interface within Emacs mail and news
4231 @cindex Interface to PGP from Emacs mail and news
4232 @cindex News, interface to PGP from
4233 @cindex Mail, interface to PGP from
4234 @cindex Encryption software, interface to
4239 @email{patl@@lcs.mit.edu, Patrick J. LoPresti} and
4240 @email{jin@@atype.com, Jin S. Choi}
4243 @email{lbudney@@pobox.com, Len Budney}
4245 @item Latest version
4249 @uref{http://www.nb.net/~lbudney/linux/software/mailcrypt/mailcrypt-3.5.3.tar.gz}
4252 @uref{http://www.nb.net/~lbudney/linux/software/mailcrypt.html}
4256 @node JDE, Patch, Mailcrypt, Major packages and programs
4257 @section JDE --- Integrated development environment for Java
4258 @cindex Java development environment
4259 @cindex Integrated Java development environment
4265 @email{paulk@@mathworks.com, Paul Kinnucan}
4268 jde-subscribe@@sunsite.auc.dk
4270 @item Latest version
4274 @uref{http://sunsite.auc.dk/jde/}
4278 @node Patch, , JDE, Major packages and programs
4279 @section Patch --- program to apply "diffs" for updating files
4280 @cindex Updating files with diffs
4281 @cindex Patching source files with diffs
4282 @cindex Diffs and patching
4283 @cindex @file{patch}
4288 @email{lwall@@wall.org, Larry Wall} (with GNU modifications)
4290 @item Latest version
4294 @xref{Current GNU distributions}.
4298 @c ------------------------------------------------------------
4299 @node Key bindings, Alternate character sets, Major packages and programs, Top
4300 @chapter Key bindings
4301 @cindex Key bindings
4304 * Binding keys to commands::
4305 * Invalid prefix characters::
4306 * Terminal setup code works after Emacs has begun::
4307 * Using function keys under X::
4308 * Working with function and arrow keys::
4309 * X key translations for Emacs::
4310 * Handling C-s and C-q with flow control::
4311 * Binding C-s and C-q::
4312 * Backspace invokes help::
4313 * stty and Backspace key::
4315 * Producing C-XXX with the keyboard::
4318 * Compose Character::
4319 * Binding combinations of modifiers and function keys::
4320 * Meta key does not work in xterm::
4321 * ExtendChar key does not work as Meta::
4324 @node Binding keys to commands, Invalid prefix characters, Key bindings, Key bindings
4325 @section How do I bind keys (including function keys) to commands?
4326 @cindex Binding keys to commands
4327 @cindex Keys, binding to commands
4328 @cindex Commands, binding keys to
4330 Keys can be bound to commands either interactively or in your
4331 @file{.emacs} file. To interactively bind keys for all modes, type
4332 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
4334 To bind a key just in the current major mode, type @kbd{M-x
4335 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
4337 @inforef{Key Bindings, Key Bindings, emacs}, for further details.
4339 To make the process of binding keys interactively eaiser, use the
4340 following ``trick'': First bind the key interactively, then immediately
4341 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}. Now, the command needed
4342 to bind the key is in the kill ring, and can be yanked into your
4343 @file{.emacs} file. If the key binding is global, no changes to the
4344 command are required. For example,
4347 (global-set-key (quote [f1]) (quote help-for-help))
4351 can be placed directly into the @file{.emacs} file. If the key binding is
4352 local, the command is used in conjunction with the "add-hook" command.
4353 For example, in tex-mode, a local binding might be
4356 (add-hook 'tex-mode-hook
4358 (local-set-key (quote [f1]) (quote help-for-help))))
4365 Control characters in key sequences, in the form yanked from the kill
4366 ring are given in their graphic form---i.e., @key{CTRL} is shown as
4367 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc. You may want
4368 to convert these into their vector or string forms.
4371 If a prefix key of the character sequence to be bound is already
4372 bound as a complete key, then you must unbind it before the new
4373 binding. For example, if @kbd{ESC @{} is previously bound:
4376 (global-unset-key [?\e ?@{]) ;; or
4377 (local-unset-key [?\e ?@{])
4381 Aside from commands and ``lambda lists,'' a vector or string also
4382 can be bound to a key and thus treated as a macro. For example:
4385 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g]) ;; or
4386 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
4391 @node Invalid prefix characters, Terminal setup code works after Emacs has begun, Binding keys to commands, Key bindings
4392 @section Why does Emacs say "Key sequence XXX uses invalid prefix characters"?
4393 @cindex Prefix characters, invalid
4394 @cindex Invalid prefix characters
4395 @cindex Misspecified key sequences
4397 Usually, one of two things has happened. In one case, the control
4398 character in the key sequence has been misspecified (e.g. @samp{C-f}
4399 used instead of @samp{\C-f} within a Lisp expression). In the other
4400 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
4401 was already bound as a @dfn{complete key}. Historically, the @samp{ESC [}
4402 prefix was usually the problem, in which case you should evaluate either
4403 of these forms before attempting to bind the key sequence:
4406 (global-unset-key [?\e ?[]) ;; or
4407 (global-unset-key "\e[")
4410 @node Terminal setup code works after Emacs has begun, Using function keys under X, Invalid prefix characters, Key bindings
4411 @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?
4412 @cindex Terminal setup code in @file{.emacs}
4414 During startup, Emacs initializes itself according to a given code/file
4415 order. If some of the code executed in your @file{.emacs} file needs to
4416 be postponed until the initial terminal or window-system setup code has
4417 been executed but is not, then you will experience this problem (this
4418 code/file execution order is not enforced after startup).
4420 To postpone the execution of Emacs Lisp code until after terminal or
4421 window-system setup, treat the code as a @dfn{lambda list} and set the
4422 value of either the @code{term-setup-hook} or @code{window-setup-hook}
4423 variable to this lambda function. For example,
4426 (add-hook 'term-setup-hook
4428 (when (string-match "\\`vt220" (or (getenv "TERM") ""))
4429 ;; Make vt220's "Do" key behave like M-x:
4430 (global-set-key [do] 'execute-extended-command))))
4433 For information on what Emacs does every time it is started, see the
4434 @file{lisp/startup.el} file.
4436 @node Using function keys under X, Working with function and arrow keys, Terminal setup code works after Emacs has begun, Key bindings
4437 @section How do I use function keys under X?
4438 @cindex Function keys
4439 @cindex X Window System and function keys
4440 @cindex Binding function keys
4442 With Emacs 19, functions keys under X are bound like any other key. @xref{Binding keys to commands}, for details.
4444 @node Working with function and arrow keys, X key translations for Emacs, Using function keys under X, Key bindings
4445 @section How do I tell what characters or symbols my function or arrow keys emit?
4446 @cindex Working with arrow keys
4447 @cindex Arrow keys, symbols generated by
4448 @cindex Working with function keys
4449 @cindex Function keys, symbols generated by
4450 @cindex Symbols generated by function keys
4452 Type @kbd{C-h c} then the function or arrow keys. The command will
4453 return either a function key symbol or character sequence (see the
4454 Emacs on-line documentation for an explanation). This works for other
4457 @node X key translations for Emacs, Handling C-s and C-q with flow control, Working with function and arrow keys, Key bindings
4458 @section How do I set the X key ``translations'' for Emacs?
4459 @cindex X key translations
4460 @cindex Key translations under X
4461 @cindex Translations for keys under X
4463 Emacs is not written using the Xt library by default, so there are no
4464 ``translations'' to be set. (We aren't sure how to set such translations
4465 if you do build Emacs with Xt; please let us know if you've done this!)
4467 The only way to affect the behavior of keys within Emacs is through
4468 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs). The
4469 @code{define-key} command should be used in conjunction with the
4470 @code{function-key-map} map. For instance,
4473 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
4477 defines the @kbd{M-@key{TAB}} key sequence.
4479 @node Handling C-s and C-q with flow control, Binding C-s and C-q, X key translations for Emacs, Key bindings
4480 @section How do I handle @kbd{C-s} and @kbd{C-q} being used for flow control?
4481 @cindex Flow control, @kbd{C-s} and @kbd{C-q} with
4482 @cindex @kbd{C-s} and @kbd{C-q} with flow control
4484 @kbd{C-s} and @kbd{C-q} are used in the XON/XOFF flow control protocol.
4485 This messes things up when you're using Emacs over a serial line,
4486 because Emacs binds these keys to commands by default. Because Emacs
4487 won't honor them as flow control characters, too many of these
4488 characters are not passed on and overwhelm output buffers. Sometimes,
4489 intermediate software using XON/XOFF flow control will prevent Emacs
4490 from ever seeing @kbd{C-s} and @kbd{C-q}.
4497 Disable the use of @kbd{C-s} and @kbd{C-q} for flow control.
4499 You need to determine the cause of the flow control.
4506 Your terminal may use XON/XOFF flow control to have time to display
4507 all the characters it receives. For example, VT series terminals do
4508 this. It may be possible to turn this off from a setup menu. For
4509 example, on a VT220 you may select ``No XOFF'' in the setup menu. This
4510 is also true for some terminal emulation programs on PCs.
4512 When you turn off flow control at the terminal, you will also need to
4513 turn it off at the other end, which might be at the computer you are
4514 logged in to or at some terminal server in between.
4516 If you turn off flow control, characters may be lost; using a printer
4517 connected to the terminal may fail. You may be able to get around
4518 this problem by modifying the @samp{termcap} entry for your terminal to
4519 include extra NUL padding characters.
4524 If you are using a dialup connection, the modems may be using
4525 XON/XOFF flow control. It's not clear how to get around this.
4528 a router or terminal server
4530 Some network box between the terminal and your computer may be using
4531 XON/XOFF flow control. It may be possible to make it use some other
4532 kind of flow control. You will probably have to ask your local
4533 network experts for help with this.
4536 @code{tty} and/or @code{pty} devices
4538 If your connection to Emacs goes through multiple @code{tty} and/or
4539 @code{pty} devices, they may be using XON/XOFF flow control even when it
4542 @email{eirik@@theory.tn.cornell.edu, Eirik Fuller} writes:
4545 Some versions of @code{rlogin} (and possibly @code{telnet}) do not pass
4546 flow control characters to the remote system to which they connect. On
4547 such systems, Emacs on the remote system cannot disable flow control on
4548 the local system. Sometimes @samp{rlogin -8} will avoid this problem.
4550 One way to cure this is to disable flow control on the local host (the
4551 one running @code{rlogin}, not the one running @code{rlogind}) using the
4552 @code{stty} command, before starting the @code{rlogin} process. On many
4553 systems, @samp{stty start u stop u} will do this.
4555 Some versions of @samp{tcsh} will prevent even this from working. One
4556 way around this is to start another shell before starting rlogin,
4557 and issue the @samp{stty} command to disable flow control from that shell.
4560 Use @samp{stty -ixon} instead of @samp{stty start u stop u} on some systems.
4565 Make Emacs speak the XON/XOFF flow control protocol.
4567 You can make Emacs treat @kbd{C-s} and @kbd{C-q} as flow control characters by
4571 (enable-flow-control)
4575 to unconditionally enable flow control or
4578 (enable-flow-control-on "vt100" "h19")
4582 (using your terminal names instead of @samp{vt100} or @samp{h19}) to
4583 enable selectively. These commands will automatically swap @kbd{C-s}
4584 and @kbd{C-q} to @kbd{C-\} and @kbd{C-^}. Variables can be used to
4585 change the default swap keys (@code{flow-control-c-s-replacement} and
4586 @code{flow-control-c-q-replacement}).
4588 If you are fixing this for yourself, simply put the form in your
4589 @file{.emacs} file. If you are fixing this for your entire site, the
4590 best place to put it is in the @file{site-lisp/site-start.el} file.
4591 (Here @file{site-lisp} is actually a subdirectory of your Emacs
4592 installation directory, typically @file{/usr/local/share/emacs}.)
4593 Putting this form in @file{site-lisp/default.el} has the problem that
4594 if the user's @file{.emacs} file has an error, this will prevent
4595 @file{default.el} from being loaded and Emacs may be unusable for the
4596 user, even for correcting their @file{.emacs} file (unless they're
4597 smart enough to move it to another name).
4599 @code{enable-flow-control} can be invoked interactively as well:
4600 @kbd{M-x enable-flow-control @key{RET}}.
4604 For further discussion of this issue, read the file @file{etc/PROBLEMS}
4605 (in the Emacs source directory when you unpack the Emacs distribution).
4607 @node Binding C-s and C-q, Backspace invokes help, Handling C-s and C-q with flow control, Key bindings
4608 @section How do I bind @kbd{C-s} and @kbd{C-q} (or any key) if these keys are filtered out?
4609 @cindex Binding @kbd{C-s} and @kbd{C-q}
4610 @cindex @kbd{C-s} and @kbd{C-q}, binding
4612 To bind @kbd{C-s} and @kbd{C-q}, use either @code{enable-flow-control}
4613 or @code{enable-flow-control-on}. @xref{Handling C-s and C-q with flow
4614 control}, for usage and implementation details.
4616 To bind other keys, use @code{keyboard-translate}. @xref{Swapping
4617 keys}, for usage details. To do this for an entire site, you should
4618 swap the keys in @file{site-lisp/site-start.el}. @xref{Handling C-s
4619 and C-q with flow control}, for an explanation of why
4620 @file{site-lisp/default.el} should not be used.
4625 If you do this for an entire site, the users will be confused by
4626 the disparity between what the documentation says and how Emacs
4631 @node Backspace invokes help, stty and Backspace key, Binding C-s and C-q, Key bindings
4632 @section Why does the @key{Backspace} key invoke help?
4633 @cindex Backspace key invokes help
4634 @cindex Help invoked by Backspace
4635 @cindex DEL key does not delete
4637 The @key{Backspace} key (on most keyboards) generates ASCII code 8.
4638 @kbd{C-h} sends the same code. In Emacs by default @kbd{C-h} invokes
4639 help-command. This is intended to be easy to remember since the first
4640 letter of @samp{help} is @samp{h}. The easiest solution to this problem
4641 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
4642 @key{Delete} key) for deleting the previous character.
4644 For many people this solution may be problematic:
4649 They normally use @key{Backspace} outside of Emacs for deleting the
4650 previous character. This can be solved by making @key{DEL} the command
4651 for deleting the previous character outside of Emacs. On many Unix
4652 systems, this command will remap @key{DEL}:
4659 The user may prefer the @key{Backspace} key for deleting the
4660 previous character because it is more conveniently located on their
4661 keyboard or because they don't even have a separate @key{Delete} key.
4662 In this case, the @key{Backspace} key should be made to behave like
4663 @key{Delete}. There are several methods.
4667 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
4668 TeraTerm) allow the character generated by the @key{Backspace} key to be
4669 changed from a setup menu.
4672 You may be able to get a keyboard that is completely programmable, or a
4673 terminal emulator that supports remapping of any key to any other key.
4676 With Emacs 21.1 and later, you can control the effect of the
4677 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
4678 windowed displays, by customizing the option
4679 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
4680 normal-erase-is-backspace}. See the documentation of these symbols
4681 (@pxref{Emacs Lisp documentation}) for more info.
4684 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
4688 (keyboard-translate ?\C-h ?\C-?)
4692 This is the recommended method of forcing @key{Backspace} to act as
4693 @key{DEL}, because it works even in modes which bind @key{DEL} to
4694 something other than @code{delete-backward-char}.
4696 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
4697 default deletes forward:
4700 (keyboard-translate ?\C-? ?\C-d)
4703 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
4706 Another approach is to switch key bindings and put help on @kbd{C-x h}
4710 (global-set-key "\C-h" 'delete-backward-char)
4712 ;;; overrides mark-whole-buffer
4713 (global-set-key "\C-xh" 'help-command)
4717 This method is not recommended, though: it only solves the problem for
4718 those modes which bind @key{DEL} to @code{delete-backward-char}. Modes
4719 which bind @key{DEL} to something else, such as @code{view-mode}, will
4720 not work as you expect when you press the @key{Backspace} key. For this
4721 reason, we recommend the @code{keyboard-translate} method, shown
4724 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
4727 Don't try to bind @key{DEL} to @code{help-command}, because there are
4728 many modes that have local bindings of @key{DEL} that will interfere.
4732 When Emacs 21 or later runs on a windowed display, it binds the
4733 @key{Delete} key to a command which deletes the character at point, to
4734 make Emacs more consistent with keyboard operation on these systems.
4736 For more information about troubleshooting this problem, see @ref{DEL
4737 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
4740 @node stty and Backspace key, Swapping keys, Backspace invokes help, Key bindings
4741 @section Why doesn't Emacs look at the @file{stty} settings for @key{Backspace} vs. @key{Delete}?
4742 @cindex @file{stty} and Emacs
4743 @cindex Backspace and @file{stty}
4744 @cindex Delete and @file{stty}
4748 @c FIXME: RMS explained the reasons for this on emacs-hackers. It's
4749 @c probably worth putting that explanation here.
4751 @node Swapping keys, Producing C-XXX with the keyboard, stty and Backspace key, Key bindings
4752 @section How do I swap two keys?
4753 @cindex Swapping keys
4754 @cindex Keys, swapping
4755 @cindex @code{keyboard-translate}
4757 In Emacs 19, you can swap two keys (or key sequences) by using the
4758 @code{keyboard-translate} function. For example, to turn @kbd{C-h} into
4759 @key{DEL} and @key{DEL} to @kbd{C-h}, use
4762 (keyboard-translate ?\C-h ?\C-?) ; translate `C-h' to DEL
4763 (keyboard-translate ?\C-? ?\C-h) ; translate DEL to `C-h'.
4767 The first key sequence of the pair after the function identifies what is
4768 produced by the keyboard; the second, what is matched for in the
4771 Keyboard translations are not the same as key bindings in keymaps.
4772 Emacs contains numerous keymaps that apply in different situations, but
4773 there is only one set of keyboard translations, and it applies to every
4774 character that Emacs reads from the terminal. Keyboard translations
4775 take place at the lowest level of input processing; the keys that are
4776 looked up in keymaps contain the characters that result from keyboard
4779 @inforef{Keyboard Translations, Keyboard Translations, emacs}.
4781 @node Producing C-XXX with the keyboard, No Meta key, Swapping keys, Key bindings
4782 @section How do I produce C-XXX with my keyboard?
4783 @cindex Producing control characters
4784 @cindex Generating control characters
4785 @cindex Control characters, generating
4787 On terminals (but not under X), some common "aliases" are:
4791 @item @kbd{C-2} or @kbd{C-@key{SPC}}
4797 @item @kbd{C-7} or @kbd{C-S--}
4811 Often other aliases exist; use the @kbd{C-h c} command and try
4812 @key{CTRL} with all of the digits on your keyboard to see what gets
4813 generated. You can also try the @kbd{C-h w} command if you know the
4814 name of the command.
4816 @node No Meta key, No Escape key, Producing C-XXX with the keyboard, Key bindings
4817 @section What if I don't have a @key{Meta} key?
4818 @cindex No @key{Meta} key
4819 @cindex @key{Meta} key, what to do if you lack it
4821 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
4823 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}. In fact,
4824 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
4825 (depending on the value of @code{meta-prefix-char}). Note that you
4826 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
4827 @key{ESC}, release it, and then press @key{a}.
4829 @node No Escape key, Compose Character, No Meta key, Key bindings
4830 @section What if I don't have an @key{Escape} key?
4831 @cindex No Escape key
4832 @cindex Lacking an Escape key
4833 @cindex Escape key, lacking
4835 Type @kbd{C-[} instead. This should send ASCII code 27 just like an
4836 Escape key would. @kbd{C-3} may also work on some terminal (but not
4837 under X). For many terminals (notably DEC terminals) @key{F11}
4838 generates @key{ESC}. If not, the following form can be used to bind it:
4841 ;;; F11 is the documented ESC replacement on DEC terminals.
4842 (define-key function-key-map [f11] [?\e])
4845 @node Compose Character, Binding combinations of modifiers and function keys, No Escape key, Key bindings
4846 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
4847 @cindex @key{Compose Character} key, using as @key{Meta}
4848 @cindex @key{Meta}, using @key{Compose Character} for
4850 On a dumb terminal such as a VT220, no. It is rumored that certain
4851 VT220 clones could have their @key{Compose} key configured this way. If
4852 you're using X, you might be able to do this with the @code{xmodmap}
4855 @node Binding combinations of modifiers and function keys, Meta key does not work in xterm, Compose Character, Key bindings
4856 @section How do I bind a combination of modifier key and function key?
4857 @cindex Modifiers and function keys
4858 @cindex Function keys and modifiers
4859 @cindex Binding modifiers and function keys
4861 With Emacs 19 and later, you can represent modified function keys in
4862 vector format by adding prefixes to the function key symbol. For
4863 example (from the on-line documentation):
4866 (global-set-key [?\C-x right] 'forward-page)
4870 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
4872 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
4873 @key{Super}, @key{Alt}, and @key{Shift} with function keys. To
4874 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
4875 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name. Here
4876 is how to make @kbd{H-M-RIGHT} move forward a word:
4879 (global-set-key [H-M-right] 'forward-word)
4885 Not all modifiers are permitted in all situations. @key{Hyper},
4886 @key{Super}, and @key{Alt} are not available on Unix character
4887 terminals. Non-ASCII keys and mouse events (e.g. @kbd{C-=} and
4888 @kbd{Mouse-1}) also fall under this category.
4892 @xref{Binding keys to commands}, for general key binding instructions.
4894 @node Meta key does not work in xterm, ExtendChar key does not work as Meta, Binding combinations of modifiers and function keys, Key bindings
4895 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
4896 @cindex @key{Meta} key and @code{xterm}
4897 @cindex Xterm and @key{Meta} key
4899 @inforef{Single-Byte Character Support, Single-Byte Character Set
4902 If the advice in the Emacs manual fails, try all of these methods before
4903 asking for further help:
4908 You may have big problems using @code{mwm} as your window manager.
4909 (Does anyone know a good generic solution to allow the use of the
4910 @key{Meta} key in Emacs with @file{mwm}?)
4913 For X11: Make sure it really is a @key{Meta} key. Use @code{xev} to
4914 find out what keysym your @key{Meta} key generates. It should be either
4915 @code{Meta_L} or @code{Meta_R}. If it isn't, use @file{xmodmap} to fix
4916 the situation. If @key{Meta} does generate @code{Meta_L} or
4917 @code{Meta_R}, but @kbd{M-x} produces a non-ASCII character, put this in
4918 your @file{~/.Xdefaults} file:
4921 XTerm*eightBitInput: false
4922 XTerm*eightBitOutput: true
4926 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
4927 characters. @samp{stty -a} (or @samp{stty everything}) should show
4928 @samp{cs8} somewhere. If it shows @samp{cs7} instead, use @samp{stty
4929 cs8 -istrip} (or @samp{stty pass8}) to fix it.
4932 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
4933 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
4937 If Emacs is running on Ultrix, it is reported that evaluating
4938 @code{(set-input-mode t nil)} helps.
4941 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
4942 you type @kbd{M-W}, which is the same conversion Emacs would make if it
4943 got the @kbd{M-W} anyway. In X11R4, the following resource
4944 specification will do this:
4947 XTerm.VT100.EightBitInput: false
4951 (This changes the behavior of the @code{insert-eight-bit} action.)
4953 With older @code{xterm}s, you can specify this behavior with a translation:
4956 XTerm.VT100.Translations: #override \
4957 Meta<KeyPress>: string(0x1b) insert()
4961 You might have to replace @samp{Meta} with @samp{Alt}.
4965 @node ExtendChar key does not work as Meta, , Meta key does not work in xterm, Key bindings
4966 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
4967 @cindex @key{ExtendChar} key as @key{Meta}
4968 @cindex @key{Meta}, using @key{ExtendChar} for
4969 @cindex HP-UX, the @key{ExtendChar} key
4971 This is a result of an internationalization extension in X11R4 and the
4972 fact that HP is now using this extension. Emacs assumes that the
4973 @code{XLookupString} function returns the same result regardless of the
4974 @key{Meta} key state which is no longer necessarily true. Until Emacs
4975 is fixed, the temporary kludge is to run this command after each time
4976 the X server is started but preferably before any xterm clients are:
4979 xmodmap -e 'remove mod1 = Mode_switch'
4982 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
4985 This will disable the use of the extra keysyms systemwide, which may be
4986 undesirable if you actually intend to use them.
4988 @c ------------------------------------------------------------
4989 @node Alternate character sets, Mail and news, Key bindings, Top
4990 @chapter Alternate character sets
4991 @cindex Alternate character sets
4994 * Emacs does not display 8-bit characters::
4995 * Inputting eight-bit characters::
4996 * Kanji and Chinese characters::
4997 * Right-to-left alphabets::
5000 @node Emacs does not display 8-bit characters, Inputting eight-bit characters, Alternate character sets, Alternate character sets
5001 @section How do I make Emacs display 8-bit characters?
5002 @cindex Displaying eight-bit characters
5003 @cindex Eight-bit characters, displaying
5005 @inforef{Single-Byte Character Support, Single-byte Character Set
5006 Support, emacs}. On a Unix, when Emacs runs on a text-only terminal
5007 display or is invoked with @samp{emacs -nw}, you typically need to use
5008 @code{set-terminal-coding-system} to tell Emacs what the terminal can
5009 display, even after setting the language environment; otherwise
5010 non-ASCII characters will display as @samp{?}. On other operating
5011 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
5012 character set supported by the display, and sets up the required
5013 terminal coding system automatically.
5015 @node Inputting eight-bit characters, Kanji and Chinese characters, Emacs does not display 8-bit characters, Alternate character sets
5016 @section How do I input eight-bit characters?
5017 @cindex Entering eight-bit characters
5018 @cindex Eight-bit characters, entering
5019 @cindex Input, 8-bit characters
5021 Various methods are available for input of eight-bit characters. See
5022 @inforef{Single-Byte Character Support, Single-byte Character Set
5023 Support, emacs}. For more sophisticated methods, @inforef{Input
5024 Methods, Input Methods, emacs}.
5026 @node Kanji and Chinese characters, Right-to-left alphabets, Inputting eight-bit characters, Alternate character sets
5027 @section Where can I get an Emacs that handles kanji, Chinese, or other Far-Eastern character sets?
5028 @cindex Kanji, handling with Emacs
5029 @cindex Chinese, handling with Emacs
5030 @cindex Japanese, handling with Emacs
5031 @cindex Korean, handling with Emacs
5033 Emacs 20 and later includes many of the features of MULE, the MULtilingual
5034 Enhancement to Emacs. @xref{Installing Emacs}, for information on where
5035 to find and download the latest version of Emacs.
5037 @node Right-to-left alphabets, , Kanji and Chinese characters, Alternate character sets
5038 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
5039 @cindex Right-to-left alphabets
5040 @cindex Hebrew, handling with Emacs
5041 @cindex Semitic alphabets
5042 @cindex Arabic alphabets
5044 Emacs 20 and later supports Hebrew characters (ISO 8859-8), but does not
5045 yet support right-to-left character entry and display.
5047 @email{joel@@exc.com, Joel M. Hoffman} has written a Lisp package called
5048 @file{hebrew.el} that allows right-to-left editing of Hebrew. It
5049 reportedly works out of the box with Emacs 19, but requires patches for
5050 Emacs 18. Write to Joel if you want the patches or package.
5052 @c FIXME: Should we mention Ehud Karni's package?
5054 @file{hebrew.el} requires a Hebrew screen font, but no other hardware support.
5055 Joel has a screen font for PCs running MS-DOS or GNU/Linux.
5057 You might also try to query archie for files named with @file{hebrew};
5058 several ftp sites in Israel may also have the necessary files.
5060 @c ------------------------------------------------------------
5061 @node Mail and news, Concept index, Alternate character sets, Top
5062 @chapter Mail and news
5063 @cindex Mail and news
5066 * Changing the included text prefix::
5067 * Saving a copy of outgoing mail::
5068 * Expanding aliases when sending mail::
5069 * Rmail thinks all messages are one big one::
5070 * Sorting the messages in an Rmail folder::
5071 * Rmail writes to /usr/spool/mail::
5072 * Recovering mail files when Rmail munges them::
5073 * Replying to the sender of a message::
5074 * MIME with Emacs mail packages::
5075 * Automatically starting a mail or news reader::
5076 * Reading news with Emacs::
5077 * Gnus does not work with NNTP::
5078 * Viewing articles with embedded underlining::
5079 * Saving a multi-part Gnus posting::
5080 * Starting Gnus faster::
5081 * Catching up in all newsgroups::
5082 * Killing based on nonstandard headers::
5083 * Removing flashing messages::
5084 * Catch-up is slow in Gnus::
5085 * Gnus hangs for a long time::
5086 * Learning more about Gnus::
5089 @node Changing the included text prefix, Saving a copy of outgoing mail, Mail and news, Mail and news
5090 @section How do I change the included text prefix in mail/news followups?
5091 @cindex Prefix in mail/news followups, changing
5092 @cindex Included text prefix, changing
5093 @cindex Setting the included text character
5094 @cindex Quoting in mail messages
5096 If you read mail with Rmail or news with Gnus, set the variable
5097 @code{mail-yank-prefix}. For VM, set @code{vm-included-text-prefix}.
5098 For mh-e, set @code{mh-ins-buf-prefix}.
5100 For fancier control of citations, use Supercite. @xref{Supercite}.
5102 To prevent Emacs from including various headers of the replied-to
5103 message, set the value of @code{mail-yank-ignored-headers} to an
5106 @node Saving a copy of outgoing mail, Expanding aliases when sending mail, Changing the included text prefix, Mail and news
5107 @section How do I save a copy of outgoing mail?
5108 @cindex Saving a copy of outgoing mail
5109 @cindex Copying outgoing mail to a file
5110 @cindex Filing outgoing mail
5111 @cindex Automatic filing of outgoing mail
5112 @cindex Mail, saving outgoing automatically
5114 You can either mail yourself a copy by including a @samp{BCC} header in the
5115 mail message, or store a copy of the message directly to a file by
5116 including an @samp{FCC} header.
5118 If you use standard mail, you can automatically create a @samp{BCC} to
5122 (setq mail-self-blind t)
5126 in your @file{.emacs} file. You can automatically include an @samp{FCC}
5127 field by putting something like the following in your @file{.emacs}
5131 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
5134 The output file will be in Unix mail format, which can be read directly
5135 by VM, but not always by Rmail. @xref{Learning how to do something}.
5137 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
5140 It does not work to put @samp{set record filename} in the @file{.mailrc}
5143 @node Expanding aliases when sending mail, Rmail thinks all messages are one big one, Saving a copy of outgoing mail, Mail and news
5144 @section Why doesn't Emacs expand my aliases when sending mail?
5145 @cindex Expanding aliases when sending mail
5146 @cindex Mail alias expansion
5147 @cindex Sending mail with aliases
5152 You must separate multiple addresses in the headers of the mail buffer
5153 with commas. This is because Emacs supports RFC822 standard addresses
5157 To: Willy Smith <wks@@xpnsv.lwyrs.com>
5160 However, you do not need to---and probably should not, unless your
5161 system's version of @file{/usr/ucb/mail} (a.k.a.@: @code{mailx})
5162 supports RFC822---separate addresses with commas in your
5163 @file{~/.mailrc} file.
5166 Emacs normally only reads the @file{.mailrc} file once per session,
5167 when you start to compose your first mail message. If you edit
5168 @file{.mailrc}, you can type @kbd{M-x rebuild-mail-abbrevs @key{RET}} to
5169 make Emacs reread @file{~/.mailrc}.
5172 If you like, you can expand mail aliases as abbrevs, as soon as you
5173 type them in. To enable this feature, execute the following:
5176 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
5179 Note that the aliases are expanded automatically only after you type
5180 @key{RET} or a punctuation character (e.g. @kbd{,}). You can force their
5181 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
5182 (@kbd{M-x expand-abbrev}).
5185 @node Rmail thinks all messages are one big one, Sorting the messages in an Rmail folder, Expanding aliases when sending mail, Mail and news
5186 @section Why does Rmail think all my saved messages are one big message?
5187 @cindex Rmail thinks all messages are one large message
5189 A file created through the @samp{FCC} field in a message is in Unix mail
5190 format, not the format that Rmail uses (BABYL format). Rmail will try
5191 to convert a Unix mail file into BABYL format on input, but sometimes it
5192 makes errors. For guaranteed safety, you can make the
5193 @file{saved-messages} file be an inbox for your Rmail file by using the
5194 function @code{set-rmail-inbox-list}.
5196 @node Sorting the messages in an Rmail folder, Rmail writes to /usr/spool/mail, Rmail thinks all messages are one big one, Mail and news
5197 @section How can I sort the messages in my Rmail folder?
5198 @cindex Rmail, sorting messages in
5199 @cindex Folder, sorting messages in an Rmail
5200 @cindex Sorting messages in an Rmail folder
5202 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
5203 and their key bindings.
5205 @node Rmail writes to /usr/spool/mail, Recovering mail files when Rmail munges them, Sorting the messages in an Rmail folder, Mail and news
5206 @section Why does Rmail need to write to @file{/usr/spool/mail}?
5207 @cindex Rmail and @file{/usr/spool/mail}
5208 @cindex @file{/usr/spool/mail} and Rmail
5210 This is the behavior of the @code{movemail} program which Rmail uses.
5211 This indicates that @code{movemail} is configured to use lock files.
5216 Certain systems require lock files to interlock access to mail files.
5217 On these systems, @code{movemail} must write lock files, or you risk losing
5218 mail. You simply must arrange to let @code{movemail} write them.
5220 Other systems use the @code{flock} system call to interlock access. On
5221 these systems, you should configure @code{movemail} to use @code{flock}.
5224 @node Recovering mail files when Rmail munges them, Replying to the sender of a message, Rmail writes to /usr/spool/mail, Mail and news
5225 @section How do I recover my mail files after Rmail munges their format?
5226 @cindex Recovering munged mail files
5227 @cindex Rmail munged my files
5228 @cindex Mail files, recovering those munged by Rmail
5230 If you have just done @kbd{M-x rmail-input} on a file and you don't want
5231 to save it in Rmail's format (called BABYL), just kill the buffer (with
5234 @cindex Exporting messages as Unix mail files
5235 If you typed @kbd{M-x rmail} and it read some messages out of your inbox
5236 and you want to put them in a Unix mail file, use @kbd{C-o} on each
5239 @cindex Converting from BABYL to Unix mail format
5240 @cindex @code{unrmail} command
5241 If you want to convert an existing file from BABYL format to Unix mail
5242 format, use the command @kbd{M-x unrmail}: it will prompt you for the
5243 input and output file names.
5246 Alternatively, you could use the @code{b2m} program supplied with
5247 Emacs. @code{b2m} is a filter, and is used like this:
5250 b2m < @var{babyl-file} > @var{mbox-file}
5254 where @var{babyl-file} is the name of the BABYL file, and
5255 @var{mbox-file} is the name of the file where the converted mail will
5258 @node Replying to the sender of a message, MIME with Emacs mail packages, Recovering mail files when Rmail munges them, Mail and news
5259 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
5260 @cindex Replying only to the sender of a message
5261 @cindex Sender, replying only to
5262 @cindex Rmail, replying to the sender of a message in
5264 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit
5265 @key{r} to reply in Rmail, by default it CCs all of the original
5266 recipients (everyone on the original @samp{To} and @samp{CC}
5267 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
5268 it replies only to the sender. However, going through the whole
5269 @kbd{C-u} business every time you want to reply is a pain. This is the
5270 best fix I've been able to come up with:
5273 (defun rmail-reply-t ()
5274 "Reply only to the sender of the current message. (See rmail-reply.)"
5278 (add-hook 'rmail-mode-hook
5280 (define-key rmail-mode-map "r" 'rmail-reply-t)
5281 (define-key rmail-mode-map "R" 'rmail-reply)))
5284 @node MIME with Emacs mail packages, Automatically starting a mail or news reader, Replying to the sender of a message, Mail and news
5285 @section How can I get my favorite Emacs mail package to support MIME?
5286 @cindex MIME and Emacs mail packages
5287 @cindex Mail packages and MIME
5288 @cindex FAQ for MIME and Emacs
5290 Read the Emacs MIME FAQ, maintained by @email{trey@@cs.berkeley.edu,
5291 MacDonald Hall Jackson} at
5293 @uref{http://bmrc.berkeley.edu/~trey/emacs/mime.html}
5295 Version 6.x of VM supports MIME. @xref{VM}. Gnus supports MIME in mail
5296 and news messages as of version 5.8.1 (Pterodactyl). Rmail has limited
5297 support for single-part MIME messages beginning with Emacs 20.3.
5299 @node Automatically starting a mail or news reader, Reading news with Emacs, MIME with Emacs mail packages, Mail and news
5300 @section How do I make Emacs automatically start my mail/news reader?
5301 @cindex Mail reader, starting automatically
5302 @cindex News reader, starting automatically
5303 @cindex Starting mail/news reader automatically
5305 To start Emacs in Gnus:
5318 A more convenient way to start with Gnus:
5321 alias gnus 'emacs -f gnus'
5325 It is probably unwise to automatically start your mail or news reader
5326 from your @file{.emacs} file. This would cause problems if you needed to run
5327 two copies of Emacs at the same time. Also, this would make it difficult for
5328 you to start Emacs quickly when you needed to.
5330 @node Reading news with Emacs, Gnus does not work with NNTP, Automatically starting a mail or news reader, Mail and news
5331 @section How do I read news under Emacs?
5332 @cindex Reading news under Emacs
5333 @cindex Usenet reader in Emacs
5334 @cindex Gnus newsreader
5336 Use @kbd{M-x gnus}. It is documented in Info (@pxref{Learning how to do
5339 @node Gnus does not work with NNTP, Viewing articles with embedded underlining, Reading news with Emacs, Mail and news
5340 @section Why doesn't Gnus work via NNTP?
5341 @cindex Gnus and NNTP
5342 @cindex NNTP, Gnus fails to work with
5344 There is a bug in NNTP version 1.5.10, such that when multiple requests
5345 are sent to the NNTP server, the server only handles the first one
5346 before blocking waiting for more input which never comes. NNTP version
5347 1.5.11 claims to fix this.
5349 You can work around the bug inside Emacs like this:
5352 (setq nntp-maximum-request 1)
5355 You can find out what version of NNTP your news server is running by
5356 telnetting to the NNTP port (usually 119) on the news server machine
5357 (i.e., @kbd{telnet server-machine 119}). The server should give its
5358 version number in the welcome message. Type @kbd{quit} to get out.
5360 @xref{Spontaneous entry into isearch-mode}, for some additional ideas.
5362 @node Viewing articles with embedded underlining, Saving a multi-part Gnus posting, Gnus does not work with NNTP, Mail and news
5363 @section How do I view news articles with embedded underlining (e.g., ClariNews)?
5364 @cindex Underlining, embedded in news articles
5365 @cindex News articles with embedded underlining
5366 @cindex Embedded underlining in news articles
5368 Underlining appears like this:
5371 _^Hu_^Hn_^Hd_^He_^Hr_^Hl_^Hi_^Hn_^Hi_^Hn_^Hg
5374 @email{abraham@@dina.kvl.dk, Per Abrahamsen} suggests using the following
5375 code, which uses the underline face to turn such text into true
5376 underlining, inconjunction with Gnus:
5379 (defun gnus-article-prepare-overstrike ()
5380 ;; Prepare article for overstrike commands.
5382 (set-buffer gnus-article-buffer)
5383 (let ((buffer-read-only nil))
5384 (goto-char (point-min))
5385 (while (search-forward "\b" nil t)
5386 (let ((next (following-char))
5387 (previous (char-after (- (point) 2))))
5388 (cond ((eq next previous)
5389 (delete-region (- (point) 2) (point))
5390 (put-text-property (point) (1+ (point))
5393 (delete-region (1- (point)) (1+ (point)))
5394 (put-text-property (1- (point)) (point)
5397 (delete-region (- (point) 2) (point))
5398 (put-text-property (point) (1+ (point))
5399 'face 'underline))))))))
5401 (add-hook 'gnus-article-prepare-hook 'gnus-article-prepare-overstrike)
5404 Latest versions of Gnus do such a conversion automatically.
5406 If you prefer to do away with underlining altogether, you can
5407 destructively remove it with @kbd{M-x ununderline-region}; do this
5411 (add-hook 'gnus-article-prepare-hook
5412 (lambda () (ununderline-region (point-min) (point-max))))
5415 @node Saving a multi-part Gnus posting, Starting Gnus faster, Viewing articles with embedded underlining, Mail and news
5416 @section How do I save all the items of a multi-part posting in Gnus?
5417 @cindex Multi-part postings in Gnus, saving
5418 @cindex Saving multi-part postings in Gnus
5419 @cindex Gnus, saving multi-part postings in
5421 Use @code{gnus-uu}. Type @kbd{C-c C-v C-h} in the Gnus summary buffer
5422 to see a list of available commands.
5424 @node Starting Gnus faster, Catching up in all newsgroups, Saving a multi-part Gnus posting, Mail and news
5425 @section How do I make Gnus start up faster?
5426 @cindex Faster, starting Gnus
5427 @cindex Starting Gnus faster
5428 @cindex Gnus, starting faster
5430 From the Gnus FAQ (@pxref{Learning more about Gnus}):
5433 @email{pktiwari@@eos.ncsu.edu, Pranav Kumar Tiwari} writes: I posted
5434 the same query recently and I got an answer to it. I am going to
5435 repeat the answer. What you need is a newer version of gnus, version
5436 5.0.4+. I am using 5.0.12 and it works fine with me with the
5440 (setq gnus-check-new-newsgroups nil
5441 gnus-read-active-file 'some
5442 gnus-nov-is-evil nil
5443 gnus-select-method '(nntp gnus-nntp-server))
5447 @node Catching up in all newsgroups, Killing based on nonstandard headers, Starting Gnus faster, Mail and news
5448 @section How do I catch up all newsgroups in Gnus?
5449 @cindex Catching up all newsgroups in Gnus
5450 @cindex Gnus, Catching up all newsgroups in
5452 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
5454 Leave off the initial @kbd{M-<} if you only want to catch up from point
5455 to the end of the @file{*Newsgroup*} buffer.
5457 @node Killing based on nonstandard headers, Removing flashing messages, Catching up in all newsgroups, Mail and news
5458 @section Why can't I kill in Gnus based on the Newsgroups/Keywords/Control headers?
5459 @cindex Killing articles based on nonstandard headers
5460 @cindex Newsgroups header, killing articles based on
5461 @cindex Keywords header, killing articles based on
5462 @cindex Control header, killing articles based on
5464 Gnus will complain that the @samp{Newsgroups}, @samp{Keywords}, and
5465 @samp{Control} headers are ``Unknown header'' fields.
5467 For the @samp{Newsgroups} header, there is an easy workaround: kill on the
5468 @samp{Xref} header instead, which will be present on any cross-posted article
5469 (as long as your site carries the cross-post group).
5471 If you really want to kill on one of these headers, you can do it like
5475 (gnus-kill nil "^Newsgroups: .*\\(bad\\.group\\|worse\\.group\\)")
5478 @node Removing flashing messages, Catch-up is slow in Gnus, Killing based on nonstandard headers, Mail and news
5479 @section How do I get rid of flashing messages in Gnus for slow connections?
5480 @cindex Flashing Gnus messages, removing
5481 @cindex Removing flashing Gnus messages
5482 @cindex Slow connections causing flashing messages in Gnus
5483 @cindex Gnus, flashing messages in
5485 Set @code{nntp-debug-read} to @code{nil}.
5487 @node Catch-up is slow in Gnus, Gnus hangs for a long time, Removing flashing messages, Mail and news
5488 @section Why is catch up slow in Gnus?
5489 @cindex Slow catch up in Gnus
5490 @cindex Gnus is slow when catching up
5491 @cindex Crosspostings make Gnus catching up slow
5493 Because Gnus is marking crosspostings read. You can control this with
5494 the variable @code{gnus-use-cross-reference}.
5496 @node Gnus hangs for a long time, Learning more about Gnus, Catch-up is slow in Gnus, Mail and news
5497 @section Why does Gnus hang for a long time when posting?
5498 @cindex Hangs in Gnus
5499 @cindex Gnus hangs while posting
5500 @cindex Posting, Gnus hangs wile
5502 @email{tale@@uunet.uu.net, David Lawrence} explains:
5505 The problem is almost always interaction between NNTP and C News. NNTP
5506 POST asks C News's @code{inews} to not background itself but rather hang
5507 around and give its exit status so it knows whether the post was successful.
5508 (That wait will on some systems not return the exit status of the
5509 waited for job is a different sort of problem.) It ends up taking a
5510 long time because @code{inews} is calling @code{relaynews}, which often
5511 waits for another @code{relaynews} to free the lock on the news system
5512 so it can file the article.
5514 My preferred solution is to change @code{inews} to not call
5515 @code{relaynews}, but rather use @code{newsspool}. This loses some
5516 error-catching functionality, but is for the most part safe as
5517 @code{inews} will detect a lot of the errors on its own. The C News
5518 folks have sped up @code{inews}, too, so speed should look better to
5519 most folks as that update propagates around.
5522 @node Learning more about Gnus, , Gnus hangs for a long time, Mail and news
5523 @section Where can I find out more about Gnus?
5524 @cindex FAQ for Gnus
5526 @cindex Learning more about GNU
5528 Look for the Gnus FAQ, available at
5530 @uref{http://www.ccs.neu.edu/software/contrib/gnus/}
5532 @node Concept index, , Mail and news, Top
5533 @unnumbered Concept Index