1 \input texinfo @c -*- mode: texinfo; -*-
3 @setfilename ../../info/efaq
4 @settitle GNU Emacs FAQ
7 @c This is used in many places
10 @c This file is maintained by Romain Francoise <rfrancoise@gnu.org>.
11 @c Feel free to install changes without prior permission (but I'd
12 @c appreciate a notice if you do).
15 Copyright @copyright{} 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
16 Free Software Foundation, Inc.@*
17 Copyright @copyright{} 1994, 1995, 1996, 1997, 1998, 1999, 2000
19 Copyright @copyright{} 1992, 1993 Steven Byrnes@*
20 Copyright @copyright{} 1990, 1991, 1992 Joseph Brian Wells@*
23 This list of frequently asked questions about GNU Emacs with answers
24 (``FAQ'') may be translated into other languages, transformed into other
25 formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information.
27 The same conditions apply to any derivative of the FAQ as apply to the FAQ
28 itself. Every copy of the FAQ must include this notice or an approved
29 translation, information on who is currently maintaining the FAQ and how to
30 contact them (including their e-mail address), and information on where the
31 latest version of the FAQ is archived (including FTP information).
33 The FAQ may be copied and redistributed under these conditions, except that
34 the FAQ may not be embedded in a larger literary work unless that work
35 itself allows free copying and redistribution.
37 [This version has been heavily edited since it was included in the Emacs
44 * Emacs FAQ: (efaq). Frequently Asked Questions about Emacs.
47 @c The @titlepage stuff only appears in the printed version
50 @center @titlefont{GNU Emacs FAQ}
52 @c The following two commands start the copyright page.
54 @vskip 0pt plus 1filll
60 @node Top, FAQ notation, (dir), (dir)
61 @top The GNU Emacs FAQ
63 @c FIXME @today is just the day we ran `makeinfo'.
64 This is the GNU Emacs FAQ, last updated on @today{}.
66 This FAQ is maintained as a part of GNU Emacs. If you find any errors,
67 or have any suggestions, please use @kbd{M-x report-emacs-bug} to report
81 * Compiling and installing Emacs::
82 * Finding Emacs and related packages::
83 * Major packages and programs::
85 * Alternate character sets::
90 @c ------------------------------------------------------------
95 This chapter describes notation used in the GNU Emacs FAQ, as well as in
96 the Emacs documentation. Consult this section if this is the first time
97 you are reading the FAQ, or if you are confused by notation or terms
102 * Extended commands::
104 * File-name conventions::
109 @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
111 @cindex Control key, notation for
112 @cindex @key{Meta} key, notation for
113 @cindex Control-Meta characters, notation for
114 @cindex @kbd{C-h}, definition of
115 @cindex @kbd{C-M-h}, definition of
116 @cindex @key{DEL}, definition of
117 @cindex @key{ESC}, definition of
118 @cindex @key{LFD}, definition of
119 @cindex @key{RET}, definition of
120 @cindex @key{SPC}, definition of
121 @cindex @key{TAB}, definition of
122 @cindex Notation for keys
127 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
130 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
131 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
134 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
138 @kbd{C-M-x}: a synonym for the above
141 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
144 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
147 @key{DEL}: @key{Delete}, usually @strong{not} the same as
148 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
149 deleting invokes Emacs help)
152 @key{ESC}: Escape; same as @kbd{C-[}
155 @key{TAB}: Tab; same as @kbd{C-i}
162 Key sequences longer than one key (and some single-key sequences) are
163 written inside quotes or on lines by themselves, like this:
166 @kbd{M-x frobnicate-while-foo RET}
170 Any real spaces in such a key sequence should be ignored; only @key{SPC}
171 really means press the space key.
173 The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
174 that would be sent by pressing just @key{x} minus 96 (or 64 for
175 upper-case @key{X}) and will be from 0 to 31. On Unix and GNU/Linux
176 terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the
177 @acronym{ASCII} code that would be sent by pressing just @key{x}. Essentially,
178 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
180 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
183 @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call
184 @kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON.
185 Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127.
186 @c FIXME I cannot understand the previous sentence.
188 @inforef{Keys, Keys, emacs}, for more information. (@xref{Emacs
189 manual}, for more information about Info.)
191 @node Extended commands
192 @section What does @file{M-x @var{command}} mean?
193 @cindex Extended commands
194 @cindex Commands, extended
195 @cindex M-x, meaning of
197 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
198 command, then type @key{RET}. (@xref{Basic keys}, if you're not sure
199 what @kbd{M-x} and @key{RET} mean.)
201 @kbd{M-x} (by default) invokes the command
202 @code{execute-extended-command}. This command allows you to run any
203 Emacs command if you can remember the command's name. If you can't
204 remember the command's name, you can type @key{TAB} and @key{SPC} for
205 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
206 @kbd{M-n} (or up-arrow and down-arrow on terminals that have these
207 editing keys) to see previous commands entered. An Emacs @dfn{command}
208 is an @dfn{interactive} Emacs function.
211 Your system administrator may have bound other key sequences to invoke
212 @code{execute-extended-command}. A function key labeled @kbd{Do} is a
213 good candidate for this, on keyboards that have such a key.
215 If you need to run non-interactive Emacs functions, see @ref{Evaluating
219 @section How do I read topic XXX in the Emacs manual?
220 @cindex Emacs manual, reading topics in
221 @cindex Reading topics in the Emacs manual
222 @cindex Finding topics in the Emacs manual
223 @cindex Info, finding topics in
225 When we refer you to some @var{topic} in the Emacs manual, you can
226 read this manual node inside Emacs (assuming nothing is broken) by
227 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
229 This invokes Info, the GNU hypertext documentation browser. If you don't
230 already know how to use Info, type @key{?} from within Info.
232 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
233 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
235 If these commands don't work as expected, your system administrator may
236 not have installed the Info files, or may have installed them
237 improperly. In this case you should complain.
239 @xref{Getting a printed manual}, if you would like a paper copy of the
242 @node File-name conventions
243 @section What are @file{etc/GNU}, @file{src/config.h}, and @file{site-lisp/default.el}?
244 @cindex File-name conventions
245 @cindex Conventions for file names
246 @cindex Directories and files that come with Emacs
248 These are files that come with Emacs. The Emacs distribution is divided
249 into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}.
251 If you use Emacs, but don't know where it is kept on your system, start
252 Emacs, then type @kbd{C-h v data-directory @key{RET}}. The directory
253 name displayed by this will be the full pathname of the installed
254 @file{etc} directory. (This full path is recorded in the Emacs variable
255 @code{data-directory}, and @kbd{C-h v} displays the value and the
256 documentation of a variable.)
258 The location of your Info directory (i.e., where Info documentation
259 is stored) is kept in the variable @code{Info-default-directory-list}. Use
260 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
261 this variable, which will be a list of directory names. The last
262 directory in that list is probably where most Info files are stored. By
263 default, Info documentation is placed in @file{/usr/local/share/info}.
265 Some of these files are available individually via FTP or e-mail; see
266 @ref{Informational files for Emacs}. They all are available in the
267 source distribution. Many of the files in the @file{etc} directory are
268 also available via the Emacs @samp{Help} menu, or by typing @kbd{C-h ?}
269 (@kbd{M-x help-for-help}).
271 @node Common acronyms
272 @section What are FSF, LPF, GNU, RMS, FTP, and GPL?
273 @cindex FSF, definition of
274 @cindex LPF, definition of
275 @cindex GNU, definition of
276 @cindex RMS, definition of
277 @cindex Stallman, Richard, acronym for
278 @cindex Richard Stallman, acronym for
279 @cindex FTP, definition of
280 @cindex GPL, definition of
281 @cindex Acronyms, definitions for
282 @cindex Common acronyms, definitions for
287 Free Software Foundation
290 League for Programming Freedom
296 Richard Matthew Stallman
299 File Transfer Protocol
302 GNU General Public License
306 Avoid confusing the FSF and the LPF. The LPF opposes
307 look-and-feel copyrights and software patents. The FSF aims to make
308 high quality free software available for everyone.
310 The word ``free'' in the title of the Free Software Foundation refers to
311 ``freedom,'' not ``zero cost.'' Anyone can charge any price for
312 GPL-covered software that they want to. However, in practice, the
313 freedom enforced by the GPL leads to low prices, because you can always
314 get the software for less money from someone else, since everyone has
315 the right to resell or give away GPL-covered software.
317 @c ------------------------------------------------------------
318 @node General questions
319 @chapter General questions
320 @cindex General questions
322 This chapter contains general questions having to do with Emacs, the
323 Free Software Foundation, and related organizations.
327 * Real meaning of copyleft::
328 * Guidelines for newsgroup postings::
329 * Newsgroup archives::
331 * Unsubscribing from Emacs lists::
332 * Contacting the FSF::
336 @section What is the LPF?
337 @cindex LPF, description of
338 @cindex League for Programming Freedom
339 @cindex Software patents, opposition to
340 @cindex Patents for software, opposition to
342 The LPF opposes the expanding danger of software patents and
343 look-and-feel copyrights. More information on the LPF's views is
344 available at @uref{http://progfree.org/, the LPF home page}.
346 @node Real meaning of copyleft
347 @section What is the real legal meaning of the GNU copyleft?
348 @cindex Copyleft, real meaning of
349 @cindex GPL, real meaning of
350 @cindex General Public License, real meaning of
351 @cindex Discussion of the GPL
353 The real legal meaning of the GNU General Public License (copyleft) will
354 only be known if and when a judge rules on its validity and scope.
355 There has never been a copyright infringement case involving the GPL to
356 set any precedents. Although legal actions have been brought against
357 companies for violating the terms of the GPL, so far all have been
358 settled out of court (in favour of the plaintiffs). Please take any
359 discussion regarding this issue to the newsgroup
360 @uref{news:gnu.misc.discuss}, which was created to hold the extensive
361 flame wars on the subject.
366 The legal meaning of the GNU copyleft is less important than the spirit,
367 which is that Emacs is a free software project and that work pertaining
368 to Emacs should also be free software. ``Free'' means that all users
369 have the freedom to study, share, change and improve Emacs. To make
370 sure everyone has this freedom, pass along source code when you
371 distribute any version of Emacs or a related program, and give the
372 recipients the same freedom that you enjoyed.
375 @node Guidelines for newsgroup postings
376 @section What are appropriate messages for the various Emacs newsgroups?
377 @cindex Newsgroups, appropriate messages for
378 @cindex GNU newsgroups, appropriate messages for
379 @cindex Usenet groups, appropriate messages for
380 @cindex Mailing lists, appropriate messages for
381 @cindex Posting messages to newsgroups
383 @cindex GNU mailing lists
384 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU
385 mailing list. (@xref{Informational files for Emacs}, if you want a copy
386 of the file.) For those lists which are gatewayed with newsgroups, it
387 lists both the newsgroup name and the mailing list address.
389 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
390 in general. The newsgroup @uref{news:gnu.emacs.help} is specifically
393 Messages advocating ``non-free'' software are considered unacceptable on
394 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
395 which was created to hold the extensive flame-wars on the subject.
396 ``Non-free'' software includes any software for which the end user can't
397 freely modify the source code and exchange enhancements. Be careful to
398 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
399 posting a followup that recommends such software.
401 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
402 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
404 @node Newsgroup archives
405 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
406 @cindex Archived postings from @code{gnu.emacs.help}
407 @cindex Usenet archives for GNU groups
408 @cindex Old Usenet postings for GNU groups
410 The FSF has maintained archives of all of the GNU mailing lists for many
411 years, although there may be some unintentional gaps in coverage. The
412 archive is not particularly well organized or easy to retrieve
413 individual postings from, but pretty much everything is there.
415 The archive is at @uref{ftp://lists.gnu.org/}.
417 The archive can be browsed over the web at
418 @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}.
420 Web-based Usenet search services, such as
421 @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also
422 archive the @code{gnu.*} groups.
424 You can read the archives of the @code{gnu.*} groups and post new
425 messages at @uref{http://gmane.org/, Gmane}. Gmane is a service that
426 presents mailing lists as newsgroups.
429 @section Where should I report bugs and other problems with Emacs?
430 @cindex Bug reporting
431 @cindex Good bug reports
432 @cindex How to submit a bug report
433 @cindex Reporting bugs
435 The correct way to report Emacs bugs is to use the command
436 @kbd{M-x report-emacs-bug}. It sets up a mail buffer with the
437 essential information and the correct e-mail address, which is
438 @email{bug-gnu-emacs@@gnu.org} for the released versions of Emacs.
439 Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the
440 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
441 news to submit the bug report. This ensures a reliable return address
442 so you can be contacted for further details.
444 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
445 a bug! The manual describes in detail how to submit a useful bug
446 report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}).
447 (@xref{Emacs manual}, if you don't know how to read the manual.)
452 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the
453 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because
454 it takes the time of an unnecessarily large group of people, most of
455 whom are just users and have no idea how to fix these problem.
456 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people
457 who are more likely to know what to do and have expressed a wish to
458 receive more messages about Emacs than the others.
461 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
464 If you have reported a bug and you don't hear about a possible fix,
465 then after a suitable delay (such as a week) it is okay to post on
466 @code{gnu.emacs.help} asking if anyone can help you.
469 If you are unsure whether you have found a bug, consider the following
470 non-exhaustive list, courtesy of RMS:
473 If Emacs crashes, that is a bug. If Emacs gets compilation errors
474 while building, that is a bug. If Emacs crashes while building, that
475 is a bug. If Lisp code does not do what the documentation says it
479 @node Unsubscribing from Emacs lists
480 @section How do I unsubscribe from a mailing list?
481 @cindex Unsubscribing from GNU mailing lists
482 @cindex Removing yourself from GNU mailing lists
484 If you are receiving a GNU mailing list named @var{list}, you should be
485 able to unsubscribe from it by sending a request to the address
486 @email{@var{list}-request@@gnu.org}. Mailing lists mails normally
487 contain information in either the message header
488 (@samp{List-Unsubscribe:}) or as a footer that tells you how to
491 @node Contacting the FSF
492 @section What is the current address of the FSF?
493 @cindex Snail mail address of the FSF
494 @cindex Postal address of the FSF
495 @cindex Contracting the FSF
496 @cindex Free Software Foundation, contacting
510 @uref{http://www.fsf.org/}
513 Free Software Foundation@*
514 51 Franklin Street, Fifth Floor@*
515 Boston, MA 02110-1301@*
520 @cindex Ordering GNU software
521 For details on how to order items directly from the FSF, see the
522 @uref{http://shop.fsf.org/, FSF on-line store}.
524 @c ------------------------------------------------------------
526 @chapter Getting help
529 This chapter tells you how to get help with Emacs.
533 * Learning how to do something::
534 * Getting a printed manual::
535 * Emacs Lisp documentation::
536 * Installing Texinfo documentation::
537 * Printing a Texinfo file::
538 * Viewing Info files outside of Emacs::
539 * Informational files for Emacs::
540 * Help installing Emacs::
541 * Obtaining the FAQ::
545 @section I'm just starting Emacs; how do I do basic editing?
546 @cindex Basic editing with Emacs
547 @cindex Beginning editing
548 @cindex Tutorial, invoking the
549 @cindex Self-paced tutorial, invoking the
550 @cindex Help system, entering the
552 Type @kbd{C-h t} to invoke the self-paced tutorial. Just typing
553 @kbd{C-h} enters the help system. Starting with Emacs 22, the tutorial
554 is available in many foreign languages such as French, German, Japanese,
555 Russian, etc. Use @kbd{M-x help-with-tutorial-spec-language @key{RET}}
556 to choose your language and start the tutorial.
558 Your system administrator may have changed @kbd{C-h} to act like
559 @key{DEL} to deal with local keyboards. You can use @kbd{M-x
560 help-for-help} instead to invoke help. To discover what key (if any)
561 invokes help on your system, type @kbd{M-x where-is @key{RET}
562 help-for-help @key{RET}}. This will print a comma-separated list of key
563 sequences in the echo area. Ignore the last character in each key
564 sequence listed. Each of the resulting key sequences (e.g. @key{F1} is
565 common) invokes help.
567 Emacs help works best if it is invoked by a single key whose value
568 should be stored in the variable @code{help-char}.
570 @node Learning how to do something
571 @section How do I find out how to do something in Emacs?
572 @cindex Help for Emacs
573 @cindex Learning to do something in Emacs
574 @cindex Reference card for Emacs
575 @cindex Overview of help systems
577 There are several methods for finding out how to do things in Emacs.
581 @cindex Reading the Emacs manual
583 The complete text of the Emacs manual is available via the Info
584 hypertext reader. Type @kbd{C-h r} to display the manual in Info mode.
585 Typing @key{h} immediately after entering Info will provide a short
586 tutorial on how to use it.
588 @cindex Lookup a subject in a manual
589 @cindex Index search in a manual
591 To quickly locate the section of the manual which discusses a certain
592 issue, or describes a command or a variable, type @kbd{C-h i m emacs
593 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
594 topic, the command, or the variable which you are looking for. If this
595 does not land you on the right place in the manual, press @kbd{,}
596 (comma) repeatedly until you find what you need. (The @kbd{i} and
597 @kbd{,} keys invoke the index-searching functions, which look for the
598 @var{topic} you type in all the indices of the Emacs manual.)
602 You can list all of the commands whose names contain a certain word
603 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
606 @cindex Command description in the manual
608 The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts
609 for the name of a command, and then attempts to find the section in the
610 Emacs manual where that command is described.
612 @cindex Finding commands and variables
614 You can list all of the functions and variables whose names contain a
615 certain word using @kbd{M-x apropos}.
618 You can list all of the functions and variables whose documentation
619 matches a regular expression or a string, using @kbd{M-x
620 apropos-documentation}.
623 You can order a hardcopy of the manual from the FSF. @xref{Getting a
626 @cindex Reference cards, in other languages
628 You can get a printed reference card listing commands and keys to
629 invoke them. You can order one from the FSF for $2 (or 10 for $18),
630 or you can print your own from the @file{etc/refcards/refcard.tex} or
631 @file{etc/refcards/refcard.pdf} files in the Emacs distribution.
632 Beginning with version 21.1, the Emacs distribution comes with
633 translations of the reference card into several languages; look for
634 files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang}
635 is a two-letter code of the language. For example, the German version
636 of the reference card is in the files @file{etc/refcards/de-refcard.tex}
637 and @file{etc/recards/de-refcard.pdf}.
640 There are many other commands in Emacs for getting help and
641 information. To get a list of these commands, type @samp{?} after
646 @node Getting a printed manual
647 @section How do I get a printed copy of the Emacs manual?
648 @cindex Printed Emacs manual, obtaining
649 @cindex Manual, obtaining a printed or HTML copy of
650 @cindex Emacs manual, obtaining a printed or HTML copy of
652 You can order a printed copy of the Emacs manual from the FSF. For
653 details see the @uref{http://shop.fsf.org/, FSF on-line store}.
655 The full Texinfo source for the manual also comes in the @file{doc/emacs}
656 directory of the Emacs distribution, if you're daring enough to try to
657 print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo
660 If you absolutely have to print your own copy, and you don't have @TeX{},
661 you can get a PostScript or PDF (or HTML) version from
663 @uref{http://www.gnu.org/software/emacs/manual/}
665 @xref{Learning how to do something}, for how to view the manual.
667 @node Emacs Lisp documentation
668 @section Where can I get documentation on Emacs Lisp?
669 @cindex Documentation on Emacs Lisp
670 @cindex Function documentation
671 @cindex Variable documentation
672 @cindex Emacs Lisp Reference Manual
673 @cindex Reference manual for Emacs Lisp
675 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
676 function, @kbd{C-h v} for a variable.
678 For more information, the Emacs Lisp Reference Manual is available
679 in Info format. @xref{Top, Emacs Lisp,, elisp, The
680 Emacs Lisp Reference Manual}.
682 You can also order a hardcopy of the manual, details on ordering it from
683 FSF are on the @uref{http://shop.fsf.org/, FSF on-line store}.
685 An HTML version of the Emacs Lisp Reference Manual is available at
687 @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html}
689 @node Installing Texinfo documentation
690 @section How do I install a piece of Texinfo documentation?
691 @cindex Texinfo documentation, installing
692 @cindex Installing Texinfo documentation
693 @cindex New Texinfo files, installing
694 @cindex Documentation, installing new Texinfo files
695 @cindex Info files, how to install
697 First, you must turn the Texinfo files into Info files. You may do this
698 using the stand-alone @file{makeinfo} program, available as part of the
701 @uref{http://www.gnu.org/software/texinfo/}
703 For information about the Texinfo format, read the Texinfo manual which
704 comes with the Texinfo package. This manual also comes installed in
705 Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo
708 Alternatively, you could use the Emacs command @kbd{M-x
709 texinfo-format-buffer}, after visiting the Texinfo source file of the
710 manual you want to convert.
712 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
713 resulting Info files in Emacs's Info tree. To install Info files,
718 Move the files to the @file{info} directory in the installed Emacs
719 distribution. @xref{File-name conventions}, if you don't know where that
723 Run the @code{install-info} command, which is part of the Texinfo
724 distribution, to update the main Info directory menu, like this:
727 install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
731 where @var{dir-path} is the full path to the directory where you copied
732 the produced Info file(s), and @var{file} is the name of the Info file
733 you produced and want to install.
735 If you don't have the @code{install-info} command installed, you can
736 edit the file @file{info/dir} in the installed Emacs distribution, and
737 add a line for the top level node in the Info package that you are
738 installing. Follow the examples already in this file. The format is:
741 * Topic: (relative-pathname). Short description of topic.
746 If you want to install Info files and you don't have the necessary
747 privileges, you have several options:
751 Info files don't actually need to be installed before being used.
752 You can use a prefix argument for the @code{info} command and specify
753 the name of the Info file in the minibuffer. This goes to the node
754 named @samp{Top} in that file. For example, to view a Info file named
755 @file{@var{info-file}} in your home directory, you can type this:
758 @kbd{C-u C-h i ~/@var{info-file} @key{RET}}
761 Alternatively, you can feed a file name to the @code{Info-goto-node}
762 command (invoked by pressing @key{g} in Info mode) by typing the name
763 of the file in parentheses, like this:
766 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
770 You can create your own Info directory. You can tell Emacs where that
771 Info directory is by adding its pathname to the value of the variable
772 @code{Info-default-directory-list}. For example, to use a private Info
773 directory which is a subdirectory of your home directory named @file{Info},
774 you could put this in your @file{.emacs} file:
777 (setq Info-default-directory-list
778 (cons "~/Info" Info-default-directory-list))
781 You will need a top-level Info file named @file{dir} in this directory
782 which has everything the system @file{dir} file has in it, except it should
783 list only entries for Info files in that directory. You might not need
784 it if all files in this directory were referenced by other @file{dir}
785 files. The node lists from all @file{dir} files in
786 @code{Info-default-directory-list} are merged by the Info system.
790 @node Printing a Texinfo file
791 @section How do I print a Texinfo file?
792 @cindex Printing a Texinfo file
793 @cindex Texinfo file, printing
794 @cindex Printing documentation
796 You can't get nicely printed output from Info files; you must still have
797 the original Texinfo source file for the manual you want to print.
799 Assuming you have @TeX{} installed on your system, follow these steps:
804 Make sure the first line of the Texinfo file looks like this:
810 You may need to change @samp{texinfo} to the full pathname of the
811 @file{texinfo.tex} file, which comes with Emacs as
812 @file{doc/misc/texinfo.tex} (or copy or link it into the current directory).
815 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
816 the name of the Texinfo source file for which you want to produce a
819 The @samp{texi2dvi} script is part of the GNU Texinfo distribution
820 (@pxref{Installing Texinfo documentation}).
822 Alternatively, @samp{texi2pdf} produces PDF files.
825 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
826 printing DVI files at your site. For example, if you have a PostScript
827 printer, run the @code{dvips} program to print the DVI file on that
832 To get more general instructions, retrieve the latest Texinfo package
833 (@pxref{Installing Texinfo documentation}).
835 @node Viewing Info files outside of Emacs
836 @section Can I view Info files without using Emacs?
837 @cindex Viewing Info files
838 @cindex Info file viewers
839 @cindex Alternative Info file viewers
841 Yes. Here are some alternative programs:
846 @code{info}, a stand-alone version of the Info program, comes as part of
847 the Texinfo package. @xref{Installing Texinfo documentation}, for
851 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
852 You can get Tkinfo at
853 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
857 @node Informational files for Emacs
858 @section What informational files are available for Emacs?
859 @cindex Informational files included with Emacs
860 @cindex Files included with Emacs
861 @cindex @file{COPYING}, description of file
862 @cindex @file{DISTRIB}, description of file
863 @cindex @file{GNU}, description of file
864 @cindex @file{INTERVIEW}, description of file
865 @cindex @file{MACHINES}, description of file
866 @cindex @file{MAILINGLISTS}, description of file
867 @cindex @file{NEWS}, description of file
869 This isn't a frequently asked question, but it should be! A variety of
870 informational files about Emacs and relevant aspects of the GNU project
871 are available for you to read.
873 The following files are available in the @file{etc} directory of the
874 Emacs distribution (see @ref{File-name conventions}, if you're not sure
880 GNU General Public License
883 Emacs Availability Information
889 Richard Stallman discusses his public-domain UNIX-compatible software
890 system with BYTE editors
893 Status of Emacs on Various Machines and Systems
896 GNU Project Electronic Mailing Lists
899 Emacs news, a history of recent user-visible changes
903 More GNU information, including back issues of the @cite{GNU's
906 @uref{http://www.gnu.org/bulletins/bulletins.html} and
908 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
910 @node Help installing Emacs
911 @section Where can I get help in installing Emacs?
912 @cindex Installation help
913 @cindex Help installing Emacs
915 @xref{Installing Emacs}, for some basic installation hints, and see
916 @ref{Problems building Emacs}, if you have problems with the installation.
918 The web-page @uref{http://www.fsf.org/resources/service/} lists
919 companies and individuals willing to sell you help in installing or
922 @node Obtaining the FAQ
923 @section Where can I get the latest version of this FAQ?
924 @cindex FAQ, obtaining the
925 @cindex Latest FAQ version, obtaining the
927 The Emacs FAQ is distributed with Emacs in Info format. You can read it
928 by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of
929 the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h
930 C-f} (@kbd{M-x view-emacs-FAQ}).
933 @c ------------------------------------------------------------
934 @node Status of Emacs
935 @chapter Status of Emacs
936 @cindex Status of Emacs
938 This chapter gives you basic information about Emacs, including its
939 latest version status.
942 * Origin of the term Emacs::
943 * Latest version of Emacs::
949 @node Origin of the term Emacs
950 @section Where does the name ``Emacs'' come from?
951 @cindex Origin of the term ``Emacs''
952 @cindex Emacs name origin
954 @cindex Original version of Emacs
956 Emacs originally was an acronym for Editor MACroS. RMS says he ``picked
957 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
958 the time.'' The first Emacs was a set of macros written in 1976 at MIT
959 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
960 Editor and COrrector) under ITS on a PDP-10. RMS had already extended
961 TECO with a ``real-time'' full-screen mode with reprogrammable keys.
962 Emacs was started by @email{gls@@east.sun.com, Guy Steele} as a project
963 to unify the many divergent TECO command sets and key bindings at MIT,
964 and completed by RMS.
966 Many people have said that TECO code looks a lot like line noise; you
967 can read more at @uref{news:alt.lang.teco}. Someone has written a TECO
968 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
969 come with Emacs}); it would be an interesting project to run the
970 original TECO Emacs inside of Emacs.
973 For some not-so-serious alternative reasons for Emacs to have that
974 name, check out the file @file{etc/JOKES} (@pxref{File-name
977 @node Latest version of Emacs
978 @section What is the latest version of Emacs?
979 @cindex Version, latest
980 @cindex Latest version of Emacs
982 Emacs @value{VER} is the current version as of this writing. A version
983 number with two components (e.g. @samp{22.1}) indicates a released
984 version; three components (e.g. @samp{23.0.50}) indicate a development
987 @node New in Emacs 20
988 @section What is different about Emacs 20?
989 @cindex Differences between Emacs 19 and Emacs 20
990 @cindex Emacs 20, new features in
992 To find out what has changed in recent versions, type @kbd{C-h C-n}
993 (@kbd{M-x view-emacs-news}). The oldest changes are at the bottom of
994 the file, so you might want to read it starting there, rather than at
997 The differences between Emacs versions 18 and 19 was rather dramatic;
998 the introduction of frames, faces, and colors on windowing systems was
999 obvious to even the most casual user.
1001 There are differences between Emacs versions 19 and 20 as well, but many
1002 are more subtle or harder to find. Among the changes are the inclusion
1003 of MULE code for languages that use non-Latin characters and for mixing
1004 several languages in the same document; the ``Customize'' facility for
1005 modifying variables without having to use Lisp; and automatic conversion
1006 of files from Macintosh, Microsoft, and Unix platforms.
1008 A number of older Lisp packages, such as Gnus, Supercite and the
1009 calendar/diary, have been updated and enhanced to work with Emacs 20,
1010 and are now included with the standard distribution.
1013 @node New in Emacs 21
1014 @section What is different about Emacs 21?
1015 @cindex Differences between Emacs 20 and Emacs 21
1016 @cindex Emacs 21, new features in
1017 @cindex Recently introduced features
1019 @cindex Variable-size fonts
1020 @cindex Toolbar support
1021 Emacs 21 features a thorough rewrite of the display engine. The new
1022 display engine supports variable-size fonts, images, and can play sounds
1023 on platforms which support that. As a result, the visual appearance of
1024 Emacs, when it runs on a windowed display, is much more reminiscent of
1025 modern GUI programs, and includes 3D widgets (used for the mode line and
1026 the scroll bars), a configurable and extensible toolbar, tooltips
1027 (a.k.a.@: balloon help), and other niceties.
1029 @cindex Colors on text-only terminals
1031 In addition, Emacs 21 supports faces on text-only terminals. This means
1032 that you can now have colors when you run Emacs on a GNU/Linux console
1033 and on @code{xterm} with @kbd{emacs -nw}.
1035 @node New in Emacs 22
1036 @section What is different about Emacs 22?
1037 @cindex Differences between Emacs 21 and Emacs 22
1038 @cindex Emacs 22, new features in
1039 @cindex Recently introduced features
1040 @cindex Default features
1043 @cindex GTK+ Toolkit
1044 @cindex Drag-and-drop
1046 Emacs can be built with GTK+ widgets, and supports drag-and-drop
1049 @cindex Supported systems
1051 Emacs 22 features support for GNU/Linux systems on S390 and x86-64
1052 machines, as well as support for the Mac OS X and Cygwin operating
1056 The native MS-Windows, and Mac OS X builds include full support
1057 for images, toolbar, and tooltips.
1060 Font Lock mode, Auto Compression mode, and File Name Shadow Mode are
1064 The maximum size of buffers has been doubled and is 256M on 32-bit
1068 Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}.
1072 Mouse wheel support is enabled by default.
1075 Window fringes are customizable.
1078 The mode line of the selected window is now highlighted.
1081 The minibuffer prompt is displayed in a distinct face.
1084 Abbrev definitions are read automatically at startup.
1087 Grep mode is separate from Compilation mode and has many new options and
1088 commands specific to grep.
1091 The original Emacs macro system has been replaced by the new Kmacro
1092 package, which provides many new commands and features and a simple
1093 interface that uses the function keys F3 and F4. Macros are stored in a
1094 macro ring, and can be debugged and edited interactively.
1097 The Grand Unified Debugger (GUD) can be used with a full graphical user
1098 interface to GDB; this provides many features found in traditional
1099 development environments, making it easy to manipulate breakpoints, add
1100 watch points, display the call stack, etc. Breakpoints are visually
1101 indicated in the source buffer.
1105 Many new modes and packages have been included in Emacs, such as Calc,
1106 TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org,
1107 PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines,
1108 savehist, Conf mode, Python mode, DNS mode, etc.
1110 @cindex Multilingual Environment
1112 Leim is now part of Emacs. Unicode support has been much improved, and
1113 the following input methods have been added: belarusian, bulgarian-bds,
1114 bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian,
1115 latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard,
1116 lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345,
1117 russian-computer, sgml, slovenian, tamil-inscript, ucs,
1118 ukrainian-computer, vietnamese-telex, and welsh.
1120 The following language environments have also been added: Belarusian,
1121 Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6,
1122 Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish,
1123 Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255.
1125 @cindex Documentation
1126 @cindex Emacs Lisp Manual
1128 In addition, Emacs 22 now includes the Emacs Lisp Reference Manual
1129 (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro.
1132 Many other changes have been made in Emacs 22, use @kbd{C-h n} to get a
1135 @c ------------------------------------------------------------
1136 @node Common requests
1137 @chapter Common requests
1138 @cindex Common requests
1141 * Setting up a customization file::
1144 * Debugging a customization file::
1145 * Displaying the current line or column::
1146 * Displaying the current file name in the titlebar::
1147 * Turning on abbrevs by default::
1148 * Associating modes with files::
1149 * Highlighting a region::
1150 * Replacing highlighted text::
1151 * Controlling case sensitivity::
1152 * Working with unprintable characters::
1153 * Searching for/replacing newlines::
1154 * Yanking text in isearch::
1155 * Wrapping words automatically::
1156 * Turning on auto-fill by default::
1157 * Changing load-path::
1158 * Using an already running Emacs process::
1159 * Compiler error messages::
1160 * Indenting switch statements::
1161 * Customizing C and C++ indentation::
1162 * Horizontal scrolling::
1164 * Turning off beeping::
1165 * Turning the volume down::
1166 * Automatic indentation::
1167 * Matching parentheses::
1168 * Hiding #ifdef lines::
1169 * Repeating commands::
1170 * Valid X resources::
1171 * Evaluating Emacs Lisp code::
1172 * Changing the length of a Tab::
1173 * Inserting text at the beginning of each line::
1174 * Underlining paragraphs::
1175 * Forcing the cursor to remain in the same column::
1176 * Forcing Emacs to iconify itself::
1177 * Using regular expressions::
1178 * Replacing text across multiple files::
1179 * Documentation for etags::
1180 * Disabling backups::
1181 * Disabling auto-save-mode::
1182 * Going to a line by number::
1183 * Modifying pull-down menus::
1184 * Deleting menus and menu options::
1185 * Turning on syntax highlighting::
1186 * Scrolling only one line::
1187 * Editing MS-DOS files::
1188 * Filling paragraphs with a single space::
1189 * Escape sequences in shell output::
1190 * Fullscreen mode on MS-Windows::
1193 @node Setting up a customization file
1194 @section How do I set up a @file{.emacs} file properly?
1195 @cindex @file{.emacs} file, setting up
1196 @cindex @file{.emacs} file, locating
1197 @cindex Init file, setting up
1198 @cindex Customization file, setting up
1200 @inforef{Init File, Init File, emacs}.
1202 In general, new Emacs users should not have @file{.emacs} files, because
1203 it causes confusing non-standard behavior. Then they send questions to
1204 @email{help-gnu-emacs@@gnu.org} asking why Emacs isn't behaving as
1207 Beginning with version 20.1, Emacs includes the new Customize facility
1208 (@pxref{Using Customize}). This allows users who are unfamiliar with
1209 Emacs Lisp to modify their @file{.emacs} files in a relatively
1210 straightforward way, using menus rather than Lisp code. Most packages
1211 support Customize as of this writing.
1213 While Customize might indeed make it easier to configure Emacs,
1214 consider taking a bit of time to learn Emacs Lisp and modifying your
1215 @file{.emacs} directly. Simple configuration options are described
1216 rather completely in @inforef{Init File, Init File, emacs}, for users
1217 interested in performing frequently requested, basic tasks.
1219 Sometimes users are unsure as to where their @file{.emacs} file should
1220 be found. Visiting the file as @file{~/.emacs} from Emacs will find
1223 @node Using Customize
1224 @section How do I start using Customize?
1225 @cindex Customize groups
1226 @cindex Customizing variables
1227 @cindex Customizing faces
1229 The main Customize entry point is @kbd{M-x customize @key{RET}}. This
1230 command takes you to a buffer listing all the available Customize
1231 groups. From there, you can access all customizable options and faces,
1232 change their values, and save your changes to your init file.
1233 @inforef{Easy Customization, Easy Customization, emacs}.
1235 If you know the name of the group in advance (e.g. ``shell''), use
1236 @kbd{M-x customize-group @key{RET}}.
1238 If you wish to customize a single option, use @kbd{M-x customize-option
1239 @key{RET}}. This command prompts you for the name of the option to
1240 customize, with completion.
1242 @node Colors on a TTY
1243 @section How do I get colors and syntax highlighting on a TTY?
1244 @cindex Colors on a TTY
1245 @cindex Syntax highlighting on a TTY
1246 @cindex Console, colors
1248 In Emacs 21.1 and later, colors and faces are supported in non-windowed mode,
1249 i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when
1250 invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were
1251 supported in the MS-DOS port since Emacs 19.29.) Emacs automatically
1252 detects color support at startup and uses it if available. If you think
1253 that your terminal supports colors, but Emacs won't use them, check the
1254 @code{termcap} entry for your display type for color-related
1257 The command @kbd{M-x list-colors-display} pops up a window which
1258 exhibits all the colors Emacs knows about on the current display.
1260 Syntax highlighting is on by default since version 22.1.
1262 @node Debugging a customization file
1263 @section How do I debug a @file{.emacs} file?
1264 @cindex Debugging @file{.emacs} file
1265 @cindex @file{.emacs} debugging
1266 @cindex Init file debugging
1267 @cindex @samp{-debug-init} option
1269 Start Emacs with the @samp{-debug-init} command-line option. This
1270 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1271 file, and places you in the debugger if something goes wrong. The top
1272 line in the @file{trace-back} buffer will be the error message, and the
1273 second or third line of that buffer will display the Lisp code from your
1274 @file{.emacs} file that caused the problem.
1276 You can also evaluate an individual function or argument to a function
1277 in your @file{.emacs} file by moving the cursor to the end of the
1278 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1281 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1282 variables which you are trying to set or use.
1284 @node Displaying the current line or column
1285 @section How do I make Emacs display the current line (or column) number?
1286 @cindex @code{line-number-mode}
1287 @cindex Displaying the current line or column
1288 @cindex Line number, displaying the current
1289 @cindex Column, displaying the current
1290 @cindex @code{mode-line-format}
1292 To have Emacs automatically display the current line number of the point
1293 in the mode line, do @kbd{M-x line-number-mode}. You can also put the
1297 (setq line-number-mode t)
1301 in your @file{.emacs} file to achieve this whenever you start Emacs.
1302 (Line number display is on by default, unless your site-specific
1303 initialization disables it.) Note that Emacs will not display the line
1304 number if the buffer's size in bytes is larger than the value of the
1305 variable @code{line-number-display-limit}.
1307 You can similarly display the current column with
1308 @kbd{M-x column-number-mode}, or by putting the form
1311 (setq column-number-mode t)
1315 in your @file{.emacs} file.
1317 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1318 will insert the current column's value into the mode line. See the
1319 documentation for @code{mode-line-format} (using @kbd{C-h v
1320 mode-line-format @key{RET}}) for more information on how to set and use
1323 Users of all Emacs versions can display the current column using the
1324 @samp{column} package written by @email{abraham@@dina.kvl.dk, Per
1325 Abrahamsen}. @xref{Packages that do not come with Emacs}, for
1326 instructions on how to get it.
1328 @cindex Set number capability in @code{vi} emulators
1329 None of the @code{vi} emulation modes provide the ``set number''
1330 capability of @code{vi} (as far as we know). The @samp{setnu} package
1331 written by @email{kyle@@wonderworks.com, Kyle Jones} provides this
1332 feature. So too does @samp{wb-line-number}, written by
1333 @email{naoki.y.nakamura@@nifty.com, Naoki Nakamura}.
1335 @node Displaying the current file name in the titlebar
1336 @section How can I modify the titlebar to contain the current file name?
1337 @cindex Titlebar, displaying the current file name in
1338 @cindex File name, displaying in the titlebar
1339 @cindex @code{frame-title-format}
1341 The contents of an Emacs frame's titlebar is controlled by the variable
1342 @code{frame-title-format}, which has the same structure as the variable
1343 @code{mode-line-format}. (Use @kbd{C-h v} or @kbd{M-x
1344 describe-variable} to get information about one or both of these
1347 By default, the titlebar for a frame does contain the name of the buffer
1348 currently being visited, except if there is a single frame. In such a
1349 case, the titlebar contains Emacs invocation name and the name of the
1350 machine at which Emacs was invoked. This is done by setting
1351 @code{frame-title-format} to the default value of
1354 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1357 To modify the behavior such that frame titlebars contain the buffer's
1358 name regardless of the number of existing frames, include the following
1359 in your @file{.emacs}:
1362 (setq frame-title-format "%b")
1365 @node Turning on abbrevs by default
1366 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1367 @cindex Abbrevs, turning on by default
1369 Put this in your @file{.emacs} file:
1373 (quietly-read-abbrev-file)
1376 (add-hook '@var{mymode}-mode-hook
1378 (setq abbrev-mode t)))
1381 Starting with Emacs 22, the standard abbrevs file is read automatically
1382 at startup, so the first of these two forms becomes unnecessary.
1384 @node Associating modes with files
1385 @section How do I make Emacs use a certain major mode for certain files?
1386 @cindex Associating modes with files
1387 @cindex File extensions and modes
1388 @cindex @code{auto-mode-alist}, modifying
1389 @cindex Modes, associating with file extensions
1391 If you want to use a certain mode @var{foo} for all files whose names end
1392 with the extension @file{.@var{bar}}, this will do it for you:
1395 (setq auto-mode-alist (cons '("\\.@var{bar}\\'" . @var{foo}-mode) auto-mode-alist))
1398 Otherwise put this somewhere in the first line of any file you want to
1399 edit in the mode @var{foo} (in the second line, if the first line begins
1406 @cindex Major mode for shell scripts
1407 Beginning with Emacs 19, the variable @code{interpreter-mode-alist}
1408 specifies which mode to use when loading a shell script. (Emacs
1409 determines which interpreter you're using by examining the first line of
1410 the script.) Use @kbd{C-h v} (or @kbd{M-x describe-variable})
1411 on @code{interpreter-mode-alist} to learn more.
1413 @node Highlighting a region
1414 @section How can I highlight a region of text in Emacs?
1415 @cindex Highlighting text
1416 @cindex Text, highlighting
1417 @cindex @code{transient-mark-mode}
1418 @cindex Region, highlighting a
1420 You can cause the region to be highlighted when the mark is active by
1424 (transient-mark-mode t)
1428 in your @file{.emacs} file.
1430 @node Replacing highlighted text
1431 @section How can I replace highlighted text with what I type?
1432 @cindex @code{delete-selection-mode}
1433 @cindex Replacing highlighted text
1434 @cindex Highlighting and replacing text
1436 Use @code{delete-selection-mode}, which you can start automatically by
1437 placing the following Lisp form in your @file{.emacs} file:
1440 (delete-selection-mode 1)
1443 According to the documentation string for @code{delete-selection-mode}
1444 (which you can read using @kbd{M-x describe-function @key{RET}
1445 delete-selection-mode @key{RET}}):
1448 When ON, typed text replaces the selection if the selection is active.
1449 When OFF, typed text is just inserted at point.
1452 This mode also allows you to delete (not kill) the highlighted region by
1455 @node Controlling case sensitivity
1456 @section How do I control Emacs's case-sensitivity when searching/replacing?
1457 @cindex @code{case-fold-search}
1458 @cindex Case sensitivity of searches
1459 @cindex Searching without case sensitivity
1460 @cindex Ignoring case in searches
1462 For searching, the value of the variable @code{case-fold-search}
1463 determines whether they are case sensitive:
1466 (setq case-fold-search nil) ; make searches case sensitive
1467 (setq case-fold-search t) ; make searches case insensitive
1470 @cindex Case sensitivity in replacements
1471 @cindex Replacing, and case sensitivity
1472 @cindex @code{case-replace}
1473 Similarly, for replacing, the variable @code{case-replace} determines
1474 whether replacements preserve case.
1476 You can also toggle case sensitivity at will in isearch with @kbd{M-c}.
1478 To change the case sensitivity just for one major mode, use the major
1479 mode's hook. For example:
1482 (add-hook '@var{foo}-mode-hook
1484 (setq case-fold-search nil)))
1487 @node Working with unprintable characters
1488 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1489 @cindex Unprintable characters, working with
1490 @cindex Working with unprintable characters
1491 @cindex Control characters, working with
1492 @cindex Eight-bit characters, working with
1493 @cindex Searching for unprintable characters
1494 @cindex Regexps and unprintable characters
1496 To search for a single character that appears in the buffer as, for
1497 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}. (This assumes
1498 the value of @code{search-quote-char} is 17 (i.e., @kbd{C-q}).)
1499 Searching for @strong{all} unprintable characters is best done with a
1500 regular expression (@dfn{regexp}) search. The easiest regexp to use for
1501 the unprintable chars is the complement of the regexp for the printable
1507 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1510 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1514 To type these special characters in an interactive argument to
1515 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1516 use @kbd{C-q}. (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1517 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.) So,
1518 to search for unprintable characters using @code{re-search-forward}:
1520 @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}}
1522 Using @code{isearch-forward-regexp}:
1524 @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1526 To delete all unprintable characters, simply use replace-regexp:
1528 @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}}
1530 Replacing is similar to the above. To replace all unprintable
1531 characters with a colon, use:
1533 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}
1535 @node Searching for/replacing newlines
1536 @section How do I input a newline character in isearch or query-replace?
1537 @cindex Searching for newlines
1538 @cindex Replacing newlines
1540 Use @kbd{C-q C-j}. For more information, see @inforef{Special Isearch,
1541 Special Input for Incremental Search, emacs}.
1544 @node Yanking text in isearch
1545 @section How do I copy text from the kill ring into the search string?
1546 @cindex Yanking text into the search string
1547 @cindex isearch yanking
1549 Use @kbd{M-y}. @inforef{Isearch Yank, Isearch Yanking, emacs}.
1551 @node Wrapping words automatically
1552 @section How do I make Emacs wrap words for me?
1553 @cindex Wrapping word automatically
1554 @cindex Wrapping lines
1556 @cindex @code{auto-fill-mode}, introduction to
1557 @cindex Maximum line width, default value
1558 @cindex @code{fill-column}, default value
1560 Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}.
1561 The default maximum line width is 70, determined by the variable
1562 @code{fill-column}. To learn how to turn this on automatically, see
1563 @ref{Turning on auto-fill by default}.
1565 @node Turning on auto-fill by default
1566 @section How do I turn on @code{auto-fill-mode} by default?
1567 @cindex @code{auto-fill-mode}, activating automatically
1568 @cindex Filling automatically
1569 @cindex Automatic entry to @code{auto-fill-mode}
1571 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1574 To turn it on for every buffer in a certain mode, you must use the hook
1575 for that mode. For example, to turn on @code{auto-fill} mode for all
1576 text buffers, including the following in your @file{.emacs} file:
1579 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1582 If you want @code{auto-fill} mode on in all major modes, do this:
1585 (setq-default auto-fill-function 'do-auto-fill)
1588 @node Changing load-path
1589 @section How do I change @code{load-path}?
1590 @cindex @code{load-path}, modifying
1591 @cindex Modifying @code{load-path}
1592 @cindex Adding to @code{load-path}
1594 In general, you should only add to the @code{load-path}. You can add
1595 directory @var{/dir/subdir} to the load path like this:
1598 (setq load-path (cons "/dir/subdir/" load-path))
1601 To do this relative to your home directory:
1604 (setq load-path (cons "~/mysubdir/" load-path))
1607 @node Using an already running Emacs process
1608 @section How do I use an already running Emacs from another window?
1609 @cindex @code{emacsclient}
1610 @cindex Emacs server functions
1611 @cindex Using an existing Emacs process
1613 @code{emacsclient}, which comes with Emacs, is for editing a file using
1614 an already running Emacs rather than starting up a new Emacs. It does
1615 this by sending a request to the already running Emacs, which must be
1616 expecting the request.
1623 Emacs must have executed the @code{server-start} function for
1624 @samp{emacsclient} to work. This can be done either by a command line
1628 emacs -f server-start
1631 or by invoking @code{server-start} from @file{.emacs}:
1634 (if (@var{some conditions are met}) (server-start))
1637 When this is done, Emacs creates a Unix domain socket named
1638 @file{server} in @file{/tmp/emacs@var{userid}}. See
1639 @code{server-socket-dir}.
1641 To get your news reader, mail reader, etc., to invoke
1642 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1643 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}. You may
1644 have to specify the full pathname of the @samp{emacsclient} program
1649 setenv EDITOR emacsclient
1651 # using full pathname
1652 setenv EDITOR /usr/local/emacs/etc/emacsclient
1655 EDITOR=emacsclient ; export EDITOR
1661 When @samp{emacsclient} is run, it connects to the socket and passes its
1662 command line options to Emacs, which at the next opportunity will visit
1663 the files specified. (Line numbers can be specified just like with
1664 Emacs.) The user will have to switch to the Emacs window by hand. When
1665 the user is done editing a file, the user can type @kbd{C-x #} (or
1666 @kbd{M-x server-edit}) to indicate this. If there is another buffer
1667 requested by @code{emacsclient}, Emacs will switch to it; otherwise
1668 @code{emacsclient} will exit, signaling the calling program to continue.
1670 @cindex @code{gnuserv}
1671 There is an enhanced version of @samp{emacsclient} called
1672 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman}
1673 (@pxref{Packages that do not come with Emacs}). @samp{gnuserv} uses
1674 Internet domain sockets, so it can work across most network connections.
1676 The most recent @samp{gnuserv} package is available at
1678 @uref{http://meltin.net/hacks/emacs/}
1682 @node Compiler error messages
1683 @section How do I make Emacs recognize my compiler's funny error messages?
1684 @cindex Compiler error messages, recognizing
1685 @cindex Recognizing non-standard compiler errors
1686 @cindex Regexps for recognizing compiler errors
1687 @cindex Errors, recognizing compiler
1689 Customize the @code{compilation-error-regexp-alist} variable.
1691 @node Indenting switch statements
1692 @section How do I change the indentation for @code{switch}?
1693 @cindex @code{switch}, indenting
1694 @cindex Indenting of @code{switch}
1696 Many people want to indent their @code{switch} statements like this:
1714 The solution at first appears to be: set @code{c-indent-level} to 4 and
1715 @code{c-label-offset} to -2. However, this will give you an indentation
1716 spacing of four instead of two.
1718 The @emph{real} solution is to use @code{cc-mode} (the default mode for
1719 C programming in Emacs 20 and later) and add the following line to your
1723 (c-set-offset 'case-label '+)
1726 There appears to be no way to do this with the old @code{c-mode}.
1728 @node Customizing C and C++ indentation
1729 @section How to customize indentation in C, C@t{++}, and Java buffers?
1730 @cindex Indentation, how to customize
1731 @cindex Customize indentation
1733 The Emacs @code{cc-mode} features an interactive procedure for
1734 customizing the indentation style, which is fully explained in the
1735 @cite{CC Mode} manual that is part of the Emacs distribution, see
1736 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1737 The CC Mode Manual}. Here's a short summary of the procedure:
1741 Go to the beginning of the first line where you don't like the
1742 indentation and type @kbd{C-c C-o}. Emacs will prompt you for the
1743 syntactic symbol; type @key{RET} to accept the default it suggests.
1746 Emacs now prompts for the offset of this syntactic symbol, showing the
1747 default (the current definition) inside parentheses. You can choose
1752 No extra indentation.
1754 Indent one basic offset.
1756 Outdent one basic offset.
1758 Indent two basic offsets
1760 Outdent two basic offsets.
1762 Indent half basic offset.
1764 Outdent half basic offset.
1768 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1769 the line or the block according to what you just specified.
1772 If you don't like the result, go back to step 1. Otherwise, add the
1773 following line to your @file{.emacs}:
1776 (c-set-offset '@var{syntactic-symbol} @var{offset})
1780 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1781 when you type @kbd{C-c C-o} at the beginning of the line, and
1782 @var{offset} is one of the indentation symbols listed above (@code{+},
1783 @code{/}, @code{0}, etc.) that you've chosen during the interactive
1787 Go to the next line whose indentation is not to your liking and repeat
1791 It is recommended to put all the resulting @code{(c-set-offset ...)}
1792 customizations inside a C mode hook, like this:
1795 (defun my-c-mode-hook ()
1798 (add-hook 'c-mode-hook 'my-c-mode-hook)
1802 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1803 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1804 might be unavailable when @code{cc-mode} is not loaded.
1806 Note that @code{c-mode-hook} runs for C source files only; use
1807 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1808 Java sources, etc. If you want the same customizations to be in
1809 effect in @emph{all} languages supported by @code{cc-mode}, use
1810 @code{c-mode-common-hook}.
1812 @node Horizontal scrolling
1813 @section How can I make Emacs automatically scroll horizontally?
1814 @cindex @code{hscroll-mode}
1815 @cindex Horizontal scrolling
1816 @cindex Scrolling horizontally
1818 In Emacs 21 and later, this is on by default: if the variable
1819 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1820 automatically scrolls the display horizontally when point moves off the
1821 left or right edge of the window.
1823 Note that this is overridden by the variable
1824 @code{truncate-partial-width-windows} if that variable is non-nil
1825 and the current buffer is not full-frame width.
1827 In Emacs 20, use the @code{hscroll-mode}. Here is some information from
1828 the documentation, available by typing @kbd{C-h f hscroll-mode @key{RET}}:
1830 Automatically scroll horizontally when the point moves off the
1831 left or right edge of the window.
1835 Type @kbd{M-x hscroll-mode} to enable it in the current buffer.
1838 Type @kbd{M-x hscroll-global-mode} to enable it in every buffer.
1841 @code{turn-on-hscroll} is useful in mode hooks as in:
1844 (add-hook 'text-mode-hook 'turn-on-hscroll)
1848 @code{hscroll-margin} controls how close the cursor can get to the
1852 @code{hscroll-step-percent} controls how far to jump once we decide to do so.
1855 @node Overwrite mode
1856 @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting?
1857 @cindex @key{Insert}
1858 @cindex @code{overwrite-mode}
1859 @cindex Overwriting existing text
1860 @cindex Toggling @code{overwrite-mode}
1862 @kbd{M-x overwrite-mode} (a minor mode). This toggles
1863 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1864 is as easy as another @kbd{M-x overwrite-mode}.
1866 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1868 @node Turning off beeping
1869 @section How do I stop Emacs from beeping on a terminal?
1870 @cindex Beeping, turning off
1871 @cindex Visible bell
1872 @cindex Bell, visible
1874 @email{martin@@cc.gatech.edu, Martin R. Frank} writes:
1876 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1877 and set the visible bell to nothing.
1879 That is, put the following in your @code{TERMCAP} environment variable
1880 (assuming you have one):
1886 And evaluate the following Lisp form:
1889 (setq visible-bell t)
1892 @node Turning the volume down
1893 @section How do I turn down the bell volume in Emacs running under X?
1894 @cindex Bell, volume of
1895 @cindex Volume of bell
1897 On X Window system, you can adjust the bell volume and duration for all
1898 programs with the shell command @code{xset}.
1900 Invoking @code{xset} without any arguments produces some basic
1901 information, including the following:
1904 usage: xset [-display host:dpy] option ...
1907 To set bell volume, pitch and duration:
1908 b [vol [pitch [dur]]] b on
1911 @node Automatic indentation
1912 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
1913 @cindex Indenting new lines
1914 @cindex New lines, indenting of
1915 @cindex Previous line, indenting according to
1916 @cindex Text indentation
1918 Such behavior is automatic in Emacs 20 and later. From the
1919 @file{etc/NEWS} file for Emacs 20.2:
1922 ** In Text mode, now only blank lines separate paragraphs. This makes
1923 it possible to get the full benefit of Adaptive Fill mode in Text mode,
1924 and other modes derived from it (such as Mail mode). @key{TAB} in Text
1925 mode now runs the command @code{indent-relative}; this makes a practical
1926 difference only when you use indented paragraphs.
1928 As a result, the old Indented Text mode is now identical to Text mode,
1929 and is an alias for it.
1931 If you want spaces at the beginning of a line to start a paragraph, use
1932 the new mode, Paragraph Indent Text mode.
1935 @cindex Prefixing lines
1937 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
1938 by default}), you can tell Emacs to prefix every line with a certain
1939 character sequence, the @dfn{fill prefix}. Type the prefix at the
1940 beginning of a line, position point after it, and then type @kbd{C-x .}
1941 (@code{set-fill-prefix}) to set the fill prefix. Thereafter,
1942 auto-filling will automatically put the fill prefix at the beginning of
1943 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
1944 prefix when refilling the paragraph.
1946 If you have paragraphs with different levels of indentation, you will
1947 have to set the fill prefix to the correct value each time you move to a
1948 new paragraph. There are many packages available to deal with this
1949 (@pxref{Packages that do not come with Emacs}). Look for ``fill'' and
1950 ``indent'' keywords for guidance.
1952 @node Matching parentheses
1953 @section How do I show which parenthesis matches the one I'm looking at?
1954 @cindex Parentheses, matching
1955 @cindex @file{paren.el}
1956 @cindex Highlighting matching parentheses
1957 @cindex Pairs of parentheses, highlighting
1958 @cindex Matching parentheses
1960 Call @code{show-paren-mode} in your @file{.emacs} file:
1966 You can also enable this mode by selecting the @samp{Paren Match
1967 Highlighting} option from the @samp{Options} menu of the Emacs menu bar
1968 at the top of any Emacs frame.
1970 Alternatives to this mode include:
1975 If you're looking at a right parenthesis (or brace or bracket) you can
1976 delete it and reinsert it. Emacs will momentarily move the cursor to
1977 the matching parenthesis.
1980 @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp})
1981 will skip over one set of balanced parentheses, so you can see which
1982 parentheses match. (You can train it to skip over balanced brackets
1983 and braces at the same time by modifying the syntax table.)
1985 @cindex Show matching paren as in @code{vi}
1987 Here is some Emacs Lisp that will make the @key{%} key show the matching
1988 parenthesis, like in @code{vi}. In addition, if the cursor isn't over a
1989 parenthesis, it simply inserts a % like normal.
1992 ;; By an unknown contributor
1994 (global-set-key "%" 'match-paren)
1996 (defun match-paren (arg)
1997 "Go to the matching paren if on a paren; otherwise insert %."
1999 (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2000 ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2001 (t (self-insert-command (or arg 1)))))
2006 @node Hiding #ifdef lines
2007 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2008 @cindex @code{#ifdef}, selective display of
2009 @cindex @code{hide-ifdef-mode}
2010 @cindex Hiding @code{#ifdef} text
2011 @cindex Selectively displaying @code{#ifdef} code
2013 @kbd{M-x hide-ifdef-mode}. (This is a minor mode.) You might also want
2014 to investigate @file{cpp.el}, which is distributed with Emacs.
2016 @node Repeating commands
2017 @section How do I repeat a command as many times as possible?
2018 @cindex Repeating commands many times
2019 @cindex Commands, repeating many times
2020 @cindex @code{.}, equivalent to @code{vi} command
2022 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2023 that repeats the last command. If you preface it with a prefix
2024 argument, the prefix arg is applied to the command.
2026 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2027 (@code{repeat-complex-command}) to reinvoke commands that used the
2028 minibuffer to get arguments. In @code{repeat-complex-command} you can
2029 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2030 keyboard has these keys) to scan through all the different complex
2031 commands you've typed.
2033 To repeat a set of commands, use keyboard macros. Use @kbd{C-x (} and
2034 @kbd{C-x )} to make a keyboard macro that invokes the command and then
2035 type @kbd{C-x e}. (@inforef{Keyboard Macros, Keyboard Macros, emacs}.)
2037 If you're really desperate for the @code{.} command in @code{vi} that
2038 redoes the last insertion/deletion, use VIPER, a @code{vi} emulation
2039 mode which comes with Emacs, and which appears to support it.
2041 @node Valid X resources
2042 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2043 @cindex Resources, X
2045 @cindex Setting X resources
2047 @inforef{X Resources, X Resources, emacs}.
2049 You can also use a resource editor, such as editres (for X11R5 and
2050 onwards), to look at the resource names for the menu bar, assuming Emacs
2051 was compiled with the X toolkit.
2053 @node Evaluating Emacs Lisp code
2054 @section How do I execute (``evaluate'') a piece of Emacs Lisp code?
2055 @cindex Evaluating Lisp code
2056 @cindex Lisp forms, evaluating
2058 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2059 Emacs Lisp @dfn{form}:
2064 If you want it evaluated every time you run Emacs, put it in a file
2065 named @file{.emacs} in your home directory. This is known as ``your
2066 @file{.emacs} file,'' and contains all of your personal customizations.
2069 You can type the form in the @file{*scratch*} buffer, and then type
2070 @key{LFD} (or @kbd{C-j}) after it. The result of evaluating the form
2071 will be inserted in the buffer.
2074 In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form
2075 before or around point.
2078 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2079 before point and prints its value in the echo area.
2082 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2083 form in the minibuffer which will be evaluated once you press @key{RET}.
2086 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2087 forms in a file. (To do this from Lisp use the function @code{load}
2090 The functions @code{load-library}, @code{eval-region},
2091 @code{eval-buffer}, @code{require}, and @code{autoload} are also
2092 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2097 @node Changing the length of a Tab
2098 @section How do I change Emacs's idea of the @key{TAB} character's length?
2100 @cindex Length of tab character
2101 @cindex @code{default-tab-width}
2103 Set the variable @code{default-tab-width}. For example, to set
2104 @key{TAB} stops every 10 characters, insert the following in your
2108 (setq default-tab-width 10)
2111 Do not confuse variable @code{tab-width} with variable
2112 @code{tab-stop-list}. The former is used for the display of literal
2113 @key{TAB} characters. The latter controls what characters are inserted
2114 when you press the @key{TAB} character in certain modes.
2116 @node Inserting text at the beginning of each line
2117 @section How do I insert <some text> at the beginning of every line?
2118 @cindex Prefixing a region with some text
2119 @cindex Prefix character, inserting in mail/news replies
2120 @cindex Replies to mail/news, inserting a prefix character
2121 @cindex @code{mail-yank-prefix}
2122 @cindex Mail replies, inserting a prefix character
2123 @cindex News replies, inserting a prefix character
2125 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2126 @key{RET} ^ @key{RET} your text @key{RET}}.
2128 To do this to a region, use @code{string-insert-rectangle}.
2129 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2130 want to prefix, move the cursor to last line to be prefixed, and type
2131 @kbd{M-x string-insert-rectangle @key{RET}}. To do this for the whole
2132 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2134 If you are trying to prefix a yanked mail message with @samp{>}, you
2135 might want to set the variable @code{mail-yank-prefix}. In Message
2136 buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;}
2137 runs the function @code{comment-region}, it is a general-purpose
2138 mechanism to comment regions) (@pxref{Changing the included text prefix}).
2140 @node Underlining paragraphs
2141 @section How do I insert @samp{_^H} before each character in a region to get an underlined paragraph?
2142 @cindex Underlining a region of text
2143 @cindex @code{underline-region}
2145 Mark the region and then type @kbd{M-x underline-region @key{RET}}.
2147 @node Forcing the cursor to remain in the same column
2148 @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?
2149 @cindex @code{picture-mode}
2150 @cindex Remaining in the same column, regardless of contents
2151 @cindex Vertical movement in empty documents
2153 Use @kbd{M-x picture-mode}.
2155 See also the variable @code{track-eol} and the command
2156 @code{set-goal-column} bound to @kbd{C-x C-n}
2157 (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}).
2159 @node Forcing Emacs to iconify itself
2160 @section How do I tell Emacs to iconify itself?
2161 @cindex Iconification under the X Window System
2162 @cindex X Window System and iconification
2163 @cindex Suspending Emacs
2165 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2166 otherwise. @inforef{Frame Commands, Frame Commands, emacs}.
2168 @node Using regular expressions
2169 @section How do I use regexps (regular expressions) in Emacs?
2171 @cindex Regular expressions
2172 @cindex Differences between Unix and Emacs regexps
2173 @cindex Unix regexps, differences from Emacs
2174 @cindex Text strings, putting regexps in
2176 @inforef{Regexp Backslash, Regexp Backslash, emacs}.
2178 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2179 are @samp{\(} and @samp{\)}. Also, the string syntax for a backslash is
2180 @samp{\\}. To specify a regular expression like @samp{xxx\(foo\|bar\)}
2181 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2183 Note the doubled backslashes!
2188 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2189 (@samp{[^...]}) can match a newline character (@key{LFD} a.k.a.@:
2190 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2191 characters not to match.
2194 The character syntax regexps (e.g., @samp{\sw}) are not
2195 meaningful inside character set regexps (e.g., @samp{[aeiou]}). (This
2196 is actually typical for regexp syntax.)
2200 @node Replacing text across multiple files
2201 @section How do I perform a replace operation across more than one file?
2202 @cindex Replacing strings across files
2203 @cindex Multiple files, replacing across
2204 @cindex Files, replacing strings across multiple
2205 @cindex Recursive search/replace operations
2207 As of Emacs 19.29, Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x
2208 d}) supports the command @code{dired-do-query-replace} (@kbd{Q}), which
2209 allows users to replace regular expressions in multiple files.
2211 You can use this command to perform search/replace operations on
2212 multiple files by following the following steps:
2216 Assemble a list of files you want to operate on with either
2217 @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}.
2220 Mark all files in the resulting Dired buffer using @kbd{t}.
2223 Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked
2227 To accept all replacements in each file, hit @kbd{!}.
2230 Another way to do the same thing is to use the ``tags'' feature of
2231 Emacs: it includes the command @code{tags-query-replace} which performs
2232 a query-replace across all the files mentioned in the @file{TAGS} file.
2233 @inforef{Tags Search, Tags Search, emacs}.
2235 @node Documentation for etags
2236 @section Where is the documentation for @code{etags}?
2237 @cindex Documentation for @code{etags}
2238 @cindex @code{etags}, documentation for
2240 The @code{etags} man page should be in the same place as the
2241 @code{emacs} man page.
2243 Quick command-line switch descriptions are also available. For example,
2246 @node Disabling backups
2247 @section How do I disable backup files?
2248 @cindex Backups, disabling
2249 @cindex Disabling backups
2251 You probably don't want to do this, since backups are useful, especially
2252 when something goes wrong.
2254 To avoid seeing backup files (and other ``uninteresting'' files) in Dired,
2255 load @code{dired-x} by adding the following to your @file{.emacs} file:
2258 (add-hook 'dired-load-hook
2263 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2264 You can make omitting the default for new dired buffers by putting the
2265 following in your @file{.emacs}:
2268 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2271 If you're tired of seeing backup files whenever you do an @samp{ls} at
2272 the Unix shell, try GNU @code{ls} with the @samp{-B} option. GNU
2273 @code{ls} is part of the GNU Fileutils package, available from
2274 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2276 To disable or change the way backups are made, @inforef{Backup Names, ,
2279 @cindex Backup files in a single directory
2280 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2281 by customizing the variable @code{backup-directory-alist}. This
2282 variable's value specifies that files whose names match specific patters
2283 should have their backups put in certain directories. A typical use is
2284 to add the element @code{("." . @var{dir})} to force Emacs to put
2285 @strong{all} backup files in the directory @file{dir}.
2287 @node Disabling auto-save-mode
2288 @section How do I disable @code{auto-save-mode}?
2289 @cindex Disabling @code{auto-save-mode}
2291 @cindex Saving at frequent intervals
2293 You probably don't want to do this, since auto-saving is useful,
2294 especially when Emacs or your computer crashes while you are editing a
2297 Instead, you might want to change the variable
2298 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2299 waits before auto-saving. Increasing this value forces Emacs to wait
2300 longer between auto-saves, which might annoy you less.
2302 You might also want to look into Sebastian Kremer's @code{auto-save}
2303 package (@pxref{Packages that do not come with Emacs}). This
2304 package also allows you to place all auto-save files in one directory,
2305 such as @file{/tmp}.
2307 To disable or change how @code{auto-save-mode} works, @inforef{Auto
2310 @node Going to a line by number
2311 @section How can I go to a certain line given its number?
2312 @cindex Going to a line by number
2313 @cindex Compilation error messages
2314 @cindex Recompilation
2316 Are you sure you indeed need to go to a line by its number? Perhaps all
2317 you want is to display a line in your source file for which a compiler
2318 printed an error message? If so, compiling from within Emacs using the
2319 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2320 effective way of doing that. Emacs automatically intercepts the compile
2321 error messages, inserts them into a special buffer called
2322 @code{*compilation*}, and lets you visit the locus of each message in
2323 the source. Type @kbd{C-x `} to step through the offending lines one by
2324 one (starting with Emacs 22, you can also use @kbd{M-g M-p} and
2325 @kbd{M-g M-n} to go to the previous and next matches directly). Click
2326 @kbd{Mouse-2} or press @key{RET} on a message text in the
2327 @code{*compilation*} buffer to go to the line whose number is mentioned
2330 But if you indeed need to go to a certain text line, type @kbd{M-g M-g}
2331 (which is the default binding of the @code{goto-line} function starting
2332 with Emacs 22). Emacs will prompt you for the number of the line and go
2335 You can do this faster by invoking @code{goto-line} with a numeric
2336 argument that is the line's number. For example, @kbd{C-u 286 M-g M-g}
2337 will jump to line number 286 in the current buffer.
2339 @node Modifying pull-down menus
2340 @section How can I create or modify new pull-down menu options?
2341 @cindex Pull-down menus, creating or modifying
2342 @cindex Menus, creating or modifying
2343 @cindex Creating new menu options
2344 @cindex Modifying pull-down menus
2345 @cindex Menus and keymaps
2346 @cindex Keymaps and menus
2348 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2349 represents a local or global keymap. Selecting a menu title with the
2350 mouse displays that keymap's non-@code{nil} contents in the form of a menu.
2352 So to add a menu option to an existing menu, all you have to do is add a
2353 new definition to the appropriate keymap. Adding a @samp{Forward Word}
2354 item to the @samp{Edit} menu thus requires the following Lisp code:
2357 (define-key global-map
2358 [menu-bar edit forward]
2359 '("Forward word" . forward-word))
2363 The first line adds the entry to the global keymap, which includes
2364 global menu bar entries. Replacing the reference to @code{global-map}
2365 with a local keymap would add this menu option only within a particular
2368 The second line describes the path from the menu-bar to the new entry.
2369 Placing this menu entry underneath the @samp{File} menu would mean
2370 changing the word @code{edit} in the second line to @code{file}.
2372 The third line is a cons cell whose first element is the title that will
2373 be displayed, and whose second element is the function that will be
2374 called when that menu option is invoked.
2376 To add a new menu, rather than a new option to an existing menu, we must
2377 define an entirely new keymap:
2380 (define-key global-map [menu-bar words]
2381 (cons "Words" (make-sparse-keymap "Words")))
2384 The above code creates a new sparse keymap, gives it the name
2385 @samp{Words}, and attaches it to the global menu bar. Adding the
2386 @samp{Forward Word} item to this new menu would thus require the
2390 (define-key global-map
2391 [menu-bar words forward]
2392 '("Forward word" . forward-word))
2396 Note that because of the way keymaps work, menu options are displayed
2397 with the more recently defined items at the top. Thus if you were to
2398 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2399 order), the menu option @samp{baz} would appear at the top, and
2400 @samp{foo} would be at the bottom.
2402 One way to avoid this problem is to use the function @code{define-key-after},
2403 which works the same as @code{define-key}, but lets you modify where items
2404 appear. The following Lisp code would insert the @samp{Forward Word}
2405 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2409 (lookup-key global-map [menu-bar edit])
2411 '("Forward word" . forward-word)
2415 Note how the second and third arguments to @code{define-key-after} are
2416 different from those of @code{define-key}, and that we have added a new
2417 (final) argument, the function after which our new key should be
2420 To move a menu option from one position to another, simply evaluate
2421 @code{define-key-after} with the appropriate final argument.
2423 More detailed information---and more examples of how to create and
2424 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2425 ``Menu Keymaps.'' (@xref{Emacs Lisp documentation}, for information on
2428 @node Deleting menus and menu options
2429 @section How do I delete menus and menu options?
2430 @cindex Deleting menus and menu options
2431 @cindex Menus, deleting
2433 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2434 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2438 (define-key global-map [menu-bar words] nil)
2441 Similarly, removing a menu option requires redefining a keymap entry to
2442 @code{nil}. For example, to delete the @samp{Forward word} menu option
2443 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2447 (define-key global-map [menu-bar edit forward] nil)
2450 @node Turning on syntax highlighting
2451 @section How do I turn on syntax highlighting?
2452 @cindex Syntax highlighting
2453 @cindex @code{font-lock-mode}
2454 @cindex Highlighting based on syntax
2455 @cindex Colorizing text
2456 @cindex FAQ, @code{font-lock-mode}
2458 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2459 highlighting in the current buffer. It is enabled by default in Emacs
2462 With @code{font-lock-mode} turned on, different types of text will
2463 appear in different colors. For instance, in a programming mode,
2464 variables will appear in one face, keywords in a second, and comments in
2467 To turn @code{font-lock-mode} off within an existing buffer, use
2468 @kbd{M-x font-lock-mode @key{RET}}.
2470 In Emacs 21 and earlier versions, you could use the following code in
2471 your @file{.emacs} file to turn on @code{font-lock-mode} globally:
2474 (global-font-lock-mode 1)
2477 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2478 and cause an annoying delay in display, so several features exist to
2481 @cindex Just-In-Time syntax highlighting
2482 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2483 activates the new @dfn{Just-In-Time fontification} provided by
2484 @code{jit-lock-mode}. @code{jit-lock-mode} defers the fontification of
2485 portions of buffer until you actually need to see them, and can also
2486 fontify while Emacs is idle. This makes display of the visible portion
2487 of a buffer almost instantaneous. For details about customizing
2488 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2490 @cindex Levels of syntax highlighting
2491 @cindex Decoration level, in @code{font-lock-mode}
2492 In versions of Emacs before 21, different levels of decoration are
2493 available, from slight to gaudy. More decoration means you need to wait
2494 more time for a buffer to be fontified (or a faster machine). To
2495 control how decorated your buffers should become, set the value of
2496 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2497 @code{nil} value indicating default (usually minimum) decoration, and a
2498 @code{t} value indicating the maximum decoration. For the gaudiest
2499 possible look, then, include the line
2502 (setq font-lock-maximum-decoration t)
2506 in your @file{.emacs} file. You can also set this variable such that
2507 different modes are highlighted in a different ways; for more
2508 information, see the documentation for
2509 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2510 describe-variable @key{RET}}).
2512 Also see the documentation for the function @code{font-lock-mode},
2513 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2514 describe-function @key{RET} font-lock-mode @key{RET}}).
2516 To print buffers with the faces (i.e., colors and fonts) intact, use
2517 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2518 ps-print-region-with-faces}. You will need a way to send text to a
2519 PostScript printer, or a PostScript interpreter such as Ghostscript;
2520 consult the documentation of the variables @code{ps-printer-name},
2521 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2523 @node Scrolling only one line
2524 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2525 @cindex Scrolling only one line
2526 @cindex Reducing the increment when scrolling
2528 Customize the @code{scroll-conservatively} variable with @kbd{M-x
2529 customize-variable @key{RET} scroll-conservatively @key{RET}} and set it
2530 to a large value like, say, 10000. For an explanation of what this
2531 means, @inforef{Auto Scrolling, Auto Scrolling, emacs}.
2533 Alternatively, use the following Lisp form in your @file{.emacs}:
2536 (setq scroll-conservatively most-positive-fixnum)
2539 @node Editing MS-DOS files
2540 @section How can I edit MS-DOS files using Emacs?
2541 @cindex Editing MS-DOS files
2542 @cindex MS-DOS files, editing
2543 @cindex Microsoft files, editing
2544 @cindex Windows files, editing
2546 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2547 performed transparently. You can open MS-DOS files on a Unix system,
2548 edit it, and save it without having to worry about the file format.
2550 When editing an MS-DOS style file, the mode line will indicate that it
2551 is a DOS file. On Unix and GNU/Linux systems, and also on a Macintosh,
2552 the string @samp{(DOS)} will appear near the left edge of the mode line;
2553 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2554 default, a backslash (@samp{\}) will appear in the mode line.
2556 If you are running a version of Emacs before 20.1, get @code{crypt++}
2557 (@pxref{Packages that do not come with Emacs}). Among other things,
2558 @code{crypt++} transparently modifies MS-DOS files as they are loaded
2559 and saved, allowing you to ignore the different conventions that Unix
2560 and MS-DOS have for delineating the end of a line.
2562 @node Filling paragraphs with a single space
2563 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2564 @cindex One space following periods
2565 @cindex Single space following periods
2566 @cindex Periods, one space following
2568 Add the following line to your @file{.emacs} file:
2571 (setq sentence-end-double-space nil)
2574 @node Escape sequences in shell output
2575 @section Why these strange escape sequences from @code{ls} from the Shell mode?
2576 @cindex Escape sequences in @code{ls} output
2577 @cindex @code{ls} in Shell mode
2579 This happens because @code{ls} is aliased to @samp{ls --color} in your
2580 shell init file. You have two alternatives to solve this:
2584 Make the alias conditioned on the @code{EMACS} variable in the
2585 environment. When Emacs runs a subsidiary shell, it exports the
2586 @code{EMACS} variable to that shell, with value equal to the absolute
2587 file name of Emacs. You can
2588 unalias @code{ls} when that happens, thus limiting the alias to your
2589 interactive sessions.
2592 Install the @code{ansi-color} package (bundled with Emacs 21.1 and
2593 later), which converts these ANSI escape sequences into colors.
2596 @node Fullscreen mode on MS-Windows
2597 @section How can I start Emacs in fullscreen mode on MS-Windows?
2598 @cindex Maximize frame
2599 @cindex Fullscreen mode
2601 Use the function @code{w32-send-sys-command}. For example, you can
2602 put the following in your @file{.emacs} file:
2605 (add-hook 'term-setup-hook
2606 #'(lambda () (w32-send-sys-command ?\xF030)))
2609 To avoid the slightly distracting visual effect of Emacs starting with
2610 its default frame size and then growing to fullscreen, you can add an
2611 @samp{Emacs.Geometry} entry to the Windows registry settings (see
2612 @pxref{(emacs)X Resources}).
2614 To compute the correct values for width and height, first maximize the
2615 Emacs frame and then evaluate @code{(frame-height)} and
2616 @code{(frame-width)} with @kbd{M-:}.
2618 @c ------------------------------------------------------------
2619 @node Bugs and problems
2620 @chapter Bugs and problems
2621 @cindex Bugs and problems
2623 The Emacs manual lists some common kinds of trouble users could get
2624 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2625 Emacs Manual}, so you might look there if the problem you encounter
2626 isn't described in this chapter. If you decide you've discovered a bug,
2627 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2628 instructions how to do that.
2630 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2631 known problems with building and using Emacs on specific platforms;
2632 type @kbd{C-h C-e} to read it.
2635 * Problems with very large files::
2636 * ^M in the shell buffer::
2637 * Shell process exits abnormally::
2638 * Problems with Shell Mode on MS-Windows::
2639 * Termcap/Terminfo entries for Emacs::
2640 * Spontaneous entry into isearch-mode::
2641 * Problems talking to certain hosts::
2642 * Errors with init files::
2643 * Emacs ignores X resources::
2644 * Emacs ignores frame parameters::
2645 * Emacs takes a long time to visit files::
2646 * Editing files with $ in the name::
2647 * Shell mode loses the current directory::
2648 * Security risks with Emacs::
2649 * Dired claims that no file is on this line::
2652 @node Problems with very large files
2653 @section Does Emacs have problems with files larger than 8 megabytes?
2654 @cindex Very large files, opening
2655 @cindex Large files, opening
2656 @cindex Opening very large files
2657 @cindex Maximum file size
2658 @cindex Files, maximum size
2660 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2661 files larger than 8 megabytes. In versions 19.29 and later, the maximum
2662 buffer size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes.
2663 And in Emacs 22, the maximum buffer size has been increased to
2664 268,435,455 bytes (or 256 MBytes) on 32-bit machines.
2666 @node ^M in the shell buffer
2667 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2668 @cindex Shell buffer, echoed commands and @samp{^M} in
2669 @cindex Echoed commands in @code{shell-mode}
2671 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2672 make them go away. If that doesn't work, you have several options:
2674 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2679 if ("$EMACS" =~ /*) then
2680 if ($?tcsh) unset edit
2686 Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2693 Alternatively, use @code{csh} in your shell buffers instead of
2694 @code{tcsh}. One way is:
2697 (setq explicit-shell-file-name "/bin/csh")
2701 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2705 setenv ESHELL /bin/csh
2709 (You must start Emacs over again with the environment variable properly
2710 set for this to take effect.)
2712 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2713 with the following Lisp form,
2716 (setenv "ESHELL" "/bin/csh")
2719 The above solutions try to prevent the shell from producing the
2720 @samp{^M} characters in the first place. If this is not possible
2721 (e.g., if you use a Windows shell), you can get Emacs to remove these
2722 characters from the buffer by adding this to your @file{.emacs} init
2726 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2729 On a related note: if your shell is echoing your input line in the shell
2730 buffer, you might want to customize the @code{comint-process-echoes}
2731 variable in your shell buffers, or try the following command in your
2732 shell start-up file:
2735 stty -icrnl -onlcr -echo susp ^Z
2738 @node Shell process exits abnormally
2739 @section Why do I get ``Process shell exited abnormally with code 1''?
2740 @cindex Abnormal exits from @code{shell-mode}
2741 @cindex @code{shell-mode} exits
2742 @cindex Process shell exited
2744 The most likely reason for this message is that the @samp{env} program
2745 is not properly installed. Compile this program for your architecture,
2746 and install it with @samp{a+x} permission in the architecture-dependent
2747 Emacs program directory. (You can find what this directory is at your
2748 site by inspecting the value of the variable @code{exec-directory} by
2749 typing @kbd{C-h v exec-directory @key{RET}}.)
2751 You should also check for other programs named @samp{env} in your path
2752 (e.g., SunOS has a program named @file{/usr/bin/env}). We don't
2753 understand why this can cause a failure and don't know a general
2754 solution for working around the problem in this case.
2756 The @samp{make clean} command will remove @samp{env} and other vital
2757 programs, so be careful when using it.
2759 It has been reported that this sometimes happened when Emacs was started
2760 as an X client from an xterm window (i.e., had a controlling tty) but the
2761 xterm was later terminated.
2763 See also @samp{PROBLEMS} (in the @file{etc} subdirectory of the
2764 top-level directory when you unpack the Emacs source) for other
2765 possible causes of this message.
2767 @node Problems with Shell Mode on MS-Windows
2768 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2770 @cindex Shell Mode, and MS-Windows
2771 @cindex @code{explicit-shell-file-name}
2772 On MS-Windows, this might happen because Emacs tries to look for the
2773 shell in a wrong place. The default file name @file{/bin/sh} is
2774 usually incorrect for non-Unix systems. If you know where your shell
2775 executable is, set the variable @code{explicit-shell-file-name} in
2776 your @file{.emacs} file to point to its full file name, like this:
2779 (setq explicit-shell-file-name "d:/shells/bash.exe")
2782 If you don't know what shell does Emacs use, try the @kbd{M-!}
2783 command; if that works, put the following line into your
2787 (setq explicit-shell-file-name shell-file-name)
2790 @cindex Antivirus programs, and Shell Mode
2791 Some people have trouble with Shell Mode because of intrusive
2792 antivirus software; disabling the resident antivirus program solves
2793 the problems in those cases.
2795 @node Termcap/Terminfo entries for Emacs
2796 @section Where is the termcap/terminfo entry for terminal type @samp{emacs}?
2799 @cindex Emacs entries for termcap/terminfo
2801 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2802 the @samp{TERMCAP} environment variable of subshells. It may help in
2803 certain situations (e.g., using rlogin from shell buffer) to add an
2804 entry for @samp{emacs} to the system-wide termcap file. Here is a
2805 correct termcap entry for @samp{emacs}:
2811 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2812 @code{captoinfo}. You need to generate
2813 @file{/usr/lib/terminfo/e/emacs}. It may work to simply copy
2814 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2816 Having a termcap/terminfo entry will not enable the use of full screen
2817 programs in shell buffers. Use @kbd{M-x terminal-emulator} for that
2820 A workaround to the problem of missing termcap/terminfo entries is to
2821 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2822 in your shell start up file. @code{csh} users could put this in their
2823 @file{.cshrc} files:
2826 if ("$term" == emacs) set term=dumb
2829 @node Spontaneous entry into isearch-mode
2830 @section Why does Emacs spontaneously start displaying @samp{I-search:} and beeping?
2831 @cindex Spontaneous entry into isearch-mode
2832 @cindex isearch-mode, spontaneous entry into
2833 @cindex Beeping without obvious reason
2835 Your terminal (or something between your terminal and the computer) is
2836 sending @kbd{C-s} and @kbd{C-q} for flow control, and Emacs is receiving
2837 these characters and interpreting them as commands. (The @kbd{C-s}
2838 character normally invokes the @code{isearch-forward} command.) For
2839 possible solutions, see @ref{Handling C-s and C-q with flow control}.
2841 @node Problems talking to certain hosts
2842 @section Why can't Emacs talk to certain hosts (or certain hostnames)?
2843 @cindex Hosts, Emacs cannot talk to
2844 @cindex @code{gethostbyname}, problematic version
2846 The problem may be that Emacs is linked with a wimpier version of
2847 @code{gethostbyname} than the rest of the programs on the machine. This
2848 is often manifested as a message on startup of ``X server not responding.
2849 Check your @samp{DISPLAY} environment variable.'' or a message of
2850 ``Unknown host'' from @code{open-network-stream}.
2852 On a Sun, this may be because Emacs had to be linked with the static C
2853 library. The version of @code{gethostbyname} in the static C library
2854 may only look in @file{/etc/hosts} and the NIS (YP) maps, while the
2855 version in the dynamic C library may be smart enough to check DNS in
2856 addition to or instead of NIS. On a Motorola Delta running System V
2857 R3.6, the version of @code{gethostbyname} in the standard library works,
2858 but the one that works with NIS doesn't (the one you get with -linet).
2859 Other operating systems have similar problems.
2866 Explicitly add the host you want to communicate with to @file{/etc/hosts}.
2869 Relink Emacs with this line in @file{src/config.h}:
2872 #define LIBS_SYSTEM -lresolv
2876 Replace @code{gethostbyname} and friends in @file{libc.a} with more
2877 useful versions such as the ones in @file{libresolv.a}. Then relink
2881 If you are actually running NIS, make sure that @code{ypbind} is
2882 properly told to do DNS lookups with the correct command line switch.
2886 @node Errors with init files
2887 @section Why does Emacs say @samp{Error in init file}?
2888 @cindex Error in @file{.emacs}
2889 @cindex Error in init file
2890 @cindex Init file, errors in
2891 @cindex @file{.emacs} file, errors in
2892 @cindex Debugging @file{.emacs} file
2894 An error occurred while loading either your @file{.emacs} file or the
2895 system-wide file @file{site-lisp/default.el}. Emacs 21.1 and later pops the
2896 @file{*Messages*} buffer, and puts there some additional information
2897 about the error, to provide some hints for debugging.
2899 For information on how to debug your @file{.emacs} file, see
2900 @ref{Debugging a customization file}.
2902 It may be the case that you need to load some package first, or use a
2903 hook that will be evaluated after the package is loaded. A common case
2904 of this is explained in @ref{Terminal setup code works after Emacs has
2907 @node Emacs ignores X resources
2908 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
2909 @cindex X resources being ignored
2910 @cindex Ignored X resources
2911 @cindex @file{.Xdefaults}
2913 As of version 19, Emacs searches for X resources in the files specified
2914 by the following environment variables:
2918 @item @code{XFILESEARCHPATH}
2919 @item @code{XUSERFILESEARCHPATH}
2920 @item @code{XAPPLRESDIR}
2924 This emulates the functionality provided by programs written using the
2927 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
2928 of file names separated by colons. @code{XAPPLRESDIR} should be a list
2929 of directory names separated by colons.
2931 Emacs searches for X resources:
2936 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
2939 then in the value of the @samp{XENVIRONMENT} environment variable,
2944 or if that is unset, in the file named
2945 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
2946 the name of the machine Emacs is running on),
2951 then in the screen-specific and server-wide resource properties provided
2957 or if those properties are unset, in the file named @file{~/.Xdefaults}
2963 then in the files listed in @samp{XUSERFILESEARCHPATH},
2968 or in files named @file{@var{lang}/Emacs} in directories listed in
2969 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
2970 environment variable), if the @samp{LANG} environment variable is set,
2972 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
2974 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
2977 or in @file{~/Emacs},
2982 then in the files listed in @code{XFILESEARCHPATH}.
2986 @node Emacs ignores frame parameters
2987 @section Why don't my customizations of the frame parameters work?
2988 @cindex Frame parameters
2990 This probably happens because you have set the frame parameters in the
2991 variable @code{initial-frame-alist}. That variable holds parameters
2992 used only for the first frame created when Emacs starts. To customize
2993 the parameters of all frames, change the variable
2994 @code{default-frame-alist} instead.
2996 These two variables exist because many users customize the initial frame
2997 in a special way. For example, you could determine the position and
2998 size of the initial frame, but would like to control the geometry of the
2999 other frames by individually positioning each one of them.
3002 @node Emacs takes a long time to visit files
3003 @section Why does Emacs take 20 seconds to visit a file?
3004 @cindex Visiting files takes a long time
3005 @cindex Delay when visiting files
3006 @cindex Files, take a long time to visit
3008 Old versions of Emacs (i.e., versions before Emacs 20.x) often
3009 encountered this when the master lock file, @file{!!!SuperLock!!!}, has
3010 been left in the lock directory somehow. Delete it.
3012 @email{meuer@@geom.umn.edu, Mark Meuer} says that NeXT NFS has a bug
3013 where an exclusive create succeeds but returns an error status. This
3014 can cause the same problem. Since Emacs's file locking doesn't work
3015 over NFS anyway, the best solution is to recompile Emacs with
3016 @code{CLASH_DETECTION} undefined.
3018 @node Editing files with $ in the name
3019 @section How do I edit a file with a @samp{$} in its name?
3020 @cindex Editing files with @samp{$} in the name
3021 @cindex @samp{$} in file names
3022 @cindex File names containing @samp{$}, editing
3024 When entering a file name in the minibuffer, Emacs will attempt to expand
3025 a @samp{$} followed by a word as an environment variable. To suppress
3026 this behavior, type @kbd{$$} instead.
3028 @node Shell mode loses the current directory
3029 @section Why does shell mode lose track of the shell's current directory?
3030 @cindex Current directory and @code{shell-mode}
3031 @cindex @code{shell-mode} and current directory
3032 @cindex Directory, current in @code{shell-mode}
3034 Emacs has no way of knowing when the shell actually changes its
3035 directory. This is an intrinsic limitation of Unix. So it tries to
3036 guess by recognizing @samp{cd} commands. If you type @kbd{cd} followed
3037 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
3038 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
3039 correctly guess the shell's new current directory. A huge variety of
3040 fixes and enhancements to shell mode for this problem have been written
3041 to handle this problem (@pxref{Finding a package with particular
3044 You can tell Emacs the shell's current directory with the command
3047 @node Security risks with Emacs
3048 @section Are there any security risks in Emacs?
3049 @cindex Security with Emacs
3050 @cindex @samp{movemail} and security
3051 @cindex @code{file-local-variable} and security
3052 @cindex Synthetic X events and security
3053 @cindex X events and security
3058 The @file{movemail} incident. (No, this is not a risk.)
3060 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3061 chapter 4. The site at LBL had installed the @file{/etc/movemail}
3062 program setuid root. (As of version 19, @file{movemail} is in your
3063 architecture-specific directory; type @kbd{C-h v exec-directory
3064 @key{RET}} to see what it is.) Since @code{movemail} had not been
3065 designed for this situation, a security hole was created and users could
3066 get root privileges.
3068 @code{movemail} has since been changed so that this security hole will
3069 not exist, even if it is installed setuid root. However,
3070 @code{movemail} no longer needs to be installed setuid root, which
3071 should eliminate this particular risk.
3073 We have heard unverified reports that the 1988 Internet worm took
3074 advantage of this configuration problem.
3077 The @code{file-local-variable} feature. (Yes, a risk, but easy to
3080 There is an Emacs feature that allows the setting of local values for
3081 variables when editing a file by including specially formatted text near
3082 the end of the file. This feature also includes the ability to have
3083 arbitrary Emacs Lisp code evaluated when the file is visited.
3084 Obviously, there is a potential for Trojan horses to exploit this
3087 As of Emacs 22, Emacs has a list of local variables that are known to
3088 be safe to set. If a file tries to set any variable outside this
3089 list, it asks the user to confirm whether the variables should be set.
3090 You can also tell Emacs whether to allow the evaluation of Emacs Lisp
3091 code found at the bottom of files by setting the variable
3092 @code{enable-local-eval}.
3094 For more information, @inforef{File Variables, File Variables, emacs}.
3097 Synthetic X events. (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3100 Emacs accepts synthetic X events generated by the @code{SendEvent}
3101 request as though they were regular events. As a result, if you are
3102 using the trivial host-based authentication, other users who can open X
3103 connections to your X workstation can make your Emacs process do
3104 anything, including run other processes with your privileges.
3106 The only fix for this is to prevent other users from being able to open
3107 X connections. The standard way to prevent this is to use a real
3108 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}. If using
3109 the @code{xauth} program has any effect, then you are probably using
3110 @samp{MIT-MAGIC-COOKIE-1}. Your site may be using a superior
3111 authentication method; ask your system administrator.
3113 If real authentication is not a possibility, you may be satisfied by
3114 just allowing hosts access for brief intervals while you start your X
3115 programs, then removing the access. This reduces the risk somewhat by
3116 narrowing the time window when hostile users would have access, but
3117 @emph{does not eliminate the risk}.
3119 On most computers running Unix and X, you enable and disable
3120 access using the @code{xhost} command. To allow all hosts access to
3128 at the shell prompt, which (on an HP machine, at least) produces the
3132 access control disabled, clients can connect from any host
3135 To deny all hosts access to your X server (except those explicitly
3136 allowed by name), use
3142 On the test HP computer, this command generated the following message:
3145 access control enabled, only authorized clients can connect
3150 @node Dired claims that no file is on this line
3151 @section Dired says, @samp{no file on this line} when I try to do something.
3152 @cindex Dired does not see a file
3154 @c FIXME: I think this is fixed in Emacs 21, but I didn't have time to
3156 Chances are you're using a localized version of Unix that doesn't use US
3157 date format in dired listings. You can check this by looking at dired
3158 listings or by typing @kbd{ls -l} to a shell and looking at the dates that
3161 Dired uses a regular expression to find the beginning of a file name.
3162 In a long Unix-style directory listing (@samp{ls -l}), the file name
3163 starts after the date. The regexp has thus been written to look for the
3164 date, the format of which can vary on non-US systems.
3166 There are two approaches to solving this. The first one involves
3167 setting things up so that @samp{ls -l} outputs US date format. This can
3168 be done by setting the locale. See your OS manual for more information.
3170 The second approach involves changing the regular expression used by
3171 dired, @code{directory-listing-before-filename-regexp}.
3173 @c ------------------------------------------------------------
3174 @node Compiling and installing Emacs
3175 @chapter Compiling and installing Emacs
3176 @cindex Compiling and installing Emacs
3179 * Installing Emacs::
3181 * Problems building Emacs::
3184 @node Installing Emacs
3185 @section How do I install Emacs?
3186 @cindex Installing Emacs
3187 @cindex Unix systems, installing Emacs on
3188 @cindex Downloading and installing Emacs
3189 @cindex Retrieving and installing Emacs
3190 @cindex Building Emacs from source
3191 @cindex Source code, building Emacs from
3192 @cindex Unpacking and installing Emacs
3194 This answer is meant for users of Unix and Unix-like systems. Users of
3195 other operating systems should see the series of questions beginning
3196 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3197 and binaries, and how to install Emacs on those systems.
3199 For Unix and Unix-like systems, the easiest way is often to compile it
3200 from scratch. You will need:
3205 Emacs sources. @xref{Current GNU distributions}, for a list of ftp sites
3206 that make them available. On @file{ftp.gnu.org}, the main GNU
3207 distribution site, sources are available as
3209 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-@value{VER}.tar.gz}
3211 The above will obviously change as new versions of Emacs come out. For
3212 instance, when Emacs 24.3 is released, it will most probably be
3215 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-24.3.tar.gz}
3217 Again, you should use one of the GNU mirror sites (see @ref{Current GNU
3218 distributions}, and adjust the URL accordingly) so as to reduce load on
3222 @code{gzip}, the GNU compression utility. You can get @code{gzip} via
3223 anonymous ftp at mirrors of @file{ftp.gnu.org} sites; it should compile
3224 and install without much trouble on most systems. Once you have
3225 retrieved the Emacs sources, you will probably be able to uncompress
3226 them with the command
3229 gunzip --verbose emacs-@value{VER}.tar.gz
3233 changing the Emacs version (@value{VER}), as necessary. Once
3234 @code{gunzip} has finished doing its job, a file by the name of
3235 @file{emacs-@value{VER}.tar} should be in your build directory.
3238 @code{tar}, the @dfn{tape archiving} program, which moves multiple files
3239 into and out of archive files, or @dfn{tarfiles}. All of the files
3240 comprising the Emacs source come in a single tarfile, and must be
3241 extracted using @code{tar} before you can build Emacs. Typically, the
3242 extraction command would look like
3245 tar -xvvf emacs-@value{VER}.tar
3249 The @samp{x} indicates that we want to extract files from this tarfile,
3250 the two @samp{v}s force verbose output, and the @samp{f} tells
3251 @code{tar} to use a disk file, rather than one on the tape drive.
3253 If you're using GNU @code{tar} (available at mirrors of
3254 @file{ftp.gnu.org}), you can combine this step and the previous one by
3258 tar -zxvvf emacs-@value{VER}.tar.gz
3262 The additional @samp{z} at the beginning of the options list tells GNU
3263 @code{tar} to uncompress the file with @code{gunzip} before extracting
3264 the tarfile's components.
3268 At this point, the Emacs sources (all 70+ megabytes of them) should be
3269 sitting in a directory called @file{emacs-@value{VER}}. On most common
3270 Unix and Unix-like systems, you should be able to compile Emacs (with X
3271 Window system support) with the following commands:
3274 cd emacs-@value{VER} # change directory to emacs-@value{VER}
3275 ./configure # configure Emacs for your particular system
3276 make # use Makefile to build components, then Emacs
3279 If the @code{make} completes successfully, the odds are fairly good that
3280 the build has gone well. (@xref{Problems building Emacs}, if you weren't
3283 By default, Emacs is installed in the following directories:
3286 @item /usr/local/bin
3289 @item /usr/local/share/emacs/@value{VER}
3290 Lisp code and support files.
3292 @item /usr/local/info
3296 To install files in those default directories, become the superuser and
3303 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3304 and any Emacs Info files that might be in @file{/usr/local/info}.
3306 Much more verbose instructions (with many more hints and suggestions)
3307 come with the Emacs sources, in the file @file{INSTALL}.
3309 @node Updating Emacs
3310 @section How do I update Emacs to the latest version?
3311 @cindex Updating Emacs
3313 @xref{Installing Emacs}, and follow the instructions there for
3316 Most files are placed in version-specific directories. Emacs
3317 @value{VER}, for instance, places files in
3318 @file{/usr/local/share/emacs/@value{VER}}.
3320 Upgrading should overwrite only, @file{/usr/local/bin/emacs} (the Emacs
3321 binary) and documentation in @file{/usr/local/info}. Back up these
3322 files before you upgrade, and you shouldn't have too much trouble.
3324 @node Problems building Emacs
3325 @section What should I do if I have trouble building Emacs?
3326 @cindex Problems building Emacs
3327 @cindex Errors when building Emacs
3329 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3330 source) to see if there is already a solution for your problem. Next,
3331 look for other questions in this FAQ that have to do with Emacs
3332 installation and compilation problems.
3334 If you'd like to have someone look at your problem and help solve it,
3335 see @ref{Help installing Emacs}.
3337 If you cannot find a solution in the documentation, send a message to
3338 @email{bug-gnu-emacs@@gnu.org}.
3340 Please don't post it to @uref{news:gnu.emacs.help} or send e-mail to
3341 @email{help-gnu-emacs@@gnu.org}. For further guidelines, see
3342 @ref{Guidelines for newsgroup postings} and @ref{Reporting bugs}.
3345 @c ------------------------------------------------------------
3346 @node Finding Emacs and related packages
3347 @chapter Finding Emacs and related packages
3348 @cindex Finding Emacs and related packages
3351 * Finding Emacs on the Internet::
3352 * Finding a package with particular functionality::
3353 * Packages that do not come with Emacs::
3354 * Current GNU distributions::
3355 * Difference between Emacs and XEmacs::
3356 * Emacs for minimalists::
3357 * Emacs for MS-DOS::
3358 * Emacs for Windows::
3359 * Emacs for GNUstep::
3360 * Emacs for Apple computers::
3363 @node Finding Emacs on the Internet
3364 @section Where can I get Emacs on the net (or by snail mail)?
3365 @cindex Finding Emacs on the Internet
3366 @cindex Snail mail, ordering Emacs via
3367 @cindex Postal service, ordering Emacs via
3368 @cindex Distribution, retrieving Emacs
3369 @cindex Internet, retrieving from
3371 Information on downloading Emacs is available at
3372 @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}.
3374 For an order form for all Emacs and FSF distributions deliverable from
3375 the USA, see @uref{http://shop.fsf.org/}.
3377 @xref{Installing Emacs}, for information on how to obtain and build the latest
3378 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3379 archive sites that make GNU software available.
3381 @node Finding a package with particular functionality
3382 @section How do I find a Emacs Lisp package that does XXX?
3383 @cindex Package, finding
3384 @cindex Finding an Emacs Lisp package
3385 @cindex Functionality, finding a particular package
3387 First of all, you should check to make sure that the package isn't
3388 already available. For example, typing @kbd{M-x apropos @key{RET}
3389 wordstar @key{RET}} lists all functions and variables containing the
3390 string @samp{wordstar}.
3392 It is also possible that the package is on your system, but has not been
3393 loaded. To see which packages are available for loading, look through
3394 your computer's lisp directory (@pxref{File-name conventions}). The Lisp
3395 source to most packages contains a short description of how they
3396 should be loaded, invoked, and configured---so before you use or
3397 modify a Lisp package, see if the author has provided any hints in the
3400 The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse
3401 the constituent Emacs packages.
3403 For advice on how to find extra packages that are not part of Emacs,
3404 see @ref{Packages that do not come with Emacs}.
3406 @node Packages that do not come with Emacs
3407 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3408 @cindex Unbundled packages
3409 @cindex Finding other packages
3410 @cindex Lisp packages that do not come with Emacs
3411 @cindex Packages, those that do not come with Emacs
3412 @cindex Emacs Lisp List
3413 @cindex Emacs Lisp Archive
3415 @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs Lisp
3416 List (ELL)}, maintained by @email{S.J.Eglen@@damtp.cam.ac.uk, Stephen Eglen},
3417 aims to provide one compact list with links to all of the current Emacs
3418 Lisp files on the Internet. The ELL can be browsed over the web, or
3419 from Emacs with @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.el,
3420 the @file{ell} package}.
3422 Many authors post their packages to the @uref{news:gnu.emacs.sources,
3423 Emacs sources newsgroup}. You can search the archives of this
3424 group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google},
3425 or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example.
3427 Several packages are stored in
3428 @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}.
3430 Read the file @file{etc/MORE.STUFF} for more information about
3433 @node Current GNU distributions
3434 @section Where can I get other up-to-date GNU stuff?
3435 @cindex Current GNU distributions
3436 @cindex Sources for current GNU distributions
3437 @cindex Stuff, current GNU
3438 @cindex Up-to-date GNU stuff
3439 @cindex Finding current GNU software
3440 @cindex Official GNU software sites
3442 The most up-to-date official GNU software is normally kept at
3444 @uref{ftp://ftp.gnu.org/pub/gnu}
3446 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3448 @uref{http://www.gnu.org/order/ftp.html}
3450 @node Difference between Emacs and XEmacs
3451 @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)?
3453 @cindex Difference Emacs and XEmacs
3457 XEmacs is a branch version of Emacs. It was first called Lucid Emacs,
3458 and was initially derived from a prerelease version of Emacs 19. In
3459 this FAQ, we use the name ``Emacs'' only for the official version.
3461 Emacs and XEmacs each come with Lisp packages that are lacking in the
3462 other. The two versions have some significant differences at the Lisp
3463 programming level. Their current features are roughly comparable,
3464 though the support for some operating systems, character sets and
3465 specific packages might be quite different.
3467 Some XEmacs code has been contributed to Emacs, and we would like to
3468 use other parts, but the earlier XEmacs maintainers did not always
3469 keep track of the authors of contributed code, which makes it
3470 impossible for the FSF to get copyright papers signed for that code.
3471 (The FSF requires these papers for all the code included in the Emacs
3472 release, aside from generic C support packages that retain their
3473 separate identity and are not integrated into the code of Emacs
3476 If you want to talk about these two versions and distinguish them,
3477 please call them ``Emacs'' and ``XEmacs.'' To contrast ``XEmacs''
3478 with ``GNU Emacs'' would be misleading, since XEmacs too has its
3479 origin in the work of the GNU Project. Terms such as ``Emacsen'' and
3480 ``(X)Emacs'' are not wrong, but they are not very clear, so it
3481 is better to write ``Emacs and XEmacs.''
3483 @node Emacs for minimalists
3484 @section I don't have enough disk space to install Emacs
3486 @cindex Not enough disk space to install Emacs
3488 GNU Zile is a lightweight Emacs clone. Zile is short for @samp{Zile Is
3489 Lossy Emacs}. It has all of Emacs's basic editing features. The Zile
3490 binary typically has a size of about 130 kbytes, so this can be useful
3491 if you are in an extremely space-restricted environment. More
3492 information is available from
3494 @uref{http://www.gnu.org/software/zile/}
3497 @node Emacs for MS-DOS
3498 @section Where can I get Emacs for my PC running MS-DOS?
3499 @cindex MS-DOS, Emacs for
3500 @cindex DOS, Emacs for
3501 @cindex Compiling Emacs for DOS
3502 @cindex Emacs for MS-DOS
3503 @cindex Tools needed to compile Emacs under DOS
3505 A pre-built binary distribution of Emacs 20 is available from the
3506 SimTel.NET archives. This version apparently works under MS-DOS and
3507 Windows (3.X, 9X, ME, NT, and 2000) and supports long file names under
3508 Windows 9X, Windows ME, and Windows 2000. More information is available
3511 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README}
3513 The binary itself is available in the files @file{em*.zip} in the
3516 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/}
3518 If you prefer to compile Emacs for yourself, you can do so with the
3519 current distribution directly. You will need a 386 (or
3520 better) processor, and to be running MS-DOS 3.0 or later. According to
3521 @email{eliz@@gnu.org, Eli Zaretskii} and
3522 @email{hankedr@@dms.auburn.edu, Darrel Hankerson}, you will need the
3528 DJGPP version 1.12 maint 1 or later. Djgpp 2.0 or later is
3529 recommended, since 1.x is very old an unmaintained. Djgpp 2 supports
3530 long file names on Windows 9X/ME/2K.
3532 You can get the latest release of DJGPP by retrieving all of
3535 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2*}
3537 @item Unpacking program
3538 The easiest way is to use @code{djtar} which comes with DJGPP v2.x,
3539 because it can open gzip'ed tarfiles (i.e., those ending with
3540 @file{.tar.gz}) in one step. @code{Djtar} comes in
3541 @file{djdev@var{nnn}.zip} archive (where @var{nnn} is the DJGPP version
3542 number), from the URL mentioned above.
3544 @strong{Warning!} Do @strong{not} use the popular WinZip program to
3545 unpack the Emacs distribution! WinZip is known to corrupt some of the
3546 files by converting them to the DOS CR-LF format, it doesn't always
3547 preserve the directory structure recorded in the compressed Emacs
3548 archive, and commits other atrocities. Some of these problems could
3549 actually prevent Emacs from building successfully!
3551 @item make, mv, sed, and rm
3552 All of these utilities are available at
3554 @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu}
3556 16-bit utilities can be found in GNUish, at
3558 @uref{http://www.simtel.net/pub/gnuish/}
3561 (@code{mv} and @code{rm} are in the Fileutils package, @code{sed} and
3562 @code{make} are each one in a separate package named after them.)
3566 The files @file{INSTALL} (near its end) and @file{etc/PROBLEMS} in the
3567 directory of the Emacs sources contains some additional information
3568 regarding Emacs under MS-DOS.
3570 For a list of other MS-DOS implementations of Emacs (and Emacs
3571 look-alikes), consult the list of ``Emacs implementations and literature,''
3574 @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/}
3576 Note that while many of these programs look similar to Emacs, they often
3577 lack certain features, such as the Emacs Lisp extension language.
3579 @node Emacs for Windows
3580 @section Where can I get Emacs for Microsoft Windows?
3581 @cindex FAQ for NT Emacs
3582 @cindex Emacs for MS-Windows
3583 @cindex Microsoft Windows, Emacs for
3584 @cindex Windows 9X, ME, NT, 2K, and CE, Emacs for
3586 For information on Emacs for Windows 95 and NT, read the FAQ produced by
3587 @email{voelker@@cs.washington.edu, Geoff Voelker} and currently maintained
3588 by @email{ramprasad@@gnu.org, Ramprasad B}, available at
3590 @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html}
3592 @xref{Emacs for MS-DOS}, for Windows 3.1.
3595 @node Emacs for GNUstep
3596 @section Where can I get Emacs for GNUstep?
3597 @cindex GNUSTEP, Emacs for
3599 Beginning with version 23.1, Emacs supports GNUstep natively.
3601 @node Emacs for Apple computers
3602 @section Where can I get Emacs for my Apple computer?
3603 @cindex Apple computers, Emacs for
3604 @cindex Macintosh, Emacs for
3606 Beginning with version 22.1, Emacs supports Mac OS X natively.
3609 @c ------------------------------------------------------------
3610 @node Major packages and programs
3611 @chapter Major packages and programs
3612 @cindex Major packages and programs
3625 @section VM (View Mail) --- another mail reader within Emacs, with MIME support
3627 @cindex Alternative mail software
3629 @cindex E-mail reader, VM
3634 @uref{http://www.nongnu.org/viewmail/}
3636 @item Informational newsgroup
3637 @uref{news:gnu.emacs.vm.info}@*
3639 @item Bug reports newsgroup
3640 @uref{news:gnu.emacs.vm.bug}@*
3643 VM was originally written by @uref{http://www.wonderworks.com/vm/,Kyle Jones}.
3644 @uref{ftp://ftp.wonderworks.com/pub/vm/,Older versions} of VM remain
3649 @section AUC@TeX{} --- enhanced @TeX{} modes with debugging facilities
3650 @cindex Mode for @TeX{}
3652 @cindex AUC@TeX{} mode for editing @TeX{}
3653 @cindex Writing and debugging @TeX{}
3655 AUC@TeX{} is a set of sophisticated major modes for @TeX{}, LaTeX,
3656 ConTeXt, and Texinfo offering context-sensitive syntax highlighting,
3657 indentation, formatting and folding, macro completion, @TeX{} shell
3658 functionality, and debugging. Be also sure to check out
3659 @ref{Introduction, RefTeX, Introduction, reftex, Ref@TeX{} User Manual}.
3660 Current versions of AUC@TeX{} include the
3661 @uref{http://www.gnu.org/software/auctex/preview-latex.html,preview-latex}
3662 package for WYSIWYG previews of various LaTeX constructs in the Emacs
3665 @uref{http://www.gnu.org/software/auctex/, AUCTeX}
3668 @section BBDB --- personal Info Rolodex integrated with mail/news readers
3670 @cindex Rolodex-like functionality
3671 @cindex Integrated contact database
3672 @cindex Contact database
3673 @cindex Big Brother Database
3674 @cindex Address book
3676 @uref{http://bbdb.sourceforge.net/, The Insidious Big Brother Database}
3678 @node Spell-checkers
3679 @section Spell-checkers
3680 @cindex Spell-checker
3681 @cindex Checking spelling
3686 Various spell-checkers are compatible with Emacs, including:
3691 @uref{http://aspell.net/}
3694 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
3697 @uref{http://hunspell.sourceforge.net/}
3702 @section Emacs/W3 --- A World Wide Web browser inside of Emacs
3705 @cindex HTML browser in Emacs
3706 @cindex @code{w3-mode}
3708 @uref{http://www.gnu.org/software/w3/, Emacs/W3}
3711 @section EDB --- Database program for Emacs; replaces forms editing modes
3716 @uref{http://gnuvola.org/software/edb/, the Emacs Database}
3719 @section JDE --- Integrated development environment for Java
3720 @cindex Java development environment
3721 @cindex Integrated Java development environment
3724 @uref{http://jdee.sourceforge.net/, a Java Development Environment for Emacs}
3726 @c ------------------------------------------------------------
3728 @chapter Key bindings
3729 @cindex Key bindings
3732 * Binding keys to commands::
3733 * Invalid prefix characters::
3734 * Terminal setup code works after Emacs has begun::
3735 * Working with function and arrow keys::
3736 * X key translations for Emacs::
3737 * Handling C-s and C-q with flow control::
3738 * Binding C-s and C-q::
3739 * Backspace invokes help::
3740 * stty and Backspace key::
3742 * Producing C-XXX with the keyboard::
3745 * Compose Character::
3746 * Binding combinations of modifiers and function keys::
3747 * Meta key does not work in xterm::
3748 * ExtendChar key does not work as Meta::
3749 * SPC no longer completes file names::
3752 @node Binding keys to commands
3753 @section How do I bind keys (including function keys) to commands?
3754 @cindex Binding keys to commands
3755 @cindex Keys, binding to commands
3756 @cindex Commands, binding keys to
3758 Keys can be bound to commands either interactively or in your
3759 @file{.emacs} file. To interactively bind keys for all modes, type
3760 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3762 To bind a key just in the current major mode, type @kbd{M-x
3763 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
3765 @inforef{Key Bindings, Key Bindings, emacs}, for further details.
3767 To make the process of binding keys interactively easier, use the
3768 following ``trick'': First bind the key interactively, then immediately
3769 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}. Now, the command needed
3770 to bind the key is in the kill ring, and can be yanked into your
3771 @file{.emacs} file. If the key binding is global, no changes to the
3772 command are required. For example,
3775 (global-set-key (quote [f1]) (quote help-for-help))
3779 can be placed directly into the @file{.emacs} file. If the key binding is
3780 local, the command is used in conjunction with the @samp{add-hook} function.
3781 For example, in TeX mode, a local binding might be
3784 (add-hook 'tex-mode-hook
3786 (local-set-key (quote [f1]) (quote help-for-help))))
3793 Control characters in key sequences, in the form yanked from the kill
3794 ring are given in their graphic form---i.e., @key{CTRL} is shown as
3795 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc. You may want
3796 to convert these into their vector or string forms.
3799 If a prefix key of the character sequence to be bound is already
3800 bound as a complete key, then you must unbind it before the new
3801 binding. For example, if @kbd{ESC @{} is previously bound:
3804 (global-unset-key [?\e ?@{]) ;; or
3805 (local-unset-key [?\e ?@{])
3809 Aside from commands and ``lambda lists,'' a vector or string also
3810 can be bound to a key and thus treated as a macro. For example:
3813 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g]) ;; or
3814 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
3819 @node Invalid prefix characters
3820 @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}?
3821 @cindex Prefix characters, invalid
3822 @cindex Invalid prefix characters
3823 @cindex Misspecified key sequences
3825 Usually, one of two things has happened. In one case, the control
3826 character in the key sequence has been misspecified (e.g. @samp{C-f}
3827 used instead of @samp{\C-f} within a Lisp expression). In the other
3828 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
3829 was already bound as a @dfn{complete key}. Historically, the @samp{ESC [}
3830 prefix was usually the problem, in which case you should evaluate either
3831 of these forms before attempting to bind the key sequence:
3834 (global-unset-key [?\e ?[]) ;; or
3835 (global-unset-key "\e[")
3838 @node Terminal setup code works after Emacs has begun
3839 @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?
3840 @cindex Terminal setup code in @file{.emacs}
3842 During startup, Emacs initializes itself according to a given code/file
3843 order. If some of the code executed in your @file{.emacs} file needs to
3844 be postponed until the initial terminal or window-system setup code has
3845 been executed but is not, then you will experience this problem (this
3846 code/file execution order is not enforced after startup).
3848 To postpone the execution of Emacs Lisp code until after terminal or
3849 window-system setup, treat the code as a @dfn{lambda list} and set the
3850 value of either the @code{term-setup-hook} or @code{window-setup-hook}
3851 variable to this lambda function. For example,
3854 (add-hook 'term-setup-hook
3856 (when (string-match "\\`vt220" (or (getenv "TERM") ""))
3857 ;; Make vt220's "Do" key behave like M-x:
3858 (global-set-key [do] 'execute-extended-command))))
3861 For information on what Emacs does every time it is started, see the
3862 @file{lisp/startup.el} file.
3864 @node Working with function and arrow keys
3865 @section How do I tell what characters or symbols my function or arrow keys emit?
3866 @cindex Working with arrow keys
3867 @cindex Arrow keys, symbols generated by
3868 @cindex Working with function keys
3869 @cindex Function keys, symbols generated by
3870 @cindex Symbols generated by function keys
3872 Type @kbd{C-h c} then the function or arrow keys. The command will
3873 return either a function key symbol or character sequence (see the
3874 Emacs documentation for an explanation). This works for other
3877 @node X key translations for Emacs
3878 @section How do I set the X key ``translations'' for Emacs?
3879 @cindex X key translations
3880 @cindex Key translations under X
3881 @cindex Translations for keys under X
3883 Emacs is not written using the Xt library by default, so there are no
3884 ``translations'' to be set. (We aren't sure how to set such translations
3885 if you do build Emacs with Xt; please let us know if you've done this!)
3887 The only way to affect the behavior of keys within Emacs is through
3888 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs). The
3889 @code{define-key} command should be used in conjunction with the
3890 @code{function-key-map} map. For instance,
3893 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
3897 defines the @kbd{M-@key{TAB}} key sequence.
3899 @node Handling C-s and C-q with flow control
3900 @section How do I handle @kbd{C-s} and @kbd{C-q} being used for flow control?
3901 @cindex Flow control, @kbd{C-s} and @kbd{C-q} with
3902 @cindex @kbd{C-s} and @kbd{C-q} with flow control
3904 @kbd{C-s} and @kbd{C-q} are used in the XON/XOFF flow control protocol.
3905 This messes things up when you're using Emacs over a serial line,
3906 because Emacs binds these keys to commands by default. Because Emacs
3907 won't honor them as flow control characters, too many of these
3908 characters are not passed on and overwhelm output buffers. Sometimes,
3909 intermediate software using XON/XOFF flow control will prevent Emacs
3910 from ever seeing @kbd{C-s} and @kbd{C-q}.
3917 Disable the use of @kbd{C-s} and @kbd{C-q} for flow control.
3919 You need to determine the cause of the flow control.
3926 Your terminal may use XON/XOFF flow control to have time to display
3927 all the characters it receives. For example, VT series terminals do
3928 this. It may be possible to turn this off from a setup menu. For
3929 example, on a VT220 you may select ``No XOFF'' in the setup menu. This
3930 is also true for some terminal emulation programs on PCs.
3932 When you turn off flow control at the terminal, you will also need to
3933 turn it off at the other end, which might be at the computer you are
3934 logged in to or at some terminal server in between.
3936 If you turn off flow control, characters may be lost; using a printer
3937 connected to the terminal may fail. You may be able to get around
3938 this problem by modifying the @samp{termcap} entry for your terminal to
3939 include extra NUL padding characters.
3944 If you are using a dialup connection, the modems may be using
3945 XON/XOFF flow control. It's not clear how to get around this.
3948 a router or terminal server
3950 Some network box between the terminal and your computer may be using
3951 XON/XOFF flow control. It may be possible to make it use some other
3952 kind of flow control. You will probably have to ask your local
3953 network experts for help with this.
3956 @code{tty} and/or @code{pty} devices
3958 If your connection to Emacs goes through multiple @code{tty} and/or
3959 @code{pty} devices, they may be using XON/XOFF flow control even when it
3962 @email{eirik@@theory.tn.cornell.edu, Eirik Fuller} writes:
3965 Some versions of @code{rlogin} (and possibly @code{telnet}) do not pass
3966 flow control characters to the remote system to which they connect. On
3967 such systems, Emacs on the remote system cannot disable flow control on
3968 the local system. Sometimes @samp{rlogin -8} will avoid this problem.
3970 One way to cure this is to disable flow control on the local host (the
3971 one running @code{rlogin}, not the one running @code{rlogind}) using the
3972 @code{stty} command, before starting the @code{rlogin} process. On many
3973 systems, @samp{stty start u stop u} will do this.
3975 Some versions of @samp{tcsh} will prevent even this from working. One
3976 way around this is to start another shell before starting rlogin,
3977 and issue the @samp{stty} command to disable flow control from that shell.
3980 Use @samp{stty -ixon} instead of @samp{stty start u stop u} on some systems.
3985 Make Emacs speak the XON/XOFF flow control protocol.
3987 You can make Emacs treat @kbd{C-s} and @kbd{C-q} as flow control characters by
3991 (enable-flow-control)
3995 to unconditionally enable flow control or
3998 (enable-flow-control-on "vt100" "h19")
4002 (using your terminal names instead of @samp{vt100} or @samp{h19}) to
4003 enable selectively. These commands will automatically swap @kbd{C-s}
4004 and @kbd{C-q} to @kbd{C-\} and @kbd{C-^}. Variables can be used to
4005 change the default swap keys (@code{flow-control-c-s-replacement} and
4006 @code{flow-control-c-q-replacement}).
4008 If you are fixing this for yourself, simply put the form in your
4009 @file{.emacs} file. If you are fixing this for your entire site, the
4010 best place to put it is in the @file{site-lisp/site-start.el} file.
4011 (Here @file{site-lisp} is actually a subdirectory of your Emacs
4012 installation directory, typically @file{/usr/local/share/emacs}.)
4013 Putting this form in @file{site-lisp/default.el} has the problem that
4014 if the user's @file{.emacs} file has an error, this will prevent
4015 @file{default.el} from being loaded and Emacs may be unusable for the
4016 user, even for correcting their @file{.emacs} file (unless they're
4017 smart enough to move it to another name).
4019 @code{enable-flow-control} can be invoked interactively as well:
4020 @kbd{M-x enable-flow-control @key{RET}}.
4024 For further discussion of this issue, read the file @file{etc/PROBLEMS}
4025 (in the Emacs source directory when you unpack the Emacs distribution).
4027 @node Binding C-s and C-q
4028 @section How do I bind @kbd{C-s} and @kbd{C-q} (or any key) if these keys are filtered out?
4029 @cindex Binding @kbd{C-s} and @kbd{C-q}
4030 @cindex @kbd{C-s} and @kbd{C-q}, binding
4032 To bind @kbd{C-s} and @kbd{C-q}, use either @code{enable-flow-control}
4033 or @code{enable-flow-control-on}. @xref{Handling C-s and C-q with flow
4034 control}, for usage and implementation details.
4036 To bind other keys, use @code{keyboard-translate}. @xref{Swapping
4037 keys}, for usage details. To do this for an entire site, you should
4038 swap the keys in @file{site-lisp/site-start.el}. @xref{Handling C-s
4039 and C-q with flow control}, for an explanation of why
4040 @file{site-lisp/default.el} should not be used.
4045 If you do this for an entire site, the users will be confused by
4046 the disparity between what the documentation says and how Emacs
4051 @node Backspace invokes help
4052 @section Why does the @key{Backspace} key invoke help?
4053 @cindex Backspace key invokes help
4054 @cindex Help invoked by Backspace
4055 @cindex DEL key does not delete
4057 The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8.
4058 @kbd{C-h} sends the same code. In Emacs by default @kbd{C-h} invokes
4059 help-command. This is intended to be easy to remember since the first
4060 letter of @samp{help} is @samp{h}. The easiest solution to this problem
4061 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
4062 @key{Delete} key) for deleting the previous character.
4064 For many people this solution may be problematic:
4069 They normally use @key{Backspace} outside of Emacs for deleting the
4070 previous character. This can be solved by making @key{DEL} the command
4071 for deleting the previous character outside of Emacs. On many Unix
4072 systems, this command will remap @key{DEL}:
4079 The user may prefer the @key{Backspace} key for deleting the
4080 previous character because it is more conveniently located on their
4081 keyboard or because they don't even have a separate @key{Delete} key.
4082 In this case, the @key{Backspace} key should be made to behave like
4083 @key{Delete}. There are several methods.
4087 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
4088 TeraTerm) allow the character generated by the @key{Backspace} key to be
4089 changed from a setup menu.
4092 You may be able to get a keyboard that is completely programmable, or a
4093 terminal emulator that supports remapping of any key to any other key.
4096 With Emacs 21.1 and later, you can control the effect of the
4097 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
4098 windowed displays, by customizing the option
4099 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
4100 normal-erase-is-backspace}. See the documentation of these symbols
4101 (@pxref{Emacs Lisp documentation}) for more info.
4104 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
4108 (keyboard-translate ?\C-h ?\C-?)
4112 This is the recommended method of forcing @key{Backspace} to act as
4113 @key{DEL}, because it works even in modes which bind @key{DEL} to
4114 something other than @code{delete-backward-char}.
4116 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
4117 default deletes forward:
4120 (keyboard-translate ?\C-? ?\C-d)
4123 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
4126 Another approach is to switch key bindings and put help on @kbd{C-x h}
4130 (global-set-key "\C-h" 'delete-backward-char)
4132 ;; overrides mark-whole-buffer
4133 (global-set-key "\C-xh" 'help-command)
4137 This method is not recommended, though: it only solves the problem for
4138 those modes which bind @key{DEL} to @code{delete-backward-char}. Modes
4139 which bind @key{DEL} to something else, such as @code{view-mode}, will
4140 not work as you expect when you press the @key{Backspace} key. For this
4141 reason, we recommend the @code{keyboard-translate} method, shown
4144 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
4147 Don't try to bind @key{DEL} to @code{help-command}, because there are
4148 many modes that have local bindings of @key{DEL} that will interfere.
4152 When Emacs 21 or later runs on a windowed display, it binds the
4153 @key{Delete} key to a command which deletes the character at point, to
4154 make Emacs more consistent with keyboard operation on these systems.
4156 For more information about troubleshooting this problem, see @ref{DEL
4157 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
4160 @node stty and Backspace key
4161 @section Why doesn't Emacs look at the @file{stty} settings for @key{Backspace} vs. @key{Delete}?
4162 @cindex @file{stty} and Emacs
4163 @cindex Backspace and @file{stty}
4164 @cindex Delete and @file{stty}
4168 @c FIXME: RMS explained the reasons for this on emacs-hackers. It's
4169 @c probably worth putting that explanation here.
4172 @section How do I swap two keys?
4173 @cindex Swapping keys
4174 @cindex Keys, swapping
4175 @cindex @code{keyboard-translate}
4177 You can swap two keys (or key sequences) by using the
4178 @code{keyboard-translate} function. For example, to turn @kbd{C-h}
4179 into @key{DEL} and @key{DEL} to @kbd{C-h}, use
4182 (keyboard-translate ?\C-h ?\C-?) ; translate `C-h' to DEL
4183 (keyboard-translate ?\C-? ?\C-h) ; translate DEL to `C-h'.
4187 The first key sequence of the pair after the function identifies what is
4188 produced by the keyboard; the second, what is matched for in the
4191 However, in the specific case of @kbd{C-h} and @key{DEL}, you should
4192 toggle @code{normal-erase-is-backspace-mode} instead of calling
4193 @code{keyboard-translate}. @inforef{DEL Does Not Delete, DEL Does Not Delete,
4196 Keyboard translations are not the same as key bindings in keymaps.
4197 Emacs contains numerous keymaps that apply in different situations, but
4198 there is only one set of keyboard translations, and it applies to every
4199 character that Emacs reads from the terminal. Keyboard translations
4200 take place at the lowest level of input processing; the keys that are
4201 looked up in keymaps contain the characters that result from keyboard
4204 @node Producing C-XXX with the keyboard
4205 @section How do I produce C-XXX with my keyboard?
4206 @cindex Producing control characters
4207 @cindex Generating control characters
4208 @cindex Control characters, generating
4210 On terminals (but not under X), some common ``aliases'' are:
4214 @item @kbd{C-2} or @kbd{C-@key{SPC}}
4220 @item @kbd{C-7} or @kbd{C-S--}
4234 Often other aliases exist; use the @kbd{C-h c} command and try
4235 @key{CTRL} with all of the digits on your keyboard to see what gets
4236 generated. You can also try the @kbd{C-h w} command if you know the
4237 name of the command.
4240 @section What if I don't have a @key{Meta} key?
4241 @cindex No @key{Meta} key
4242 @cindex @key{Meta} key, what to do if you lack it
4244 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
4246 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}. In fact,
4247 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
4248 (depending on the value of @code{meta-prefix-char}). Note that you
4249 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
4250 @key{ESC}, release it, and then press @key{a}.
4253 @section What if I don't have an @key{Escape} key?
4254 @cindex No Escape key
4255 @cindex Lacking an Escape key
4256 @cindex Escape key, lacking
4258 Type @kbd{C-[} instead. This should send @acronym{ASCII} code 27 just like an
4259 Escape key would. @kbd{C-3} may also work on some terminal (but not
4260 under X). For many terminals (notably DEC terminals) @key{F11}
4261 generates @key{ESC}. If not, the following form can be used to bind it:
4264 ;; F11 is the documented ESC replacement on DEC terminals.
4265 (define-key function-key-map [f11] [?\e])
4268 @node Compose Character
4269 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
4270 @cindex @key{Compose Character} key, using as @key{Meta}
4271 @cindex @key{Meta}, using @key{Compose Character} for
4273 On a dumb terminal such as a VT220, no. It is rumored that certain
4274 VT220 clones could have their @key{Compose} key configured this way. If
4275 you're using X, you might be able to do this with the @code{xmodmap}
4278 @node Binding combinations of modifiers and function keys
4279 @section How do I bind a combination of modifier key and function key?
4280 @cindex Modifiers and function keys
4281 @cindex Function keys and modifiers
4282 @cindex Binding modifiers and function keys
4284 With Emacs 19 and later, you can represent modified function keys in
4285 vector format by adding prefixes to the function key symbol. For
4286 example (from the Emacs documentation):
4289 (global-set-key [?\C-x right] 'forward-page)
4293 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
4295 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
4296 @key{Super}, @key{Alt}, and @key{Shift} with function keys. To
4297 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
4298 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name. Here
4299 is how to make @kbd{H-M-RIGHT} move forward a word:
4302 (global-set-key [H-M-right] 'forward-word)
4308 Not all modifiers are permitted in all situations. @key{Hyper},
4309 @key{Super}, and @key{Alt} are not available on Unix character
4310 terminals. Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and
4311 @kbd{Mouse-1}) also fall under this category.
4315 @xref{Binding keys to commands}, for general key binding instructions.
4317 @node Meta key does not work in xterm
4318 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
4319 @cindex @key{Meta} key and @code{xterm}
4320 @cindex Xterm and @key{Meta} key
4322 @inforef{Unibyte Mode, Single-Byte Character Set Support, emacs}.
4324 If the advice in the Emacs manual fails, try all of these methods before
4325 asking for further help:
4330 You may have big problems using @code{mwm} as your window manager.
4331 (Does anyone know a good generic solution to allow the use of the
4332 @key{Meta} key in Emacs with @file{mwm}?)
4335 For X11: Make sure it really is a @key{Meta} key. Use @code{xev} to
4336 find out what keysym your @key{Meta} key generates. It should be either
4337 @code{Meta_L} or @code{Meta_R}. If it isn't, use @file{xmodmap} to fix
4338 the situation. If @key{Meta} does generate @code{Meta_L} or
4339 @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in
4340 your @file{~/.Xdefaults} file:
4343 XTerm*eightBitInput: false
4344 XTerm*eightBitOutput: true
4348 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
4349 characters. @samp{stty -a} (or @samp{stty everything}) should show
4350 @samp{cs8} somewhere. If it shows @samp{cs7} instead, use @samp{stty
4351 cs8 -istrip} (or @samp{stty pass8}) to fix it.
4354 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
4355 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
4359 If Emacs is running on Ultrix, it is reported that evaluating
4360 @code{(set-input-mode t nil)} helps.
4363 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
4364 you type @kbd{M-W}, which is the same conversion Emacs would make if it
4365 got the @kbd{M-W} anyway. In X11R4, the following resource
4366 specification will do this:
4369 XTerm.VT100.EightBitInput: false
4373 (This changes the behavior of the @code{insert-eight-bit} action.)
4375 With older @code{xterm}s, you can specify this behavior with a translation:
4378 XTerm.VT100.Translations: #override \
4379 Meta<KeyPress>: string(0x1b) insert()
4383 You might have to replace @samp{Meta} with @samp{Alt}.
4387 @node ExtendChar key does not work as Meta
4388 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
4389 @cindex @key{ExtendChar} key as @key{Meta}
4390 @cindex @key{Meta}, using @key{ExtendChar} for
4391 @cindex HP-UX, the @key{ExtendChar} key
4393 This is a result of an internationalization extension in X11R4 and the
4394 fact that HP is now using this extension. Emacs assumes that the
4395 @code{XLookupString} function returns the same result regardless of the
4396 @key{Meta} key state which is no longer necessarily true. Until Emacs
4397 is fixed, the temporary kludge is to run this command after each time
4398 the X server is started but preferably before any xterm clients are:
4401 xmodmap -e 'remove mod1 = Mode_switch'
4404 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
4407 This will disable the use of the extra keysyms systemwide, which may be
4408 undesirable if you actually intend to use them.
4410 @node SPC no longer completes file names
4411 @section Why doesn't SPC complete file names anymore?
4412 @cindex @kbd{SPC} file name completion
4414 Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in
4415 the minibuffer, so that file names with embedded spaces could be typed
4416 without the need to quote the spaces.
4418 You can get the old behavior by binding @kbd{SPC} to
4419 @code{minibuffer-complete-word} in the minibuffer, as follows:
4422 (define-key minibuffer-local-filename-completion-map (kbd "SPC")
4423 'minibuffer-complete-word)
4425 (define-key minibuffer-local-must-match-filename-map (kbd "SPC")
4426 'minibuffer-complete-word)
4429 @c ------------------------------------------------------------
4430 @node Alternate character sets
4431 @chapter Alternate character sets
4432 @cindex Alternate character sets
4435 * Emacs does not display 8-bit characters::
4436 * Inputting eight-bit characters::
4437 * Kanji and Chinese characters::
4438 * Right-to-left alphabets::
4439 * How to add fonts::
4442 @node Emacs does not display 8-bit characters
4443 @section How do I make Emacs display 8-bit characters?
4444 @cindex Displaying eight-bit characters
4445 @cindex Eight-bit characters, displaying
4447 @inforef{Unibyte Mode, Single-byte Character Set
4448 Support, emacs}. On a Unix, when Emacs runs on a text-only terminal
4449 display or is invoked with @samp{emacs -nw}, you typically need to use
4450 @code{set-terminal-coding-system} to tell Emacs what the terminal can
4451 display, even after setting the language environment; otherwise
4452 non-@acronym{ASCII} characters will display as @samp{?}. On other operating
4453 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
4454 character set supported by the display, and sets up the required
4455 terminal coding system automatically.
4457 @node Inputting eight-bit characters
4458 @section How do I input eight-bit characters?
4459 @cindex Entering eight-bit characters
4460 @cindex Eight-bit characters, entering
4461 @cindex Input, 8-bit characters
4463 Various methods are available for input of eight-bit characters. See
4464 @inforef{Unibyte Mode, Single-byte Character Set
4465 Support, emacs}. For more sophisticated methods, @inforef{Input
4466 Methods, Input Methods, emacs}.
4468 @node Kanji and Chinese characters
4469 @section Where can I get an Emacs that handles kanji, Chinese, or other Far-Eastern character sets?
4470 @cindex Kanji, handling with Emacs
4471 @cindex Chinese, handling with Emacs
4472 @cindex Japanese, handling with Emacs
4473 @cindex Korean, handling with Emacs
4475 Emacs 20 and later includes many of the features of MULE, the MULtilingual
4476 Enhancement to Emacs. @xref{Installing Emacs}, for information on where
4477 to find and download the latest version of Emacs.
4479 @node Right-to-left alphabets
4480 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
4481 @cindex Right-to-left alphabets
4482 @cindex Hebrew, handling with Emacs
4483 @cindex Semitic alphabets
4484 @cindex Arabic alphabets
4486 Emacs 20 and later supports Hebrew characters (ISO 8859-8), but does not
4487 yet support right-to-left character entry and display.
4489 @email{joel@@exc.com, Joel M. Hoffman} has written a Lisp package called
4490 @file{hebrew.el} that allows right-to-left editing of Hebrew. It
4491 reportedly works out of the box with Emacs 19, but requires patches for
4492 Emacs 18. Write to Joel if you want the patches or package.
4494 @c FIXME: Should we mention Ehud Karni's package?
4496 @file{hebrew.el} requires a Hebrew screen font, but no other hardware support.
4497 Joel has a screen font for PCs running MS-DOS or GNU/Linux.
4499 You might also try querying @code{archie} for files named with
4500 @file{hebrew}; several ftp sites in Israel may also have the necessary
4503 @node How to add fonts
4504 @section How do I add fonts for use with Emacs?
4505 @cindex add fonts for use with Emacs
4508 First, download and install the BDF font files and any auxiliary
4509 packages they need. The GNU Intlfonts distribution can be found on
4510 @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU
4511 Software Directory Web site}.
4513 Next, if you are on X Window system, issue the following two commands
4514 from the shell's prompt:
4517 xset +fp /usr/local/share/emacs/fonts
4522 (Modify the first command if you installed the fonts in a directory
4523 that is not @file{/usr/local/share/emacs/fonts}.) You also need to
4524 arrange for these two commands to run whenever you log in, e.g., by
4525 adding them to your window-system startup file, such as
4526 @file{~/.xsessionrc} or @file{~/.gnomerc}.
4528 Now, add the following line to your @file{~/.emacs} init file:
4531 (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf")
4535 (Again, modify the file name if you installed the fonts elsewhere.)
4537 Finally, if you wish to use the installed fonts with @code{ps-print},
4538 add the following line to your @file{~/.emacs}:
4541 (setq ps-multibyte-buffer 'bdf-font-except-latin)
4544 A few additional steps are necessary for MS-Windows; they are listed
4547 First, make sure @emph{all} the directories with BDF font files are
4548 mentioned in @code{bdf-directory-list}. On Unix and GNU/Linux
4549 systems, one normally runs @kbd{make install} to install the BDF fonts
4550 in the same directory. By contrast, Windows users typically don't run
4551 the Intlfonts installation command, but unpack the distribution in
4552 some directory, which leaves the BDF fonts in its subdirectories. For
4553 example, assume that you unpacked Intlfonts in @file{C:/Intlfonts};
4554 then you should set @code{bdf-directory-list} as follows:
4557 (setq bdf-directory-list
4558 '("C:/Intlfonts/Asian"
4559 "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X"
4560 "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic"
4561 "C:/Intlfonts/European" "C:/Intlfonts/European.BIG"
4562 "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X"
4563 "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X"
4564 "C:/Intlfonts/Misc"))
4567 @cindex @code{w32-bdf-filename-alist}
4568 @cindex @code{w32-find-bdf-fonts}
4569 Next, you need to set up the variable @code{w32-bdf-filename-alist} to
4570 an alist of the BDF fonts and their corresponding file names.
4571 Assuming you have set @code{bdf-directory-list} to name all the
4572 directories with the BDF font files, the following Lisp snippet will
4573 set up @code{w32-bdf-filename-alist}:
4576 (setq w32-bdf-filename-alist
4577 (w32-find-bdf-fonts bdf-directory-list))
4580 Now, create fontsets for the BDF fonts:
4583 (create-fontset-from-fontset-spec
4584 "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf,
4585 japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*,
4586 katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4587 latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*,
4588 japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*,
4589 thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1,
4590 lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1,
4591 tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
4592 ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode,
4593 tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0")
4596 Many of the international bdf fonts from Intlfonts are type 0, and
4597 therefore need to be added to font-encoding-alist:
4600 (setq font-encoding-alist
4601 (append '(("MuleTibetan-0" (tibetan . 0))
4602 ("GB2312" (chinese-gb2312 . 0))
4603 ("JISX0208" (japanese-jisx0208 . 0))
4604 ("JISX0212" (japanese-jisx0212 . 0))
4605 ("VISCII" (vietnamese-viscii-lower . 0))
4606 ("KSC5601" (korean-ksc5601 . 0))
4607 ("MuleArabic-0" (arabic-digit . 0))
4608 ("MuleArabic-1" (arabic-1-column . 0))
4609 ("MuleArabic-2" (arabic-2-column . 0)))
4610 font-encoding-alist))
4613 You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium}
4614 fontset, or you can select it by setting the default font in your
4618 (set-default-font "fontset-bdf")
4622 @c ------------------------------------------------------------
4624 @chapter Mail and news
4625 @cindex Mail and news
4628 * Changing the included text prefix::
4629 * Saving a copy of outgoing mail::
4630 * Expanding aliases when sending mail::
4631 * Sorting the messages in an Rmail folder::
4632 * Rmail writes to /usr/spool/mail::
4633 * Replying to the sender of a message::
4634 * MIME with Emacs mail packages::
4635 * Automatically starting a mail or news reader::
4636 * Reading news with Emacs::
4637 * Gnus does not work with NNTP::
4638 * Viewing articles with embedded underlining::
4639 * Saving a multi-part Gnus posting::
4640 * Starting Gnus faster::
4641 * Catching up in all newsgroups::
4642 * Killing based on nonstandard headers::
4643 * Catch-up is slow in Gnus::
4644 * Gnus hangs for a long time::
4645 * Learning more about Gnus::
4648 @node Changing the included text prefix
4649 @section How do I change the included text prefix in mail/news followups?
4650 @cindex Prefix in mail/news followups, changing
4651 @cindex Included text prefix, changing
4652 @cindex Setting the included text character
4653 @cindex Quoting in mail messages
4655 If you read mail with Rmail or news with Gnus, set the variable
4656 @code{mail-yank-prefix}. For VM, set @code{vm-included-text-prefix}.
4657 For mh-e, set @code{mh-ins-buf-prefix}.
4659 For fancier control of citations, use Supercite (part of Emacs).
4661 To prevent Emacs from including various headers of the replied-to
4662 message, set the value of @code{mail-yank-ignored-headers} to an
4665 @node Saving a copy of outgoing mail
4666 @section How do I save a copy of outgoing mail?
4667 @cindex Saving a copy of outgoing mail
4668 @cindex Copying outgoing mail to a file
4669 @cindex Filing outgoing mail
4670 @cindex Automatic filing of outgoing mail
4671 @cindex Mail, saving outgoing automatically
4673 You can either mail yourself a copy by including a @samp{BCC} header in the
4674 mail message, or store a copy of the message directly to a file by
4675 including an @samp{FCC} header.
4677 If you use standard mail, you can automatically create a @samp{BCC} to
4681 (setq mail-self-blind t)
4685 in your @file{.emacs} file. You can automatically include an @samp{FCC}
4686 field by putting something like the following in your @file{.emacs}
4690 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
4693 The output file will be in Unix mail format, which can be read directly
4694 by VM or Rmail (since Emacs 23).
4696 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
4699 It does not work to put @samp{set record filename} in the @file{.mailrc}
4702 @node Expanding aliases when sending mail
4703 @section Why doesn't Emacs expand my aliases when sending mail?
4704 @cindex Expanding aliases when sending mail
4705 @cindex Mail alias expansion
4706 @cindex Sending mail with aliases
4711 You must separate multiple addresses in the headers of the mail buffer
4712 with commas. This is because Emacs supports RFC822 standard addresses
4716 To: Willy Smith <wks@@xpnsv.lwyrs.com>
4719 However, you do not need to---and probably should not, unless your
4720 system's version of @file{/usr/ucb/mail} (a.k.a.@: @code{mailx})
4721 supports RFC822---separate addresses with commas in your
4722 @file{~/.mailrc} file.
4725 Emacs normally only reads the @file{.mailrc} file once per session,
4726 when you start to compose your first mail message. If you edit
4727 @file{.mailrc}, you can type @kbd{M-x rebuild-mail-abbrevs @key{RET}} to
4728 make Emacs reread @file{~/.mailrc}.
4731 If you like, you can expand mail aliases as abbrevs, as soon as you
4732 type them in. To enable this feature, execute the following:
4735 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
4738 Note that the aliases are expanded automatically only after you type
4739 @key{RET} or a punctuation character (e.g. @kbd{,}). You can force their
4740 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
4741 (@kbd{M-x expand-abbrev}).
4744 @node Sorting the messages in an Rmail folder
4745 @section How can I sort the messages in my Rmail folder?
4746 @cindex Rmail, sorting messages in
4747 @cindex Folder, sorting messages in an Rmail
4748 @cindex Sorting messages in an Rmail folder
4750 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
4751 and their key bindings.
4753 @node Rmail writes to /usr/spool/mail
4754 @section Why does Rmail need to write to @file{/usr/spool/mail}?
4755 @cindex Rmail and @file{/usr/spool/mail}
4756 @cindex @file{/usr/spool/mail} and Rmail
4758 This is the behavior of the @code{movemail} program which Rmail uses.
4759 This indicates that @code{movemail} is configured to use lock files.
4764 Certain systems require lock files to interlock access to mail files.
4765 On these systems, @code{movemail} must write lock files, or you risk losing
4766 mail. You simply must arrange to let @code{movemail} write them.
4768 Other systems use the @code{flock} system call to interlock access. On
4769 these systems, you should configure @code{movemail} to use @code{flock}.
4772 @node Replying to the sender of a message
4773 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
4774 @cindex Replying only to the sender of a message
4775 @cindex Sender, replying only to
4776 @cindex Rmail, replying to the sender of a message in
4778 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit
4779 @key{r} to reply in Rmail, by default it CCs all of the original
4780 recipients (everyone on the original @samp{To} and @samp{CC}
4781 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
4782 it replies only to the sender. However, going through the whole
4783 @kbd{C-u} business every time you want to reply is a pain. This is the
4784 best fix I've been able to come up with:
4787 (defun rmail-reply-t ()
4788 "Reply only to the sender of the current message. (See rmail-reply.)"
4792 (add-hook 'rmail-mode-hook
4794 (define-key rmail-mode-map "r" 'rmail-reply-t)
4795 (define-key rmail-mode-map "R" 'rmail-reply)))
4798 @node MIME with Emacs mail packages
4799 @section How can I get my favorite Emacs mail package to support MIME?
4800 @cindex MIME and Emacs mail packages
4801 @cindex Mail packages and MIME
4802 @cindex FAQ for MIME and Emacs
4804 Version 6.x of VM supports MIME. @xref{VM}. Gnus supports MIME in mail
4805 and news messages as of version 5.8.1 (Pterodactyl). Rmail has limited
4806 support for single-part MIME messages beginning with Emacs 20.3.
4808 @node Automatically starting a mail or news reader
4809 @section How do I make Emacs automatically start my mail/news reader?
4810 @cindex Mail reader, starting automatically
4811 @cindex News reader, starting automatically
4812 @cindex Starting mail/news reader automatically
4814 To start Emacs in Gnus:
4827 A more convenient way to start with Gnus:
4830 alias gnus 'emacs -f gnus'
4834 It is probably unwise to automatically start your mail or news reader
4835 from your @file{.emacs} file. This would cause problems if you needed to run
4836 two copies of Emacs at the same time. Also, this would make it difficult for
4837 you to start Emacs quickly when you needed to.
4839 @node Reading news with Emacs
4840 @section How do I read news under Emacs?
4841 @cindex Reading news under Emacs
4842 @cindex Usenet reader in Emacs
4843 @cindex Gnus newsreader
4845 Use @kbd{M-x gnus}. It is documented in Info (@pxref{Learning how to do
4848 @node Gnus does not work with NNTP
4849 @section Why doesn't Gnus work via NNTP?
4850 @cindex Gnus and NNTP
4851 @cindex NNTP, Gnus fails to work with
4853 There is a bug in NNTP version 1.5.10, such that when multiple requests
4854 are sent to the NNTP server, the server only handles the first one
4855 before blocking waiting for more input which never comes. NNTP version
4856 1.5.11 claims to fix this.
4858 You can work around the bug inside Emacs like this:
4861 (setq nntp-maximum-request 1)
4864 You can find out what version of NNTP your news server is running by
4865 telnetting to the NNTP port (usually 119) on the news server machine
4866 (i.e., @kbd{telnet server-machine 119}). The server should give its
4867 version number in the welcome message. Type @kbd{quit} to get out.
4869 @xref{Spontaneous entry into isearch-mode}, for some additional ideas.
4871 @node Viewing articles with embedded underlining
4872 @section How do I view news articles with embedded underlining (e.g., ClariNews)?
4873 @cindex Underlining, embedded in news articles
4874 @cindex News articles with embedded underlining
4875 @cindex Embedded underlining in news articles
4877 Underlining appears like this:
4880 _^Hu_^Hn_^Hd_^He_^Hr_^Hl_^Hi_^Hn_^Hi_^Hn_^Hg
4883 @email{abraham@@dina.kvl.dk, Per Abrahamsen} suggests using the following
4884 code, which uses the underline face to turn such text into true
4885 underlining, inconjunction with Gnus:
4888 (defun gnus-article-prepare-overstrike ()
4889 ;; Prepare article for overstrike commands.
4891 (set-buffer gnus-article-buffer)
4892 (let ((buffer-read-only nil))
4893 (goto-char (point-min))
4894 (while (search-forward "\b" nil t)
4895 (let ((next (following-char))
4896 (previous (char-after (- (point) 2))))
4897 (cond ((eq next previous)
4898 (delete-region (- (point) 2) (point))
4899 (put-text-property (point) (1+ (point))
4902 (delete-region (1- (point)) (1+ (point)))
4903 (put-text-property (1- (point)) (point)
4906 (delete-region (- (point) 2) (point))
4907 (put-text-property (point) (1+ (point))
4908 'face 'underline))))))))
4910 (add-hook 'gnus-article-prepare-hook 'gnus-article-prepare-overstrike)
4913 Latest versions of Gnus do such a conversion automatically.
4915 If you prefer to do away with underlining altogether, you can
4916 destructively remove it with @kbd{M-x ununderline-region}; do this
4920 (add-hook 'gnus-article-prepare-hook
4921 (lambda () (ununderline-region (point-min) (point-max))))
4924 @node Saving a multi-part Gnus posting
4925 @section How do I save all the items of a multi-part posting in Gnus?
4926 @cindex Multi-part postings in Gnus, saving
4927 @cindex Saving multi-part postings in Gnus
4928 @cindex Gnus, saving multi-part postings in
4930 Use @code{gnus-uu}. Type @kbd{C-c C-v C-h} in the Gnus summary buffer
4931 to see a list of available commands.
4933 @node Starting Gnus faster
4934 @section How do I make Gnus start up faster?
4935 @cindex Faster, starting Gnus
4936 @cindex Starting Gnus faster
4937 @cindex Gnus, starting faster
4939 From the Gnus FAQ (@pxref{Learning more about Gnus}):
4942 @email{pktiwari@@eos.ncsu.edu, Pranav Kumar Tiwari} writes: I posted
4943 the same query recently and I got an answer to it. I am going to
4944 repeat the answer. What you need is a newer version of gnus, version
4945 5.0.4+. I am using 5.0.12 and it works fine with me with the
4949 (setq gnus-check-new-newsgroups nil
4950 gnus-read-active-file 'some
4951 gnus-nov-is-evil nil
4952 gnus-select-method '(nntp gnus-nntp-server))
4956 @node Catching up in all newsgroups
4957 @section How do I catch up all newsgroups in Gnus?
4958 @cindex Catching up all newsgroups in Gnus
4959 @cindex Gnus, Catching up all newsgroups in
4961 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
4963 Leave off the initial @kbd{M-<} if you only want to catch up from point
4964 to the end of the @file{*Newsgroup*} buffer.
4966 @node Killing based on nonstandard headers
4967 @section Why can't I kill in Gnus based on the Newsgroups/Keywords/Control headers?
4968 @cindex Killing articles based on nonstandard headers
4969 @cindex Newsgroups header, killing articles based on
4970 @cindex Keywords header, killing articles based on
4971 @cindex Control header, killing articles based on
4973 Gnus will complain that the @samp{Newsgroups}, @samp{Keywords}, and
4974 @samp{Control} headers are ``Unknown header'' fields.
4976 For the @samp{Newsgroups} header, there is an easy workaround: kill on the
4977 @samp{Xref} header instead, which will be present on any cross-posted article
4978 (as long as your site carries the cross-post group).
4980 If you really want to kill on one of these headers, you can do it like
4984 (gnus-kill nil "^Newsgroups: .*\\(bad\\.group\\|worse\\.group\\)")
4987 @node Catch-up is slow in Gnus
4988 @section Why is catch up slow in Gnus?
4989 @cindex Slow catch up in Gnus
4990 @cindex Gnus is slow when catching up
4991 @cindex Crosspostings make Gnus catching up slow
4993 Because Gnus is marking crosspostings read. You can control this with
4994 the variable @code{gnus-use-cross-reference}.
4996 @node Gnus hangs for a long time
4997 @section Why does Gnus hang for a long time when posting?
4998 @cindex Hangs in Gnus
4999 @cindex Gnus hangs while posting
5000 @cindex Posting, Gnus hangs wile
5002 @email{tale@@uunet.uu.net, David Lawrence} explains:
5005 The problem is almost always interaction between NNTP and C News. NNTP
5006 POST asks C News's @code{inews} to not background itself but rather hang
5007 around and give its exit status so it knows whether the post was successful.
5008 (That wait will on some systems not return the exit status of the
5009 waited for job is a different sort of problem.) It ends up taking a
5010 long time because @code{inews} is calling @code{relaynews}, which often
5011 waits for another @code{relaynews} to free the lock on the news system
5012 so it can file the article.
5014 My preferred solution is to change @code{inews} to not call
5015 @code{relaynews}, but rather use @code{newsspool}. This loses some
5016 error-catching functionality, but is for the most part safe as
5017 @code{inews} will detect a lot of the errors on its own. The C News
5018 folks have sped up @code{inews}, too, so speed should look better to
5019 most folks as that update propagates around.
5022 @node Learning more about Gnus
5023 @section Where can I find out more about Gnus?
5024 @cindex FAQ for Gnus
5026 @cindex Learning more about Gnus
5028 For more information on Gnus, consult the Gnus manual and FAQ, which are
5029 part of the Gnus distribution.
5032 @unnumbered Concept Index
5038 arch-tag: fee0d62d-06cf-43d8-ac21-123408eaf10f