(skip_invisible): Use new retval of TEXT_PROP_MEANS_INVISIBLE.
[emacs.git] / man / faq.texi
blobdc60b6616fc4f13eaad23c4b8450cdde23a35837
1 \input texinfo   @c -*-texinfo-*-  -*- coding: latin-1 -*-
2 @c %**start of header
3 @setfilename ../info/efaq
4 @settitle GNU Emacs FAQ
5 @c %**end of header
7 @setchapternewpage odd
9 @c This is used in many places
10 @set VER 21.1
12 @c The @ifinfo stuff only appears in the Info version
13 @ifinfo
14 @dircategory Emacs
15 @direntry
16 * Emacs FAQ: (efaq).    Frequently Asked Questions about Emacs.
17 @end direntry
19 Copyright 1994,1995,1996,1997,1998,1999,2000 Reuven M. Lerner@*
20 Copyright 1992,1993 Steven Byrnes@*
21 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 somewhat edited from the last-posted version
38 (as of August 1999) for inclusion in the Emacs distribution.]
40 @end ifinfo
42 @c The @titlepage stuff only appears in the printed version
43 @titlepage
44 @sp 10
45 @center @titlefont{GNU Emacs FAQ}
47 @c The following two commands start the copyright page.
48 @page
49 @vskip 0pt plus 1filll
50 Copyright @copyright{} 1994,1995,1996,1997,1998,1999,2000 Reuven M. Lerner@*
51 Copyright @copyright{} 1992,1993 Steven Byrnes@*
52 Copyright @copyright{} 1990,1991,1992 Joseph Brian Wells@*
54 This list of frequently asked questions about GNU Emacs with answers
55 ("FAQ") may be translated into other languages, transformed into other
56 formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information.
58 The same conditions apply to any derivative of the FAQ as apply to the FAQ
59 itself.  Every copy of the FAQ must include this notice or an approved
60 translation, information on who is currently maintaining the FAQ and how to
61 contact them (including their e-mail address), and information on where the
62 latest version of the FAQ is archived (including FTP information).
64 The FAQ may be copied and redistributed under these conditions, except that
65 the FAQ may not be embedded in a larger literary work unless that work
66 itself allows free copying and redistribution.
68 [This version has been somewhat edited from the last-posted version
69 (as of August 1999) for inclusion in the Emacs distribution.]
70 @end titlepage
72 @node    Top, FAQ notation, (dir), (dir)
74 This is the GNU Emacs FAQ, last updated on @today{}.
76 The FAQ is maintained as a Texinfo document, allowing us to create HTML,
77 Info, and TeX documents from a single source file, and is slowly but
78 surely being improved.  Please bear with us as we improve on this
79 format.  If you have any suggestions or questions, please contact
80 @email{emacs-faq@@lerner.co.il, the FAQ maintainers}.
82 @menu
83 * FAQ notation::                
84 * General questions::           
85 * Getting help::                
86 * Status of Emacs::             
87 * Common requests::             
88 * Bugs and problems::           
89 * Compiling and installing Emacs::  
90 * Finding Emacs and related packages::  
91 * Major packages and programs::  
92 * Key bindings::                
93 * Alternate character sets::    
94 * Mail and news::               
95 * Concept index::               
96 @end menu
98 @c ------------------------------------------------------------
99 @node FAQ notation, General questions, Top, Top
100 @chapter FAQ notation
101 @cindex FAQ notation
103 This chapter describes notation used in the GNU Emacs FAQ, as well as in
104 the Emacs documentation.  Consult this section if this is the first time
105 you are reading the FAQ, or if you are confused by notation or terms
106 used in the FAQ.
108 @menu
109 * Basic keys::                  
110 * Extended commands::           
111 * On-line manual::              
112 * File-name conventions::        
113 * Common acronyms::             
114 @end menu
116 @node Basic keys, Extended commands, FAQ notation, FAQ notation
117 @section What do these mean: @kbd{C-h}, @kbd{M-C-a}, @key{RET}, @kbd{@key{ESC} a}, etc.?
118 @cindex Basic keys
119 @cindex Control key, notation for
120 @cindex @key{Meta} key, notation for
121 @cindex Control-Meta characters, notation for
122 @cindex @kbd{C-h}, definition of
123 @cindex @kbd{M-C-h}, definition of
124 @cindex @key{DEL}, definition of
125 @cindex @key{ESC}, definition of
126 @cindex @key{LFD}, definition of
127 @cindex @key{RET}, definition of
128 @cindex @key{SPC}, definition of
129 @cindex @key{TAB}, definition of
130 @cindex Notation for keys
132 @itemize @bullet
134 @item
135 @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key
137 @item
138 @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key
139 (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key})
141 @item
142 @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control}
143 and @key{Meta}
145 @item
146 @kbd{C-M-x}: a synonym for the above
148 @item
149 @key{LFD}: Linefeed or Newline; same as @kbd{C-j}
151 @item
152 @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m}
154 @item
155 @key{DEL}: @key{Delete}, usually @strong{not} the same as
156 @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if
157 deleting invokes Emacs help)
159 @item
160 @key{ESC}: Escape; same as @kbd{C-[}
162 @item
163 @key{TAB}: Tab; same as @kbd{C-i}
165 @item
166 @key{SPC}: Space bar
168 @end itemize
170 Key sequences longer than one key (and some single-key sequences) are
171 written inside quotes or on lines by themselves, like this:
173 @display
174   @kbd{M-x frobnicate-while-foo RET}
175 @end display
177 @noindent
178 Any real spaces in such a key sequence should be ignored; only @key{SPC}
179 really means press the space key.
181 The ASCII code sent by @kbd{C-x} (except for @kbd{C-?}) is the value
182 that would be sent by pressing just @key{x} minus 96 (or 64 for
183 upper-case @key{X}) and will be from 0 to 31.  On Unix and GNU/Linux
184 terminals, the ASCII code sent by @kbd{M-x} is the sum of 128 and the
185 ASCII code that would be sent by pressing just @key{x}.  Essentially,
186 @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit
187 7@footnote{
188 DOS and Windows terminals don't set bit 7 when the @key{Meta} key is
189 pressed.}.
191 @kbd{C-?} (aka @key{DEL}) is ASCII code 127.  It is a misnomer to call
192 @kbd{C-?}  a ``control'' key, since 127 has both bits 5 and 6 turned ON.
193 Also, on very few keyboards does @kbd{C-?} generate ASCII code 127.
195 @inforef{Text Characters, Text Characters, emacs}, and @inforef{Keys,
196 Keys, emacs}, for more information.  (@xref{On-line manual}, for more
197 information about Info.)
199 @node Extended commands, On-line manual, Basic keys, FAQ notation
200 @section What does @file{M-x @var{command}} mean?
201 @cindex Extended commands
202 @cindex Commands, extended
203 @cindex M-x, meaning of
205 @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
206 command, then type @key{RET}.  (@xref{Basic keys}, if you're not sure
207 what @kbd{M-x} and @key{RET} mean.)
209 @kbd{M-x} (by default) invokes the command
210 @code{execute-extended-command}.  This command allows you to run any
211 Emacs command if you can remember the command's name.  If you can't
212 remember the command's name, you can type @key{TAB} and @key{SPC} for
213 completion, @key{?} for a list of possibilities, and @kbd{M-p} and
214 @kbd{M-n} (or up-arrow and down-arrow on terminals that have these
215 editing keys) to see previous commands entered.  An Emacs @dfn{command}
216 is an @dfn{interactive} Emacs function.
218 @cindex @key{Do} key
219 Your system administrator may have bound other key sequences to invoke
220 @code{execute-extended-command}.  A function key labeled @kbd{Do} is a
221 good candidate for this, on keyboards that have such a key.
223 If you need to run non-interactive Emacs functions, see @ref{Evaluating
224 Emacs Lisp code}.
226 @node On-line manual, File-name conventions, Extended commands, FAQ notation
227 @section How do I read topic XXX in the on-line manual?
228 @cindex On-line manual, reading topics in
229 @cindex Reading topics in the on-line manual
230 @cindex Finding topics in the on-line manual
231 @cindex Info, finding topics in
233 When we refer you to some @var{topic} in the on-line manual, you can
234 read this manual node inside Emacs (assuming nothing is broken) by
235 typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}.
237 This invokes Info, the GNU hypertext documentation browser.  If you don't
238 already know how to use Info, type @key{?} from within Info.
240 If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs
241 @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}.
243 If these commands don't work as expected, your system administrator may
244 not have installed the Info files, or may have installed them
245 improperly.  In this case you should complain.
247 @xref{Getting a printed manual}, if you would like a paper copy of the
248 Emacs manual.
250 @node File-name conventions, Common acronyms, On-line manual, FAQ notation
251 @section What are @file{etc/SERVICE}, @file{src/config.h}, and @file{lisp/default.el}?
252 @cindex File-name conventions
253 @cindex Conventions for file names
254 @cindex Directories and files that come with Emacs
256 These are files that come with Emacs.  The Emacs distribution is divided
257 into subdirectories; the important ones are @file{etc}, @file{lisp}, and
258 @file{src}.
260 If you use Emacs, but don't know where it is kept on your system, start
261 Emacs, then type @kbd{C-h v data-directory @key{RET}}.  The directory
262 name displayed by this will be the full pathname of the installed
263 @file{etc} directory.  (This full path is recorded in the Emacs variable
264 @code{data-directory}, and @kbd{C-h v} displays the value and the
265 documentation of a variable.)
267 The location of your Info directory (i.e., where on-line documentation
268 is stored) is kept in the variable @code{Info-default-directory-list}.  Use
269 @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of
270 this variable, which will be a list of directory names.  The last
271 directory in that list is probably where most Info files are stored.  By
272 default, Info documentation is placed in @file{/usr/local/info}.
274 Some of these files are available individually via FTP or e-mail; see
275 @ref{Informational files for Emacs}.  They all are available in the
276 source distribution.  Many of the files in the @file{etc} directory are
277 also available via the Emacs @samp{Help} menu, or by typing @kbd{C-h ?}
278 (@kbd{M-x help-for-help}).
280 Your system administrator may have removed the @file{src} directory and
281 many files from the @file{etc} directory.
283 @node Common acronyms,  , File-name conventions, FAQ notation
284 @section What are FSF, LPF, OSF, GNU, RMS, FTP, and GPL?
285 @cindex FSF, definition of
286 @cindex LPF, definition of
287 @cindex OSF, definition of
288 @cindex GNU, definition of
289 @cindex RMS, definition of
290 @cindex Stallman, Richard, acronym for
291 @cindex Richard Stallman, acronym for
292 @cindex FTP, definition of
293 @cindex GPL, definition of
294 @cindex Acronyms, definitions for
295 @cindex Common acronyms, definitions for
297 @table @asis
299 @item FSF
300 Free Software Foundation
302 @item LPF
303 League for Programming Freedom
305 @item OSF
306 Open Software Foundation
308 @item GNU
309 GNU's Not Unix
311 @item RMS
312 Richard Matthew Stallman
314 @item FTP
315 File Transfer Protocol
317 @item GPL
318 GNU General Public License
320 @end table
322 Avoid confusing the FSF, the LPF, and the OSF.  The LPF opposes
323 look-and-feel copyrights and software patents.  The FSF aims to make
324 high quality free software available for everyone.  The OSF is a
325 consortium of computer vendors which develops commercial software for
326 Unix systems.
328 The word ``free'' in the title of the Free Software Foundation refers to
329 ``freedom,'' not ``zero dollars.''  Anyone can charge any price for
330 GPL-covered software that they want to.  However, in practice, the
331 freedom enforced by the GPL leads to low prices, because you can always
332 get the software for less money from someone else, since everyone has
333 the right to resell or give away GPL-covered software.
335 @c ------------------------------------------------------------
336 @node    General questions, Getting help, FAQ notation, Top
337 @chapter General questions
338 @cindex General questions
340 This chapter contains general questions having to do with Emacs, the
341 Free Software Foundation, and related organizations.
343 @menu
344 * The LPF::                     
345 * Real meaning of copyleft::    
346 * Guidelines for newsgroup postings::  
347 * Newsgroup archives::          
348 * Reporting bugs::              
349 * Unsubscribing from Emacs lists::  
350 * Contacting the FSF::          
351 @end menu
353 @node The LPF, Real meaning of copyleft, General questions, General questions
354 @section What is the LPF?
355 @cindex LPF, description of
356 @cindex League for Programming Freedom
357 @cindex Software patents, opposition to
358 @cindex Patents for software, opposition to
360 The LPF opposes the expanding danger of software patents and
361 look-and-feel copyrights.  To get more information, feel free to contact
362 the LPF via e-mail or otherwise.  You may also contact
363 @email{jbw@@cs.bu.edu, Joe Wells}; he will be happy to talk to you
364 about the LPF.
366 You can find more information about the LPF in the file @file{etc/LPF}.
367 More papers describing the LPF's views are available on the Internet and
368 also from @uref{http://lpf.ai.mit.edu/, the LPF home page}.
370 @node Real meaning of copyleft, Guidelines for newsgroup postings, The LPF, General questions
371 @section What is the real legal meaning of the GNU copyleft?
372 @cindex Copyleft, real meaning of
373 @cindex GPL, real meaning of
374 @cindex General Public License, real meaning of
375 @cindex Discussion of the GPL
377 The real legal meaning of the GNU General Public License (copyleft) will
378 only be known if and when a judge rules on its validity and scope.
379 There has never been a copyright infringement case involving the GPL to
380 set any precedents.  Please take any discussion regarding this issue to
381 the newsgroup @uref{news:gnu.misc.discuss}, which was created to hold the
382 extensive flame wars on the subject.
384 RMS writes:
386 @quotation
387 The legal meaning of the GNU copyleft is less important than the spirit,
388 which is that Emacs is a free software project and that work pertaining
389 to Emacs should also be free software.  ``Free'' means that all users
390 have the freedom to study, share, change and improve Emacs.  To make
391 sure everyone has this freedom, pass along source code when you
392 distribute any version of Emacs or a related program, and give the
393 recipients the same freedom that you enjoyed.
394 @end quotation
396 @node Guidelines for newsgroup postings, Newsgroup archives, Real meaning of copyleft, General questions
397 @section  What are appropriate messages for @uref{news:gnu.emacs.help}, @uref{news:gnu.emacs.bug}, @uref{news:comp.emacs}, etc.?
398 @cindex Newsgroups, appropriate messages for
399 @cindex GNU newsgroups, appropriate messages for
400 @cindex Usenet groups, appropriate messages for
401 @cindex Mailing lists, appropriate messages for
402 @cindex Posting messages to newsgroups
404 @cindex GNU mailing lists
405 The file @file{etc/MAILINGLISTS} describes the purpose of each GNU
406 mailing list.  (@xref{Informational files for Emacs}, if you want a copy
407 of the file.)  For those lists which are gatewayed with newsgroups, it
408 lists both the newsgroup name and the mailing list address.
410 The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs
411 in general.  This includes Emacs along with various other
412 implementations, such as XEmacs, JOVE, MicroEmacs, Freemacs, MG,
413 Unipress, CCA, and Epsilon.
415 Many people post Emacs questions to @uref{news:comp.emacs} because they
416 don't receive any of the @code{gnu.*} newsgroups.  Arguments have been
417 made both for and against posting GNU-Emacs-specific material to
418 @uref{news:comp.emacs}.  You have to decide for yourself.
420 Messages advocating ``non-free'' software are considered unacceptable on
421 any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss},
422 which was created to hold the extensive flame-wars on the subject.
423 ``Non-free'' software includes any software for which the end user can't
424 freely modify the source code and exchange enhancements.  Be careful to
425 remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when
426 posting a followup that recommends such software.
428 @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid
429 posting bug reports to this newsgroup directly (@pxref{Reporting bugs}).
431 @node Newsgroup archives, Reporting bugs, Guidelines for newsgroup postings, General questions
432 @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups?
433 @cindex Archived postings from @uref{news:gnu.emacs.help}
434 @cindex Usenet archives for GNU groups
435 @cindex Old Usenet postings for GNU groups
437 The FSF has maintained archives of all of the GNU mailing lists for many
438 years, although there may be some unintentional gaps in coverage.  The
439 archive is not particularly well organized or easy to retrieve
440 individual postings from, but pretty much everything is there.
442 The archive is at @uref{ftp://ftp-mailing-list-archives.gnu.org}.
444 As of this writing, the archives are not yet working.
446 Web-based Usenet search services, such as
447 @uref{http://www.dejanews.com, DejaNews}, also archive the
448 @code{gnu.*} groups.
450 @node Reporting bugs, Unsubscribing from Emacs lists, Newsgroup archives, General questions
451 @section Where should I report bugs and other problems with Emacs?
452 @cindex Bug reporting
453 @cindex Good bug reports
454 @cindex How to submit a bug report
455 @cindex Reporting bugs
457 The correct way to report Emacs bugs is by e-mail to
458 @email{bug-gnu-emacs@@gnu.org}.  Anything sent here also appears in the
459 newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of
460 news to submit the bug report.  This ensures a reliable return address
461 so you can be contacted for further details.
463 Be sure to read the ``Bugs'' section of the Emacs manual before reporting
464 a bug to bug-gnu-emacs!  The manual describes in detail how to submit a
465 useful bug report.  (@xref{On-line manual}, if you don't know how to read the
466 manual.)
468 RMS says:
470 @quotation
471 Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the
472 effect of posting on @uref{news:gnu.emacs.help}) is undesirable because
473 it takes the time of an unnecessarily large group of people, most of
474 whom are just users and have no idea how to fix these problem.
475 @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people
476 who are more likely to know what to do and have expressed a wish to
477 receive more messages about Emacs than the others.
478 @end quotation
480 RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}:
482 @quotation
483 If you have reported a bug and you don't hear about a possible fix,
484 then after a suitable delay (such as a week) it is okay to post on
485 @code{gnu.emacs.help} asking if anyone can help you.
486 @end quotation
488 If you are unsure whether you have found a bug, consider the following
489 non-exhaustive list, courtesy of RMS:
491 @quotation
492 If Emacs crashes, that is a bug.  If Emacs gets compilation errors
493 while building, that is a bug.  If Emacs crashes while building, that
494 is a bug.  If Lisp code does not do what the documentation says it
495 does, that is a bug.
496 @end quotation
498 @node Unsubscribing from Emacs lists, Contacting the FSF, Reporting bugs, General questions
499 @section  How do I unsubscribe from this mailing list?
500 @cindex Unsubscribing from GNU mailing lists
501 @cindex Removing yourself from GNU mailing lists
503 If you are receiving a GNU mailing list named @var{list}, you might be
504 able to unsubscribe from it by sending a request to the address
505 @email{@var{list}-request@@gnu.org}.  However, this will not work if you are
506 not listed on the main mailing list, but instead receive the mail from a
507 distribution point.  In that case, you will have to track down at which
508 distribution point you are listed.  Inspecting the @samp{Received} headers
509 on the mail messages may help, along with liberal use of the @samp{EXPN} or
510 @samp{VRFY} sendmail commands through @samp{telnet @var{site-address}
511 smtp}.  Ask your postmaster for help, if you cannot figure out these
512 details.
514 @node Contacting the FSF,  , Unsubscribing from Emacs lists, General questions
515 @section  What is the current address of the FSF?
516 @cindex Snail mail address of the FSF
517 @cindex Postal address of the FSF
518 @cindex Contracting the FSF
519 @cindex Free Software Foundation, contacting
521 @table @asis
523 @item E-mail
524 gnu@@gnu.org
526 @item Telephone
527 +1-617-542-5942
529 @item Fax
530 +1-617-542-2652
532 @item World Wide Web
533 @uref{http://www.gnu.org/}
535 @item Postal address
536 Free Software Foundation@*
537 59 Temple Place - Suite 330@*
538 Boston, MA 02111-1307@*
539 USA@*
541 @end table
543 @cindex Ordering GNU software
544 For details on how to order items directly from the FSF, see the
545 @uref{http://www.gnu.org/order/order.html, GNU Web site}, and also the
546 files @file{etc/ORDERS}, @file{ORDERS.EUROPE}, and @file{ORDERS.JAPAN}.
548 @c ------------------------------------------------------------
549 @node Getting help, Status of Emacs, General questions, Top
550 @chapter Getting help
551 @cindex Getting help
553 This chapter tells you how to get help with Emacs
555 @menu
556 * Basic editing::               
557 * Learning how to do something::  
558 * Getting a printed manual::    
559 * Emacs Lisp documentation::    
560 * Installing Texinfo documentation::  
561 * Printing a Texinfo file::     
562 * Viewing Info files outside of Emacs::  
563 * Informational files for Emacs::  
564 * Help installing Emacs::       
565 * Obtaining the FAQ::           
566 @end menu
568 @node Basic editing, Learning how to do something, Getting help, Getting help
569 @section I'm just starting Emacs; how do I do basic editing?
570 @cindex Basic editing with Emacs
571 @cindex Beginning editing
572 @cindex Tutorial, invoking the
573 @cindex Self-paced tutorial, invoking the
574 @cindex Help system, entering the
576 Type @kbd{C-h t} to invoke the self-paced tutorial.  Just typing @kbd{C-h}
577 enters the help system.
579 Your system administrator may have changed @kbd{C-h} to act like
580 @key{DEL} to deal with local keyboards.  You can use @kbd{M-x
581 help-for-help} instead to invoke help.  To discover what key (if any)
582 invokes help on your system, type @kbd{M-x where-is @key{RET}
583 help-for-help @key{RET}}.  This will print a comma-separated list of key
584 sequences in the echo area.  Ignore the last character in each key
585 sequence listed.  Each of the resulting key sequences invokes help.
587 Emacs help works best if it is invoked by a single key whose value
588 should be stored in the variable @code{help-char}.
590 There is also a WWW-based tutorial for Emacs 18, much of which is also
591 relevant for later versions of Emacs, available at
593 @uref{http://kufacts.cc.ukans.edu/cwis/writeups/misc/emacsguide.html}
595 @node Learning how to do something, Getting a printed manual, Basic editing, Getting help
596 @section How do I find out how to do something in Emacs?
597 @cindex Help for Emacs
598 @cindex Learning to do something in Emacs
599 @cindex Reference card for Emacs
600 @cindex Overview of help systems
602 There are several methods for finding out how to do things in Emacs.
604 @itemize @bullet
606 @cindex Reading the Emacs manual
607 @item
608 The complete text of the Emacs manual is available on-line via the Info
609 hypertext reader.  Type @kbd{C-h i} to invoke Info.  Typing @key{h}
610 immediately after entering Info will provide a short tutorial on how to
611 use it.
613 @cindex Lookup a subject in a manual
614 @cindex Index search in a manual
615 @item
616 To quickly locate the section of the manual which discusses a certain
617 issue, or describes a command or a variable, type @kbd{C-h i m emacs
618 @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the
619 topic, the command, or the variable which you are looking for.  If this
620 does not land you on the right place in the manual, press @kbd{,}
621 (comma) repeatedly until you find what you need.  (The @kbd{i} and
622 @kbd{,} keys invoke the index-searching functions, which look for the
623 @var{topic} you type in all the indices of the Emacs manual.)
625 @cindex Apropos
626 @item
627 You can list all of the commands whose names contain a certain word
628 (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x
629 command-apropos}).
631 @cindex Command description in the manual
632 @item
633 The command @kbd{C-h C-f} (@code{Info-goto-emacs-command-node}) prompts
634 for the name of a command, and then attempts to find the section in the
635 Emacs manual where that command is described.
637 @cindex Finding commands and variables
638 @item
639 You can list all of the functions and variables whose names contain a
640 certain word using @kbd{M-x apropos}.
642 @item
643 You can list all of the functions and variables whose documentation
644 matches a regular expression or a string, using @kbd{M-x
645 apropos-documentation}.
647 @item
648 You can order a hardcopy of the manual from the FSF.  @xref{Getting a
649 printed manual}.
651 @cindex Reference cards, in other languages
652 @item
653 You can get a printed reference card listing commands and keys to
654 invoke them.  You can order one from the FSF for $1 (or 10 for $5),
655 or you can print your own from the @file{etc/refcard.tex} or
656 @file{etc/refcard.ps} files in the Emacs distribution.  Beginning with
657 version 21.1, the Emacs distribution comes with translations of the
658 reference card into several languages; look for files named
659 @file{etc/@var{lang}-refcard.*}, where @var{lang} is a two-letter code
660 of the language.  For example, the German version of the reference card
661 is in the files @file{etc/de-refcard.tex} and @file{etc/de-refcard.ps}.
663 @item
664 There are many other commands in Emacs for getting help and
665 information.  To get a list of these commands, type @samp{?} after
666 @kbd{C-h}.
668 @end itemize
670 @node Getting a printed manual, Emacs Lisp documentation, Learning how to do something, Getting help
671 @section How do I get a printed copy of the Emacs manual?
672 @cindex Printed Emacs manual, obtaining
673 @cindex Manual, obtaining a printed copy of
674 @cindex Emacs manual, obtaining a printed copy of
676 You can order a printed copy of the Emacs manual from the FSF.  For
677 details see the @uref{http://www.gnu.org/order/order.html, GNU Web site}
678 and the file @file{etc/ORDERS}.
680 @c The number 620 below is version-dependent!
681 The full Texinfo source for the manual also comes in the @file{man}
682 directory of the Emacs distribution, if you're daring enough to try to
683 print out this 620-page manual yourself (@pxref{Printing a Texinfo
684 file}).
686 If you absolutely have to print your own copy, and you don't have @TeX{},
687 you can get a PostScript version from
689 @uref{http://www.gnu.org/manual/emacs/ps/emacs.ps.gz}
691 An HTML version of the manual is at
693 @uref{www.gnu.org/manual/emacs/index.html}
695 @xref{Learning how to do something}, for how to view the manual on-line.
697 @node Emacs Lisp documentation, Installing Texinfo documentation, Getting a printed manual, Getting help
698 @section Where can I get documentation on Emacs Lisp?
699 @cindex Documentation on Emacs Lisp
700 @cindex Function documentation
701 @cindex Variable documentation
702 @cindex Emacs Lisp Reference Manual
703 @cindex Reference manual for Emacs Lisp
705 Within Emacs, you can type @kbd{C-h f} to get the documentation for a
706 function, @kbd{C-h v} for a variable.
708 For more information, obtain the Emacs Lisp Reference Manual.  Details
709 on ordering it from FSF are on the
710 @uref{http://www.gnu.org/order/order.html, GNU Web site} and in the file
711 @file{etc/ORDERS}.
713 The Emacs Lisp Reference Manual is also available on-line, in Info
714 format.  Texinfo source for the manual (along with pregenerated Info
715 files) is available at
717 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/elisp-manual-21-2.6.tar.gz}
719 and all mirrors of @samp{ftp.gnu.org} (for a list, @pxref{Current GNU
720 distributions}).  @xref{Installing Texinfo documentation}, if you want
721 to install the Info files, or @ref{Printing a Texinfo file}, if you want
722 to use the Texinfo source to print the manual yourself.
724 An HTML version of the Emacs Lisp Reference Manual is available at
726 @uref{http://www.gnu.org/manual/elisp-manual-21-2.6/elisp.html}
728 @node Installing Texinfo documentation, Printing a Texinfo file, Emacs Lisp documentation, Getting help
729 @section How do I install a piece of Texinfo documentation?
730 @cindex Texinfo documentation, installing
731 @cindex Installing Texinfo documentation
732 @cindex New Texinfo files, installing
733 @cindex Documentation, installing new Texinfo files
734 @cindex Info files, how to install
736 First, you must turn the Texinfo files into Info files.  You may do this
737 using the stand-alone @file{makeinfo} program, available as part of the latest
738 Texinfo package at
740 @uref{ftp://ftp.gnu.org/pub/gnu/texinfo/texinfo-4.0.tar.gz}
742 and all mirrors of @samp{ftp.gnu.org} (for a list, @pxref{Current GNU
743 distributions}).
745 For information about the Texinfo format, read the Texinfo manual which
746 comes with the Texinfo package.  This manual also comes installed in
747 Info format, so you can read it on-line; type @kbd{C-h i m texinfo
748 @key{RET}}.
750 Alternatively, you could use the Emacs command @kbd{M-x
751 texinfo-format-buffer}, after visiting the Texinfo source file of the
752 manual you want to convert.
754 Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the
755 resulting Info files in Emacs's Info tree.  To install Info files,
756 perform these steps:
758 @enumerate
759 @item
760 Move the files to the @file{info} directory in the installed Emacs
761 distribution.  @xref{File-name conventions}, if you don't know where that
764 @item
765 Run the @code{install-info} command, which is part of the Texinfo
766 distribution, to update the main Info directory menu, like this:
768 @example
769  install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file}
770 @end example
772 @noindent
773 where @var{dir-path} is the full path to the directory where you copied
774 the produced Info file(s), and @var{file} is the name of the Info file
775 you produced and want to install.
777 If you don't have the @code{install-info} command installed, you can
778 edit the file @file{info/dir} in the installed Emacs distribution, and
779 add a line for the top level node in the Info package that you are
780 installing.  Follow the examples already in this file.  The format is:
782 @example
783 * Topic: (relative-pathname).  Short description of topic.
784 @end example
786 @end enumerate 
788 If you want to install Info files and you don't have the necessary
789 privileges, you have several options:
791 @itemize @bullet
792 @item
793 Info files don't actually need to be installed before being used.  You
794 can feed a file name to the @code{Info-goto-node} command (invoked by
795 pressing @key{g} in Info mode) by typing the name of the file in
796 parentheses.  This goes to the node named ``Top'' in that file.  For
797 example, to view a Info file named @file{@var{info-file}} in your home
798 directory, you can type this:
800 @example
801 @kbd{C-h i g (~/@var{info-file}) @key{RET}}
802 @end example
804 @item
805 You can create your own Info directory.  You can tell Emacs where that
806 Info directory is by adding its pathname to the value of the variable
807 @code{Info-default-directory-list}.  For example, to use a private Info
808 directory which is a subdirectory of your home directory named @file{Info},
809 you could put this in your @file{.emacs} file:
811 @lisp
812 (setq Info-default-directory-list
813       (cons "~/Info" Info-default-directory-list))
814 @end lisp
816 You will need a top-level Info file named @file{dir} in this directory
817 which has everything the system @file{dir} file has in it, except it should
818 list only entries for Info files in that directory.  You might not need
819 it if all files in this directory were referenced by other @file{dir}
820 files.  The node lists from all @file{dir} files in
821 @code{Info-default-directory-list} are merged by the Info system.
823 @end itemize
825 @node Printing a Texinfo file, Viewing Info files outside of Emacs, Installing Texinfo documentation, Getting help
826 @section How do I print a Texinfo file?
827 @cindex Printing a Texinfo file
828 @cindex Texinfo file, printing
829 @cindex Printing documentation
831 You can't get nicely printed output from Info files; you must still have
832 the original Texinfo source file for the manual you want to print.
834 Assuming you have @TeX{} installed on your system, follow these steps:
836 @enumerate
838 @item
839 Make sure the first line of the Texinfo file looks like this:
841 @example
842 \input texinfo
843 @end example
845 You may need to change @samp{texinfo} to the full pathname of the
846 @file{texinfo.tex} file, which comes with Emacs as
847 @file{man/texinfo.tex} (or copy or link it into the current directory).
849 @item
850 Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is
851 the name of the Texinfo source file for which you want to produce a
852 printed copy.
854 The @samp{texi2dvi} script is part of the GNU Texinfo distribution
855 (@pxref{Installing Texinfo documentation}).
857 @item
858 Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for
859 printing DVI files at your site.  For example, if you have a PostScript
860 printer, run the @code{dvips} program to print the DVI file on that
861 printer.
863 @end enumerate
865 To get more general instructions, retrieve the latest Texinfo package
866 (@pxref{Installing Texinfo documentation}).
868 @node Viewing Info files outside of Emacs, Informational files for Emacs, Printing a Texinfo file, Getting help
869 @section Can I view Info files without using Emacs?
870 @cindex Viewing Info files
871 @cindex Info file viewers
872 @cindex Alternative Info file viewers
874 Yes.  Here are some alternative programs:
876 @itemize @bullet
878 @item
879 @code{info}, a stand-alone version of the Info program, comes as part of
880 the Texinfo package.  @xref{Installing Texinfo documentation}, for
881 details.
883 @item
884 Xinfo, a stand-alone version of the Info program that runs under X
885 Window system.  You can get it at
886 @uref{ftp://ftp.gnu.org/pub/gnu/xinfo/xinfo-1.01.01.tar.gz} and all
887 mirrors of @samp{ftp.gnu.org} (see @ref{Current GNU distributions}, for a
888 list of mirrors).
890 @item
891 Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk.
892 You can get Tkinfo at
893 @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}.
895 @end itemize
897 @node Informational files for Emacs, Help installing Emacs, Viewing Info files outside of Emacs, Getting help
898 @section What informational files are available for Emacs?
899 @cindex Informational files included with Emacs
900 @cindex Files included with Emacs
901 @cindex @file{COPYING}, description of file
902 @cindex @file{DISTRIB}, description of file
903 @cindex @file{FTP}, description of file
904 @cindex @file{GNU}, description of file
905 @cindex @file{INTERVIEW}, description of file
906 @cindex @file{LPF}, description of file
907 @cindex @file{MACHINES}, description of file
908 @cindex @file{MAILINGLISTS}, description of file
909 @cindex @file{NEWS}, description of file
910 @cindex @file{SERVICE}, description of file
911 @cindex @file{SUN-SUPPORT}, description of file
913 This isn't a frequently asked question, but it should be!  A variety of
914 informational files about Emacs and relevant aspects of the GNU project
915 are available for you to read.
917 The following files are available in the @file{etc} directory of the
918 Emacs distribution (see @ref{File-name conventions}, if you're not sure
919 where that is).
921 @table @file
923 @item COPYING
924 Emacs General Public License
926 @item DISTRIB
927 Emacs Availability Information, including the popular "Free Software
928 Foundation Order Form"
930 @item FTP
931 How to get GNU Software by Internet FTP or by UUCP
933 @item GNU
934 The GNU Manifesto
936 @item INTERVIEW
937 Richard Stallman discusses his public-domain UNIX-compatible software
938 system with BYTE editors
940 @item LPF
941 Why you should join the League for Programming Freedom
943 @item MACHINES
944 Status of Emacs on Various Machines and Systems
946 @item MAILINGLISTS
947 GNU Project Electronic Mailing Lists
949 @item NEWS
950 Emacs news, a history of recent user-visible changes
952 @item SERVICE
953 GNU Service Directory
955 @item SUN-SUPPORT
956 including "Using Emacstool with GNU Emacs"
958 @end table
960 Latest versions of the above files also available at
962 @uref{ftp://ftp.gnu.org/pub/gnu/GNUinfo/}
964 More GNU information, including back issues of the @cite{GNU's
965 Bulletin}, are at
967 @uref{http://www.gnu.org/bulletins/bulletins.html} and
969 @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html}
971 @node Help installing Emacs, Obtaining the FAQ, Informational files for Emacs, Getting help
972 @section Where can I get help in installing Emacs?
973 @cindex Installation help
974 @cindex Help installing Emacs
976 @xref{Installing Emacs}, for some basic installation hints, and see
977 @ref{Problems building Emacs}, or @ref{Linking with -lX11 fails}, if you
978 have problems with the installation.
980 The file @file{etc/SERVICE} (see @ref{File-name conventions}, if you're
981 not sure where that is) lists companies and individuals willing to sell
982 you help in installing or using Emacs.  An up-to-date version this file
983 is available on @samp{ftp.gnu.org} (@pxref{Informational files for
984 Emacs}).
986 @node Obtaining the FAQ,  , Help installing Emacs, Getting help
987 @section Where can I get the latest version of this FAQ?
988 @cindex FAQ, obtaining the
989 @cindex Latest FAQ version, obtaining the
990 @cindex Retrieving the latest FAQ version
991 @cindex E-mail, retrieving the FAQ via
992 @cindex Web, reading the FAQ on the
994 The Emacs FAQ is available in several ways:
996 @itemize @bullet
998 @item
999 Inside of Emacs itself.  You can get it from selecting the @samp{Emacs
1000 FAQ} option from the @samp{Help} menu of the Emacs menu bar at the top
1001 of any Emacs frame, or by typing @kbd{C-h F} (@kbd{M-x view-emacs-FAQ}).
1003 @item
1004 Via USENET.  If you can read news, the FAQ should be available in your
1005 news spool, in both the @uref{news:gnu.emacs.help} and
1006 @uref{news:comp.emacs} newsgroups.  Every news reader should allow you
1007 to read any news article that is still in the news spool, even if you
1008 have read the article before.  You may need to read the instructions for
1009 your news reader to discover how to do this.  In @file{rn}, this command
1010 will do this for you at the article selection level:
1012 @example
1013 ?GNU Emacs Frequently Asked Questions?rc:m
1014 @end example
1016 In Gnus, you should type @kbd{C-u C-x C-s} from the @file{*Summary*}
1017 buffer or @kbd{C-u @key{SPC}} from the @file{*Newsgroup*} buffer to view
1018 all articles in a newsgroup.
1020 If the FAQ articles have expired and have been deleted from your news
1021 spool, it might (or might not) do some good to complain to your news
1022 administrator, because the most recent FAQ should not expire for a
1023 while.
1025 @item
1026 Via HTTP or FTP.  You can always fetch the latest FAQ from
1028 @uref{http://www.lerner.co.il/emacs/} and
1030 @uref{ftp://ftp.lerner.co.il/pub/emacs/}
1032 @item
1033 In the Emacs distribution.  Since Emacs 18.56, the FAQ at the time
1034 of release has been part of the Emacs distribution as either
1035 @file{etc/FAQ} or @file{man/faq.texi} (@pxref{File-name conventions}).
1037 @item
1038 Via the World Wide Web.  A hypertext version is available at
1040 @uref{http://www.lerner.co.il/emacs/}
1042 @item
1043 Via anonymous ftp and e-mail from @file{rtfm.mit.edu} (and its mirror in
1044 Europe), the main repository for FAQs and other items posted to
1045 news.answers.  The Emacs FAQs are available at
1047 @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/} and
1049 @uref{ftp://ftp.uni-paderborn.de/pub/doc/FAQ/comp/emacs/}
1051 If you do not have access to anonymous FTP, you can access the archives
1052 using the @file{rtfm.mit.edu} mail server.  The Emacs FAQ can be
1053 retrieved by sending mail to @email{mail-server@@rtfm.mit.edu} with a
1054 blank subject and containing
1056 @example
1057 send usenet/news.answers/GNU-Emacs-FAQ/diffs
1058 send usenet/news.answers/GNU-Emacs-FAQ/part1
1059 send usenet/news.answers/GNU-Emacs-FAQ/part2
1060 send usenet/news.answers/GNU-Emacs-FAQ/part3
1061 send usenet/news.answers/GNU-Emacs-FAQ/part4
1062 send usenet/news.answers/GNU-Emacs-FAQ/part5
1063 @end example
1065 For more information, send email to @email{mail-server@@rtfm.mit.edu}
1066 with "help" and "index" in the body on separate lines.
1068 @item
1069 As the very last resort, you can e-mail a request to
1070 @email{emacs-faq@@lerner.co.il}.  Don't do this unless you have made a
1071 good-faith effort to obtain the FAQ list via one of the methods listed
1072 above.
1074 @end itemize
1076 @c ------------------------------------------------------------
1077 @node    Status of Emacs, Common requests, Getting help, Top
1078 @chapter Status of Emacs
1079 @cindex Status of Emacs
1081 This chapter gives you basic information about Emacs, including its
1082 latest version status.
1084 @menu
1085 * Origin of the term Emacs::    
1086 * Latest version of Emacs::     
1087 * New in Emacs 20::             
1088 * New in Emacs 21::            
1089 @end menu
1091 @node Origin of the term Emacs, Latest version of Emacs, Status of Emacs, Status of Emacs
1092 @section Where does the name ``Emacs'' come from?
1093 @cindex Origin of the term ``Emacs''
1094 @cindex Emacs name origin
1095 @cindex TECO
1096 @cindex Original version of Emacs
1098 Emacs originally was an acronym for Editor MACroS.  RMS says he ``picked
1099 the name Emacs because @key{E} was not in use as an abbreviation on ITS at
1100 the time.''  The first Emacs was a set of macros written in 1976 at MIT
1101 by RMS for the editor TECO (Text Editor and COrrector, originally Tape
1102 Editor and COrrector) under ITS on a PDP-10.  RMS had already extended
1103 TECO with a ``real-time'' full-screen mode with reprogrammable keys.
1104 Emacs was started by @email{gls@@east.sun.com, Guy Steele} as a project
1105 to unify the many divergent TECO command sets and key bindings at MIT,
1106 and completed by RMS.
1108 Many people have said that TECO code looks a lot like line noise; you
1109 can read more at @uref{news:alt.lang.teco}.  Someone has written a TECO
1110 implementation in Emacs Lisp (to find it, see @ref{Packages that do not
1111 come with Emacs}); it would be an interesting project to run the
1112 original TECO Emacs inside of Emacs.
1114 @cindex Why Emacs?
1115 For some not-so-serious alternative reasons for Emacs to have that
1116 name, check out the file @file{etc/JOKES} (@pxref{File-name
1117 conventions}).
1119 @node Latest version of Emacs, New in Emacs 20, Origin of the term Emacs, Status of Emacs
1120 @section What is the latest version of Emacs?
1121 @cindex Version, latest
1122 @cindex Latest version of Emacs
1124 Emacs @value{VER} is the current version as of this writing.
1126 @node New in Emacs 20,  New in Emacs 21, Latest version of Emacs, Status of Emacs
1127 @section What is different about Emacs 20?
1128 @cindex Differences between Emacs 19 and Emacs 20
1129 @cindex Emacs 20, new features in
1131 To find out what has changed in recent versions, type @kbd{C-h n}
1132 (@kbd{M-x view-emacs-news}).  The oldest changes are at the bottom of
1133 the file, so you might want to read it starting there, rather than at
1134 the top.
1136 The differences between Emacs versions 18 and 19 was rather dramatic;
1137 the introduction of frames, faces, and colors on windowing systems was
1138 obvious to even the most casual user.
1140 There are differences between Emacs versions 19 and 20 as well, but many
1141 are more subtle or harder to find.  Among the changes are the inclusion
1142 of MULE code for languages that use non-Latin characters and for mixing
1143 several languages in the same document; the ``Customize'' facility for
1144 modifying variables without having to use Lisp; and automatic conversion
1145 of files from Macintosh, Microsoft, and Unix platforms.
1147 A number of older Lisp packages, such as Gnus, Supercite and the
1148 calendar/diary, have been updated and enhanced to work with Emacs 20,
1149 and are now included with the standard distribution.
1152 @node New in Emacs 21, , New in Emacs 20, Status of Emacs
1153 @section What is different about Emacs 21?
1154 @cindex Differences between Emacs 20 and Emacs 21
1155 @cindex Emacs 21, new features in
1156 @cindex Recently introduced features
1158 @cindex Variable-size fonts
1159 @cindex Toolbar support
1160 Emacs 21 features a thorough rewrite of the display engine.  The new
1161 display engine supports variable-size fonts, images, and can play sounds
1162 on platforms which support that.  As a result, the visual appearence of
1163 Emacs, when it runs on a windowed display, is much more reminiscent of
1164 modern GUI programs, and includes 3D widgets (used for the mode line and
1165 the scroll bars), a configurable and extensible toolbar, tooltips
1166 (a.k.a.@: balloon help), and other niceties.
1168 @cindex Colors on text-only terminals
1169 @cindex TTY colors
1170 In addition, Emacs 21 supports faces on text-only terminals.  This means
1171 that you can now have colors when you run Emacs on a GNU/Linux console
1172 and on @code{xterm} with @kbd{emacs -nw}.
1174 @c ------------------------------------------------------------
1175 @node    Common requests, Bugs and problems, Status of Emacs, Top
1176 @chapter Common requests
1177 @cindex Common requests
1179 @menu
1180 * Setting up a customization file::  
1181 * Debugging a customization file::  
1182 * Colors on a TTY::  
1183 * Displaying the current line or column::  
1184 * Displaying the current file name in the titlebar::  
1185 * Turning on abbrevs by default::  
1186 * Turning on auto-fill by default::  
1187 * Associating modes with files::  
1188 * Working with unprintable characters::  
1189 * Highlighting a region::       
1190 * Controlling case sensitivity::  
1191 * Wrapping words automatically::  
1192 * Spell-checkers::              
1193 * Checking TeX and *roff documents::  
1194 * Changing load-path::          
1195 * Using an already running Emacs process::  
1196 * Compiler error messages::     
1197 * Indenting switch statements::  
1198 * Customizing C and C++ indentation::  
1199 * Horizontal scrolling::        
1200 * Overwrite mode::              
1201 * Turning off beeping::         
1202 * Turning the volume down::     
1203 * Automatic indentation::       
1204 * Matching parentheses::        
1205 * Hiding #ifdef lines::         
1206 * Repeating commands::          
1207 * Valid X resources::           
1208 * Evaluating Emacs Lisp code::  
1209 * Changing the length of a Tab::  
1210 * Inserting > at the beginning of each line::  
1211 * Underlining paragraphs::      
1212 * Repeating a command as many times as possible::  
1213 * Forcing the cursor to remain in the same column::  
1214 * Forcing Emacs to iconify itself::  
1215 * Using regular expressions::   
1216 * Replacing text across multiple files::  
1217 * Documentation for etags::     
1218 * Disabling backups::           
1219 * Disabling auto-save-mode::    
1220 * Going to a line by number::   
1221 * Modifying pull-down menus::   
1222 * Deleting menus and menu options::  
1223 * Turning on syntax highlighting::  
1224 * Scrolling only one line::     
1225 * Replacing highlighted text::  
1226 * Editing MS-DOS files::        
1227 * Filling paragraphs with a single space::  
1228 * Escape sequences in shell output::   
1229 @end menu
1231 @node Setting up a customization file, Colors on a TTY, Common requests, Common requests
1232 @section How do I set up a @file{.emacs} file properly?
1233 @cindex @file{.emacs} file, setting up
1234 @cindex Init file, setting up
1235 @cindex Customization file, setting up
1237 @inforef{Init File, Init File, emacs}
1239 In general, new Emacs users should not have @file{.emacs} files, because
1240 it causes confusing non-standard behavior.  Then they send questions to
1241 @email{help-gnu-emacs@@gnu.org} asking why Emacs isn't behaving as
1242 documented.
1244 Beginning with version 20.1, Emacs includes the new Customize
1245 facility, which can be invoked using @kbd{M-x customize @key{RET}}.
1246 This allows users who are unfamiliar with Emacs Lisp to modify their
1247 @file{.emacs} files in a relatively straightforward way, using menus
1248 rather than Lisp code.  Not all packages support Customize as of this
1249 writing, but the number is growing fairly steadily.
1251 While Customize might indeed make it easier to configure Emacs,
1252 consider taking a bit of time to learn Emacs Lisp and modifying your
1253 @file{.emacs} directly.  Simple configuration options are described
1254 rather completely in @inforef{Init File, Init File, emacs}, for users
1255 interested in performing frequently requested, basic tasks.
1257 @node Colors on a TTY, Debugging a customization file, Setting up a customization file, Common requests
1258 @section How do I get colors and syntax highlighting on a TTY?
1259 @cindex Colors on a TTY
1260 @cindex Syntax highlighting on a TTY
1261 @cindex Console, colors
1263 As of Emacs 21.1, colors and faces are supported in non-windowed mode,
1264 i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when
1265 invoked as @samp{emacs -nw} on X and MS-Windows.  (Colors and faces were
1266 supported in the MS-DOS port since Emacs 19.29.)  Emacs automatically
1267 detects color support at startup and uses it if available.  If you think
1268 that your terminal supports colors, but Emacs won't use them, check the
1269 @code{termcap} entry for your display type for color-related
1270 capabilities.
1272 The command @kbd{M-x list-colors-display} pops up a window which
1273 exhibits all the colors Emacs knows about on the current display.
1275 Syntax highlighting is usually turned off by default; see @ref{Turning
1276 on syntax highlighting}, for instructions how to turn it on.
1278 @node Debugging a customization file, Displaying the current line or column, Colors on a TTY, Common requests
1279 @section How do I debug a @file{.emacs} file?
1280 @cindex Debugging @file{.emacs} file
1281 @cindex @file{.emacs} debugging
1282 @cindex Init file debugging
1283 @cindex @samp{-debug-init} option
1285 Start Emacs with the @samp{-debug-init} command-line option.  This
1286 enables the Emacs Lisp debugger before evaluating your @file{.emacs}
1287 file, and places you in the debugger if something goes wrong.  The top
1288 line in the @file{trace-back} buffer will be the error message, and the
1289 second or third line of that buffer will display the Lisp code from your
1290 @file{.emacs} file that caused the problem.
1292 You can also evaluate an individual function or argument to a function
1293 in your @file{.emacs} file by moving the cursor to the end of the
1294 function or argument and typing @kbd{C-x C-e} (@kbd{M-x
1295 eval-last-sexp}).
1297 Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of
1298 variables which you are trying to set or use.
1300 @node Displaying the current line or column, Displaying the current file name in the titlebar, Debugging a customization file, Common requests
1301 @section How do I make Emacs display the current line (or column) number?
1302 @cindex @code{line-number-mode}
1303 @cindex Displaying the current line or column
1304 @cindex Line number, displaying the current
1305 @cindex Column, displaying the current
1306 @cindex @code{mode-line-format}
1308 To have Emacs automatically display the current line number of the point
1309 in the mode line, do @kbd{M-x line-number-mode}.  You can also put the
1310 form
1312 @lisp
1313 (setq line-number-mode t)
1314 @end lisp
1316 @noindent
1317 in your @file{.emacs} file to achieve this whenever you start Emacs.
1318 (Line number display is on by default, unless your site-specific
1319 initialization disables it.) Note that Emacs will not display the line
1320 number if the buffer's size in bytes is larger than the value of the
1321 variable @code{line-number-display-limit}.
1323 As of Emacs 20, you can similarly display the current column with
1324 @kbd{M-x column-number-mode}, or by putting the form
1326 @lisp
1327 (setq column-number-mode t) 
1328 @end lisp
1330 @noindent
1331 in your @file{.emacs} file.
1333 The @code{"%c"} format specifier in the variable @code{mode-line-format}
1334 will insert the current column's value into the mode line.  See the
1335 documentation for @code{mode-line-format} (using @kbd{C-h v
1336 mode-line-format @key{RET}}) for more information on how to set and use
1337 this variable.
1339 Users of all Emacs versions can display the current column using the
1340 @samp{column} package written by @email{abraham@@dina.kvl.dk, Per
1341 Abrahamsen}.  @xref{Packages that do not come with Emacs}, for
1342 instructions on how to get it.
1344 @cindex Set number capability in @code{vi} emulators
1345 None of the @code{vi} emulation modes provide the ``set number''
1346 capability of @code{vi} (as far as we know).
1348 @node Displaying the current file name in the titlebar, Turning on abbrevs by default, Displaying the current line or column, Common requests
1349 @section How can I modify the titlebar to contain the current file name?
1350 @cindex Titlebar, displaying the current file name in
1351 @cindex File name, displaying in the titlebar
1352 @cindex @code{frame-title-format}
1354 The contents of an Emacs frame's titlebar is controlled by the variable
1355 @code{frame-title-format}, which has the same structure as the variable
1356 @code{mode-line-format}.  (Use @kbd{C-h v} or @kbd{M-x
1357 describe-variable} to get information about one or both of these
1358 variables.)
1360 By default, the titlebar for a frame does contain the name of the buffer
1361 currently being visited, except if there is a single frame.  In such a
1362 case, the titlebar contains Emacs invocation name and the name of the
1363 machine at which Emacs was invoked.  This is done by setting
1364 @code{frame-title-format} to the default value of
1366 @lisp
1367 (multiple-frames "%b" ("" invocation-name "@@" system-name))
1368 @end lisp
1370 To modify the behavior such that frame titlebars contain the buffer's
1371 name regardless of the number of existing frames, include the following
1372 in your @file{.emacs}:
1374 @lisp
1375 (setq frame-title-format "%b")
1376 @end lisp
1378 @node Turning on abbrevs by default, Turning on auto-fill by default, Displaying the current file name in the titlebar, Common requests
1379 @section How do I turn on abbrevs by default just in mode @var{mymode}?
1380 @cindex Abbrevs, turning on by default
1382 Put this in your @file{.emacs} file:
1384 @lisp
1385 (condition-case ()
1386    (quietly-read-abbrev-file)
1387   (file-error nil))
1389 (add-hook '@var{mymode}-mode-hook
1390           (lambda ()
1391            (setq abbrev-mode t)))
1392 @end lisp
1394 @node Turning on auto-fill by default, Associating modes with files, Turning on abbrevs by default, Common requests
1395 @section How do I turn on @code{auto-fill-mode} by default?
1396 @cindex @code{auto-fill-mode}, activating automatically
1397 @cindex Filling automatically
1398 @cindex Automatic entry to @code{auto-fill-mode}
1400 To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x
1401 auto-fill-mode}.
1403 To turn it on for every buffer in a certain mode, you must use the hook
1404 for that mode.  For example, to turn on @code{auto-fill} mode for all
1405 text buffers, including the following in your @file{.emacs} file:
1407 @lisp
1408 (add-hook 'text-mode-hook 'turn-on-auto-fill)
1409 @end lisp
1411 If you want @code{auto-fill} mode on in all major modes, do this:
1413 @lisp
1414 (setq-default auto-fill-function 'do-auto-fill)
1415 @end lisp
1417 @node Associating modes with files, Working with unprintable characters, Turning on auto-fill by default, Common requests
1418 @section How do I make Emacs use a certain major mode for certain files?
1419 @cindex Associating modes with files
1420 @cindex File extensions and modes
1421 @cindex @code{auto-mode-alist}, modifying
1422 @cindex Modes, associating with file extensions
1424 If you want to use a certain mode @var{foo} for all files whose names end
1425 with the extension @file{.@var{bar}}, this will do it for you:
1427 @lisp
1428 (setq auto-mode-alist (cons '("\\.@var{bar}\\'" . @var{foo}-mode) auto-mode-alist))
1429 @end lisp
1431 Otherwise put this somewhere in the first line of any file you want to
1432 edit in the mode @var{foo} (in the second line, if the first line begins
1433 with @samp{#!}):
1435 @example
1436 -*- @var{foo} -*-
1437 @end example
1439 @cindex Major mode for shell scripts
1440 Beginning with Emacs 19, the variable @code{interpreter-mode-alist}
1441 specifies which mode to use when loading a shell script.  (Emacs
1442 determines which interpreter you're using by examining the first line of
1443 the script.)  This feature only applies when the file name doesn't
1444 indicate which mode to use.  Use @kbd{C-h v} (or @kbd{M-x
1445 describe-variable}) on @code{interpreter-mode-alist} to learn more.
1447 @node Working with unprintable characters, Highlighting a region, Associating modes with files, Common requests
1448 @section How do I search for, delete, or replace unprintable (eight-bit or control) characters?
1449 @cindex Unprintable characters, working with
1450 @cindex Working with unprintable characters
1451 @cindex Control characters, working with
1452 @cindex Eight-bit characters, working with
1453 @cindex Searching for unprintable characters
1454 @cindex Regexps and unprintable characters
1456 To search for a single character that appears in the buffer as, for
1457 example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}.  (This assumes
1458 the value of @code{search-quote-char} is 17 (i.e., @kbd{C-q}).)
1459 Searching for @strong{all} unprintable characters is best done with a
1460 regular expression (@dfn{regexp}) search.  The easiest regexp to use for
1461 the unprintable chars is the complement of the regexp for the printable
1462 chars.
1464 @itemize @bullet
1466 @item
1467 Regexp for the printable chars: @samp{[\t\n\r\f -~]}
1469 @item
1470 Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]}
1472 @end itemize
1474 To type these special characters in an interactive argument to
1475 @code{isearch-forward-regexp} or @code{re-search-forward}, you need to
1476 use @kbd{C-q}.  (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand
1477 respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.)  So,
1478 to search for unprintable characters using @code{re-search-forward}:
1480 @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}}
1482 Using @code{isearch-forward-regexp}:
1484 @kbd{M-C-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]}
1486 To delete all unprintable characters, simply use replace-regexp:
1488 @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}}
1490 Replacing is similar to the above.  To replace all unprintable
1491 characters with a colon, use:
1493 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}
1495 @itemize @bullet
1497 @item
1498 You don't need to quote @key{TAB} with either isearch or typing
1499 something in the minibuffer.
1501 @end itemize
1503 @node Highlighting a region, Controlling case sensitivity, Working with unprintable characters, Common requests
1504 @section How can I highlight a region of text in Emacs?
1505 @cindex Highlighting text
1506 @cindex Text, highlighting
1507 @cindex @code{transient-mark-mode}
1508 @cindex Region, highlighting a
1510 You can cause the region to be highlighted when the mark is active by
1511 including
1513 @lisp
1514 (transient-mark-mode t)
1515 @end lisp
1517 @noindent
1518 in your @file{.emacs} file.  (Also see @ref{Turning on syntax
1519 highlighting}.)
1521 @node Controlling case sensitivity, Wrapping words automatically, Highlighting a region, Common requests
1522 @section How do I control Emacs's case-sensitivity when searching/replacing?
1523 @cindex @code{case-fold-search}
1524 @cindex Case sensitivity of searches
1525 @cindex Searching without case sensitivity
1526 @cindex Ignoring case in searches
1528 For searching, the value of the variable @code{case-fold-search}
1529 determines whether they are case sensitive:
1531 @lisp
1532 (setq case-fold-search nil) ; make searches case sensitive
1533 (setq case-fold-search t)   ; make searches case insensitive
1534 @end lisp
1536 @cindex Case sensitivity in replacements
1537 @cindex Replacing, and case sensitivity
1538 @cindex @code{case-replace}
1539 Similarly, for replacing, the variable @code{case-replace} determines
1540 whether replacements preserve case.
1542 To change the case sensitivity just for one major mode, use the major
1543 mode's hook.  For example:
1545 @lisp
1546 (add-hook '@var{foo}-mode-hook
1547           (lambda ()
1548            (setq case-fold-search nil)))
1549 @end lisp
1551 @node Wrapping words automatically, Spell-checkers, Controlling case sensitivity, Common requests
1552 @section How do I make Emacs wrap words for me?
1553 @cindex Wrapping word automatically
1554 @cindex Wrapping lines
1555 @cindex Line wrap
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 Spell-checkers, Checking TeX and *roff documents, Wrapping words automatically, Common requests
1566 @section Where can I get a better spelling checker for Emacs?
1567 @cindex Checking spelling
1568 @cindex Spelling, checking text documents
1570 Use Ispell.  @xref{Ispell}.
1572 @node Checking TeX and *roff documents, Changing load-path, Spell-checkers, Common requests
1573 @section How can I spell-check @TeX{} or *roff documents?
1574 @cindex Spelling, checking @TeX{} documents
1575 @cindex @TeX{} documents, checking spelling in
1577 Use Ispell.  Ispell can handle @TeX{} and *roff documents.
1578 @xref{Ispell}.
1580 @node Changing load-path, Using an already running Emacs process, Checking TeX and *roff documents, Common requests
1581 @section How do I change @code{load-path}?
1582 @cindex @code{load-path}, modifying
1583 @cindex Modifying @code{load-path}
1584 @cindex Adding to @code{load-path}
1586 In general, you should only add to the @code{load-path}.  You can add
1587 directory @var{/dir/subdir} to the load path like this:
1589 @lisp
1590 (setq load-path (cons "/dir/subdir/" load-path))
1591 @end lisp
1593 To do this relative to your home directory:
1595 @lisp
1596 (setq load-path (cons "~/mysubdir/" load-path)
1597 @end lisp
1599 @node Using an already running Emacs process, Compiler error messages, Changing load-path, Common requests
1600 @section How do I use an already running Emacs from another window?
1601 @cindex @code{emacsclient}
1602 @cindex Emacs server functions
1603 @cindex Using an existing Emacs process
1605 @code{emacsclient}, which comes with Emacs, is for editing a file using
1606 an already running Emacs rather than starting up a new Emacs.  It does
1607 this by sending a request to the already running Emacs, which must be
1608 expecting the request.
1610 @itemize @bullet
1612 @item
1613 Setup:
1615 Emacs must have executed the @code{server-start} function for
1616 @samp{emacsclient} to work.  This can be done either by a command line
1617 option:
1619 @example
1620 emacs -f server-start
1621 @end example
1623 or by invoking @code{server-start} from @file{.emacs}:
1625 @lisp
1626 (if (@var{some conditions are met}) (server-start))
1627 @end lisp
1629 When this is done, Emacs starts a subprocess running a program called
1630 @samp{emacsserver}.  @samp{emacsserver} creates a Unix domain socket.
1631 The socket is either named @file{.emacs_server}, in the user's home directory,
1632 or @file{esrv-@var{userid}-@var{systemname}}, in the @file{/tmp}
1633 directory, depending on how @samp{emacsserver} was compiled.
1635 To get your news reader, mail reader, etc., to invoke
1636 @samp{emacsclient}, try setting the environment variable @code{EDITOR}
1637 (or sometimes @code{VISUAL}) to the value @samp{emacsclient}.  You may
1638 have to specify the full pathname of the @samp{emacsclient} program
1639 instead.  Examples:
1641 @example
1642 # csh commands:
1643 setenv EDITOR emacsclient
1645 # using full pathname
1646 setenv EDITOR /usr/local/emacs/etc/emacsclient  
1648 # sh command:
1649 EDITOR=emacsclient ; export EDITOR
1650 @end example
1652 @item
1653 Normal use:
1655 When @samp{emacsclient} is run, it connects to the @file{.emacs_server}
1656 socket and passes its command line options to @samp{server}.  When
1657 @samp{server} receives these requests, it sends this information to the
1658 the Emacs process, which at the next opportunity will visit the files
1659 specified.  (Line numbers can be specified just like with Emacs.)  The
1660 user will have to switch to the Emacs window by hand.  When the user is
1661 done editing a file, the user can type @kbd{C-x #} (or @kbd{M-x
1662 server-edit}) to indicate this.  If there is another buffer requested by
1663 @code{emacsclient}, Emacs will switch to it; otherwise
1664 @code{emacsclient} will exit, signaling the calling program to continue.
1666 @samp{emacsclient} and @samp{server} must be running on machines which
1667 share the same filesystem for this to work.  The pathnames that
1668 @samp{emacsclient} specifies should be correct for the filesystem that
1669 the Emacs process sees.  The Emacs process should not be suspended at
1670 the time @samp{emacsclient} is invoked.  On Unix and GNU/Linux systems,
1671 @samp{emacsclient} should either be invoked from another X window, or
1672 from a shell window inside Emacs itself, or from another interactive
1673 session, e.g., by means of a @code{screen} program.
1675 @cindex @code{gnuserv}
1676 There is an enhanced version of @samp{emacsclient}/server called
1677 @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman}
1678 which is available in the Emacs Lisp Archive (@pxref{Packages that do
1679 not come with Emacs}).  @samp{gnuserv} uses Internet domain sockets, so
1680 it can work across most network connections.  It also supports the
1681 execution of arbitrary Emacs Lisp forms and does not require the client
1682 program to wait for completion.
1684 The alpha version of an enhanced @samp{gnuserv} is available at
1686 @uref{ftp://ftp.wellfleet.com/netman/psmith/emacs/gnuserv-2.1alpha.tar.gz}
1688 @end itemize
1690 @node Compiler error messages, Indenting switch statements, Using an already running Emacs process, Common requests
1691 @section How do I make Emacs recognize my compiler's funny error messages?
1692 @cindex Compiler error messages, recognizing
1693 @cindex Recognizing non-standard compiler errors
1694 @cindex Regexps for recognizing compiler errors
1695 @cindex Errors, recognizing compiler
1697 The variable @code{compilation-error-regexp-alist} helps control how
1698 Emacs parses your compiler output.  It is a list of triplets of the form:
1699 @code{(@var{regexp} @var{file-idx} @var{line-idx})}, where @var{regexp},
1700 @var{file-idx} and @var{line-idx} are strings.  To help determine what
1701 the constituent elements should be, load @file{compile.el} and then type
1702 @kbd{C-h v compilation-error-regexp-alist @key{RET}} to see the current
1703 value.  A good idea is to look at @file{compile.el} itself as the
1704 comments included for this variable are quite useful---the regular
1705 expressions required for your compiler's output may be very close to one
1706 already provided.  Once you have determined the proper regexps, use the
1707 following to inform Emacs of your changes:
1709 @lisp
1710 (setq compilation-error-regexp-alist
1711       (cons '(@var{regexp} @var{file-idx} @var{line-idx})
1712          compilation-error-regexp-alist))
1713 @end lisp
1715 @node Indenting switch statements, Customizing C and C++ indentation, Compiler error messages, Common requests
1716 @section How do I change the indentation for @code{switch}?
1717 @cindex @code{switch}, indenting
1718 @cindex Indenting of @code{switch}
1720 Many people want to indent their @code{switch} statements like this:
1722 @example
1725   switch(x) @{
1726     case A:
1727       x1;
1728       break;
1729     case B:
1730       x2;
1731       break;
1732     default:
1733       x3;
1734   @}
1736 @end example
1738 The solution at first appears to be: set @code{c-indent-level} to 4 and
1739 @code{c-label-offset} to -2.  However, this will give you an indentation
1740 spacing of four instead of two.
1742 The @emph{real} solution is to use @code{cc-mode} (the default mode for
1743 C programming in Emacs 20 and later) and add the following line to yoyr
1744 @file{.emacs}:
1746 @lisp
1747 (c-set-offset 'case-label '+)
1748 @end lisp
1750 There appears to be no way to do this with the old @code{c-mode}.
1752 @node Customizing C and C++ indentation, Horizontal scrolling, Indenting switch statements, Common requests
1753 @section How to customize indentation in C, C@t{++}, and Java buffers?
1754 @cindex Indentation, how to customize
1755 @cindex Customize indentation
1757 The Emacs @code{cc-mode} features an interactive procedure for
1758 customizing the indentation style, which is fully explained in the
1759 @cite{CC Mode} manual that is part of the Emacs distribution, see
1760 @ref{Customizing Indentation, , Customization Indentation, ccmode,
1761 The CC Mode Manual}.  Here's a short summary of the procedure:
1763 @enumerate
1764 @item
1765 Go to the beginning of the first line where you don't like the
1766 indentation and type @kbd{C-c C-o}.  Emacs will prompt you for the
1767 syntactic symbol; type @key{RET} to accept the default it suggests.
1769 @item
1770 Emacs now prompts for the offset of this syntactic symbol, showing the
1771 default (the current definition) inside parentheses.  You can choose
1772 one of these:
1774 @table @code
1775 @item 0
1776 No extra indentation.
1777 @item +
1778 Indent one basic offset.
1779 @item -
1780 Outdent one basic offset.
1781 @item ++
1782 Indent two basic offsets
1783 @item --
1784 Outdent two basic offsets.
1785 @item *
1786 Indent half basic offset.
1787 @item /
1788 Outdent half basic offset.
1789 @end table
1791 @item
1792 After choosing one of these symbols, type @kbd{C-c C-q} to reindent
1793 the line or the block according to what you just specified.
1795 @item
1796 If you don't like the result, go back to step 1.  Otherwise, add the
1797 following line to your @file{.emacs}:
1799 @lisp
1800 (c-set-offset '@var{syntactic-symbol} @var{offset})
1801 @end lisp
1803 @noindent
1804 where @var{syntactic-symbol} is the name Emacs shows in the minibuffer
1805 when you type @kbd{C-c C-o} at the beginning of the line, and
1806 @var{offset} is one of the indentation symbols listed above (@code{+},
1807 @code{/}, @code{0}, etc.) that you've chosen during the interactive
1808 procedure.
1810 @item
1811 Go to the next line whose indentation is not to your liking and repeat
1812 the process there.
1813 @end enumerate
1815 It is recommended to put all the resulting @code{(c-set-offset ...)}
1816 customizations inside a C mode hook, like this:
1818 @lisp
1819 (defun my-c-mode-hook ()
1820   (c-set-offset ...)
1821   (c-set-offset ...))
1822 (add-hook 'c-mode-hook 'my-c-mode-hook)
1823 @end lisp
1825 @noindent
1826 Using @code{c-mode-hook} avoids the need to put a @w{@code{(require
1827 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset}
1828 might be unavailable when @code{cc-mode} is not loaded.
1830 Note that @code{c-mode-hook} runs for C source files only; use
1831 @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for
1832 Java sources, etc.  If you want the same customizations to be in
1833 effect in @emph{all} languages supported by @code{cc-mode}, use
1834 @code{c-mode-common-hook}.
1836 @node Horizontal scrolling, Overwrite mode, Customizing C and C++ indentation, Common requests
1837 @section How can I make Emacs automatically scroll horizontally?
1838 @cindex @code{hscroll-mode}
1839 @cindex Horizontal scrolling
1840 @cindex Scrolling horizontally
1842 In Emacs 21 and later, this is on by default: if the variable
1843 @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs
1844 automatically scrolls the display horizontally when point moves off the
1845 left or right edge of the window.
1847 In Emacs 20, use the @code{hscroll-mode}.  Here is some information from
1848 the documentation, available by typing @kbd{C-h f hscroll-mode @key{RET}}:
1850 Automatically scroll horizontally when the point moves off the
1851 left or right edge of the window.  
1853 @itemize @minus
1854 @item
1855 Type @kbd{M-x hscroll-mode} to enable it in the current buffer.
1857 @item
1858 Type @kbd{M-x hscroll-global-mode} to enable it in every buffer.
1860 @item
1861 @code{turn-on-hscroll} is useful in mode hooks as in:
1863 @lisp
1864 (add-hook 'text-mode-hook 'turn-on-hscroll)
1865 @end lisp
1867 @item
1868 @code{hscroll-margin} controls how close the cursor can get to the
1869 edge of the window. 
1871 @item
1872 @code{hscroll-step-percent} controls how far to jump once we decide to do so.
1873 @end itemize
1875 @node Overwrite mode, Turning off beeping, Horizontal scrolling, Common requests
1876 @section How do I make Emacs "typeover" or "overwrite" instead of inserting?
1877 @cindex @key{Insert}
1878 @cindex @code{overwrite-mode}
1879 @cindex Overwriting existing text
1880 @cindex Toggling @code{overwrite-mode}
1882 @kbd{M-x overwrite-mode} (a minor mode).  This toggles
1883 @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode}
1884 is as easy as another @kbd{M-x overwrite-mode}.
1886 On some systems, @key{Insert} toggles @code{overwrite-mode} on and off.
1888 @node Turning off beeping, Turning the volume down, Overwrite mode, Common requests
1889 @section How do I stop Emacs from beeping on a terminal?
1890 @cindex Beeping, turning off
1891 @cindex Visible bell
1892 @cindex Bell, visible
1894 @email{martin@@cc.gatech.edu, Martin R. Frank} writes:
1896 Tell Emacs to use the @dfn{visible bell} instead of the audible bell,
1897 and set the visible bell to nothing.
1899 That is, put the following in your @code{TERMCAP} environment variable
1900 (assuming you have one):
1902 @example
1903 ... :vb=: ...                    
1904 @end example
1906 And evaluate the following Lisp form:
1908 @example
1909 (setq visible-bell t)
1910 @end example
1912 @node Turning the volume down, Automatic indentation, Turning off beeping, Common requests
1913 @section How do I turn down the bell volume in Emacs running under X?
1914 @cindex Bell, volume of
1915 @cindex Volume of bell
1917 On X Window system, you can adjust the bell volume and duration for all
1918 programs with the shell command @code{xset}.
1920 Invoking @code{xset} without any arguments produces some basic
1921 information, including the following:
1923 @example
1924 usage:  xset [-display host:dpy] option ...
1925   To turn bell off:
1926       -b                b off               b 0
1927   To set bell volume, pitch and duration:
1928        b [vol [pitch [dur]]]          b on
1929 @end example
1931 @node Automatic indentation, Matching parentheses, Turning the volume down, Common requests
1932 @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line?
1933 @cindex Indenting new lines
1934 @cindex New lines, indenting of
1935 @cindex Previous line, indenting according to
1936 @cindex Text indentation
1938 Such behavior is automatic in Emacs 20 and later.  From the
1939 @file{etc/NEWS} file for Emacs 20.2:
1941 @example
1942 ** In Text mode, now only blank lines separate paragraphs.  This makes
1943 it possible to get the full benefit of Adaptive Fill mode in Text mode,
1944 and other modes derived from it (such as Mail mode).  @key{TAB} in Text
1945 mode now runs the command @code{indent-relative}; this makes a practical
1946 difference only when you use indented paragraphs.
1948 As a result, the old Indented Text mode is now identical to Text mode,
1949 and is an alias for it.
1951 If you want spaces at the beginning of a line to start a paragraph, use
1952 the new mode, Paragraph Indent Text mode.
1953 @end example
1955 @cindex Prefixing lines
1956 @cindex Fill prefix
1957 If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill
1958 by default}), you can tell Emacs to prefix every line with a certain
1959 character sequence, the @dfn{fill prefix}.  Type the prefix at the
1960 beginning of a line, position point after it, and then type @kbd{C-x .}
1961 (@code{set-fill-prefix}) to set the fill prefix.  Thereafter,
1962 auto-filling will automatically put the fill prefix at the beginning of
1963 new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill
1964 prefix when refilling the paragraph.
1966 If you have paragraphs with different levels of indentation, you will
1967 have to set the fill prefix to the correct value each time you move to a
1968 new paragraph.  To avoid this hassle, try one of the many packages
1969 available from the Emacs Lisp Archive (@pxref{Packages that do not come
1970 with Emacs}.)  Look up ``fill'' and ``indent'' in the Lisp Code
1971 Directory for guidance.
1973 @node Matching parentheses, Hiding #ifdef lines, Automatic indentation, Common requests
1974 @section How do I show which parenthesis matches the one I'm looking at?
1975 @cindex Parentheses, matching
1976 @cindex @file{paren.el}
1977 @cindex Highlighting matching parentheses
1978 @cindex Pairs of parentheses, highlighting
1979 @cindex Matching parentheses
1981 As of version 19, Emacs comes with @file{paren.el}, which (when loaded)
1982 will automatically highlight matching parentheses whenever point (i.e.,
1983 the cursor) is located over one.  To load @file{paren.el} automatically,
1984 include the line
1986 @lisp
1987 (require 'paren)
1988 @end lisp
1990 in your @file{.emacs} file.  @email{shutkoa@@ugsolutions.com, Alan Shutko}
1991 reports that as of version 20.1, you must also call @code{show-paren-mode} in
1992 your @file{.emacs} file:
1994 @lisp
1995 (show-paren-mode 1)
1996 @end lisp
1998 Customize will let you turn on @code{show-paren-mode}.  Use @kbd{M-x
1999 customize-group @key{RET} paren-showing @key{RET}}.  From within
2000 Customize, you can also go directly to the ``paren-showing'' group.
2002 Alternatives to paren include:
2004 @itemize @bullet
2006 @item
2007 If you're looking at a right parenthesis (or brace or bracket) you can
2008 delete it and reinsert it.  Emacs will momentarily move the cursor to
2009 the matching parenthesis.
2011 @item
2012 @kbd{M-C-f} (@code{forward-sexp}) and @kbd{M-C-b} (@code{backward-sexp})
2013 will skip over one set of balanced parentheses, so you can see which
2014 parentheses match.  (You can train it to skip over balanced brackets
2015 and braces at the same time by modifying the syntax table.)
2017 @cindex Show matching paren as in @code{vi}
2018 @item
2019 Here is some Emacs Lisp that will make the @key{%} key show the matching
2020 parenthesis, like in @code{vi}.  In addition, if the cursor isn't over a
2021 parenthesis, it simply inserts a % like normal.
2023 @lisp
2024 ;; By an unknown contributor
2026 (global-set-key "%" 'match-paren)
2028 (defun match-paren (arg)
2029   "Go to the matching paren if on a paren; otherwise insert %."
2030   (interactive "p")
2031   (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1))
2032         ((looking-at "\\s\)") (forward-char 1) (backward-list 1))
2033         (t (self-insert-command (or arg 1)))))
2034 @end lisp
2036 @end itemize
2038 @node Hiding #ifdef lines, Repeating commands, Matching parentheses, Common requests
2039 @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler?
2040 @cindex @code{#ifdef}, selective display of
2041 @cindex @code{hide-ifdef-mode}
2042 @cindex Hiding @code{#ifdef} text
2043 @cindex Selectively displaying @code{#ifdef} code
2045 @kbd{M-x hide-ifdef-mode}.  (This is a minor mode.)  You might also want
2046 to try @file{cpp.el}, available at the Emacs Lisp Archive
2047 (@pxref{Packages that do not come with Emacs}).
2049 @node Repeating commands, Valid X resources, Hiding #ifdef lines, Common requests
2050 @section Is there an equivalent to the @code{.} (dot) command of vi?
2051 @cindex Repeating commands as with @code{vi}
2052 @cindex Command, repeat last
2053 @cindex @code{.}, equivalent to @code{vi} command
2055 (@code{.} is the redo command in @code{vi}.  It redoes the last
2056 insertion/deletion.)
2058 As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z})
2059 that repeats the last command.  If you preface it with a prefix
2060 argument, the prefix arg is applied to the command.
2062 You can also type @kbd{C-x @key{ESC} @key{ESC}}
2063 (@code{repeat-complex-command}) to reinvoke commands that used the
2064 minibuffer to get arguments.  In @code{repeat-complex-command} you can
2065 type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your
2066 keyboard has these keys) to scan through all the different complex
2067 commands you've typed.
2069 To repeat a set of commands, use keyboard macros.  (@inforef{Keyboard
2070 Macros, Keyboard Macros, emacs}.)
2072 If you're really desperate for the @code{.} command, use VIPER, a
2073 @code{vi} emulation mode which comes with Emacs, and which appears to
2074 support it.  (@xref{VIPER}.)
2076 @node Valid X resources, Evaluating Emacs Lisp code, Repeating commands, Common requests
2077 @section What are the valid X resource settings (i.e., stuff in .Xdefaults)?
2078 @cindex Resources, X
2079 @cindex X resources
2080 @cindex Setting X resources
2082 @inforef{Resources X, Resources X, emacs}.
2084 You can also use a resource editor, such as editres (for X11R5 and
2085 onwards), to look at the resource names for the menu bar, assuming Emacs
2086 was compiled with the X toolkit.
2088 @node Evaluating Emacs Lisp code, Changing the length of a Tab, Valid X resources, Common requests
2089 @section How do I execute ("evaluate") a piece of Emacs Lisp code?
2090 @cindex Evaluating Lisp code
2091 @cindex Lisp forms, evaluating
2093 There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an
2094 Emacs Lisp @dfn{form}:
2096 @itemize @bullet
2098 @item
2099 If you want it evaluated every time you run Emacs, put it in a file
2100 named @file{.emacs} in your home directory.  This is known as ``your
2101 @file{.emacs} file,'' and contains all of your personal customizations.
2103 @item
2104 You can type the form in the @file{*scratch*} buffer, and then type
2105 @key{LFD} (or @kbd{C-j}) after it.  The result of evaluating the form
2106 will be inserted in the buffer.
2108 @item
2109 In @code{emacs-lisp-mode}, typing @kbd{M-C-x} evaluates a top-level form
2110 before or around point.
2112 @item
2113 Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately
2114 before point and prints its value in the echo area.
2116 @item
2117 Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp
2118 form in the minibuffer which will be evaluated once you press @key{RET}.
2120 @item
2121 You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp
2122 forms in a file.  (To do this from Lisp use the function @code{load}
2123 instead.)
2125 The functions @code{load-library}, @code{eval-region},
2126 @code{eval-current-buffer}, @code{require}, and @code{autoload} are also
2127 useful; see @ref{Emacs Lisp documentation}, if you want to learn more
2128 about them.
2130 @end itemize
2132 @node Changing the length of a Tab, Inserting > at the beginning of each line, Evaluating Emacs Lisp code, Common requests
2133 @section How do I change Emacs's idea of the @key{TAB} character's length?
2134 @cindex Tab length
2135 @cindex Length of tab character
2136 @cindex @code{default-tab-width} 
2138 Set the variable @code{default-tab-width}.  For example, to set
2139 @key{TAB} stops every 10 characters, insert the following in your
2140 @file{.emacs} file:
2142 @lisp
2143 (setq default-tab-width 10)
2144 @end lisp
2146 Do not confuse variable @code{tab-width} with variable
2147 @code{tab-stop-list}.  The former is used for the display of literal
2148 @key{TAB} characters.  The latter controls what characters are inserted
2149 when you press the @key{TAB} character in certain modes.
2151 @node Inserting > at the beginning of each line, Underlining paragraphs, Changing the length of a Tab, Common requests
2152 @section How do I insert @samp{>} at the beginning of every line?
2153 @cindex Prefix character, inserting in mail/news replies
2154 @cindex Replies to mail/news, inserting a prefix character
2155 @cindex @code{mail-yank-prefix}
2156 @cindex Mail replies, inserting a prefix character
2157 @cindex News replies, inserting a prefix character
2159 To do this to an entire buffer, type @kbd{M-< M-x replace-regexp
2160 @key{RET} ^ @key{RET} > @key{RET}}.
2162 To do this to a region, use @code{string-insert-rectangle}.
2163 Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you
2164 want to prefix, move the cursor to last line to be prefixed, and type
2165 @kbd{M-x string-insert-rectangle @key{RET}}.  To do this for the whole
2166 buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}.
2168 If you are trying to prefix a yanked mail message with @samp{>}, you
2169 might want to set the variable @code{mail-yank-prefix}.  Better yet, use
2170 the Supercite package (@pxref{Supercite}), which provides flexible
2171 citation for yanked mail and news messages; it is included in Emacs
2172 since version 19.20.  @xref{Changing the included text prefix}, for
2173 additional information.
2175 @node Underlining paragraphs, Repeating a command as many times as possible, Inserting > at the beginning of each line, Common requests
2176 @section How do I insert "_^H" before each character in a region to get an underlined paragraph?
2177 @cindex Underlining a region of text
2178 @cindex @code{underline-region}
2180 Mark the region and then type @kbd{M-x underline-region @key{RET}}.
2182 @node Repeating a command as many times as possible, Forcing the cursor to remain in the same column, Underlining paragraphs, Common requests
2183 @section How do I repeat a command as many times as possible?
2184 @cindex Repeating commands many times
2185 @cindex Commands, repeating many times
2187 Use @kbd{C-x (} and @kbd{C-x )} to make a keyboard macro that invokes
2188 the command and then type @kbd{M-0 C-x e}.
2190 Any messages your command prints in the echo area will be suppressed.
2192 If you need to repeat a command a small number of times, you can use
2193 @kbd{C-x z}, see @ref{Repeating commands}.
2195 @node Forcing the cursor to remain in the same column, Forcing Emacs to iconify itself, Repeating a command as many times as possible, Common requests
2196 @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?
2197 @cindex @code{picture-mode}
2198 @cindex Remaining in the same column, regardless of contents
2199 @cindex Vertical movement in empty documents
2201 @kbd{M-x picture-mode}.
2203 @node Forcing Emacs to iconify itself, Using regular expressions, Forcing the cursor to remain in the same column, Common requests
2204 @section How do I tell Emacs to iconify itself?
2205 @cindex Iconification under the X Window System
2206 @cindex X Window System and iconification
2207 @cindex Suspending Emacs
2209 @kbd{C-z} iconifies Emacs when running under X and suspends Emacs
2210 otherwise.  @inforef{Misc X, Misc X, emacs}.
2212 @node Using regular expressions, Replacing text across multiple files, Forcing Emacs to iconify itself, Common requests
2213 @section How do I use regexps (regular expressions) in Emacs?
2214 @cindex Regexps
2215 @cindex Regular expressions
2216 @cindex Differences between Unix and Emacs regexps
2217 @cindex Unix regeps, differences from Emacs
2218 @cindex Text strings, putting regexps in
2220 @inforef{Regexps, Regexps, emacs}.
2222 The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators
2223 are @samp{\(} and @samp{\)}.  Also, the string syntax for a backslash is
2224 @samp{\\}.  To specify a regular expression like @samp{xxx\(foo\|bar\)}
2225 in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}.
2227 Note the doubled backslashes!
2229 @itemize @bullet
2231 @item
2232 Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set
2233 (@samp{[^...]})  can match a newline character (@key{LFD} a.k.a.@:
2234 @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the
2235 characters not to match.
2237 @item
2238 The character syntax regexps (e.g., @samp{\sw}) are not
2239 meaningful inside character set regexps (e.g., @samp{[aeiou]}).  (This
2240 is actually typical for regexp syntax.)
2242 @end itemize
2244 @node Replacing text across multiple files, Documentation for etags, Using regular expressions, Common requests
2245 @section How do I perform a replace operation across more than one file?
2246 @cindex Replacing strings across files
2247 @cindex Multiple files, replacing across
2248 @cindex Files, replacing strings across multiple
2250 The ``tags'' feature of Emacs includes the command
2251 @code{tags-query-replace} which performs a query-replace across all the
2252 files mentioned in the @file{TAGS} file.  @inforef{Tags Search, Tags Search,
2253 emacs}.
2255 As of Emacs 19.29, Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x
2256 d}) supports the command @code{dired-do-query-replace}, which allows
2257 users to replace regular expressions in multiple files.
2259 @node Documentation for etags, Disabling backups, Replacing text across multiple files, Common requests
2260 @section Where is the documentation for @code{etags}?
2261 @cindex Documentation for @code{etags}
2262 @cindex @code{etags}, documentation for
2264 The @code{etags} man page should be in the same place as the
2265 @code{emacs} man page.
2267 Quick command-line switch descriptions are also available.  For example,
2268 @samp{etags -H}.
2270 @node Disabling backups, Disabling auto-save-mode, Documentation for etags, Common requests
2271 @section How do I disable backup files?
2272 @cindex Backups, disabling
2273 @cindex Disabling backups
2275 You probably don't want to do this, since backups are useful, especially
2276 when something goes wrong.
2278 To avoid seeing backup files (and other "uninteresting" files) in Dired,
2279 load @code{dired-x} by adding the following to your @file{.emacs} file:
2281 @lisp
2282 (add-hook 'dired-load-hook
2283           (lambda ()
2284            (load "dired-x")))
2285 @end lisp
2287 With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer.
2288 You can make omitting the default for new dired buffers by putting the
2289 following in your @file{.emacs}:
2291 @lisp
2292 (add-hook 'dired-mode-hook 'dired-omit-toggle)
2293 @end lisp
2295 If you're tired of seeing backup files whenever you do an @samp{ls} at
2296 the Unix shell, try GNU @code{ls} with the @samp{-B} option.  GNU
2297 @code{ls} is part of the GNU Fileutils package, available from
2298 @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}).
2300 To disable or change the way backups are made, @inforef{Backup Names, ,
2301 emacs}.
2303 @cindex Backup files in a single directory
2304 Beginning with Emacs 21.1, you can control where Emacs puts backup files
2305 by customizing the variable @code{backup-directory-alist}.  This
2306 variable's value specifies that files whose names match specific patters
2307 should have their backups put in certain directories.  A typical use is
2308 to add the element @code{("." . @var{dir})} to force Emacs to put
2309 @strong{all} backup files in the directory @file{dir}.
2311 @node Disabling auto-save-mode, Going to a line by number, Disabling backups, Common requests
2312 @section How do I disable @code{auto-save-mode}?
2313 @cindex Disabling @code{auto-save-mode}
2314 @cindex Auto-saving
2315 @cindex Saving at frequent intervals
2317 You probably don't want to do this, since auto-saving is useful,
2318 especially when Emacs or your computer crashes while you are editing a
2319 document.
2321 Instead, you might want to change the variable
2322 @code{auto-save-interval}, which specifies how many keystrokes Emacs
2323 waits before auto-saving.  Increasing this value forces Emacs to wait
2324 longer between auto-saves, which might annoy you less.
2326 You might also want to look into Sebastian Kremer's @code{auto-save}
2327 package, available from the Lisp Code Archive (@pxref{Packages that do not come
2328 with Emacs}).  This
2329 package also allows you to place all auto-save files in one directory,
2330 such as @file{/tmp}.
2332 To disable or change how @code{auto-save-mode} works, @inforef{Auto
2333 Save, , emacs}.
2335 @node Going to a line by number, Modifying pull-down menus, Disabling auto-save-mode, Common requests
2336 @section How can I go to a certain line given its number?
2337 @cindex Going to a line by number
2338 @cindex Compilation error messages
2339 @cindex Recompilation
2341 Are you sure you indeed need to go to a line by its number?  Perhaps all
2342 you want is to display a line in your source file for which a compiler
2343 printed an error message?  If so, compiling from within Emacs using the
2344 @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more
2345 effective way of doing that.  Emacs automatically intercepts the compile
2346 error messages, inserts them into a special buffer called
2347 @code{*compilation*}, and lets you visit the locus of each message in
2348 the source.  Type @kbd{C-x `} to step through the offending lines one by
2349 one.  Click @kbd{Mouse-2} or press @key{RET} on a message text in the
2350 @code{*compilation*} buffer to go to the line whose number is mentioned
2351 in that message.
2353 But if you indeed need to go to a certain text line, type @kbd{M-x
2354 goto-line @key{RET}}.  Emacs will prompt you for the number of the line
2355 and go to that line.
2357 You can do this faster by invoking @code{goto-line} with a numeric
2358 argument that is the line's number.  For example, @kbd{C-u 286 M-x
2359 goto-line @key{RET}} will jump to line number 286 in the current
2360 buffer.
2362 If you need to use this command frequently, you might consider binding
2363 it to a key.  The following snippet, if added to your @file{~/.emacs}
2364 file, will bind the sequence @kbd{C-x g} to @code{goto-line}:
2366 @lisp
2367  (global-set-key "\C-xg" 'goto-line)
2368 @end lisp
2371 @node Modifying pull-down menus, Deleting menus and menu options, Going to a line by number, Common requests
2372 @section How can I create or modify new pull-down menu options?
2373 @cindex Pull-down menus, creating or modifying
2374 @cindex Menus, creating or modifying
2375 @cindex Creating new menu options
2376 @cindex Modifying pull-down menus
2377 @cindex Menus and keymaps
2378 @cindex Keymaps and menus
2380 Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers})
2381 represents a local or global keymap.  Selecting a menu title with the
2382 mouse displays that keymap's non-nil contents in the form of a menu.
2384 So to add a menu option to an existing menu, all you have to do is add a
2385 new definition to the appropriate keymap.  Adding a @samp{Forward Word}
2386 item to the @samp{Edit} menu thus requires the following Lisp code:
2388 @lisp
2389 (define-key global-map           
2390   [menu-bar edit forward]        
2391   '("Forward word" . forward-word))
2392 @end lisp
2394 @noindent
2395 The first line adds the entry to the global keymap, which includes
2396 global menu bar entries.  Replacing the reference to @code{global-map}
2397 with a local keymap would add this menu option only within a particular
2398 mode.
2400 The second line describes the path from the menu-bar to the new entry.
2401 Placing this menu entry underneath the @samp{File} menu would mean
2402 changing the word @code{edit} in the second line to @code{file}.
2404 The third line is a cons cell whose first element is the title that will
2405 be displayed, and whose second element is the function that will be
2406 called when that menu option is invoked.
2408 To add a new menu, rather than a new option to an existing menu, we must
2409 define an entirely new keymap:
2411 @lisp
2412 (define-key global-map [menu-bar words]
2413   (cons "Words" (make-sparse-keymap "Words")))
2414 @end lisp
2416 The above code creates a new sparse keymap, gives it the name
2417 @samp{Words}, and attaches it to the global menu bar.  Adding the
2418 @samp{Forward Word} item to this new menu would thus require the
2419 following code:
2421 @lisp
2422 (define-key global-map
2423   [menu-bar words forward]
2424   '("Forward word" . forward-word))
2425 @end lisp
2427 @noindent
2428 Note that because of the way keymaps work, menu options are displayed
2429 with the more recently defined items at the top.  Thus if you were to
2430 define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that
2431 order), the menu option @samp{baz} would appear at the top, and
2432 @samp{foo} would be at the bottom.
2434 One way to avoid this problem is to use the function @code{define-key-after},
2435 which works the same as @code{define-key}, but lets you modify where items
2436 appear.  The following Lisp code would insert the @samp{Forward Word}
2437 item in the @samp{Edit} menu immediately following the @samp{Undo} item:
2439 @lisp
2440 (define-key-after
2441   (lookup-key global-map [menu-bar edit])
2442   [forward]
2443   '("Forward word" . forward-word)
2444   'undo)
2445 @end lisp
2447 Note how the second and third arguments to @code{define-key-after} are
2448 different from those of @code{define-key}, and that we have added a new
2449 (final) argument, the function after which our new key should be
2450 defined.
2452 To move a menu option from one position to another, simply evaluate
2453 @code{define-key-after} with the appropriate final argument.
2455 More detailed information---and more examples of how to create and
2456 modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under
2457 ``Menu Keymaps''.  (@xref{Emacs Lisp documentation}, for information on
2458 this manual.)
2460 @node Deleting menus and menu options, Turning on syntax highlighting, Modifying pull-down menus, Common requests
2461 @section How do I delete menus and menu options?
2462 @cindex Deleting menus and menu options
2463 @cindex Menus, deleting
2465 The simplest way to remove a menu is to set its keymap to @samp{nil}.
2466 For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down
2467 menus}), use:
2469 @lisp
2470 (define-key global-map [menu-bar words] nil)
2471 @end lisp
2473 Similarly, removing a menu option requires redefining a keymap entry to
2474 @code{nil}.  For example, to delete the @samp{Forward word} menu option
2475 from the @samp{Edit} menu (we added it in @ref{Modifying pull-down
2476 menus}), use:
2478 @lisp
2479 (define-key global-map [menu-bar edit forward] nil)
2480 @end lisp
2482 @node Turning on syntax highlighting, Scrolling only one line, Deleting menus and menu options, Common requests
2483 @section How do I turn on syntax highlighting?
2484 @cindex Syntax highlighting
2485 @cindex @code{font-lock-mode}
2486 @cindex Highlighting based on syntax
2487 @cindex Colorizing text
2488 @cindex FAQ, @code{font-lock-mode}
2490 @code{font-lock-mode} is the standard way to have Emacs perform syntax
2491 highlighting in the current buffer.  With @code{font-lock-mode} turned
2492 on, different types of text will appear in different colors.  For
2493 instance, if you turn on @code{font-lock-mode} in a programming mode,
2494 variables will appear in one face, keywords in a second, and comments in
2495 a third.
2497 @cindex hilit19 is deprecated
2498 Earlier versions of Emacs supported hilit19, a similar package.  Use of
2499 hilit19 is now considered non-standard, although @file{hilit19.el} comes
2500 with the stock Emacs distribution.  It is no longer maintained.
2502 To turn @code{font-lock-mode} on within an existing buffer, use @kbd{M-x
2503 font-lock-mode @key{RET}}.
2505 To automatically invoke @code{font-lock-mode} when a particular major
2506 mode is invoked, set the major mode's hook.  For example, to fontify all
2507 @code{c-mode} buffers, add the following to your @file{.emacs} file:
2509 @lisp
2510 (add-hook 'c-mode-hook 'turn-on-font-lock)
2511 @end lisp
2513 To automatically invoke @code{font-lock-mode} for all major modes, you
2514 can turn on @code{global-font-lock-mode} by including the following line
2515 in your @file{.emacs} file:
2517 @lisp
2518 (global-font-lock-mode 1)
2519 @end lisp
2521 @noindent
2522 This instructs Emacs to turn on font-lock mode in those buffers for
2523 which a font-lock mode definition has been provided (in the variable
2524 @code{font-lock-global-modes}).  If you edit a file in
2525 @code{pie-ala-mode}, and no font-lock definitions have been provided for
2526 @code{pie-ala} files, then the above setting will have no effect on that
2527 particular buffer.
2529 Highlighting a buffer with @code{font-lock-mode} can take quite a while,
2530 and cause an annoying delay in display, so several features exist to
2531 work around this.
2533 @cindex Just-In-Time syntax highlighting
2534 In Emacs 21 and later, turning on @code{font-lock-mode} automatically
2535 activates the new @dfn{Just-In-Time fontification} provided by
2536 @code{jit-lock-mode}.  @code{jit-lock-mode} defers the fontification of
2537 portions of buffer until you actually need to see them, and can also
2538 fontify while Emacs is idle.  This makes display of the visible portion
2539 of a buffer almost instantaneous.  For details about customizing
2540 @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}.
2542 @cindex Levels of syntax highlighting
2543 @cindex Decoration level, in @code{font-lock-mode}
2544 In versions of Emacs before 21, different levels of decoration are
2545 available, from slight to gaudy.  More decoration means you need to wait
2546 more time for a buffer to be fontified (or a faster machine).  To
2547 control how decorated your buffers should become, set the value of
2548 @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a
2549 @code{nil} value indicating default (usually minimum) decoration, and a
2550 @code{t} value indicating the maximum decoration.  For the gaudiest
2551 possible look, then, include the line
2553 @lisp
2554 (setq font-lock-maximum-decoration t)
2555 @end lisp
2557 @noindent
2558 in your @file{.emacs} file.  You can also set this variable such that
2559 different modes are highlighted in a different ways; for more
2560 information, see the documentation for
2561 @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x
2562 describe-variable @key{RET}}).
2564 @cindex Lazy font-lock
2565 You might also want to investigate @code{fast-lock-mode} and
2566 @code{lazy-lock-mode}, versions of @code{font-lock-mode} that speed up
2567 highlighting.  These are the alternatives for @code{jit-lock-mode} in
2568 versions of Emacs before 21.1.  The advantage of @code{lazy-lock-mode}
2569 is that it only fontifies buffers when certain conditions are met, such
2570 as after a certain amount of idle time, or after you have finished
2571 scrolling through text.  See the documentation for @code{lazy-lock-mode}
2572 by typing @kbd{C-h f @code{lazy-lock-mode}} (@kbd{M-x describe-function
2573 @key{RET} lazy-lock-mode @key{RET}}).
2575 Also see the documentation for the function @code{font-lock-mode},
2576 available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x
2577 describe-function @key{RET} font-lock-mode @key{RET}}).
2579 For more information on font-lock mode, take a look at the
2580 @code{font-lock-mode} FAQ, maintained by
2581 @email{jari.aalto@@ntc.nokia.com, Jari Aalto} at
2583 @uref{ftp://cs.uta.fi/pub/ssjaaa/ema-font.gui}
2585 To print buffers with the faces (i.e., colors and fonts) intact, use
2586 @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x
2587 ps-print-region-with-faces}.  You will need a way to send text to a
2588 PostScript printer, or a PostScript interpreter such as Ghostscript;
2589 consult the documentation of the variables @code{ps-printer-name},
2590 @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details.
2592 @node Scrolling only one line, Replacing highlighted text, Turning on syntax highlighting, Common requests
2593 @section How can I force Emacs to scroll only one line when I move past the bottom of the screen?
2594 @cindex Scrolling only one line
2595 @cindex Reducing the increment when scrollng
2597 Place the following Lisp form in your @file{.emacs} file:
2599 @lisp
2600 (setq scroll-step 1)
2601 @end lisp
2603 @inforef{Scrolling, Scrolling, emacs}.
2605 @node Replacing highlighted text, Editing MS-DOS files, Scrolling only one line, Common requests
2606 @section How can I replace highlighted text with what I type?
2607 @cindex @code{delete-selection-mode}
2608 @cindex Replacing highlighted text
2609 @cindex Highlighing and replacing text
2611 Use @code{delete-selection-mode}, which you can start automatically by
2612 placing the following Lisp form in your @file{.emacs} file:
2614 @lisp
2615 (delete-selection-mode t)
2616 @end lisp
2618 According to the documentation string for @code{delete-selection-mode}
2619 (which you can read using @kbd{M-x describe-function @key{RET}
2620 delete-selection-mode @key{RET}}):
2622 @quotation
2623 When ON, typed text replaces the selection if the selection is active.
2624 When OFF, typed text is just inserted at point.
2625 @end quotation
2627 This mode also allows you to delete (not kill) the highlighted region by
2628 pressing @key{DEL}.
2630 @node Editing MS-DOS files, Filling paragraphs with a single space, Replacing highlighted text, Common requests
2631 @section How can I edit MS-DOS files using Emacs?
2632 @cindex Editing MS-DOS files
2633 @cindex MS-DOS files, editing
2634 @cindex Microsoft files, editing
2635 @cindex Windows files, editing
2637 As of Emacs 20, detection and handling of MS-DOS (and Windows) files is
2638 performed transparently.  You can open MS-DOS files on a Unix system,
2639 edit it, and save it without having to worry about the file format.
2641 When editing an MS-DOS style file, the mode line will indicate that it
2642 is a DOS file.  On Unix and GNU/Linux systems, and also on a Macintosh,
2643 the string @samp{(DOS)} will appear near the left edge of the mode line;
2644 on DOS and Windows, where the DOS end-of-line (EOL) format is the
2645 default, a backslash (@samp{\}) will appear in the mode line.
2647 If you are running a version of Emacs before 20.1, get @code{crypt++}
2648 from the Emacs Lisp Archive (@pxref{Packages that do not come with
2649 Emacs}).  Among other things, @code{crypt++} transparently modifies
2650 MS-DOS files as they are loaded and saved, allowing you to ignore the
2651 different conventions that Unix and MS-DOS have for delineating the end
2652 of a line.
2654 @node Filling paragraphs with a single space,  Escape sequences in shell output, Editing MS-DOS files, Common requests
2655 @section How can I tell Emacs to fill paragraphs with a single space after each period?
2656 @cindex One space following periods
2657 @cindex Single space following periods
2658 @cindex Periods, one space following
2660 @email{ulm@@vsnhd1.cern.ch, Ulrich Mueller} suggests adding the
2661 following two lines to your @file{.emacs} file:
2663 @lisp
2664 (setq sentence-end "[.?!][]\"')@}]*\\($\\|[ \t]\\)[ \t\n]*")
2665 (setq sentence-end-double-space nil)
2666 @end lisp
2668 @node Escape sequences in shell output, , Filling paragraphs with a single space, Common requests
2669 @section Why do I get these strange escape sequences when I run
2670 @code{ls} from the Shell mode?
2671 @cindex Escape sequences in @code{ls} output
2672 @cindex @code{ls} in Shell mode
2674 This happens because @code{ls} is aliased to @samp{ls --color} in your
2675 shell init file.  You have two alternatives to solve this:
2677 @itemize @bullet
2678 @item
2679 Make the alias conditioned on the @code{EMACS} variable in the
2680 environment.  When Emacs runs a subsidiary shell, it exports the
2681 @code{EMACS} variable with the value @code{t} to that shell.  You can
2682 unalias @code{ls} when that happens, thus limiting the alias to your
2683 interactive sessions.
2685 @item
2686 Install the @code{ansi-color} package (bundled with Emacs 21.1 and
2687 later), which converts these ANSI escape sequences into colors.
2688 @end itemize
2690 @c ------------------------------------------------------------
2691 @node    Bugs and problems, Compiling and installing Emacs, Common requests, Top
2692 @chapter Bugs and problems
2693 @cindex Bugs and problems
2695 The Emacs manual lists some common kinds of trouble users could get
2696 into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU
2697 Emacs Manual}, so you might look there if the problem you encounter
2698 isn't described in this chapter.  If you decide you've discovered a bug,
2699 see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for
2700 instructions how to do that.
2702 The file @file{etc/PROBLEMS} in the Emacs distribution lists various
2703 known problems with building and using Emacs on specific platforms;
2704 type @kbd{C-h P} to read it.
2706 @menu
2707 * Problems with very large files::  
2708 * ^M in the shell buffer::      
2709 * Shell process exits abnormally::  
2710 * Problems with Shell Mode on MS-Windows::  
2711 * Termcap/Terminfo entries for Emacs::  
2712 * Spontaneous entry into isearch-mode::  
2713 * Problems talking to certain hosts::  
2714 * Errors with init files::      
2715 * Emacs ignores X resources::   
2716 * Emacs ignores frame parameters::  
2717 * Emacs takes a long time to visit files::  
2718 * Editing files with $ in the name::  
2719 * Shell mode loses the current directory::  
2720 * Security risks with Emacs::   
2721 * Dired claims that no file is on this line::  
2722 @end menu
2724 @node Problems with very large files, ^M in the shell buffer, Bugs and problems, Bugs and problems
2725 @section Does Emacs have problems with files larger than 8 megabytes?
2726 @cindex Very large files, opening
2727 @cindex Large files, opening
2728 @cindex Opening very large files
2729 @cindex Maximum file size
2730 @cindex Files, maximum size
2732 Old versions (i.e., anything before 19.29) of Emacs had problems editing
2733 files larger than 8 megabytes.  As of version 19.29, the maximum buffer
2734 size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes.  Emacs 20
2735 can be compiled on some 64-bit systems in a way that enlarges the buffer
2736 size up to 576,460,752,303,423,487 bytes, or 549,755,813 GBytes.
2738 If you are using a version of Emacs older than 19.29 and cannot upgrade,
2739 you will have to recompile. @email{lnz@@lucid.com, Leonard N. Zubkoff}
2740 suggests putting the following two lines in @file{src/config.h} before
2741 compiling Emacs to allow for 26-bit integers and pointers (and thus file
2742 sizes of up to 33,554,431 bytes):
2744 @example
2745 #define VALBITS 26
2746 #define GCTYPEBITS 5
2747 @end example
2749 @noindent
2750 This method may result in "ILLEGAL DATATYPE" and other random errors on
2751 some machines.
2753 @email{daveg@@csvax.cs.caltech.edu, David Gillespie} explains how this
2754 problems crops up; while his numbers are true only for pre-19.29
2755 versions of Emacs, the theory remains the same with current versions.
2757 @quotation
2758 Emacs is largely written in a dialect of Lisp; Lisp is a freely-typed
2759 language in the sense that you can put any value of any type into any
2760 variable, or return it from a function, and so on.  So each value
2761 must carry a @dfn{tag} along with it identifying what kind of thing it
2762 is, e.g., integer, pointer to a list, pointer to an editing buffer, and
2763 so on.  Emacs uses standard 32-bit integers for data objects, taking the
2764 top 8 bits for the tag and the bottom 24 bits for the value.  So
2765 integers (and pointers) are somewhat restricted compared to true C
2766 integers and pointers.
2767 @end quotation
2769 @node ^M in the shell buffer, Shell process exits abnormally, Problems with very large files, Bugs and problems
2770 @section How do I get rid of @samp{^M} or echoed commands in my shell buffer?
2771 @cindex Shell buffer, echoed commands and @samp{^M} in
2772 @cindex Echoed commands in @code{shell-mode}
2774 Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to
2775 make them go away.  If that doesn't work, you have several options:
2777 For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2778 file:
2780 @example
2781 if ($?EMACS) then
2782     if ("$EMACS" == t) then
2783         if ($?tcsh) unset edit
2784         stty nl
2785     endif
2786 endif
2787 @end example
2789 Or put this in your @file{.emacs_tcsh} file:
2791 @example
2792 unset edit
2793 stty nl
2794 @end example
2796 Alternatively, use @code{csh} in your shell buffers instead of
2797 @code{tcsh}.  One way is:
2799 @lisp
2800 (setq explicit-shell-file-name "/bin/csh")
2801 @end lisp
2803 @noindent
2804 and another is to do this in your @file{.cshrc} (or @file{.tcshrc})
2805 file:
2807 @example
2808 setenv ESHELL /bin/csh
2809 @end example
2811 @noindent
2812 (You must start Emacs over again with the environment variable properly
2813 set for this to take effect.)
2815 You can also set the @code{ESHELL} environment variable in Emacs Lisp
2816 with the following Lisp form,
2818 @lisp
2819 (setenv "ESHELL" "/bin/csh")
2820 @end lisp
2822 The above solutions try to prevent the shell from producing the
2823 @samp{^M} characters in the first place.  If this is not possible
2824 (e.g., if you use a Windows shell), you can get Emacs to remove these
2825 characters from the buffer by adding this to your @file{.emacs} init
2826 file:
2828 @smalllisp
2829 (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m)
2830 @end smalllisp
2832 On a related note: If your shell is echoing your input line in the shell
2833 buffer, you might want to try the following command in your shell
2834 start-up file:
2836 @example
2837 stty -icrnl -onlcr -echo susp ^Z
2838 @end example
2840 @node Shell process exits abnormally, Problems with Shell Mode on MS-Windows, ^M in the shell buffer, Bugs and problems
2841 @section Why do I get "Process shell exited abnormally with code 1"?
2842 @cindex Abnormal exits from @code{shell-mode}
2843 @cindex @code{shell-mode} exits
2844 @cindex Process shell exited
2846 The most likely reason for this message is that the @samp{env} program
2847 is not properly installed.  Compile this program for your architecture,
2848 and install it with @samp{a+x} permission in the architecture-dependent
2849 Emacs program directory.  (You can find what this directory is at your
2850 site by inspecting the value of the variable @code{exec-directory} by
2851 typing @kbd{C-h v exec-directory @key{RET}}.)
2853 You should also check for other programs named @samp{env} in your path
2854 (e.g., SunOS has a program named @file{/usr/bin/env}).  We don't
2855 understand why this can cause a failure and don't know a general
2856 solution for working around the problem in this case.
2858 The @samp{make clean} command will remove @samp{env} and other vital
2859 programs, so be careful when using it.
2861 It has been reported that this sometimes happened when Emacs was started
2862 as an X client from an xterm window (i.e., had a controlling tty) but the
2863 xterm was later terminated.
2865 See also @samp{PROBLEMS} (in the @file{etc} subdirectory of the
2866 top-level directory when you unpack the Emacs source) for other
2867 possible causes of this message.
2869 @node Problems with Shell Mode on MS-Windows, Termcap/Terminfo entries for Emacs, Shell process exits abnormally, Bugs and problems
2870 @section Why do I get an error message when I try to run @kbd{M-x shell}?
2872 @cindex Shell Mode, and MS-Windows
2873 @cindex @code{explicit-shell-file-name}
2874 On MS-Windows, this might happen because Emacs tries to look for the
2875 shell in a wrong place.  The default file name @file{/bin/sh} is
2876 usually incorrect for non-Unix systems.  If you know where your shell
2877 executable is, set the variable @code{explicit-shell-file-name} in
2878 your @file{.emacs} file to point to its full file name, like this:
2880 @lisp
2881 (setq explicit-shell-file-name "d:/shells/bash.exe")
2882 @end lisp
2884 If you don't know what shell does Emacs use, try the @kbd{M-!}
2885 command; if that works, put the following line into your
2886 @file{.emacs}:
2888 @lisp
2889 (setq explicit-shell-file-name shell-file-name)
2890 @end lisp
2892 @cindex Antivirus programs, and Shell Mode
2893 Some people have trouble with Shell Mode because of intrusive
2894 antivirus software; disabling the resident antivirus program solves
2895 the problems in those cases.
2897 @node Termcap/Terminfo entries for Emacs, Spontaneous entry into isearch-mode, Problems with Shell Mode on MS-Windows, Bugs and problems
2898 @section Where is the termcap/terminfo entry for terminal type "emacs"?
2899 @cindex Termcap
2900 @cindex Terminfo
2901 @cindex Emacs entries for termcap/terminfo
2903 The termcap entry for terminal type @samp{emacs} is ordinarily put in
2904 the @samp{TERMCAP} environment variable of subshells.  It may help in
2905 certain situations (e.g., using rlogin from shell buffer) to add an
2906 entry for @samp{emacs} to the system-wide termcap file.  Here is a
2907 correct termcap entry for @samp{emacs}:
2909 @example
2910 emacs:tc=unknown:
2911 @end example
2913 To make a terminfo entry for @samp{emacs}, use @code{tic} or
2914 @code{captoinfo}.  You need to generate
2915 @file{/usr/lib/terminfo/e/emacs}.  It may work to simply copy
2916 @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}.
2918 Having a termcap/terminfo entry will not enable the use of full screen
2919 programs in shell buffers.  Use @kbd{M-x terminal-emulator} for that
2920 instead.
2922 A workaround to the problem of missing termcap/terminfo entries is to
2923 change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown}
2924 in your shell start up file.  @code{csh} users could put this in their
2925 @file{.cshrc} files:
2927 @example
2928 if ("$term" == emacs) set term=dumb
2929 @end example
2931 @node Spontaneous entry into isearch-mode, Problems talking to certain hosts, Termcap/Terminfo entries for Emacs, Bugs and problems
2932 @section Why does Emacs spontaneously start displaying "I-search:" and beeping?
2933 @cindex Spontaneous entry into isearch-mode
2934 @cindex isearch-mode, spontaneous entry into
2935 @cindex Beeping without obvious reason
2937 Your terminal (or something between your terminal and the computer) is
2938 sending @kbd{C-s} and @kbd{C-q} for flow control, and Emacs is receiving
2939 these characters and interpreting them as commands.  (The @kbd{C-s}
2940 character normally invokes the @code{isearch-forward} command.)  For
2941 possible solutions, see @ref{Handling C-s and C-q with flow control}.
2943 @node Problems talking to certain hosts, Errors with init files, Spontaneous entry into isearch-mode, Bugs and problems
2944 @section Why can't Emacs talk to certain hosts (or certain hostnames)?
2945 @cindex Hosts, Emacs cannot talk to
2946 @cindex @code{gethostbyname}, problematic version
2948 The problem may be that Emacs is linked with a wimpier version of
2949 @code{gethostbyname} than the rest of the programs on the machine.  This
2950 is often manifested as a message on startup of ``X server not responding.
2951 Check your @samp{DISPLAY} environment variable.'' or a message of
2952 ``Unknown host'' from @code{open-network-stream}.
2954 On a Sun, this may be because Emacs had to be linked with the static C
2955 library.  The version of @code{gethostbyname} in the static C library
2956 may only look in @file{/etc/hosts} and the NIS (YP) maps, while the
2957 version in the dynamic C library may be smart enough to check DNS in
2958 addition to or instead of NIS.  On a Motorola Delta running System V
2959 R3.6, the version of @code{gethostbyname} in the standard library works,
2960 but the one that works with NIS doesn't (the one you get with -linet).
2961 Other operating systems have similar problems.
2963 Try these options:
2965 @itemize @bullet
2967 @item
2968 Explicitly add the host you want to communicate with to @file{/etc/hosts}.
2970 @item
2971 Relink Emacs with this line in @file{src/config.h}:
2973 @example
2974 #define LIBS_SYSTEM -lresolv
2975 @end example
2977 @item
2978 Replace @code{gethostbyname} and friends in @file{libc.a} with more
2979 useful versions such as the ones in @file{libresolv.a}.  Then relink
2980 Emacs.
2982 @item
2983 If you are actually running NIS, make sure that @code{ypbind} is
2984 properly told to do DNS lookups with the correct command line switch.
2986 @end itemize
2988 @node Errors with init files, Emacs ignores X resources, Problems talking to certain hosts, Bugs and problems
2989 @section Why does Emacs say "Error in init file"?
2990 @cindex Error in @file{.emacs}
2991 @cindex Error in init file
2992 @cindex Init file, errors in
2993 @cindex @file{.emacs} file, errors in
2994 @cindex Debugging @file{.emacs} file
2996 An error occurred while loading either your @file{.emacs} file or the
2997 system-wide file @file{lisp/default.el}.  Emacs 21.1 and later pops the
2998 @file{*Messages*} buffer, and puts there some additional information
2999 about the error, to provide some hints for debugging.
3001 For information on how to debug your @file{.emacs} file, see
3002 @ref{Debugging a customization file}.
3004 It may be the case that you need to load some package first, or use a
3005 hook that will be evaluated after the package is loaded.  A common case
3006 of this is explained in @ref{Terminal setup code works after Emacs has
3007 begun}.
3009 @node Emacs ignores X resources, Emacs ignores frame parameters, Errors with init files, Bugs and problems
3010 @section Why does Emacs ignore my X resources (my .Xdefaults file)?
3011 @cindex X resources being ignored
3012 @cindex Ignored X resources
3013 @cindex @file{.Xdefaults}
3015 As of version 19, Emacs searches for X resources in the files specified
3016 by the following environment variables:
3018 @itemize @bullet
3020 @item @code{XFILESEARCHPATH}
3021 @item @code{XUSERFILESEARCHPATH}
3022 @item @code{XAPPLRESDIR} 
3024 @end itemize
3026 This emulates the functionality provided by programs written using the
3027 Xt toolkit.
3029 @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list
3030 of file names separated by colons.  @code{XAPPLRESDIR} should be a list
3031 of directory names separated by colons.
3033 Emacs searches for X resources:
3035 @enumerate
3037 @item
3038 specified on the command line, with the @samp{-xrm RESOURCESTRING} option,
3040 @item
3041 then in the value of the @samp{XENVIRONMENT} environment variable,
3043 @itemize @minus 
3045 @item
3046 or if that is unset, in the file named
3047 @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is
3048 the name of the machine Emacs is running on),
3050 @end itemize
3052 @item
3053 then in the screen-specific and server-wide resource properties provided
3054 by the server,
3056 @itemize @minus
3058 @item
3059 or if those properties are unset, in the file named @file{~/.Xdefaults}
3060 if it exists,
3062 @end itemize
3064 @item
3065 then in the files listed in @samp{XUSERFILESEARCHPATH},
3067 @itemize @minus
3069 @item
3070 or in files named @file{@var{lang}/Emacs} in directories listed in
3071 @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG}
3072 environment variable), if the @samp{LANG} environment variable is set, 
3073 @item
3074 or in files named Emacs in the directories listed in @samp{XAPPLRESDIR}
3075 @item
3076 or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable
3077 is set),
3078 @item 
3079 or in @file{~/Emacs},
3081 @end itemize
3083 @item
3084 then in the files listed in  @code{XFILESEARCHPATH}.
3086 @end enumerate
3088 @node Emacs ignores frame parameters, Emacs takes a long time to visit files, Emacs ignores X resources, Bugs and problems
3089 @section Why don't my customizations of the frame parameters work?
3090 @cindex Frame parameters
3092 This probably happens because you have set the frame parameters in the
3093 variable @code{initial-frame-alist}.  That variable holds parameters
3094 used only for the first frame created when Emacs starts.  To customize
3095 the parameters of all frames, change the variable
3096 @code{default-frame-alist} instead.
3098 These two variables exist because many users customize the initial frame
3099 in a special way.  For example, you could determine the position and
3100 size of the initial frame, but would like to control the geometry of the
3101 other frames by individually positioning each one of them.
3104 @node Emacs takes a long time to visit files, Editing files with $ in the name, Emacs ignores frame parameters, Bugs and problems
3105 @section Why does Emacs take 20 seconds to visit a file?
3106 @cindex Visiting files takes a long time
3107 @cindex Delay when visiting files
3108 @cindex Files, take a long time to visit
3110 Old versions of Emacs (i.e., versions before Emacs 20.x) often
3111 encountered this when the master lock file, @file{!!!SuperLock!!!}, has
3112 been left in the lock directory somehow.  Delete it.
3114 @email{meuer@@geom.umn.edu, Mark Meuer} says that NeXT NFS has a bug
3115 where an exclusive create succeeds but returns an error status.  This
3116 can cause the same problem.  Since Emacs's file locking doesn't work
3117 over NFS anyway, the best solution is to recompile Emacs with
3118 @code{CLASH_DETECTION} undefined.
3120 @node Editing files with $ in the name, Shell mode loses the current directory, Emacs takes a long time to visit files, Bugs and problems
3121 @section How do I edit a file with a @samp{$} in its name?
3122 @cindex Editing files with @samp{$} in the name
3123 @cindex @samp{$} in file names
3124 @cindex File names containing @samp{$}, editing
3126 When entering a file name in the minibuffer, Emacs will attempt to expand
3127 a @samp{$} followed by a word as an environment variable.  To suppress
3128 this behavior, type @kbd{$$} instead.
3130 @node Shell mode loses the current directory, Security risks with Emacs, Editing files with $ in the name, Bugs and problems
3131 @section Why does shell mode lose track of the shell's current directory?
3132 @cindex Current directory and @code{shell-mode}
3133 @cindex @code{shell-mode} and current directory
3134 @cindex Directory, current in @code{shell-mode}
3136 Emacs has no way of knowing when the shell actually changes its
3137 directory.  This is an intrinsic limitation of Unix.  So it tries to
3138 guess by recognizing @samp{cd} commands.  If you type @kbd{cd} followed
3139 by a directory name with a variable reference (@kbd{cd $HOME/bin}) or
3140 with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to
3141 correctly guess the shell's new current directory.  A huge variety of
3142 fixes and enhancements to shell mode for this problem have been written
3143 to handle this problem.  Check the Lisp Code Directory (@pxref{Finding a
3144 package with particular functionality}).
3146 You can tell Emacs the shell's current directory with the command
3147 @kbd{M-x dirs}.
3149 @node Security risks with Emacs, Dired claims that no file is on this line, Shell mode loses the current directory, Bugs and problems
3150 @section Are there any security risks in Emacs?
3151 @cindex Security with Emacs
3152 @cindex @samp{movemail} and security
3153 @cindex @code{file-local-variable} and security
3154 @cindex Synthetic X events and security
3155 @cindex X events and security
3157 @itemize @bullet
3159 @item
3160 The @file{movemail} incident.  (No, this is not a risk.)
3162 In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in
3163 chapter 4.  The site at LBL had installed the @file{/etc/movemail}
3164 program setuid root.  (As of version 19, @file{movemail} is in your
3165 architecture-specific directory; type @kbd{C-h v exec-directory
3166 @key{RET}} to see what it is.)  Since @code{movemail} had not been
3167 designed for this situation, a security hole was created and users could
3168 get root privileges.
3170 @code{movemail} has since been changed so that this security hole will
3171 not exist, even if it is installed setuid root.  However,
3172 @code{movemail} no longer needs to be installed setuid root, which
3173 should eliminate this particular risk.
3175 We have heard unverified reports that the 1988 Internet worm took
3176 advantage of this configuration problem.
3178 @item
3179 The @code{file-local-variable} feature.  (Yes, a risk, but easy to
3180 change.)
3182 There is an Emacs feature that allows the setting of local values for
3183 variables when editing a file by including specially formatted text near
3184 the end of the file.  This feature also includes the ability to have
3185 arbitrary Emacs Lisp code evaluated when the file is visited.
3186 Obviously, there is a potential for Trojan horses to exploit this
3187 feature.
3189 Emacs 18 allowed this feature by default; users could disable it by
3190 setting the variable @code{inhibit-local-variables} to a non-nil value.
3192 As of Emacs 19, Emacs has a list of local variables that create a
3193 security risk.  If a file tries to set one of them, it asks the user to
3194 confirm whether the variables should be set.  You can also tell Emacs
3195 whether to allow the evaluation of Emacs Lisp code found at the bottom
3196 of files by setting the variable @code{enable-local-eval}.
3198 For more information, @inforef{File Variables, File Variables, emacs}.
3200 @item
3201 Synthetic X events.  (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or
3202 better.)
3204 Emacs accepts synthetic X events generated by the @code{SendEvent}
3205 request as though they were regular events.  As a result, if you are
3206 using the trivial host-based authentication, other users who can open X
3207 connections to your X workstation can make your Emacs process do
3208 anything, including run other processes with your privileges.
3210 The only fix for this is to prevent other users from being able to open
3211 X connections.  The standard way to prevent this is to use a real
3212 authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}.  If using
3213 the @code{xauth} program has any effect, then you are probably using
3214 @samp{MIT-MAGIC-COOKIE-1}.  Your site may be using a superior
3215 authentication method; ask your system administrator.
3217 If real authentication is not a possibility, you may be satisfied by
3218 just allowing hosts access for brief intervals while you start your X
3219 programs, then removing the access.  This reduces the risk somewhat by
3220 narrowing the time window when hostile users would have access, but
3221 @emph{does not eliminate the risk}.
3223 On most computers running Unix and X, you enable and disable
3224 access using the @code{xhost} command.  To allow all hosts access to
3225 your X server, use
3227 @example
3228 xhost +
3229 @end example
3231 @noindent
3232 at the shell prompt, which (on an HP machine, at least) produces the
3233 following message:
3235 @example
3236 access control disabled, clients can connect from any host
3237 @end example
3239 To deny all hosts access to your X server (except those explicitly
3240 allowed by name), use
3242 @example
3243 xhost -
3244 @end example
3246 On the test HP computer, this command generated the following message:
3248 @example
3249 access control enabled, only authorized clients can connect
3250 @end example
3252 @end itemize
3254 @node Dired claims that no file is on this line,  , Security risks with Emacs, Bugs and problems
3255 @section Dired says, "no file on this line" when I try to do something.
3256 @cindex Dired does not see a file
3258 @c FIXME: I think this is fixed in Emacs 21, but I didn't have time to
3259 @c check.
3260 Chances are you're using a localized version of Unix that doesn't use US
3261 date format in dired listings.  You can check this by looking at dired
3262 listings or by typing @kbd{ls -l} to a shell and looking at the dates that
3263 come out.
3265 Dired uses a regular expression to find the beginning of a file name.
3266 In a long Unix-style directory listing (@samp{ls -l}), the file name
3267 starts after the date.  The regexp has thus been written to look for the
3268 date, the format of which can vary on non-US systems.
3270 There are two approaches to solving this.  The first one involves
3271 setting things up so that @samp{ls -l} outputs US date format.  This can
3272 be done by setting the locale.  See your OS manual for more information.
3274 The second approach involves changing the regular expression used by
3275 dired, @code{dired-move-to-filename-regexp}.
3277 @c ------------------------------------------------------------
3278 @node Compiling and installing Emacs, Finding Emacs and related packages, Bugs and problems, Top
3279 @chapter    Compiling and installing Emacs
3280 @cindex    Compiling and installing Emacs
3282 @menu
3283 * Installing Emacs::            
3284 * Updating Emacs::              
3285 * Problems building Emacs::     
3286 * Linking with -lX11 fails::    
3287 @end menu
3289 @node Installing Emacs, Updating Emacs, Compiling and installing Emacs, Compiling and installing Emacs
3290 @section How do I install Emacs?
3291 @cindex Installing Emacs
3292 @cindex Unix systems, installing Emacs on
3293 @cindex Downloading and installing Emacs
3294 @cindex Retrieving and installing Emacs
3295 @cindex Building Emacs from source
3296 @cindex Source code, building Emacs from
3297 @cindex Unpacking and installing Emacs
3299 This answer is meant for users of Unix and Unix-like systems.  Users of
3300 other operating systems should see the series of questions beginning
3301 with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source
3302 and binaries, and how to install Emacs on those systems.
3304 For Unix and Unix-like systems, the easiest way is often to compile it
3305 from scratch.  You will need:
3307 @itemize @bullet
3309 @item
3310 Emacs sources.  @xref{Current GNU distributions}, for a list of ftp sites
3311 that make them available.  On @file{ftp.gnu.org}, the main GNU
3312 distribution site, sources are available as
3314 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-@value{VER}.tar.gz}
3316 The above will obviously change as new versions of Emacs come out.  For
3317 instance, when Emacs 21.42 is released, it will most probably be
3318 available as
3320 @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-21.42.tar.gz}
3322 Again, you should use one of the GNU mirror sites (see @ref{Current GNU
3323 distributions}, and adjust the URL accordingly) so as to reduce load on
3324 @file{ftp.gnu.org}.
3326 @item
3327 @code{gzip}, the GNU compression utility.  You can get @code{gzip} via
3328 anonymous ftp at mirrors of @file{ftp.gnu.org} sites; it should compile
3329 and install without much trouble on most systems.  Once you have
3330 retrieved the Emacs sources, you will probably be able to uncompress
3331 them with the command
3333 @example
3334 gunzip --verbose emacs-@value{VER}.tar.gz
3335 @end example
3337 @noindent
3338 changing the Emacs version (@value{VER}), as necessary.  Once
3339 @code{gunzip} has finished doing its job, a file by the name of
3340 @file{emacs-@value{VER}.tar} should be in your build directory.
3342 @item 
3343 @code{tar}, the @dfn{tape archiving} program, which moves multiple files
3344 into and out of archive files, or @dfn{tarfiles}.  All of the files
3345 comprising the Emacs source come in a single tarfile, and must be
3346 extracted using @code{tar} before you can build Emacs.  Typically, the
3347 extraction command would look like
3349 @example
3350 tar -xvvf emacs-@value{VER}.tar
3351 @end example
3353 @noindent
3354 The @samp{x} indicates that we want to extract files from this tarfile,
3355 the two @samp{v}s force verbose output, and the @samp{f} tells
3356 @code{tar} to use a disk file, rather than one on the tape drive.
3358 If you're using GNU @code{tar} (available at mirrors of
3359 @file{ftp.gnu.org}), you can combine this step and the previous one by
3360 using the command
3362 @example
3363 tar -zxvvf emacs-@value{VER}.tar.gz
3364 @end example
3366 @noindent
3367 The additional @samp{z} at the beginning of the options list tells GNU
3368 @code{tar} to uncompress the file with @code{gunzip} before extracting
3369 the tarfile's components.
3371 @end itemize
3373 At this point, the Emacs sources (all 70+ megabytes of them) should be
3374 sitting in a directory called @file{emacs-@value{VER}}.  On most common
3375 Unix and Unix-like systems, you should be able to compile Emacs (with X
3376 Window system support) with the following commands:
3378 @example
3379 cd emacs-@value{VER}       # change directory to emacs-@value{VER}
3380 ./configure         # configure Emacs for your particular system 
3381 make                # use Makefile to build components, then Emacs 
3382 @end example
3384 If the @code{make} completes successfully, the odds are fairly good that
3385 the build has gone well.  (@xref{Problems building Emacs}, if you weren't
3386 successful.)
3388 By default, Emacs is installed in the following directories:
3390 @table @file
3391 @item /usr/local/bin
3392 binaries.
3394 @item /usr/local/share/emacs/@value{VER}
3395 Lisp code and support files.
3397 @item /usr/local/info
3398 Info documentation.
3399 @end table
3401 To install files in those default directories, become the superuser and
3402 type
3404 @example
3405 make install
3406 @end example
3408 Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs}
3409 and any Emacs Info files that might be in @file{/usr/local/info}.
3411 Much more verbose instructions (with many more hints and suggestions)
3412 come with the Emacs sources, in the file @file{INSTALL}.
3414 @node Updating Emacs, Problems building Emacs, Installing Emacs, Compiling and installing Emacs
3415 @section How do I update Emacs to the latest version?
3416 @cindex Updating Emacs
3418 @xref{Installing Emacs}, and follow the instructions there for
3419 installation.
3421 Most files are placed in version-specific directories.  Emacs
3422 @value{VER}, for instance, places files in
3423 @file{/usr/local/share/emacs/@value{VER}}.
3425 Upgrading should overwrite only, @file{/usr/local/bin/emacs} (the Emacs
3426 binary) and documentation in @file{/usr/local/info}.  Back up these
3427 files before you upgrade, and you shouldn't have too much trouble.
3429 @node Problems building Emacs, Linking with -lX11 fails, Updating Emacs, Compiling and installing Emacs
3430 @section What should I do if I have trouble building Emacs?
3431 @cindex Problems building Emacs
3432 @cindex Errors when building Emacs
3434 First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs
3435 source) to see if there is already a solution for your problem.  Next,
3436 look for other questions in this FAQ that have to do with Emacs
3437 installation and compilation problems.
3439 If you'd like to have someone look at your problem and help solve it,
3440 see @ref{Help installing Emacs}.
3442 If you cannot find a solution in the documentation, send a message to
3443 @email{bug-gnu-emacs@@gnu.org}.
3445 Please don't post it to @uref{news:gnu.emacs.help} or send e-mail to
3446 @email{help-gnu-emacs@@gnu.org}.  For further guidelines, see
3447 @ref{Guidelines for newsgroup postings} and @ref{Reporting bugs}.
3449 @node Linking with -lX11 fails,  , Problems building Emacs, Compiling and installing Emacs
3450 @section Why does linking Emacs with -lX11 fail?
3451 @cindex Linking with -lX11 fails
3452 @cindex lX11, linking fails with
3454 Emacs needs to be linked with the static version of the X11 library,
3455 @file{libX11.a}.  This may be missing.
3457 On OpenWindows, you may need to use @code{add_services} to add the
3458 "OpenWindows Programmers" optional software category from the CD-ROM.
3460 On HP-UX 8.0, you may need to run @code{update} again to load the
3461 X11-PRG ``fileset''.  This may be missing even if you specified ``all
3462 filesets'' the first time.  If @file{libcurses.a} is missing, you may
3463 need to load the ``Berkeley Development Option.''
3465 @email{zoo@@armadillo.com, David Zuhn} says that MIT X builds shared
3466 libraries by default, and only shared libraries, on those platforms that
3467 support them.  These shared libraries can't be used when undumping
3468 @code{temacs} (the last stage of the Emacs build process).  To get
3469 regular libraries in addition to shared libraries, add this to
3470 @file{site.cf}:
3472 @example
3473 #define ForceNormalLib YES
3474 @end example
3476 Other systems may have similar problems.  You can always define
3477 @code{CANNOT_DUMP} and link with the shared libraries instead.
3479 @cindex X Menus don't work
3480 To get the Xmenu stuff to work, you need to find a copy of MIT's
3481 @file{liboldX.a}.
3483 @c ------------------------------------------------------------
3484 @node Finding Emacs and related packages, Major packages and programs, Compiling and installing Emacs, Top
3485 @chapter Finding Emacs and related packages
3486 @cindex Finding Emacs and related packages
3488 @menu
3489 * Finding Emacs on the Internet::  
3490 * Finding a package with particular functionality::  
3491 * Packages that do not come with Emacs::  
3492 * Submitting to the Emacs Lisp Archive::  
3493 * Current GNU distributions::   
3494 * Difference between Emacs and XEmacs::  
3495 * Emacs for MS-DOS::            
3496 * Emacs for Windows::           
3497 * Emacs for OS/2::              
3498 * Emacs for Atari ST::          
3499 * Emacs for the Amiga ::        
3500 * Emacs for NeXTSTEP::          
3501 * Emacs for Apple computers::   
3502 * Emacs for VMS and DECwindows::  
3503 * Modes for various languages::  
3504 * Translating names to IP addresses::  
3505 @end menu
3507 @node Finding Emacs on the Internet, Finding a package with particular functionality, Finding Emacs and related packages, Finding Emacs and related packages
3508 @section Where can I get Emacs on the net (or by snail mail)?
3509 @cindex Finding Emacs on the Internet
3510 @cindex Snail mail, ordering Emacs via
3511 @cindex Postal service, ordering Emacs via
3512 @cindex Distribution, retrieving Emacs 
3513 @cindex Internet, retreiving from
3515 Look in the files @file{etc/DISTRIB} and @file{etc/FTP} for information
3516 on nearby archive sites and @file{etc/ORDERS} for mail orders.  If you
3517 don't already have Emacs, see @ref{Informational files for Emacs}, for how
3518 to get these files.
3520 @xref{Installing Emacs}, for information on how to obtain and build the latest
3521 version of Emacs, and see @ref{Current GNU distributions}, for a list of
3522 archive sites that make GNU software available.
3524 @node Finding a package with particular functionality, Packages that do not come with Emacs, Finding Emacs on the Internet, Finding Emacs and related packages
3525 @section How do I find a Emacs Lisp package that does XXX?
3526 @cindex Package, finding
3527 @cindex Finding an Emacs Lisp package
3528 @cindex Functionality, finding a particular package 
3530 First of all, you should check to make sure that the package isn't
3531 already available.  For example, typing @kbd{M-x apropos @key{RET}
3532 wordstar @key{RET}} lists all functions and variables containing the
3533 string @samp{wordstar}.
3535 It is also possible that the package is on your system, but has not been
3536 loaded.  To see which packages are available for loading, look through
3537 your computer's lisp directory (@pxref{File-name conventions}).  The Lisp
3538 source to most packages contains a short description of how they
3539 should be loaded, invoked, and configured---so before you use or
3540 modify a Lisp package, see if the author has provided any hints in the
3541 source code.
3543 If a package does not come with Emacs, check the Lisp Code Directory.
3544 The LCD was originally maintained by @email{brennan@@hal.com, Dave
3545 Brennan}, but was recently taken over by @email{toby@@world.std.com,
3546 toby knudsen}, who maintains @uref{http://www.emacs.org}.  The LCD is
3547 currently being reorganized and updated, but you can meanwhile find many
3548 packages at @uref{ftp://ftp.emacs.org/pub}.
3550 For now, you can search through the LCD with @file{lispdir.el}, which is
3551 in the process of being updated.  Download it from the LCD, in the
3552 @file{emacs-lisp-attic/misc} directory, and then evaluate the following
3553 Lisp form (@pxref{Evaluating Emacs Lisp code}):
3555 @lisp
3556 (setq lisp-code-directory
3557  "/anonymous@@ftp.emacs.org:pub/emacs-lisp-attic/emacs-lisp/LCD-datafile.gz"
3558   elisp-archive-host "ftp.emacs.org"
3559   elisp-archive-directory "/pub/emacs-lisp-attic/emacs-lisp/")
3560 @end lisp
3562 Once you have installed @file{lispdir.el}, you can use @kbd{M-x
3563 lisp-dir-apropos} to search the listing.  For example, @kbd{M-x
3564 lisp-dir-apropos @key{RET} ange-ftp @key{RET}} produces this output:
3566 @example
3567          GNU Emacs Lisp Code Directory Apropos --- "ange-ftp"
3568 "~/" refers to archive.cis.ohio-state.edu:pub/elisp-archive/
3570      ange-ftp (4.18)       15-Jul-1992
3571           Andy Norman, <ange@@hplb.hpl.hp.com>
3572           ~/packages/ange-ftp.tar.Z
3573           transparent FTP Support for GNU Emacs
3574      auto-save (1.19)      01-May-1992
3575           Sebastian Kremer, <sk@@thp.uni-koeln.de>
3576           ~/misc/auto-save.el.Z
3577           Safer autosaving with support for ange-ftp and /tmp
3578      ftp-quik (1.0)        28-Jul-1993
3579           Terrence Brannon, <tb06@@pl122f.eecs.lehigh.edu>
3580           ~/modes/ftp-quik.el.Z
3581           Quik access to dired'ing of ange-ftp and normal paths
3582 @end example
3584 @node Packages that do not come with Emacs, Submitting to the Emacs Lisp Archive, Finding a package with particular functionality, Finding Emacs and related packages
3585 @section Where can I get Emacs Lisp packages that don't come with Emacs?
3586 @cindex Unbundled packages
3587 @cindex Finding other packages
3588 @cindex Lisp packages that do not come with Emacs
3589 @cindex Packages, those that do not come with Emacs
3590 @cindex Emacs Lisp Archive, description of
3591 @cindex Archive, description of the Emacs Lisp
3593 First, check the Lisp Code Directory to find the name of the package you
3594 are looking for (@pxref{Finding a package with particular
3595 functionality}).  Next, check local archives and the Emacs Lisp Archive
3596 to find a copy of the relevant files.  If you still haven't found it,
3597 you can send e-mail to the author asking for a copy.  If you find Emacs
3598 Lisp code that doesn't appear in the LCD, please submit a copy to the
3599 LCD (@pxref{Submitting to the Emacs Lisp Archive}).
3601 You can access the Emacs Lisp Archive at
3603 @uref{ftp://archive.cis.ohio-state.edu/pub/emacs-lisp/}
3605 @noindent
3606 or at
3608 @uref{http://www.cis.ohio-state.edu/emacs-lisp}
3610 @noindent
3611 Retrieve and read the file @file{README} first.
3613 @itemize @bullet
3615 @item
3616 The archive maintainers do not have time to answer individual
3617 requests for packages or the list of packages in the archive.  If you
3618 cannot use FTP or UUCP to access the archive yourself, try to find a
3619 friend who can, but please don't ask the maintainers.
3621 @item
3622 Any files with names ending in @file{.Z}, @file{.z}, or @file{.gz} are
3623 compressed, so you should use "binary" mode in FTP to retrieve them.
3624 You should also use binary mode whenever you retrieve any files with
3625 names ending in @file{.elc}.
3627 @end itemize
3629 @node Submitting to the Emacs Lisp Archive, Current GNU distributions, Packages that do not come with Emacs, Finding Emacs and related packages
3630 @section How do I submit code to the Emacs Lisp Archive?
3631 @cindex Submitting code to the Emacs Lisp Archive
3632 @cindex Emacs Lisp Archive, submissions to
3633 @cindex Lisp Archive, submissions to
3634 @cindex Archive, submitting to the Emacs Lisp
3636 Guidelines and procedures for submission to the archive can be found in
3637 the file @file{GUIDELINES} in the archive directory (@pxref{Packages that
3638 do not come with Emacs}).  It covers documentation, copyrights,
3639 packaging, submission, and the Lisp Code Directory Record.  Anonymous
3640 FTP uploads are not permitted.  Instead, all submissions are mailed to
3641 @email{elisp-archive@@cis.ohio-state.edu}.  The @file{lispdir.el}
3642 package has a function named @code{submit-lcd-entry} which will help you
3643 with this.
3645 @node Current GNU distributions, Difference between Emacs and XEmacs, Submitting to the Emacs Lisp Archive, Finding Emacs and related packages
3646 @section Where can I get other up-to-date GNU stuff?
3647 @cindex Current GNU distributions
3648 @cindex Sources for current GNU distributions
3649 @cindex Stuff, current GNU
3650 @cindex Up-to-date GNU stuff
3651 @cindex Finding current GNU software
3652 @cindex Official GNU software sites
3654 The most up-to-date official GNU software is normally kept at
3656 @uref{ftp://ftp.gnu.org/pub/gnu}
3658 Read the files @file{etc/DISTRIB} and @file{etc/FTP} for more
3659 information.
3661 A list of sites mirroring @samp{ftp.gnu.org} can be found at
3663 @uref{http://www.gnu.org/order/ftp.html}
3665 @node Difference between Emacs and XEmacs, Emacs for MS-DOS, Current GNU distributions, Finding Emacs and related packages
3666 @section What is the difference between Emacs and XEmacs (formerly "Lucid Emacs")?
3667 @cindex XEmacs
3668 @cindex Difference Emacs and XEmacs
3669 @cindex Lucid Emacs
3670 @cindex Epoch
3672 First of all, they're both GNU Emacs.  XEmacs is just as much a later
3673 version of GNU Emacs as the FSF-distributed version.  This FAQ refers to
3674 the latest version to be distributed by the FSF as ``Emacs,'' partly
3675 because the XEmacs maintainers now refer to their product using the
3676 ``XEmacs'' name, and partly because there isn't any accurate way to
3677 differentiate between the two without getting mired in paragraphs of
3678 legalese and history.
3680 XEmacs, which began life as Lucid Emacs, is based on an early version of
3681 Emacs 19 and Epoch, an X-aware version of Emacs 18.
3683 Emacs (i.e., the version distributed by the FSF) has a larger installed
3684 base and now always contains the MULE multilingual facilities.
3685 XEmacs can do some clever tricks with X and MS-Windows, such as
3686 putting arbitrary graphics in a buffer.  Similar facilities have been
3687 implemented for Emacs as part of a new redisplay implementation for
3688 Emacs 21, and are available in the latest Emacs releases.
3689 Emacs and XEmacs each come with
3690 Lisp packages that are lacking in the other; RMS says that the FSF would
3691 include more packages that come with XEmacs, but that the XEmacs
3692 maintainers don't always keep track of the authors of contributed code,
3693 which makes it impossible for the FSF to have certain legal papers
3694 signed.  (Without these legal papers, the FSF will not distribute Lisp
3695 packages with Emacs.)  The two versions have some
3696 significant differences at the Lisp programming level.
3698 Many XEmacs features have found their way into recent versions of Emacs,
3699 and more features can be expected in the future, but there are still many
3700 differences between the two.
3702 The latest stable version of XEmacs as of this writing is 21.1; you can
3703 get it at
3705 @uref{ftp://ftp.xemacs.org/pub/xemacs/current/xemacs-21.1.13.tar.gz}
3707 More information about XEmacs, including a list of frequently asked
3708 questions (FAQ), is available at
3710 @uref{http://www.xemacs.org/}
3712 @node Emacs for MS-DOS, Emacs for Windows, Difference between Emacs and XEmacs, Finding Emacs and related packages
3713 @section Where can I get Emacs for my PC running MS-DOS?
3714 @cindex MS-DOS, Emacs for
3715 @cindex DOS, Emacs for
3716 @cindex Compiling Emacs for DOS
3717 @cindex Emacs for MS-DOS
3718 @cindex Tools needed to compile Emacs under DOS
3720 A pre-built binary distribution of Emacs is available from the
3721 SimTel.NET archives.  This version apparently works under MS-DOS and
3722 Windows (3.X, 9X, ME, NT, and 2000) and supports long file names under
3723 Windows 9X, Windows ME, and Windows 2000.  More information is available
3724 from
3726 @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/emacs.README}
3728 The binary itself is available in the files @file{em*.zip} in the
3729 directory
3731 @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/}
3733 If you prefer to compile Emacs for yourself, you can do so with the
3734 current distribution directly.  You will need a 386 (or
3735 better) processor, and to be running MS-DOS 3.0 or later.  According to
3736 @email{eliz@@is.elta.co.il, Eli Zaretskii} and
3737 @email{hankedr@@dms.auburn.edu, Darrel Hankerson}, you will need the
3738 following:
3740 @table @emph
3742 @item Compiler
3743 DJGPP version 1.12 maint 1 or later.  Djgpp 2.0 or later is
3744 recommended, since 1.x is very old an unmaintained.  Djgpp 2 supports
3745 long file names on Windows 9X/ME/2K.
3747 You can get the latest release of DJGPP by retrieving all of
3748 the files in
3750 @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2*}
3752 @item Unpacking program
3753 The easiest way is to use @code{djtar} which comes with DJGPP v2.x,
3754 because it can open gzip'ed tarfiles (i.e., those ending with
3755 @file{.tar.gz}) in one step.  @code{Djtar} comes in
3756 @file{djdev@var{nnn}.zip} archive (where @var{nnn} is the DJGPP version
3757 number), from the URL mentioned above.
3759 @strong{Warning!}  Do @strong{not} use the popular WinZip program to
3760 unpack the Emacs distribution!  WinZip is known to corrupt some of the
3761 files by converting them to the DOS CR-LF format, it doesn't always
3762 preserve the directory structure recorded in the compressed Emacs
3763 archive, and commits other atrocities.  Some of these problems could
3764 actually prevent Emacs from building successfully!
3766 @item make, mv, sed, and rm
3767 All of these utilities are available at
3769 @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu}
3771 16-bit utilities can be found in GNUish, at
3773 @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/gnuish}
3775 @noindent
3776 (@code{mv} and @code{rm} are in the Fileutils package, @code{sed} and
3777 @code{make} are each one in a separate package named after them.)
3779 @end table
3781 The files @file{INSTALL} (near its end) and @file{etc/PROBLEMS} in the
3782 directory of the Emacs sources contains some additional information
3783 regarding Emacs under MS-DOS.
3785 For a list of other MS-DOS implementations of Emacs (and Emacs
3786 look-alikes), consult the list of "Emacs implementations and literature,"
3787 available at
3789 @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/}
3791 Note that while many of these programs look similar to Emacs, they often
3792 lack certain features, such as the Emacs Lisp extension language.
3794 @node Emacs for Windows, Emacs for OS/2, Emacs for MS-DOS, Finding Emacs and related packages
3795 @section Where can I get Emacs for Microsoft Windows
3796 @cindex FAQ for NT Emacs
3797 @cindex Emacs for MS-Windows
3798 @cindex Microsoft Windows, Emacs for
3799 @cindex Windows 9X, ME, NT, 2K, and CE, Emacs for
3801 For information on Emacs for Windows 95 and NT, read the FAQ produced by
3802 @email{voelker@@cs.washington.edu, Geoff Voelker}, available at
3804 @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html}
3806 @xref{Emacs for MS-DOS}, for Windows 3.1.
3808 A port of Emacs 20.7 for Windows CE, based on NTEmacs, is available at
3810 @uref{http://www.rainer-keuchel.de/software.html}
3812 @noindent
3813 This port was done by @email{coyxc@@rainer-keuchel.de, Rainer Keuchel},
3814 and supports all Emacs features except async subprocesses and menus.
3815 You will need MSVC 6.0 and a Windows CE SDK to build this port.
3817 @node Emacs for OS/2, Emacs for Atari ST, Emacs for Windows, Finding Emacs and related packages
3818 @section Where can I get Emacs for my PC running OS/2?
3819 @cindex OS/2, Emacs for
3821 Emacs 20.6 is ported for emx on OS/2 2.0 or 2.1, and is available at
3823 @uref{ftp://hobbes.nmsu.edu/pub/os2/apps/editors/emacs/e206*.zip}
3825 @noindent
3826 and also at
3828 @uref{http://archiv.leo.org/pub/comp/os/os2/leo/gnu/emacs%2d20/}
3830 Instructions for installation, basic setup, and other useful information
3831 for OS/2 users of Emacs can be found at
3833 @uref{http://userpage.fu-berlin.de/~oheiabbd/emacs/emacs206-os2.html}
3835 @node Emacs for Atari ST, Emacs for the Amiga , Emacs for OS/2, Finding Emacs and related packages
3836 @section Where can I get Emacs for my Atari ST?
3837 @cindex Atari ST, Emacs for
3838 @cindex TOS, Emacs for
3840 Roland Schäuble reports that Emacs 18.58 running on plain TOS and MiNT
3841 is available at
3842 @uref{ftp://atari.archive.umich.edu/Editors/Emacs-18-58/1858b-d3.zoo}.
3844 @node Emacs for the Amiga , Emacs for NeXTSTEP, Emacs for Atari ST, Finding Emacs and related packages
3845 @section Where can I get Emacs for my Amiga?
3846 @cindex Amiga, Emacs for
3848 The files you need are available at
3850 @uref{ftp://ftp.wustl.edu/pub/aminet/util/gnu/}
3852 @email{dgilbert@@gamiga.guelphnet.dweomer.org, David Gilbert} has released a
3853 beta version of Emacs 19.25 for the Amiga.  You can get the binary at
3855 @uref{ftp://ftp.wustl.edu/pub/aminet/util/gnu/a2.0bEmacs-bin.lha}
3857 @node Emacs for NeXTSTEP, Emacs for Apple computers, Emacs for the Amiga , Finding Emacs and related packages
3858 @section Where can I get Emacs for NeXTSTEP?
3859 @cindex NeXTSTEP, Emacs for
3861 Emacs.app is a NeXTSTEP version of Emacs 19.34 which supports colors,
3862 menus, and multiple frames.  You can get it from
3864 @uref{ftp://next-ftp.peak.org/pub/next/apps/emacs/Emacs_for_NeXTstep.4.20a1.NIHS.b.tar.gz}
3866 @node Emacs for Apple computers, Emacs for VMS and DECwindows, Emacs for NeXTSTEP, Finding Emacs and related packages
3867 @section Where can I get Emacs for my Apple computer?
3868 @cindex Apple computers, Emacs for
3869 @cindex Macintosh, Emacs for
3871 An unofficial port of GNU Emacs 18.59 to the Macintosh is available at a
3872 number of ftp sites, the home being
3873 @uref{ftp://ftp.cs.cornell.edu/pub/parmet/Emacs-1.17.sit.bin}.
3875 A port of Emacs 20.4 is available at
3876 @uref{http://www.cs.hku.hk/~choi/emacs/index.html}.
3878 Beginning with version 21.1, the Macintosh is supported in the official
3879 Emacs distribution; see the files @file{mac/README} and
3880 @file{mac/INSTALL} in the Emacs distribution for build instructions.
3882 Apple's forthcoming "OS X" is based largely on NeXTSTEP and OpenStep.
3883 @xref{Emacs for NeXTSTEP}, for more details about that version.
3885 @node Emacs for VMS and DECwindows, Modes for various languages, Emacs for Apple computers, Finding Emacs and related packages
3886 @section Where do I get Emacs that runs on VMS under DECwindows?
3887 @cindex DECwindows, Emacs for
3888 @cindex VMS, Emacs for
3890 Up-to-date information about GNU software (including Emacs) for VMS is
3891 available at @uref{http://vms.gnu.org/}.
3893 @node Modes for various languages, Translating names to IP addresses, Emacs for VMS and DECwindows, Finding Emacs and related packages
3894 @section Where can I get modes for Lex, Yacc/Bison, Bourne shell, csh, C@t{++}, Objective-C, Pascal, Java, and Awk?
3895 @cindex Awk, mode for
3896 @cindex @code{awk-mode}
3897 @cindex Bison, mode for
3898 @cindex Bourne Shell, mode for
3899 @cindex C@t{++}, mode for
3900 @cindex Java, mode for
3901 @cindex Lex mode
3902 @cindex Objective-C, mode for
3903 @cindex @code{pascal-mode}
3904 @cindex Shell mode
3905 @cindex Yacc mode
3906 @cindex @file{csh} mode
3907 @cindex @code{sh-mode}
3908 @cindex @code{cc-mode}
3910 Most of these modes are now available in standard Emacs distribution.
3911 To get additional modes, look in the Lisp Code Directory (@pxref{Finding
3912 a package with particular functionality}).  For C@t{++}, if you use
3913 @code{lisp-dir-apropos}, you must specify the pattern with something
3914 like @kbd{M-x lisp-dir-apropos @key{RET} c\+\+ @key{RET}}.@footnote{
3915 The backslashes in @samp{\+\+} are required because @kbd{M-x
3916 lisp-dir-apropos} expects a regular expression as its argument
3917 (@pxref{Using regular expressions}), and @samp{+} has a special meaning
3918 in regular expressions.}
3920 Barry Warsaw's @code{cc-mode} now works for C, C@t{++}, Objective-C, and
3921 Java code.  You can get the latest version from the Emacs Lisp Archive;
3922 @pxref{Packages that do not come with Emacs} for details.  A FAQ for
3923 @code{cc-mode} is available at
3924 @uref{http://www.python.org/emacs/cc-mode/}.
3926 @node Translating names to IP addresses,  , Modes for various languages, Finding Emacs and related packages
3927 @section What is the IP address of XXX.YYY.ZZZ?
3928 @cindex Translating names to IP addresses
3929 @cindex IP addresses from names
3930 @cindex Using BIND to translate addresses
3931 @cindex DNS and IP addresses
3933 If you are on a Unix machine, try using the @samp{nslookup} command,
3934 included in the Berkeley BIND package.  For example, to find the IP
3935 address of @samp{ftp.gnu.org}, you would type @code{nslookup
3936 ftp.gnu.org}.
3938 Your computer should then provide the IP address of that machine.
3940 If your site's nameserver is deficient, you can use IP addresses to FTP
3941 files.  You can get this information by e-mail:
3943 @example
3944 To: dns@@[134.214.84.25]    (to grasp.insa-lyon.fr)
3945 Body: ip XXX.YYY.ZZZ        (or "help" for more information 
3946                              and options - no quotes) 
3947 @end example
3949 @noindent
3952 @example
3953 To: resolve@@[147.31.254.130]         (to laverne.cs.widener.edu)
3954 Body: site XXX.YYY.ZZZ
3955 @end example
3957 @c ------------------------------------------------------------
3958 @node Major packages and programs, Key bindings, Finding Emacs and related packages, Top
3959 @chapter Major packages and programs
3960 @cindex Major packages and programs
3962 @menu
3963 * VM::                          
3964 * Supercite::                   
3965 * Calc::                        
3966 * VIPER::                       
3967 * AUC-TeX::                     
3968 * BBDB::                        
3969 * Ispell::                      
3970 * w3-mode::                     
3971 * EDB::                         
3972 * Mailcrypt::                   
3973 * JDE::                         
3974 * Patch::                       
3975 @end menu
3977 @node VM, Supercite, Major packages and programs, Major packages and programs
3978 @section VM (View Mail) --- another mail reader within Emacs, with MIME support
3979 @cindex VM
3980 @cindex Alternative mail software
3981 @cindex View Mail
3982 @cindex E-mail reader, VM
3984 @table @b
3986 @item Author
3987 @email{kyle@@uunet.uu.net, Kyle Jones}
3989 @item Latest version
3990 6.72
3992 @item Distribution
3993 @uref{ftp://ftp.wonderworks.com/pub/vm/vm.tar.gz}
3995 @item Informational newsgroup/mailing list
3996 @uref{news:gnu.emacs.vm.info}@*
3997 Subscription requests to @email{info-vm-request@@uunet.uu.net}@*
3998 Submissions to @email{info-vm@@uunet.uu.net}
4000 @item Bug reports newsgroup/mailing list
4001 @uref{news:gnu.emacs.vm.bug}@*
4002 Subscription requests to @email{bug-vm-request@@uunet.uu.net}@*
4003 Submissions to @email{bug-vm@@uunet.uu.net}
4004 @end table
4006 VM 6 works with Emacs 20.4, and may cause problems with Emacs 20.3 and
4007 below.  (But note that many people seem to use Emacs 20.3 with VM 6,
4008 without any problems.)  Risk-averse users might wish to try VM 5.97,
4009 available from @uref{ftp://ftp.wonderworks.com/pub/vm/, the same FTP
4010 site}.
4012 @node Supercite, Calc, VM, Major packages and programs
4013 @section Supercite --- mail and news citation package within Emacs
4014 @cindex Supercite
4015 @cindex Superyank
4016 @cindex Mail and news citations
4017 @cindex News and mail citations
4018 @cindex Citations in mail and news
4020 @table @b
4022 @item Author
4023 @email{bwarsaw@@cen.com, Barry Warsaw}
4025 @item Latest version
4026 3.54 (comes bundled with Emacs 20)
4028 @item Distribution
4029 @uref{http://www.python.org/emacs/supercite.tar.gz}
4031 @item Mailing list
4032 Subscription requests to @email{supercite-request@@python.org}@*
4033 Submissions @email{supercite@@python.org}
4035 @end table
4037 Superyank is an old version of Supercite.
4039 @node Calc, VIPER, Supercite, Major packages and programs
4040 @section Calc --- poor man's Mathematica within Emacs
4041 @cindex Programmable calculator
4042 @cindex Calc
4043 @cindex Mathematical package
4045 @table @b
4047 @item Author
4048 @email{daveg@@csvax.cs.caltech.edu, Dave Gillespie}
4050 @item Latest version
4051 2.02f
4053 @item Distribution
4054 @uref{ftp://ftp.gnu.org/pub/gnu/calc/calc-2.02f.tar.gz}
4056 @end table
4058 Note that Calc 2.02f needs patching to work with Emacs 21 and later.
4060 @cindex @code{calculator}, a package
4061 Emacs 21.1 and later comes with a package called @file{calculator.el}.
4062 It doesn't support all the mathematical wizardry offered by Calc, such
4063 as matrices, special functions, and statistics, but is more than
4064 adequate as a replacement for @code{xcalc} and similar programs.
4066 @node VIPER, AUC-TeX, Calc, Major packages and programs
4067 @section VIPER --- @code{vi} emulation for Emacs
4068 @cindex @code{vi} emulation
4069 @cindex VIPER
4070 @cindex Emulation of @code{vi}
4072 Since Emacs 19.29, the preferred @code{vi} emulation in Emacs is VIPER
4073 (@kbd{M-x viper-mode @key{RET}}), which comes with Emacs.  It extends
4074 and supersedes VIP (including VIP 4.3) and provides @code{vi} emulation
4075 at several levels, from one that closely follows @code{vi} to one that
4076 departs from @code{vi} in several significant ways.
4078 For Emacs 19.28 and earlier, the following version of VIP is generally
4079 better than the one distributed with Emacs:
4081 @table @b
4082 @item Author
4083 @email{sane@@cs.uiuc.edu, Aamod Sane}
4085 @item Latest version
4088 @item Distribution
4089 @uref{ftp://archive.cis.ohio-state.edu/pub/emacs-lisp/modes/vip-mode.tar.Z}
4091 @end table
4093 @node AUC-TeX, BBDB, VIPER, Major packages and programs
4094 @section AUC TeX --- enhanced LaTeX mode with debugging facilities
4095 @cindex Mode for @TeX{}
4096 @cindex @TeX{} mode
4097 @cindex AUC-TeX mode for editing @TeX{}
4098 @cindex Writing and debugging @TeX{}
4100 @table @b
4102 @item Authors
4103 @email{krab@@iesd.auc.dk, Kresten Krab Thorup} and@*
4104 @email{abraham@@dina.kvl.dk, Per Abrahamsen}
4106 @item Latest version
4107 9.9p
4109 @item Distribution
4110 @uref{ftp://sunsite.auc.dk/packages/auctex/auctex.tar.gz}
4112 @item Web site
4113 @uref{http://sunsite.auc.dk/auctex/}
4115 @item Mailing list:
4116 Subscription requests to @email{auc-tex-request@@iesd.auc.dk}@*
4117 Submissions to @email{auc-tex@@iesd.auc.dk}@*
4118 Development team is at @email{auc-tex_mgr@@iesd.auc.dk}
4120 @end table
4122 @node BBDB, Ispell, AUC-TeX, Major packages and programs
4123 @section BBDB --- personal Info Rolodex integrated with mail/news readers
4124 @cindex BBDB
4125 @cindex Rolodex-like functionality
4126 @cindex Integrated contact database
4127 @cindex Contact database
4128 @cindex Big Brother Database
4129 @cindex Address book
4131 @table @b
4133 @item Maintainer
4134 @email{simmonmt@@acm.org, Matt Simmons}
4136 @item Latest version
4137 2.00
4139 @item Distribution
4140 @uref{http://www.netcom.com/~simmonmt/bbdb/index.html}
4142 @item Mailing lists
4143 Subscription requests to @email{info-bbdb-request@@xemacs.org}@*
4144 Submissions to @email{info-bbdb@@xemacs.org}@*
4145 Release announcements: @email{bbdb-announce-request@@xemacs.org}
4147 @end table
4149 @node Ispell, w3-mode, BBDB, Major packages and programs
4150 @section Ispell --- spell checker in C with interface for Emacs
4151 @cindex Spell-checker
4152 @cindex Checking spelling
4153 @cindex Ispell
4155 @table @b
4157 @item Author
4158 @email{geoff@@itcorp.com, Geoff Kuenning}
4160 @item Latest version
4161 3.1.20
4163 @item Distribution
4164 @uref{ftp://ftp.cs.ucla.edu/pub/ispell/ispell-3.1.20.tar.gz}@*
4166 @item Web site
4167 @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html}
4169 @end table
4171 @itemize @bullet
4173 @item
4174 Do not ask Geoff to send you the latest version of Ispell. He does not
4175 have free e-mail.
4177 @item
4178 This Ispell program is distinct from GNU Ispell 4.0. GNU Ispell 4.0 is
4179 no longer a supported product.
4181 @end itemize
4183 @node w3-mode, EDB, Ispell, Major packages and programs
4184 @section w3-mode --- A World Wide Web browser inside of Emacs
4185 @cindex WWW browser
4186 @cindex Web browser
4187 @cindex HTML browser in Emacs
4188 @cindex @code{w3-mode}
4190 @table @b
4192 @item Author
4193 @email{wmperry@@spry.com, Bill Perry}
4195 @item Latest version
4196 4.0pre.39
4198 @item Distribution
4199 @uref{ftp://ftp.cs.indiana.edu/pub/elisp/w3/w3.tar.gz}
4201 @item Mailing lists
4202 Receive announcements from @email{w3-announce-request@@indiana.edu}@*
4203 Become a beta tester at @email{w3-beta-request@@indiana.edu}@*
4204 Help to develop @code{w3-mode} at @email{w3-dev@@indiana.edu}
4206 @end table
4208 @node EDB, Mailcrypt, w3-mode, Major packages and programs
4209 @section EDB --- Database program for Emacs; replaces forms editing modes
4210 @cindex EDB
4211 @cindex Database
4212 @cindex Forms mode
4214 @table @b
4215 @item Author
4216 @email{mernst@@theory.lcs.mit.edu, Michael Ernst}
4218 @item Latest version
4219 1.21
4221 @item Distribution
4222 @uref{ftp://theory.lcs.mit.edu/pub/emacs/edb}
4224 @end table
4226 @node Mailcrypt, JDE, EDB, Major packages and programs
4227 @section Mailcrypt --- PGP interface within Emacs mail and news
4228 @cindex PGP
4229 @cindex GPG
4230 @cindex Interface to PGP from Emacs mail and news
4231 @cindex News, interface to PGP from
4232 @cindex Mail, interface to PGP from
4233 @cindex Encryption software, interface to
4235 @table @b
4237 @item Authors
4238 @email{patl@@lcs.mit.edu, Patrick J. LoPresti} and
4239 @email{jin@@atype.com, Jin S. Choi}
4241 @item Maintainer
4242 @email{lbudney@@pobox.com, Len Budney}
4244 @item Latest version
4245 3.5.3
4247 @item Distribution
4248 @uref{http://www.nb.net/~lbudney/linux/software/mailcrypt/mailcrypt-3.5.3.tar.gz}
4250 @item Web site
4251 @uref{http://www.nb.net/~lbudney/linux/software/mailcrypt.html}
4253 @end table
4255 @node JDE, Patch, Mailcrypt, Major packages and programs
4256 @section JDE --- Integrated development environment for Java
4257 @cindex Java development environment
4258 @cindex Integrated Java development environment
4259 @cindex JDE
4261 @table @b
4263 @item Author
4264 @email{paulk@@mathworks.com, Paul Kinnucan}
4266 @item Mailing list
4267 jde-subscribe@@sunsite.auc.dk
4269 @item Latest version
4270 2.1.1
4272 @item Web site
4273 @uref{http://sunsite.auc.dk/jde/}
4275 @end table
4277 @node Patch,  , JDE, Major packages and programs
4278 @section Patch --- program to apply "diffs" for updating files
4279 @cindex Updating files with diffs
4280 @cindex Patching source files with diffs
4281 @cindex Diffs and patching
4282 @cindex @file{patch}
4284 @table @b
4286 @item Author
4287 @email{lwall@@wall.org, Larry Wall} (with GNU modifications)
4289 @item Latest version
4290 2.5.4
4292 @item Distribution
4293 @xref{Current GNU distributions}.
4295 @end table
4297 @c ------------------------------------------------------------
4298 @node Key bindings, Alternate character sets, Major packages and programs, Top
4299 @chapter Key bindings
4300 @cindex Key bindings
4302 @menu
4303 * Binding keys to commands::    
4304 * Invalid prefix characters::   
4305 * Terminal setup code works after Emacs has begun::  
4306 * Using function keys under X::  
4307 * Working with function and arrow keys::  
4308 * X key translations for Emacs::  
4309 * Handling C-s and C-q with flow control::  
4310 * Binding C-s and C-q::         
4311 * Backspace invokes help::      
4312 * stty and Backspace key::      
4313 * Swapping keys::               
4314 * Producing C-XXX with the keyboard::  
4315 * No Meta key::                 
4316 * No Escape key::               
4317 * Compose Character::           
4318 * Binding combinations of modifiers and function keys::  
4319 * Meta key does not work in xterm::  
4320 * ExtendChar key does not work as Meta::  
4321 @end menu
4323 @node Binding keys to commands, Invalid prefix characters, Key bindings, Key bindings
4324 @section How do I bind keys (including function keys) to commands?
4325 @cindex Binding keys to commands
4326 @cindex Keys, binding to commands
4327 @cindex Commands, binding keys to
4329 Keys can be bound to commands either interactively or in your
4330 @file{.emacs} file.  To interactively bind keys for all modes, type
4331 @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
4333 To bind a key just in the current major mode, type @kbd{M-x
4334 local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}.
4336 @inforef{Key Bindings, Key Bindings, emacs}, for further details.
4338 To make the process of binding keys interactively eaiser, use the
4339 following ``trick'': First bind the key interactively, then immediately
4340 type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}.  Now, the command needed
4341 to bind the key is in the kill ring, and can be yanked into your
4342 @file{.emacs} file.  If the key binding is global, no changes to the
4343 command are required.  For example,
4345 @lisp
4346 (global-set-key (quote [f1]) (quote help-for-help))
4347 @end lisp
4349 @noindent
4350 can be placed directly into the @file{.emacs} file.  If the key binding is
4351 local, the command is used in conjunction with the "add-hook" command.
4352 For example, in tex-mode, a local binding might be
4354 @lisp
4355 (add-hook 'tex-mode-hook
4356   (lambda ()
4357    (local-set-key (quote [f1]) (quote help-for-help))))
4358 @end lisp
4361 @itemize @bullet
4363 @item
4364 Control characters in key sequences, in the form yanked from the kill
4365 ring are given in their graphic form---i.e., @key{CTRL} is shown as
4366 @samp{^}, @key{TAB} as a set of spaces (usually 8), etc.  You may want
4367 to convert these into their vector or string forms.
4369 @item
4370 If a prefix key of the character sequence to be bound is already
4371 bound as a complete key, then you must unbind it before the new
4372 binding.  For example, if @kbd{ESC @{} is previously bound:
4374 @lisp
4375 (global-unset-key [?\e ?@{])   ;;   or
4376 (local-unset-key [?\e ?@{])
4377 @end lisp
4379 @item
4380 Aside from commands and ``lambda lists,'' a vector or string also
4381 can be bound to a key and thus treated as a macro.  For example:
4383 @lisp
4384 (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g])  ;;  or
4385 (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g")
4386 @end lisp
4388 @end itemize
4390 @node Invalid prefix characters, Terminal setup code works after Emacs has begun, Binding keys to commands, Key bindings
4391 @section Why does Emacs say "Key sequence XXX uses invalid prefix characters"?
4392 @cindex Prefix characters, invalid
4393 @cindex Invalid prefix characters
4394 @cindex Misspecified key sequences
4396 Usually, one of two things has happened.  In one case, the control
4397 character in the key sequence has been misspecified (e.g. @samp{C-f}
4398 used instead of @samp{\C-f} within a Lisp expression).  In the other
4399 case, a @dfn{prefix key} in the keystroke sequence you were trying to bind
4400 was already bound as a @dfn{complete key}.  Historically, the @samp{ESC [}
4401 prefix was usually the problem, in which case you should evaluate either
4402 of these forms before attempting to bind the key sequence:
4404 @lisp
4405 (global-unset-key [?\e ?[])  ;;  or
4406 (global-unset-key "\e[")
4407 @end lisp
4409 @node Terminal setup code works after Emacs has begun, Using function keys under X, Invalid prefix characters, Key bindings
4410 @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?
4411 @cindex Terminal setup code in @file{.emacs}
4413 During startup, Emacs initializes itself according to a given code/file
4414 order.  If some of the code executed in your @file{.emacs} file needs to
4415 be postponed until the initial terminal or window-system setup code has
4416 been executed but is not, then you will experience this problem (this
4417 code/file execution order is not enforced after startup).
4419 To postpone the execution of Emacs Lisp code until after terminal or
4420 window-system setup, treat the code as a @dfn{lambda list} and set the
4421 value of either the @code{term-setup-hook} or @code{window-setup-hook}
4422 variable to this lambda function.  For example,
4424 @lisp
4425 (add-hook 'term-setup-hook
4426           (lambda ()
4427            (when (string-match "\\`vt220" (or (getenv "TERM") ""))
4428              ;; Make vt220's "Do" key behave like M-x:
4429              (global-set-key [do] 'execute-extended-command))))
4430 @end lisp
4432 For information on what Emacs does every time it is started, see the
4433 @file{lisp/startup.el} file.
4435 @node Using function keys under X, Working with function and arrow keys, Terminal setup code works after Emacs has begun, Key bindings
4436 @section How do I use function keys under X?
4437 @cindex Function keys
4438 @cindex X Window System and function keys
4439 @cindex Binding function keys
4441 With Emacs 19, functions keys under X are bound like any other key.  @xref{Binding keys to commands}, for details.
4443 @node Working with function and arrow keys, X key translations for Emacs, Using function keys under X, Key bindings
4444 @section How do I tell what characters or symbols my function or arrow keys emit?
4445 @cindex Working with arrow keys
4446 @cindex Arrow keys, symbols generated by
4447 @cindex Working with function keys
4448 @cindex Function keys, symbols generated by
4449 @cindex Symbols generated by function keys
4451 Type @kbd{C-h c} then the function or arrow keys.  The command will
4452 return either a function key symbol or character sequence (see the
4453 Emacs on-line documentation for an explanation).  This works for other
4454 keys as well.
4456 @node X key translations for Emacs, Handling C-s and C-q with flow control, Working with function and arrow keys, Key bindings
4457 @section How do I set the X key ``translations'' for Emacs?
4458 @cindex X key translations
4459 @cindex Key translations under X
4460 @cindex Translations for keys under X
4462 Emacs is not written using the Xt library by default, so there are no
4463 ``translations'' to be set.  (We aren't sure how to set such translations
4464 if you do build Emacs with Xt; please let us know if you've done this!)
4466 The only way to affect the behavior of keys within Emacs is through
4467 @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs).  The
4468 @code{define-key} command should be used in conjunction with the
4469 @code{function-key-map} map.  For instance,
4471 @lisp
4472 (define-key function-key-map [M-@key{TAB}] [?\M-\t])
4473 @end lisp
4475 @noindent
4476 defines the @kbd{M-@key{TAB}} key sequence.
4478 @node Handling C-s and C-q with flow control, Binding C-s and C-q, X key translations for Emacs, Key bindings
4479 @section How do I handle @kbd{C-s} and @kbd{C-q} being used for flow control?
4480 @cindex Flow control, @kbd{C-s} and @kbd{C-q} with
4481 @cindex @kbd{C-s} and @kbd{C-q} with flow control
4483 @kbd{C-s} and @kbd{C-q} are used in the XON/XOFF flow control protocol.
4484 This messes things up when you're using Emacs over a serial line,
4485 because Emacs binds these keys to commands by default.  Because Emacs
4486 won't honor them as flow control characters, too many of these
4487 characters are not passed on and overwhelm output buffers.  Sometimes,
4488 intermediate software using XON/XOFF flow control will prevent Emacs
4489 from ever seeing @kbd{C-s} and @kbd{C-q}.
4491 Possible solutions:
4493 @itemize @bullet
4495 @item
4496 Disable the use of @kbd{C-s} and @kbd{C-q} for flow control.
4498 You need to determine the cause of the flow control.
4500 @itemize @minus
4502 @item
4503 your terminal
4505 Your terminal may use XON/XOFF flow control to have time to display
4506 all the characters it receives.  For example, VT series terminals do
4507 this.  It may be possible to turn this off from a setup menu.  For
4508 example, on a VT220 you may select ``No XOFF'' in the setup menu.  This
4509 is also true for some terminal emulation programs on PCs.
4511 When you turn off flow control at the terminal, you will also need to
4512 turn it off at the other end, which might be at the computer you are
4513 logged in to or at some terminal server in between.
4515 If you turn off flow control, characters may be lost; using a printer
4516 connected to the terminal may fail.  You may be able to get around
4517 this problem by modifying the @samp{termcap} entry for your terminal to
4518 include extra NUL padding characters.
4520 @item
4521 a modem
4523 If you are using a dialup connection, the modems may be using
4524 XON/XOFF flow control.  It's not clear how to get around this.
4526 @item
4527 a router or terminal server
4529 Some network box between the terminal and your computer may be using
4530 XON/XOFF flow control.  It may be possible to make it use some other
4531 kind of flow control.  You will probably have to ask your local
4532 network experts for help with this.
4534 @item
4535 @code{tty} and/or @code{pty} devices
4537 If your connection to Emacs goes through multiple @code{tty} and/or
4538 @code{pty} devices, they may be using XON/XOFF flow control even when it
4539 is not necessary.
4541 @email{eirik@@theory.tn.cornell.edu, Eirik Fuller} writes:
4543 @quotation
4544 Some versions of @code{rlogin} (and possibly @code{telnet}) do not pass
4545 flow control characters to the remote system to which they connect.  On
4546 such systems, Emacs on the remote system cannot disable flow control on
4547 the local system.  Sometimes @samp{rlogin -8} will avoid this problem.
4549 One way to cure this is to disable flow control on the local host (the
4550 one running @code{rlogin}, not the one running @code{rlogind}) using the
4551 @code{stty} command, before starting the @code{rlogin} process.  On many
4552 systems, @samp{stty start u stop u} will do this.
4554 Some versions of @samp{tcsh} will prevent even this from working.  One
4555 way around this is to start another shell before starting rlogin,
4556 and issue the @samp{stty} command to disable flow control from that shell.
4557 @end quotation
4559 Use @samp{stty -ixon} instead of @samp{stty start u stop u} on some systems.
4561 @end itemize
4563 @item
4564 Make Emacs speak the XON/XOFF flow control protocol.
4566 You can make Emacs treat @kbd{C-s} and @kbd{C-q} as flow control characters by
4567 evaluating the form
4569 @lisp
4570 (enable-flow-control)
4571 @end lisp
4573 @noindent
4574 to unconditionally enable flow control or
4576 @lisp
4577 (enable-flow-control-on "vt100" "h19")
4578 @end lisp
4580 @noindent
4581 (using your terminal names instead of @samp{vt100} or @samp{h19}) to
4582 enable selectively.  These commands will automatically swap @kbd{C-s}
4583 and @kbd{C-q} to @kbd{C-\} and @kbd{C-^}.  Variables can be used to
4584 change the default swap keys (@code{flow-control-c-s-replacement} and
4585 @code{flow-control-c-q-replacement}).
4587 If you are fixing this for yourself, simply put the form in your
4588 @file{.emacs} file.  If you are fixing this for your entire site, the
4589 best place to put it is in the @file{site-lisp/site-start.el} file.
4590 (Here @file{site-lisp} is actually a subdirectory of your Emacs
4591 installation directory, typically @file{/usr/local/share/emacs}.)
4592 Putting this form in @file{site-lisp/default.el} has the problem that
4593 if the user's @file{.emacs} file has an error, this will prevent
4594 @file{default.el} from being loaded and Emacs may be unusable for the
4595 user, even for correcting their @file{.emacs} file (unless they're
4596 smart enough to move it to another name).
4598 @code{enable-flow-control} can be invoked interactively as well:
4599 @kbd{M-x enable-flow-control @key{RET}}.
4601 @end itemize
4603 For further discussion of this issue, read the file @file{etc/PROBLEMS}
4604 (in the Emacs source directory when you unpack the Emacs distribution).
4606 @node Binding C-s and C-q, Backspace invokes help, Handling C-s and C-q with flow control, Key bindings
4607 @section How do I bind @kbd{C-s} and @kbd{C-q} (or any key) if these keys are filtered out?
4608 @cindex Binding @kbd{C-s} and @kbd{C-q}
4609 @cindex @kbd{C-s} and @kbd{C-q}, binding
4611 To bind @kbd{C-s} and @kbd{C-q}, use either @code{enable-flow-control}
4612 or @code{enable-flow-control-on}.  @xref{Handling C-s and C-q with flow
4613 control}, for usage and implementation details.
4615 To bind other keys, use @code{keyboard-translate}.  @xref{Swapping
4616 keys}, for usage details.  To do this for an entire site, you should
4617 swap the keys in @file{site-lisp/site-start.el}.  @xref{Handling C-s
4618 and C-q with flow control}, for an explanation of why
4619 @file{site-lisp/default.el} should not be used.
4621 @itemize @bullet
4623 @item
4624 If you do this for an entire site, the users will be confused by
4625 the disparity between what the documentation says and how Emacs
4626 actually behaves.
4628 @end itemize
4630 @node Backspace invokes help, stty and Backspace key, Binding C-s and C-q, Key bindings
4631 @section Why does the @key{Backspace} key invoke help?
4632 @cindex Backspace key invokes help
4633 @cindex Help invoked by Backspace
4634 @cindex DEL key does not delete
4636 The @key{Backspace} key (on most keyboards) generates ASCII code 8.
4637 @kbd{C-h} sends the same code.  In Emacs by default @kbd{C-h} invokes
4638 help-command.  This is intended to be easy to remember since the first
4639 letter of @samp{help} is @samp{h}.  The easiest solution to this problem
4640 is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the
4641 @key{Delete} key) for deleting the previous character.
4643 For many people this solution may be problematic:
4645 @itemize @bullet
4647 @item
4648 They normally use @key{Backspace} outside of Emacs for deleting the
4649 previous character.  This can be solved by making @key{DEL} the command
4650 for deleting the previous character outside of Emacs.  On many Unix
4651 systems, this command will remap @key{DEL}:
4653 @example
4654 stty erase `^?'
4655 @end example
4657 @item
4658 The user may prefer the @key{Backspace} key for deleting the
4659 previous character because it is more conveniently located on their
4660 keyboard or because they don't even have a separate @key{Delete} key.
4661 In this case, the @key{Backspace} key should be made to behave like
4662 @key{Delete}.  There are several methods.
4664 @itemize @minus
4665 @item
4666 Some terminals (e.g., VT3## terminals) and terminal emulators (e.g.,
4667 TeraTerm) allow the character generated by the @key{Backspace} key to be
4668 changed from a setup menu.
4670 @item
4671 You may be able to get a keyboard that is completely programmable, or a
4672 terminal emulator that supports remapping of any key to any other key.
4674 @item
4675 With Emacs 21.1 and later, you can control the effect of the
4676 @key{Backspace} and @key{Delete} keys, on both dumb terminals and a
4677 windowed displays, by customizing the option
4678 @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x
4679 normal-erase-is-backspace}.  See the documentation of these symbols
4680 (@pxref{Emacs Lisp documentation}) for more info.
4682 @item
4683 It is possible to swap the @key{Backspace} and @key{DEL} keys inside
4684 Emacs:
4686 @lisp
4687 (keyboard-translate ?\C-h ?\C-?)
4688 @end lisp
4690 @noindent
4691 This is the recommended method of forcing @key{Backspace} to act as
4692 @key{DEL}, because it works even in modes which bind @key{DEL} to
4693 something other than @code{delete-backward-char}.
4695 Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by
4696 default deletes forward:
4698 @lisp
4699 (keyboard-translate ?\C-? ?\C-d)
4700 @end lisp
4702 @xref{Swapping keys}, for further details about @code{keyboard-translate}.
4704 @item
4705 Another approach is to switch key bindings and put help on @kbd{C-x h}
4706 instead:
4708 @lisp
4709 (global-set-key "\C-h" 'delete-backward-char)
4711 ;;; overrides mark-whole-buffer
4712 (global-set-key "\C-xh" 'help-command) 
4713 @end lisp
4715 @noindent
4716 This method is not recommended, though: it only solves the problem for
4717 those modes which bind @key{DEL} to @code{delete-backward-char}.  Modes
4718 which bind @key{DEL} to something else, such as @code{view-mode}, will
4719 not work as you expect when you press the @key{Backspace} key.  For this
4720 reason, we recommend the the @code{keyboard-translate} method, shown
4721 above.
4723 Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}.
4724 @end itemize
4726 Don't try to bind @key{DEL} to @code{help-command}, because there are
4727 many modes that have local bindings of @key{DEL} that will interfere.
4729 @end itemize
4731 When Emacs 21 or later runs on a windowed display, it binds the
4732 @key{Delete} key to a command which deletes the character at point, to
4733 make Emacs more consistent with keyboard operation on these systems.
4735 For more information about troubleshooting this problem, see @ref{DEL
4736 Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs
4737 Manual}.
4739 @node stty and Backspace key, Swapping keys, Backspace invokes help, Key bindings
4740 @section Why doesn't Emacs look at the @file{stty} settings for @key{Backspace} vs. @key{Delete}?
4741 @cindex @file{stty} and Emacs
4742 @cindex Backspace and @file{stty}
4743 @cindex Delete and @file{stty}
4745 Good question!
4747 @c FIXME: RMS explained the reasons for this on emacs-hackers.  It's
4748 @c probably worth putting that explanation here.
4750 @node Swapping keys, Producing C-XXX with the keyboard, stty and Backspace key, Key bindings
4751 @section How do I swap two keys?
4752 @cindex Swapping keys
4753 @cindex Keys, swapping
4754 @cindex @code{keyboard-translate}
4756 In Emacs 19, you can swap two keys (or key sequences) by using the
4757 @code{keyboard-translate} function.  For example, to turn @kbd{C-h} into
4758 @key{DEL} and @key{DEL} to @kbd{C-h}, use
4760 @lisp
4761 (keyboard-translate ?\C-h ?\C-?)  ; translate `C-h' to DEL
4762 (keyboard-translate ?\C-? ?\C-h)  ; translate DEL to `C-h'.
4763 @end lisp
4765 @noindent
4766 The first key sequence of the pair after the function identifies what is
4767 produced by the keyboard; the second, what is matched for in the
4768 keymaps.
4770 Keyboard translations are not the same as key bindings in keymaps.
4771 Emacs contains numerous keymaps that apply in different situations, but
4772 there is only one set of keyboard translations, and it applies to every
4773 character that Emacs reads from the terminal.  Keyboard translations
4774 take place at the lowest level of input processing; the keys that are
4775 looked up in keymaps contain the characters that result from keyboard
4776 translation.
4778 @inforef{Keyboard Translations, Keyboard Translations, emacs}.
4780 @node Producing C-XXX with the keyboard, No Meta key, Swapping keys, Key bindings
4781 @section How do I produce C-XXX with my keyboard?
4782 @cindex Producing control characters
4783 @cindex Generating control characters
4784 @cindex Control characters, generating
4786 On terminals (but not under X), some common "aliases" are:
4788 @table @asis
4790 @item @kbd{C-2}  or  @kbd{C-@key{SPC}}
4791 @kbd{C-@@}
4793 @item @kbd{C-6}
4794 @kbd{C-^}
4796 @item @kbd{C-7}  or  @kbd{C-S--}
4797 @kbd{C-_}
4799 @item @kbd{C-4}
4800 @kbd{C-\}
4802 @item @kbd{C-5}
4803 @kbd{C-]}
4805 @item @kbd{C-/}
4806 @kbd{C-?}
4808 @end table
4810 Often other aliases exist; use the @kbd{C-h c} command and try
4811 @key{CTRL} with all of the digits on your keyboard to see what gets
4812 generated.  You can also try the @kbd{C-h w} command if you know the
4813 name of the command.
4815 @node No Meta key, No Escape key, Producing C-XXX with the keyboard, Key bindings
4816 @section What if I don't have a @key{Meta} key?
4817 @cindex No @key{Meta} key
4818 @cindex @key{Meta} key, what to do if you lack it
4820 On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it.
4822 Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}.  In fact,
4823 Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway
4824 (depending on the value of @code{meta-prefix-char}).  Note that you
4825 press @key{Meta} and @key{a} together, but with @key{ESC}, you press
4826 @key{ESC}, release it, and then press @key{a}.
4828 @node No Escape key, Compose Character, No Meta key, Key bindings
4829 @section What if I don't have an @key{Escape} key?
4830 @cindex No Escape key
4831 @cindex Lacking an Escape key
4832 @cindex Escape key, lacking
4834 Type @kbd{C-[} instead.  This should send ASCII code 27 just like an
4835 Escape key would.  @kbd{C-3} may also work on some terminal (but not
4836 under X).  For many terminals (notably DEC terminals) @key{F11}
4837 generates @key{ESC}.  If not, the following form can be used to bind it:
4839 @lisp
4840 ;;; F11 is the documented ESC replacement on DEC terminals.
4841 (define-key function-key-map [f11] [?\e])  
4842 @end lisp
4844 @node Compose Character, Binding combinations of modifiers and function keys, No Escape key, Key bindings
4845 @section Can I make my @key{Compose Character} key behave like a @key{Meta} key?
4846 @cindex @key{Compose Character} key, using as @key{Meta}
4847 @cindex @key{Meta}, using @key{Compose Character} for
4849 On a dumb terminal such as a VT220, no.  It is rumored that certain
4850 VT220 clones could have their @key{Compose} key configured this way.  If
4851 you're using X, you might be able to do this with the @code{xmodmap}
4852 command.
4854 @node Binding combinations of modifiers and function keys, Meta key does not work in xterm, Compose Character, Key bindings
4855 @section How do I bind a combination of modifier key and function key?
4856 @cindex Modifiers and function keys
4857 @cindex Function keys and modifiers
4858 @cindex Binding modifiers and function keys
4860 With Emacs 19 and later, you can represent modified function keys in
4861 vector format by adding prefixes to the function key symbol.  For
4862 example (from the on-line documentation):
4864 @lisp
4865 (global-set-key [?\C-x right] 'forward-page)
4866 @end lisp
4868 @noindent
4869 where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}.
4871 You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper},
4872 @key{Super}, @key{Alt}, and @key{Shift} with function keys.  To
4873 represent these modifiers, prepend the strings @samp{C-}, @samp{M-},
4874 @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name.  Here
4875 is how to make @kbd{H-M-RIGHT} move forward a word:
4877 @lisp
4878 (global-set-key [H-M-right] 'forward-word)
4879 @end lisp
4881 @itemize @bullet
4883 @item
4884 Not all modifiers are permitted in all situations.  @key{Hyper},
4885 @key{Super}, and @key{Alt} are not available on Unix character
4886 terminals.  Non-ASCII keys and mouse events (e.g. @kbd{C-=} and
4887 @kbd{Mouse-1}) also fall under this category.
4889 @end itemize
4891 @xref{Binding keys to commands}, for general key binding instructions.
4893 @node Meta key does not work in xterm, ExtendChar key does not work as Meta, Binding combinations of modifiers and function keys, Key bindings
4894 @section Why doesn't my @key{Meta} key work in an @code{xterm} window?
4895 @cindex @key{Meta} key and @code{xterm}
4896 @cindex Xterm and @key{Meta} key
4898 @inforef{Single-Byte Character Support, Single-Byte Character Set
4899 Support, emacs}.
4901 If the advice in the Emacs manual fails, try all of these methods before
4902 asking for further help:
4904 @itemize @bullet
4906 @item
4907 You may have big problems using @code{mwm} as your window manager.
4908 (Does anyone know a good generic solution to allow the use of the
4909 @key{Meta} key in Emacs with @file{mwm}?)
4911 @item
4912 For X11: Make sure it really is a @key{Meta} key.  Use @code{xev} to
4913 find out what keysym your @key{Meta} key generates.  It should be either
4914 @code{Meta_L} or @code{Meta_R}.  If it isn't, use @file{xmodmap} to fix
4915 the situation.  If @key{Meta} does generate @code{Meta_L} or
4916 @code{Meta_R}, but @kbd{M-x} produces a non-ASCII character, put this in
4917 your @file{~/.Xdefaults} file:
4919 @example
4920  XTerm*eightBitInput:   false
4921  XTerm*eightBitOutput:  true
4922 @end example
4924 @item
4925 Make sure the @code{pty} the @code{xterm} is using is passing 8 bit
4926 characters.  @samp{stty -a} (or @samp{stty everything}) should show
4927 @samp{cs8} somewhere.  If it shows @samp{cs7} instead, use @samp{stty
4928 cs8 -istrip} (or @samp{stty pass8}) to fix it.
4930 @item
4931 If there is an @code{rlogin} connection between @code{xterm} and Emacs, the
4932 @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits
4933 of every character.
4935 @item
4936 If Emacs is running on Ultrix, it is reported that evaluating
4937 @code{(set-input-mode t nil)} helps.
4939 @item
4940 If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when
4941 you type @kbd{M-W}, which is the same conversion Emacs would make if it
4942 got the @kbd{M-W} anyway.  In X11R4, the following resource
4943 specification will do this:
4945 @example
4946 XTerm.VT100.EightBitInput: false
4947 @end example
4949 @noindent
4950 (This changes the behavior of the @code{insert-eight-bit} action.)
4952 With older @code{xterm}s, you can specify this behavior with a translation:
4954 @example
4955 XTerm.VT100.Translations: #override \
4956   Meta<KeyPress>: string(0x1b) insert()
4957 @end example
4959 @noindent
4960 You might have to replace @samp{Meta} with @samp{Alt}.
4962 @end itemize
4964 @node ExtendChar key does not work as Meta,  , Meta key does not work in xterm, Key bindings
4965 @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x?
4966 @cindex @key{ExtendChar} key as @key{Meta}
4967 @cindex @key{Meta}, using @key{ExtendChar} for
4968 @cindex HP-UX, the @key{ExtendChar} key
4970 This is a result of an internationalization extension in X11R4 and the
4971 fact that HP is now using this extension.  Emacs assumes that the
4972 @code{XLookupString} function returns the same result regardless of the
4973 @key{Meta} key state which is no longer necessarily true.  Until Emacs
4974 is fixed, the temporary kludge is to run this command after each time
4975 the X server is started but preferably before any xterm clients are:
4977 @example
4978 xmodmap -e 'remove mod1 = Mode_switch'
4979 @end example
4981 @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is
4982 @c solved?
4984 This will disable the use of the extra keysyms systemwide, which may be
4985 undesirable if you actually intend to use them.
4987 @c ------------------------------------------------------------
4988 @node Alternate character sets, Mail and news, Key bindings, Top
4989 @chapter Alternate character sets
4990 @cindex Alternate character sets
4992 @menu
4993 * Emacs does not display 8-bit characters::  
4994 * Inputting eight-bit characters::  
4995 * Kanji and Chinese characters::  
4996 * Right-to-left alphabets::     
4997 @end menu
4999 @node Emacs does not display 8-bit characters, Inputting eight-bit characters, Alternate character sets, Alternate character sets
5000 @section How do I make Emacs display 8-bit characters?
5001 @cindex Displaying eight-bit characters
5002 @cindex Eight-bit characters, displaying
5004 @inforef{Single-Byte Character Support, Single-byte Character Set
5005 Support, emacs}.  On a Unix, when Emacs runs on a text-only terminal
5006 display or is invoked with @samp{emacs -nw}, you typically need to use
5007 @code{set-terminal-coding-system} to tell Emacs what the terminal can
5008 display, even after setting the language environment; otherwise
5009 non-ASCII characters will display as @samp{?}.  On other operating
5010 systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the
5011 character set supported by the display, and sets up the required
5012 terminal coding system automatically.
5014 @node Inputting eight-bit characters, Kanji and Chinese characters, Emacs does not display 8-bit characters, Alternate character sets
5015 @section How do I input eight-bit characters?
5016 @cindex Entering eight-bit characters
5017 @cindex Eight-bit characters, entering
5018 @cindex Input, 8-bit characters
5020 Various methods are available for input of eight-bit characters.  See
5021 @inforef{Single-Byte Character Support, Single-byte Character Set
5022 Support, emacs}.  For more sophisticated methods, @inforef{Input
5023 Methods, Input Methods, emacs}.
5025 @node Kanji and Chinese characters, Right-to-left alphabets, Inputting eight-bit characters, Alternate character sets
5026 @section Where can I get an Emacs that handles kanji, Chinese, or other Far-Eastern character sets?
5027 @cindex Kanji, handling with Emacs
5028 @cindex Chinese, handling with Emacs
5029 @cindex Japanese, handling with Emacs
5030 @cindex Korean, handling with Emacs
5032 Emacs 20 and later includes many of the features of MULE, the MULtilingual
5033 Enhancement to Emacs.  @xref{Installing Emacs}, for information on where
5034 to find and download the latest version of Emacs.
5036 @node Right-to-left alphabets,  , Kanji and Chinese characters, Alternate character sets
5037 @section Where is an Emacs that can handle Semitic (right-to-left) alphabets?
5038 @cindex Right-to-left alphabets
5039 @cindex Hebrew, handling with Emacs
5040 @cindex Semitic alphabets
5041 @cindex Arabic alphabets
5043 Emacs 20 and later supports Hebrew characters (ISO 8859-8), but does not
5044 yet support right-to-left character entry and display.
5046 @email{joel@@exc.com, Joel M. Hoffman} has written a Lisp package called
5047 @file{hebrew.el} that allows right-to-left editing of Hebrew.  It
5048 reportedly works out of the box with Emacs 19, but requires patches for
5049 Emacs 18.  Write to Joel if you want the patches or package.
5051 @c FIXME: Should we mention Ehud Karni's package?
5053 @file{hebrew.el} requires a Hebrew screen font, but no other hardware support.
5054 Joel has a screen font for PCs running MS-DOS or GNU/Linux.
5056 You might also try to query archie for files named with @file{hebrew};
5057 several ftp sites in Israel may also have the necessary files.
5059 @c ------------------------------------------------------------
5060 @node Mail and news, Concept index, Alternate character sets, Top
5061 @chapter Mail and news
5062 @cindex Mail and news
5064 @menu
5065 * Changing the included text prefix::  
5066 * Saving a copy of outgoing mail::  
5067 * Expanding aliases when sending mail::  
5068 * Rmail thinks all messages are one big one::  
5069 * Sorting the messages in an Rmail folder::  
5070 * Rmail writes to /usr/spool/mail::  
5071 * Recovering mail files when Rmail munges them::  
5072 * Replying to the sender of a message::  
5073 * MIME with Emacs mail packages::  
5074 * Automatically starting a mail or news reader::  
5075 * Reading news with Emacs::     
5076 * Gnus does not work with NNTP::  
5077 * Viewing articles with embedded underlining::  
5078 * Saving a multi-part Gnus posting::  
5079 * Starting Gnus faster::        
5080 * Catching up in all newsgroups::  
5081 * Killing based on nonstandard headers::  
5082 * Removing flashing messages::  
5083 * Catch-up is slow in Gnus::    
5084 * Gnus hangs for a long time::  
5085 * Learning more about Gnus::    
5086 @end menu
5088 @node Changing the included text prefix, Saving a copy of outgoing mail, Mail and news, Mail and news
5089 @section How do I change the included text prefix in mail/news followups?
5090 @cindex Prefix in mail/news followups, changing
5091 @cindex Included text prefix, changing
5092 @cindex Setting the included text character
5093 @cindex Quoting in mail messages
5095 If you read mail with Rmail or news with Gnus, set the variable
5096 @code{mail-yank-prefix}.  For VM, set @code{vm-included-text-prefix}.
5097 For mh-e, set @code{mh-ins-buf-prefix}.
5099 For fancier control of citations, use Supercite.  @xref{Supercite}.
5101 To prevent Emacs from including various headers of the replied-to
5102 message, set the value of @code{mail-yank-ignored-headers} to an
5103 appropriate regexp.
5105 @node Saving a copy of outgoing mail, Expanding aliases when sending mail, Changing the included text prefix, Mail and news
5106 @section How do I save a copy of outgoing mail?
5107 @cindex Saving a copy of outgoing mail
5108 @cindex Copying outgoing mail to a file
5109 @cindex Filing outgoing mail
5110 @cindex Automatic filing of outgoing mail
5111 @cindex Mail, saving outgoing automatically
5113 You can either mail yourself a copy by including a @samp{BCC} header in the
5114 mail message, or store a copy of the message directly to a file by
5115 including an @samp{FCC} header.
5117 If you use standard mail, you can automatically create a @samp{BCC} to
5118 yourself by putting
5120 @lisp
5121 (setq mail-self-blind t)
5122 @end lisp
5124 @noindent
5125 in your @file{.emacs} file.  You can automatically include an @samp{FCC}
5126 field by putting something like the following in your @file{.emacs}
5127 file:
5129 @lisp
5130 (setq mail-archive-file-name (expand-file-name "~/outgoing"))
5131 @end lisp
5133 The output file will be in Unix mail format, which can be read directly
5134 by VM, but not always by Rmail.  @xref{Learning how to do something}.
5136 If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your
5137 components file.
5139 It does not work to put @samp{set record filename} in the @file{.mailrc}
5140 file.
5142 @node Expanding aliases when sending mail, Rmail thinks all messages are one big one, Saving a copy of outgoing mail, Mail and news
5143 @section Why doesn't Emacs expand my aliases when sending mail?
5144 @cindex Expanding aliases when sending mail
5145 @cindex Mail alias expansion
5146 @cindex Sending mail with aliases
5148 @itemize @bullet
5150 @item
5151 You must separate multiple addresses in the headers of the mail buffer
5152 with commas.  This is because Emacs supports RFC822 standard addresses
5153 like this one:
5155 @example
5156 To: Willy Smith <wks@@xpnsv.lwyrs.com>
5157 @end example
5159 However, you do not need to---and probably should not, unless your
5160 system's version of @file{/usr/ucb/mail} (a.k.a.@: @code{mailx})
5161 supports RFC822---separate addresses with commas in your
5162 @file{~/.mailrc} file.
5164 @item
5165 Emacs normally only reads the @file{.mailrc} file once per session,
5166 when you start to compose your first mail message.  If you edit
5167 @file{.mailrc}, you can type @kbd{M-x rebuild-mail-abbrevs @key{RET}} to
5168 make Emacs reread @file{~/.mailrc}.
5170 @item
5171 If you like, you can expand mail aliases as abbrevs, as soon as you
5172 type them in.  To enable this feature, execute the following:
5174 @lisp
5175 (add-hook 'mail-mode-hook 'mail-abbrevs-setup)
5176 @end lisp
5178 Note that the aliases are expanded automatically only after you type
5179 @key{RET} or a punctuation character (e.g. @kbd{,}).  You can force their
5180 expansion by moving point to the end of the alias and typing @kbd{C-x a e}
5181 (@kbd{M-x expand-abbrev}).
5182 @end itemize
5184 @node Rmail thinks all messages are one big one, Sorting the messages in an Rmail folder, Expanding aliases when sending mail, Mail and news
5185 @section Why does Rmail think all my saved messages are one big message?
5186 @cindex Rmail thinks all messages are one large message
5188 A file created through the @samp{FCC} field in a message is in Unix mail
5189 format, not the format that Rmail uses (BABYL format).  Rmail will try
5190 to convert a Unix mail file into BABYL format on input, but sometimes it
5191 makes errors.  For guaranteed safety, you can make the
5192 @file{saved-messages} file be an inbox for your Rmail file by using the
5193 function @code{set-rmail-inbox-list}.
5195 @node Sorting the messages in an Rmail folder, Rmail writes to /usr/spool/mail, Rmail thinks all messages are one big one, Mail and news
5196 @section How can I sort the messages in my Rmail folder?
5197 @cindex Rmail, sorting messages in
5198 @cindex Folder, sorting messages in an Rmail
5199 @cindex Sorting messages in an Rmail folder
5201 In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions
5202 and their key bindings.
5204 @node Rmail writes to /usr/spool/mail, Recovering mail files when Rmail munges them, Sorting the messages in an Rmail folder, Mail and news
5205 @section Why does Rmail need to write to @file{/usr/spool/mail}?
5206 @cindex Rmail and @file{/usr/spool/mail}
5207 @cindex @file{/usr/spool/mail} and Rmail
5209 This is the behavior of the @code{movemail} program which Rmail uses.
5210 This indicates that @code{movemail} is configured to use lock files.
5212 RMS writes:
5214 @quotation
5215 Certain systems require lock files to interlock access to mail files.
5216 On these systems, @code{movemail} must write lock files, or you risk losing
5217 mail.  You simply must arrange to let @code{movemail} write them.
5219 Other systems use the @code{flock} system call to interlock access.  On
5220 these systems, you should configure @code{movemail} to use @code{flock}.
5221 @end quotation
5223 @node Recovering mail files when Rmail munges them, Replying to the sender of a message, Rmail writes to /usr/spool/mail, Mail and news
5224 @section How do I recover my mail files after Rmail munges their format?
5225 @cindex Recovering munged mail files
5226 @cindex Rmail munged my files
5227 @cindex Mail files, recovering those munged by Rmail
5229 If you have just done @kbd{M-x rmail-input} on a file and you don't want
5230 to save it in Rmail's format (called BABYL), just kill the buffer (with
5231 @kbd{C-x k}).
5233 @cindex Exporting messages as Unix mail files
5234 If you typed @kbd{M-x rmail} and it read some messages out of your inbox
5235 and you want to put them in a Unix mail file, use @kbd{C-o} on each
5236 message.
5238 @cindex Converting from BABYL to Unix mail format
5239 @cindex @code{unrmail} command
5240 If you want to convert an existing file from BABYL format to Unix mail
5241 format, use the command @kbd{M-x unrmail}: it will prompt you for the
5242 input and output file names.
5244 @pindex b2m
5245 Alternatively, you could use the @code{b2m} program supplied with
5246 Emacs.  @code{b2m} is a filter, and is used like this:
5248 @example
5249  b2m < @var{babyl-file} > @var{mbox-file}
5250 @end example
5252 @noindent
5253 where @var{babyl-file} is the name of the BABYL file, and
5254 @var{mbox-file} is the name of the file where the converted mail will
5255 be written.
5257 @node Replying to the sender of a message, MIME with Emacs mail packages, Recovering mail files when Rmail munges them, Mail and news
5258 @section How can I force Rmail to reply to the sender of a message, but not the other recipients?
5259 @cindex Replying only to the sender of a message
5260 @cindex Sender, replying only to
5261 @cindex Rmail, replying to the sender of a message in
5263 @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit
5264 @key{r} to reply in Rmail, by default it CCs all of the original
5265 recipients (everyone on the original @samp{To} and @samp{CC}
5266 lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}),
5267 it replies only to the sender.  However, going through the whole
5268 @kbd{C-u} business every time you want to reply is a pain.  This is the
5269 best fix I've been able to come up with:
5271 @lisp
5272 (defun rmail-reply-t ()
5273   "Reply only to the sender of the current message. (See rmail-reply.)"
5274   (interactive)
5275   (rmail-reply t))
5277 (add-hook 'rmail-mode-hook
5278   (lambda ()
5279     (define-key rmail-mode-map "r" 'rmail-reply-t)
5280     (define-key rmail-mode-map "R" 'rmail-reply)))
5281 @end lisp
5283 @node MIME with Emacs mail packages, Automatically starting a mail or news reader, Replying to the sender of a message, Mail and news
5284 @section How can I get my favorite Emacs mail package to support MIME?  
5285 @cindex MIME and Emacs mail packages
5286 @cindex Mail packages and MIME
5287 @cindex FAQ for MIME and Emacs
5289 Read the Emacs MIME FAQ, maintained by @email{trey@@cs.berkeley.edu,
5290 MacDonald Hall Jackson} at
5292 @uref{http://bmrc.berkeley.edu/~trey/emacs/mime.html}
5294 Version 6.x of VM supports MIME.  @xref{VM}.  Gnus supports MIME in mail
5295 and news messages as of version 5.8.1 (Pterodactyl).  Rmail has limited
5296 support for single-part MIME messages beginning with Emacs 20.3.
5298 @node Automatically starting a mail or news reader, Reading news with Emacs, MIME with Emacs mail packages, Mail and news
5299 @section How do I make Emacs automatically start my mail/news reader?
5300 @cindex Mail reader, starting automatically
5301 @cindex News reader, starting automatically
5302 @cindex Starting mail/news reader automatically
5304 To start Emacs in Gnus:
5306 @example
5307 emacs -f gnus
5308 @end example
5310 @noindent
5311 in Rmail:
5313 @example
5314 emacs -f rmail
5315 @end example
5317 A more convenient way to start with Gnus:
5319 @example
5320 alias gnus 'emacs -f gnus'
5321 gnus
5322 @end example
5324 It is probably unwise to automatically start your mail or news reader
5325 from your @file{.emacs} file.  This would cause problems if you needed to run
5326 two copies of Emacs at the same time.  Also, this would make it difficult for
5327 you to start Emacs quickly when you needed to.
5329 @node Reading news with Emacs, Gnus does not work with NNTP, Automatically starting a mail or news reader, Mail and news
5330 @section How do I read news under Emacs?
5331 @cindex Reading news under Emacs
5332 @cindex Usenet reader in Emacs
5333 @cindex Gnus newsreader
5335 Use @kbd{M-x gnus}.  It is documented in Info (@pxref{Learning how to do
5336 something}).
5338 @node Gnus does not work with NNTP, Viewing articles with embedded underlining, Reading news with Emacs, Mail and news
5339 @section Why doesn't Gnus work via NNTP?
5340 @cindex Gnus and NNTP
5341 @cindex NNTP, Gnus fails to work with
5343 There is a bug in NNTP version 1.5.10, such that when multiple requests
5344 are sent to the NNTP server, the server only handles the first one
5345 before blocking waiting for more input which never comes.  NNTP version
5346 1.5.11 claims to fix this.
5348 You can work around the bug inside Emacs like this:
5350 @lisp
5351 (setq nntp-maximum-request 1)
5352 @end lisp
5354 You can find out what version of NNTP your news server is running by
5355 telnetting to the NNTP port (usually 119) on the news server machine
5356 (i.e., @kbd{telnet server-machine 119}).  The server should give its
5357 version number in the welcome message.  Type @kbd{quit} to get out.
5359 @xref{Spontaneous entry into isearch-mode}, for some additional ideas.
5361 @node Viewing articles with embedded underlining, Saving a multi-part Gnus posting, Gnus does not work with NNTP, Mail and news
5362 @section How do I view news articles with embedded underlining (e.g., ClariNews)?
5363 @cindex Underlining, embedded in news articles
5364 @cindex News articles with embedded underlining
5365 @cindex Embedded underlining in news articles
5367 Underlining appears like this:
5369 @example
5370 _^Hu_^Hn_^Hd_^He_^Hr_^Hl_^Hi_^Hn_^Hi_^Hn_^Hg
5371 @end example
5373 @email{abraham@@dina.kvl.dk, Per Abrahamsen} suggests using the following
5374 code, which uses the underline face to turn such text into true
5375 underlining, inconjunction with Gnus:
5377 @lisp
5378 (defun gnus-article-prepare-overstrike ()
5379   ;; Prepare article for overstrike commands.
5380   (save-excursion
5381     (set-buffer gnus-article-buffer)
5382     (let ((buffer-read-only nil))
5383     (goto-char (point-min))
5384       (while (search-forward "\b" nil t)
5385         (let ((next (following-char))
5386               (previous (char-after (- (point) 2))))
5387           (cond ((eq next previous)
5388                  (delete-region (- (point) 2) (point))
5389                  (put-text-property (point) (1+ (point))
5390                                     'face 'bold))
5391                 ((eq next ?_)
5392                  (delete-region (1- (point)) (1+ (point)))
5393                  (put-text-property (1- (point)) (point)
5394                                     'face 'underline))
5395                 ((eq previous ?_)
5396                  (delete-region (- (point) 2) (point))
5397                  (put-text-property (point) (1+ (point))
5398                                     'face 'underline))))))))
5400 (add-hook 'gnus-article-prepare-hook 'gnus-article-prepare-overstrike)
5401 @end lisp
5403 Latest versions of Gnus do such a conversion automatically.
5405 If you prefer to do away with underlining altogether, you can
5406 destructively remove it with @kbd{M-x ununderline-region}; do this
5407 automatically via
5409 @lisp
5410 (add-hook 'gnus-article-prepare-hook
5411   (lambda () (ununderline-region (point-min) (point-max))))
5412 @end lisp
5414 @node Saving a multi-part Gnus posting, Starting Gnus faster, Viewing articles with embedded underlining, Mail and news
5415 @section How do I save all the items of a multi-part posting in Gnus?
5416 @cindex Multi-part postings in Gnus, saving
5417 @cindex Saving multi-part postings in Gnus
5418 @cindex Gnus, saving multi-part postings in
5420 Use @code{gnus-uu}.  Type @kbd{C-c C-v C-h} in the Gnus summary buffer
5421 to see a list of available commands.
5423 @node Starting Gnus faster, Catching up in all newsgroups, Saving a multi-part Gnus posting, Mail and news
5424 @section How do I make Gnus start up faster?
5425 @cindex Faster, starting Gnus
5426 @cindex Starting Gnus faster
5427 @cindex Gnus, starting faster
5429 From the Gnus FAQ (@pxref{Learning more about Gnus}):
5431 @quotation
5432 @email{pktiwari@@eos.ncsu.edu, Pranav Kumar Tiwari} writes: I posted
5433 the same query recently and I got an answer to it. I am going to
5434 repeat the answer. What you need is a newer version of gnus, version
5435 5.0.4+. I am using 5.0.12 and it works fine with me with the
5436 following settings:
5438 @lisp
5439 (setq gnus-check-new-newsgroups nil
5440       gnus-read-active-file 'some
5441       gnus-nov-is-evil nil
5442       gnus-select-method '(nntp gnus-nntp-server))
5443 @end lisp
5444 @end quotation
5446 @node Catching up in all newsgroups, Killing based on nonstandard headers, Starting Gnus faster, Mail and news
5447 @section How do I catch up all newsgroups in Gnus?
5448 @cindex Catching up all newsgroups in Gnus
5449 @cindex Gnus, Catching up all newsgroups in
5451 In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e}
5453 Leave off the initial @kbd{M-<} if you only want to catch up from point
5454 to the end of the @file{*Newsgroup*} buffer.
5456 @node Killing based on nonstandard headers, Removing flashing messages, Catching up in all newsgroups, Mail and news
5457 @section Why can't I kill in Gnus based on the Newsgroups/Keywords/Control headers?
5458 @cindex Killing articles based on nonstandard headers
5459 @cindex Newsgroups header, killing articles based on
5460 @cindex Keywords header, killing articles based on
5461 @cindex Control header, killing articles based on
5463 Gnus will complain that the @samp{Newsgroups}, @samp{Keywords}, and
5464 @samp{Control} headers are ``Unknown header'' fields.
5466 For the @samp{Newsgroups} header, there is an easy workaround: kill on the
5467 @samp{Xref} header instead, which will be present on any cross-posted article
5468 (as long as your site carries the cross-post group).
5470 If you really want to kill on one of these headers, you can do it like
5471 this:
5473 @lisp
5474 (gnus-kill nil "^Newsgroups: .*\\(bad\\.group\\|worse\\.group\\)")
5475 @end lisp
5477 @node Removing flashing messages, Catch-up is slow in Gnus, Killing based on nonstandard headers, Mail and news
5478 @section How do I get rid of flashing messages in Gnus for slow connections?
5479 @cindex Flashing Gnus messages, removing
5480 @cindex Removing flashing Gnus messages
5481 @cindex Slow connections causing flashing messages in Gnus
5482 @cindex Gnus, flashing messages in
5484 Set @code{nntp-debug-read} to @code{nil}.
5486 @node Catch-up is slow in Gnus, Gnus hangs for a long time, Removing flashing messages, Mail and news
5487 @section Why is catch up slow in Gnus?
5488 @cindex Slow catch up in Gnus
5489 @cindex Gnus is slow when catching up
5490 @cindex Crosspostings make Gnus catching up slow
5492 Because Gnus is marking crosspostings read.  You can control this with
5493 the variable @code{gnus-use-cross-reference}.
5495 @node Gnus hangs for a long time, Learning more about Gnus, Catch-up is slow in Gnus, Mail and news
5496 @section Why does Gnus hang for a long time when posting?
5497 @cindex Hangs in Gnus
5498 @cindex Gnus hangs while posting
5499 @cindex Posting, Gnus hangs wile
5501 @email{tale@@uunet.uu.net, David Lawrence} explains:
5503 @quotation
5504 The problem is almost always interaction between NNTP and C News.  NNTP
5505 POST asks C News's @code{inews} to not background itself but rather hang
5506 around and give its exit status so it knows whether the post was successful.
5507 (That wait will on some systems not return the exit status of the
5508 waited for job is a different sort of problem.)  It ends up taking a
5509 long time because @code{inews} is calling @code{relaynews}, which often
5510 waits for another @code{relaynews} to free the lock on the news system
5511 so it can file the article.
5513 My preferred solution is to change @code{inews} to not call
5514 @code{relaynews}, but rather use @code{newsspool}.  This loses some
5515 error-catching functionality, but is for the most part safe as
5516 @code{inews} will detect a lot of the errors on its own.  The C News
5517 folks have sped up @code{inews}, too, so speed should look better to
5518 most folks as that update propagates around.
5519 @end quotation
5521 @node Learning more about Gnus,  , Gnus hangs for a long time, Mail and news
5522 @section Where can I find out more about Gnus?
5523 @cindex FAQ for Gnus
5524 @cindex Gnus FAQ
5525 @cindex Learning more about GNU
5527 Look for the Gnus FAQ, available at
5529 @uref{http://www.ccs.neu.edu/software/contrib/gnus/}
5531 @node Concept index,  , Mail and news, Top
5532 @unnumbered Concept Index
5533 @printindex cp
5535 @contents
5536 @bye